From 9247062a0fb413246797bca5605adf88fffbd538 Mon Sep 17 00:00:00 2001 From: PureCloud Jenkins Date: Wed, 4 Oct 2023 12:55:39 +0000 Subject: [PATCH] 127.1.0 --- PureCloudPlatformClientV2.podspec | 4 +- README.md | 2 +- build/APIData.json | 40749 ---------------- build/PureCloudPlatformClientV2.podspec | 4 +- build/README.md | 2 +- build/docs/AlertingAPI.json | 349 + build/docs/AnalyticsAPI.json | 700 + build/docs/ArchitectAPI.json | 2674 + build/docs/AuditAPI.json | 89 + build/docs/AuthorizationAPI.json | 835 + build/docs/BillingAPI.json | 39 + build/docs/CarrierServicesAPI.json | 29 + build/docs/ChatAPI.json | 69 + build/docs/CoachingAPI.json | 424 + build/docs/ContentManagementAPI.json | 829 + build/docs/ConversationsAPI.json | 4090 ++ build/docs/DataExtensionsAPI.json | 30 + build/docs/DownloadsAPI.json | 31 + build/docs/EmailsAPI.json | 23 + build/docs/EventsAPI.json | 42 + build/docs/ExternalContactsAPI.json | 1221 + build/docs/FaxAPI.json | 84 + build/docs/FlowsAPI.json | 29 + build/docs/GamificationAPI.json | 1390 + .../GeneralDataProtectionRegulationAPI.json | 70 + build/docs/GeolocationAPI.json | 64 + build/docs/GreetingsAPI.json | 259 + build/docs/GroupsAPI.json | 269 + build/docs/IdentityProviderAPI.json | 307 + build/docs/InfrastructureAsCodeAPI.json | 153 + build/docs/IntegrationsAPI.json | 1268 + build/docs/JourneyAPI.json | 604 + build/docs/KnowledgeAPI.json | 2031 + build/docs/LanguageUnderstandingAPI.json | 667 + build/docs/LanguagesAPI.json | 115 + build/docs/LearningAPI.json | 640 + build/docs/LicenseAPI.json | 119 + build/docs/LocationsAPI.json | 136 + build/docs/MessagingAPI.json | 177 + build/docs/MobileDevicesAPI.json | 82 + build/docs/NotificationsAPI.json | 124 + build/docs/OAuthAPI.json | 195 + build/docs/ObjectsAPI.json | 176 + build/docs/OrganizationAPI.json | 231 + build/docs/OrganizationAuthorizationAPI.json | 799 + build/docs/OutboundAPI.json | 2598 + build/docs/PresenceAPI.json | 335 + build/docs/ProcessAutomationAPI.json | 156 + build/docs/QualityAPI.json | 1265 + build/docs/RecordingAPI.json | 1154 + build/docs/ResponseManagementAPI.json | 286 + build/docs/RoutingAPI.json | 2382 + build/docs/SCIMAPI.json | 611 + build/docs/ScriptsAPI.json | 415 + build/docs/SearchAPI.json | 349 + build/docs/SettingsAPI.json | 23 + build/docs/SpeechTextAnalyticsAPI.json | 627 + build/docs/StationsAPI.json | 76 + build/docs/SuggestAPI.json | 85 + build/docs/TeamsAPI.json | 173 + build/docs/TelephonyAPI.json | 74 + build/docs/TelephonyProvidersEdgeAPI.json | 2197 + build/docs/TextbotsAPI.json | 75 + build/docs/TokensAPI.json | 40 + build/docs/UploadsAPI.json | 86 + build/docs/UsageAPI.json | 109 + build/docs/UserRecordingsAPI.json | 109 + build/docs/UsersAPI.json | 1616 + build/docs/UtilitiesAPI.json | 48 + build/docs/VoicemailAPI.json | 366 + build/docs/WebChatAPI.json | 314 + build/docs/WebDeploymentsAPI.json | 292 + build/docs/WebMessagingAPI.json | 21 + build/docs/WidgetsAPI.json | 66 + build/docs/WorkforceManagementAPI.json | 3230 ++ build/docs/deleteAlertingAlert-example.txt | 15 + ...eAlertingInteractionstatsAlert-example.txt | 15 + ...teAlertingInteractionstatsRule-example.txt | 15 + build/docs/deleteAlertingRule-example.txt | 15 + ...alyticsConversationsDetailsJob-example.txt | 15 + ...leteAnalyticsReportingSchedule-example.txt | 15 + ...deleteAnalyticsUsersDetailsJob-example.txt | 15 + .../deleteArchitectEmergencygroup-example.txt | 15 + build/docs/deleteArchitectIvr-example.txt | 15 + build/docs/deleteArchitectPrompt-example.txt | 16 + .../deleteArchitectPromptResource-example.txt | 16 + ...teArchitectPromptResourceAudio-example.txt | 16 + build/docs/deleteArchitectPrompts-example.txt | 16 + .../docs/deleteArchitectSchedule-example.txt | 15 + .../deleteArchitectSchedulegroup-example.txt | 15 + ...eArchitectSystempromptResource-example.txt | 16 + .../deleteAuthorizationDivision-example.txt | 16 + .../docs/deleteAuthorizationRole-example.txt | 15 + ...thorizationSubjectDivisionRole-example.txt | 17 + .../deleteCoachingAppointment-example.txt | 16 + ...eCoachingAppointmentAnnotation-example.txt | 16 + ...eleteContentmanagementDocument-example.txt | 16 + .../deleteContentmanagementShare-example.txt | 15 + ...ontentmanagementStatusStatusId-example.txt | 15 + ...leteContentmanagementWorkspace-example.txt | 16 + ...ntentmanagementWorkspaceMember-example.txt | 16 + ...entmanagementWorkspaceTagvalue-example.txt | 16 + ...eteConversationParticipantCode-example.txt | 17 + ...sationParticipantFlaggedreason-example.txt | 16 + ...onversationRecordingAnnotation-example.txt | 17 + ...rsationsCallParticipantConsult-example.txt | 16 + ...nsEmailMessagesDraftAttachment-example.txt | 16 + ...esCachedmediaCachedMediaItemId-example.txt | 15 + ...egrationsFacebookIntegrationId-example.txt | 15 + ...grationsInstagramIntegrationId-example.txt | 15 + ...gIntegrationsLineIntegrationId-example.txt | 15 + ...gIntegrationsOpenIntegrationId-example.txt | 15 + ...tegrationsTwitterIntegrationId-example.txt | 15 + ...egrationsWhatsappIntegrationId-example.txt | 16 + ...eConversationsMessagingSetting-example.txt | 15 + ...ationsMessagingSettingsDefault-example.txt | 14 + ...ortedcontentSupportedContentId-example.txt | 15 + ...manceExternalmetricsDefinition-example.txt | 15 + .../deleteExternalcontactsContact-example.txt | 16 + ...eteExternalcontactsContactNote-example.txt | 17 + ...ExternalcontactsContactsSchema-example.txt | 15 + ...teExternalcontactsOrganization-example.txt | 16 + ...ternalcontactsOrganizationNote-example.txt | 17 + ...nalcontactsOrganizationTrustor-example.txt | 15 + ...teExternalcontactsRelationship-example.txt | 16 + build/docs/deleteFaxDocument-example.txt | 15 + build/docs/deleteFlow-example.txt | 15 + build/docs/deleteFlows-example.txt | 16 + build/docs/deleteFlowsDatatable-example.txt | 16 + .../docs/deleteFlowsDatatableRow-example.txt | 16 + build/docs/deleteFlowsMilestone-example.txt | 16 + build/docs/deleteGreeting-example.txt | 15 + build/docs/deleteGroup-example.txt | 15 + build/docs/deleteGroupMembers-example.txt | 17 + .../deleteIdentityprovidersAdfs-example.txt | 15 + .../deleteIdentityprovidersCic-example.txt | 15 + ...deleteIdentityprovidersGeneric-example.txt | 15 + .../deleteIdentityprovidersGsuite-example.txt | 15 + ...teIdentityprovidersIdentitynow-example.txt | 15 + .../deleteIdentityprovidersOkta-example.txt | 15 + ...eleteIdentityprovidersOnelogin-example.txt | 15 + .../deleteIdentityprovidersPing-example.txt | 15 + ...leteIdentityprovidersPurecloud-example.txt | 15 + ...eteIdentityprovidersPureengage-example.txt | 15 + ...eteIdentityprovidersSalesforce-example.txt | 15 + build/docs/deleteIntegration-example.txt | 16 + .../docs/deleteIntegrationsAction-example.txt | 15 + .../deleteIntegrationsActionDraft-example.txt | 15 + .../deleteIntegrationsCredential-example.txt | 15 + build/docs/deleteJourneyActionmap-example.txt | 15 + .../deleteJourneyActiontemplate-example.txt | 16 + build/docs/deleteJourneyOutcome-example.txt | 15 + ...deleteJourneyOutcomesPredictor-example.txt | 15 + build/docs/deleteJourneySegment-example.txt | 15 + .../deleteKnowledgeKnowledgebase-example.txt | 16 + ...KnowledgeKnowledgebaseCategory-example.txt | 17 + ...KnowledgeKnowledgebaseDocument-example.txt | 16 + ...KnowledgebaseDocumentVariation-example.txt | 17 + ...nowledgeKnowledgebaseExportJob-example.txt | 16 + ...nowledgeKnowledgebaseImportJob-example.txt | 16 + ...eteKnowledgeKnowledgebaseLabel-example.txt | 17 + ...eKnowledgebaseLanguageCategory-example.txt | 18 + ...eKnowledgebaseLanguageDocument-example.txt | 18 + ...dgebaseLanguageDocumentsImport-example.txt | 17 + build/docs/deleteLanguage-example.txt | 15 + ...eteLanguageunderstandingDomain-example.txt | 15 + ...andingDomainFeedbackFeedbackId-example.txt | 16 + ...uageunderstandingDomainVersion-example.txt | 16 + ...leteLanguageunderstandingMiner-example.txt | 15 + ...anguageunderstandingMinerDraft-example.txt | 16 + .../docs/deleteLearningAssignment-example.txt | 15 + build/docs/deleteLearningModule-example.txt | 15 + build/docs/deleteLocation-example.txt | 15 + build/docs/deleteMessagingSetting-example.txt | 15 + ...deleteMessagingSettingsDefault-example.txt | 14 + ...ortedcontentSupportedContentId-example.txt | 15 + build/docs/deleteMobiledevice-example.txt | 15 + ...ificationsChannelSubscriptions-example.txt | 15 + build/docs/deleteOauthClient-example.txt | 15 + .../deleteOrgauthorizationTrustee-example.txt | 15 + ...authorizationTrusteeCloneduser-example.txt | 16 + ...teOrgauthorizationTrusteeGroup-example.txt | 16 + ...authorizationTrusteeGroupRoles-example.txt | 16 + ...eteOrgauthorizationTrusteeUser-example.txt | 16 + ...gauthorizationTrusteeUserRoles-example.txt | 16 + .../deleteOrgauthorizationTrustor-example.txt | 15 + ...authorizationTrustorCloneduser-example.txt | 16 + ...teOrgauthorizationTrustorGroup-example.txt | 16 + ...eteOrgauthorizationTrustorUser-example.txt | 16 + build/docs/deleteOrphanrecording-example.txt | 16 + .../deleteOutboundAttemptlimit-example.txt | 15 + .../deleteOutboundCallabletimeset-example.txt | 15 + ...utboundCallanalysisresponseset-example.txt | 15 + build/docs/deleteOutboundCampaign-example.txt | 16 + ...deleteOutboundCampaignProgress-example.txt | 15 + .../deleteOutboundCampaignrule-example.txt | 15 + .../deleteOutboundContactlist-example.txt | 15 + ...leteOutboundContactlistContact-example.txt | 16 + ...eteOutboundContactlistContacts-example.txt | 16 + ...eleteOutboundContactlistfilter-example.txt | 15 + .../deleteOutboundContactlists-example.txt | 15 + .../deleteOutboundDigitalruleset-example.txt | 15 + build/docs/deleteOutboundDnclist-example.txt | 15 + ...dDnclistCustomexclusioncolumns-example.txt | 16 + ...eOutboundDnclistEmailaddresses-example.txt | 16 + ...eteOutboundDnclistPhonenumbers-example.txt | 16 + ...eleteOutboundMessagingcampaign-example.txt | 16 + ...boundMessagingcampaignProgress-example.txt | 15 + build/docs/deleteOutboundRuleset-example.txt | 15 + ...eleteOutboundSchedulesCampaign-example.txt | 15 + ...OutboundSchedulesEmailcampaign-example.txt | 15 + ...oundSchedulesMessagingcampaign-example.txt | 15 + ...eleteOutboundSchedulesSequence-example.txt | 15 + build/docs/deleteOutboundSequence-example.txt | 15 + build/docs/deletePresenceSource-example.txt | 15 + .../docs/deletePresencedefinition-example.txt | 15 + ...deleteProcessautomationTrigger-example.txt | 15 + .../docs/deleteQualityCalibration-example.txt | 17 + ...eQualityConversationEvaluation-example.txt | 18 + build/docs/deleteQualityForm-example.txt | 15 + .../deleteQualityFormsEvaluation-example.txt | 15 + .../docs/deleteQualityFormsSurvey-example.txt | 15 + ...platformMediaretentionpolicies-example.txt | 15 + ...ssplatformMediaretentionpolicy-example.txt | 15 + build/docs/deleteRecordingJob-example.txt | 15 + ...ecordingMediaretentionpolicies-example.txt | 15 + ...eRecordingMediaretentionpolicy-example.txt | 15 + ...eleteResponsemanagementLibrary-example.txt | 15 + ...leteResponsemanagementResponse-example.txt | 15 + ...esponsemanagementResponseasset-example.txt | 15 + .../docs/deleteRoutingAssessment-example.txt | 15 + .../docs/deleteRoutingEmailDomain-example.txt | 15 + .../deleteRoutingEmailDomainRoute-example.txt | 16 + ...leteRoutingEmailOutboundDomain-example.txt | 15 + build/docs/deleteRoutingLanguage-example.txt | 15 + build/docs/deleteRoutingPredictor-example.txt | 15 + build/docs/deleteRoutingQueue-example.txt | 16 + .../docs/deleteRoutingQueueMember-example.txt | 16 + build/docs/deleteRoutingQueueUser-example.txt | 16 + .../deleteRoutingQueueWrapupcode-example.txt | 16 + build/docs/deleteRoutingSettings-example.txt | 14 + build/docs/deleteRoutingSkill-example.txt | 15 + .../docs/deleteRoutingSkillgroup-example.txt | 15 + .../docs/deleteRoutingSmsAddress-example.txt | 15 + .../deleteRoutingSmsPhonenumber-example.txt | 15 + .../deleteRoutingUserUtilization-example.txt | 15 + .../docs/deleteRoutingUtilization-example.txt | 14 + .../docs/deleteRoutingWrapupcode-example.txt | 15 + build/docs/deleteScimUser-example.txt | 17 + build/docs/deleteScimV2User-example.txt | 17 + ...ryfeedbackDictionaryFeedbackId-example.txt | 15 + ...eSpeechandtextanalyticsProgram-example.txt | 16 + ...textanalyticsSentimentfeedback-example.txt | 14 + ...entfeedbackSentimentFeedbackId-example.txt | 15 + ...eteSpeechandtextanalyticsTopic-example.txt | 15 + .../deleteStationAssociateduser-example.txt | 15 + build/docs/deleteTeam-example.txt | 15 + build/docs/deleteTeamMembers-example.txt | 16 + .../deleteTelephonyProvidersEdge-example.txt | 15 + ...yProvidersEdgeLogicalinterface-example.txt | 16 + ...onyProvidersEdgeSoftwareupdate-example.txt | 15 + ...idersEdgesCertificateauthority-example.txt | 15 + ...TelephonyProvidersEdgesDidpool-example.txt | 15 + ...lephonyProvidersEdgesEdgegroup-example.txt | 15 + ...onyProvidersEdgesExtensionpool-example.txt | 15 + ...teTelephonyProvidersEdgesPhone-example.txt | 15 + ...ProvidersEdgesPhonebasesetting-example.txt | 15 + ...eteTelephonyProvidersEdgesSite-example.txt | 15 + ...rovidersEdgesSiteOutboundroute-example.txt | 16 + ...ProvidersEdgesTrunkbasesetting-example.txt | 15 + build/docs/deleteToken-example.txt | 15 + build/docs/deleteTokensMe-example.txt | 14 + build/docs/deleteUser-example.txt | 16 + .../deleteUserRoutinglanguage-example.txt | 16 + build/docs/deleteUserRoutingskill-example.txt | 16 + ...teUserStationAssociatedstation-example.txt | 15 + ...eleteUserStationDefaultstation-example.txt | 15 + build/docs/deleteUserrecording-example.txt | 15 + build/docs/deleteVoicemailMessage-example.txt | 15 + .../docs/deleteVoicemailMessages-example.txt | 14 + .../docs/deleteWebchatDeployment-example.txt | 15 + ...WebchatGuestConversationMember-example.txt | 16 + build/docs/deleteWebchatSettings-example.txt | 14 + ...eteWebdeploymentsConfiguration-example.txt | 15 + ...deleteWebdeploymentsDeployment-example.txt | 15 + ...ntsDeploymentCobrowseSessionId-example.txt | 17 + ...eleteWebdeploymentsTokenRevoke-example.txt | 16 + .../docs/deleteWidgetsDeployment-example.txt | 15 + ...orkforcemanagementBusinessunit-example.txt | 15 + ...gementBusinessunitActivitycode-example.txt | 16 + ...ementBusinessunitPlanninggroup-example.txt | 16 + ...ementBusinessunitSchedulingRun-example.txt | 16 + ...usinessunitServicegoaltemplate-example.txt | 16 + ...gementBusinessunitWeekSchedule-example.txt | 18 + ...inessunitWeekShorttermforecast-example.txt | 17 + ...kforcemanagementCalendarUrlIcs-example.txt | 14 + ...kforcemanagementManagementunit-example.txt | 15 + ...mentManagementunitTimeofflimit-example.txt | 16 + ...ementManagementunitTimeoffplan-example.txt | 16 + ...nagementManagementunitWorkplan-example.txt | 16 + ...ManagementunitWorkplanrotation-example.txt | 16 + build/docs/getAlertingAlert-example.txt | 16 + .../docs/getAlertingAlertsActive-example.txt | 15 + ...tAlertingInteractionstatsAlert-example.txt | 17 + ...AlertingInteractionstatsAlerts-example.txt | 16 + ...ngInteractionstatsAlertsUnread-example.txt | 15 + ...etAlertingInteractionstatsRule-example.txt | 17 + ...tAlertingInteractionstatsRules-example.txt | 16 + build/docs/getAlertingRule-example.txt | 16 + ...AnalyticsBotflowReportingturns-example.txt | 23 + ...etAnalyticsConversationDetails-example.txt | 16 + ...tAnalyticsConversationsDetails-example.txt | 16 + ...alyticsConversationsDetailsJob-example.txt | 16 + ...ConversationsDetailsJobResults-example.txt | 18 + ...sationsDetailsJobsAvailability-example.txt | 15 + ...AnalyticsDataretentionSettings-example.txt | 15 + .../getAnalyticsReportingExports-example.txt | 17 + ...lyticsReportingExportsMetadata-example.txt | 15 + .../getAnalyticsReportingMetadata-example.txt | 18 + ...yticsReportingReportIdMetadata-example.txt | 17 + ...nalyticsReportingReportformats-example.txt | 15 + .../getAnalyticsReportingSchedule-example.txt | 16 + ...lyticsReportingScheduleHistory-example.txt | 18 + ...ReportingScheduleHistoryLatest-example.txt | 16 + ...sReportingScheduleHistoryRunId-example.txt | 17 + ...getAnalyticsReportingSchedules-example.txt | 17 + .../getAnalyticsReportingSettings-example.txt | 15 + ...tAnalyticsReportingTimeperiods-example.txt | 15 + .../getAnalyticsUsersDetailsJob-example.txt | 16 + ...nalyticsUsersDetailsJobResults-example.txt | 18 + ...csUsersDetailsJobsAvailability-example.txt | 15 + ...getArchitectDependencytracking-example.txt | 23 + ...chitectDependencytrackingBuild-example.txt | 15 + ...dencytrackingConsumedresources-example.txt | 21 + ...encytrackingConsumingresources-example.txt | 22 + ...ackingDeletedresourceconsumers-example.txt | 22 + ...hitectDependencytrackingObject-example.txt | 23 + ...rchitectDependencytrackingType-example.txt | 16 + ...chitectDependencytrackingTypes-example.txt | 17 + ...ackingUpdatedresourceconsumers-example.txt | 21 + .../getArchitectEmergencygroup-example.txt | 16 + .../getArchitectEmergencygroups-example.txt | 20 + ...ctEmergencygroupsDivisionviews-example.txt | 22 + build/docs/getArchitectIvr-example.txt | 16 + build/docs/getArchitectIvrs-example.txt | 22 + .../getArchitectIvrsDivisionviews-example.txt | 22 + build/docs/getArchitectPrompt-example.txt | 16 + ...rchitectPromptHistoryHistoryId-example.txt | 22 + .../getArchitectPromptResource-example.txt | 17 + .../getArchitectPromptResources-example.txt | 18 + build/docs/getArchitectPrompts-example.txt | 22 + build/docs/getArchitectSchedule-example.txt | 16 + .../getArchitectSchedulegroup-example.txt | 16 + .../getArchitectSchedulegroups-example.txt | 22 + ...ectSchedulegroupsDivisionviews-example.txt | 22 + build/docs/getArchitectSchedules-example.txt | 21 + ...rchitectSchedulesDivisionviews-example.txt | 22 + .../docs/getArchitectSystemprompt-example.txt | 16 + ...ctSystempromptHistoryHistoryId-example.txt | 22 + ...tArchitectSystempromptResource-example.txt | 17 + ...ArchitectSystempromptResources-example.txt | 20 + .../getArchitectSystemprompts-example.txt | 22 + ...itsQueryRealtimeServicemapping-example.txt | 15 + .../getAuditsQueryServicemapping-example.txt | 15 + .../getAuditsQueryTransactionId-example.txt | 16 + ...uditsQueryTransactionIdResults-example.txt | 19 + .../docs/getAuthorizationDivision-example.txt | 17 + ...getAuthorizationDivisionGrants-example.txt | 18 + .../getAuthorizationDivisions-example.txt | 24 + .../getAuthorizationDivisionsHome-example.txt | 15 + ...getAuthorizationDivisionsLimit-example.txt | 15 + ...horizationDivisionspermittedMe-example.txt | 17 + ...ationDivisionspermittedPagedMe-example.txt | 18 + ...visionspermittedPagedSubjectId-example.txt | 19 + .../getAuthorizationPermissions-example.txt | 19 + .../docs/getAuthorizationProducts-example.txt | 15 + build/docs/getAuthorizationRole-example.txt | 18 + ...nRoleComparedefaultRightRoleId-example.txt | 17 + ...AuthorizationRoleSubjectgrants-example.txt | 22 + .../getAuthorizationRoleUsers-example.txt | 18 + build/docs/getAuthorizationRoles-example.txt | 26 + .../docs/getAuthorizationSettings-example.txt | 15 + .../docs/getAuthorizationSubject-example.txt | 16 + .../getAuthorizationSubjectsMe-example.txt | 15 + ...uthorizationSubjectsRolecounts-example.txt | 16 + ...getBillingReportsBillableusage-example.txt | 17 + ...teebillingoverviewTrustorOrgId-example.txt | 17 + ...tegrationsEmergencylocationsMe-example.txt | 16 + build/docs/getChatSettings-example.txt | 15 + build/docs/getChatsSettings-example.txt | 15 + build/docs/getCoachingAppointment-example.txt | 16 + ...tCoachingAppointmentAnnotation-example.txt | 17 + ...CoachingAppointmentAnnotations-example.txt | 18 + ...getCoachingAppointmentStatuses-example.txt | 18 + .../docs/getCoachingAppointments-example.txt | 26 + .../getCoachingAppointmentsMe-example.txt | 25 + .../docs/getCoachingNotification-example.txt | 17 + .../docs/getCoachingNotifications-example.txt | 18 + .../getContentmanagementDocument-example.txt | 17 + ...ontentmanagementDocumentAudits-example.txt | 22 + ...ntentmanagementDocumentContent-example.txt | 18 + .../getContentmanagementDocuments-example.txt | 22 + .../getContentmanagementQuery-example.txt | 21 + ...ntentmanagementSecurityprofile-example.txt | 16 + ...tentmanagementSecurityprofiles-example.txt | 15 + .../getContentmanagementShare-example.txt | 17 + ...ontentmanagementSharedSharedId-example.txt | 20 + .../getContentmanagementShares-example.txt | 19 + .../getContentmanagementStatus-example.txt | 17 + ...ontentmanagementStatusStatusId-example.txt | 16 + .../getContentmanagementUsage-example.txt | 15 + .../getContentmanagementWorkspace-example.txt | 17 + ...ntmanagementWorkspaceDocuments-example.txt | 21 + ...ntentmanagementWorkspaceMember-example.txt | 18 + ...tentmanagementWorkspaceMembers-example.txt | 19 + ...entmanagementWorkspaceTagvalue-example.txt | 18 + ...ntmanagementWorkspaceTagvalues-example.txt | 20 + ...getContentmanagementWorkspaces-example.txt | 19 + build/docs/getConversation-example.txt | 16 + ...ionParticipantSecureivrsession-example.txt | 18 + ...onParticipantSecureivrsessions-example.txt | 17 + ...tConversationParticipantWrapup-example.txt | 18 + ...ersationParticipantWrapupcodes-example.txt | 17 + .../docs/getConversationRecording-example.txt | 25 + ...onversationRecordingAnnotation-example.txt | 18 + ...nversationRecordingAnnotations-example.txt | 17 + ...tConversationRecordingmetadata-example.txt | 16 + ...onRecordingmetadataRecordingId-example.txt | 17 + .../getConversationRecordings-example.txt | 19 + ...etConversationSecureattributes-example.txt | 16 + build/docs/getConversations-example.txt | 16 + build/docs/getConversationsCall-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...ersationsCallParticipantWrapup-example.txt | 18 + ...ionsCallParticipantWrapupcodes-example.txt | 17 + .../docs/getConversationsCallback-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...tionsCallbackParticipantWrapup-example.txt | 18 + ...CallbackParticipantWrapupcodes-example.txt | 17 + .../getConversationsCallbacks-example.txt | 15 + build/docs/getConversationsCalls-example.txt | 15 + .../getConversationsCallsHistory-example.txt | 19 + ...sCallsMaximumconferenceparties-example.txt | 15 + build/docs/getConversationsChat-example.txt | 16 + .../getConversationsChatMessage-example.txt | 17 + .../getConversationsChatMessages-example.txt | 20 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...ersationsChatParticipantWrapup-example.txt | 18 + ...ionsChatParticipantWrapupcodes-example.txt | 17 + build/docs/getConversationsChats-example.txt | 15 + ...etConversationsCobrowsesession-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...browsesessionParticipantWrapup-example.txt | 18 + ...esessionParticipantWrapupcodes-example.txt | 17 + ...tConversationsCobrowsesessions-example.txt | 15 + build/docs/getConversationsEmail-example.txt | 16 + .../getConversationsEmailMessage-example.txt | 17 + .../getConversationsEmailMessages-example.txt | 16 + ...onversationsEmailMessagesDraft-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...rsationsEmailParticipantWrapup-example.txt | 18 + ...onsEmailParticipantWrapupcodes-example.txt | 17 + .../getConversationsEmailSettings-example.txt | 16 + build/docs/getConversationsEmails-example.txt | 15 + ...tConversationsKeyconfiguration-example.txt | 16 + ...ConversationsKeyconfigurations-example.txt | 15 + .../docs/getConversationsMessage-example.txt | 16 + ...municationMessagesMediaMediaId-example.txt | 18 + ...getConversationsMessageDetails-example.txt | 17 + ...getConversationsMessageMessage-example.txt | 18 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...ationsMessageParticipantWrapup-example.txt | 18 + ...sMessageParticipantWrapupcodes-example.txt | 17 + .../docs/getConversationsMessages-example.txt | 15 + ...nversationsMessagesCachedmedia-example.txt | 18 + ...esCachedmediaCachedMediaItemId-example.txt | 16 + ...versationsMessagingFacebookApp-example.txt | 15 + ...ersationsMessagingIntegrations-example.txt | 20 + ...sMessagingIntegrationsFacebook-example.txt | 20 + ...egrationsFacebookIntegrationId-example.txt | 17 + ...MessagingIntegrationsInstagram-example.txt | 20 + ...grationsInstagramIntegrationId-example.txt | 17 + ...tionsMessagingIntegrationsLine-example.txt | 20 + ...gIntegrationsLineIntegrationId-example.txt | 17 + ...tionsMessagingIntegrationsOpen-example.txt | 20 + ...gIntegrationsOpenIntegrationId-example.txt | 17 + ...nsMessagingIntegrationsTwitter-example.txt | 20 + ...tegrationsTwitterIntegrationId-example.txt | 17 + ...sMessagingIntegrationsWhatsapp-example.txt | 20 + ...egrationsWhatsappIntegrationId-example.txt | 17 + ...tConversationsMessagingSetting-example.txt | 16 + ...ConversationsMessagingSettings-example.txt | 17 + ...ationsMessagingSettingsDefault-example.txt | 15 + ...tConversationsMessagingSticker-example.txt | 18 + ...tionsMessagingSupportedcontent-example.txt | 17 + ...ssagingSupportedcontentDefault-example.txt | 15 + ...ortedcontentSupportedContentId-example.txt | 16 + ...ionsMessagingThreadingtimeline-example.txt | 15 + ...ParticipantCommunicationWrapup-example.txt | 19 + .../docs/getConversationsSettings-example.txt | 15 + ...ParticipantCommunicationWrapup-example.txt | 19 + ...ParticipantCommunicationWrapup-example.txt | 19 + .../getDataextensionsCoretype-example.txt | 16 + .../getDataextensionsCoretypes-example.txt | 15 + .../docs/getDataextensionsLimits-example.txt | 15 + build/docs/getDate-example.txt | 15 + .../getDocumentationGknSearch-example.txt | 16 + build/docs/getDocumentationSearch-example.txt | 16 + build/docs/getDownload-example.txt | 19 + build/docs/getEmailsSettings-example.txt | 15 + ...manceExternalmetricsDefinition-example.txt | 16 + ...anceExternalmetricsDefinitions-example.txt | 17 + .../getExternalcontactsContact-example.txt | 17 + ...rnalcontactsContactIdentifiers-example.txt | 16 + ...contactsContactJourneySessions-example.txt | 19 + ...getExternalcontactsContactNote-example.txt | 18 + ...etExternalcontactsContactNotes-example.txt | 20 + ...ernalcontactsContactUnresolved-example.txt | 17 + .../getExternalcontactsContacts-example.txt | 20 + ...ExternalcontactsContactsSchema-example.txt | 16 + ...lcontactsContactsSchemaVersion-example.txt | 17 + ...contactsContactsSchemaVersions-example.txt | 16 + ...xternalcontactsContactsSchemas-example.txt | 15 + ...etExternalcontactsOrganization-example.txt | 18 + ...alcontactsOrganizationContacts-example.txt | 21 + ...ternalcontactsOrganizationNote-example.txt | 18 + ...ernalcontactsOrganizationNotes-example.txt | 20 + ...tactsOrganizationRelationships-example.txt | 20 + ...tExternalcontactsOrganizations-example.txt | 22 + ...nalcontactsOrganizationsSchema-example.txt | 16 + ...actsOrganizationsSchemaVersion-example.txt | 17 + ...ctsOrganizationsSchemaVersions-example.txt | 16 + ...alcontactsOrganizationsSchemas-example.txt | 15 + ...etExternalcontactsRelationship-example.txt | 17 + ...ontactsReversewhitepageslookup-example.txt | 17 + ...etExternalcontactsScanContacts-example.txt | 17 + .../getExternalcontactsScanNotes-example.txt | 17 + ...ernalcontactsScanOrganizations-example.txt | 17 + ...ernalcontactsScanRelationships-example.txt | 17 + build/docs/getFaxDocument-example.txt | 16 + build/docs/getFaxDocumentContent-example.txt | 16 + build/docs/getFaxDocuments-example.txt | 17 + build/docs/getFaxSummary-example.txt | 15 + build/docs/getFieldconfig-example.txt | 16 + build/docs/getFlow-example.txt | 17 + .../docs/getFlowHistoryHistoryId-example.txt | 22 + .../getFlowLatestconfiguration-example.txt | 17 + build/docs/getFlowVersion-example.txt | 18 + .../getFlowVersionConfiguration-example.txt | 18 + build/docs/getFlowVersionHealth-example.txt | 18 + .../getFlowVersionIntentHealth-example.txt | 19 + ...owVersionIntentUtteranceHealth-example.txt | 20 + build/docs/getFlowVersions-example.txt | 19 + build/docs/getFlows-example.txt | 34 + build/docs/getFlowsDatatable-example.txt | 17 + .../getFlowsDatatableExportJob-example.txt | 17 + .../getFlowsDatatableImportJob-example.txt | 17 + .../getFlowsDatatableImportJobs-example.txt | 18 + build/docs/getFlowsDatatableRow-example.txt | 18 + build/docs/getFlowsDatatableRows-example.txt | 20 + build/docs/getFlowsDatatables-example.txt | 22 + ...getFlowsDatatablesDivisionview-example.txt | 17 + ...etFlowsDatatablesDivisionviews-example.txt | 22 + build/docs/getFlowsDivisionviews-example.txt | 27 + build/docs/getFlowsExecution-example.txt | 16 + build/docs/getFlowsJob-example.txt | 17 + build/docs/getFlowsMilestone-example.txt | 16 + build/docs/getFlowsMilestones-example.txt | 24 + ...etFlowsMilestonesDivisionviews-example.txt | 22 + build/docs/getFlowsOutcome-example.txt | 16 + build/docs/getFlowsOutcomes-example.txt | 24 + .../getFlowsOutcomesDivisionviews-example.txt | 22 + .../docs/getGamificationInsights-example.txt | 26 + ...getGamificationInsightsDetails-example.txt | 20 + ...mificationInsightsGroupsTrends-example.txt | 22 + ...icationInsightsGroupsTrendsAll-example.txt | 22 + ...getGamificationInsightsMembers-example.txt | 19 + .../getGamificationInsightsTrends-example.txt | 22 + ...amificationInsightsUserDetails-example.txt | 21 + ...GamificationInsightsUserTrends-example.txt | 23 + .../getGamificationLeaderboard-example.txt | 18 + .../getGamificationLeaderboardAll-example.txt | 20 + ...cationLeaderboardAllBestpoints-example.txt | 17 + ...ificationLeaderboardBestpoints-example.txt | 15 + ...etGamificationMetricdefinition-example.txt | 16 + ...tGamificationMetricdefinitions-example.txt | 15 + build/docs/getGamificationProfile-example.txt | 16 + .../getGamificationProfileMembers-example.txt | 16 + .../getGamificationProfileMetric-example.txt | 18 + .../getGamificationProfileMetrics-example.txt | 19 + ...ProfileMetricsObjectivedetails-example.txt | 17 + .../docs/getGamificationProfiles-example.txt | 15 + .../getGamificationProfilesUser-example.txt | 17 + ...getGamificationProfilesUsersMe-example.txt | 16 + .../getGamificationScorecards-example.txt | 17 + ...mificationScorecardsAttendance-example.txt | 17 + ...mificationScorecardsBestpoints-example.txt | 15 + ...icationScorecardsPointsAlltime-example.txt | 16 + ...icationScorecardsPointsAverage-example.txt | 16 + ...ficationScorecardsPointsTrends-example.txt | 18 + ...sProfileMetricUserValuesTrends-example.txt | 22 + ...ProfileMetricUsersValuesTrends-example.txt | 23 + ...cardsProfileMetricValuesTrends-example.txt | 22 + .../getGamificationScorecardsUser-example.txt | 18 + ...cationScorecardsUserAttendance-example.txt | 18 + ...cationScorecardsUserBestpoints-example.txt | 16 + ...ionScorecardsUserPointsAlltime-example.txt | 17 + ...tionScorecardsUserPointsTrends-example.txt | 19 + ...tionScorecardsUserValuesTrends-example.txt | 19 + ...onScorecardsUsersPointsAverage-example.txt | 18 + ...onScorecardsUsersValuesAverage-example.txt | 19 + ...ionScorecardsUsersValuesTrends-example.txt | 20 + ...icationScorecardsValuesAverage-example.txt | 17 + ...ficationScorecardsValuesTrends-example.txt | 20 + build/docs/getGamificationStatus-example.txt | 15 + .../docs/getGamificationTemplate-example.txt | 16 + .../docs/getGamificationTemplates-example.txt | 15 + build/docs/getGdprRequest-example.txt | 16 + build/docs/getGdprRequests-example.txt | 17 + build/docs/getGdprSubjects-example.txt | 17 + .../docs/getGeolocationsSettings-example.txt | 15 + build/docs/getGreeting-example.txt | 16 + build/docs/getGreetingMedia-example.txt | 17 + build/docs/getGreetings-example.txt | 17 + build/docs/getGreetingsDefaults-example.txt | 15 + build/docs/getGroup-example.txt | 16 + build/docs/getGroupGreetings-example.txt | 18 + .../getGroupGreetingsDefaults-example.txt | 16 + build/docs/getGroupIndividuals-example.txt | 16 + build/docs/getGroupMembers-example.txt | 20 + build/docs/getGroupProfile-example.txt | 17 + build/docs/getGroups-example.txt | 20 + build/docs/getGroupsSearch-example.txt | 17 + build/docs/getIdentityproviders-example.txt | 15 + .../docs/getIdentityprovidersAdfs-example.txt | 15 + .../docs/getIdentityprovidersCic-example.txt | 15 + .../getIdentityprovidersGeneric-example.txt | 15 + .../getIdentityprovidersGsuite-example.txt | 15 + ...etIdentityprovidersIdentitynow-example.txt | 15 + .../docs/getIdentityprovidersOkta-example.txt | 15 + .../getIdentityprovidersOnelogin-example.txt | 15 + .../docs/getIdentityprovidersPing-example.txt | 15 + .../getIdentityprovidersPurecloud-example.txt | 15 + ...getIdentityprovidersPureengage-example.txt | 15 + ...getIdentityprovidersSalesforce-example.txt | 15 + ...nfrastructureascodeAccelerator-example.txt | 17 + ...frastructureascodeAccelerators-example.txt | 25 + .../getInfrastructureascodeJob-example.txt | 17 + .../getInfrastructureascodeJobs-example.txt | 22 + build/docs/getIntegration-example.txt | 22 + .../getIntegrationConfigCurrent-example.txt | 16 + build/docs/getIntegrations-example.txt | 21 + build/docs/getIntegrationsAction-example.txt | 18 + .../getIntegrationsActionDraft-example.txt | 18 + ...tIntegrationsActionDraftSchema-example.txt | 17 + ...ntegrationsActionDraftTemplate-example.txt | 17 + ...egrationsActionDraftValidation-example.txt | 16 + .../getIntegrationsActionSchema-example.txt | 17 + .../getIntegrationsActionTemplate-example.txt | 17 + build/docs/getIntegrationsActions-example.txt | 26 + ...tIntegrationsActionsCategories-example.txt | 22 + .../getIntegrationsActionsDrafts-example.txt | 26 + ...nsBotconnectorIntegrationIdBot-example.txt | 18 + ...nectorIntegrationIdBotVersions-example.txt | 19 + ...sBotconnectorIntegrationIdBots-example.txt | 16 + ...ctorIntegrationIdBotsSummaries-example.txt | 18 + .../getIntegrationsClientapps-example.txt | 21 + ...lientappsUnifiedcommunications-example.txt | 21 + .../getIntegrationsCredential-example.txt | 16 + .../getIntegrationsCredentials-example.txt | 17 + ...etIntegrationsCredentialsTypes-example.txt | 15 + ...egrationsSpeechDialogflowAgent-example.txt | 16 + ...grationsSpeechDialogflowAgents-example.txt | 18 + ...tIntegrationsSpeechLexBotAlias-example.txt | 16 + ...ationsSpeechLexBotBotIdAliases-example.txt | 20 + .../getIntegrationsSpeechLexBots-example.txt | 18 + ...getIntegrationsSpeechTtsEngine-example.txt | 17 + ...tegrationsSpeechTtsEngineVoice-example.txt | 17 + ...egrationsSpeechTtsEngineVoices-example.txt | 18 + ...etIntegrationsSpeechTtsEngines-example.txt | 20 + ...tIntegrationsSpeechTtsSettings-example.txt | 15 + build/docs/getIntegrationsType-example.txt | 16 + ...etIntegrationsTypeConfigschema-example.txt | 17 + build/docs/getIntegrationsTypes-example.txt | 21 + .../docs/getIntegrationsUserapps-example.txt | 22 + build/docs/getIpranges-example.txt | 15 + build/docs/getJourneyActionmap-example.txt | 16 + build/docs/getJourneyActionmaps-example.txt | 23 + ...tJourneyActionmapsEstimatesJob-example.txt | 16 + ...yActionmapsEstimatesJobResults-example.txt | 16 + build/docs/getJourneyActiontarget-example.txt | 16 + .../docs/getJourneyActiontargets-example.txt | 17 + .../docs/getJourneyActiontemplate-example.txt | 16 + .../getJourneyActiontemplates-example.txt | 22 + build/docs/getJourneyOutcome-example.txt | 16 + build/docs/getJourneyOutcomes-example.txt | 21 + .../getJourneyOutcomesPredictor-example.txt | 16 + .../getJourneyOutcomesPredictors-example.txt | 15 + build/docs/getJourneySegment-example.txt | 16 + build/docs/getJourneySegments-example.txt | 22 + build/docs/getJourneySession-example.txt | 16 + ...getJourneySessionOutcomescores-example.txt | 16 + ...nowledgeGuestSessionCategories-example.txt | 25 + ...tKnowledgeGuestSessionDocument-example.txt | 17 + ...KnowledgeGuestSessionDocuments-example.txt | 18 + .../getKnowledgeKnowledgebase-example.txt | 16 + ...owledgeKnowledgebaseCategories-example.txt | 25 + ...KnowledgeKnowledgebaseCategory-example.txt | 17 + ...KnowledgeKnowledgebaseDocument-example.txt | 19 + ...eKnowledgebaseDocumentFeedback-example.txt | 28 + ...baseDocumentFeedbackFeedbackId-example.txt | 18 + ...KnowledgebaseDocumentVariation-example.txt | 19 + ...nowledgebaseDocumentVariations-example.txt | 21 + ...geKnowledgebaseDocumentVersion-example.txt | 19 + ...gebaseDocumentVersionVariation-example.txt | 19 + ...ebaseDocumentVersionVariations-example.txt | 21 + ...eKnowledgebaseDocumentVersions-example.txt | 21 + ...nowledgeKnowledgebaseDocuments-example.txt | 27 + ...nowledgeKnowledgebaseExportJob-example.txt | 17 + ...nowledgeKnowledgebaseImportJob-example.txt | 18 + ...getKnowledgeKnowledgebaseLabel-example.txt | 17 + ...etKnowledgeKnowledgebaseLabels-example.txt | 21 + ...nowledgebaseLanguageCategories-example.txt | 22 + ...eKnowledgebaseLanguageCategory-example.txt | 18 + ...eKnowledgebaseLanguageDocument-example.txt | 18 + ...KnowledgebaseLanguageDocuments-example.txt | 26 + ...dgebaseLanguageDocumentsImport-example.txt | 18 + ...eKnowledgebaseLanguageTraining-example.txt | 18 + ...KnowledgebaseLanguageTrainings-example.txt | 22 + ...geKnowledgebaseUnansweredGroup-example.txt | 20 + ...baseUnansweredGroupPhrasegroup-example.txt | 21 + ...eKnowledgebaseUnansweredGroups-example.txt | 19 + .../getKnowledgeKnowledgebases-example.txt | 24 + build/docs/getLanguage-example.txt | 16 + build/docs/getLanguages-example.txt | 19 + .../docs/getLanguagesTranslations-example.txt | 15 + ...etLanguagesTranslationsBuiltin-example.txt | 16 + ...guagesTranslationsOrganization-example.txt | 16 + .../getLanguagesTranslationsUser-example.txt | 16 + ...getLanguageunderstandingDomain-example.txt | 16 + ...ageunderstandingDomainFeedback-example.txt | 28 + ...andingDomainFeedbackFeedbackId-example.txt | 18 + ...uageunderstandingDomainVersion-example.txt | 18 + ...derstandingDomainVersionReport-example.txt | 17 + ...ageunderstandingDomainVersions-example.txt | 19 + ...etLanguageunderstandingDomains-example.txt | 17 + .../getLanguageunderstandingMiner-example.txt | 16 + ...anguageunderstandingMinerDraft-example.txt | 19 + ...nguageunderstandingMinerDrafts-example.txt | 16 + ...nguageunderstandingMinerIntent-example.txt | 18 + ...guageunderstandingMinerIntents-example.txt | 17 + ...anguageunderstandingMinerTopic-example.txt | 18 + ...eunderstandingMinerTopicPhrase-example.txt | 18 + ...nguageunderstandingMinerTopics-example.txt | 16 + ...getLanguageunderstandingMiners-example.txt | 16 + build/docs/getLearningAssignment-example.txt | 17 + build/docs/getLearningAssignments-example.txt | 30 + .../docs/getLearningAssignmentsMe-example.txt | 29 + build/docs/getLearningModule-example.txt | 17 + build/docs/getLearningModuleJob-example.txt | 17 + build/docs/getLearningModuleRule-example.txt | 16 + .../docs/getLearningModuleVersion-example.txt | 18 + build/docs/getLearningModules-example.txt | 25 + .../getLearningModulesAssignments-example.txt | 22 + ...rningModulesCoverartCoverArtId-example.txt | 16 + build/docs/getLicenseDefinition-example.txt | 16 + build/docs/getLicenseDefinitions-example.txt | 15 + build/docs/getLicenseToggle-example.txt | 16 + build/docs/getLicenseUser-example.txt | 16 + build/docs/getLicenseUsers-example.txt | 17 + build/docs/getLocation-example.txt | 17 + .../docs/getLocationSublocations-example.txt | 16 + build/docs/getLocations-example.txt | 19 + build/docs/getLocationsSearch-example.txt | 17 + build/docs/getMessagingSetting-example.txt | 16 + build/docs/getMessagingSettings-example.txt | 17 + .../getMessagingSettingsDefault-example.txt | 15 + .../getMessagingSupportedcontent-example.txt | 17 + ...ortedcontentSupportedContentId-example.txt | 16 + build/docs/getMobiledevice-example.txt | 16 + build/docs/getMobiledevices-example.txt | 18 + ...etNotificationsAvailabletopics-example.txt | 17 + ...ificationsChannelSubscriptions-example.txt | 16 + .../docs/getNotificationsChannels-example.txt | 16 + build/docs/getOauthAuthorization-example.txt | 17 + build/docs/getOauthAuthorizations-example.txt | 16 + build/docs/getOauthClient-example.txt | 16 + ...getOauthClientUsageQueryResult-example.txt | 17 + .../getOauthClientUsageSummary-example.txt | 17 + build/docs/getOauthClients-example.txt | 15 + build/docs/getOauthScope-example.txt | 17 + build/docs/getOauthScopes-example.txt | 16 + ...izationsAuthenticationSettings-example.txt | 15 + ...ganizationsEmbeddedintegration-example.txt | 15 + ...zationsIpaddressauthentication-example.txt | 15 + ...ganizationsLimitsChangerequest-example.txt | 16 + ...anizationsLimitsChangerequests-example.txt | 20 + .../getOrganizationsLimitsDocs-example.txt | 15 + ...etOrganizationsLimitsNamespace-example.txt | 16 + ...zationsLimitsNamespaceDefaults-example.txt | 16 + ...tOrganizationsLimitsNamespaces-example.txt | 17 + build/docs/getOrganizationsMe-example.txt | 15 + .../getOrganizationsWhitelist-example.txt | 15 + .../getOrgauthorizationPairing-example.txt | 16 + .../getOrgauthorizationTrustee-example.txt | 16 + ...uthorizationTrusteeClonedusers-example.txt | 16 + ...etOrgauthorizationTrusteeGroup-example.txt | 17 + ...authorizationTrusteeGroupRoles-example.txt | 17 + ...tOrgauthorizationTrusteeGroups-example.txt | 18 + ...getOrgauthorizationTrusteeUser-example.txt | 17 + ...gauthorizationTrusteeUserRoles-example.txt | 17 + ...etOrgauthorizationTrusteeUsers-example.txt | 18 + .../getOrgauthorizationTrustees-example.txt | 17 + ...rgauthorizationTrusteesDefault-example.txt | 15 + .../getOrgauthorizationTrustor-example.txt | 16 + ...authorizationTrustorCloneduser-example.txt | 17 + ...uthorizationTrustorClonedusers-example.txt | 16 + ...etOrgauthorizationTrustorGroup-example.txt | 17 + ...tOrgauthorizationTrustorGroups-example.txt | 18 + ...getOrgauthorizationTrustorUser-example.txt | 17 + ...etOrgauthorizationTrustorUsers-example.txt | 18 + .../getOrgauthorizationTrustors-example.txt | 17 + build/docs/getOrphanrecording-example.txt | 16 + .../docs/getOrphanrecordingMedia-example.txt | 24 + build/docs/getOrphanrecordings-example.txt | 23 + .../docs/getOutboundAttemptlimit-example.txt | 16 + .../docs/getOutboundAttemptlimits-example.txt | 22 + .../getOutboundCallabletimeset-example.txt | 16 + .../getOutboundCallabletimesets-example.txt | 22 + ...utboundCallanalysisresponseset-example.txt | 16 + ...tboundCallanalysisresponsesets-example.txt | 22 + build/docs/getOutboundCampaign-example.txt | 16 + ...gentownedmappingpreviewResults-example.txt | 16 + ...getOutboundCampaignDiagnostics-example.txt | 16 + ...etOutboundCampaignInteractions-example.txt | 16 + .../getOutboundCampaignProgress-example.txt | 16 + .../docs/getOutboundCampaignStats-example.txt | 16 + .../docs/getOutboundCampaignrule-example.txt | 16 + .../docs/getOutboundCampaignrules-example.txt | 22 + build/docs/getOutboundCampaigns-example.txt | 28 + .../docs/getOutboundCampaignsAll-example.txt | 22 + ...boundCampaignsAllDivisionviews-example.txt | 22 + ...tOutboundCampaignsDivisionview-example.txt | 16 + ...OutboundCampaignsDivisionviews-example.txt | 22 + build/docs/getOutboundContactlist-example.txt | 18 + .../getOutboundContactlistContact-example.txt | 17 + .../getOutboundContactlistExport-example.txt | 17 + ...utboundContactlistImportstatus-example.txt | 16 + ...tactlistTimezonemappingpreview-example.txt | 16 + .../getOutboundContactlistfilter-example.txt | 16 + .../getOutboundContactlistfilters-example.txt | 23 + .../docs/getOutboundContactlists-example.txt | 26 + ...tboundContactlistsDivisionview-example.txt | 18 + ...boundContactlistsDivisionviews-example.txt | 24 + .../getOutboundDigitalruleset-example.txt | 16 + .../getOutboundDigitalrulesets-example.txt | 21 + build/docs/getOutboundDnclist-example.txt | 18 + .../docs/getOutboundDnclistExport-example.txt | 17 + ...getOutboundDnclistImportstatus-example.txt | 16 + build/docs/getOutboundDnclists-example.txt | 26 + ...etOutboundDnclistsDivisionview-example.txt | 18 + ...tOutboundDnclistsDivisionviews-example.txt | 25 + build/docs/getOutboundEvent-example.txt | 16 + build/docs/getOutboundEvents-example.txt | 22 + .../getOutboundMessagingcampaign-example.txt | 16 + ...ndMessagingcampaignDiagnostics-example.txt | 16 + ...boundMessagingcampaignProgress-example.txt | 16 + .../getOutboundMessagingcampaigns-example.txt | 25 + ...MessagingcampaignsDivisionview-example.txt | 16 + ...essagingcampaignsDivisionviews-example.txt | 22 + build/docs/getOutboundRuleset-example.txt | 16 + build/docs/getOutboundRulesets-example.txt | 22 + .../getOutboundSchedulesCampaign-example.txt | 16 + .../getOutboundSchedulesCampaigns-example.txt | 15 + ...OutboundSchedulesEmailcampaign-example.txt | 16 + ...utboundSchedulesEmailcampaigns-example.txt | 15 + ...oundSchedulesMessagingcampaign-example.txt | 16 + ...undSchedulesMessagingcampaigns-example.txt | 15 + .../getOutboundSchedulesSequence-example.txt | 16 + .../getOutboundSchedulesSequences-example.txt | 15 + build/docs/getOutboundSequence-example.txt | 16 + build/docs/getOutboundSequences-example.txt | 22 + build/docs/getOutboundSettings-example.txt | 15 + .../getOutboundWrapupcodemappings-example.txt | 15 + build/docs/getPresenceSettings-example.txt | 15 + build/docs/getPresenceSource-example.txt | 16 + build/docs/getPresenceSources-example.txt | 16 + .../getPresenceUserPrimarysource-example.txt | 16 + build/docs/getPresencedefinition-example.txt | 17 + build/docs/getPresencedefinitions-example.txt | 19 + .../getProcessautomationTrigger-example.txt | 16 + .../getProcessautomationTriggers-example.txt | 21 + ...rocessautomationTriggersTopics-example.txt | 18 + build/docs/getProfilesGroups-example.txt | 20 + build/docs/getProfilesUsers-example.txt | 22 + .../docs/getQualityAgentsActivity-example.txt | 28 + build/docs/getQualityCalibration-example.txt | 18 + build/docs/getQualityCalibrations-example.txt | 25 + ...tQualityConversationEvaluation-example.txt | 18 + .../getQualityConversationSurveys-example.txt | 16 + ...ationsAuditsQueryTransactionId-example.txt | 16 + ...uditsQueryTransactionIdResults-example.txt | 19 + .../getQualityEvaluationsQuery-example.txt | 35 + .../getQualityEvaluatorsActivity-example.txt | 26 + build/docs/getQualityForm-example.txt | 16 + build/docs/getQualityFormVersions-example.txt | 18 + build/docs/getQualityForms-example.txt | 23 + .../getQualityFormsEvaluation-example.txt | 16 + ...QualityFormsEvaluationVersions-example.txt | 19 + .../getQualityFormsEvaluations-example.txt | 23 + ...tyFormsEvaluationsBulkContexts-example.txt | 16 + build/docs/getQualityFormsSurvey-example.txt | 16 + .../getQualityFormsSurveyVersions-example.txt | 18 + build/docs/getQualityFormsSurveys-example.txt | 23 + .../getQualityFormsSurveysBulk-example.txt | 16 + ...ualityFormsSurveysBulkContexts-example.txt | 17 + .../docs/getQualityPublishedform-example.txt | 16 + .../docs/getQualityPublishedforms-example.txt | 19 + ...ualityPublishedformsEvaluation-example.txt | 16 + ...alityPublishedformsEvaluations-example.txt | 19 + ...getQualityPublishedformsSurvey-example.txt | 16 + ...etQualityPublishedformsSurveys-example.txt | 19 + build/docs/getQualitySurvey-example.txt | 16 + .../getQualitySurveysScorable-example.txt | 16 + .../docs/getRecordingBatchrequest-example.txt | 16 + ...platformMediaretentionpolicies-example.txt | 26 + ...ssplatformMediaretentionpolicy-example.txt | 16 + build/docs/getRecordingJob-example.txt | 16 + ...etRecordingJobFailedrecordings-example.txt | 20 + build/docs/getRecordingJobs-example.txt | 23 + .../getRecordingKeyconfiguration-example.txt | 16 + .../getRecordingKeyconfigurations-example.txt | 15 + ...ecordingMediaretentionpolicies-example.txt | 26 + ...tRecordingMediaretentionpolicy-example.txt | 16 + .../getRecordingRecordingkeys-example.txt | 17 + ...gRecordingkeysRotationschedule-example.txt | 15 + build/docs/getRecordingSettings-example.txt | 16 + .../getRecordingUploadsReport-example.txt | 16 + .../getRecordingsRetentionQuery-example.txt | 18 + .../getRecordingsScreensessions-example.txt | 17 + ...getResponsemanagementLibraries-example.txt | 19 + .../getResponsemanagementLibrary-example.txt | 16 + .../getResponsemanagementResponse-example.txt | 17 + ...esponsemanagementResponseasset-example.txt | 16 + ...ntResponseassetsStatusStatusId-example.txt | 16 + ...getResponsemanagementResponses-example.txt | 19 + build/docs/getRoutingAssessment-example.txt | 16 + build/docs/getRoutingAssessments-example.txt | 20 + .../docs/getRoutingAssessmentsJob-example.txt | 16 + .../getRoutingAssessmentsJobs-example.txt | 16 + .../getRoutingAvailablemediatypes-example.txt | 15 + build/docs/getRoutingEmailDomain-example.txt | 16 + .../getRoutingEmailDomainRoute-example.txt | 17 + .../getRoutingEmailDomainRoutes-example.txt | 19 + build/docs/getRoutingEmailDomains-example.txt | 19 + .../getRoutingEmailOutboundDomain-example.txt | 16 + ...gEmailOutboundDomainActivation-example.txt | 16 + ...utingEmailOutboundDomainSearch-example.txt | 16 + ...getRoutingEmailOutboundDomains-example.txt | 16 + build/docs/getRoutingEmailSetup-example.txt | 15 + build/docs/getRoutingLanguage-example.txt | 16 + build/docs/getRoutingLanguages-example.txt | 20 + .../getRoutingMessageRecipient-example.txt | 16 + .../getRoutingMessageRecipients-example.txt | 19 + build/docs/getRoutingPredictor-example.txt | 16 + ...tRoutingPredictorModelFeatures-example.txt | 17 + .../getRoutingPredictorModels-example.txt | 16 + build/docs/getRoutingPredictors-example.txt | 20 + ...ictorsKeyperformanceindicators-example.txt | 17 + build/docs/getRoutingQueue-example.txt | 16 + ...etRoutingQueueComparisonperiod-example.txt | 17 + ...tRoutingQueueComparisonperiods-example.txt | 16 + ...tRoutingQueueEstimatedwaittime-example.txt | 17 + ...ueueMediatypeEstimatedwaittime-example.txt | 17 + build/docs/getRoutingQueueMembers-example.txt | 28 + build/docs/getRoutingQueueUsers-example.txt | 27 + .../getRoutingQueueWrapupcodes-example.txt | 18 + build/docs/getRoutingQueues-example.txt | 23 + .../getRoutingQueuesDivisionviews-example.txt | 22 + ...tRoutingQueuesDivisionviewsAll-example.txt | 18 + build/docs/getRoutingQueuesMe-example.txt | 19 + build/docs/getRoutingSettings-example.txt | 15 + ...etRoutingSettingsContactcenter-example.txt | 15 + ...etRoutingSettingsTranscription-example.txt | 15 + build/docs/getRoutingSkill-example.txt | 16 + build/docs/getRoutingSkillgroup-example.txt | 16 + .../getRoutingSkillgroupMembers-example.txt | 20 + ...tingSkillgroupMembersDivisions-example.txt | 17 + build/docs/getRoutingSkillgroups-example.txt | 19 + build/docs/getRoutingSkills-example.txt | 19 + build/docs/getRoutingSmsAddress-example.txt | 16 + build/docs/getRoutingSmsAddresses-example.txt | 17 + ...outingSmsAvailablephonenumbers-example.txt | 22 + .../docs/getRoutingSmsPhonenumber-example.txt | 17 + .../getRoutingSmsPhonenumbers-example.txt | 25 + .../getRoutingUserUtilization-example.txt | 16 + build/docs/getRoutingUtilization-example.txt | 15 + build/docs/getRoutingWrapupcode-example.txt | 16 + build/docs/getRoutingWrapupcodes-example.txt | 22 + build/docs/getScimGroup-example.txt | 19 + build/docs/getScimGroups-example.txt | 20 + build/docs/getScimResourcetype-example.txt | 16 + build/docs/getScimResourcetypes-example.txt | 15 + build/docs/getScimSchema-example.txt | 16 + build/docs/getScimSchemas-example.txt | 16 + .../getScimServiceproviderconfig-example.txt | 16 + build/docs/getScimUser-example.txt | 19 + build/docs/getScimUsers-example.txt | 20 + build/docs/getScimV2Group-example.txt | 19 + build/docs/getScimV2Groups-example.txt | 20 + build/docs/getScimV2Resourcetype-example.txt | 16 + build/docs/getScimV2Resourcetypes-example.txt | 15 + build/docs/getScimV2Schema-example.txt | 16 + build/docs/getScimV2Schemas-example.txt | 16 + ...getScimV2Serviceproviderconfig-example.txt | 16 + build/docs/getScimV2User-example.txt | 19 + build/docs/getScimV2Users-example.txt | 20 + build/docs/getScript-example.txt | 16 + build/docs/getScriptPage-example.txt | 18 + build/docs/getScriptPages-example.txt | 17 + build/docs/getScripts-example.txt | 25 + .../docs/getScriptsDivisionviews-example.txt | 25 + build/docs/getScriptsPublished-example.txt | 23 + ...tScriptsPublishedDivisionviews-example.txt | 23 + .../getScriptsPublishedScriptId-example.txt | 17 + ...etScriptsPublishedScriptIdPage-example.txt | 18 + ...tScriptsPublishedScriptIdPages-example.txt | 17 + ...iptsPublishedScriptIdVariables-example.txt | 20 + build/docs/getScriptsUploadStatus-example.txt | 17 + build/docs/getSearch-example.txt | 18 + build/docs/getSearchSuggest-example.txt | 18 + ...chandtextanalyticsConversation-example.txt | 16 + ...tionCommunicationTranscripturl-example.txt | 17 + ...ionCommunicationTranscripturls-example.txt | 17 + ...extanalyticsDictionaryfeedback-example.txt | 18 + ...ryfeedbackDictionaryFeedbackId-example.txt | 16 + ...tSpeechandtextanalyticsProgram-example.txt | 16 + ...ndtextanalyticsProgramMappings-example.txt | 16 + ...icsProgramTranscriptionengines-example.txt | 16 + ...SpeechandtextanalyticsPrograms-example.txt | 18 + ...extanalyticsProgramsGeneralJob-example.txt | 16 + ...dtextanalyticsProgramsMappings-example.txt | 17 + ...extanalyticsProgramsPublishjob-example.txt | 16 + ...msTranscriptionenginesDialects-example.txt | 15 + ...xtanalyticsProgramsUnpublished-example.txt | 17 + ...textanalyticsSentimentDialects-example.txt | 15 + ...textanalyticsSentimentfeedback-example.txt | 16 + ...SpeechandtextanalyticsSettings-example.txt | 15 + ...getSpeechandtextanalyticsTopic-example.txt | 16 + ...etSpeechandtextanalyticsTopics-example.txt | 22 + ...andtextanalyticsTopicsDialects-example.txt | 15 + ...handtextanalyticsTopicsGeneral-example.txt | 16 + ...xtanalyticsTopicsGeneralStatus-example.txt | 16 + ...dtextanalyticsTopicsPublishjob-example.txt | 16 + build/docs/getStation-example.txt | 16 + build/docs/getStations-example.txt | 23 + build/docs/getSystempresences-example.txt | 15 + build/docs/getTeam-example.txt | 16 + build/docs/getTeamMembers-example.txt | 20 + build/docs/getTeams-example.txt | 20 + .../docs/getTelephonyMediaregions-example.txt | 15 + .../getTelephonyProvidersEdge-example.txt | 17 + ...rovidersEdgeDiagnosticNslookup-example.txt | 16 + ...onyProvidersEdgeDiagnosticPing-example.txt | 16 + ...nyProvidersEdgeDiagnosticRoute-example.txt | 16 + ...ovidersEdgeDiagnosticTracepath-example.txt | 16 + ...yProvidersEdgeLogicalinterface-example.txt | 18 + ...ProvidersEdgeLogicalinterfaces-example.txt | 17 + ...tTelephonyProvidersEdgeLogsJob-example.txt | 17 + ...tTelephonyProvidersEdgeMetrics-example.txt | 16 + ...ProvidersEdgePhysicalinterface-example.txt | 17 + ...rovidersEdgePhysicalinterfaces-example.txt | 16 + ...phonyProvidersEdgeSetuppackage-example.txt | 16 + ...onyProvidersEdgeSoftwareupdate-example.txt | 16 + ...yProvidersEdgeSoftwareversions-example.txt | 16 + ...etTelephonyProvidersEdgeTrunks-example.txt | 22 + .../getTelephonyProvidersEdges-example.txt | 23 + ...ovidersEdgesAvailablelanguages-example.txt | 15 + ...ersEdgesCertificateauthorities-example.txt | 15 + ...idersEdgesCertificateauthority-example.txt | 16 + .../getTelephonyProvidersEdgesDid-example.txt | 16 + ...TelephonyProvidersEdgesDidpool-example.txt | 16 + ...elephonyProvidersEdgesDidpools-example.txt | 19 + ...honyProvidersEdgesDidpoolsDids-example.txt | 21 + ...getTelephonyProvidersEdgesDids-example.txt | 23 + ...lephonyProvidersEdgesEdgegroup-example.txt | 17 + ...ersEdgesEdgegroupEdgetrunkbase-example.txt | 17 + ...ephonyProvidersEdgesEdgegroups-example.txt | 20 + ...rovidersEdgesEdgeversionreport-example.txt | 15 + ...TelephonyProvidersEdgesExpired-example.txt | 15 + ...lephonyProvidersEdgesExtension-example.txt | 16 + ...onyProvidersEdgesExtensionpool-example.txt | 16 + ...nyProvidersEdgesExtensionpools-example.txt | 19 + ...ephonyProvidersEdgesExtensions-example.txt | 20 + ...getTelephonyProvidersEdgesLine-example.txt | 16 + ...yProvidersEdgesLinebasesetting-example.txt | 16 + ...ProvidersEdgesLinebasesettings-example.txt | 20 + ...etTelephonyProvidersEdgesLines-example.txt | 20 + ...onyProvidersEdgesLinesTemplate-example.txt | 16 + ...rovidersEdgesLogicalinterfaces-example.txt | 17 + ...TelephonyProvidersEdgesMetrics-example.txt | 16 + ...onyProvidersEdgesOutboundroute-example.txt | 16 + ...nyProvidersEdgesOutboundroutes-example.txt | 21 + ...etTelephonyProvidersEdgesPhone-example.txt | 16 + ...ProvidersEdgesPhonebasesetting-example.txt | 16 + ...rovidersEdgesPhonebasesettings-example.txt | 21 + ...basesettingsAvailablemetabases-example.txt | 17 + ...EdgesPhonebasesettingsTemplate-example.txt | 16 + ...tTelephonyProvidersEdgesPhones-example.txt | 32 + ...nyProvidersEdgesPhonesTemplate-example.txt | 16 + ...ovidersEdgesPhysicalinterfaces-example.txt | 16 + ...getTelephonyProvidersEdgesSite-example.txt | 16 + ...nyProvidersEdgesSiteNumberplan-example.txt | 17 + ...yProvidersEdgesSiteNumberplans-example.txt | 16 + ...SiteNumberplansClassifications-example.txt | 17 + ...rovidersEdgesSiteOutboundroute-example.txt | 17 + ...ovidersEdgesSiteOutboundroutes-example.txt | 21 + ...etTelephonyProvidersEdgesSites-example.txt | 22 + ...lephonyProvidersEdgesTimezones-example.txt | 17 + ...etTelephonyProvidersEdgesTrunk-example.txt | 16 + ...honyProvidersEdgesTrunkMetrics-example.txt | 16 + ...ProvidersEdgesTrunkbasesetting-example.txt | 17 + ...rovidersEdgesTrunkbasesettings-example.txt | 24 + ...basesettingsAvailablemetabases-example.txt | 18 + ...EdgesTrunkbasesettingsTemplate-example.txt | 16 + ...tTelephonyProvidersEdgesTrunks-example.txt | 22 + ...onyProvidersEdgesTrunksMetrics-example.txt | 16 + ...vidersEdgesTrunkswithrecording-example.txt | 16 + build/docs/getTelephonySiptraces-example.txt | 21 + ...onySiptracesDownloadDownloadId-example.txt | 16 + build/docs/getTextbotsBotsSearch-example.txt | 19 + build/docs/getTimezones-example.txt | 17 + build/docs/getTokensMe-example.txt | 16 + ...etUsageQueryExecutionIdResults-example.txt | 16 + ...SimplesearchExecutionIdResults-example.txt | 16 + build/docs/getUser-example.txt | 19 + build/docs/getUserAdjacents-example.txt | 17 + build/docs/getUserCallforwarding-example.txt | 16 + build/docs/getUserDirectreports-example.txt | 17 + build/docs/getUserFavorites-example.txt | 20 + build/docs/getUserGeolocation-example.txt | 17 + build/docs/getUserGreetings-example.txt | 18 + .../docs/getUserGreetingsDefaults-example.txt | 16 + build/docs/getUserOutofoffice-example.txt | 16 + build/docs/getUserPresence-example.txt | 17 + .../getUserPresencesPurecloud-example.txt | 16 + build/docs/getUserProfile-example.txt | 18 + build/docs/getUserProfileskills-example.txt | 16 + build/docs/getUserQueues-example.txt | 20 + build/docs/getUserRoles-example.txt | 16 + .../docs/getUserRoutinglanguages-example.txt | 19 + build/docs/getUserRoutingskills-example.txt | 19 + build/docs/getUserRoutingstatus-example.txt | 16 + build/docs/getUserSkillgroups-example.txt | 19 + build/docs/getUserState-example.txt | 16 + build/docs/getUserStation-example.txt | 16 + build/docs/getUserSuperiors-example.txt | 17 + build/docs/getUserTrustors-example.txt | 18 + build/docs/getUserrecording-example.txt | 17 + build/docs/getUserrecordingMedia-example.txt | 18 + build/docs/getUserrecordings-example.txt | 18 + .../docs/getUserrecordingsSummary-example.txt | 15 + build/docs/getUsers-example.txt | 23 + .../getUsersDevelopmentActivities-example.txt | 27 + ...etUsersDevelopmentActivitiesMe-example.txt | 26 + .../getUsersDevelopmentActivity-example.txt | 17 + build/docs/getUsersMe-example.txt | 17 + build/docs/getUsersPresenceBulk-example.txt | 17 + ...getUsersPresencesPurecloudBulk-example.txt | 16 + build/docs/getUsersSearch-example.txt | 18 + .../docs/getVoicemailGroupMailbox-example.txt | 16 + .../getVoicemailGroupMessages-example.txt | 18 + .../docs/getVoicemailGroupPolicy-example.txt | 16 + build/docs/getVoicemailMailbox-example.txt | 15 + build/docs/getVoicemailMeMailbox-example.txt | 15 + build/docs/getVoicemailMeMessages-example.txt | 17 + build/docs/getVoicemailMePolicy-example.txt | 15 + build/docs/getVoicemailMessage-example.txt | 17 + .../docs/getVoicemailMessageMedia-example.txt | 17 + build/docs/getVoicemailMessages-example.txt | 17 + build/docs/getVoicemailPolicy-example.txt | 15 + .../getVoicemailQueueMessages-example.txt | 18 + build/docs/getVoicemailSearch-example.txt | 17 + build/docs/getVoicemailUserpolicy-example.txt | 16 + build/docs/getWebchatDeployment-example.txt | 16 + build/docs/getWebchatDeployments-example.txt | 15 + ...tGuestConversationMediarequest-example.txt | 17 + ...GuestConversationMediarequests-example.txt | 16 + ...WebchatGuestConversationMember-example.txt | 17 + ...ebchatGuestConversationMembers-example.txt | 19 + ...ebchatGuestConversationMessage-example.txt | 17 + ...bchatGuestConversationMessages-example.txt | 20 + build/docs/getWebchatSettings-example.txt | 15 + ...eploymentsConfigurationVersion-example.txt | 17 + ...ploymentsConfigurationVersions-example.txt | 16 + ...entsConfigurationVersionsDraft-example.txt | 16 + ...etWebdeploymentsConfigurations-example.txt | 16 + .../getWebdeploymentsDeployment-example.txt | 17 + ...ntsDeploymentCobrowseSessionId-example.txt | 17 + ...ymentsDeploymentConfigurations-example.txt | 18 + .../getWebdeploymentsDeployments-example.txt | 16 + .../docs/getWebmessagingMessages-example.txt | 17 + build/docs/getWidgetsDeployment-example.txt | 16 + build/docs/getWidgetsDeployments-example.txt | 15 + ...etWorkforcemanagementAdherence-example.txt | 16 + ...managementAdherenceExplanation-example.txt | 16 + ...gementAdherenceExplanationsJob-example.txt | 16 + ...mentAdherenceHistoricalBulkJob-example.txt | 16 + ...nagementAdherenceHistoricalJob-example.txt | 16 + ...orcemanagementAdhocmodelingjob-example.txt | 16 + ...ementAgentAdherenceExplanation-example.txt | 17 + ...emanagementAgentManagementunit-example.txt | 16 + ...nagementAgentsMeManagementunit-example.txt | 15 + ...orkforcemanagementBusinessunit-example.txt | 17 + ...gementBusinessunitActivitycode-example.txt | 17 + ...ementBusinessunitActivitycodes-example.txt | 16 + ...nessunitIntradayPlanninggroups-example.txt | 17 + ...entBusinessunitManagementunits-example.txt | 18 + ...ementBusinessunitPlanninggroup-example.txt | 17 + ...mentBusinessunitPlanninggroups-example.txt | 16 + ...ementBusinessunitSchedulingRun-example.txt | 17 + ...usinessunitSchedulingRunResult-example.txt | 19 + ...mentBusinessunitSchedulingRuns-example.txt | 16 + ...usinessunitServicegoaltemplate-example.txt | 18 + ...sinessunitServicegoaltemplates-example.txt | 17 + ...gementBusinessunitWeekSchedule-example.txt | 19 + ...tWeekScheduleGenerationresults-example.txt | 18 + ...tWeekScheduleHeadcountforecast-example.txt | 19 + ...ssunitWeekScheduleHistoryAgent-example.txt | 19 + ...ementBusinessunitWeekSchedules-example.txt | 19 + ...inessunitWeekShorttermforecast-example.txt | 19 + ...sunitWeekShorttermforecastData-example.txt | 20 + ...ttermforecastGenerationresults-example.txt | 18 + ...rmforecastLongtermforecastdata-example.txt | 19 + ...horttermforecastPlanninggroups-example.txt | 18 + ...nessunitWeekShorttermforecasts-example.txt | 17 + ...rkforcemanagementBusinessunits-example.txt | 17 + ...mentBusinessunitsDivisionviews-example.txt | 16 + ...forcemanagementCalendarDataIcs-example.txt | 16 + ...kforcemanagementCalendarUrlIcs-example.txt | 15 + ...agementHistoricaldataDeletejob-example.txt | 15 + ...mentHistoricaldataImportstatus-example.txt | 15 + ...orcemanagementIntegrationsHris-example.txt | 15 + ...ntegrationsHrisTimeofftypesJob-example.txt | 16 + ...kforcemanagementManagementunit-example.txt | 17 + ...entManagementunitActivitycodes-example.txt | 16 + ...agementManagementunitAdherence-example.txt | 17 + ...emanagementManagementunitAgent-example.txt | 18 + ...ManagementunitAgentShifttrades-example.txt | 17 + ...nagementunitShifttradesMatched-example.txt | 16 + ...ManagementunitShifttradesUsers-example.txt | 16 + ...mentManagementunitTimeofflimit-example.txt | 17 + ...entManagementunitTimeofflimits-example.txt | 16 + ...ementManagementunitTimeoffplan-example.txt | 17 + ...mentManagementunitTimeoffplans-example.txt | 16 + ...nagementunitUserTimeoffrequest-example.txt | 18 + ...serTimeoffrequestTimeofflimits-example.txt | 18 + ...agementunitUserTimeoffrequests-example.txt | 18 + ...emanagementManagementunitUsers-example.txt | 16 + ...mentManagementunitWeekSchedule-example.txt | 20 + ...entManagementunitWeekSchedules-example.txt | 20 + ...tManagementunitWeekShifttrades-example.txt | 18 + ...nagementManagementunitWorkplan-example.txt | 18 + ...ManagementunitWorkplanrotation-example.txt | 17 + ...anagementunitWorkplanrotations-example.txt | 17 + ...agementManagementunitWorkplans-example.txt | 17 + ...forcemanagementManagementunits-example.txt | 20 + ...ntManagementunitsDivisionviews-example.txt | 16 + ...rkforcemanagementNotifications-example.txt | 15 + ...rkforcemanagementSchedulingjob-example.txt | 16 + ...WorkforcemanagementShifttrades-example.txt | 15 + ...orkforcemanagementShrinkageJob-example.txt | 16 + ...rcemanagementTimeoffbalanceJob-example.txt | 16 + ...kforcemanagementTimeoffrequest-example.txt | 16 + ...imeoffrequestWaitlistpositions-example.txt | 16 + ...forcemanagementTimeoffrequests-example.txt | 16 + .../docs/headNotificationsChannel-example.txt | 15 + build/docs/headTokensMe-example.txt | 14 + build/docs/index.md | 2 +- build/docs/patchAlertingAlert-example.txt | 17 + .../docs/patchAlertingAlertsBulk-example.txt | 16 + build/docs/patchAlertingRulesBulk-example.txt | 16 + ...atchAnalyticsReportingSettings-example.txt | 16 + build/docs/patchAuthorizationRole-example.txt | 17 + .../patchAuthorizationSettings-example.txt | 16 + build/docs/patchChatSettings-example.txt | 16 + build/docs/patchChatsSettings-example.txt | 16 + .../docs/patchCoachingAppointment-example.txt | 17 + ...hCoachingAppointmentAnnotation-example.txt | 18 + ...patchCoachingAppointmentStatus-example.txt | 17 + .../patchCoachingNotification-example.txt | 17 + .../patchConversationParticipant-example.txt | 17 + ...versationParticipantAttributes-example.txt | 17 + ...chConversationSecureattributes-example.txt | 17 + ...tionIdParticipantCommunication-example.txt | 19 + build/docs/patchConversationsCall-example.txt | 17 + ...chConversationsCallParticipant-example.txt | 17 + ...tionsCallParticipantAttributes-example.txt | 18 + ...nsCallParticipantCommunication-example.txt | 19 + ...rsationsCallParticipantConsult-example.txt | 18 + .../patchConversationsCallback-example.txt | 17 + ...nversationsCallbackParticipant-example.txt | 17 + ...sCallbackParticipantAttributes-example.txt | 18 + ...llbackParticipantCommunication-example.txt | 19 + .../patchConversationsCallbacks-example.txt | 16 + build/docs/patchConversationsChat-example.txt | 17 + ...chConversationsChatParticipant-example.txt | 17 + ...tionsChatParticipantAttributes-example.txt | 18 + ...nsChatParticipantCommunication-example.txt | 19 + ...chConversationsCobrowsesession-example.txt | 17 + ...ionsCobrowsesessionParticipant-example.txt | 17 + ...sesessionParticipantAttributes-example.txt | 18 + ...essionParticipantCommunication-example.txt | 19 + .../docs/patchConversationsEmail-example.txt | 17 + ...onversationsEmailMessagesDraft-example.txt | 19 + ...hConversationsEmailParticipant-example.txt | 17 + ...ionsEmailParticipantAttributes-example.txt | 18 + ...sEmailParticipantCommunication-example.txt | 19 + .../patchConversationsMessage-example.txt | 17 + ...onversationsMessageParticipant-example.txt | 17 + ...nsMessageParticipantAttributes-example.txt | 18 + ...essageParticipantCommunication-example.txt | 19 + ...egrationsFacebookIntegrationId-example.txt | 17 + ...grationsInstagramIntegrationId-example.txt | 17 + ...gIntegrationsOpenIntegrationId-example.txt | 17 + ...tegrationsTwitterIntegrationId-example.txt | 17 + ...egrationsWhatsappIntegrationId-example.txt | 17 + ...hConversationsMessagingSetting-example.txt | 17 + ...ortedcontentSupportedContentId-example.txt | 17 + .../patchConversationsSettings-example.txt | 15 + build/docs/patchEmailsSettings-example.txt | 16 + ...manceExternalmetricsDefinition-example.txt | 17 + ...rnalcontactsContactIdentifiers-example.txt | 17 + .../patchGeolocationsSettings-example.txt | 16 + build/docs/patchIntegration-example.txt | 23 + .../docs/patchIntegrationsAction-example.txt | 17 + .../patchIntegrationsActionDraft-example.txt | 17 + build/docs/patchJourneyActionmap-example.txt | 17 + .../docs/patchJourneyActiontarget-example.txt | 17 + .../patchJourneyActiontemplate-example.txt | 17 + build/docs/patchJourneyOutcome-example.txt | 17 + build/docs/patchJourneySegment-example.txt | 17 + ...SessionDocumentsSearchSearchId-example.txt | 17 + .../patchKnowledgeKnowledgebase-example.txt | 17 + ...KnowledgeKnowledgebaseCategory-example.txt | 18 + ...KnowledgeKnowledgebaseDocument-example.txt | 18 + ...KnowledgebaseDocumentVariation-example.txt | 19 + ...dgebaseDocumentsSearchSearchId-example.txt | 17 + ...nowledgeKnowledgebaseImportJob-example.txt | 18 + ...tchKnowledgeKnowledgebaseLabel-example.txt | 18 + ...eKnowledgebaseLanguageCategory-example.txt | 19 + ...eKnowledgebaseLanguageDocument-example.txt | 19 + ...KnowledgebaseLanguageDocuments-example.txt | 18 + ...dgebaseLanguageDocumentsImport-example.txt | 19 + ...baseUnansweredGroupPhrasegroup-example.txt | 19 + ...tchLanguageunderstandingDomain-example.txt | 17 + ...anguageunderstandingMinerDraft-example.txt | 18 + .../docs/patchLearningAssignment-example.txt | 17 + ...chLearningAssignmentReschedule-example.txt | 17 + build/docs/patchLocation-example.txt | 17 + build/docs/patchMessagingSetting-example.txt | 17 + ...ortedcontentSupportedContentId-example.txt | 17 + ...izationsAuthenticationSettings-example.txt | 16 + .../patchOrganizationsFeature-example.txt | 17 + ...dDnclistCustomexclusioncolumns-example.txt | 16 + ...hOutboundDnclistEmailaddresses-example.txt | 16 + ...tchOutboundDnclistPhonenumbers-example.txt | 16 + build/docs/patchOutboundSettings-example.txt | 15 + .../docs/patchQualityFormsSurvey-example.txt | 17 + ...ssplatformMediaretentionpolicy-example.txt | 17 + ...hRecordingMediaretentionpolicy-example.txt | 17 + .../patchRecordingsScreensession-example.txt | 16 + .../docs/patchRoutingConversation-example.txt | 17 + .../docs/patchRoutingEmailDomain-example.txt | 17 + ...atchRoutingEmailDomainValidate-example.txt | 17 + build/docs/patchRoutingPredictor-example.txt | 17 + .../docs/patchRoutingQueueMember-example.txt | 17 + .../docs/patchRoutingQueueMembers-example.txt | 17 + build/docs/patchRoutingQueueUser-example.txt | 17 + build/docs/patchRoutingQueueUsers-example.txt | 17 + ...chRoutingSettingsContactcenter-example.txt | 15 + build/docs/patchRoutingSkillgroup-example.txt | 17 + build/docs/patchScimGroup-example.txt | 18 + build/docs/patchScimUser-example.txt | 18 + build/docs/patchScimV2Group-example.txt | 18 + build/docs/patchScimV2User-example.txt | 18 + ...SpeechandtextanalyticsSettings-example.txt | 16 + build/docs/patchTeam-example.txt | 17 + build/docs/patchUser-example.txt | 17 + .../docs/patchUserCallforwarding-example.txt | 17 + build/docs/patchUserGeolocation-example.txt | 18 + build/docs/patchUserPresence-example.txt | 18 + .../patchUserPresencesPurecloud-example.txt | 17 + build/docs/patchUserQueue-example.txt | 18 + build/docs/patchUserQueues-example.txt | 18 + .../docs/patchUserRoutinglanguage-example.txt | 18 + .../patchUserRoutinglanguagesBulk-example.txt | 17 + .../patchUserRoutingskillsBulk-example.txt | 17 + build/docs/patchUsersBulk-example.txt | 16 + .../patchVoicemailGroupPolicy-example.txt | 17 + build/docs/patchVoicemailMePolicy-example.txt | 16 + build/docs/patchVoicemailMessage-example.txt | 17 + .../docs/patchVoicemailUserpolicy-example.txt | 17 + ...tGuestConversationMediarequest-example.txt | 18 + ...ementAgentAdherenceExplanation-example.txt | 18 + ...orkforcemanagementBusinessunit-example.txt | 17 + ...gementBusinessunitActivitycode-example.txt | 18 + ...ementBusinessunitPlanninggroup-example.txt | 18 + ...ementBusinessunitSchedulingRun-example.txt | 17 + ...usinessunitServicegoaltemplate-example.txt | 18 + ...kforcemanagementManagementunit-example.txt | 17 + ...mentManagementunitTimeofflimit-example.txt | 18 + ...ementManagementunitTimeoffplan-example.txt | 18 + ...ffrequestUserIntegrationstatus-example.txt | 19 + ...nagementunitUserTimeoffrequest-example.txt | 19 + ...ntManagementunitWeekShifttrade-example.txt | 19 + ...nagementManagementunitWorkplan-example.txt | 19 + ...ManagementunitWorkplanrotation-example.txt | 18 + ...kforcemanagementTimeoffrequest-example.txt | 17 + .../docs/postAlertingAlertsQuery-example.txt | 16 + ...tAlertingInteractionstatsRules-example.txt | 17 + build/docs/postAlertingRules-example.txt | 16 + .../postAlertingRulesBulkRemove-example.txt | 16 + build/docs/postAlertingRulesQuery-example.txt | 16 + ...nalyticsActionsAggregatesQuery-example.txt | 16 + ...stAnalyticsBotsAggregatesQuery-example.txt | 16 + ...sConversationDetailsProperties-example.txt | 17 + ...csConversationsAggregatesQuery-example.txt | 16 + ...lyticsConversationsDetailsJobs-example.txt | 16 + ...yticsConversationsDetailsQuery-example.txt | 16 + ...sConversationsTranscriptsQuery-example.txt | 16 + ...ticsEvaluationsAggregatesQuery-example.txt | 16 + ...tAnalyticsFlowsAggregatesQuery-example.txt | 16 + ...nalyticsFlowsObservationsQuery-example.txt | 16 + ...alyticsJourneysAggregatesQuery-example.txt | 16 + ...alyticsQueuesObservationsQuery-example.txt | 16 + .../postAnalyticsReportingExports-example.txt | 16 + ...ticsReportingScheduleRunreport-example.txt | 16 + ...ostAnalyticsReportingSchedules-example.txt | 16 + ...nalyticsSurveysAggregatesQuery-example.txt | 16 + ...ticsTranscriptsAggregatesQuery-example.txt | 16 + ...tAnalyticsUsersAggregatesQuery-example.txt | 16 + .../postAnalyticsUsersDetailsJobs-example.txt | 16 + ...postAnalyticsUsersDetailsQuery-example.txt | 16 + ...nalyticsUsersObservationsQuery-example.txt | 16 + ...chitectDependencytrackingBuild-example.txt | 14 + .../postArchitectEmergencygroups-example.txt | 16 + build/docs/postArchitectIvrs-example.txt | 16 + .../postArchitectPromptHistory-example.txt | 16 + .../postArchitectPromptResources-example.txt | 17 + build/docs/postArchitectPrompts-example.txt | 16 + .../postArchitectSchedulegroups-example.txt | 16 + build/docs/postArchitectSchedules-example.txt | 16 + ...stArchitectSystempromptHistory-example.txt | 16 + ...ArchitectSystempromptResources-example.txt | 17 + build/docs/postAuditsQuery-example.txt | 16 + .../docs/postAuditsQueryRealtime-example.txt | 17 + ...ostAuthorizationDivisionObject-example.txt | 17 + ...stAuthorizationDivisionRestore-example.txt | 17 + .../postAuthorizationDivisions-example.txt | 16 + build/docs/postAuthorizationRole-example.txt | 17 + ...nRoleComparedefaultRightRoleId-example.txt | 18 + build/docs/postAuthorizationRoles-example.txt | 16 + .../postAuthorizationRolesDefault-example.txt | 16 + ...ostAuthorizationSubjectBulkadd-example.txt | 17 + ...AuthorizationSubjectBulkremove-example.txt | 16 + ...uthorizationSubjectBulkreplace-example.txt | 17 + ...thorizationSubjectDivisionRole-example.txt | 18 + ...tegrationsEmergencylocationsMe-example.txt | 16 + build/docs/postCertificateDetails-example.txt | 16 + ...CoachingAppointmentAnnotations-example.txt | 17 + ...achingAppointmentConversations-example.txt | 17 + .../docs/postCoachingAppointments-example.txt | 16 + ...ingAppointmentsAggregatesQuery-example.txt | 16 + ...postCoachingScheduleslotsQuery-example.txt | 16 + ...ostContentmanagementAuditquery-example.txt | 16 + .../postContentmanagementDocument-example.txt | 19 + ...ntentmanagementDocumentContent-example.txt | 18 + ...postContentmanagementDocuments-example.txt | 19 + .../postContentmanagementQuery-example.txt | 17 + .../postContentmanagementShares-example.txt | 16 + ...ntmanagementWorkspaceTagvalues-example.txt | 17 + ...agementWorkspaceTagvaluesQuery-example.txt | 18 + ...ostContentmanagementWorkspaces-example.txt | 16 + build/docs/postConversationAssign-example.txt | 17 + .../docs/postConversationCobrowse-example.txt | 16 + .../postConversationDisconnect-example.txt | 16 + ...nversationParticipantCallbacks-example.txt | 17 + ...tConversationParticipantDigits-example.txt | 17 + ...ConversationParticipantReplace-example.txt | 17 + ...onParticipantSecureivrsessions-example.txt | 18 + ...nversationRecordingAnnotations-example.txt | 18 + build/docs/postConversationsCall-example.txt | 17 + ...versationsCallParticipantCoach-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...rsationsCallParticipantConsult-example.txt | 18 + ...rsationsCallParticipantMonitor-example.txt | 16 + ...rsationsCallParticipantReplace-example.txt | 17 + ...tConversationsCallParticipants-example.txt | 17 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...ionsCallbackParticipantReplace-example.txt | 17 + .../postConversationsCallbacks-example.txt | 16 + ...sationsCallbacksBulkDisconnect-example.txt | 15 + ...nversationsCallbacksBulkUpdate-example.txt | 16 + build/docs/postConversationsCalls-example.txt | 16 + ...tionsChatCommunicationMessages-example.txt | 18 + ...sationsChatCommunicationTyping-example.txt | 17 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...rsationsChatParticipantReplace-example.txt | 17 + build/docs/postConversationsChats-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...rowsesessionParticipantReplace-example.txt | 17 + ...versationsEmailInboundmessages-example.txt | 17 + ...postConversationsEmailMessages-example.txt | 17 + ...ilMessagesDraftAttachmentsCopy-example.txt | 17 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...sationsEmailParticipantReplace-example.txt | 17 + .../docs/postConversationsEmails-example.txt | 16 + ...stConversationsEmailsAgentless-example.txt | 16 + build/docs/postConversationsFaxes-example.txt | 16 + ...ConversationsKeyconfigurations-example.txt | 16 + ...tionsKeyconfigurationsValidate-example.txt | 16 + ...nsMessageCommunicationMessages-example.txt | 19 + ...sageCommunicationMessagesMedia-example.txt | 17 + ...ionsMessageCommunicationTyping-example.txt | 17 + ...sationsMessageInboundOpenEvent-example.txt | 17 + ...tionsMessageInboundOpenMessage-example.txt | 17 + ...tionsMessageInboundOpenReceipt-example.txt | 17 + ...nversationsMessageMessagesBulk-example.txt | 18 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...tionsMessageParticipantReplace-example.txt | 17 + .../postConversationsMessages-example.txt | 16 + ...ConversationsMessagesAgentless-example.txt | 16 + ...nversationsMessagesInboundOpen-example.txt | 16 + ...sMessagingIntegrationsFacebook-example.txt | 16 + ...MessagingIntegrationsInstagram-example.txt | 16 + ...tionsMessagingIntegrationsLine-example.txt | 16 + ...tionsMessagingIntegrationsOpen-example.txt | 16 + ...nsMessagingIntegrationsTwitter-example.txt | 16 + ...sMessagingIntegrationsWhatsapp-example.txt | 16 + ...ConversationsMessagingSettings-example.txt | 16 + ...tionsMessagingSupportedcontent-example.txt | 16 + ...nsParticipantsAttributesSearch-example.txt | 16 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...ParticipantCommunicationWrapup-example.txt | 18 + ...ParticipantCommunicationWrapup-example.txt | 18 + .../postDocumentationGknSearch-example.txt | 16 + .../docs/postDocumentationSearch-example.txt | 16 + ...performanceExternalmetricsData-example.txt | 16 + ...anceExternalmetricsDefinitions-example.txt | 16 + .../docs/postEventsConversations-example.txt | 16 + .../docs/postEventsUsersPresence-example.txt | 16 + .../postEventsUsersRoutingstatus-example.txt | 16 + ...stExternalcontactsBulkContacts-example.txt | 16 + ...xternalcontactsBulkContactsAdd-example.txt | 16 + ...rnalcontactsBulkContactsRemove-example.txt | 16 + ...contactsBulkContactsUnresolved-example.txt | 16 + ...rnalcontactsBulkContactsUpdate-example.txt | 16 + .../postExternalcontactsBulkNotes-example.txt | 16 + ...stExternalcontactsBulkNotesAdd-example.txt | 16 + ...xternalcontactsBulkNotesRemove-example.txt | 16 + ...xternalcontactsBulkNotesUpdate-example.txt | 16 + ...ernalcontactsBulkOrganizations-example.txt | 16 + ...alcontactsBulkOrganizationsAdd-example.txt | 16 + ...ontactsBulkOrganizationsRemove-example.txt | 16 + ...ontactsBulkOrganizationsUpdate-example.txt | 16 + ...ernalcontactsBulkRelationships-example.txt | 16 + ...alcontactsBulkRelationshipsAdd-example.txt | 16 + ...ontactsBulkRelationshipsRemove-example.txt | 16 + ...ontactsBulkRelationshipsUpdate-example.txt | 16 + ...stExternalcontactsContactNotes-example.txt | 17 + ...ternalcontactsContactPromotion-example.txt | 16 + .../postExternalcontactsContacts-example.txt | 16 + ...xternalcontactsContactsSchemas-example.txt | 16 + ...ternalcontactsIdentifierlookup-example.txt | 16 + ...tExternalcontactsMergeContacts-example.txt | 16 + ...ernalcontactsOrganizationNotes-example.txt | 17 + ...tExternalcontactsOrganizations-example.txt | 16 + ...alcontactsOrganizationsSchemas-example.txt | 16 + ...tExternalcontactsRelationships-example.txt | 16 + build/docs/postFlowHistory-example.txt | 16 + build/docs/postFlowVersions-example.txt | 17 + build/docs/postFlows-example.txt | 17 + .../docs/postFlowsActionsCheckin-example.txt | 16 + .../docs/postFlowsActionsCheckout-example.txt | 16 + .../postFlowsActionsDeactivate-example.txt | 16 + .../docs/postFlowsActionsPublish-example.txt | 17 + build/docs/postFlowsActionsRevert-example.txt | 16 + build/docs/postFlowsActionsUnlock-example.txt | 16 + .../postFlowsDatatableExportJobs-example.txt | 16 + .../postFlowsDatatableImportJobs-example.txt | 17 + build/docs/postFlowsDatatableRows-example.txt | 17 + build/docs/postFlowsDatatables-example.txt | 16 + build/docs/postFlowsExecutions-example.txt | 16 + build/docs/postFlowsJobs-example.txt | 15 + build/docs/postFlowsMilestones-example.txt | 16 + build/docs/postFlowsOutcomes-example.txt | 16 + ...ostGamificationProfileActivate-example.txt | 16 + ...tGamificationProfileDeactivate-example.txt | 16 + ...postGamificationProfileMembers-example.txt | 17 + ...ficationProfileMembersValidate-example.txt | 17 + ...tGamificationProfileMetricLink-example.txt | 18 + ...postGamificationProfileMetrics-example.txt | 17 + .../docs/postGamificationProfiles-example.txt | 17 + ...tGamificationProfilesUserQuery-example.txt | 17 + ...mificationProfilesUsersMeQuery-example.txt | 16 + build/docs/postGdprRequests-example.txt | 17 + build/docs/postGreetings-example.txt | 16 + build/docs/postGroupGreetings-example.txt | 17 + build/docs/postGroupMembers-example.txt | 17 + build/docs/postGroups-example.txt | 16 + build/docs/postGroupsSearch-example.txt | 16 + .../postInfrastructureascodeJobs-example.txt | 16 + build/docs/postIntegrations-example.txt | 16 + .../postIntegrationsActionDraft-example.txt | 16 + ...IntegrationsActionDraftPublish-example.txt | 17 + ...ostIntegrationsActionDraftTest-example.txt | 17 + .../postIntegrationsActionExecute-example.txt | 17 + .../postIntegrationsActionTest-example.txt | 17 + .../docs/postIntegrationsActions-example.txt | 16 + .../postIntegrationsActionsDrafts-example.txt | 16 + .../postIntegrationsCredentials-example.txt | 16 + build/docs/postJourneyActionmaps-example.txt | 16 + ...JourneyActionmapsEstimatesJobs-example.txt | 16 + .../postJourneyActiontemplates-example.txt | 16 + build/docs/postJourneyOutcomes-example.txt | 16 + .../postJourneyOutcomesPredictors-example.txt | 16 + build/docs/postJourneySegments-example.txt | 16 + .../postKnowledgeDocumentuploads-example.txt | 16 + ...geGuestSessionDocumentFeedback-example.txt | 18 + ...dgeGuestSessionDocumentsSearch-example.txt | 18 + ...sionDocumentsSearchSuggestions-example.txt | 17 + .../postKnowledgeGuestSessions-example.txt | 16 + ...owledgeKnowledgebaseCategories-example.txt | 17 + ...eKnowledgebaseDocumentFeedback-example.txt | 18 + ...nowledgebaseDocumentVariations-example.txt | 18 + ...eKnowledgebaseDocumentVersions-example.txt | 18 + ...edgeKnowledgebaseDocumentViews-example.txt | 17 + ...nowledgeKnowledgebaseDocuments-example.txt | 17 + ...geKnowledgebaseDocumentsSearch-example.txt | 18 + ...baseDocumentsSearchSuggestions-example.txt | 17 + ...owledgeKnowledgebaseExportJobs-example.txt | 17 + ...owledgeKnowledgebaseImportJobs-example.txt | 17 + ...stKnowledgeKnowledgebaseLabels-example.txt | 17 + ...nowledgebaseLanguageCategories-example.txt | 18 + ...KnowledgebaseLanguageDocuments-example.txt | 18 + ...gebaseLanguageDocumentsImports-example.txt | 18 + ...dgebaseLanguageTrainingPromote-example.txt | 18 + ...KnowledgebaseLanguageTrainings-example.txt | 17 + ...stKnowledgeKnowledgebaseSearch-example.txt | 17 + .../postKnowledgeKnowledgebases-example.txt | 16 + build/docs/postLanguages-example.txt | 16 + ...ageunderstandingDomainFeedback-example.txt | 17 + ...derstandingDomainVersionDetect-example.txt | 18 + ...erstandingDomainVersionPublish-example.txt | 17 + ...nderstandingDomainVersionTrain-example.txt | 17 + ...ageunderstandingDomainVersions-example.txt | 18 + ...stLanguageunderstandingDomains-example.txt | 16 + ...nguageunderstandingMinerDrafts-example.txt | 17 + ...guageunderstandingMinerExecute-example.txt | 17 + ...guageunderstandingMinerUploads-example.txt | 17 + ...ostLanguageunderstandingMiners-example.txt | 16 + ...postLearningAssessmentsScoring-example.txt | 16 + ...postLearningAssignmentReassign-example.txt | 16 + .../postLearningAssignmentReset-example.txt | 16 + .../docs/postLearningAssignments-example.txt | 16 + ...ningAssignmentsAggregatesQuery-example.txt | 16 + ...postLearningAssignmentsBulkadd-example.txt | 16 + ...tLearningAssignmentsBulkremove-example.txt | 16 + build/docs/postLearningModuleJobs-example.txt | 17 + .../postLearningModulePublish-example.txt | 17 + build/docs/postLearningModules-example.txt | 16 + build/docs/postLearningRulesQuery-example.txt | 18 + ...postLearningScheduleslotsQuery-example.txt | 16 + build/docs/postLicenseInfer-example.txt | 16 + .../docs/postLicenseOrganization-example.txt | 16 + build/docs/postLicenseToggle-example.txt | 16 + build/docs/postLicenseUsers-example.txt | 16 + build/docs/postLocations-example.txt | 16 + build/docs/postLocationsSearch-example.txt | 16 + build/docs/postMessagingSettings-example.txt | 16 + .../postMessagingSupportedcontent-example.txt | 16 + build/docs/postMobiledevices-example.txt | 16 + ...ificationsChannelSubscriptions-example.txt | 18 + .../postNotificationsChannels-example.txt | 15 + build/docs/postOauthClientSecret-example.txt | 16 + .../postOauthClientUsageQuery-example.txt | 17 + build/docs/postOauthClients-example.txt | 16 + .../postOrgauthorizationPairings-example.txt | 16 + ...tOrgauthorizationTrusteeGroups-example.txt | 17 + ...stOrgauthorizationTrusteeUsers-example.txt | 17 + .../postOrgauthorizationTrustees-example.txt | 16 + ...OrgauthorizationTrusteesAudits-example.txt | 20 + ...rgauthorizationTrusteesDefault-example.txt | 17 + ...tOrgauthorizationTrustorAudits-example.txt | 20 + .../postOutboundAttemptlimits-example.txt | 16 + build/docs/postOutboundAudits-example.txt | 21 + .../postOutboundCallabletimesets-example.txt | 16 + ...tboundCallanalysisresponsesets-example.txt | 16 + ...mpaignAgentownedmappingpreview-example.txt | 16 + ...tboundCampaignCallbackSchedule-example.txt | 17 + .../postOutboundCampaignrules-example.txt | 16 + build/docs/postOutboundCampaigns-example.txt | 16 + .../postOutboundCampaignsProgress-example.txt | 16 + .../postOutboundContactlistClear-example.txt | 15 + ...ostOutboundContactlistContacts-example.txt | 20 + ...utboundContactlistContactsBulk-example.txt | 17 + .../postOutboundContactlistExport-example.txt | 16 + ...postOutboundContactlistfilters-example.txt | 16 + ...boundContactlistfiltersPreview-example.txt | 16 + .../docs/postOutboundContactlists-example.txt | 16 + .../postOutboundConversationDnc-example.txt | 15 + .../postOutboundDigitalrulesets-example.txt | 16 + ...tOutboundDnclistEmailaddresses-example.txt | 16 + .../postOutboundDnclistExport-example.txt | 16 + ...ostOutboundDnclistPhonenumbers-example.txt | 17 + build/docs/postOutboundDnclists-example.txt | 16 + ...postOutboundMessagingcampaigns-example.txt | 16 + ...oundMessagingcampaignsProgress-example.txt | 16 + build/docs/postOutboundRulesets-example.txt | 16 + build/docs/postOutboundSequences-example.txt | 16 + build/docs/postPresenceSources-example.txt | 16 + .../docs/postPresencedefinitions-example.txt | 16 + ...stProcessautomationTriggerTest-example.txt | 17 + .../postProcessautomationTriggers-example.txt | 16 + ...essautomationTriggersTopicTest-example.txt | 17 + .../docs/postQualityCalibrations-example.txt | 17 + ...QualityConversationEvaluations-example.txt | 18 + ...ualityConversationsAuditsQuery-example.txt | 16 + ...tyEvaluationsAggregatesQueryMe-example.txt | 16 + .../postQualityEvaluationsScoring-example.txt | 16 + build/docs/postQualityForms-example.txt | 16 + .../postQualityFormsEvaluations-example.txt | 16 + .../docs/postQualityFormsSurveys-example.txt | 16 + .../postQualityPublishedforms-example.txt | 16 + ...alityPublishedformsEvaluations-example.txt | 16 + ...stQualityPublishedformsSurveys-example.txt | 16 + .../postQualitySurveysScoring-example.txt | 16 + .../postRecordingBatchrequests-example.txt | 16 + ...platformMediaretentionpolicies-example.txt | 16 + build/docs/postRecordingJobs-example.txt | 16 + ...postRecordingKeyconfigurations-example.txt | 16 + ...rdingKeyconfigurationsValidate-example.txt | 16 + build/docs/postRecordingLocalkeys-example.txt | 16 + ...ecordingMediaretentionpolicies-example.txt | 16 + .../postRecordingRecordingkeys-example.txt | 15 + .../postRecordingUploadsReports-example.txt | 16 + ...stRecordingsDeletionprotection-example.txt | 16 + ...dingsScreensessionsAcknowledge-example.txt | 15 + ...cordingsScreensessionsMetadata-example.txt | 15 + ...ostResponsemanagementLibraries-example.txt | 16 + ...managementResponseassetsSearch-example.txt | 17 + ...anagementResponseassetsUploads-example.txt | 16 + ...ostResponsemanagementResponses-example.txt | 17 + ...sponsemanagementResponsesQuery-example.txt | 16 + build/docs/postRoutingAssessments-example.txt | 16 + .../postRoutingAssessmentsJobs-example.txt | 16 + .../postRoutingEmailDomainRoutes-example.txt | 17 + ...utingEmailDomainTestconnection-example.txt | 17 + .../docs/postRoutingEmailDomains-example.txt | 16 + ...ostRoutingEmailOutboundDomains-example.txt | 16 + ...gEmailOutboundDomainsSimulated-example.txt | 16 + build/docs/postRoutingLanguages-example.txt | 16 + build/docs/postRoutingPredictors-example.txt | 16 + .../docs/postRoutingQueueMembers-example.txt | 17 + build/docs/postRoutingQueueUsers-example.txt | 17 + .../postRoutingQueueWrapupcodes-example.txt | 17 + build/docs/postRoutingQueues-example.txt | 16 + ...tingSkillgroupMembersDivisions-example.txt | 16 + build/docs/postRoutingSkillgroups-example.txt | 16 + build/docs/postRoutingSkills-example.txt | 16 + .../docs/postRoutingSmsAddresses-example.txt | 16 + .../postRoutingSmsPhonenumbers-example.txt | 16 + build/docs/postRoutingWrapupcodes-example.txt | 16 + build/docs/postScimUsers-example.txt | 16 + build/docs/postScimV2Users-example.txt | 16 + build/docs/postScriptExport-example.txt | 17 + build/docs/postScriptsPublished-example.txt | 17 + build/docs/postSearch-example.txt | 17 + build/docs/postSearchSuggest-example.txt | 17 + ...extanalyticsDictionaryfeedback-example.txt | 16 + ...SpeechandtextanalyticsPrograms-example.txt | 16 + ...xtanalyticsProgramsGeneralJobs-example.txt | 16 + ...xtanalyticsProgramsPublishjobs-example.txt | 16 + ...textanalyticsSentimentfeedback-example.txt | 16 + ...stSpeechandtextanalyticsTopics-example.txt | 16 + ...textanalyticsTopicsPublishjobs-example.txt | 16 + ...textanalyticsTranscriptsSearch-example.txt | 16 + build/docs/postTeamMembers-example.txt | 17 + build/docs/postTeams-example.txt | 16 + build/docs/postTeamsSearch-example.txt | 16 + ...rovidersEdgeDiagnosticNslookup-example.txt | 17 + ...onyProvidersEdgeDiagnosticPing-example.txt | 17 + ...nyProvidersEdgeDiagnosticRoute-example.txt | 17 + ...ovidersEdgeDiagnosticTracepath-example.txt | 17 + ...ProvidersEdgeLogicalinterfaces-example.txt | 17 + ...honyProvidersEdgeLogsJobUpload-example.txt | 17 + ...TelephonyProvidersEdgeLogsJobs-example.txt | 17 + ...stTelephonyProvidersEdgeReboot-example.txt | 17 + ...onyProvidersEdgeSoftwareupdate-example.txt | 17 + ...lephonyProvidersEdgeStatuscode-example.txt | 17 + ...stTelephonyProvidersEdgeUnpair-example.txt | 16 + .../postTelephonyProvidersEdges-example.txt | 16 + ...rovidersEdgesAddressvalidation-example.txt | 16 + ...ersEdgesCertificateauthorities-example.txt | 16 + ...elephonyProvidersEdgesDidpools-example.txt | 16 + ...ephonyProvidersEdgesEdgegroups-example.txt | 16 + ...nyProvidersEdgesExtensionpools-example.txt | 16 + ...phonyProvidersEdgesPhoneReboot-example.txt | 15 + ...rovidersEdgesPhonebasesettings-example.txt | 16 + ...tTelephonyProvidersEdgesPhones-example.txt | 16 + ...honyProvidersEdgesPhonesReboot-example.txt | 15 + ...ovidersEdgesSiteOutboundroutes-example.txt | 17 + ...stTelephonyProvidersEdgesSites-example.txt | 16 + ...rovidersEdgesTrunkbasesettings-example.txt | 16 + ...postTelephonySiptracesDownload-example.txt | 16 + ...stTextbotsBotflowsSessionTurns-example.txt | 17 + .../postTextbotsBotflowsSessions-example.txt | 16 + .../docs/postTextbotsBotsExecute-example.txt | 16 + .../postUploadsLearningCoverart-example.txt | 16 + .../postUploadsPublicassetsImages-example.txt | 16 + build/docs/postUploadsRecordings-example.txt | 16 + ...rcemanagementHistoricaldataCsv-example.txt | 16 + build/docs/postUsageQuery-example.txt | 16 + build/docs/postUsageSimplesearch-example.txt | 16 + build/docs/postUserExternalid-example.txt | 17 + build/docs/postUserGreetings-example.txt | 17 + build/docs/postUserInvite-example.txt | 16 + build/docs/postUserPassword-example.txt | 16 + .../docs/postUserRoutinglanguages-example.txt | 17 + build/docs/postUserRoutingskills-example.txt | 17 + build/docs/postUsers-example.txt | 16 + ...pmentActivitiesAggregatesQuery-example.txt | 16 + build/docs/postUsersMePassword-example.txt | 15 + build/docs/postUsersSearch-example.txt | 16 + .../postUsersSearchTeamsAssign-example.txt | 16 + build/docs/postVoicemailMessages-example.txt | 16 + build/docs/postVoicemailSearch-example.txt | 16 + build/docs/postWebchatDeployments-example.txt | 16 + ...uestConversationMemberMessages-example.txt | 18 + ...tGuestConversationMemberTyping-example.txt | 17 + .../postWebchatGuestConversations-example.txt | 16 + ...figurationVersionsDraftPublish-example.txt | 16 + ...stWebdeploymentsConfigurations-example.txt | 16 + .../postWebdeploymentsDeployments-example.txt | 16 + ...TokenOauthcodegrantjwtexchange-example.txt | 16 + ...postWebdeploymentsTokenRefresh-example.txt | 16 + build/docs/postWidgetsDeployments-example.txt | 16 + ...anagementAdherenceExplanations-example.txt | 16 + ...mentAdherenceExplanationsQuery-example.txt | 18 + ...emanagementAdherenceHistorical-example.txt | 16 + ...agementAdherenceHistoricalBulk-example.txt | 16 + ...mentAgentAdherenceExplanations-example.txt | 17 + ...gentAdherenceExplanationsQuery-example.txt | 19 + .../postWorkforcemanagementAgents-example.txt | 16 + ...entAgentsIntegrationsHrisQuery-example.txt | 16 + ...mentAgentsMePossibleworkshifts-example.txt | 16 + ...cemanagementAgentschedulesMine-example.txt | 16 + ...ementBusinessunitActivitycodes-example.txt | 17 + ...unitAdherenceExplanationsQuery-example.txt | 19 + ...sinessunitAgentschedulesSearch-example.txt | 19 + ...managementBusinessunitIntraday-example.txt | 18 + ...mentBusinessunitPlanninggroups-example.txt | 17 + ...sinessunitServicegoaltemplates-example.txt | 17 + ...eekScheduleAgentschedulesQuery-example.txt | 21 + ...ntBusinessunitWeekScheduleCopy-example.txt | 19 + ...nessunitWeekScheduleReschedule-example.txt | 19 + ...BusinessunitWeekScheduleUpdate-example.txt | 19 + ...nitWeekScheduleUpdateUploadurl-example.txt | 19 + ...ementBusinessunitWeekSchedules-example.txt | 18 + ...inessunitWeekSchedulesGenerate-example.txt | 18 + ...usinessunitWeekSchedulesImport-example.txt | 18 + ...itWeekSchedulesImportUploadurl-example.txt | 18 + ...sunitWeekShorttermforecastCopy-example.txt | 20 + ...WeekShorttermforecastsGenerate-example.txt | 19 + ...itWeekShorttermforecastsImport-example.txt | 18 + ...rttermforecastsImportUploadurl-example.txt | 18 + ...rkforcemanagementBusinessunits-example.txt | 16 + ...kforcemanagementCalendarUrlIcs-example.txt | 16 + ...agementHistoricaldataDeletejob-example.txt | 15 + ...nagementHistoricaldataValidate-example.txt | 15 + ...ntegrationsHriTimeofftypesJobs-example.txt | 16 + ...gementunitAgentschedulesSearch-example.txt | 19 + ...ntunitHistoricaladherencequery-example.txt | 17 + ...cemanagementManagementunitMove-example.txt | 17 + ...tManagementunitSchedulesSearch-example.txt | 17 + ...entManagementunitShrinkageJobs-example.txt | 17 + ...entManagementunitTimeofflimits-example.txt | 17 + ...ntunitTimeofflimitsValuesQuery-example.txt | 17 + ...mentManagementunitTimeoffplans-example.txt | 17 + ...tManagementunitTimeoffrequests-example.txt | 17 + ...requestsIntegrationstatusQuery-example.txt | 17 + ...gementunitTimeoffrequestsQuery-example.txt | 17 + ...requestsWaitlistpositionsQuery-example.txt | 17 + ...mentunitUserTimeoffbalanceJobs-example.txt | 18 + ...meoffrequestTimeoffbalanceJobs-example.txt | 18 + ...nitUserTimeoffrequestsEstimate-example.txt | 18 + ...agementunitWeekShifttradeMatch-example.txt | 19 + ...tManagementunitWeekShifttrades-example.txt | 18 + ...ementunitWeekShifttradesSearch-example.txt | 18 + ...ntunitWeekShifttradesStateBulk-example.txt | 19 + ...mentManagementunitWorkplanCopy-example.txt | 18 + ...ManagementunitWorkplanValidate-example.txt | 19 + ...gementunitWorkplanrotationCopy-example.txt | 18 + ...anagementunitWorkplanrotations-example.txt | 17 + ...agementManagementunitWorkplans-example.txt | 18 + ...forcemanagementManagementunits-example.txt | 16 + ...emanagementNotificationsUpdate-example.txt | 16 + ...stWorkforcemanagementSchedules-example.txt | 16 + ...agementTeamAdherenceHistorical-example.txt | 17 + ...rcemanagementTeamShrinkageJobs-example.txt | 17 + ...cemanagementTimeoffbalanceJobs-example.txt | 16 + ...entTimeofflimitsAvailableQuery-example.txt | 16 + ...forcemanagementTimeoffrequests-example.txt | 16 + ...agementTimeoffrequestsEstimate-example.txt | 16 + ...requestsIntegrationstatusQuery-example.txt | 16 + build/docs/putAlertingAlert-example.txt | 17 + ...tAlertingInteractionstatsAlert-example.txt | 18 + ...utAlertingInteractionstatsRule-example.txt | 18 + build/docs/putAlertingRule-example.txt | 17 + ...AnalyticsDataretentionSettings-example.txt | 16 + .../putAnalyticsReportingSchedule-example.txt | 17 + .../putArchitectEmergencygroup-example.txt | 17 + build/docs/putArchitectIvr-example.txt | 17 + build/docs/putArchitectPrompt-example.txt | 17 + .../putArchitectPromptResource-example.txt | 18 + build/docs/putArchitectSchedule-example.txt | 17 + .../putArchitectSchedulegroup-example.txt | 17 + ...tArchitectSystempromptResource-example.txt | 18 + .../docs/putAuthorizationDivision-example.txt | 17 + build/docs/putAuthorizationRole-example.txt | 17 + .../putAuthorizationRoleUsersAdd-example.txt | 17 + ...utAuthorizationRoleUsersRemove-example.txt | 17 + .../putAuthorizationRolesDefault-example.txt | 16 + build/docs/putChatSettings-example.txt | 16 + build/docs/putChatsSettings-example.txt | 16 + .../putContentmanagementWorkspace-example.txt | 17 + ...ntentmanagementWorkspaceMember-example.txt | 18 + ...entmanagementWorkspaceTagvalue-example.txt | 18 + ...sationParticipantFlaggedreason-example.txt | 16 + .../docs/putConversationRecording-example.txt | 19 + ...onversationRecordingAnnotation-example.txt | 19 + ...utConversationSecureattributes-example.txt | 17 + build/docs/putConversationTags-example.txt | 17 + ...articipantCommunicationUuidata-example.txt | 19 + ...onversationsCallRecordingstate-example.txt | 17 + ...rsationsCallbackRecordingstate-example.txt | 17 + ...onversationsChatRecordingstate-example.txt | 17 + ...sCobrowsesessionRecordingstate-example.txt | 17 + ...onversationsEmailMessagesDraft-example.txt | 17 + ...nversationsEmailRecordingstate-example.txt | 17 + ...tConversationsKeyconfiguration-example.txt | 17 + ...ersationsMessageRecordingstate-example.txt | 17 + ...gIntegrationsLineIntegrationId-example.txt | 17 + ...ationsMessagingSettingsDefault-example.txt | 16 + ...ssagingSupportedcontentDefault-example.txt | 16 + ...ionsMessagingThreadingtimeline-example.txt | 16 + ...tionsScreenshareRecordingstate-example.txt | 17 + ...versationsSocialRecordingstate-example.txt | 17 + ...nversationsVideoRecordingstate-example.txt | 17 + .../putExternalcontactsContact-example.txt | 17 + ...putExternalcontactsContactNote-example.txt | 18 + ...ExternalcontactsContactsSchema-example.txt | 17 + ...utExternalcontactsConversation-example.txt | 16 + ...utExternalcontactsOrganization-example.txt | 17 + ...ternalcontactsOrganizationNote-example.txt | 18 + ...tsOrganizationTrustorTrustorId-example.txt | 17 + ...nalcontactsOrganizationsSchema-example.txt | 17 + ...utExternalcontactsRelationship-example.txt | 17 + build/docs/putFaxDocument-example.txt | 17 + build/docs/putFlow-example.txt | 17 + build/docs/putFlowsDatatable-example.txt | 18 + build/docs/putFlowsDatatableRow-example.txt | 18 + build/docs/putFlowsMilestone-example.txt | 17 + build/docs/putFlowsOutcome-example.txt | 17 + build/docs/putGamificationProfile-example.txt | 17 + .../putGamificationProfileMetric-example.txt | 18 + build/docs/putGamificationStatus-example.txt | 16 + build/docs/putGreeting-example.txt | 17 + build/docs/putGreetingsDefaults-example.txt | 16 + build/docs/putGroup-example.txt | 17 + .../putGroupGreetingsDefaults-example.txt | 17 + .../docs/putIdentityprovidersAdfs-example.txt | 16 + .../docs/putIdentityprovidersCic-example.txt | 16 + .../putIdentityprovidersGeneric-example.txt | 16 + .../putIdentityprovidersGsuite-example.txt | 16 + ...utIdentityprovidersIdentitynow-example.txt | 16 + .../docs/putIdentityprovidersOkta-example.txt | 16 + .../putIdentityprovidersOnelogin-example.txt | 16 + .../docs/putIdentityprovidersPing-example.txt | 16 + .../putIdentityprovidersPurecloud-example.txt | 16 + ...putIdentityprovidersPureengage-example.txt | 16 + ...putIdentityprovidersSalesforce-example.txt | 16 + .../putIntegrationConfigCurrent-example.txt | 17 + ...sBotconnectorIntegrationIdBots-example.txt | 16 + .../putIntegrationsCredential-example.txt | 17 + ...tIntegrationsSpeechTtsSettings-example.txt | 16 + ...mmunicationThirdpartypresences-example.txt | 17 + ...uageunderstandingDomainVersion-example.txt | 18 + build/docs/putLearningModule-example.txt | 17 + build/docs/putLearningModuleRule-example.txt | 17 + .../putMessagingSettingsDefault-example.txt | 16 + build/docs/putMobiledevice-example.txt | 17 + ...ificationsChannelSubscriptions-example.txt | 18 + build/docs/putOauthClient-example.txt | 17 + ...ganizationsEmbeddedintegration-example.txt | 16 + ...zationsIpaddressauthentication-example.txt | 16 + build/docs/putOrganizationsMe-example.txt | 16 + .../putOrganizationsWhitelist-example.txt | 16 + .../putOrgauthorizationTrustee-example.txt | 17 + ...ationTrusteeGroupRoledivisions-example.txt | 18 + ...authorizationTrusteeGroupRoles-example.txt | 18 + ...zationTrusteeUserRoledivisions-example.txt | 18 + ...gauthorizationTrusteeUserRoles-example.txt | 18 + ...authorizationTrustorCloneduser-example.txt | 17 + ...utOrgauthorizationTrustorGroup-example.txt | 17 + ...putOrgauthorizationTrustorUser-example.txt | 17 + build/docs/putOrphanrecording-example.txt | 17 + .../docs/putOutboundAttemptlimit-example.txt | 17 + .../putOutboundCallabletimeset-example.txt | 17 + ...utboundCallanalysisresponseset-example.txt | 17 + build/docs/putOutboundCampaign-example.txt | 17 + .../docs/putOutboundCampaignAgent-example.txt | 18 + .../docs/putOutboundCampaignrule-example.txt | 17 + build/docs/putOutboundContactlist-example.txt | 17 + .../putOutboundContactlistContact-example.txt | 18 + .../putOutboundContactlistfilter-example.txt | 17 + .../putOutboundDigitalruleset-example.txt | 17 + build/docs/putOutboundDnclist-example.txt | 17 + .../putOutboundMessagingcampaign-example.txt | 17 + build/docs/putOutboundRuleset-example.txt | 17 + .../putOutboundSchedulesCampaign-example.txt | 17 + ...OutboundSchedulesEmailcampaign-example.txt | 17 + ...oundSchedulesMessagingcampaign-example.txt | 17 + .../putOutboundSchedulesSequence-example.txt | 17 + build/docs/putOutboundSequence-example.txt | 17 + .../putOutboundWrapupcodemappings-example.txt | 16 + build/docs/putPresenceSettings-example.txt | 16 + build/docs/putPresenceSource-example.txt | 17 + .../putPresenceUserPrimarysource-example.txt | 17 + build/docs/putPresencedefinition-example.txt | 17 + .../putProcessautomationTrigger-example.txt | 17 + build/docs/putQualityCalibration-example.txt | 17 + ...tQualityConversationEvaluation-example.txt | 19 + build/docs/putQualityForm-example.txt | 17 + .../putQualityFormsEvaluation-example.txt | 17 + build/docs/putQualityFormsSurvey-example.txt | 17 + .../putQualitySurveysScorable-example.txt | 17 + ...ssplatformMediaretentionpolicy-example.txt | 17 + build/docs/putRecordingJob-example.txt | 17 + .../putRecordingKeyconfiguration-example.txt | 17 + ...tRecordingMediaretentionpolicy-example.txt | 17 + ...gRecordingkeysRotationschedule-example.txt | 16 + build/docs/putRecordingSettings-example.txt | 16 + ...utRecordingsDeletionprotection-example.txt | 16 + .../putResponsemanagementLibrary-example.txt | 17 + .../putResponsemanagementResponse-example.txt | 18 + ...esponsemanagementResponseasset-example.txt | 17 + .../putRoutingEmailDomainRoute-example.txt | 18 + ...gEmailOutboundDomainActivation-example.txt | 16 + .../putRoutingMessageRecipient-example.txt | 17 + build/docs/putRoutingQueue-example.txt | 17 + build/docs/putRoutingSettings-example.txt | 16 + ...utRoutingSettingsTranscription-example.txt | 16 + .../docs/putRoutingSmsPhonenumber-example.txt | 17 + .../putRoutingUserUtilization-example.txt | 17 + build/docs/putRoutingUtilization-example.txt | 16 + build/docs/putRoutingWrapupcode-example.txt | 17 + build/docs/putScimGroup-example.txt | 18 + build/docs/putScimUser-example.txt | 18 + build/docs/putScimV2Group-example.txt | 18 + build/docs/putScimV2User-example.txt | 18 + ...ryfeedbackDictionaryFeedbackId-example.txt | 17 + ...tSpeechandtextanalyticsProgram-example.txt | 17 + ...ndtextanalyticsProgramMappings-example.txt | 17 + ...icsProgramTranscriptionengines-example.txt | 17 + ...SpeechandtextanalyticsSettings-example.txt | 16 + ...putSpeechandtextanalyticsTopic-example.txt | 17 + .../putTelephonyProvidersEdge-example.txt | 17 + ...yProvidersEdgeLogicalinterface-example.txt | 18 + ...idersEdgesCertificateauthority-example.txt | 17 + ...TelephonyProvidersEdgesDidpool-example.txt | 17 + ...lephonyProvidersEdgesEdgegroup-example.txt | 17 + ...ersEdgesEdgegroupEdgetrunkbase-example.txt | 18 + ...onyProvidersEdgesExtensionpool-example.txt | 17 + ...utTelephonyProvidersEdgesPhone-example.txt | 17 + ...ProvidersEdgesPhonebasesetting-example.txt | 17 + ...putTelephonyProvidersEdgesSite-example.txt | 17 + ...yProvidersEdgesSiteNumberplans-example.txt | 17 + ...rovidersEdgesSiteOutboundroute-example.txt | 18 + ...ProvidersEdgesTrunkbasesetting-example.txt | 17 + build/docs/putUserCallforwarding-example.txt | 17 + .../docs/putUserGreetingsDefaults-example.txt | 17 + build/docs/putUserOutofoffice-example.txt | 17 + build/docs/putUserProfileskills-example.txt | 17 + build/docs/putUserRoles-example.txt | 17 + build/docs/putUserRoutingskill-example.txt | 18 + .../docs/putUserRoutingskillsBulk-example.txt | 17 + build/docs/putUserRoutingstatus-example.txt | 17 + build/docs/putUserState-example.txt | 17 + ...tionAssociatedstationStationId-example.txt | 16 + ...StationDefaultstationStationId-example.txt | 16 + build/docs/putUserrecording-example.txt | 18 + build/docs/putUsersPresencesBulk-example.txt | 16 + build/docs/putVoicemailMessage-example.txt | 17 + build/docs/putVoicemailPolicy-example.txt | 16 + build/docs/putVoicemailUserpolicy-example.txt | 17 + build/docs/putWebchatDeployment-example.txt | 17 + build/docs/putWebchatSettings-example.txt | 16 + ...entsConfigurationVersionsDraft-example.txt | 17 + .../putWebdeploymentsDeployment-example.txt | 17 + build/docs/putWidgetsDeployment-example.txt | 17 + ...anagementAgentIntegrationsHris-example.txt | 17 + ...nagementunitTimeofflimitValues-example.txt | 18 + build/docs/releaseNotes.md | 85 +- releaseNotes.md | 85 +- version.json | 6 +- 2117 files changed, 75554 insertions(+), 40925 deletions(-) delete mode 100644 build/APIData.json create mode 100644 build/docs/AlertingAPI.json create mode 100644 build/docs/AnalyticsAPI.json create mode 100644 build/docs/ArchitectAPI.json create mode 100644 build/docs/AuditAPI.json create mode 100644 build/docs/AuthorizationAPI.json create mode 100644 build/docs/BillingAPI.json create mode 100644 build/docs/CarrierServicesAPI.json create mode 100644 build/docs/ChatAPI.json create mode 100644 build/docs/CoachingAPI.json create mode 100644 build/docs/ContentManagementAPI.json create mode 100644 build/docs/ConversationsAPI.json create mode 100644 build/docs/DataExtensionsAPI.json create mode 100644 build/docs/DownloadsAPI.json create mode 100644 build/docs/EmailsAPI.json create mode 100644 build/docs/EventsAPI.json create mode 100644 build/docs/ExternalContactsAPI.json create mode 100644 build/docs/FaxAPI.json create mode 100644 build/docs/FlowsAPI.json create mode 100644 build/docs/GamificationAPI.json create mode 100644 build/docs/GeneralDataProtectionRegulationAPI.json create mode 100644 build/docs/GeolocationAPI.json create mode 100644 build/docs/GreetingsAPI.json create mode 100644 build/docs/GroupsAPI.json create mode 100644 build/docs/IdentityProviderAPI.json create mode 100644 build/docs/InfrastructureAsCodeAPI.json create mode 100644 build/docs/IntegrationsAPI.json create mode 100644 build/docs/JourneyAPI.json create mode 100644 build/docs/KnowledgeAPI.json create mode 100644 build/docs/LanguageUnderstandingAPI.json create mode 100644 build/docs/LanguagesAPI.json create mode 100644 build/docs/LearningAPI.json create mode 100644 build/docs/LicenseAPI.json create mode 100644 build/docs/LocationsAPI.json create mode 100644 build/docs/MessagingAPI.json create mode 100644 build/docs/MobileDevicesAPI.json create mode 100644 build/docs/NotificationsAPI.json create mode 100644 build/docs/OAuthAPI.json create mode 100644 build/docs/ObjectsAPI.json create mode 100644 build/docs/OrganizationAPI.json create mode 100644 build/docs/OrganizationAuthorizationAPI.json create mode 100644 build/docs/OutboundAPI.json create mode 100644 build/docs/PresenceAPI.json create mode 100644 build/docs/ProcessAutomationAPI.json create mode 100644 build/docs/QualityAPI.json create mode 100644 build/docs/RecordingAPI.json create mode 100644 build/docs/ResponseManagementAPI.json create mode 100644 build/docs/RoutingAPI.json create mode 100644 build/docs/SCIMAPI.json create mode 100644 build/docs/ScriptsAPI.json create mode 100644 build/docs/SearchAPI.json create mode 100644 build/docs/SettingsAPI.json create mode 100644 build/docs/SpeechTextAnalyticsAPI.json create mode 100644 build/docs/StationsAPI.json create mode 100644 build/docs/SuggestAPI.json create mode 100644 build/docs/TeamsAPI.json create mode 100644 build/docs/TelephonyAPI.json create mode 100644 build/docs/TelephonyProvidersEdgeAPI.json create mode 100644 build/docs/TextbotsAPI.json create mode 100644 build/docs/TokensAPI.json create mode 100644 build/docs/UploadsAPI.json create mode 100644 build/docs/UsageAPI.json create mode 100644 build/docs/UserRecordingsAPI.json create mode 100644 build/docs/UsersAPI.json create mode 100644 build/docs/UtilitiesAPI.json create mode 100644 build/docs/VoicemailAPI.json create mode 100644 build/docs/WebChatAPI.json create mode 100644 build/docs/WebDeploymentsAPI.json create mode 100644 build/docs/WebMessagingAPI.json create mode 100644 build/docs/WidgetsAPI.json create mode 100644 build/docs/WorkforceManagementAPI.json create mode 100644 build/docs/deleteAlertingAlert-example.txt create mode 100644 build/docs/deleteAlertingInteractionstatsAlert-example.txt create mode 100644 build/docs/deleteAlertingInteractionstatsRule-example.txt create mode 100644 build/docs/deleteAlertingRule-example.txt create mode 100644 build/docs/deleteAnalyticsConversationsDetailsJob-example.txt create mode 100644 build/docs/deleteAnalyticsReportingSchedule-example.txt create mode 100644 build/docs/deleteAnalyticsUsersDetailsJob-example.txt create mode 100644 build/docs/deleteArchitectEmergencygroup-example.txt create mode 100644 build/docs/deleteArchitectIvr-example.txt create mode 100644 build/docs/deleteArchitectPrompt-example.txt create mode 100644 build/docs/deleteArchitectPromptResource-example.txt create mode 100644 build/docs/deleteArchitectPromptResourceAudio-example.txt create mode 100644 build/docs/deleteArchitectPrompts-example.txt create mode 100644 build/docs/deleteArchitectSchedule-example.txt create mode 100644 build/docs/deleteArchitectSchedulegroup-example.txt create mode 100644 build/docs/deleteArchitectSystempromptResource-example.txt create mode 100644 build/docs/deleteAuthorizationDivision-example.txt create mode 100644 build/docs/deleteAuthorizationRole-example.txt create mode 100644 build/docs/deleteAuthorizationSubjectDivisionRole-example.txt create mode 100644 build/docs/deleteCoachingAppointment-example.txt create mode 100644 build/docs/deleteCoachingAppointmentAnnotation-example.txt create mode 100644 build/docs/deleteContentmanagementDocument-example.txt create mode 100644 build/docs/deleteContentmanagementShare-example.txt create mode 100644 build/docs/deleteContentmanagementStatusStatusId-example.txt create mode 100644 build/docs/deleteContentmanagementWorkspace-example.txt create mode 100644 build/docs/deleteContentmanagementWorkspaceMember-example.txt create mode 100644 build/docs/deleteContentmanagementWorkspaceTagvalue-example.txt create mode 100644 build/docs/deleteConversationParticipantCode-example.txt create mode 100644 build/docs/deleteConversationParticipantFlaggedreason-example.txt create mode 100644 build/docs/deleteConversationRecordingAnnotation-example.txt create mode 100644 build/docs/deleteConversationsCallParticipantConsult-example.txt create mode 100644 build/docs/deleteConversationsEmailMessagesDraftAttachment-example.txt create mode 100644 build/docs/deleteConversationsMessagesCachedmediaCachedMediaItemId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsFacebookIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsInstagramIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsLineIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsOpenIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsTwitterIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt create mode 100644 build/docs/deleteConversationsMessagingSetting-example.txt create mode 100644 build/docs/deleteConversationsMessagingSettingsDefault-example.txt create mode 100644 build/docs/deleteConversationsMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/deleteEmployeeperformanceExternalmetricsDefinition-example.txt create mode 100644 build/docs/deleteExternalcontactsContact-example.txt create mode 100644 build/docs/deleteExternalcontactsContactNote-example.txt create mode 100644 build/docs/deleteExternalcontactsContactsSchema-example.txt create mode 100644 build/docs/deleteExternalcontactsOrganization-example.txt create mode 100644 build/docs/deleteExternalcontactsOrganizationNote-example.txt create mode 100644 build/docs/deleteExternalcontactsOrganizationTrustor-example.txt create mode 100644 build/docs/deleteExternalcontactsRelationship-example.txt create mode 100644 build/docs/deleteFaxDocument-example.txt create mode 100644 build/docs/deleteFlow-example.txt create mode 100644 build/docs/deleteFlows-example.txt create mode 100644 build/docs/deleteFlowsDatatable-example.txt create mode 100644 build/docs/deleteFlowsDatatableRow-example.txt create mode 100644 build/docs/deleteFlowsMilestone-example.txt create mode 100644 build/docs/deleteGreeting-example.txt create mode 100644 build/docs/deleteGroup-example.txt create mode 100644 build/docs/deleteGroupMembers-example.txt create mode 100644 build/docs/deleteIdentityprovidersAdfs-example.txt create mode 100644 build/docs/deleteIdentityprovidersCic-example.txt create mode 100644 build/docs/deleteIdentityprovidersGeneric-example.txt create mode 100644 build/docs/deleteIdentityprovidersGsuite-example.txt create mode 100644 build/docs/deleteIdentityprovidersIdentitynow-example.txt create mode 100644 build/docs/deleteIdentityprovidersOkta-example.txt create mode 100644 build/docs/deleteIdentityprovidersOnelogin-example.txt create mode 100644 build/docs/deleteIdentityprovidersPing-example.txt create mode 100644 build/docs/deleteIdentityprovidersPurecloud-example.txt create mode 100644 build/docs/deleteIdentityprovidersPureengage-example.txt create mode 100644 build/docs/deleteIdentityprovidersSalesforce-example.txt create mode 100644 build/docs/deleteIntegration-example.txt create mode 100644 build/docs/deleteIntegrationsAction-example.txt create mode 100644 build/docs/deleteIntegrationsActionDraft-example.txt create mode 100644 build/docs/deleteIntegrationsCredential-example.txt create mode 100644 build/docs/deleteJourneyActionmap-example.txt create mode 100644 build/docs/deleteJourneyActiontemplate-example.txt create mode 100644 build/docs/deleteJourneyOutcome-example.txt create mode 100644 build/docs/deleteJourneyOutcomesPredictor-example.txt create mode 100644 build/docs/deleteJourneySegment-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebase-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseCategory-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseDocument-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseDocumentVariation-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseExportJob-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseImportJob-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseLabel-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseLanguageCategory-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseLanguageDocument-example.txt create mode 100644 build/docs/deleteKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt create mode 100644 build/docs/deleteLanguage-example.txt create mode 100644 build/docs/deleteLanguageunderstandingDomain-example.txt create mode 100644 build/docs/deleteLanguageunderstandingDomainFeedbackFeedbackId-example.txt create mode 100644 build/docs/deleteLanguageunderstandingDomainVersion-example.txt create mode 100644 build/docs/deleteLanguageunderstandingMiner-example.txt create mode 100644 build/docs/deleteLanguageunderstandingMinerDraft-example.txt create mode 100644 build/docs/deleteLearningAssignment-example.txt create mode 100644 build/docs/deleteLearningModule-example.txt create mode 100644 build/docs/deleteLocation-example.txt create mode 100644 build/docs/deleteMessagingSetting-example.txt create mode 100644 build/docs/deleteMessagingSettingsDefault-example.txt create mode 100644 build/docs/deleteMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/deleteMobiledevice-example.txt create mode 100644 build/docs/deleteNotificationsChannelSubscriptions-example.txt create mode 100644 build/docs/deleteOauthClient-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrustee-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrusteeCloneduser-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrusteeGroup-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrusteeGroupRoles-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrusteeUser-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrusteeUserRoles-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrustor-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrustorCloneduser-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrustorGroup-example.txt create mode 100644 build/docs/deleteOrgauthorizationTrustorUser-example.txt create mode 100644 build/docs/deleteOrphanrecording-example.txt create mode 100644 build/docs/deleteOutboundAttemptlimit-example.txt create mode 100644 build/docs/deleteOutboundCallabletimeset-example.txt create mode 100644 build/docs/deleteOutboundCallanalysisresponseset-example.txt create mode 100644 build/docs/deleteOutboundCampaign-example.txt create mode 100644 build/docs/deleteOutboundCampaignProgress-example.txt create mode 100644 build/docs/deleteOutboundCampaignrule-example.txt create mode 100644 build/docs/deleteOutboundContactlist-example.txt create mode 100644 build/docs/deleteOutboundContactlistContact-example.txt create mode 100644 build/docs/deleteOutboundContactlistContacts-example.txt create mode 100644 build/docs/deleteOutboundContactlistfilter-example.txt create mode 100644 build/docs/deleteOutboundContactlists-example.txt create mode 100644 build/docs/deleteOutboundDigitalruleset-example.txt create mode 100644 build/docs/deleteOutboundDnclist-example.txt create mode 100644 build/docs/deleteOutboundDnclistCustomexclusioncolumns-example.txt create mode 100644 build/docs/deleteOutboundDnclistEmailaddresses-example.txt create mode 100644 build/docs/deleteOutboundDnclistPhonenumbers-example.txt create mode 100644 build/docs/deleteOutboundMessagingcampaign-example.txt create mode 100644 build/docs/deleteOutboundMessagingcampaignProgress-example.txt create mode 100644 build/docs/deleteOutboundRuleset-example.txt create mode 100644 build/docs/deleteOutboundSchedulesCampaign-example.txt create mode 100644 build/docs/deleteOutboundSchedulesEmailcampaign-example.txt create mode 100644 build/docs/deleteOutboundSchedulesMessagingcampaign-example.txt create mode 100644 build/docs/deleteOutboundSchedulesSequence-example.txt create mode 100644 build/docs/deleteOutboundSequence-example.txt create mode 100644 build/docs/deletePresenceSource-example.txt create mode 100644 build/docs/deletePresencedefinition-example.txt create mode 100644 build/docs/deleteProcessautomationTrigger-example.txt create mode 100644 build/docs/deleteQualityCalibration-example.txt create mode 100644 build/docs/deleteQualityConversationEvaluation-example.txt create mode 100644 build/docs/deleteQualityForm-example.txt create mode 100644 build/docs/deleteQualityFormsEvaluation-example.txt create mode 100644 build/docs/deleteQualityFormsSurvey-example.txt create mode 100644 build/docs/deleteRecordingCrossplatformMediaretentionpolicies-example.txt create mode 100644 build/docs/deleteRecordingCrossplatformMediaretentionpolicy-example.txt create mode 100644 build/docs/deleteRecordingJob-example.txt create mode 100644 build/docs/deleteRecordingMediaretentionpolicies-example.txt create mode 100644 build/docs/deleteRecordingMediaretentionpolicy-example.txt create mode 100644 build/docs/deleteResponsemanagementLibrary-example.txt create mode 100644 build/docs/deleteResponsemanagementResponse-example.txt create mode 100644 build/docs/deleteResponsemanagementResponseasset-example.txt create mode 100644 build/docs/deleteRoutingAssessment-example.txt create mode 100644 build/docs/deleteRoutingEmailDomain-example.txt create mode 100644 build/docs/deleteRoutingEmailDomainRoute-example.txt create mode 100644 build/docs/deleteRoutingEmailOutboundDomain-example.txt create mode 100644 build/docs/deleteRoutingLanguage-example.txt create mode 100644 build/docs/deleteRoutingPredictor-example.txt create mode 100644 build/docs/deleteRoutingQueue-example.txt create mode 100644 build/docs/deleteRoutingQueueMember-example.txt create mode 100644 build/docs/deleteRoutingQueueUser-example.txt create mode 100644 build/docs/deleteRoutingQueueWrapupcode-example.txt create mode 100644 build/docs/deleteRoutingSettings-example.txt create mode 100644 build/docs/deleteRoutingSkill-example.txt create mode 100644 build/docs/deleteRoutingSkillgroup-example.txt create mode 100644 build/docs/deleteRoutingSmsAddress-example.txt create mode 100644 build/docs/deleteRoutingSmsPhonenumber-example.txt create mode 100644 build/docs/deleteRoutingUserUtilization-example.txt create mode 100644 build/docs/deleteRoutingUtilization-example.txt create mode 100644 build/docs/deleteRoutingWrapupcode-example.txt create mode 100644 build/docs/deleteScimUser-example.txt create mode 100644 build/docs/deleteScimV2User-example.txt create mode 100644 build/docs/deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt create mode 100644 build/docs/deleteSpeechandtextanalyticsProgram-example.txt create mode 100644 build/docs/deleteSpeechandtextanalyticsSentimentfeedback-example.txt create mode 100644 build/docs/deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId-example.txt create mode 100644 build/docs/deleteSpeechandtextanalyticsTopic-example.txt create mode 100644 build/docs/deleteStationAssociateduser-example.txt create mode 100644 build/docs/deleteTeam-example.txt create mode 100644 build/docs/deleteTeamMembers-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdge-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgeLogicalinterface-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgeSoftwareupdate-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesCertificateauthority-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesDidpool-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesEdgegroup-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesExtensionpool-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesPhone-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesPhonebasesetting-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesSite-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesSiteOutboundroute-example.txt create mode 100644 build/docs/deleteTelephonyProvidersEdgesTrunkbasesetting-example.txt create mode 100644 build/docs/deleteToken-example.txt create mode 100644 build/docs/deleteTokensMe-example.txt create mode 100644 build/docs/deleteUser-example.txt create mode 100644 build/docs/deleteUserRoutinglanguage-example.txt create mode 100644 build/docs/deleteUserRoutingskill-example.txt create mode 100644 build/docs/deleteUserStationAssociatedstation-example.txt create mode 100644 build/docs/deleteUserStationDefaultstation-example.txt create mode 100644 build/docs/deleteUserrecording-example.txt create mode 100644 build/docs/deleteVoicemailMessage-example.txt create mode 100644 build/docs/deleteVoicemailMessages-example.txt create mode 100644 build/docs/deleteWebchatDeployment-example.txt create mode 100644 build/docs/deleteWebchatGuestConversationMember-example.txt create mode 100644 build/docs/deleteWebchatSettings-example.txt create mode 100644 build/docs/deleteWebdeploymentsConfiguration-example.txt create mode 100644 build/docs/deleteWebdeploymentsDeployment-example.txt create mode 100644 build/docs/deleteWebdeploymentsDeploymentCobrowseSessionId-example.txt create mode 100644 build/docs/deleteWebdeploymentsTokenRevoke-example.txt create mode 100644 build/docs/deleteWidgetsDeployment-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunit-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitActivitycode-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitPlanninggroup-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitSchedulingRun-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitServicegoaltemplate-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitWeekSchedule-example.txt create mode 100644 build/docs/deleteWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt create mode 100644 build/docs/deleteWorkforcemanagementCalendarUrlIcs-example.txt create mode 100644 build/docs/deleteWorkforcemanagementManagementunit-example.txt create mode 100644 build/docs/deleteWorkforcemanagementManagementunitTimeofflimit-example.txt create mode 100644 build/docs/deleteWorkforcemanagementManagementunitTimeoffplan-example.txt create mode 100644 build/docs/deleteWorkforcemanagementManagementunitWorkplan-example.txt create mode 100644 build/docs/deleteWorkforcemanagementManagementunitWorkplanrotation-example.txt create mode 100644 build/docs/getAlertingAlert-example.txt create mode 100644 build/docs/getAlertingAlertsActive-example.txt create mode 100644 build/docs/getAlertingInteractionstatsAlert-example.txt create mode 100644 build/docs/getAlertingInteractionstatsAlerts-example.txt create mode 100644 build/docs/getAlertingInteractionstatsAlertsUnread-example.txt create mode 100644 build/docs/getAlertingInteractionstatsRule-example.txt create mode 100644 build/docs/getAlertingInteractionstatsRules-example.txt create mode 100644 build/docs/getAlertingRule-example.txt create mode 100644 build/docs/getAnalyticsBotflowReportingturns-example.txt create mode 100644 build/docs/getAnalyticsConversationDetails-example.txt create mode 100644 build/docs/getAnalyticsConversationsDetails-example.txt create mode 100644 build/docs/getAnalyticsConversationsDetailsJob-example.txt create mode 100644 build/docs/getAnalyticsConversationsDetailsJobResults-example.txt create mode 100644 build/docs/getAnalyticsConversationsDetailsJobsAvailability-example.txt create mode 100644 build/docs/getAnalyticsDataretentionSettings-example.txt create mode 100644 build/docs/getAnalyticsReportingExports-example.txt create mode 100644 build/docs/getAnalyticsReportingExportsMetadata-example.txt create mode 100644 build/docs/getAnalyticsReportingMetadata-example.txt create mode 100644 build/docs/getAnalyticsReportingReportIdMetadata-example.txt create mode 100644 build/docs/getAnalyticsReportingReportformats-example.txt create mode 100644 build/docs/getAnalyticsReportingSchedule-example.txt create mode 100644 build/docs/getAnalyticsReportingScheduleHistory-example.txt create mode 100644 build/docs/getAnalyticsReportingScheduleHistoryLatest-example.txt create mode 100644 build/docs/getAnalyticsReportingScheduleHistoryRunId-example.txt create mode 100644 build/docs/getAnalyticsReportingSchedules-example.txt create mode 100644 build/docs/getAnalyticsReportingSettings-example.txt create mode 100644 build/docs/getAnalyticsReportingTimeperiods-example.txt create mode 100644 build/docs/getAnalyticsUsersDetailsJob-example.txt create mode 100644 build/docs/getAnalyticsUsersDetailsJobResults-example.txt create mode 100644 build/docs/getAnalyticsUsersDetailsJobsAvailability-example.txt create mode 100644 build/docs/getArchitectDependencytracking-example.txt create mode 100644 build/docs/getArchitectDependencytrackingBuild-example.txt create mode 100644 build/docs/getArchitectDependencytrackingConsumedresources-example.txt create mode 100644 build/docs/getArchitectDependencytrackingConsumingresources-example.txt create mode 100644 build/docs/getArchitectDependencytrackingDeletedresourceconsumers-example.txt create mode 100644 build/docs/getArchitectDependencytrackingObject-example.txt create mode 100644 build/docs/getArchitectDependencytrackingType-example.txt create mode 100644 build/docs/getArchitectDependencytrackingTypes-example.txt create mode 100644 build/docs/getArchitectDependencytrackingUpdatedresourceconsumers-example.txt create mode 100644 build/docs/getArchitectEmergencygroup-example.txt create mode 100644 build/docs/getArchitectEmergencygroups-example.txt create mode 100644 build/docs/getArchitectEmergencygroupsDivisionviews-example.txt create mode 100644 build/docs/getArchitectIvr-example.txt create mode 100644 build/docs/getArchitectIvrs-example.txt create mode 100644 build/docs/getArchitectIvrsDivisionviews-example.txt create mode 100644 build/docs/getArchitectPrompt-example.txt create mode 100644 build/docs/getArchitectPromptHistoryHistoryId-example.txt create mode 100644 build/docs/getArchitectPromptResource-example.txt create mode 100644 build/docs/getArchitectPromptResources-example.txt create mode 100644 build/docs/getArchitectPrompts-example.txt create mode 100644 build/docs/getArchitectSchedule-example.txt create mode 100644 build/docs/getArchitectSchedulegroup-example.txt create mode 100644 build/docs/getArchitectSchedulegroups-example.txt create mode 100644 build/docs/getArchitectSchedulegroupsDivisionviews-example.txt create mode 100644 build/docs/getArchitectSchedules-example.txt create mode 100644 build/docs/getArchitectSchedulesDivisionviews-example.txt create mode 100644 build/docs/getArchitectSystemprompt-example.txt create mode 100644 build/docs/getArchitectSystempromptHistoryHistoryId-example.txt create mode 100644 build/docs/getArchitectSystempromptResource-example.txt create mode 100644 build/docs/getArchitectSystempromptResources-example.txt create mode 100644 build/docs/getArchitectSystemprompts-example.txt create mode 100644 build/docs/getAuditsQueryRealtimeServicemapping-example.txt create mode 100644 build/docs/getAuditsQueryServicemapping-example.txt create mode 100644 build/docs/getAuditsQueryTransactionId-example.txt create mode 100644 build/docs/getAuditsQueryTransactionIdResults-example.txt create mode 100644 build/docs/getAuthorizationDivision-example.txt create mode 100644 build/docs/getAuthorizationDivisionGrants-example.txt create mode 100644 build/docs/getAuthorizationDivisions-example.txt create mode 100644 build/docs/getAuthorizationDivisionsHome-example.txt create mode 100644 build/docs/getAuthorizationDivisionsLimit-example.txt create mode 100644 build/docs/getAuthorizationDivisionspermittedMe-example.txt create mode 100644 build/docs/getAuthorizationDivisionspermittedPagedMe-example.txt create mode 100644 build/docs/getAuthorizationDivisionspermittedPagedSubjectId-example.txt create mode 100644 build/docs/getAuthorizationPermissions-example.txt create mode 100644 build/docs/getAuthorizationProducts-example.txt create mode 100644 build/docs/getAuthorizationRole-example.txt create mode 100644 build/docs/getAuthorizationRoleComparedefaultRightRoleId-example.txt create mode 100644 build/docs/getAuthorizationRoleSubjectgrants-example.txt create mode 100644 build/docs/getAuthorizationRoleUsers-example.txt create mode 100644 build/docs/getAuthorizationRoles-example.txt create mode 100644 build/docs/getAuthorizationSettings-example.txt create mode 100644 build/docs/getAuthorizationSubject-example.txt create mode 100644 build/docs/getAuthorizationSubjectsMe-example.txt create mode 100644 build/docs/getAuthorizationSubjectsRolecounts-example.txt create mode 100644 build/docs/getBillingReportsBillableusage-example.txt create mode 100644 build/docs/getBillingTrusteebillingoverviewTrustorOrgId-example.txt create mode 100644 build/docs/getCarrierservicesIntegrationsEmergencylocationsMe-example.txt create mode 100644 build/docs/getChatSettings-example.txt create mode 100644 build/docs/getChatsSettings-example.txt create mode 100644 build/docs/getCoachingAppointment-example.txt create mode 100644 build/docs/getCoachingAppointmentAnnotation-example.txt create mode 100644 build/docs/getCoachingAppointmentAnnotations-example.txt create mode 100644 build/docs/getCoachingAppointmentStatuses-example.txt create mode 100644 build/docs/getCoachingAppointments-example.txt create mode 100644 build/docs/getCoachingAppointmentsMe-example.txt create mode 100644 build/docs/getCoachingNotification-example.txt create mode 100644 build/docs/getCoachingNotifications-example.txt create mode 100644 build/docs/getContentmanagementDocument-example.txt create mode 100644 build/docs/getContentmanagementDocumentAudits-example.txt create mode 100644 build/docs/getContentmanagementDocumentContent-example.txt create mode 100644 build/docs/getContentmanagementDocuments-example.txt create mode 100644 build/docs/getContentmanagementQuery-example.txt create mode 100644 build/docs/getContentmanagementSecurityprofile-example.txt create mode 100644 build/docs/getContentmanagementSecurityprofiles-example.txt create mode 100644 build/docs/getContentmanagementShare-example.txt create mode 100644 build/docs/getContentmanagementSharedSharedId-example.txt create mode 100644 build/docs/getContentmanagementShares-example.txt create mode 100644 build/docs/getContentmanagementStatus-example.txt create mode 100644 build/docs/getContentmanagementStatusStatusId-example.txt create mode 100644 build/docs/getContentmanagementUsage-example.txt create mode 100644 build/docs/getContentmanagementWorkspace-example.txt create mode 100644 build/docs/getContentmanagementWorkspaceDocuments-example.txt create mode 100644 build/docs/getContentmanagementWorkspaceMember-example.txt create mode 100644 build/docs/getContentmanagementWorkspaceMembers-example.txt create mode 100644 build/docs/getContentmanagementWorkspaceTagvalue-example.txt create mode 100644 build/docs/getContentmanagementWorkspaceTagvalues-example.txt create mode 100644 build/docs/getContentmanagementWorkspaces-example.txt create mode 100644 build/docs/getConversation-example.txt create mode 100644 build/docs/getConversationParticipantSecureivrsession-example.txt create mode 100644 build/docs/getConversationParticipantSecureivrsessions-example.txt create mode 100644 build/docs/getConversationParticipantWrapup-example.txt create mode 100644 build/docs/getConversationParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationRecording-example.txt create mode 100644 build/docs/getConversationRecordingAnnotation-example.txt create mode 100644 build/docs/getConversationRecordingAnnotations-example.txt create mode 100644 build/docs/getConversationRecordingmetadata-example.txt create mode 100644 build/docs/getConversationRecordingmetadataRecordingId-example.txt create mode 100644 build/docs/getConversationRecordings-example.txt create mode 100644 build/docs/getConversationSecureattributes-example.txt create mode 100644 build/docs/getConversations-example.txt create mode 100644 build/docs/getConversationsCall-example.txt create mode 100644 build/docs/getConversationsCallParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsCallParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsCallParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsCallback-example.txt create mode 100644 build/docs/getConversationsCallbackParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsCallbackParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsCallbackParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsCallbacks-example.txt create mode 100644 build/docs/getConversationsCalls-example.txt create mode 100644 build/docs/getConversationsCallsHistory-example.txt create mode 100644 build/docs/getConversationsCallsMaximumconferenceparties-example.txt create mode 100644 build/docs/getConversationsChat-example.txt create mode 100644 build/docs/getConversationsChatMessage-example.txt create mode 100644 build/docs/getConversationsChatMessages-example.txt create mode 100644 build/docs/getConversationsChatParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsChatParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsChatParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsChats-example.txt create mode 100644 build/docs/getConversationsCobrowsesession-example.txt create mode 100644 build/docs/getConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsCobrowsesessionParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsCobrowsesessionParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsCobrowsesessions-example.txt create mode 100644 build/docs/getConversationsEmail-example.txt create mode 100644 build/docs/getConversationsEmailMessage-example.txt create mode 100644 build/docs/getConversationsEmailMessages-example.txt create mode 100644 build/docs/getConversationsEmailMessagesDraft-example.txt create mode 100644 build/docs/getConversationsEmailParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsEmailParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsEmailParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsEmailSettings-example.txt create mode 100644 build/docs/getConversationsEmails-example.txt create mode 100644 build/docs/getConversationsKeyconfiguration-example.txt create mode 100644 build/docs/getConversationsKeyconfigurations-example.txt create mode 100644 build/docs/getConversationsMessage-example.txt create mode 100644 build/docs/getConversationsMessageCommunicationMessagesMediaMediaId-example.txt create mode 100644 build/docs/getConversationsMessageDetails-example.txt create mode 100644 build/docs/getConversationsMessageMessage-example.txt create mode 100644 build/docs/getConversationsMessageParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsMessageParticipantWrapup-example.txt create mode 100644 build/docs/getConversationsMessageParticipantWrapupcodes-example.txt create mode 100644 build/docs/getConversationsMessages-example.txt create mode 100644 build/docs/getConversationsMessagesCachedmedia-example.txt create mode 100644 build/docs/getConversationsMessagesCachedmediaCachedMediaItemId-example.txt create mode 100644 build/docs/getConversationsMessagingFacebookApp-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrations-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsFacebook-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsFacebookIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsInstagram-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsInstagramIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsLine-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsLineIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsOpen-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsOpenIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsTwitter-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsTwitterIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsWhatsapp-example.txt create mode 100644 build/docs/getConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt create mode 100644 build/docs/getConversationsMessagingSetting-example.txt create mode 100644 build/docs/getConversationsMessagingSettings-example.txt create mode 100644 build/docs/getConversationsMessagingSettingsDefault-example.txt create mode 100644 build/docs/getConversationsMessagingSticker-example.txt create mode 100644 build/docs/getConversationsMessagingSupportedcontent-example.txt create mode 100644 build/docs/getConversationsMessagingSupportedcontentDefault-example.txt create mode 100644 build/docs/getConversationsMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/getConversationsMessagingThreadingtimeline-example.txt create mode 100644 build/docs/getConversationsScreenshareParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsSettings-example.txt create mode 100644 build/docs/getConversationsSocialParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getConversationsVideoParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/getDataextensionsCoretype-example.txt create mode 100644 build/docs/getDataextensionsCoretypes-example.txt create mode 100644 build/docs/getDataextensionsLimits-example.txt create mode 100644 build/docs/getDate-example.txt create mode 100644 build/docs/getDocumentationGknSearch-example.txt create mode 100644 build/docs/getDocumentationSearch-example.txt create mode 100644 build/docs/getDownload-example.txt create mode 100644 build/docs/getEmailsSettings-example.txt create mode 100644 build/docs/getEmployeeperformanceExternalmetricsDefinition-example.txt create mode 100644 build/docs/getEmployeeperformanceExternalmetricsDefinitions-example.txt create mode 100644 build/docs/getExternalcontactsContact-example.txt create mode 100644 build/docs/getExternalcontactsContactIdentifiers-example.txt create mode 100644 build/docs/getExternalcontactsContactJourneySessions-example.txt create mode 100644 build/docs/getExternalcontactsContactNote-example.txt create mode 100644 build/docs/getExternalcontactsContactNotes-example.txt create mode 100644 build/docs/getExternalcontactsContactUnresolved-example.txt create mode 100644 build/docs/getExternalcontactsContacts-example.txt create mode 100644 build/docs/getExternalcontactsContactsSchema-example.txt create mode 100644 build/docs/getExternalcontactsContactsSchemaVersion-example.txt create mode 100644 build/docs/getExternalcontactsContactsSchemaVersions-example.txt create mode 100644 build/docs/getExternalcontactsContactsSchemas-example.txt create mode 100644 build/docs/getExternalcontactsOrganization-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationContacts-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationNote-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationNotes-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationRelationships-example.txt create mode 100644 build/docs/getExternalcontactsOrganizations-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationsSchema-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationsSchemaVersion-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationsSchemaVersions-example.txt create mode 100644 build/docs/getExternalcontactsOrganizationsSchemas-example.txt create mode 100644 build/docs/getExternalcontactsRelationship-example.txt create mode 100644 build/docs/getExternalcontactsReversewhitepageslookup-example.txt create mode 100644 build/docs/getExternalcontactsScanContacts-example.txt create mode 100644 build/docs/getExternalcontactsScanNotes-example.txt create mode 100644 build/docs/getExternalcontactsScanOrganizations-example.txt create mode 100644 build/docs/getExternalcontactsScanRelationships-example.txt create mode 100644 build/docs/getFaxDocument-example.txt create mode 100644 build/docs/getFaxDocumentContent-example.txt create mode 100644 build/docs/getFaxDocuments-example.txt create mode 100644 build/docs/getFaxSummary-example.txt create mode 100644 build/docs/getFieldconfig-example.txt create mode 100644 build/docs/getFlow-example.txt create mode 100644 build/docs/getFlowHistoryHistoryId-example.txt create mode 100644 build/docs/getFlowLatestconfiguration-example.txt create mode 100644 build/docs/getFlowVersion-example.txt create mode 100644 build/docs/getFlowVersionConfiguration-example.txt create mode 100644 build/docs/getFlowVersionHealth-example.txt create mode 100644 build/docs/getFlowVersionIntentHealth-example.txt create mode 100644 build/docs/getFlowVersionIntentUtteranceHealth-example.txt create mode 100644 build/docs/getFlowVersions-example.txt create mode 100644 build/docs/getFlows-example.txt create mode 100644 build/docs/getFlowsDatatable-example.txt create mode 100644 build/docs/getFlowsDatatableExportJob-example.txt create mode 100644 build/docs/getFlowsDatatableImportJob-example.txt create mode 100644 build/docs/getFlowsDatatableImportJobs-example.txt create mode 100644 build/docs/getFlowsDatatableRow-example.txt create mode 100644 build/docs/getFlowsDatatableRows-example.txt create mode 100644 build/docs/getFlowsDatatables-example.txt create mode 100644 build/docs/getFlowsDatatablesDivisionview-example.txt create mode 100644 build/docs/getFlowsDatatablesDivisionviews-example.txt create mode 100644 build/docs/getFlowsDivisionviews-example.txt create mode 100644 build/docs/getFlowsExecution-example.txt create mode 100644 build/docs/getFlowsJob-example.txt create mode 100644 build/docs/getFlowsMilestone-example.txt create mode 100644 build/docs/getFlowsMilestones-example.txt create mode 100644 build/docs/getFlowsMilestonesDivisionviews-example.txt create mode 100644 build/docs/getFlowsOutcome-example.txt create mode 100644 build/docs/getFlowsOutcomes-example.txt create mode 100644 build/docs/getFlowsOutcomesDivisionviews-example.txt create mode 100644 build/docs/getGamificationInsights-example.txt create mode 100644 build/docs/getGamificationInsightsDetails-example.txt create mode 100644 build/docs/getGamificationInsightsGroupsTrends-example.txt create mode 100644 build/docs/getGamificationInsightsGroupsTrendsAll-example.txt create mode 100644 build/docs/getGamificationInsightsMembers-example.txt create mode 100644 build/docs/getGamificationInsightsTrends-example.txt create mode 100644 build/docs/getGamificationInsightsUserDetails-example.txt create mode 100644 build/docs/getGamificationInsightsUserTrends-example.txt create mode 100644 build/docs/getGamificationLeaderboard-example.txt create mode 100644 build/docs/getGamificationLeaderboardAll-example.txt create mode 100644 build/docs/getGamificationLeaderboardAllBestpoints-example.txt create mode 100644 build/docs/getGamificationLeaderboardBestpoints-example.txt create mode 100644 build/docs/getGamificationMetricdefinition-example.txt create mode 100644 build/docs/getGamificationMetricdefinitions-example.txt create mode 100644 build/docs/getGamificationProfile-example.txt create mode 100644 build/docs/getGamificationProfileMembers-example.txt create mode 100644 build/docs/getGamificationProfileMetric-example.txt create mode 100644 build/docs/getGamificationProfileMetrics-example.txt create mode 100644 build/docs/getGamificationProfileMetricsObjectivedetails-example.txt create mode 100644 build/docs/getGamificationProfiles-example.txt create mode 100644 build/docs/getGamificationProfilesUser-example.txt create mode 100644 build/docs/getGamificationProfilesUsersMe-example.txt create mode 100644 build/docs/getGamificationScorecards-example.txt create mode 100644 build/docs/getGamificationScorecardsAttendance-example.txt create mode 100644 build/docs/getGamificationScorecardsBestpoints-example.txt create mode 100644 build/docs/getGamificationScorecardsPointsAlltime-example.txt create mode 100644 build/docs/getGamificationScorecardsPointsAverage-example.txt create mode 100644 build/docs/getGamificationScorecardsPointsTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsProfileMetricUserValuesTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsProfileMetricUsersValuesTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsProfileMetricValuesTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsUser-example.txt create mode 100644 build/docs/getGamificationScorecardsUserAttendance-example.txt create mode 100644 build/docs/getGamificationScorecardsUserBestpoints-example.txt create mode 100644 build/docs/getGamificationScorecardsUserPointsAlltime-example.txt create mode 100644 build/docs/getGamificationScorecardsUserPointsTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsUserValuesTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsUsersPointsAverage-example.txt create mode 100644 build/docs/getGamificationScorecardsUsersValuesAverage-example.txt create mode 100644 build/docs/getGamificationScorecardsUsersValuesTrends-example.txt create mode 100644 build/docs/getGamificationScorecardsValuesAverage-example.txt create mode 100644 build/docs/getGamificationScorecardsValuesTrends-example.txt create mode 100644 build/docs/getGamificationStatus-example.txt create mode 100644 build/docs/getGamificationTemplate-example.txt create mode 100644 build/docs/getGamificationTemplates-example.txt create mode 100644 build/docs/getGdprRequest-example.txt create mode 100644 build/docs/getGdprRequests-example.txt create mode 100644 build/docs/getGdprSubjects-example.txt create mode 100644 build/docs/getGeolocationsSettings-example.txt create mode 100644 build/docs/getGreeting-example.txt create mode 100644 build/docs/getGreetingMedia-example.txt create mode 100644 build/docs/getGreetings-example.txt create mode 100644 build/docs/getGreetingsDefaults-example.txt create mode 100644 build/docs/getGroup-example.txt create mode 100644 build/docs/getGroupGreetings-example.txt create mode 100644 build/docs/getGroupGreetingsDefaults-example.txt create mode 100644 build/docs/getGroupIndividuals-example.txt create mode 100644 build/docs/getGroupMembers-example.txt create mode 100644 build/docs/getGroupProfile-example.txt create mode 100644 build/docs/getGroups-example.txt create mode 100644 build/docs/getGroupsSearch-example.txt create mode 100644 build/docs/getIdentityproviders-example.txt create mode 100644 build/docs/getIdentityprovidersAdfs-example.txt create mode 100644 build/docs/getIdentityprovidersCic-example.txt create mode 100644 build/docs/getIdentityprovidersGeneric-example.txt create mode 100644 build/docs/getIdentityprovidersGsuite-example.txt create mode 100644 build/docs/getIdentityprovidersIdentitynow-example.txt create mode 100644 build/docs/getIdentityprovidersOkta-example.txt create mode 100644 build/docs/getIdentityprovidersOnelogin-example.txt create mode 100644 build/docs/getIdentityprovidersPing-example.txt create mode 100644 build/docs/getIdentityprovidersPurecloud-example.txt create mode 100644 build/docs/getIdentityprovidersPureengage-example.txt create mode 100644 build/docs/getIdentityprovidersSalesforce-example.txt create mode 100644 build/docs/getInfrastructureascodeAccelerator-example.txt create mode 100644 build/docs/getInfrastructureascodeAccelerators-example.txt create mode 100644 build/docs/getInfrastructureascodeJob-example.txt create mode 100644 build/docs/getInfrastructureascodeJobs-example.txt create mode 100644 build/docs/getIntegration-example.txt create mode 100644 build/docs/getIntegrationConfigCurrent-example.txt create mode 100644 build/docs/getIntegrations-example.txt create mode 100644 build/docs/getIntegrationsAction-example.txt create mode 100644 build/docs/getIntegrationsActionDraft-example.txt create mode 100644 build/docs/getIntegrationsActionDraftSchema-example.txt create mode 100644 build/docs/getIntegrationsActionDraftTemplate-example.txt create mode 100644 build/docs/getIntegrationsActionDraftValidation-example.txt create mode 100644 build/docs/getIntegrationsActionSchema-example.txt create mode 100644 build/docs/getIntegrationsActionTemplate-example.txt create mode 100644 build/docs/getIntegrationsActions-example.txt create mode 100644 build/docs/getIntegrationsActionsCategories-example.txt create mode 100644 build/docs/getIntegrationsActionsDrafts-example.txt create mode 100644 build/docs/getIntegrationsBotconnectorIntegrationIdBot-example.txt create mode 100644 build/docs/getIntegrationsBotconnectorIntegrationIdBotVersions-example.txt create mode 100644 build/docs/getIntegrationsBotconnectorIntegrationIdBots-example.txt create mode 100644 build/docs/getIntegrationsBotconnectorIntegrationIdBotsSummaries-example.txt create mode 100644 build/docs/getIntegrationsClientapps-example.txt create mode 100644 build/docs/getIntegrationsClientappsUnifiedcommunications-example.txt create mode 100644 build/docs/getIntegrationsCredential-example.txt create mode 100644 build/docs/getIntegrationsCredentials-example.txt create mode 100644 build/docs/getIntegrationsCredentialsTypes-example.txt create mode 100644 build/docs/getIntegrationsSpeechDialogflowAgent-example.txt create mode 100644 build/docs/getIntegrationsSpeechDialogflowAgents-example.txt create mode 100644 build/docs/getIntegrationsSpeechLexBotAlias-example.txt create mode 100644 build/docs/getIntegrationsSpeechLexBotBotIdAliases-example.txt create mode 100644 build/docs/getIntegrationsSpeechLexBots-example.txt create mode 100644 build/docs/getIntegrationsSpeechTtsEngine-example.txt create mode 100644 build/docs/getIntegrationsSpeechTtsEngineVoice-example.txt create mode 100644 build/docs/getIntegrationsSpeechTtsEngineVoices-example.txt create mode 100644 build/docs/getIntegrationsSpeechTtsEngines-example.txt create mode 100644 build/docs/getIntegrationsSpeechTtsSettings-example.txt create mode 100644 build/docs/getIntegrationsType-example.txt create mode 100644 build/docs/getIntegrationsTypeConfigschema-example.txt create mode 100644 build/docs/getIntegrationsTypes-example.txt create mode 100644 build/docs/getIntegrationsUserapps-example.txt create mode 100644 build/docs/getIpranges-example.txt create mode 100644 build/docs/getJourneyActionmap-example.txt create mode 100644 build/docs/getJourneyActionmaps-example.txt create mode 100644 build/docs/getJourneyActionmapsEstimatesJob-example.txt create mode 100644 build/docs/getJourneyActionmapsEstimatesJobResults-example.txt create mode 100644 build/docs/getJourneyActiontarget-example.txt create mode 100644 build/docs/getJourneyActiontargets-example.txt create mode 100644 build/docs/getJourneyActiontemplate-example.txt create mode 100644 build/docs/getJourneyActiontemplates-example.txt create mode 100644 build/docs/getJourneyOutcome-example.txt create mode 100644 build/docs/getJourneyOutcomes-example.txt create mode 100644 build/docs/getJourneyOutcomesPredictor-example.txt create mode 100644 build/docs/getJourneyOutcomesPredictors-example.txt create mode 100644 build/docs/getJourneySegment-example.txt create mode 100644 build/docs/getJourneySegments-example.txt create mode 100644 build/docs/getJourneySession-example.txt create mode 100644 build/docs/getJourneySessionOutcomescores-example.txt create mode 100644 build/docs/getKnowledgeGuestSessionCategories-example.txt create mode 100644 build/docs/getKnowledgeGuestSessionDocument-example.txt create mode 100644 build/docs/getKnowledgeGuestSessionDocuments-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebase-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseCategories-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseCategory-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocument-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentFeedback-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVariation-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVariations-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVersion-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVersionVariation-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVersionVariations-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocumentVersions-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseDocuments-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseExportJob-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseImportJob-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLabel-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLabels-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageCategories-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageCategory-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageDocument-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageDocuments-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageTraining-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseLanguageTrainings-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseUnansweredGroup-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebaseUnansweredGroups-example.txt create mode 100644 build/docs/getKnowledgeKnowledgebases-example.txt create mode 100644 build/docs/getLanguage-example.txt create mode 100644 build/docs/getLanguages-example.txt create mode 100644 build/docs/getLanguagesTranslations-example.txt create mode 100644 build/docs/getLanguagesTranslationsBuiltin-example.txt create mode 100644 build/docs/getLanguagesTranslationsOrganization-example.txt create mode 100644 build/docs/getLanguagesTranslationsUser-example.txt create mode 100644 build/docs/getLanguageunderstandingDomain-example.txt create mode 100644 build/docs/getLanguageunderstandingDomainFeedback-example.txt create mode 100644 build/docs/getLanguageunderstandingDomainFeedbackFeedbackId-example.txt create mode 100644 build/docs/getLanguageunderstandingDomainVersion-example.txt create mode 100644 build/docs/getLanguageunderstandingDomainVersionReport-example.txt create mode 100644 build/docs/getLanguageunderstandingDomainVersions-example.txt create mode 100644 build/docs/getLanguageunderstandingDomains-example.txt create mode 100644 build/docs/getLanguageunderstandingMiner-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerDraft-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerDrafts-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerIntent-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerIntents-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerTopic-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerTopicPhrase-example.txt create mode 100644 build/docs/getLanguageunderstandingMinerTopics-example.txt create mode 100644 build/docs/getLanguageunderstandingMiners-example.txt create mode 100644 build/docs/getLearningAssignment-example.txt create mode 100644 build/docs/getLearningAssignments-example.txt create mode 100644 build/docs/getLearningAssignmentsMe-example.txt create mode 100644 build/docs/getLearningModule-example.txt create mode 100644 build/docs/getLearningModuleJob-example.txt create mode 100644 build/docs/getLearningModuleRule-example.txt create mode 100644 build/docs/getLearningModuleVersion-example.txt create mode 100644 build/docs/getLearningModules-example.txt create mode 100644 build/docs/getLearningModulesAssignments-example.txt create mode 100644 build/docs/getLearningModulesCoverartCoverArtId-example.txt create mode 100644 build/docs/getLicenseDefinition-example.txt create mode 100644 build/docs/getLicenseDefinitions-example.txt create mode 100644 build/docs/getLicenseToggle-example.txt create mode 100644 build/docs/getLicenseUser-example.txt create mode 100644 build/docs/getLicenseUsers-example.txt create mode 100644 build/docs/getLocation-example.txt create mode 100644 build/docs/getLocationSublocations-example.txt create mode 100644 build/docs/getLocations-example.txt create mode 100644 build/docs/getLocationsSearch-example.txt create mode 100644 build/docs/getMessagingSetting-example.txt create mode 100644 build/docs/getMessagingSettings-example.txt create mode 100644 build/docs/getMessagingSettingsDefault-example.txt create mode 100644 build/docs/getMessagingSupportedcontent-example.txt create mode 100644 build/docs/getMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/getMobiledevice-example.txt create mode 100644 build/docs/getMobiledevices-example.txt create mode 100644 build/docs/getNotificationsAvailabletopics-example.txt create mode 100644 build/docs/getNotificationsChannelSubscriptions-example.txt create mode 100644 build/docs/getNotificationsChannels-example.txt create mode 100644 build/docs/getOauthAuthorization-example.txt create mode 100644 build/docs/getOauthAuthorizations-example.txt create mode 100644 build/docs/getOauthClient-example.txt create mode 100644 build/docs/getOauthClientUsageQueryResult-example.txt create mode 100644 build/docs/getOauthClientUsageSummary-example.txt create mode 100644 build/docs/getOauthClients-example.txt create mode 100644 build/docs/getOauthScope-example.txt create mode 100644 build/docs/getOauthScopes-example.txt create mode 100644 build/docs/getOrganizationsAuthenticationSettings-example.txt create mode 100644 build/docs/getOrganizationsEmbeddedintegration-example.txt create mode 100644 build/docs/getOrganizationsIpaddressauthentication-example.txt create mode 100644 build/docs/getOrganizationsLimitsChangerequest-example.txt create mode 100644 build/docs/getOrganizationsLimitsChangerequests-example.txt create mode 100644 build/docs/getOrganizationsLimitsDocs-example.txt create mode 100644 build/docs/getOrganizationsLimitsNamespace-example.txt create mode 100644 build/docs/getOrganizationsLimitsNamespaceDefaults-example.txt create mode 100644 build/docs/getOrganizationsLimitsNamespaces-example.txt create mode 100644 build/docs/getOrganizationsMe-example.txt create mode 100644 build/docs/getOrganizationsWhitelist-example.txt create mode 100644 build/docs/getOrgauthorizationPairing-example.txt create mode 100644 build/docs/getOrgauthorizationTrustee-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeClonedusers-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeGroup-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeGroupRoles-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeGroups-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeUser-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeUserRoles-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteeUsers-example.txt create mode 100644 build/docs/getOrgauthorizationTrustees-example.txt create mode 100644 build/docs/getOrgauthorizationTrusteesDefault-example.txt create mode 100644 build/docs/getOrgauthorizationTrustor-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorCloneduser-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorClonedusers-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorGroup-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorGroups-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorUser-example.txt create mode 100644 build/docs/getOrgauthorizationTrustorUsers-example.txt create mode 100644 build/docs/getOrgauthorizationTrustors-example.txt create mode 100644 build/docs/getOrphanrecording-example.txt create mode 100644 build/docs/getOrphanrecordingMedia-example.txt create mode 100644 build/docs/getOrphanrecordings-example.txt create mode 100644 build/docs/getOutboundAttemptlimit-example.txt create mode 100644 build/docs/getOutboundAttemptlimits-example.txt create mode 100644 build/docs/getOutboundCallabletimeset-example.txt create mode 100644 build/docs/getOutboundCallabletimesets-example.txt create mode 100644 build/docs/getOutboundCallanalysisresponseset-example.txt create mode 100644 build/docs/getOutboundCallanalysisresponsesets-example.txt create mode 100644 build/docs/getOutboundCampaign-example.txt create mode 100644 build/docs/getOutboundCampaignAgentownedmappingpreviewResults-example.txt create mode 100644 build/docs/getOutboundCampaignDiagnostics-example.txt create mode 100644 build/docs/getOutboundCampaignInteractions-example.txt create mode 100644 build/docs/getOutboundCampaignProgress-example.txt create mode 100644 build/docs/getOutboundCampaignStats-example.txt create mode 100644 build/docs/getOutboundCampaignrule-example.txt create mode 100644 build/docs/getOutboundCampaignrules-example.txt create mode 100644 build/docs/getOutboundCampaigns-example.txt create mode 100644 build/docs/getOutboundCampaignsAll-example.txt create mode 100644 build/docs/getOutboundCampaignsAllDivisionviews-example.txt create mode 100644 build/docs/getOutboundCampaignsDivisionview-example.txt create mode 100644 build/docs/getOutboundCampaignsDivisionviews-example.txt create mode 100644 build/docs/getOutboundContactlist-example.txt create mode 100644 build/docs/getOutboundContactlistContact-example.txt create mode 100644 build/docs/getOutboundContactlistExport-example.txt create mode 100644 build/docs/getOutboundContactlistImportstatus-example.txt create mode 100644 build/docs/getOutboundContactlistTimezonemappingpreview-example.txt create mode 100644 build/docs/getOutboundContactlistfilter-example.txt create mode 100644 build/docs/getOutboundContactlistfilters-example.txt create mode 100644 build/docs/getOutboundContactlists-example.txt create mode 100644 build/docs/getOutboundContactlistsDivisionview-example.txt create mode 100644 build/docs/getOutboundContactlistsDivisionviews-example.txt create mode 100644 build/docs/getOutboundDigitalruleset-example.txt create mode 100644 build/docs/getOutboundDigitalrulesets-example.txt create mode 100644 build/docs/getOutboundDnclist-example.txt create mode 100644 build/docs/getOutboundDnclistExport-example.txt create mode 100644 build/docs/getOutboundDnclistImportstatus-example.txt create mode 100644 build/docs/getOutboundDnclists-example.txt create mode 100644 build/docs/getOutboundDnclistsDivisionview-example.txt create mode 100644 build/docs/getOutboundDnclistsDivisionviews-example.txt create mode 100644 build/docs/getOutboundEvent-example.txt create mode 100644 build/docs/getOutboundEvents-example.txt create mode 100644 build/docs/getOutboundMessagingcampaign-example.txt create mode 100644 build/docs/getOutboundMessagingcampaignDiagnostics-example.txt create mode 100644 build/docs/getOutboundMessagingcampaignProgress-example.txt create mode 100644 build/docs/getOutboundMessagingcampaigns-example.txt create mode 100644 build/docs/getOutboundMessagingcampaignsDivisionview-example.txt create mode 100644 build/docs/getOutboundMessagingcampaignsDivisionviews-example.txt create mode 100644 build/docs/getOutboundRuleset-example.txt create mode 100644 build/docs/getOutboundRulesets-example.txt create mode 100644 build/docs/getOutboundSchedulesCampaign-example.txt create mode 100644 build/docs/getOutboundSchedulesCampaigns-example.txt create mode 100644 build/docs/getOutboundSchedulesEmailcampaign-example.txt create mode 100644 build/docs/getOutboundSchedulesEmailcampaigns-example.txt create mode 100644 build/docs/getOutboundSchedulesMessagingcampaign-example.txt create mode 100644 build/docs/getOutboundSchedulesMessagingcampaigns-example.txt create mode 100644 build/docs/getOutboundSchedulesSequence-example.txt create mode 100644 build/docs/getOutboundSchedulesSequences-example.txt create mode 100644 build/docs/getOutboundSequence-example.txt create mode 100644 build/docs/getOutboundSequences-example.txt create mode 100644 build/docs/getOutboundSettings-example.txt create mode 100644 build/docs/getOutboundWrapupcodemappings-example.txt create mode 100644 build/docs/getPresenceSettings-example.txt create mode 100644 build/docs/getPresenceSource-example.txt create mode 100644 build/docs/getPresenceSources-example.txt create mode 100644 build/docs/getPresenceUserPrimarysource-example.txt create mode 100644 build/docs/getPresencedefinition-example.txt create mode 100644 build/docs/getPresencedefinitions-example.txt create mode 100644 build/docs/getProcessautomationTrigger-example.txt create mode 100644 build/docs/getProcessautomationTriggers-example.txt create mode 100644 build/docs/getProcessautomationTriggersTopics-example.txt create mode 100644 build/docs/getProfilesGroups-example.txt create mode 100644 build/docs/getProfilesUsers-example.txt create mode 100644 build/docs/getQualityAgentsActivity-example.txt create mode 100644 build/docs/getQualityCalibration-example.txt create mode 100644 build/docs/getQualityCalibrations-example.txt create mode 100644 build/docs/getQualityConversationEvaluation-example.txt create mode 100644 build/docs/getQualityConversationSurveys-example.txt create mode 100644 build/docs/getQualityConversationsAuditsQueryTransactionId-example.txt create mode 100644 build/docs/getQualityConversationsAuditsQueryTransactionIdResults-example.txt create mode 100644 build/docs/getQualityEvaluationsQuery-example.txt create mode 100644 build/docs/getQualityEvaluatorsActivity-example.txt create mode 100644 build/docs/getQualityForm-example.txt create mode 100644 build/docs/getQualityFormVersions-example.txt create mode 100644 build/docs/getQualityForms-example.txt create mode 100644 build/docs/getQualityFormsEvaluation-example.txt create mode 100644 build/docs/getQualityFormsEvaluationVersions-example.txt create mode 100644 build/docs/getQualityFormsEvaluations-example.txt create mode 100644 build/docs/getQualityFormsEvaluationsBulkContexts-example.txt create mode 100644 build/docs/getQualityFormsSurvey-example.txt create mode 100644 build/docs/getQualityFormsSurveyVersions-example.txt create mode 100644 build/docs/getQualityFormsSurveys-example.txt create mode 100644 build/docs/getQualityFormsSurveysBulk-example.txt create mode 100644 build/docs/getQualityFormsSurveysBulkContexts-example.txt create mode 100644 build/docs/getQualityPublishedform-example.txt create mode 100644 build/docs/getQualityPublishedforms-example.txt create mode 100644 build/docs/getQualityPublishedformsEvaluation-example.txt create mode 100644 build/docs/getQualityPublishedformsEvaluations-example.txt create mode 100644 build/docs/getQualityPublishedformsSurvey-example.txt create mode 100644 build/docs/getQualityPublishedformsSurveys-example.txt create mode 100644 build/docs/getQualitySurvey-example.txt create mode 100644 build/docs/getQualitySurveysScorable-example.txt create mode 100644 build/docs/getRecordingBatchrequest-example.txt create mode 100644 build/docs/getRecordingCrossplatformMediaretentionpolicies-example.txt create mode 100644 build/docs/getRecordingCrossplatformMediaretentionpolicy-example.txt create mode 100644 build/docs/getRecordingJob-example.txt create mode 100644 build/docs/getRecordingJobFailedrecordings-example.txt create mode 100644 build/docs/getRecordingJobs-example.txt create mode 100644 build/docs/getRecordingKeyconfiguration-example.txt create mode 100644 build/docs/getRecordingKeyconfigurations-example.txt create mode 100644 build/docs/getRecordingMediaretentionpolicies-example.txt create mode 100644 build/docs/getRecordingMediaretentionpolicy-example.txt create mode 100644 build/docs/getRecordingRecordingkeys-example.txt create mode 100644 build/docs/getRecordingRecordingkeysRotationschedule-example.txt create mode 100644 build/docs/getRecordingSettings-example.txt create mode 100644 build/docs/getRecordingUploadsReport-example.txt create mode 100644 build/docs/getRecordingsRetentionQuery-example.txt create mode 100644 build/docs/getRecordingsScreensessions-example.txt create mode 100644 build/docs/getResponsemanagementLibraries-example.txt create mode 100644 build/docs/getResponsemanagementLibrary-example.txt create mode 100644 build/docs/getResponsemanagementResponse-example.txt create mode 100644 build/docs/getResponsemanagementResponseasset-example.txt create mode 100644 build/docs/getResponsemanagementResponseassetsStatusStatusId-example.txt create mode 100644 build/docs/getResponsemanagementResponses-example.txt create mode 100644 build/docs/getRoutingAssessment-example.txt create mode 100644 build/docs/getRoutingAssessments-example.txt create mode 100644 build/docs/getRoutingAssessmentsJob-example.txt create mode 100644 build/docs/getRoutingAssessmentsJobs-example.txt create mode 100644 build/docs/getRoutingAvailablemediatypes-example.txt create mode 100644 build/docs/getRoutingEmailDomain-example.txt create mode 100644 build/docs/getRoutingEmailDomainRoute-example.txt create mode 100644 build/docs/getRoutingEmailDomainRoutes-example.txt create mode 100644 build/docs/getRoutingEmailDomains-example.txt create mode 100644 build/docs/getRoutingEmailOutboundDomain-example.txt create mode 100644 build/docs/getRoutingEmailOutboundDomainActivation-example.txt create mode 100644 build/docs/getRoutingEmailOutboundDomainSearch-example.txt create mode 100644 build/docs/getRoutingEmailOutboundDomains-example.txt create mode 100644 build/docs/getRoutingEmailSetup-example.txt create mode 100644 build/docs/getRoutingLanguage-example.txt create mode 100644 build/docs/getRoutingLanguages-example.txt create mode 100644 build/docs/getRoutingMessageRecipient-example.txt create mode 100644 build/docs/getRoutingMessageRecipients-example.txt create mode 100644 build/docs/getRoutingPredictor-example.txt create mode 100644 build/docs/getRoutingPredictorModelFeatures-example.txt create mode 100644 build/docs/getRoutingPredictorModels-example.txt create mode 100644 build/docs/getRoutingPredictors-example.txt create mode 100644 build/docs/getRoutingPredictorsKeyperformanceindicators-example.txt create mode 100644 build/docs/getRoutingQueue-example.txt create mode 100644 build/docs/getRoutingQueueComparisonperiod-example.txt create mode 100644 build/docs/getRoutingQueueComparisonperiods-example.txt create mode 100644 build/docs/getRoutingQueueEstimatedwaittime-example.txt create mode 100644 build/docs/getRoutingQueueMediatypeEstimatedwaittime-example.txt create mode 100644 build/docs/getRoutingQueueMembers-example.txt create mode 100644 build/docs/getRoutingQueueUsers-example.txt create mode 100644 build/docs/getRoutingQueueWrapupcodes-example.txt create mode 100644 build/docs/getRoutingQueues-example.txt create mode 100644 build/docs/getRoutingQueuesDivisionviews-example.txt create mode 100644 build/docs/getRoutingQueuesDivisionviewsAll-example.txt create mode 100644 build/docs/getRoutingQueuesMe-example.txt create mode 100644 build/docs/getRoutingSettings-example.txt create mode 100644 build/docs/getRoutingSettingsContactcenter-example.txt create mode 100644 build/docs/getRoutingSettingsTranscription-example.txt create mode 100644 build/docs/getRoutingSkill-example.txt create mode 100644 build/docs/getRoutingSkillgroup-example.txt create mode 100644 build/docs/getRoutingSkillgroupMembers-example.txt create mode 100644 build/docs/getRoutingSkillgroupMembersDivisions-example.txt create mode 100644 build/docs/getRoutingSkillgroups-example.txt create mode 100644 build/docs/getRoutingSkills-example.txt create mode 100644 build/docs/getRoutingSmsAddress-example.txt create mode 100644 build/docs/getRoutingSmsAddresses-example.txt create mode 100644 build/docs/getRoutingSmsAvailablephonenumbers-example.txt create mode 100644 build/docs/getRoutingSmsPhonenumber-example.txt create mode 100644 build/docs/getRoutingSmsPhonenumbers-example.txt create mode 100644 build/docs/getRoutingUserUtilization-example.txt create mode 100644 build/docs/getRoutingUtilization-example.txt create mode 100644 build/docs/getRoutingWrapupcode-example.txt create mode 100644 build/docs/getRoutingWrapupcodes-example.txt create mode 100644 build/docs/getScimGroup-example.txt create mode 100644 build/docs/getScimGroups-example.txt create mode 100644 build/docs/getScimResourcetype-example.txt create mode 100644 build/docs/getScimResourcetypes-example.txt create mode 100644 build/docs/getScimSchema-example.txt create mode 100644 build/docs/getScimSchemas-example.txt create mode 100644 build/docs/getScimServiceproviderconfig-example.txt create mode 100644 build/docs/getScimUser-example.txt create mode 100644 build/docs/getScimUsers-example.txt create mode 100644 build/docs/getScimV2Group-example.txt create mode 100644 build/docs/getScimV2Groups-example.txt create mode 100644 build/docs/getScimV2Resourcetype-example.txt create mode 100644 build/docs/getScimV2Resourcetypes-example.txt create mode 100644 build/docs/getScimV2Schema-example.txt create mode 100644 build/docs/getScimV2Schemas-example.txt create mode 100644 build/docs/getScimV2Serviceproviderconfig-example.txt create mode 100644 build/docs/getScimV2User-example.txt create mode 100644 build/docs/getScimV2Users-example.txt create mode 100644 build/docs/getScript-example.txt create mode 100644 build/docs/getScriptPage-example.txt create mode 100644 build/docs/getScriptPages-example.txt create mode 100644 build/docs/getScripts-example.txt create mode 100644 build/docs/getScriptsDivisionviews-example.txt create mode 100644 build/docs/getScriptsPublished-example.txt create mode 100644 build/docs/getScriptsPublishedDivisionviews-example.txt create mode 100644 build/docs/getScriptsPublishedScriptId-example.txt create mode 100644 build/docs/getScriptsPublishedScriptIdPage-example.txt create mode 100644 build/docs/getScriptsPublishedScriptIdPages-example.txt create mode 100644 build/docs/getScriptsPublishedScriptIdVariables-example.txt create mode 100644 build/docs/getScriptsUploadStatus-example.txt create mode 100644 build/docs/getSearch-example.txt create mode 100644 build/docs/getSearchSuggest-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsConversation-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturl-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturls-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsDictionaryfeedback-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgram-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramMappings-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramTranscriptionengines-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsPrograms-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramsGeneralJob-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramsMappings-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramsPublishjob-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramsTranscriptionenginesDialects-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsProgramsUnpublished-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsSentimentDialects-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsSentimentfeedback-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsSettings-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopic-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopics-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopicsDialects-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopicsGeneral-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopicsGeneralStatus-example.txt create mode 100644 build/docs/getSpeechandtextanalyticsTopicsPublishjob-example.txt create mode 100644 build/docs/getStation-example.txt create mode 100644 build/docs/getStations-example.txt create mode 100644 build/docs/getSystempresences-example.txt create mode 100644 build/docs/getTeam-example.txt create mode 100644 build/docs/getTeamMembers-example.txt create mode 100644 build/docs/getTeams-example.txt create mode 100644 build/docs/getTelephonyMediaregions-example.txt create mode 100644 build/docs/getTelephonyProvidersEdge-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeDiagnosticNslookup-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeDiagnosticPing-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeDiagnosticRoute-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeDiagnosticTracepath-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeLogicalinterface-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeLogicalinterfaces-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeLogsJob-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeMetrics-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgePhysicalinterface-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgePhysicalinterfaces-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeSetuppackage-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeSoftwareupdate-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeSoftwareversions-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgeTrunks-example.txt create mode 100644 build/docs/getTelephonyProvidersEdges-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesAvailablelanguages-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesCertificateauthorities-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesCertificateauthority-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesDid-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesDidpool-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesDidpools-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesDidpoolsDids-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesDids-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesEdgegroup-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesEdgegroups-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesEdgeversionreport-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesExpired-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesExtension-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesExtensionpool-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesExtensionpools-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesExtensions-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLine-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLinebasesetting-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLinebasesettings-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLines-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLinesTemplate-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesLogicalinterfaces-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesMetrics-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesOutboundroute-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesOutboundroutes-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhone-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhonebasesetting-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhonebasesettings-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhonebasesettingsTemplate-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhones-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhonesTemplate-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesPhysicalinterfaces-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSite-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSiteNumberplan-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSiteNumberplans-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSiteNumberplansClassifications-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSiteOutboundroute-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSiteOutboundroutes-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesSites-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTimezones-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunk-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkMetrics-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkbasesetting-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkbasesettings-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkbasesettingsTemplate-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunks-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunksMetrics-example.txt create mode 100644 build/docs/getTelephonyProvidersEdgesTrunkswithrecording-example.txt create mode 100644 build/docs/getTelephonySiptraces-example.txt create mode 100644 build/docs/getTelephonySiptracesDownloadDownloadId-example.txt create mode 100644 build/docs/getTextbotsBotsSearch-example.txt create mode 100644 build/docs/getTimezones-example.txt create mode 100644 build/docs/getTokensMe-example.txt create mode 100644 build/docs/getUsageQueryExecutionIdResults-example.txt create mode 100644 build/docs/getUsageSimplesearchExecutionIdResults-example.txt create mode 100644 build/docs/getUser-example.txt create mode 100644 build/docs/getUserAdjacents-example.txt create mode 100644 build/docs/getUserCallforwarding-example.txt create mode 100644 build/docs/getUserDirectreports-example.txt create mode 100644 build/docs/getUserFavorites-example.txt create mode 100644 build/docs/getUserGeolocation-example.txt create mode 100644 build/docs/getUserGreetings-example.txt create mode 100644 build/docs/getUserGreetingsDefaults-example.txt create mode 100644 build/docs/getUserOutofoffice-example.txt create mode 100644 build/docs/getUserPresence-example.txt create mode 100644 build/docs/getUserPresencesPurecloud-example.txt create mode 100644 build/docs/getUserProfile-example.txt create mode 100644 build/docs/getUserProfileskills-example.txt create mode 100644 build/docs/getUserQueues-example.txt create mode 100644 build/docs/getUserRoles-example.txt create mode 100644 build/docs/getUserRoutinglanguages-example.txt create mode 100644 build/docs/getUserRoutingskills-example.txt create mode 100644 build/docs/getUserRoutingstatus-example.txt create mode 100644 build/docs/getUserSkillgroups-example.txt create mode 100644 build/docs/getUserState-example.txt create mode 100644 build/docs/getUserStation-example.txt create mode 100644 build/docs/getUserSuperiors-example.txt create mode 100644 build/docs/getUserTrustors-example.txt create mode 100644 build/docs/getUserrecording-example.txt create mode 100644 build/docs/getUserrecordingMedia-example.txt create mode 100644 build/docs/getUserrecordings-example.txt create mode 100644 build/docs/getUserrecordingsSummary-example.txt create mode 100644 build/docs/getUsers-example.txt create mode 100644 build/docs/getUsersDevelopmentActivities-example.txt create mode 100644 build/docs/getUsersDevelopmentActivitiesMe-example.txt create mode 100644 build/docs/getUsersDevelopmentActivity-example.txt create mode 100644 build/docs/getUsersMe-example.txt create mode 100644 build/docs/getUsersPresenceBulk-example.txt create mode 100644 build/docs/getUsersPresencesPurecloudBulk-example.txt create mode 100644 build/docs/getUsersSearch-example.txt create mode 100644 build/docs/getVoicemailGroupMailbox-example.txt create mode 100644 build/docs/getVoicemailGroupMessages-example.txt create mode 100644 build/docs/getVoicemailGroupPolicy-example.txt create mode 100644 build/docs/getVoicemailMailbox-example.txt create mode 100644 build/docs/getVoicemailMeMailbox-example.txt create mode 100644 build/docs/getVoicemailMeMessages-example.txt create mode 100644 build/docs/getVoicemailMePolicy-example.txt create mode 100644 build/docs/getVoicemailMessage-example.txt create mode 100644 build/docs/getVoicemailMessageMedia-example.txt create mode 100644 build/docs/getVoicemailMessages-example.txt create mode 100644 build/docs/getVoicemailPolicy-example.txt create mode 100644 build/docs/getVoicemailQueueMessages-example.txt create mode 100644 build/docs/getVoicemailSearch-example.txt create mode 100644 build/docs/getVoicemailUserpolicy-example.txt create mode 100644 build/docs/getWebchatDeployment-example.txt create mode 100644 build/docs/getWebchatDeployments-example.txt create mode 100644 build/docs/getWebchatGuestConversationMediarequest-example.txt create mode 100644 build/docs/getWebchatGuestConversationMediarequests-example.txt create mode 100644 build/docs/getWebchatGuestConversationMember-example.txt create mode 100644 build/docs/getWebchatGuestConversationMembers-example.txt create mode 100644 build/docs/getWebchatGuestConversationMessage-example.txt create mode 100644 build/docs/getWebchatGuestConversationMessages-example.txt create mode 100644 build/docs/getWebchatSettings-example.txt create mode 100644 build/docs/getWebdeploymentsConfigurationVersion-example.txt create mode 100644 build/docs/getWebdeploymentsConfigurationVersions-example.txt create mode 100644 build/docs/getWebdeploymentsConfigurationVersionsDraft-example.txt create mode 100644 build/docs/getWebdeploymentsConfigurations-example.txt create mode 100644 build/docs/getWebdeploymentsDeployment-example.txt create mode 100644 build/docs/getWebdeploymentsDeploymentCobrowseSessionId-example.txt create mode 100644 build/docs/getWebdeploymentsDeploymentConfigurations-example.txt create mode 100644 build/docs/getWebdeploymentsDeployments-example.txt create mode 100644 build/docs/getWebmessagingMessages-example.txt create mode 100644 build/docs/getWidgetsDeployment-example.txt create mode 100644 build/docs/getWidgetsDeployments-example.txt create mode 100644 build/docs/getWorkforcemanagementAdherence-example.txt create mode 100644 build/docs/getWorkforcemanagementAdherenceExplanation-example.txt create mode 100644 build/docs/getWorkforcemanagementAdherenceExplanationsJob-example.txt create mode 100644 build/docs/getWorkforcemanagementAdherenceHistoricalBulkJob-example.txt create mode 100644 build/docs/getWorkforcemanagementAdherenceHistoricalJob-example.txt create mode 100644 build/docs/getWorkforcemanagementAdhocmodelingjob-example.txt create mode 100644 build/docs/getWorkforcemanagementAgentAdherenceExplanation-example.txt create mode 100644 build/docs/getWorkforcemanagementAgentManagementunit-example.txt create mode 100644 build/docs/getWorkforcemanagementAgentsMeManagementunit-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunit-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitActivitycode-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitActivitycodes-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitIntradayPlanninggroups-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitManagementunits-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitPlanninggroup-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitPlanninggroups-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitSchedulingRun-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitSchedulingRunResult-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitSchedulingRuns-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitServicegoaltemplate-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitServicegoaltemplates-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekSchedule-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekScheduleGenerationresults-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekSchedules-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastData-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecasts-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunits-example.txt create mode 100644 build/docs/getWorkforcemanagementBusinessunitsDivisionviews-example.txt create mode 100644 build/docs/getWorkforcemanagementCalendarDataIcs-example.txt create mode 100644 build/docs/getWorkforcemanagementCalendarUrlIcs-example.txt create mode 100644 build/docs/getWorkforcemanagementHistoricaldataDeletejob-example.txt create mode 100644 build/docs/getWorkforcemanagementHistoricaldataImportstatus-example.txt create mode 100644 build/docs/getWorkforcemanagementIntegrationsHris-example.txt create mode 100644 build/docs/getWorkforcemanagementIntegrationsHrisTimeofftypesJob-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunit-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitActivitycodes-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitAdherence-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitAgent-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitAgentShifttrades-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitShifttradesMatched-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitShifttradesUsers-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitTimeofflimit-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitTimeofflimits-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitTimeoffplan-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitTimeoffplans-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitUserTimeoffrequest-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitUserTimeoffrequests-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitUsers-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWeekSchedule-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWeekSchedules-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWeekShifttrades-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWorkplan-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWorkplanrotation-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWorkplanrotations-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitWorkplans-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunits-example.txt create mode 100644 build/docs/getWorkforcemanagementManagementunitsDivisionviews-example.txt create mode 100644 build/docs/getWorkforcemanagementNotifications-example.txt create mode 100644 build/docs/getWorkforcemanagementSchedulingjob-example.txt create mode 100644 build/docs/getWorkforcemanagementShifttrades-example.txt create mode 100644 build/docs/getWorkforcemanagementShrinkageJob-example.txt create mode 100644 build/docs/getWorkforcemanagementTimeoffbalanceJob-example.txt create mode 100644 build/docs/getWorkforcemanagementTimeoffrequest-example.txt create mode 100644 build/docs/getWorkforcemanagementTimeoffrequestWaitlistpositions-example.txt create mode 100644 build/docs/getWorkforcemanagementTimeoffrequests-example.txt create mode 100644 build/docs/headNotificationsChannel-example.txt create mode 100644 build/docs/headTokensMe-example.txt create mode 100644 build/docs/patchAlertingAlert-example.txt create mode 100644 build/docs/patchAlertingAlertsBulk-example.txt create mode 100644 build/docs/patchAlertingRulesBulk-example.txt create mode 100644 build/docs/patchAnalyticsReportingSettings-example.txt create mode 100644 build/docs/patchAuthorizationRole-example.txt create mode 100644 build/docs/patchAuthorizationSettings-example.txt create mode 100644 build/docs/patchChatSettings-example.txt create mode 100644 build/docs/patchChatsSettings-example.txt create mode 100644 build/docs/patchCoachingAppointment-example.txt create mode 100644 build/docs/patchCoachingAppointmentAnnotation-example.txt create mode 100644 build/docs/patchCoachingAppointmentStatus-example.txt create mode 100644 build/docs/patchCoachingNotification-example.txt create mode 100644 build/docs/patchConversationParticipant-example.txt create mode 100644 build/docs/patchConversationParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationSecureattributes-example.txt create mode 100644 build/docs/patchConversationsAftercallworkConversationIdParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsCall-example.txt create mode 100644 build/docs/patchConversationsCallParticipant-example.txt create mode 100644 build/docs/patchConversationsCallParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsCallParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsCallParticipantConsult-example.txt create mode 100644 build/docs/patchConversationsCallback-example.txt create mode 100644 build/docs/patchConversationsCallbackParticipant-example.txt create mode 100644 build/docs/patchConversationsCallbackParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsCallbackParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsCallbacks-example.txt create mode 100644 build/docs/patchConversationsChat-example.txt create mode 100644 build/docs/patchConversationsChatParticipant-example.txt create mode 100644 build/docs/patchConversationsChatParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsChatParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsCobrowsesession-example.txt create mode 100644 build/docs/patchConversationsCobrowsesessionParticipant-example.txt create mode 100644 build/docs/patchConversationsCobrowsesessionParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsCobrowsesessionParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsEmail-example.txt create mode 100644 build/docs/patchConversationsEmailMessagesDraft-example.txt create mode 100644 build/docs/patchConversationsEmailParticipant-example.txt create mode 100644 build/docs/patchConversationsEmailParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsEmailParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsMessage-example.txt create mode 100644 build/docs/patchConversationsMessageParticipant-example.txt create mode 100644 build/docs/patchConversationsMessageParticipantAttributes-example.txt create mode 100644 build/docs/patchConversationsMessageParticipantCommunication-example.txt create mode 100644 build/docs/patchConversationsMessagingIntegrationsFacebookIntegrationId-example.txt create mode 100644 build/docs/patchConversationsMessagingIntegrationsInstagramIntegrationId-example.txt create mode 100644 build/docs/patchConversationsMessagingIntegrationsOpenIntegrationId-example.txt create mode 100644 build/docs/patchConversationsMessagingIntegrationsTwitterIntegrationId-example.txt create mode 100644 build/docs/patchConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt create mode 100644 build/docs/patchConversationsMessagingSetting-example.txt create mode 100644 build/docs/patchConversationsMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/patchConversationsSettings-example.txt create mode 100644 build/docs/patchEmailsSettings-example.txt create mode 100644 build/docs/patchEmployeeperformanceExternalmetricsDefinition-example.txt create mode 100644 build/docs/patchExternalcontactsContactIdentifiers-example.txt create mode 100644 build/docs/patchGeolocationsSettings-example.txt create mode 100644 build/docs/patchIntegration-example.txt create mode 100644 build/docs/patchIntegrationsAction-example.txt create mode 100644 build/docs/patchIntegrationsActionDraft-example.txt create mode 100644 build/docs/patchJourneyActionmap-example.txt create mode 100644 build/docs/patchJourneyActiontarget-example.txt create mode 100644 build/docs/patchJourneyActiontemplate-example.txt create mode 100644 build/docs/patchJourneyOutcome-example.txt create mode 100644 build/docs/patchJourneySegment-example.txt create mode 100644 build/docs/patchKnowledgeGuestSessionDocumentsSearchSearchId-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebase-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseCategory-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseDocument-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseDocumentVariation-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseDocumentsSearchSearchId-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseImportJob-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseLabel-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseLanguageCategory-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseLanguageDocument-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseLanguageDocuments-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt create mode 100644 build/docs/patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt create mode 100644 build/docs/patchLanguageunderstandingDomain-example.txt create mode 100644 build/docs/patchLanguageunderstandingMinerDraft-example.txt create mode 100644 build/docs/patchLearningAssignment-example.txt create mode 100644 build/docs/patchLearningAssignmentReschedule-example.txt create mode 100644 build/docs/patchLocation-example.txt create mode 100644 build/docs/patchMessagingSetting-example.txt create mode 100644 build/docs/patchMessagingSupportedcontentSupportedContentId-example.txt create mode 100644 build/docs/patchOrganizationsAuthenticationSettings-example.txt create mode 100644 build/docs/patchOrganizationsFeature-example.txt create mode 100644 build/docs/patchOutboundDnclistCustomexclusioncolumns-example.txt create mode 100644 build/docs/patchOutboundDnclistEmailaddresses-example.txt create mode 100644 build/docs/patchOutboundDnclistPhonenumbers-example.txt create mode 100644 build/docs/patchOutboundSettings-example.txt create mode 100644 build/docs/patchQualityFormsSurvey-example.txt create mode 100644 build/docs/patchRecordingCrossplatformMediaretentionpolicy-example.txt create mode 100644 build/docs/patchRecordingMediaretentionpolicy-example.txt create mode 100644 build/docs/patchRecordingsScreensession-example.txt create mode 100644 build/docs/patchRoutingConversation-example.txt create mode 100644 build/docs/patchRoutingEmailDomain-example.txt create mode 100644 build/docs/patchRoutingEmailDomainValidate-example.txt create mode 100644 build/docs/patchRoutingPredictor-example.txt create mode 100644 build/docs/patchRoutingQueueMember-example.txt create mode 100644 build/docs/patchRoutingQueueMembers-example.txt create mode 100644 build/docs/patchRoutingQueueUser-example.txt create mode 100644 build/docs/patchRoutingQueueUsers-example.txt create mode 100644 build/docs/patchRoutingSettingsContactcenter-example.txt create mode 100644 build/docs/patchRoutingSkillgroup-example.txt create mode 100644 build/docs/patchScimGroup-example.txt create mode 100644 build/docs/patchScimUser-example.txt create mode 100644 build/docs/patchScimV2Group-example.txt create mode 100644 build/docs/patchScimV2User-example.txt create mode 100644 build/docs/patchSpeechandtextanalyticsSettings-example.txt create mode 100644 build/docs/patchTeam-example.txt create mode 100644 build/docs/patchUser-example.txt create mode 100644 build/docs/patchUserCallforwarding-example.txt create mode 100644 build/docs/patchUserGeolocation-example.txt create mode 100644 build/docs/patchUserPresence-example.txt create mode 100644 build/docs/patchUserPresencesPurecloud-example.txt create mode 100644 build/docs/patchUserQueue-example.txt create mode 100644 build/docs/patchUserQueues-example.txt create mode 100644 build/docs/patchUserRoutinglanguage-example.txt create mode 100644 build/docs/patchUserRoutinglanguagesBulk-example.txt create mode 100644 build/docs/patchUserRoutingskillsBulk-example.txt create mode 100644 build/docs/patchUsersBulk-example.txt create mode 100644 build/docs/patchVoicemailGroupPolicy-example.txt create mode 100644 build/docs/patchVoicemailMePolicy-example.txt create mode 100644 build/docs/patchVoicemailMessage-example.txt create mode 100644 build/docs/patchVoicemailUserpolicy-example.txt create mode 100644 build/docs/patchWebchatGuestConversationMediarequest-example.txt create mode 100644 build/docs/patchWorkforcemanagementAgentAdherenceExplanation-example.txt create mode 100644 build/docs/patchWorkforcemanagementBusinessunit-example.txt create mode 100644 build/docs/patchWorkforcemanagementBusinessunitActivitycode-example.txt create mode 100644 build/docs/patchWorkforcemanagementBusinessunitPlanninggroup-example.txt create mode 100644 build/docs/patchWorkforcemanagementBusinessunitSchedulingRun-example.txt create mode 100644 build/docs/patchWorkforcemanagementBusinessunitServicegoaltemplate-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunit-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitTimeofflimit-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitTimeoffplan-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitUserTimeoffrequest-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitWeekShifttrade-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitWorkplan-example.txt create mode 100644 build/docs/patchWorkforcemanagementManagementunitWorkplanrotation-example.txt create mode 100644 build/docs/patchWorkforcemanagementTimeoffrequest-example.txt create mode 100644 build/docs/postAlertingAlertsQuery-example.txt create mode 100644 build/docs/postAlertingInteractionstatsRules-example.txt create mode 100644 build/docs/postAlertingRules-example.txt create mode 100644 build/docs/postAlertingRulesBulkRemove-example.txt create mode 100644 build/docs/postAlertingRulesQuery-example.txt create mode 100644 build/docs/postAnalyticsActionsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsBotsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsConversationDetailsProperties-example.txt create mode 100644 build/docs/postAnalyticsConversationsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsConversationsDetailsJobs-example.txt create mode 100644 build/docs/postAnalyticsConversationsDetailsQuery-example.txt create mode 100644 build/docs/postAnalyticsConversationsTranscriptsQuery-example.txt create mode 100644 build/docs/postAnalyticsEvaluationsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsFlowsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsFlowsObservationsQuery-example.txt create mode 100644 build/docs/postAnalyticsJourneysAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsQueuesObservationsQuery-example.txt create mode 100644 build/docs/postAnalyticsReportingExports-example.txt create mode 100644 build/docs/postAnalyticsReportingScheduleRunreport-example.txt create mode 100644 build/docs/postAnalyticsReportingSchedules-example.txt create mode 100644 build/docs/postAnalyticsSurveysAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsTranscriptsAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsUsersAggregatesQuery-example.txt create mode 100644 build/docs/postAnalyticsUsersDetailsJobs-example.txt create mode 100644 build/docs/postAnalyticsUsersDetailsQuery-example.txt create mode 100644 build/docs/postAnalyticsUsersObservationsQuery-example.txt create mode 100644 build/docs/postArchitectDependencytrackingBuild-example.txt create mode 100644 build/docs/postArchitectEmergencygroups-example.txt create mode 100644 build/docs/postArchitectIvrs-example.txt create mode 100644 build/docs/postArchitectPromptHistory-example.txt create mode 100644 build/docs/postArchitectPromptResources-example.txt create mode 100644 build/docs/postArchitectPrompts-example.txt create mode 100644 build/docs/postArchitectSchedulegroups-example.txt create mode 100644 build/docs/postArchitectSchedules-example.txt create mode 100644 build/docs/postArchitectSystempromptHistory-example.txt create mode 100644 build/docs/postArchitectSystempromptResources-example.txt create mode 100644 build/docs/postAuditsQuery-example.txt create mode 100644 build/docs/postAuditsQueryRealtime-example.txt create mode 100644 build/docs/postAuthorizationDivisionObject-example.txt create mode 100644 build/docs/postAuthorizationDivisionRestore-example.txt create mode 100644 build/docs/postAuthorizationDivisions-example.txt create mode 100644 build/docs/postAuthorizationRole-example.txt create mode 100644 build/docs/postAuthorizationRoleComparedefaultRightRoleId-example.txt create mode 100644 build/docs/postAuthorizationRoles-example.txt create mode 100644 build/docs/postAuthorizationRolesDefault-example.txt create mode 100644 build/docs/postAuthorizationSubjectBulkadd-example.txt create mode 100644 build/docs/postAuthorizationSubjectBulkremove-example.txt create mode 100644 build/docs/postAuthorizationSubjectBulkreplace-example.txt create mode 100644 build/docs/postAuthorizationSubjectDivisionRole-example.txt create mode 100644 build/docs/postCarrierservicesIntegrationsEmergencylocationsMe-example.txt create mode 100644 build/docs/postCertificateDetails-example.txt create mode 100644 build/docs/postCoachingAppointmentAnnotations-example.txt create mode 100644 build/docs/postCoachingAppointmentConversations-example.txt create mode 100644 build/docs/postCoachingAppointments-example.txt create mode 100644 build/docs/postCoachingAppointmentsAggregatesQuery-example.txt create mode 100644 build/docs/postCoachingScheduleslotsQuery-example.txt create mode 100644 build/docs/postContentmanagementAuditquery-example.txt create mode 100644 build/docs/postContentmanagementDocument-example.txt create mode 100644 build/docs/postContentmanagementDocumentContent-example.txt create mode 100644 build/docs/postContentmanagementDocuments-example.txt create mode 100644 build/docs/postContentmanagementQuery-example.txt create mode 100644 build/docs/postContentmanagementShares-example.txt create mode 100644 build/docs/postContentmanagementWorkspaceTagvalues-example.txt create mode 100644 build/docs/postContentmanagementWorkspaceTagvaluesQuery-example.txt create mode 100644 build/docs/postContentmanagementWorkspaces-example.txt create mode 100644 build/docs/postConversationAssign-example.txt create mode 100644 build/docs/postConversationCobrowse-example.txt create mode 100644 build/docs/postConversationDisconnect-example.txt create mode 100644 build/docs/postConversationParticipantCallbacks-example.txt create mode 100644 build/docs/postConversationParticipantDigits-example.txt create mode 100644 build/docs/postConversationParticipantReplace-example.txt create mode 100644 build/docs/postConversationParticipantSecureivrsessions-example.txt create mode 100644 build/docs/postConversationRecordingAnnotations-example.txt create mode 100644 build/docs/postConversationsCall-example.txt create mode 100644 build/docs/postConversationsCallParticipantCoach-example.txt create mode 100644 build/docs/postConversationsCallParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsCallParticipantConsult-example.txt create mode 100644 build/docs/postConversationsCallParticipantMonitor-example.txt create mode 100644 build/docs/postConversationsCallParticipantReplace-example.txt create mode 100644 build/docs/postConversationsCallParticipants-example.txt create mode 100644 build/docs/postConversationsCallbackParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsCallbackParticipantReplace-example.txt create mode 100644 build/docs/postConversationsCallbacks-example.txt create mode 100644 build/docs/postConversationsCallbacksBulkDisconnect-example.txt create mode 100644 build/docs/postConversationsCallbacksBulkUpdate-example.txt create mode 100644 build/docs/postConversationsCalls-example.txt create mode 100644 build/docs/postConversationsChatCommunicationMessages-example.txt create mode 100644 build/docs/postConversationsChatCommunicationTyping-example.txt create mode 100644 build/docs/postConversationsChatParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsChatParticipantReplace-example.txt create mode 100644 build/docs/postConversationsChats-example.txt create mode 100644 build/docs/postConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsCobrowsesessionParticipantReplace-example.txt create mode 100644 build/docs/postConversationsEmailInboundmessages-example.txt create mode 100644 build/docs/postConversationsEmailMessages-example.txt create mode 100644 build/docs/postConversationsEmailMessagesDraftAttachmentsCopy-example.txt create mode 100644 build/docs/postConversationsEmailParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsEmailParticipantReplace-example.txt create mode 100644 build/docs/postConversationsEmails-example.txt create mode 100644 build/docs/postConversationsEmailsAgentless-example.txt create mode 100644 build/docs/postConversationsFaxes-example.txt create mode 100644 build/docs/postConversationsKeyconfigurations-example.txt create mode 100644 build/docs/postConversationsKeyconfigurationsValidate-example.txt create mode 100644 build/docs/postConversationsMessageCommunicationMessages-example.txt create mode 100644 build/docs/postConversationsMessageCommunicationMessagesMedia-example.txt create mode 100644 build/docs/postConversationsMessageCommunicationTyping-example.txt create mode 100644 build/docs/postConversationsMessageInboundOpenEvent-example.txt create mode 100644 build/docs/postConversationsMessageInboundOpenMessage-example.txt create mode 100644 build/docs/postConversationsMessageInboundOpenReceipt-example.txt create mode 100644 build/docs/postConversationsMessageMessagesBulk-example.txt create mode 100644 build/docs/postConversationsMessageParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsMessageParticipantReplace-example.txt create mode 100644 build/docs/postConversationsMessages-example.txt create mode 100644 build/docs/postConversationsMessagesAgentless-example.txt create mode 100644 build/docs/postConversationsMessagesInboundOpen-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsFacebook-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsInstagram-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsLine-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsOpen-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsTwitter-example.txt create mode 100644 build/docs/postConversationsMessagingIntegrationsWhatsapp-example.txt create mode 100644 build/docs/postConversationsMessagingSettings-example.txt create mode 100644 build/docs/postConversationsMessagingSupportedcontent-example.txt create mode 100644 build/docs/postConversationsParticipantsAttributesSearch-example.txt create mode 100644 build/docs/postConversationsScreenshareParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsSocialParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postConversationsVideoParticipantCommunicationWrapup-example.txt create mode 100644 build/docs/postDocumentationGknSearch-example.txt create mode 100644 build/docs/postDocumentationSearch-example.txt create mode 100644 build/docs/postEmployeeperformanceExternalmetricsData-example.txt create mode 100644 build/docs/postEmployeeperformanceExternalmetricsDefinitions-example.txt create mode 100644 build/docs/postEventsConversations-example.txt create mode 100644 build/docs/postEventsUsersPresence-example.txt create mode 100644 build/docs/postEventsUsersRoutingstatus-example.txt create mode 100644 build/docs/postExternalcontactsBulkContacts-example.txt create mode 100644 build/docs/postExternalcontactsBulkContactsAdd-example.txt create mode 100644 build/docs/postExternalcontactsBulkContactsRemove-example.txt create mode 100644 build/docs/postExternalcontactsBulkContactsUnresolved-example.txt create mode 100644 build/docs/postExternalcontactsBulkContactsUpdate-example.txt create mode 100644 build/docs/postExternalcontactsBulkNotes-example.txt create mode 100644 build/docs/postExternalcontactsBulkNotesAdd-example.txt create mode 100644 build/docs/postExternalcontactsBulkNotesRemove-example.txt create mode 100644 build/docs/postExternalcontactsBulkNotesUpdate-example.txt create mode 100644 build/docs/postExternalcontactsBulkOrganizations-example.txt create mode 100644 build/docs/postExternalcontactsBulkOrganizationsAdd-example.txt create mode 100644 build/docs/postExternalcontactsBulkOrganizationsRemove-example.txt create mode 100644 build/docs/postExternalcontactsBulkOrganizationsUpdate-example.txt create mode 100644 build/docs/postExternalcontactsBulkRelationships-example.txt create mode 100644 build/docs/postExternalcontactsBulkRelationshipsAdd-example.txt create mode 100644 build/docs/postExternalcontactsBulkRelationshipsRemove-example.txt create mode 100644 build/docs/postExternalcontactsBulkRelationshipsUpdate-example.txt create mode 100644 build/docs/postExternalcontactsContactNotes-example.txt create mode 100644 build/docs/postExternalcontactsContactPromotion-example.txt create mode 100644 build/docs/postExternalcontactsContacts-example.txt create mode 100644 build/docs/postExternalcontactsContactsSchemas-example.txt create mode 100644 build/docs/postExternalcontactsIdentifierlookup-example.txt create mode 100644 build/docs/postExternalcontactsMergeContacts-example.txt create mode 100644 build/docs/postExternalcontactsOrganizationNotes-example.txt create mode 100644 build/docs/postExternalcontactsOrganizations-example.txt create mode 100644 build/docs/postExternalcontactsOrganizationsSchemas-example.txt create mode 100644 build/docs/postExternalcontactsRelationships-example.txt create mode 100644 build/docs/postFlowHistory-example.txt create mode 100644 build/docs/postFlowVersions-example.txt create mode 100644 build/docs/postFlows-example.txt create mode 100644 build/docs/postFlowsActionsCheckin-example.txt create mode 100644 build/docs/postFlowsActionsCheckout-example.txt create mode 100644 build/docs/postFlowsActionsDeactivate-example.txt create mode 100644 build/docs/postFlowsActionsPublish-example.txt create mode 100644 build/docs/postFlowsActionsRevert-example.txt create mode 100644 build/docs/postFlowsActionsUnlock-example.txt create mode 100644 build/docs/postFlowsDatatableExportJobs-example.txt create mode 100644 build/docs/postFlowsDatatableImportJobs-example.txt create mode 100644 build/docs/postFlowsDatatableRows-example.txt create mode 100644 build/docs/postFlowsDatatables-example.txt create mode 100644 build/docs/postFlowsExecutions-example.txt create mode 100644 build/docs/postFlowsJobs-example.txt create mode 100644 build/docs/postFlowsMilestones-example.txt create mode 100644 build/docs/postFlowsOutcomes-example.txt create mode 100644 build/docs/postGamificationProfileActivate-example.txt create mode 100644 build/docs/postGamificationProfileDeactivate-example.txt create mode 100644 build/docs/postGamificationProfileMembers-example.txt create mode 100644 build/docs/postGamificationProfileMembersValidate-example.txt create mode 100644 build/docs/postGamificationProfileMetricLink-example.txt create mode 100644 build/docs/postGamificationProfileMetrics-example.txt create mode 100644 build/docs/postGamificationProfiles-example.txt create mode 100644 build/docs/postGamificationProfilesUserQuery-example.txt create mode 100644 build/docs/postGamificationProfilesUsersMeQuery-example.txt create mode 100644 build/docs/postGdprRequests-example.txt create mode 100644 build/docs/postGreetings-example.txt create mode 100644 build/docs/postGroupGreetings-example.txt create mode 100644 build/docs/postGroupMembers-example.txt create mode 100644 build/docs/postGroups-example.txt create mode 100644 build/docs/postGroupsSearch-example.txt create mode 100644 build/docs/postInfrastructureascodeJobs-example.txt create mode 100644 build/docs/postIntegrations-example.txt create mode 100644 build/docs/postIntegrationsActionDraft-example.txt create mode 100644 build/docs/postIntegrationsActionDraftPublish-example.txt create mode 100644 build/docs/postIntegrationsActionDraftTest-example.txt create mode 100644 build/docs/postIntegrationsActionExecute-example.txt create mode 100644 build/docs/postIntegrationsActionTest-example.txt create mode 100644 build/docs/postIntegrationsActions-example.txt create mode 100644 build/docs/postIntegrationsActionsDrafts-example.txt create mode 100644 build/docs/postIntegrationsCredentials-example.txt create mode 100644 build/docs/postJourneyActionmaps-example.txt create mode 100644 build/docs/postJourneyActionmapsEstimatesJobs-example.txt create mode 100644 build/docs/postJourneyActiontemplates-example.txt create mode 100644 build/docs/postJourneyOutcomes-example.txt create mode 100644 build/docs/postJourneyOutcomesPredictors-example.txt create mode 100644 build/docs/postJourneySegments-example.txt create mode 100644 build/docs/postKnowledgeDocumentuploads-example.txt create mode 100644 build/docs/postKnowledgeGuestSessionDocumentFeedback-example.txt create mode 100644 build/docs/postKnowledgeGuestSessionDocumentsSearch-example.txt create mode 100644 build/docs/postKnowledgeGuestSessionDocumentsSearchSuggestions-example.txt create mode 100644 build/docs/postKnowledgeGuestSessions-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseCategories-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentFeedback-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentVariations-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentVersions-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentViews-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocuments-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentsSearch-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseDocumentsSearchSuggestions-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseExportJobs-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseImportJobs-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLabels-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLanguageCategories-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLanguageDocuments-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLanguageDocumentsImports-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLanguageTrainingPromote-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseLanguageTrainings-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebaseSearch-example.txt create mode 100644 build/docs/postKnowledgeKnowledgebases-example.txt create mode 100644 build/docs/postLanguages-example.txt create mode 100644 build/docs/postLanguageunderstandingDomainFeedback-example.txt create mode 100644 build/docs/postLanguageunderstandingDomainVersionDetect-example.txt create mode 100644 build/docs/postLanguageunderstandingDomainVersionPublish-example.txt create mode 100644 build/docs/postLanguageunderstandingDomainVersionTrain-example.txt create mode 100644 build/docs/postLanguageunderstandingDomainVersions-example.txt create mode 100644 build/docs/postLanguageunderstandingDomains-example.txt create mode 100644 build/docs/postLanguageunderstandingMinerDrafts-example.txt create mode 100644 build/docs/postLanguageunderstandingMinerExecute-example.txt create mode 100644 build/docs/postLanguageunderstandingMinerUploads-example.txt create mode 100644 build/docs/postLanguageunderstandingMiners-example.txt create mode 100644 build/docs/postLearningAssessmentsScoring-example.txt create mode 100644 build/docs/postLearningAssignmentReassign-example.txt create mode 100644 build/docs/postLearningAssignmentReset-example.txt create mode 100644 build/docs/postLearningAssignments-example.txt create mode 100644 build/docs/postLearningAssignmentsAggregatesQuery-example.txt create mode 100644 build/docs/postLearningAssignmentsBulkadd-example.txt create mode 100644 build/docs/postLearningAssignmentsBulkremove-example.txt create mode 100644 build/docs/postLearningModuleJobs-example.txt create mode 100644 build/docs/postLearningModulePublish-example.txt create mode 100644 build/docs/postLearningModules-example.txt create mode 100644 build/docs/postLearningRulesQuery-example.txt create mode 100644 build/docs/postLearningScheduleslotsQuery-example.txt create mode 100644 build/docs/postLicenseInfer-example.txt create mode 100644 build/docs/postLicenseOrganization-example.txt create mode 100644 build/docs/postLicenseToggle-example.txt create mode 100644 build/docs/postLicenseUsers-example.txt create mode 100644 build/docs/postLocations-example.txt create mode 100644 build/docs/postLocationsSearch-example.txt create mode 100644 build/docs/postMessagingSettings-example.txt create mode 100644 build/docs/postMessagingSupportedcontent-example.txt create mode 100644 build/docs/postMobiledevices-example.txt create mode 100644 build/docs/postNotificationsChannelSubscriptions-example.txt create mode 100644 build/docs/postNotificationsChannels-example.txt create mode 100644 build/docs/postOauthClientSecret-example.txt create mode 100644 build/docs/postOauthClientUsageQuery-example.txt create mode 100644 build/docs/postOauthClients-example.txt create mode 100644 build/docs/postOrgauthorizationPairings-example.txt create mode 100644 build/docs/postOrgauthorizationTrusteeGroups-example.txt create mode 100644 build/docs/postOrgauthorizationTrusteeUsers-example.txt create mode 100644 build/docs/postOrgauthorizationTrustees-example.txt create mode 100644 build/docs/postOrgauthorizationTrusteesAudits-example.txt create mode 100644 build/docs/postOrgauthorizationTrusteesDefault-example.txt create mode 100644 build/docs/postOrgauthorizationTrustorAudits-example.txt create mode 100644 build/docs/postOutboundAttemptlimits-example.txt create mode 100644 build/docs/postOutboundAudits-example.txt create mode 100644 build/docs/postOutboundCallabletimesets-example.txt create mode 100644 build/docs/postOutboundCallanalysisresponsesets-example.txt create mode 100644 build/docs/postOutboundCampaignAgentownedmappingpreview-example.txt create mode 100644 build/docs/postOutboundCampaignCallbackSchedule-example.txt create mode 100644 build/docs/postOutboundCampaignrules-example.txt create mode 100644 build/docs/postOutboundCampaigns-example.txt create mode 100644 build/docs/postOutboundCampaignsProgress-example.txt create mode 100644 build/docs/postOutboundContactlistClear-example.txt create mode 100644 build/docs/postOutboundContactlistContacts-example.txt create mode 100644 build/docs/postOutboundContactlistContactsBulk-example.txt create mode 100644 build/docs/postOutboundContactlistExport-example.txt create mode 100644 build/docs/postOutboundContactlistfilters-example.txt create mode 100644 build/docs/postOutboundContactlistfiltersPreview-example.txt create mode 100644 build/docs/postOutboundContactlists-example.txt create mode 100644 build/docs/postOutboundConversationDnc-example.txt create mode 100644 build/docs/postOutboundDigitalrulesets-example.txt create mode 100644 build/docs/postOutboundDnclistEmailaddresses-example.txt create mode 100644 build/docs/postOutboundDnclistExport-example.txt create mode 100644 build/docs/postOutboundDnclistPhonenumbers-example.txt create mode 100644 build/docs/postOutboundDnclists-example.txt create mode 100644 build/docs/postOutboundMessagingcampaigns-example.txt create mode 100644 build/docs/postOutboundMessagingcampaignsProgress-example.txt create mode 100644 build/docs/postOutboundRulesets-example.txt create mode 100644 build/docs/postOutboundSequences-example.txt create mode 100644 build/docs/postPresenceSources-example.txt create mode 100644 build/docs/postPresencedefinitions-example.txt create mode 100644 build/docs/postProcessautomationTriggerTest-example.txt create mode 100644 build/docs/postProcessautomationTriggers-example.txt create mode 100644 build/docs/postProcessautomationTriggersTopicTest-example.txt create mode 100644 build/docs/postQualityCalibrations-example.txt create mode 100644 build/docs/postQualityConversationEvaluations-example.txt create mode 100644 build/docs/postQualityConversationsAuditsQuery-example.txt create mode 100644 build/docs/postQualityEvaluationsAggregatesQueryMe-example.txt create mode 100644 build/docs/postQualityEvaluationsScoring-example.txt create mode 100644 build/docs/postQualityForms-example.txt create mode 100644 build/docs/postQualityFormsEvaluations-example.txt create mode 100644 build/docs/postQualityFormsSurveys-example.txt create mode 100644 build/docs/postQualityPublishedforms-example.txt create mode 100644 build/docs/postQualityPublishedformsEvaluations-example.txt create mode 100644 build/docs/postQualityPublishedformsSurveys-example.txt create mode 100644 build/docs/postQualitySurveysScoring-example.txt create mode 100644 build/docs/postRecordingBatchrequests-example.txt create mode 100644 build/docs/postRecordingCrossplatformMediaretentionpolicies-example.txt create mode 100644 build/docs/postRecordingJobs-example.txt create mode 100644 build/docs/postRecordingKeyconfigurations-example.txt create mode 100644 build/docs/postRecordingKeyconfigurationsValidate-example.txt create mode 100644 build/docs/postRecordingLocalkeys-example.txt create mode 100644 build/docs/postRecordingMediaretentionpolicies-example.txt create mode 100644 build/docs/postRecordingRecordingkeys-example.txt create mode 100644 build/docs/postRecordingUploadsReports-example.txt create mode 100644 build/docs/postRecordingsDeletionprotection-example.txt create mode 100644 build/docs/postRecordingsScreensessionsAcknowledge-example.txt create mode 100644 build/docs/postRecordingsScreensessionsMetadata-example.txt create mode 100644 build/docs/postResponsemanagementLibraries-example.txt create mode 100644 build/docs/postResponsemanagementResponseassetsSearch-example.txt create mode 100644 build/docs/postResponsemanagementResponseassetsUploads-example.txt create mode 100644 build/docs/postResponsemanagementResponses-example.txt create mode 100644 build/docs/postResponsemanagementResponsesQuery-example.txt create mode 100644 build/docs/postRoutingAssessments-example.txt create mode 100644 build/docs/postRoutingAssessmentsJobs-example.txt create mode 100644 build/docs/postRoutingEmailDomainRoutes-example.txt create mode 100644 build/docs/postRoutingEmailDomainTestconnection-example.txt create mode 100644 build/docs/postRoutingEmailDomains-example.txt create mode 100644 build/docs/postRoutingEmailOutboundDomains-example.txt create mode 100644 build/docs/postRoutingEmailOutboundDomainsSimulated-example.txt create mode 100644 build/docs/postRoutingLanguages-example.txt create mode 100644 build/docs/postRoutingPredictors-example.txt create mode 100644 build/docs/postRoutingQueueMembers-example.txt create mode 100644 build/docs/postRoutingQueueUsers-example.txt create mode 100644 build/docs/postRoutingQueueWrapupcodes-example.txt create mode 100644 build/docs/postRoutingQueues-example.txt create mode 100644 build/docs/postRoutingSkillgroupMembersDivisions-example.txt create mode 100644 build/docs/postRoutingSkillgroups-example.txt create mode 100644 build/docs/postRoutingSkills-example.txt create mode 100644 build/docs/postRoutingSmsAddresses-example.txt create mode 100644 build/docs/postRoutingSmsPhonenumbers-example.txt create mode 100644 build/docs/postRoutingWrapupcodes-example.txt create mode 100644 build/docs/postScimUsers-example.txt create mode 100644 build/docs/postScimV2Users-example.txt create mode 100644 build/docs/postScriptExport-example.txt create mode 100644 build/docs/postScriptsPublished-example.txt create mode 100644 build/docs/postSearch-example.txt create mode 100644 build/docs/postSearchSuggest-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsDictionaryfeedback-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsPrograms-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsProgramsGeneralJobs-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsProgramsPublishjobs-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsSentimentfeedback-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsTopics-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsTopicsPublishjobs-example.txt create mode 100644 build/docs/postSpeechandtextanalyticsTranscriptsSearch-example.txt create mode 100644 build/docs/postTeamMembers-example.txt create mode 100644 build/docs/postTeams-example.txt create mode 100644 build/docs/postTeamsSearch-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeDiagnosticNslookup-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeDiagnosticPing-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeDiagnosticRoute-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeDiagnosticTracepath-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeLogicalinterfaces-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeLogsJobUpload-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeLogsJobs-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeReboot-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeSoftwareupdate-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeStatuscode-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgeUnpair-example.txt create mode 100644 build/docs/postTelephonyProvidersEdges-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesAddressvalidation-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesCertificateauthorities-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesDidpools-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesEdgegroups-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesExtensionpools-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesPhoneReboot-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesPhonebasesettings-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesPhones-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesPhonesReboot-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesSiteOutboundroutes-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesSites-example.txt create mode 100644 build/docs/postTelephonyProvidersEdgesTrunkbasesettings-example.txt create mode 100644 build/docs/postTelephonySiptracesDownload-example.txt create mode 100644 build/docs/postTextbotsBotflowsSessionTurns-example.txt create mode 100644 build/docs/postTextbotsBotflowsSessions-example.txt create mode 100644 build/docs/postTextbotsBotsExecute-example.txt create mode 100644 build/docs/postUploadsLearningCoverart-example.txt create mode 100644 build/docs/postUploadsPublicassetsImages-example.txt create mode 100644 build/docs/postUploadsRecordings-example.txt create mode 100644 build/docs/postUploadsWorkforcemanagementHistoricaldataCsv-example.txt create mode 100644 build/docs/postUsageQuery-example.txt create mode 100644 build/docs/postUsageSimplesearch-example.txt create mode 100644 build/docs/postUserExternalid-example.txt create mode 100644 build/docs/postUserGreetings-example.txt create mode 100644 build/docs/postUserInvite-example.txt create mode 100644 build/docs/postUserPassword-example.txt create mode 100644 build/docs/postUserRoutinglanguages-example.txt create mode 100644 build/docs/postUserRoutingskills-example.txt create mode 100644 build/docs/postUsers-example.txt create mode 100644 build/docs/postUsersDevelopmentActivitiesAggregatesQuery-example.txt create mode 100644 build/docs/postUsersMePassword-example.txt create mode 100644 build/docs/postUsersSearch-example.txt create mode 100644 build/docs/postUsersSearchTeamsAssign-example.txt create mode 100644 build/docs/postVoicemailMessages-example.txt create mode 100644 build/docs/postVoicemailSearch-example.txt create mode 100644 build/docs/postWebchatDeployments-example.txt create mode 100644 build/docs/postWebchatGuestConversationMemberMessages-example.txt create mode 100644 build/docs/postWebchatGuestConversationMemberTyping-example.txt create mode 100644 build/docs/postWebchatGuestConversations-example.txt create mode 100644 build/docs/postWebdeploymentsConfigurationVersionsDraftPublish-example.txt create mode 100644 build/docs/postWebdeploymentsConfigurations-example.txt create mode 100644 build/docs/postWebdeploymentsDeployments-example.txt create mode 100644 build/docs/postWebdeploymentsTokenOauthcodegrantjwtexchange-example.txt create mode 100644 build/docs/postWebdeploymentsTokenRefresh-example.txt create mode 100644 build/docs/postWidgetsDeployments-example.txt create mode 100644 build/docs/postWorkforcemanagementAdherenceExplanations-example.txt create mode 100644 build/docs/postWorkforcemanagementAdherenceExplanationsQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementAdherenceHistorical-example.txt create mode 100644 build/docs/postWorkforcemanagementAdherenceHistoricalBulk-example.txt create mode 100644 build/docs/postWorkforcemanagementAgentAdherenceExplanations-example.txt create mode 100644 build/docs/postWorkforcemanagementAgentAdherenceExplanationsQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementAgents-example.txt create mode 100644 build/docs/postWorkforcemanagementAgentsIntegrationsHrisQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementAgentsMePossibleworkshifts-example.txt create mode 100644 build/docs/postWorkforcemanagementAgentschedulesMine-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitActivitycodes-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitAdherenceExplanationsQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitAgentschedulesSearch-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitIntraday-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitPlanninggroups-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitServicegoaltemplates-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekScheduleCopy-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekScheduleReschedule-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdate-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekSchedules-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekSchedulesGenerate-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImport-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastCopy-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImport-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl-example.txt create mode 100644 build/docs/postWorkforcemanagementBusinessunits-example.txt create mode 100644 build/docs/postWorkforcemanagementCalendarUrlIcs-example.txt create mode 100644 build/docs/postWorkforcemanagementHistoricaldataDeletejob-example.txt create mode 100644 build/docs/postWorkforcemanagementHistoricaldataValidate-example.txt create mode 100644 build/docs/postWorkforcemanagementIntegrationsHriTimeofftypesJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitAgentschedulesSearch-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitHistoricaladherencequery-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitMove-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitSchedulesSearch-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitShrinkageJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeofflimits-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeofflimitsValuesQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeoffplans-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeoffrequests-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeoffrequestsQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitUserTimeoffbalanceJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWeekShifttradeMatch-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWeekShifttrades-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWeekShifttradesSearch-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWeekShifttradesStateBulk-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWorkplanCopy-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWorkplanValidate-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWorkplanrotationCopy-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWorkplanrotations-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunitWorkplans-example.txt create mode 100644 build/docs/postWorkforcemanagementManagementunits-example.txt create mode 100644 build/docs/postWorkforcemanagementNotificationsUpdate-example.txt create mode 100644 build/docs/postWorkforcemanagementSchedules-example.txt create mode 100644 build/docs/postWorkforcemanagementTeamAdherenceHistorical-example.txt create mode 100644 build/docs/postWorkforcemanagementTeamShrinkageJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementTimeoffbalanceJobs-example.txt create mode 100644 build/docs/postWorkforcemanagementTimeofflimitsAvailableQuery-example.txt create mode 100644 build/docs/postWorkforcemanagementTimeoffrequests-example.txt create mode 100644 build/docs/postWorkforcemanagementTimeoffrequestsEstimate-example.txt create mode 100644 build/docs/postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery-example.txt create mode 100644 build/docs/putAlertingAlert-example.txt create mode 100644 build/docs/putAlertingInteractionstatsAlert-example.txt create mode 100644 build/docs/putAlertingInteractionstatsRule-example.txt create mode 100644 build/docs/putAlertingRule-example.txt create mode 100644 build/docs/putAnalyticsDataretentionSettings-example.txt create mode 100644 build/docs/putAnalyticsReportingSchedule-example.txt create mode 100644 build/docs/putArchitectEmergencygroup-example.txt create mode 100644 build/docs/putArchitectIvr-example.txt create mode 100644 build/docs/putArchitectPrompt-example.txt create mode 100644 build/docs/putArchitectPromptResource-example.txt create mode 100644 build/docs/putArchitectSchedule-example.txt create mode 100644 build/docs/putArchitectSchedulegroup-example.txt create mode 100644 build/docs/putArchitectSystempromptResource-example.txt create mode 100644 build/docs/putAuthorizationDivision-example.txt create mode 100644 build/docs/putAuthorizationRole-example.txt create mode 100644 build/docs/putAuthorizationRoleUsersAdd-example.txt create mode 100644 build/docs/putAuthorizationRoleUsersRemove-example.txt create mode 100644 build/docs/putAuthorizationRolesDefault-example.txt create mode 100644 build/docs/putChatSettings-example.txt create mode 100644 build/docs/putChatsSettings-example.txt create mode 100644 build/docs/putContentmanagementWorkspace-example.txt create mode 100644 build/docs/putContentmanagementWorkspaceMember-example.txt create mode 100644 build/docs/putContentmanagementWorkspaceTagvalue-example.txt create mode 100644 build/docs/putConversationParticipantFlaggedreason-example.txt create mode 100644 build/docs/putConversationRecording-example.txt create mode 100644 build/docs/putConversationRecordingAnnotation-example.txt create mode 100644 build/docs/putConversationSecureattributes-example.txt create mode 100644 build/docs/putConversationTags-example.txt create mode 100644 build/docs/putConversationsCallParticipantCommunicationUuidata-example.txt create mode 100644 build/docs/putConversationsCallRecordingstate-example.txt create mode 100644 build/docs/putConversationsCallbackRecordingstate-example.txt create mode 100644 build/docs/putConversationsChatRecordingstate-example.txt create mode 100644 build/docs/putConversationsCobrowsesessionRecordingstate-example.txt create mode 100644 build/docs/putConversationsEmailMessagesDraft-example.txt create mode 100644 build/docs/putConversationsEmailRecordingstate-example.txt create mode 100644 build/docs/putConversationsKeyconfiguration-example.txt create mode 100644 build/docs/putConversationsMessageRecordingstate-example.txt create mode 100644 build/docs/putConversationsMessagingIntegrationsLineIntegrationId-example.txt create mode 100644 build/docs/putConversationsMessagingSettingsDefault-example.txt create mode 100644 build/docs/putConversationsMessagingSupportedcontentDefault-example.txt create mode 100644 build/docs/putConversationsMessagingThreadingtimeline-example.txt create mode 100644 build/docs/putConversationsScreenshareRecordingstate-example.txt create mode 100644 build/docs/putConversationsSocialRecordingstate-example.txt create mode 100644 build/docs/putConversationsVideoRecordingstate-example.txt create mode 100644 build/docs/putExternalcontactsContact-example.txt create mode 100644 build/docs/putExternalcontactsContactNote-example.txt create mode 100644 build/docs/putExternalcontactsContactsSchema-example.txt create mode 100644 build/docs/putExternalcontactsConversation-example.txt create mode 100644 build/docs/putExternalcontactsOrganization-example.txt create mode 100644 build/docs/putExternalcontactsOrganizationNote-example.txt create mode 100644 build/docs/putExternalcontactsOrganizationTrustorTrustorId-example.txt create mode 100644 build/docs/putExternalcontactsOrganizationsSchema-example.txt create mode 100644 build/docs/putExternalcontactsRelationship-example.txt create mode 100644 build/docs/putFaxDocument-example.txt create mode 100644 build/docs/putFlow-example.txt create mode 100644 build/docs/putFlowsDatatable-example.txt create mode 100644 build/docs/putFlowsDatatableRow-example.txt create mode 100644 build/docs/putFlowsMilestone-example.txt create mode 100644 build/docs/putFlowsOutcome-example.txt create mode 100644 build/docs/putGamificationProfile-example.txt create mode 100644 build/docs/putGamificationProfileMetric-example.txt create mode 100644 build/docs/putGamificationStatus-example.txt create mode 100644 build/docs/putGreeting-example.txt create mode 100644 build/docs/putGreetingsDefaults-example.txt create mode 100644 build/docs/putGroup-example.txt create mode 100644 build/docs/putGroupGreetingsDefaults-example.txt create mode 100644 build/docs/putIdentityprovidersAdfs-example.txt create mode 100644 build/docs/putIdentityprovidersCic-example.txt create mode 100644 build/docs/putIdentityprovidersGeneric-example.txt create mode 100644 build/docs/putIdentityprovidersGsuite-example.txt create mode 100644 build/docs/putIdentityprovidersIdentitynow-example.txt create mode 100644 build/docs/putIdentityprovidersOkta-example.txt create mode 100644 build/docs/putIdentityprovidersOnelogin-example.txt create mode 100644 build/docs/putIdentityprovidersPing-example.txt create mode 100644 build/docs/putIdentityprovidersPurecloud-example.txt create mode 100644 build/docs/putIdentityprovidersPureengage-example.txt create mode 100644 build/docs/putIdentityprovidersSalesforce-example.txt create mode 100644 build/docs/putIntegrationConfigCurrent-example.txt create mode 100644 build/docs/putIntegrationsBotconnectorIntegrationIdBots-example.txt create mode 100644 build/docs/putIntegrationsCredential-example.txt create mode 100644 build/docs/putIntegrationsSpeechTtsSettings-example.txt create mode 100644 build/docs/putIntegrationsUnifiedcommunicationThirdpartypresences-example.txt create mode 100644 build/docs/putLanguageunderstandingDomainVersion-example.txt create mode 100644 build/docs/putLearningModule-example.txt create mode 100644 build/docs/putLearningModuleRule-example.txt create mode 100644 build/docs/putMessagingSettingsDefault-example.txt create mode 100644 build/docs/putMobiledevice-example.txt create mode 100644 build/docs/putNotificationsChannelSubscriptions-example.txt create mode 100644 build/docs/putOauthClient-example.txt create mode 100644 build/docs/putOrganizationsEmbeddedintegration-example.txt create mode 100644 build/docs/putOrganizationsIpaddressauthentication-example.txt create mode 100644 build/docs/putOrganizationsMe-example.txt create mode 100644 build/docs/putOrganizationsWhitelist-example.txt create mode 100644 build/docs/putOrgauthorizationTrustee-example.txt create mode 100644 build/docs/putOrgauthorizationTrusteeGroupRoledivisions-example.txt create mode 100644 build/docs/putOrgauthorizationTrusteeGroupRoles-example.txt create mode 100644 build/docs/putOrgauthorizationTrusteeUserRoledivisions-example.txt create mode 100644 build/docs/putOrgauthorizationTrusteeUserRoles-example.txt create mode 100644 build/docs/putOrgauthorizationTrustorCloneduser-example.txt create mode 100644 build/docs/putOrgauthorizationTrustorGroup-example.txt create mode 100644 build/docs/putOrgauthorizationTrustorUser-example.txt create mode 100644 build/docs/putOrphanrecording-example.txt create mode 100644 build/docs/putOutboundAttemptlimit-example.txt create mode 100644 build/docs/putOutboundCallabletimeset-example.txt create mode 100644 build/docs/putOutboundCallanalysisresponseset-example.txt create mode 100644 build/docs/putOutboundCampaign-example.txt create mode 100644 build/docs/putOutboundCampaignAgent-example.txt create mode 100644 build/docs/putOutboundCampaignrule-example.txt create mode 100644 build/docs/putOutboundContactlist-example.txt create mode 100644 build/docs/putOutboundContactlistContact-example.txt create mode 100644 build/docs/putOutboundContactlistfilter-example.txt create mode 100644 build/docs/putOutboundDigitalruleset-example.txt create mode 100644 build/docs/putOutboundDnclist-example.txt create mode 100644 build/docs/putOutboundMessagingcampaign-example.txt create mode 100644 build/docs/putOutboundRuleset-example.txt create mode 100644 build/docs/putOutboundSchedulesCampaign-example.txt create mode 100644 build/docs/putOutboundSchedulesEmailcampaign-example.txt create mode 100644 build/docs/putOutboundSchedulesMessagingcampaign-example.txt create mode 100644 build/docs/putOutboundSchedulesSequence-example.txt create mode 100644 build/docs/putOutboundSequence-example.txt create mode 100644 build/docs/putOutboundWrapupcodemappings-example.txt create mode 100644 build/docs/putPresenceSettings-example.txt create mode 100644 build/docs/putPresenceSource-example.txt create mode 100644 build/docs/putPresenceUserPrimarysource-example.txt create mode 100644 build/docs/putPresencedefinition-example.txt create mode 100644 build/docs/putProcessautomationTrigger-example.txt create mode 100644 build/docs/putQualityCalibration-example.txt create mode 100644 build/docs/putQualityConversationEvaluation-example.txt create mode 100644 build/docs/putQualityForm-example.txt create mode 100644 build/docs/putQualityFormsEvaluation-example.txt create mode 100644 build/docs/putQualityFormsSurvey-example.txt create mode 100644 build/docs/putQualitySurveysScorable-example.txt create mode 100644 build/docs/putRecordingCrossplatformMediaretentionpolicy-example.txt create mode 100644 build/docs/putRecordingJob-example.txt create mode 100644 build/docs/putRecordingKeyconfiguration-example.txt create mode 100644 build/docs/putRecordingMediaretentionpolicy-example.txt create mode 100644 build/docs/putRecordingRecordingkeysRotationschedule-example.txt create mode 100644 build/docs/putRecordingSettings-example.txt create mode 100644 build/docs/putRecordingsDeletionprotection-example.txt create mode 100644 build/docs/putResponsemanagementLibrary-example.txt create mode 100644 build/docs/putResponsemanagementResponse-example.txt create mode 100644 build/docs/putResponsemanagementResponseasset-example.txt create mode 100644 build/docs/putRoutingEmailDomainRoute-example.txt create mode 100644 build/docs/putRoutingEmailOutboundDomainActivation-example.txt create mode 100644 build/docs/putRoutingMessageRecipient-example.txt create mode 100644 build/docs/putRoutingQueue-example.txt create mode 100644 build/docs/putRoutingSettings-example.txt create mode 100644 build/docs/putRoutingSettingsTranscription-example.txt create mode 100644 build/docs/putRoutingSmsPhonenumber-example.txt create mode 100644 build/docs/putRoutingUserUtilization-example.txt create mode 100644 build/docs/putRoutingUtilization-example.txt create mode 100644 build/docs/putRoutingWrapupcode-example.txt create mode 100644 build/docs/putScimGroup-example.txt create mode 100644 build/docs/putScimUser-example.txt create mode 100644 build/docs/putScimV2Group-example.txt create mode 100644 build/docs/putScimV2User-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsProgram-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsProgramMappings-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsProgramTranscriptionengines-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsSettings-example.txt create mode 100644 build/docs/putSpeechandtextanalyticsTopic-example.txt create mode 100644 build/docs/putTelephonyProvidersEdge-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgeLogicalinterface-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesCertificateauthority-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesDidpool-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesEdgegroup-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesExtensionpool-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesPhone-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesPhonebasesetting-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesSite-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesSiteNumberplans-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesSiteOutboundroute-example.txt create mode 100644 build/docs/putTelephonyProvidersEdgesTrunkbasesetting-example.txt create mode 100644 build/docs/putUserCallforwarding-example.txt create mode 100644 build/docs/putUserGreetingsDefaults-example.txt create mode 100644 build/docs/putUserOutofoffice-example.txt create mode 100644 build/docs/putUserProfileskills-example.txt create mode 100644 build/docs/putUserRoles-example.txt create mode 100644 build/docs/putUserRoutingskill-example.txt create mode 100644 build/docs/putUserRoutingskillsBulk-example.txt create mode 100644 build/docs/putUserRoutingstatus-example.txt create mode 100644 build/docs/putUserState-example.txt create mode 100644 build/docs/putUserStationAssociatedstationStationId-example.txt create mode 100644 build/docs/putUserStationDefaultstationStationId-example.txt create mode 100644 build/docs/putUserrecording-example.txt create mode 100644 build/docs/putUsersPresencesBulk-example.txt create mode 100644 build/docs/putVoicemailMessage-example.txt create mode 100644 build/docs/putVoicemailPolicy-example.txt create mode 100644 build/docs/putVoicemailUserpolicy-example.txt create mode 100644 build/docs/putWebchatDeployment-example.txt create mode 100644 build/docs/putWebchatSettings-example.txt create mode 100644 build/docs/putWebdeploymentsConfigurationVersionsDraft-example.txt create mode 100644 build/docs/putWebdeploymentsDeployment-example.txt create mode 100644 build/docs/putWidgetsDeployment-example.txt create mode 100644 build/docs/putWorkforcemanagementAgentIntegrationsHris-example.txt create mode 100644 build/docs/putWorkforcemanagementManagementunitTimeofflimitValues-example.txt diff --git a/PureCloudPlatformClientV2.podspec b/PureCloudPlatformClientV2.podspec index e822833c2..b160f3920 100644 --- a/PureCloudPlatformClientV2.podspec +++ b/PureCloudPlatformClientV2.podspec @@ -4,8 +4,8 @@ Pod::Spec.new do |s| s.ios.deployment_target = '10.0' s.osx.deployment_target = '10.11' s.swift_version = '5.0' - s.version = '127.0.0' - s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.0.0' } + s.version = '127.1.0' + s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.1.0' } s.authors = 'Genesys Developer Evangelists' s.social_media_url = 'https://twitter.com/PureCloud_Dev' #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/' diff --git a/README.md b/README.md index b5e6a4f94..97f6bd4c1 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.1.0' ``` Then install your project's dependencies: diff --git a/build/APIData.json b/build/APIData.json deleted file mode 100644 index 0de7cef5d..000000000 --- a/build/APIData.json +++ /dev/null @@ -1,40749 +0,0 @@ -{ - "deletealertingalert": { - "operationId": "deletealertingalert", - "functionName": "deleteAlertingAlert", - "signature": "deleteAlertingAlert(alertId)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\n\n// Delete an alert\nDeleteAlertingAlertRequest.deleteAlertingAlert(alertId: alertId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAlertingAlertRequest.deleteAlertingAlert was successful\")\n }\n}" - }, - "deletealertinginteractionstatsalert": { - "operationId": "deletealertinginteractionstatsalert", - "functionName": "deleteAlertingInteractionstatsAlert", - "signature": "deleteAlertingInteractionstatsAlert(alertId)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\n\n// Delete an interaction stats alert\nDeleteAlertingInteractionstatsAlertRequest.deleteAlertingInteractionstatsAlert(alertId: alertId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAlertingInteractionstatsAlertRequest.deleteAlertingInteractionstatsAlert was successful\")\n }\n}" - }, - "deletealertinginteractionstatsrule": { - "operationId": "deletealertinginteractionstatsrule", - "functionName": "deleteAlertingInteractionstatsRule", - "signature": "deleteAlertingInteractionstatsRule(ruleId)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule ID\n\n// Delete an interaction stats rule.\nDeleteAlertingInteractionstatsRuleRequest.deleteAlertingInteractionstatsRule(ruleId: ruleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAlertingInteractionstatsRuleRequest.deleteAlertingInteractionstatsRule was successful\")\n }\n}" - }, - "deletealertingrule": { - "operationId": "deletealertingrule", - "functionName": "deleteAlertingRule", - "signature": "deleteAlertingRule(ruleId)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule Id\n\n// Delete a rule.\nDeleteAlertingRuleRequest.deleteAlertingRule(ruleId: ruleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAlertingRuleRequest.deleteAlertingRule was successful\")\n }\n}" - }, - "getalertingalert": { - "operationId": "getalertingalert", - "functionName": "getAlertingAlert", - "signature": "getAlertingAlert(alertId)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - } - ], - "return": "CommonAlert", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\n\n// Get an alert\nGetAlertingAlertRequest.getAlertingAlert(alertId: alertId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingAlertRequest.getAlertingAlert was successful\")\n dump(response)\n }\n}" - }, - "getalertingalertsactive": { - "operationId": "getalertingalertsactive", - "functionName": "getAlertingAlertsActive", - "signature": "getAlertingAlertsActive()", - "return": "ActiveAlertCount", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Gets active alert count for a user.\nGetAlertingAlertsActiveRequest.getAlertingAlertsActive() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingAlertsActiveRequest.getAlertingAlertsActive was successful\")\n dump(response)\n }\n}" - }, - "getalertinginteractionstatsalert": { - "operationId": "getalertinginteractionstatsalert", - "functionName": "getAlertingInteractionstatsAlert", - "signature": "getAlertingInteractionstatsAlert(alertId, expand)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsAlert", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get an interaction stats alert\nGetAlertingInteractionstatsAlertRequest.getAlertingInteractionstatsAlert(alertId: alertId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingInteractionstatsAlertRequest.getAlertingInteractionstatsAlert was successful\")\n dump(response)\n }\n}" - }, - "getalertinginteractionstatsalerts": { - "operationId": "getalertinginteractionstatsalerts", - "functionName": "getAlertingInteractionstatsAlerts", - "signature": "getAlertingInteractionstatsAlerts(expand)", - "parameters": [ - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsAlertContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get interaction stats alert list.\nGetAlertingInteractionstatsAlertsRequest.getAlertingInteractionstatsAlerts(expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingInteractionstatsAlertsRequest.getAlertingInteractionstatsAlerts was successful\")\n dump(response)\n }\n}" - }, - "getalertinginteractionstatsalertsunread": { - "operationId": "getalertinginteractionstatsalertsunread", - "functionName": "getAlertingInteractionstatsAlertsUnread", - "signature": "getAlertingInteractionstatsAlertsUnread()", - "return": "UnreadMetric", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Gets user unread count of interaction stats alerts.\nGetAlertingInteractionstatsAlertsUnreadRequest.getAlertingInteractionstatsAlertsUnread() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingInteractionstatsAlertsUnreadRequest.getAlertingInteractionstatsAlertsUnread was successful\")\n dump(response)\n }\n}" - }, - "getalertinginteractionstatsrule": { - "operationId": "getalertinginteractionstatsrule", - "functionName": "getAlertingInteractionstatsRule", - "signature": "getAlertingInteractionstatsRule(ruleId, expand)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get an interaction stats rule.\nGetAlertingInteractionstatsRuleRequest.getAlertingInteractionstatsRule(ruleId: ruleId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingInteractionstatsRuleRequest.getAlertingInteractionstatsRule was successful\")\n dump(response)\n }\n}" - }, - "getalertinginteractionstatsrules": { - "operationId": "getalertinginteractionstatsrules", - "functionName": "getAlertingInteractionstatsRules", - "signature": "getAlertingInteractionstatsRules(expand)", - "parameters": [ - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsRuleContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get an interaction stats rule list.\nGetAlertingInteractionstatsRulesRequest.getAlertingInteractionstatsRules(expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingInteractionstatsRulesRequest.getAlertingInteractionstatsRules was successful\")\n dump(response)\n }\n}" - }, - "getalertingrule": { - "operationId": "getalertingrule", - "functionName": "getAlertingRule", - "signature": "getAlertingRule(ruleId)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - } - ], - "return": "CommonRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule Id\n\n// Get a rule.\nGetAlertingRuleRequest.getAlertingRule(ruleId: ruleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAlertingRuleRequest.getAlertingRule was successful\")\n dump(response)\n }\n}" - }, - "patchalertingalert": { - "operationId": "patchalertingalert", - "functionName": "patchAlertingAlert", - "signature": "patchAlertingAlert(alertId, body)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AlertRequest", - "required": "false" - } - ], - "return": "CommonAlert", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\nlet body: AlertRequest = new AlertRequest(...) // \n\n// Allows an entity to mute/snooze an alert or update the unread status of the alert.\nPatchAlertingAlertRequest.patchAlertingAlert(alertId: alertId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAlertingAlertRequest.patchAlertingAlert was successful\")\n dump(response)\n }\n}" - }, - "patchalertingalertsbulk": { - "operationId": "patchalertingalertsbulk", - "functionName": "patchAlertingAlertsBulk", - "signature": "patchAlertingAlertsBulk(body)", - "parameters": [ - { - "name": "body", - "type": "CommonAlertBulkUpdateRequest", - "required": "true" - } - ], - "return": "BulkResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CommonAlertBulkUpdateRequest = new CommonAlertBulkUpdateRequest(...) // \n\n// Bulk alert updates\nPatchAlertingAlertsBulkRequest.patchAlertingAlertsBulk(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAlertingAlertsBulkRequest.patchAlertingAlertsBulk was successful\")\n dump(response)\n }\n}" - }, - "patchalertingrulesbulk": { - "operationId": "patchalertingrulesbulk", - "functionName": "patchAlertingRulesBulk", - "signature": "patchAlertingRulesBulk(body)", - "parameters": [ - { - "name": "body", - "type": "CommonRuleBulkUpdateNotificationsRequest", - "required": "true" - } - ], - "return": "BulkResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CommonRuleBulkUpdateNotificationsRequest = new CommonRuleBulkUpdateNotificationsRequest(...) // \n\n// Bulk update of notification lists\nPatchAlertingRulesBulkRequest.patchAlertingRulesBulk(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAlertingRulesBulkRequest.patchAlertingRulesBulk was successful\")\n dump(response)\n }\n}" - }, - "postalertingalertsquery": { - "operationId": "postalertingalertsquery", - "functionName": "postAlertingAlertsQuery", - "signature": "postAlertingAlertsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "GetAlertQuery", - "required": "false" - } - ], - "return": "AlertListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GetAlertQuery = new GetAlertQuery(...) // \n\n// Gets a paged list of alerts. The max page size is 50\nPostAlertingAlertsQueryRequest.postAlertingAlertsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAlertingAlertsQueryRequest.postAlertingAlertsQuery was successful\")\n dump(response)\n }\n}" - }, - "postalertinginteractionstatsrules": { - "operationId": "postalertinginteractionstatsrules", - "functionName": "postAlertingInteractionstatsRules", - "signature": "postAlertingInteractionstatsRules(body, expand)", - "parameters": [ - { - "name": "body", - "type": "InteractionStatsRule", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: InteractionStatsRule = new InteractionStatsRule(...) // AlertingRule\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Create an interaction stats rule.\nPostAlertingInteractionstatsRulesRequest.postAlertingInteractionstatsRules(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAlertingInteractionstatsRulesRequest.postAlertingInteractionstatsRules was successful\")\n dump(response)\n }\n}" - }, - "postalertingrules": { - "operationId": "postalertingrules", - "functionName": "postAlertingRules", - "signature": "postAlertingRules(body)", - "parameters": [ - { - "name": "body", - "type": "CommonRule", - "required": "true" - } - ], - "return": "CommonRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CommonRule = new CommonRule(...) // rule to be created\n\n// Create a Rule.\nPostAlertingRulesRequest.postAlertingRules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAlertingRulesRequest.postAlertingRules was successful\")\n dump(response)\n }\n}" - }, - "postalertingrulesbulkremove": { - "operationId": "postalertingrulesbulkremove", - "functionName": "postAlertingRulesBulkRemove", - "signature": "postAlertingRulesBulkRemove(body)", - "parameters": [ - { - "name": "body", - "type": "CommonRuleBulkDeleteRequest", - "required": "true" - } - ], - "return": "BulkResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CommonRuleBulkDeleteRequest = new CommonRuleBulkDeleteRequest(...) // \n\n// Bulk remove rules\nPostAlertingRulesBulkRemoveRequest.postAlertingRulesBulkRemove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAlertingRulesBulkRemoveRequest.postAlertingRulesBulkRemove was successful\")\n dump(response)\n }\n}" - }, - "postalertingrulesquery": { - "operationId": "postalertingrulesquery", - "functionName": "postAlertingRulesQuery", - "signature": "postAlertingRulesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "GetRulesQuery", - "required": "false" - } - ], - "return": "CommonRuleContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GetRulesQuery = new GetRulesQuery(...) // \n\n// Get a paged list of rules. The max size of the page is 50 items.\nPostAlertingRulesQueryRequest.postAlertingRulesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAlertingRulesQueryRequest.postAlertingRulesQuery was successful\")\n dump(response)\n }\n}" - }, - "putalertingalert": { - "operationId": "putalertingalert", - "functionName": "putAlertingAlert", - "signature": "putAlertingAlert(alertId, body)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AlertingUnreadStatus", - "required": "false" - } - ], - "return": "UnreadStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\nlet body: AlertingUnreadStatus = new AlertingUnreadStatus(...) // \n\n// Update an alert read status\nPutAlertingAlertRequest.putAlertingAlert(alertId: alertId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAlertingAlertRequest.putAlertingAlert was successful\")\n dump(response)\n }\n}" - }, - "putalertinginteractionstatsalert": { - "operationId": "putalertinginteractionstatsalert", - "functionName": "putAlertingInteractionstatsAlert", - "signature": "putAlertingInteractionstatsAlert(alertId, body, expand)", - "parameters": [ - { - "name": "alertId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UnreadStatus", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UnreadStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet alertId: String = \"\" // Alert ID\nlet body: UnreadStatus = new UnreadStatus(...) // InteractionStatsAlert\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Update an interaction stats alert read status\nPutAlertingInteractionstatsAlertRequest.putAlertingInteractionstatsAlert(alertId: alertId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAlertingInteractionstatsAlertRequest.putAlertingInteractionstatsAlert was successful\")\n dump(response)\n }\n}" - }, - "putalertinginteractionstatsrule": { - "operationId": "putalertinginteractionstatsrule", - "functionName": "putAlertingInteractionstatsRule", - "signature": "putAlertingInteractionstatsRule(ruleId, body, expand)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InteractionStatsRule", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "InteractionStatsRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule ID\nlet body: InteractionStatsRule = new InteractionStatsRule(...) // AlertingRule\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Update an interaction stats rule\nPutAlertingInteractionstatsRuleRequest.putAlertingInteractionstatsRule(ruleId: ruleId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAlertingInteractionstatsRuleRequest.putAlertingInteractionstatsRule was successful\")\n dump(response)\n }\n}" - }, - "putalertingrule": { - "operationId": "putalertingrule", - "functionName": "putAlertingRule", - "signature": "putAlertingRule(ruleId, body)", - "parameters": [ - { - "name": "ruleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ModifiableRuleProperties", - "required": "true" - } - ], - "return": "CommonRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // Rule Id\nlet body: ModifiableRuleProperties = new ModifiableRuleProperties(...) // rule to be updated\n\n// Update a rule\nPutAlertingRuleRequest.putAlertingRule(ruleId: ruleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAlertingRuleRequest.putAlertingRule was successful\")\n dump(response)\n }\n}" - }, - "deleteanalyticsconversationsdetailsjob": { - "operationId": "deleteanalyticsconversationsdetailsjob", - "functionName": "deleteAnalyticsConversationsDetailsJob", - "signature": "deleteAnalyticsConversationsDetailsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Delete/cancel an async details job\nDeleteAnalyticsConversationsDetailsJobRequest.deleteAnalyticsConversationsDetailsJob(jobId: jobId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAnalyticsConversationsDetailsJobRequest.deleteAnalyticsConversationsDetailsJob was successful\")\n }\n}" - }, - "deleteanalyticsreportingschedule": { - "operationId": "deleteanalyticsreportingschedule", - "functionName": "deleteAnalyticsReportingSchedule", - "signature": "deleteAnalyticsReportingSchedule(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Delete a scheduled report job.\nDeleteAnalyticsReportingScheduleRequest.deleteAnalyticsReportingSchedule(scheduleId: scheduleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAnalyticsReportingScheduleRequest.deleteAnalyticsReportingSchedule was successful\")\n }\n}" - }, - "deleteanalyticsusersdetailsjob": { - "operationId": "deleteanalyticsusersdetailsjob", - "functionName": "deleteAnalyticsUsersDetailsJob", - "signature": "deleteAnalyticsUsersDetailsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Delete/cancel an async request\nDeleteAnalyticsUsersDetailsJobRequest.deleteAnalyticsUsersDetailsJob(jobId: jobId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAnalyticsUsersDetailsJobRequest.deleteAnalyticsUsersDetailsJob was successful\")\n }\n}" - }, - "getanalyticsbotflowreportingturns": { - "operationId": "getanalyticsbotflowreportingturns", - "functionName": "getAnalyticsBotflowReportingturns", - "signature": "getAnalyticsBotflowReportingturns(botFlowId, after, pageSize, interval, actionId, sessionId, language, askActionResults)", - "parameters": [ - { - "name": "botFlowId", - "type": "String", - "required": "true" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "actionId", - "type": "String", - "required": "false" - }, - { - "name": "sessionId", - "type": "String", - "required": "false" - }, - { - "name": "language", - "type": "String", - "required": "false" - }, - { - "name": "askActionResults", - "type": "String", - "required": "false" - } - ], - "return": "ReportingTurnsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet botFlowId: String = \"\" // ID of the bot flow.\nlet after: String = \"\" // The cursor that points to the ID of the last item in the list of entities that has been returned.\nlet pageSize: String = \"\" // Max number of entities to return. Maximum of 250\nlet interval: String = 2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z // Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss\nlet actionId: String = \"\" // Optional action ID to get the reporting turns associated to a particular flow action\nlet sessionId: String = \"\" // Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.\nlet language: String = en-us // Optional language code to get the reporting turns for a particular language\nlet askActionResults: GetAnalyticsBotflowReportingturnsRequest.AskActionResults_getAnalyticsBotflowReportingturns = GetAnalyticsBotflowReportingturnsRequest.AskActionResults_getAnalyticsBotflowReportingturns.enummember // Optional case-insensitive comma separated list of ask action results to filter the reporting turns.\n\n// Get Reporting Turns.\nGetAnalyticsBotflowReportingturnsRequest.getAnalyticsBotflowReportingturns(botFlowId: botFlowId, after: after, pageSize: pageSize, interval: interval, actionId: actionId, sessionId: sessionId, language: language, askActionResults: askActionResults) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsBotflowReportingturnsRequest.getAnalyticsBotflowReportingturns was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsconversationdetails": { - "operationId": "getanalyticsconversationdetails", - "functionName": "getAnalyticsConversationDetails", - "signature": "getAnalyticsConversationDetails(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "AnalyticsConversationWithoutAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get a conversation by id\nGetAnalyticsConversationDetailsRequest.getAnalyticsConversationDetails(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsConversationDetailsRequest.getAnalyticsConversationDetails was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsconversationsdetails": { - "operationId": "getanalyticsconversationsdetails", - "functionName": "getAnalyticsConversationsDetails", - "signature": "getAnalyticsConversationsDetails(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "AnalyticsConversationWithoutAttributesMultiGetResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // Comma-separated conversation ids\n\n// Gets multiple conversations by id\nGetAnalyticsConversationsDetailsRequest.getAnalyticsConversationsDetails(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsConversationsDetailsRequest.getAnalyticsConversationsDetails was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsconversationsdetailsjob": { - "operationId": "getanalyticsconversationsdetailsjob", - "functionName": "getAnalyticsConversationsDetailsJob", - "signature": "getAnalyticsConversationsDetailsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "AsyncQueryStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Get status for async query for conversation details\nGetAnalyticsConversationsDetailsJobRequest.getAnalyticsConversationsDetailsJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsConversationsDetailsJobRequest.getAnalyticsConversationsDetailsJob was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsconversationsdetailsjobresults": { - "operationId": "getanalyticsconversationsdetailsjobresults", - "functionName": "getAnalyticsConversationsDetailsJobResults", - "signature": "getAnalyticsConversationsDetailsJobResults(jobId, cursor, pageSize)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "AnalyticsConversationAsyncQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\nlet pageSize: Int = 0 // The desired maximum number of results\n\n// Fetch a page of results for an async details job\nGetAnalyticsConversationsDetailsJobResultsRequest.getAnalyticsConversationsDetailsJobResults(jobId: jobId, cursor: cursor, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsConversationsDetailsJobResultsRequest.getAnalyticsConversationsDetailsJobResults was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsconversationsdetailsjobsavailability": { - "operationId": "getanalyticsconversationsdetailsjobsavailability", - "functionName": "getAnalyticsConversationsDetailsJobsAvailability", - "signature": "getAnalyticsConversationsDetailsJobsAvailability()", - "return": "DataAvailabilityResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Lookup the datalake availability date and time\nGetAnalyticsConversationsDetailsJobsAvailabilityRequest.getAnalyticsConversationsDetailsJobsAvailability() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsConversationsDetailsJobsAvailabilityRequest.getAnalyticsConversationsDetailsJobsAvailability was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsdataretentionsettings": { - "operationId": "getanalyticsdataretentionsettings", - "functionName": "getAnalyticsDataretentionSettings", - "signature": "getAnalyticsDataretentionSettings()", - "return": "AnalyticsDataRetentionResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get analytics data retention setting\nGetAnalyticsDataretentionSettingsRequest.getAnalyticsDataretentionSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsDataretentionSettingsRequest.getAnalyticsDataretentionSettings was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingexports": { - "operationId": "getanalyticsreportingexports", - "functionName": "getAnalyticsReportingExports", - "signature": "getAnalyticsReportingExports(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ReportingExportJobListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get all view export requests for a user\nGetAnalyticsReportingExportsRequest.getAnalyticsReportingExports(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingExportsRequest.getAnalyticsReportingExports was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingexportsmetadata": { - "operationId": "getanalyticsreportingexportsmetadata", - "functionName": "getAnalyticsReportingExportsMetadata", - "signature": "getAnalyticsReportingExportsMetadata()", - "return": "ReportingExportMetadataJobListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get all export metadata\nGetAnalyticsReportingExportsMetadataRequest.getAnalyticsReportingExportsMetadata() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingExportsMetadataRequest.getAnalyticsReportingExportsMetadata was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingmetadata": { - "operationId": "getanalyticsreportingmetadata", - "functionName": "getAnalyticsReportingMetadata", - "signature": "getAnalyticsReportingMetadata(pageNumber, pageSize, locale)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "locale", - "type": "String", - "required": "false" - } - ], - "return": "ReportMetaDataEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet locale: String = \"\" // Locale\n\n// Get list of reporting metadata.\nGetAnalyticsReportingMetadataRequest.getAnalyticsReportingMetadata(pageNumber: pageNumber, pageSize: pageSize, locale: locale) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingMetadataRequest.getAnalyticsReportingMetadata was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingreportidmetadata": { - "operationId": "getanalyticsreportingreportidmetadata", - "functionName": "getAnalyticsReportingReportIdMetadata", - "signature": "getAnalyticsReportingReportIdMetadata(reportId, locale)", - "parameters": [ - { - "name": "reportId", - "type": "String", - "required": "true" - }, - { - "name": "locale", - "type": "String", - "required": "false" - } - ], - "return": "ReportMetaData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet reportId: String = \"\" // Report ID\nlet locale: String = \"\" // Locale\n\n// Get a reporting metadata.\nGetAnalyticsReportingReportIdMetadataRequest.getAnalyticsReportingReportIdMetadata(reportId: reportId, locale: locale) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingReportIdMetadataRequest.getAnalyticsReportingReportIdMetadata was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingreportformats": { - "operationId": "getanalyticsreportingreportformats", - "functionName": "getAnalyticsReportingReportformats", - "signature": "getAnalyticsReportingReportformats()", - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of report formats\nGetAnalyticsReportingReportformatsRequest.getAnalyticsReportingReportformats() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingReportformatsRequest.getAnalyticsReportingReportformats was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingschedule": { - "operationId": "getanalyticsreportingschedule", - "functionName": "getAnalyticsReportingSchedule", - "signature": "getAnalyticsReportingSchedule(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "ReportSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Get a scheduled report job.\nGetAnalyticsReportingScheduleRequest.getAnalyticsReportingSchedule(scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingScheduleRequest.getAnalyticsReportingSchedule was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingschedulehistory": { - "operationId": "getanalyticsreportingschedulehistory", - "functionName": "getAnalyticsReportingScheduleHistory", - "signature": "getAnalyticsReportingScheduleHistory(scheduleId, pageNumber, pageSize)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ReportRunEntryEntityDomainListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\nlet pageNumber: Int = 0 // \nlet pageSize: Int = 0 // \n\n// Get list of completed scheduled report jobs.\nGetAnalyticsReportingScheduleHistoryRequest.getAnalyticsReportingScheduleHistory(scheduleId: scheduleId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingScheduleHistoryRequest.getAnalyticsReportingScheduleHistory was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingschedulehistorylatest": { - "operationId": "getanalyticsreportingschedulehistorylatest", - "functionName": "getAnalyticsReportingScheduleHistoryLatest", - "signature": "getAnalyticsReportingScheduleHistoryLatest(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "ReportRunEntry", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Get most recently completed scheduled report job.\nGetAnalyticsReportingScheduleHistoryLatestRequest.getAnalyticsReportingScheduleHistoryLatest(scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingScheduleHistoryLatestRequest.getAnalyticsReportingScheduleHistoryLatest was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingschedulehistoryrunid": { - "operationId": "getanalyticsreportingschedulehistoryrunid", - "functionName": "getAnalyticsReportingScheduleHistoryRunId", - "signature": "getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId)", - "parameters": [ - { - "name": "runId", - "type": "String", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "ReportRunEntry", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet runId: String = \"\" // Run ID\nlet scheduleId: String = \"\" // Schedule ID\n\n// A completed scheduled report job\nGetAnalyticsReportingScheduleHistoryRunIdRequest.getAnalyticsReportingScheduleHistoryRunId(runId: runId, scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingScheduleHistoryRunIdRequest.getAnalyticsReportingScheduleHistoryRunId was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingschedules": { - "operationId": "getanalyticsreportingschedules", - "functionName": "getAnalyticsReportingSchedules", - "signature": "getAnalyticsReportingSchedules(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ReportScheduleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a list of scheduled report jobs\nGetAnalyticsReportingSchedulesRequest.getAnalyticsReportingSchedules(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingSchedulesRequest.getAnalyticsReportingSchedules was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingsettings": { - "operationId": "getanalyticsreportingsettings", - "functionName": "getAnalyticsReportingSettings", - "signature": "getAnalyticsReportingSettings()", - "return": "AnalyticsReportingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get AnalyticsReportingSettings for an organization\nGetAnalyticsReportingSettingsRequest.getAnalyticsReportingSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingSettingsRequest.getAnalyticsReportingSettings was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsreportingtimeperiods": { - "operationId": "getanalyticsreportingtimeperiods", - "functionName": "getAnalyticsReportingTimeperiods", - "signature": "getAnalyticsReportingTimeperiods()", - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of report time periods.\nGetAnalyticsReportingTimeperiodsRequest.getAnalyticsReportingTimeperiods() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsReportingTimeperiodsRequest.getAnalyticsReportingTimeperiods was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsusersdetailsjob": { - "operationId": "getanalyticsusersdetailsjob", - "functionName": "getAnalyticsUsersDetailsJob", - "signature": "getAnalyticsUsersDetailsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "AsyncQueryStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Get status for async query for user details\nGetAnalyticsUsersDetailsJobRequest.getAnalyticsUsersDetailsJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsUsersDetailsJobRequest.getAnalyticsUsersDetailsJob was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsusersdetailsjobresults": { - "operationId": "getanalyticsusersdetailsjobresults", - "functionName": "getAnalyticsUsersDetailsJobResults", - "signature": "getAnalyticsUsersDetailsJobResults(jobId, cursor, pageSize)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "AnalyticsUserDetailsAsyncQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\nlet pageSize: Int = 0 // The desired maximum number of results\n\n// Fetch a page of results for an async query\nGetAnalyticsUsersDetailsJobResultsRequest.getAnalyticsUsersDetailsJobResults(jobId: jobId, cursor: cursor, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsUsersDetailsJobResultsRequest.getAnalyticsUsersDetailsJobResults was successful\")\n dump(response)\n }\n}" - }, - "getanalyticsusersdetailsjobsavailability": { - "operationId": "getanalyticsusersdetailsjobsavailability", - "functionName": "getAnalyticsUsersDetailsJobsAvailability", - "signature": "getAnalyticsUsersDetailsJobsAvailability()", - "return": "DataAvailabilityResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Lookup the datalake availability date and time\nGetAnalyticsUsersDetailsJobsAvailabilityRequest.getAnalyticsUsersDetailsJobsAvailability() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAnalyticsUsersDetailsJobsAvailabilityRequest.getAnalyticsUsersDetailsJobsAvailability was successful\")\n dump(response)\n }\n}" - }, - "patchanalyticsreportingsettings": { - "operationId": "patchanalyticsreportingsettings", - "functionName": "patchAnalyticsReportingSettings", - "signature": "patchAnalyticsReportingSettings(body)", - "parameters": [ - { - "name": "body", - "type": "AnalyticsReportingSettings", - "required": "true" - } - ], - "return": "AnalyticsReportingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AnalyticsReportingSettings = new AnalyticsReportingSettings(...) // AnalyticsReportingSettingsRequest\n\n// Patch AnalyticsReportingSettings values for an organization\nPatchAnalyticsReportingSettingsRequest.patchAnalyticsReportingSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAnalyticsReportingSettingsRequest.patchAnalyticsReportingSettings was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsactionsaggregatesquery": { - "operationId": "postanalyticsactionsaggregatesquery", - "functionName": "postAnalyticsActionsAggregatesQuery", - "signature": "postAnalyticsActionsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "ActionAggregationQuery", - "required": "true" - } - ], - "return": "ActionAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ActionAggregationQuery = new ActionAggregationQuery(...) // query\n\n// Query for action aggregates\nPostAnalyticsActionsAggregatesQueryRequest.postAnalyticsActionsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsActionsAggregatesQueryRequest.postAnalyticsActionsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsbotsaggregatesquery": { - "operationId": "postanalyticsbotsaggregatesquery", - "functionName": "postAnalyticsBotsAggregatesQuery", - "signature": "postAnalyticsBotsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "BotAggregationQuery", - "required": "true" - } - ], - "return": "BotAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BotAggregationQuery = new BotAggregationQuery(...) // query\n\n// Query for bot aggregates\nPostAnalyticsBotsAggregatesQueryRequest.postAnalyticsBotsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsBotsAggregatesQueryRequest.postAnalyticsBotsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsconversationdetailsproperties": { - "operationId": "postanalyticsconversationdetailsproperties", - "functionName": "postAnalyticsConversationDetailsProperties", - "signature": "postAnalyticsConversationDetailsProperties(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PropertyIndexRequest", - "required": "true" - } - ], - "return": "PropertyIndexRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: PropertyIndexRequest = new PropertyIndexRequest(...) // request\n\n// Index conversation properties\nPostAnalyticsConversationDetailsPropertiesRequest.postAnalyticsConversationDetailsProperties(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsConversationDetailsPropertiesRequest.postAnalyticsConversationDetailsProperties was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsconversationsaggregatesquery": { - "operationId": "postanalyticsconversationsaggregatesquery", - "functionName": "postAnalyticsConversationsAggregatesQuery", - "signature": "postAnalyticsConversationsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationAggregationQuery", - "required": "true" - } - ], - "return": "ConversationAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationAggregationQuery = new ConversationAggregationQuery(...) // query\n\n// Query for conversation aggregates\nPostAnalyticsConversationsAggregatesQueryRequest.postAnalyticsConversationsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsConversationsAggregatesQueryRequest.postAnalyticsConversationsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsconversationsdetailsjobs": { - "operationId": "postanalyticsconversationsdetailsjobs", - "functionName": "postAnalyticsConversationsDetailsJobs", - "signature": "postAnalyticsConversationsDetailsJobs(body)", - "parameters": [ - { - "name": "body", - "type": "AsyncConversationQuery", - "required": "true" - } - ], - "return": "AsyncQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AsyncConversationQuery = new AsyncConversationQuery(...) // query\n\n// Query for conversation details asynchronously\nPostAnalyticsConversationsDetailsJobsRequest.postAnalyticsConversationsDetailsJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsConversationsDetailsJobsRequest.postAnalyticsConversationsDetailsJobs was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsconversationsdetailsquery": { - "operationId": "postanalyticsconversationsdetailsquery", - "functionName": "postAnalyticsConversationsDetailsQuery", - "signature": "postAnalyticsConversationsDetailsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationQuery", - "required": "true" - } - ], - "return": "AnalyticsConversationQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationQuery = new ConversationQuery(...) // query\n\n// Query for conversation details\nPostAnalyticsConversationsDetailsQueryRequest.postAnalyticsConversationsDetailsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsConversationsDetailsQueryRequest.postAnalyticsConversationsDetailsQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsconversationstranscriptsquery": { - "operationId": "postanalyticsconversationstranscriptsquery", - "functionName": "postAnalyticsConversationsTranscriptsQuery", - "signature": "postAnalyticsConversationsTranscriptsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "TranscriptConversationDetailSearchRequest", - "required": "true" - } - ], - "return": "AnalyticsConversationWithoutAttributesMultiGetResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TranscriptConversationDetailSearchRequest = new TranscriptConversationDetailSearchRequest(...) // Search request options\n\n// Search resources.\nPostAnalyticsConversationsTranscriptsQueryRequest.postAnalyticsConversationsTranscriptsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsConversationsTranscriptsQueryRequest.postAnalyticsConversationsTranscriptsQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsevaluationsaggregatesquery": { - "operationId": "postanalyticsevaluationsaggregatesquery", - "functionName": "postAnalyticsEvaluationsAggregatesQuery", - "signature": "postAnalyticsEvaluationsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "EvaluationAggregationQuery", - "required": "true" - } - ], - "return": "EvaluationAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EvaluationAggregationQuery = new EvaluationAggregationQuery(...) // query\n\n// Query for evaluation aggregates\nPostAnalyticsEvaluationsAggregatesQueryRequest.postAnalyticsEvaluationsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsEvaluationsAggregatesQueryRequest.postAnalyticsEvaluationsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsflowsaggregatesquery": { - "operationId": "postanalyticsflowsaggregatesquery", - "functionName": "postAnalyticsFlowsAggregatesQuery", - "signature": "postAnalyticsFlowsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "FlowAggregationQuery", - "required": "true" - } - ], - "return": "FlowAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FlowAggregationQuery = new FlowAggregationQuery(...) // query\n\n// Query for flow aggregates\nPostAnalyticsFlowsAggregatesQueryRequest.postAnalyticsFlowsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsFlowsAggregatesQueryRequest.postAnalyticsFlowsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsflowsobservationsquery": { - "operationId": "postanalyticsflowsobservationsquery", - "functionName": "postAnalyticsFlowsObservationsQuery", - "signature": "postAnalyticsFlowsObservationsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "FlowObservationQuery", - "required": "true" - } - ], - "return": "FlowObservationQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FlowObservationQuery = new FlowObservationQuery(...) // query\n\n// Query for flow observations\nPostAnalyticsFlowsObservationsQueryRequest.postAnalyticsFlowsObservationsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsFlowsObservationsQueryRequest.postAnalyticsFlowsObservationsQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsjourneysaggregatesquery": { - "operationId": "postanalyticsjourneysaggregatesquery", - "functionName": "postAnalyticsJourneysAggregatesQuery", - "signature": "postAnalyticsJourneysAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "JourneyAggregationQuery", - "required": "true" - } - ], - "return": "JourneyAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: JourneyAggregationQuery = new JourneyAggregationQuery(...) // query\n\n// Query for journey aggregates\nPostAnalyticsJourneysAggregatesQueryRequest.postAnalyticsJourneysAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsJourneysAggregatesQueryRequest.postAnalyticsJourneysAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsqueuesobservationsquery": { - "operationId": "postanalyticsqueuesobservationsquery", - "functionName": "postAnalyticsQueuesObservationsQuery", - "signature": "postAnalyticsQueuesObservationsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "QueueObservationQuery", - "required": "true" - } - ], - "return": "QueueObservationQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: QueueObservationQuery = new QueueObservationQuery(...) // query\n\n// Query for queue observations\nPostAnalyticsQueuesObservationsQueryRequest.postAnalyticsQueuesObservationsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsQueuesObservationsQueryRequest.postAnalyticsQueuesObservationsQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsreportingexports": { - "operationId": "postanalyticsreportingexports", - "functionName": "postAnalyticsReportingExports", - "signature": "postAnalyticsReportingExports(body)", - "parameters": [ - { - "name": "body", - "type": "ReportingExportJobRequest", - "required": "true" - } - ], - "return": "ReportingExportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ReportingExportJobRequest = new ReportingExportJobRequest(...) // ReportingExportJobRequest\n\n// Generate a view export request\nPostAnalyticsReportingExportsRequest.postAnalyticsReportingExports(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsReportingExportsRequest.postAnalyticsReportingExports was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsreportingschedulerunreport": { - "operationId": "postanalyticsreportingschedulerunreport", - "functionName": "postAnalyticsReportingScheduleRunreport", - "signature": "postAnalyticsReportingScheduleRunreport(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "RunNowResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Place a scheduled report immediately into the reporting queue\nPostAnalyticsReportingScheduleRunreportRequest.postAnalyticsReportingScheduleRunreport(scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsReportingScheduleRunreportRequest.postAnalyticsReportingScheduleRunreport was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsreportingschedules": { - "operationId": "postanalyticsreportingschedules", - "functionName": "postAnalyticsReportingSchedules", - "signature": "postAnalyticsReportingSchedules(body)", - "parameters": [ - { - "name": "body", - "type": "ReportSchedule", - "required": "true" - } - ], - "return": "ReportSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ReportSchedule = new ReportSchedule(...) // ReportSchedule\n\n// Create a scheduled report job\nPostAnalyticsReportingSchedulesRequest.postAnalyticsReportingSchedules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsReportingSchedulesRequest.postAnalyticsReportingSchedules was successful\")\n dump(response)\n }\n}" - }, - "postanalyticssurveysaggregatesquery": { - "operationId": "postanalyticssurveysaggregatesquery", - "functionName": "postAnalyticsSurveysAggregatesQuery", - "signature": "postAnalyticsSurveysAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "SurveyAggregationQuery", - "required": "true" - } - ], - "return": "SurveyAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SurveyAggregationQuery = new SurveyAggregationQuery(...) // query\n\n// Query for survey aggregates\nPostAnalyticsSurveysAggregatesQueryRequest.postAnalyticsSurveysAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsSurveysAggregatesQueryRequest.postAnalyticsSurveysAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticstranscriptsaggregatesquery": { - "operationId": "postanalyticstranscriptsaggregatesquery", - "functionName": "postAnalyticsTranscriptsAggregatesQuery", - "signature": "postAnalyticsTranscriptsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "TranscriptAggregationQuery", - "required": "true" - } - ], - "return": "TranscriptAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TranscriptAggregationQuery = new TranscriptAggregationQuery(...) // query\n\n// Query for transcript aggregates\nPostAnalyticsTranscriptsAggregatesQueryRequest.postAnalyticsTranscriptsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsTranscriptsAggregatesQueryRequest.postAnalyticsTranscriptsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsusersaggregatesquery": { - "operationId": "postanalyticsusersaggregatesquery", - "functionName": "postAnalyticsUsersAggregatesQuery", - "signature": "postAnalyticsUsersAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "UserAggregationQuery", - "required": "true" - } - ], - "return": "UserAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserAggregationQuery = new UserAggregationQuery(...) // query\n\n// Query for user aggregates\nPostAnalyticsUsersAggregatesQueryRequest.postAnalyticsUsersAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsUsersAggregatesQueryRequest.postAnalyticsUsersAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsusersdetailsjobs": { - "operationId": "postanalyticsusersdetailsjobs", - "functionName": "postAnalyticsUsersDetailsJobs", - "signature": "postAnalyticsUsersDetailsJobs(body)", - "parameters": [ - { - "name": "body", - "type": "AsyncUserDetailsQuery", - "required": "true" - } - ], - "return": "AsyncQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AsyncUserDetailsQuery = new AsyncUserDetailsQuery(...) // query\n\n// Query for user details asynchronously\nPostAnalyticsUsersDetailsJobsRequest.postAnalyticsUsersDetailsJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsUsersDetailsJobsRequest.postAnalyticsUsersDetailsJobs was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsusersdetailsquery": { - "operationId": "postanalyticsusersdetailsquery", - "functionName": "postAnalyticsUsersDetailsQuery", - "signature": "postAnalyticsUsersDetailsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "UserDetailsQuery", - "required": "true" - } - ], - "return": "AnalyticsUserDetailsQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserDetailsQuery = new UserDetailsQuery(...) // query\n\n// Query for user details\nPostAnalyticsUsersDetailsQueryRequest.postAnalyticsUsersDetailsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsUsersDetailsQueryRequest.postAnalyticsUsersDetailsQuery was successful\")\n dump(response)\n }\n}" - }, - "postanalyticsusersobservationsquery": { - "operationId": "postanalyticsusersobservationsquery", - "functionName": "postAnalyticsUsersObservationsQuery", - "signature": "postAnalyticsUsersObservationsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "UserObservationQuery", - "required": "true" - } - ], - "return": "UserObservationQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserObservationQuery = new UserObservationQuery(...) // query\n\n// Query for user observations\nPostAnalyticsUsersObservationsQueryRequest.postAnalyticsUsersObservationsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAnalyticsUsersObservationsQueryRequest.postAnalyticsUsersObservationsQuery was successful\")\n dump(response)\n }\n}" - }, - "putanalyticsdataretentionsettings": { - "operationId": "putanalyticsdataretentionsettings", - "functionName": "putAnalyticsDataretentionSettings", - "signature": "putAnalyticsDataretentionSettings(body)", - "parameters": [ - { - "name": "body", - "type": "UpdateAnalyticsDataRetentionRequest", - "required": "true" - } - ], - "return": "AnalyticsDataRetentionResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UpdateAnalyticsDataRetentionRequest = new UpdateAnalyticsDataRetentionRequest(...) // retentionDays\n\n// Update analytics data retention setting\nPutAnalyticsDataretentionSettingsRequest.putAnalyticsDataretentionSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAnalyticsDataretentionSettingsRequest.putAnalyticsDataretentionSettings was successful\")\n dump(response)\n }\n}" - }, - "putanalyticsreportingschedule": { - "operationId": "putanalyticsreportingschedule", - "functionName": "putAnalyticsReportingSchedule", - "signature": "putAnalyticsReportingSchedule(scheduleId, body)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ReportSchedule", - "required": "true" - } - ], - "return": "ReportSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\nlet body: ReportSchedule = new ReportSchedule(...) // ReportSchedule\n\n// Update a scheduled report job.\nPutAnalyticsReportingScheduleRequest.putAnalyticsReportingSchedule(scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAnalyticsReportingScheduleRequest.putAnalyticsReportingSchedule was successful\")\n dump(response)\n }\n}" - }, - "deletearchitectemergencygroup": { - "operationId": "deletearchitectemergencygroup", - "functionName": "deleteArchitectEmergencygroup", - "signature": "deleteArchitectEmergencygroup(emergencyGroupId)", - "parameters": [ - { - "name": "emergencyGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emergencyGroupId: String = \"\" // Emergency group ID\n\n// Deletes a emergency group by ID\nDeleteArchitectEmergencygroupRequest.deleteArchitectEmergencygroup(emergencyGroupId: emergencyGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectEmergencygroupRequest.deleteArchitectEmergencygroup was successful\")\n }\n}" - }, - "deletearchitectivr": { - "operationId": "deletearchitectivr", - "functionName": "deleteArchitectIvr", - "signature": "deleteArchitectIvr(ivrId)", - "parameters": [ - { - "name": "ivrId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ivrId: String = \"\" // IVR id\n\n// Delete an IVR Config.\nDeleteArchitectIvrRequest.deleteArchitectIvr(ivrId: ivrId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectIvrRequest.deleteArchitectIvr was successful\")\n }\n}" - }, - "deletearchitectprompt": { - "operationId": "deletearchitectprompt", - "functionName": "deleteArchitectPrompt", - "signature": "deleteArchitectPrompt(promptId, allResources)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "allResources", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet allResources: Bool = true // Whether or not to delete all the prompt resources\n\n// Delete specified user prompt\nDeleteArchitectPromptRequest.deleteArchitectPrompt(promptId: promptId, allResources: allResources) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectPromptRequest.deleteArchitectPrompt was successful\")\n }\n}" - }, - "deletearchitectpromptresource": { - "operationId": "deletearchitectpromptresource", - "functionName": "deleteArchitectPromptResource", - "signature": "deleteArchitectPromptResource(promptId, languageCode)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\n\n// Delete specified user prompt resource\nDeleteArchitectPromptResourceRequest.deleteArchitectPromptResource(promptId: promptId, languageCode: languageCode) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectPromptResourceRequest.deleteArchitectPromptResource was successful\")\n }\n}" - }, - "deletearchitectpromptresourceaudio": { - "operationId": "deletearchitectpromptresourceaudio", - "functionName": "deleteArchitectPromptResourceAudio", - "signature": "deleteArchitectPromptResourceAudio(promptId, languageCode)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\n\n// Delete specified user prompt resource audio\nDeleteArchitectPromptResourceAudioRequest.deleteArchitectPromptResourceAudio(promptId: promptId, languageCode: languageCode) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectPromptResourceAudioRequest.deleteArchitectPromptResourceAudio was successful\")\n }\n}" - }, - "deletearchitectprompts": { - "operationId": "deletearchitectprompts", - "functionName": "deleteArchitectPrompts", - "signature": "deleteArchitectPrompts(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // List of Prompt IDs\n\n// Batch-delete a list of prompts\nDeleteArchitectPromptsRequest.deleteArchitectPrompts(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteArchitectPromptsRequest.deleteArchitectPrompts was successful\")\n dump(response)\n }\n}" - }, - "deletearchitectschedule": { - "operationId": "deletearchitectschedule", - "functionName": "deleteArchitectSchedule", - "signature": "deleteArchitectSchedule(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Delete a schedule by id\nDeleteArchitectScheduleRequest.deleteArchitectSchedule(scheduleId: scheduleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectScheduleRequest.deleteArchitectSchedule was successful\")\n }\n}" - }, - "deletearchitectschedulegroup": { - "operationId": "deletearchitectschedulegroup", - "functionName": "deleteArchitectSchedulegroup", - "signature": "deleteArchitectSchedulegroup(scheduleGroupId)", - "parameters": [ - { - "name": "scheduleGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleGroupId: String = \"\" // Schedule group ID\n\n// Deletes a schedule group by ID\nDeleteArchitectSchedulegroupRequest.deleteArchitectSchedulegroup(scheduleGroupId: scheduleGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectSchedulegroupRequest.deleteArchitectSchedulegroup was successful\")\n }\n}" - }, - "deletearchitectsystempromptresource": { - "operationId": "deletearchitectsystempromptresource", - "functionName": "deleteArchitectSystempromptResource", - "signature": "deleteArchitectSystempromptResource(promptId, languageCode)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\n\n// Delete a system prompt resource override.\nDeleteArchitectSystempromptResourceRequest.deleteArchitectSystempromptResource(promptId: promptId, languageCode: languageCode) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteArchitectSystempromptResourceRequest.deleteArchitectSystempromptResource was successful\")\n }\n}" - }, - "deleteflow": { - "operationId": "deleteflow", - "functionName": "deleteFlow", - "signature": "deleteFlow(flowId)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\n\n// Delete flow\nDeleteFlowRequest.deleteFlow(flowId: flowId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteFlowRequest.deleteFlow was successful\")\n }\n}" - }, - "deleteflows": { - "operationId": "deleteflows", - "functionName": "deleteFlows", - "signature": "deleteFlows(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // List of Flow IDs\n\n// Batch-delete a list of flows\nDeleteFlowsRequest.deleteFlows(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteFlowsRequest.deleteFlows was successful\")\n dump(response)\n }\n}" - }, - "deleteflowsdatatable": { - "operationId": "deleteflowsdatatable", - "functionName": "deleteFlowsDatatable", - "signature": "deleteFlowsDatatable(datatableId, force)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "force", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet force: Bool = true // force delete, even if in use\n\n// deletes a specific datatable by id\nDeleteFlowsDatatableRequest.deleteFlowsDatatable(datatableId: datatableId, force: force) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteFlowsDatatableRequest.deleteFlowsDatatable was successful\")\n }\n}" - }, - "deleteflowsdatatablerow": { - "operationId": "deleteflowsdatatablerow", - "functionName": "deleteFlowsDatatableRow", - "signature": "deleteFlowsDatatableRow(datatableId, rowId)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "rowId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet rowId: String = \"\" // the key for the row\n\n// Delete a row entry\nDeleteFlowsDatatableRowRequest.deleteFlowsDatatableRow(datatableId: datatableId, rowId: rowId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteFlowsDatatableRowRequest.deleteFlowsDatatableRow was successful\")\n }\n}" - }, - "deleteflowsmilestone": { - "operationId": "deleteflowsmilestone", - "functionName": "deleteFlowsMilestone", - "signature": "deleteFlowsMilestone(milestoneId)", - "parameters": [ - { - "name": "milestoneId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet milestoneId: String = \"\" // flow milestone ID\n\n// Delete a flow milestone.\nDeleteFlowsMilestoneRequest.deleteFlowsMilestone(milestoneId: milestoneId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteFlowsMilestoneRequest.deleteFlowsMilestone was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytracking": { - "operationId": "getarchitectdependencytracking", - "functionName": "getArchitectDependencytracking", - "signature": "getArchitectDependencytracking(name, pageNumber, pageSize, objectType, consumedResources, consumingResources, consumedResourceType, consumingResourceType)", - "parameters": [ - { - "name": "name", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "objectType", - "type": "[String]", - "required": "false" - }, - { - "name": "consumedResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumingResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumedResourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "consumingResourceType", - "type": "[String]", - "required": "false" - } - ], - "return": "DependencyObjectEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet name: String = \"\" // Object name to search for\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet objectType: [String] = [\"\"] // Object type(s) to search for\nlet consumedResources: Bool = true // Include resources each result item consumes\nlet consumingResources: Bool = true // Include resources that consume each result item\nlet consumedResourceType: [String] = [\"\"] // Types of consumed resources to return, if consumed resources are requested\nlet consumingResourceType: [String] = [\"\"] // Types of consuming resources to return, if consuming resources are requested\n\n// Get Dependency Tracking objects that have a given display name\nGetArchitectDependencytrackingRequest.getArchitectDependencytracking(name: name, pageNumber: pageNumber, pageSize: pageSize, objectType: objectType, consumedResources: consumedResources, consumingResources: consumingResources, consumedResourceType: consumedResourceType, consumingResourceType: consumingResourceType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingRequest.getArchitectDependencytracking was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingbuild": { - "operationId": "getarchitectdependencytrackingbuild", - "functionName": "getArchitectDependencytrackingBuild", - "signature": "getArchitectDependencytrackingBuild()", - "return": "DependencyStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Dependency Tracking build status for an organization\nGetArchitectDependencytrackingBuildRequest.getArchitectDependencytrackingBuild() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingBuildRequest.getArchitectDependencytrackingBuild was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingconsumedresources": { - "operationId": "getarchitectdependencytrackingconsumedresources", - "functionName": "getArchitectDependencytrackingConsumedresources", - "signature": "getArchitectDependencytrackingConsumedresources(_id, version, objectType, resourceType, pageNumber, pageSize)", - "parameters": [ - { - "name": "_id", - "type": "String", - "required": "true" - }, - { - "name": "version", - "type": "String", - "required": "true" - }, - { - "name": "objectType", - "type": "String", - "required": "true" - }, - { - "name": "resourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ConsumedResourcesEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: String = \"\" // Consuming object ID\nlet version: String = \"\" // Consuming object version\nlet objectType: GetArchitectDependencytrackingConsumedresourcesRequest.ObjectType_getArchitectDependencytrackingConsumedresources = GetArchitectDependencytrackingConsumedresourcesRequest.ObjectType_getArchitectDependencytrackingConsumedresources.enummember // Consuming object type. Only versioned types are allowed here.\nlet resourceType: [String] = [\"\"] // Types of consumed resources to show\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get resources that are consumed by a given Dependency Tracking object\nGetArchitectDependencytrackingConsumedresourcesRequest.getArchitectDependencytrackingConsumedresources(_id: _id, version: version, objectType: objectType, resourceType: resourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingConsumedresourcesRequest.getArchitectDependencytrackingConsumedresources was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingconsumingresources": { - "operationId": "getarchitectdependencytrackingconsumingresources", - "functionName": "getArchitectDependencytrackingConsumingresources", - "signature": "getArchitectDependencytrackingConsumingresources(_id, objectType, resourceType, version, pageNumber, pageSize, flowFilter)", - "parameters": [ - { - "name": "_id", - "type": "String", - "required": "true" - }, - { - "name": "objectType", - "type": "String", - "required": "true" - }, - { - "name": "resourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "version", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "flowFilter", - "type": "String", - "required": "false" - } - ], - "return": "ConsumingResourcesEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: String = \"\" // Consumed object ID\nlet objectType: GetArchitectDependencytrackingConsumingresourcesRequest.ObjectType_getArchitectDependencytrackingConsumingresources = GetArchitectDependencytrackingConsumingresourcesRequest.ObjectType_getArchitectDependencytrackingConsumingresources.enummember // Consumed object type\nlet resourceType: [String] = [\"\"] // Types of consuming resources to show. Only versioned types are allowed here.\nlet version: String = \"\" // Object version\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet flowFilter: GetArchitectDependencytrackingConsumingresourcesRequest.FlowFilter_getArchitectDependencytrackingConsumingresources = GetArchitectDependencytrackingConsumingresourcesRequest.FlowFilter_getArchitectDependencytrackingConsumingresources.enummember // Show only checkedIn or published flows\n\n// Get resources that consume a given Dependency Tracking object\nGetArchitectDependencytrackingConsumingresourcesRequest.getArchitectDependencytrackingConsumingresources(_id: _id, objectType: objectType, resourceType: resourceType, version: version, pageNumber: pageNumber, pageSize: pageSize, flowFilter: flowFilter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingConsumingresourcesRequest.getArchitectDependencytrackingConsumingresources was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingdeletedresourceconsumers": { - "operationId": "getarchitectdependencytrackingdeletedresourceconsumers", - "functionName": "getArchitectDependencytrackingDeletedresourceconsumers", - "signature": "getArchitectDependencytrackingDeletedresourceconsumers(name, objectType, flowFilter, consumedResources, consumedResourceType, pageNumber, pageSize)", - "parameters": [ - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "objectType", - "type": "[String]", - "required": "false" - }, - { - "name": "flowFilter", - "type": "String", - "required": "false" - }, - { - "name": "consumedResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumedResourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DependencyObjectEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet name: String = \"\" // Name to search for\nlet objectType: [String] = [\"\"] // Object type(s) to search for\nlet flowFilter: GetArchitectDependencytrackingDeletedresourceconsumersRequest.FlowFilter_getArchitectDependencytrackingDeletedresourceconsumers = GetArchitectDependencytrackingDeletedresourceconsumersRequest.FlowFilter_getArchitectDependencytrackingDeletedresourceconsumers.enummember // Show only checkedIn or published flows\nlet consumedResources: Bool = true // Return consumed resources?\nlet consumedResourceType: [String] = [\"\"] // Resource type(s) to return\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get Dependency Tracking objects that consume deleted resources\nGetArchitectDependencytrackingDeletedresourceconsumersRequest.getArchitectDependencytrackingDeletedresourceconsumers(name: name, objectType: objectType, flowFilter: flowFilter, consumedResources: consumedResources, consumedResourceType: consumedResourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingDeletedresourceconsumersRequest.getArchitectDependencytrackingDeletedresourceconsumers was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingobject": { - "operationId": "getarchitectdependencytrackingobject", - "functionName": "getArchitectDependencytrackingObject", - "signature": "getArchitectDependencytrackingObject(_id, version, objectType, consumedResources, consumingResources, consumedResourceType, consumingResourceType, consumedResourceRequest)", - "parameters": [ - { - "name": "_id", - "type": "String", - "required": "true" - }, - { - "name": "version", - "type": "String", - "required": "false" - }, - { - "name": "objectType", - "type": "String", - "required": "false" - }, - { - "name": "consumedResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumingResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumedResourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "consumingResourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "consumedResourceRequest", - "type": "Bool", - "required": "false" - } - ], - "return": "DependencyObject", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: String = \"\" // Object ID\nlet version: String = \"\" // Object version\nlet objectType: GetArchitectDependencytrackingObjectRequest.ObjectType_getArchitectDependencytrackingObject = GetArchitectDependencytrackingObjectRequest.ObjectType_getArchitectDependencytrackingObject.enummember // Object type\nlet consumedResources: Bool = true // Include resources this item consumes\nlet consumingResources: Bool = true // Include resources that consume this item\nlet consumedResourceType: [String] = [\"\"] // Types of consumed resources to return, if consumed resources are requested\nlet consumingResourceType: [String] = [\"\"] // Types of consuming resources to return, if consuming resources are requested\nlet consumedResourceRequest: Bool = true // Indicate that this is going to look up a consumed resource object\n\n// Get a Dependency Tracking object\nGetArchitectDependencytrackingObjectRequest.getArchitectDependencytrackingObject(_id: _id, version: version, objectType: objectType, consumedResources: consumedResources, consumingResources: consumingResources, consumedResourceType: consumedResourceType, consumingResourceType: consumingResourceType, consumedResourceRequest: consumedResourceRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingObjectRequest.getArchitectDependencytrackingObject was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingtype": { - "operationId": "getarchitectdependencytrackingtype", - "functionName": "getArchitectDependencytrackingType", - "signature": "getArchitectDependencytrackingType(typeId)", - "parameters": [ - { - "name": "typeId", - "type": "String", - "required": "true" - } - ], - "return": "DependencyType", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet typeId: String = \"\" // Type ID\n\n// Get a Dependency Tracking type.\nGetArchitectDependencytrackingTypeRequest.getArchitectDependencytrackingType(typeId: typeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingTypeRequest.getArchitectDependencytrackingType was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingtypes": { - "operationId": "getarchitectdependencytrackingtypes", - "functionName": "getArchitectDependencytrackingTypes", - "signature": "getArchitectDependencytrackingTypes(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DependencyTypeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get Dependency Tracking types.\nGetArchitectDependencytrackingTypesRequest.getArchitectDependencytrackingTypes(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingTypesRequest.getArchitectDependencytrackingTypes was successful\")\n dump(response)\n }\n}" - }, - "getarchitectdependencytrackingupdatedresourceconsumers": { - "operationId": "getarchitectdependencytrackingupdatedresourceconsumers", - "functionName": "getArchitectDependencytrackingUpdatedresourceconsumers", - "signature": "getArchitectDependencytrackingUpdatedresourceconsumers(name, objectType, consumedResources, consumedResourceType, pageNumber, pageSize)", - "parameters": [ - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "objectType", - "type": "[String]", - "required": "false" - }, - { - "name": "consumedResources", - "type": "Bool", - "required": "false" - }, - { - "name": "consumedResourceType", - "type": "[String]", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DependencyObjectEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet name: String = \"\" // Name to search for\nlet objectType: [String] = [\"\"] // Object type(s) to search for\nlet consumedResources: Bool = true // Return consumed resources?\nlet consumedResourceType: [String] = [\"\"] // Resource type(s) to return\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get Dependency Tracking objects that depend on updated resources\nGetArchitectDependencytrackingUpdatedresourceconsumersRequest.getArchitectDependencytrackingUpdatedresourceconsumers(name: name, objectType: objectType, consumedResources: consumedResources, consumedResourceType: consumedResourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectDependencytrackingUpdatedresourceconsumersRequest.getArchitectDependencytrackingUpdatedresourceconsumers was successful\")\n dump(response)\n }\n}" - }, - "getarchitectemergencygroup": { - "operationId": "getarchitectemergencygroup", - "functionName": "getArchitectEmergencygroup", - "signature": "getArchitectEmergencygroup(emergencyGroupId)", - "parameters": [ - { - "name": "emergencyGroupId", - "type": "String", - "required": "true" - } - ], - "return": "EmergencyGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emergencyGroupId: String = \"\" // Emergency group ID\n\n// Gets a emergency group by ID\nGetArchitectEmergencygroupRequest.getArchitectEmergencygroup(emergencyGroupId: emergencyGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectEmergencygroupRequest.getArchitectEmergencygroup was successful\")\n dump(response)\n }\n}" - }, - "getarchitectemergencygroups": { - "operationId": "getarchitectemergencygroups", - "functionName": "getArchitectEmergencygroups", - "signature": "getArchitectEmergencygroups(pageNumber, pageSize, sortBy, sortOrder, name)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "EmergencyGroupListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name of the Emergency Group to filter by.\n\n// Get a list of emergency groups.\nGetArchitectEmergencygroupsRequest.getArchitectEmergencygroups(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectEmergencygroupsRequest.getArchitectEmergencygroups was successful\")\n dump(response)\n }\n}" - }, - "getarchitectemergencygroupsdivisionviews": { - "operationId": "getarchitectemergencygroupsdivisionviews", - "functionName": "getArchitectEmergencygroupsDivisionviews", - "signature": "getArchitectEmergencygroupsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "EmergencyGroupDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID of the Emergency Groups to filter by.\nlet name: String = \"\" // Name of the Emergency Group to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a pageable list of basic emergency group objects filterable by query parameters.\nGetArchitectEmergencygroupsDivisionviewsRequest.getArchitectEmergencygroupsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectEmergencygroupsDivisionviewsRequest.getArchitectEmergencygroupsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getarchitectivr": { - "operationId": "getarchitectivr", - "functionName": "getArchitectIvr", - "signature": "getArchitectIvr(ivrId)", - "parameters": [ - { - "name": "ivrId", - "type": "String", - "required": "true" - } - ], - "return": "IVR", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ivrId: String = \"\" // IVR id\n\n// Get an IVR config.\nGetArchitectIvrRequest.getArchitectIvr(ivrId: ivrId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectIvrRequest.getArchitectIvr was successful\")\n dump(response)\n }\n}" - }, - "getarchitectivrs": { - "operationId": "getarchitectivrs", - "functionName": "getArchitectIvrs", - "signature": "getArchitectIvrs(pageNumber, pageSize, sortBy, sortOrder, name, dnis, scheduleGroup)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "dnis", - "type": "String", - "required": "false" - }, - { - "name": "scheduleGroup", - "type": "String", - "required": "false" - } - ], - "return": "IVREntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name of the IVR to filter by.\nlet dnis: String = \"\" // The phone number of the IVR to filter by.\nlet scheduleGroup: String = \"\" // The Schedule Group of the IVR to filter by.\n\n// Get IVR configs.\nGetArchitectIvrsRequest.getArchitectIvrs(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, dnis: dnis, scheduleGroup: scheduleGroup) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectIvrsRequest.getArchitectIvrs was successful\")\n dump(response)\n }\n}" - }, - "getarchitectivrsdivisionviews": { - "operationId": "getarchitectivrsdivisionviews", - "functionName": "getArchitectIvrsDivisionviews", - "signature": "getArchitectIvrsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "IVRDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID of the IVR to filter by.\nlet name: String = \"\" // Name of the IVR to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a pageable list of basic ivr configuration information objects filterable by query parameters.\nGetArchitectIvrsDivisionviewsRequest.getArchitectIvrsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectIvrsDivisionviewsRequest.getArchitectIvrsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getarchitectprompt": { - "operationId": "getarchitectprompt", - "functionName": "getArchitectPrompt", - "signature": "getArchitectPrompt(promptId)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - } - ], - "return": "Prompt", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\n\n// Get specified user prompt\nGetArchitectPromptRequest.getArchitectPrompt(promptId: promptId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectPromptRequest.getArchitectPrompt was successful\")\n dump(response)\n }\n}" - }, - "getarchitectprompthistoryhistoryid": { - "operationId": "getarchitectprompthistoryhistoryid", - "functionName": "getArchitectPromptHistoryHistoryId", - "signature": "getArchitectPromptHistoryHistoryId(promptId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "historyId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "action", - "type": "[String]", - "required": "false" - } - ], - "return": "HistoryListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet historyId: String = \"\" // History request ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortOrder: String = \"\" // Sort order\nlet sortBy: GetArchitectPromptHistoryHistoryIdRequest.SortBy_getArchitectPromptHistoryHistoryId = GetArchitectPromptHistoryHistoryIdRequest.SortBy_getArchitectPromptHistoryHistoryId.enummember // Sort by\nlet action: [String] = [\"\"] // Flow actions to include (omit to include all)\n\n// Get generated prompt history\nGetArchitectPromptHistoryHistoryIdRequest.getArchitectPromptHistoryHistoryId(promptId: promptId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectPromptHistoryHistoryIdRequest.getArchitectPromptHistoryHistoryId was successful\")\n dump(response)\n }\n}" - }, - "getarchitectpromptresource": { - "operationId": "getarchitectpromptresource", - "functionName": "getArchitectPromptResource", - "signature": "getArchitectPromptResource(promptId, languageCode)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "PromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\n\n// Get specified user prompt resource\nGetArchitectPromptResourceRequest.getArchitectPromptResource(promptId: promptId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectPromptResourceRequest.getArchitectPromptResource was successful\")\n dump(response)\n }\n}" - }, - "getarchitectpromptresources": { - "operationId": "getarchitectpromptresources", - "functionName": "getArchitectPromptResources", - "signature": "getArchitectPromptResources(promptId, pageNumber, pageSize)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "PromptAssetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a pageable list of user prompt resources\nGetArchitectPromptResourcesRequest.getArchitectPromptResources(promptId: promptId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectPromptResourcesRequest.getArchitectPromptResources was successful\")\n dump(response)\n }\n}" - }, - "getarchitectprompts": { - "operationId": "getarchitectprompts", - "functionName": "getArchitectPrompts", - "signature": "getArchitectPrompts(pageNumber, pageSize, name, _description, nameOrDescription, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "[String]", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "nameOrDescription", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "PromptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet name: [String] = [\"\"] // Name\nlet _description: String = \"\" // Description\nlet nameOrDescription: String = \"\" // Name or description\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\n\n// Get a pageable list of user prompts\nGetArchitectPromptsRequest.getArchitectPrompts(pageNumber: pageNumber, pageSize: pageSize, name: name, _description: _description, nameOrDescription: nameOrDescription, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectPromptsRequest.getArchitectPrompts was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedule": { - "operationId": "getarchitectschedule", - "functionName": "getArchitectSchedule", - "signature": "getArchitectSchedule(scheduleId)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "Schedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\n\n// Get a schedule by ID\nGetArchitectScheduleRequest.getArchitectSchedule(scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectScheduleRequest.getArchitectSchedule was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedulegroup": { - "operationId": "getarchitectschedulegroup", - "functionName": "getArchitectSchedulegroup", - "signature": "getArchitectSchedulegroup(scheduleGroupId)", - "parameters": [ - { - "name": "scheduleGroupId", - "type": "String", - "required": "true" - } - ], - "return": "ScheduleGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleGroupId: String = \"\" // Schedule group ID\n\n// Gets a schedule group by ID\nGetArchitectSchedulegroupRequest.getArchitectSchedulegroup(scheduleGroupId: scheduleGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSchedulegroupRequest.getArchitectSchedulegroup was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedulegroups": { - "operationId": "getarchitectschedulegroups", - "functionName": "getArchitectSchedulegroups", - "signature": "getArchitectSchedulegroups(pageNumber, pageSize, sortBy, sortOrder, name, scheduleIds, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "scheduleIds", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "ScheduleGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name of the Schedule Group to filter by.\nlet scheduleIds: String = \"\" // A comma-delimited list of Schedule IDs to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a list of schedule groups.\nGetArchitectSchedulegroupsRequest.getArchitectSchedulegroups(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, scheduleIds: scheduleIds, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSchedulegroupsRequest.getArchitectSchedulegroups was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedulegroupsdivisionviews": { - "operationId": "getarchitectschedulegroupsdivisionviews", - "functionName": "getArchitectSchedulegroupsDivisionviews", - "signature": "getArchitectSchedulegroupsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "ScheduleGroupDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID of the schedule group to filter by.\nlet name: String = \"\" // Name of the schedule group to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a pageable list of basic schedule group configuration information objects filterable by query parameters.\nGetArchitectSchedulegroupsDivisionviewsRequest.getArchitectSchedulegroupsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSchedulegroupsDivisionviewsRequest.getArchitectSchedulegroupsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedules": { - "operationId": "getarchitectschedules", - "functionName": "getArchitectSchedules", - "signature": "getArchitectSchedules(pageNumber, pageSize, sortBy, sortOrder, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "ScheduleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name of the Schedule to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a list of schedules.\nGetArchitectSchedulesRequest.getArchitectSchedules(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSchedulesRequest.getArchitectSchedules was successful\")\n dump(response)\n }\n}" - }, - "getarchitectschedulesdivisionviews": { - "operationId": "getarchitectschedulesdivisionviews", - "functionName": "getArchitectSchedulesDivisionviews", - "signature": "getArchitectSchedulesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "ScheduleDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID of the schedule group to filter by.\nlet name: String = \"\" // Name of the schedule group to filter by.\nlet divisionId: [String] = [\"\"] // List of divisionIds on which to filter.\n\n// Get a pageable list of basic schedule configuration information objects filterable by query parameters.\nGetArchitectSchedulesDivisionviewsRequest.getArchitectSchedulesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSchedulesDivisionviewsRequest.getArchitectSchedulesDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getarchitectsystemprompt": { - "operationId": "getarchitectsystemprompt", - "functionName": "getArchitectSystemprompt", - "signature": "getArchitectSystemprompt(promptId)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - } - ], - "return": "SystemPrompt", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // promptId\n\n// Get a system prompt\nGetArchitectSystempromptRequest.getArchitectSystemprompt(promptId: promptId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSystempromptRequest.getArchitectSystemprompt was successful\")\n dump(response)\n }\n}" - }, - "getarchitectsystemprompthistoryhistoryid": { - "operationId": "getarchitectsystemprompthistoryhistoryid", - "functionName": "getArchitectSystempromptHistoryHistoryId", - "signature": "getArchitectSystempromptHistoryHistoryId(promptId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "historyId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "action", - "type": "[String]", - "required": "false" - } - ], - "return": "HistoryListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // promptId\nlet historyId: String = \"\" // History request ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortOrder: String = \"\" // Sort order\nlet sortBy: GetArchitectSystempromptHistoryHistoryIdRequest.SortBy_getArchitectSystempromptHistoryHistoryId = GetArchitectSystempromptHistoryHistoryIdRequest.SortBy_getArchitectSystempromptHistoryHistoryId.enummember // Sort by\nlet action: [String] = [\"\"] // Flow actions to include (omit to include all)\n\n// Get generated prompt history\nGetArchitectSystempromptHistoryHistoryIdRequest.getArchitectSystempromptHistoryHistoryId(promptId: promptId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSystempromptHistoryHistoryIdRequest.getArchitectSystempromptHistoryHistoryId was successful\")\n dump(response)\n }\n}" - }, - "getarchitectsystempromptresource": { - "operationId": "getarchitectsystempromptresource", - "functionName": "getArchitectSystempromptResource", - "signature": "getArchitectSystempromptResource(promptId, languageCode)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "SystemPromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\n\n// Get a system prompt resource.\nGetArchitectSystempromptResourceRequest.getArchitectSystempromptResource(promptId: promptId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSystempromptResourceRequest.getArchitectSystempromptResource was successful\")\n dump(response)\n }\n}" - }, - "getarchitectsystempromptresources": { - "operationId": "getarchitectsystempromptresources", - "functionName": "getArchitectSystempromptResources", - "signature": "getArchitectSystempromptResources(promptId, pageNumber, pageSize, sortBy, sortOrder)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "SystemPromptAssetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\n\n// Get system prompt resources.\nGetArchitectSystempromptResourcesRequest.getArchitectSystempromptResources(promptId: promptId, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSystempromptResourcesRequest.getArchitectSystempromptResources was successful\")\n dump(response)\n }\n}" - }, - "getarchitectsystemprompts": { - "operationId": "getarchitectsystemprompts", - "functionName": "getArchitectSystemprompts", - "signature": "getArchitectSystemprompts(pageNumber, pageSize, sortBy, sortOrder, name, _description, nameOrDescription)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "nameOrDescription", - "type": "String", - "required": "false" - } - ], - "return": "SystemPromptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name\nlet _description: String = \"\" // Description\nlet nameOrDescription: String = \"\" // Name or description\n\n// Get System Prompts\nGetArchitectSystempromptsRequest.getArchitectSystemprompts(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, _description: _description, nameOrDescription: nameOrDescription) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetArchitectSystempromptsRequest.getArchitectSystemprompts was successful\")\n dump(response)\n }\n}" - }, - "getflow": { - "operationId": "getflow", - "functionName": "getFlow", - "signature": "getFlow(flowId, deleted)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "deleted", - "type": "Bool", - "required": "false" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet deleted: Bool = true // Deleted flows\n\n// Get flow\nGetFlowRequest.getFlow(flowId: flowId, deleted: deleted) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowRequest.getFlow was successful\")\n dump(response)\n }\n}" - }, - "getflowhistoryhistoryid": { - "operationId": "getflowhistoryhistoryid", - "functionName": "getFlowHistoryHistoryId", - "signature": "getFlowHistoryHistoryId(flowId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "historyId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "action", - "type": "[String]", - "required": "false" - } - ], - "return": "HistoryListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet historyId: String = \"\" // History request ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortOrder: String = \"\" // Sort order\nlet sortBy: GetFlowHistoryHistoryIdRequest.SortBy_getFlowHistoryHistoryId = GetFlowHistoryHistoryIdRequest.SortBy_getFlowHistoryHistoryId.enummember // Sort by\nlet action: [String] = [\"\"] // Flow actions to include (omit to include all)\n\n// Get generated flow history\nGetFlowHistoryHistoryIdRequest.getFlowHistoryHistoryId(flowId: flowId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowHistoryHistoryIdRequest.getFlowHistoryHistoryId was successful\")\n dump(response)\n }\n}" - }, - "getflowlatestconfiguration": { - "operationId": "getflowlatestconfiguration", - "functionName": "getFlowLatestconfiguration", - "signature": "getFlowLatestconfiguration(flowId, deleted)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "deleted", - "type": "Bool", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet deleted: Bool = true // Deleted flows\n\n// Get the latest configuration for flow\nGetFlowLatestconfigurationRequest.getFlowLatestconfiguration(flowId: flowId, deleted: deleted) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowLatestconfigurationRequest.getFlowLatestconfiguration was successful\")\n dump(response)\n }\n}" - }, - "getflowversion": { - "operationId": "getflowversion", - "functionName": "getFlowVersion", - "signature": "getFlowVersion(flowId, versionId, deleted)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "deleted", - "type": "String", - "required": "false" - } - ], - "return": "FlowVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet versionId: String = \"\" // Version ID\nlet deleted: String = \"\" // Deleted flows\n\n// Get flow version\nGetFlowVersionRequest.getFlowVersion(flowId: flowId, versionId: versionId, deleted: deleted) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionRequest.getFlowVersion was successful\")\n dump(response)\n }\n}" - }, - "getflowversionconfiguration": { - "operationId": "getflowversionconfiguration", - "functionName": "getFlowVersionConfiguration", - "signature": "getFlowVersionConfiguration(flowId, versionId, deleted)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "deleted", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet versionId: String = \"\" // Version ID\nlet deleted: String = \"\" // Deleted flows\n\n// Create flow version configuration\nGetFlowVersionConfigurationRequest.getFlowVersionConfiguration(flowId: flowId, versionId: versionId, deleted: deleted) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionConfigurationRequest.getFlowVersionConfiguration was successful\")\n dump(response)\n }\n}" - }, - "getflowversionhealth": { - "operationId": "getflowversionhealth", - "functionName": "getFlowVersionHealth", - "signature": "getFlowVersionHealth(flowId, versionId, language)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "language", - "type": "String", - "required": "false" - } - ], - "return": "FlowHealth", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID.\nlet versionId: String = \"\" // Version ID.\nlet language: GetFlowVersionHealthRequest.Language_getFlowVersionHealth = GetFlowVersionHealthRequest.Language_getFlowVersionHealth.enummember // Language to filter for\n\n// Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.\nGetFlowVersionHealthRequest.getFlowVersionHealth(flowId: flowId, versionId: versionId, language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionHealthRequest.getFlowVersionHealth was successful\")\n dump(response)\n }\n}" - }, - "getflowversionintenthealth": { - "operationId": "getflowversionintenthealth", - "functionName": "getFlowVersionIntentHealth", - "signature": "getFlowVersionIntentHealth(flowId, versionId, intentId, language)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "intentId", - "type": "String", - "required": "true" - }, - { - "name": "language", - "type": "String", - "required": "true" - } - ], - "return": "FlowHealthIntent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID.\nlet versionId: String = \"\" // Version ID.\nlet intentId: String = \"\" // Intent ID.\nlet language: GetFlowVersionIntentHealthRequest.Language_getFlowVersionIntentHealth = GetFlowVersionIntentHealthRequest.Language_getFlowVersionIntentHealth.enummember // Language to filter for\n\n// Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.\nGetFlowVersionIntentHealthRequest.getFlowVersionIntentHealth(flowId: flowId, versionId: versionId, intentId: intentId, language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionIntentHealthRequest.getFlowVersionIntentHealth was successful\")\n dump(response)\n }\n}" - }, - "getflowversionintentutterancehealth": { - "operationId": "getflowversionintentutterancehealth", - "functionName": "getFlowVersionIntentUtteranceHealth", - "signature": "getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "intentId", - "type": "String", - "required": "true" - }, - { - "name": "utteranceId", - "type": "String", - "required": "true" - }, - { - "name": "language", - "type": "String", - "required": "true" - } - ], - "return": "FlowHealthUtterance", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID.\nlet versionId: String = \"\" // Version ID.\nlet intentId: String = \"\" // Intent ID.\nlet utteranceId: String = \"\" // Utterance ID.\nlet language: GetFlowVersionIntentUtteranceHealthRequest.Language_getFlowVersionIntentUtteranceHealth = GetFlowVersionIntentUtteranceHealthRequest.Language_getFlowVersionIntentUtteranceHealth.enummember // Language to filter for\n\n// Get health metrics associated with a specific utterance of an intent.\nGetFlowVersionIntentUtteranceHealthRequest.getFlowVersionIntentUtteranceHealth(flowId: flowId, versionId: versionId, intentId: intentId, utteranceId: utteranceId, language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionIntentUtteranceHealthRequest.getFlowVersionIntentUtteranceHealth was successful\")\n dump(response)\n }\n}" - }, - "getflowversions": { - "operationId": "getflowversions", - "functionName": "getFlowVersions", - "signature": "getFlowVersions(flowId, pageNumber, pageSize, deleted)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "deleted", - "type": "Bool", - "required": "false" - } - ], - "return": "FlowVersionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet deleted: Bool = true // Include Deleted flows\n\n// Get flow version list\nGetFlowVersionsRequest.getFlowVersions(flowId: flowId, pageNumber: pageNumber, pageSize: pageSize, deleted: deleted) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowVersionsRequest.getFlowVersions was successful\")\n dump(response)\n }\n}" - }, - "getflows": { - "operationId": "getflows", - "functionName": "getFlows", - "signature": "getFlows(type, pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, publishVersionId, editableBy, lockedBy, lockedByClientId, secure, deleted, includeSchemas, publishedAfter, publishedBefore, divisionId)", - "parameters": [ - { - "name": "type", - "type": "[String]", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "nameOrDescription", - "type": "String", - "required": "false" - }, - { - "name": "publishVersionId", - "type": "String", - "required": "false" - }, - { - "name": "editableBy", - "type": "String", - "required": "false" - }, - { - "name": "lockedBy", - "type": "String", - "required": "false" - }, - { - "name": "lockedByClientId", - "type": "String", - "required": "false" - }, - { - "name": "secure", - "type": "String", - "required": "false" - }, - { - "name": "deleted", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSchemas", - "type": "Bool", - "required": "false" - }, - { - "name": "publishedAfter", - "type": "String", - "required": "false" - }, - { - "name": "publishedBefore", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "FlowEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet type: [String] = [\"\"] // Type\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet _description: String = \"\" // Description\nlet nameOrDescription: String = \"\" // Name or description\nlet publishVersionId: String = \"\" // Publish version ID\nlet editableBy: String = \"\" // Editable by\nlet lockedBy: String = \"\" // Locked by\nlet lockedByClientId: String = \"\" // Locked by client ID\nlet secure: GetFlowsRequest.Secure_getFlows = GetFlowsRequest.Secure_getFlows.enummember // Secure\nlet deleted: Bool = true // Include deleted\nlet includeSchemas: Bool = true // Include variable schemas\nlet publishedAfter: String = 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 // Published after\nlet publishedBefore: String = 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 // Published before\nlet divisionId: [String] = [\"\"] // division ID(s)\n\n// Get a pageable list of flows, filtered by query parameters\nGetFlowsRequest.getFlows(type: type, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, publishVersionId: publishVersionId, editableBy: editableBy, lockedBy: lockedBy, lockedByClientId: lockedByClientId, secure: secure, deleted: deleted, includeSchemas: includeSchemas, publishedAfter: publishedAfter, publishedBefore: publishedBefore, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsRequest.getFlows was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatable": { - "operationId": "getflowsdatatable", - "functionName": "getFlowsDatatable", - "signature": "getFlowsDatatable(datatableId, expand)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "DataTable", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet expand: GetFlowsDatatableRequest.Expand_getFlowsDatatable = GetFlowsDatatableRequest.Expand_getFlowsDatatable.enummember // Expand instructions for the result\n\n// Returns a specific datatable by id\nGetFlowsDatatableRequest.getFlowsDatatable(datatableId: datatableId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableRequest.getFlowsDatatable was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatableexportjob": { - "operationId": "getflowsdatatableexportjob", - "functionName": "getFlowsDatatableExportJob", - "signature": "getFlowsDatatableExportJob(datatableId, exportJobId)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "exportJobId", - "type": "String", - "required": "true" - } - ], - "return": "DataTableExportJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet exportJobId: String = \"\" // id of export job\n\n// Returns the state information about an export job\nGetFlowsDatatableExportJobRequest.getFlowsDatatableExportJob(datatableId: datatableId, exportJobId: exportJobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableExportJobRequest.getFlowsDatatableExportJob was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatableimportjob": { - "operationId": "getflowsdatatableimportjob", - "functionName": "getFlowsDatatableImportJob", - "signature": "getFlowsDatatableImportJob(datatableId, importJobId)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "importJobId", - "type": "String", - "required": "true" - } - ], - "return": "DataTableImportJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet importJobId: String = \"\" // id of import job\n\n// Returns the state information about an import job\nGetFlowsDatatableImportJobRequest.getFlowsDatatableImportJob(datatableId: datatableId, importJobId: importJobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableImportJobRequest.getFlowsDatatableImportJob was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatableimportjobs": { - "operationId": "getflowsdatatableimportjobs", - "functionName": "getFlowsDatatableImportJobs", - "signature": "getFlowsDatatableImportJobs(datatableId, pageNumber, pageSize)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DataTableImportEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get all recent import jobs\nGetFlowsDatatableImportJobsRequest.getFlowsDatatableImportJobs(datatableId: datatableId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableImportJobsRequest.getFlowsDatatableImportJobs was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatablerow": { - "operationId": "getflowsdatatablerow", - "functionName": "getFlowsDatatableRow", - "signature": "getFlowsDatatableRow(datatableId, rowId, showbrief)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "rowId", - "type": "String", - "required": "true" - }, - { - "name": "showbrief", - "type": "Bool", - "required": "false" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet rowId: String = \"\" // The key for the row\nlet showbrief: Bool = true // if true returns just the key field for the row\n\n// Returns a specific row for the datatable\nGetFlowsDatatableRowRequest.getFlowsDatatableRow(datatableId: datatableId, rowId: rowId, showbrief: showbrief) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableRowRequest.getFlowsDatatableRow was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatablerows": { - "operationId": "getflowsdatatablerows", - "functionName": "getFlowsDatatableRows", - "signature": "getFlowsDatatableRows(datatableId, pageNumber, pageSize, showbrief, sortOrder)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "showbrief", - "type": "Bool", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DataTableRowEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet showbrief: Bool = true // If true returns just the key value of the row\nlet sortOrder: GetFlowsDatatableRowsRequest.SortOrder_getFlowsDatatableRows = GetFlowsDatatableRowsRequest.SortOrder_getFlowsDatatableRows.enummember // Sort order\n\n// Returns the rows for the datatable with the given id\nGetFlowsDatatableRowsRequest.getFlowsDatatableRows(datatableId: datatableId, pageNumber: pageNumber, pageSize: pageSize, showbrief: showbrief, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatableRowsRequest.getFlowsDatatableRows was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatables": { - "operationId": "getflowsdatatables", - "functionName": "getFlowsDatatables", - "signature": "getFlowsDatatables(expand, pageNumber, pageSize, sortBy, sortOrder, divisionId, name)", - "parameters": [ - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "DataTablesDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: GetFlowsDatatablesRequest.Expand_getFlowsDatatables = GetFlowsDatatablesRequest.Expand_getFlowsDatatables.enummember // Expand instructions for the result\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: GetFlowsDatatablesRequest.SortBy_getFlowsDatatables = GetFlowsDatatablesRequest.SortBy_getFlowsDatatables.enummember // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet divisionId: [String] = [\"\"] // division ID(s)\nlet name: String = exactMatch, beginsWith*, *endsWith, *contains* // Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.\n\n// Retrieve a list of datatables for the org\nGetFlowsDatatablesRequest.getFlowsDatatables(expand: expand, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, divisionId: divisionId, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatablesRequest.getFlowsDatatables was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatablesdivisionview": { - "operationId": "getflowsdatatablesdivisionview", - "functionName": "getFlowsDatatablesDivisionview", - "signature": "getFlowsDatatablesDivisionview(datatableId, expand)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "DataTable", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet expand: GetFlowsDatatablesDivisionviewRequest.Expand_getFlowsDatatablesDivisionview = GetFlowsDatatablesDivisionviewRequest.Expand_getFlowsDatatablesDivisionview.enummember // Expand instructions for the result\n\n// Returns a specific datatable by id\nGetFlowsDatatablesDivisionviewRequest.getFlowsDatatablesDivisionview(datatableId: datatableId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatablesDivisionviewRequest.getFlowsDatatablesDivisionview was successful\")\n dump(response)\n }\n}" - }, - "getflowsdatatablesdivisionviews": { - "operationId": "getflowsdatatablesdivisionviews", - "functionName": "getFlowsDatatablesDivisionviews", - "signature": "getFlowsDatatablesDivisionviews(expand, pageNumber, pageSize, sortBy, sortOrder, divisionId, name)", - "parameters": [ - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "DataTablesDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: GetFlowsDatatablesDivisionviewsRequest.Expand_getFlowsDatatablesDivisionviews = GetFlowsDatatablesDivisionviewsRequest.Expand_getFlowsDatatablesDivisionviews.enummember // Expand instructions for the result\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: GetFlowsDatatablesDivisionviewsRequest.SortBy_getFlowsDatatablesDivisionviews = GetFlowsDatatablesDivisionviewsRequest.SortBy_getFlowsDatatablesDivisionviews.enummember // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet divisionId: [String] = [\"\"] // division ID(s)\nlet name: String = exactMatch, beginsWith*, *endsWith, *contains* // Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.\n\n// Retrieve a list of datatables for the org\nGetFlowsDatatablesDivisionviewsRequest.getFlowsDatatablesDivisionviews(expand: expand, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, divisionId: divisionId, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDatatablesDivisionviewsRequest.getFlowsDatatablesDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getflowsdivisionviews": { - "operationId": "getflowsdivisionviews", - "functionName": "getFlowsDivisionviews", - "signature": "getFlowsDivisionviews(type, pageNumber, pageSize, sortBy, sortOrder, _id, name, publishVersionId, publishedAfter, publishedBefore, divisionId, includeSchemas)", - "parameters": [ - { - "name": "type", - "type": "[String]", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "publishVersionId", - "type": "String", - "required": "false" - }, - { - "name": "publishedAfter", - "type": "String", - "required": "false" - }, - { - "name": "publishedBefore", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "includeSchemas", - "type": "Bool", - "required": "false" - } - ], - "return": "FlowDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet type: [String] = [\"\"] // Type\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet publishVersionId: String = \"\" // Publish version ID\nlet publishedAfter: String = 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 // Published after\nlet publishedBefore: String = 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 // Published before\nlet divisionId: [String] = [\"\"] // division ID(s)\nlet includeSchemas: Bool = true // Include variable schemas\n\n// Get a pageable list of basic flow information objects filterable by query parameters.\nGetFlowsDivisionviewsRequest.getFlowsDivisionviews(type: type, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, publishVersionId: publishVersionId, publishedAfter: publishedAfter, publishedBefore: publishedBefore, divisionId: divisionId, includeSchemas: includeSchemas) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsDivisionviewsRequest.getFlowsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getflowsexecution": { - "operationId": "getflowsexecution", - "functionName": "getFlowsExecution", - "signature": "getFlowsExecution(flowExecutionId)", - "parameters": [ - { - "name": "flowExecutionId", - "type": "String", - "required": "true" - } - ], - "return": "FlowRuntimeExecution", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowExecutionId: String = \"\" // flow execution ID\n\n// Get a flow execution's details. Flow execution details are available for several days after the flow is started.\nGetFlowsExecutionRequest.getFlowsExecution(flowExecutionId: flowExecutionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsExecutionRequest.getFlowsExecution was successful\")\n dump(response)\n }\n}" - }, - "getflowsjob": { - "operationId": "getflowsjob", - "functionName": "getFlowsJob", - "signature": "getFlowsJob(jobId, expand)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ArchitectJobStateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // Job ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Fetch Architect Job Status\nGetFlowsJobRequest.getFlowsJob(jobId: jobId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsJobRequest.getFlowsJob was successful\")\n dump(response)\n }\n}" - }, - "getflowsmilestone": { - "operationId": "getflowsmilestone", - "functionName": "getFlowsMilestone", - "signature": "getFlowsMilestone(milestoneId)", - "parameters": [ - { - "name": "milestoneId", - "type": "String", - "required": "true" - } - ], - "return": "FlowMilestone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet milestoneId: String = \"\" // flow milestone ID\n\n// Get a flow milestone\nGetFlowsMilestoneRequest.getFlowsMilestone(milestoneId: milestoneId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsMilestoneRequest.getFlowsMilestone was successful\")\n dump(response)\n }\n}" - }, - "getflowsmilestones": { - "operationId": "getflowsmilestones", - "functionName": "getFlowsMilestones", - "signature": "getFlowsMilestones(pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "nameOrDescription", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "FlowMilestoneListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet _description: String = \"\" // Description\nlet nameOrDescription: String = \"\" // Name or description\nlet divisionId: [String] = [\"\"] // division ID(s)\n\n// Get a pageable list of flow milestones, filtered by query parameters\nGetFlowsMilestonesRequest.getFlowsMilestones(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsMilestonesRequest.getFlowsMilestones was successful\")\n dump(response)\n }\n}" - }, - "getflowsmilestonesdivisionviews": { - "operationId": "getflowsmilestonesdivisionviews", - "functionName": "getFlowsMilestonesDivisionviews", - "signature": "getFlowsMilestonesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "FlowMilestoneDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet divisionId: [String] = [\"\"] // division ID(s)\n\n// Get a pageable list of basic flow milestone information objects filterable by query parameters.\nGetFlowsMilestonesDivisionviewsRequest.getFlowsMilestonesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsMilestonesDivisionviewsRequest.getFlowsMilestonesDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getflowsoutcome": { - "operationId": "getflowsoutcome", - "functionName": "getFlowsOutcome", - "signature": "getFlowsOutcome(flowOutcomeId)", - "parameters": [ - { - "name": "flowOutcomeId", - "type": "String", - "required": "true" - } - ], - "return": "FlowOutcome", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowOutcomeId: String = \"\" // flow outcome ID\n\n// Get a flow outcome\nGetFlowsOutcomeRequest.getFlowsOutcome(flowOutcomeId: flowOutcomeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsOutcomeRequest.getFlowsOutcome was successful\")\n dump(response)\n }\n}" - }, - "getflowsoutcomes": { - "operationId": "getflowsoutcomes", - "functionName": "getFlowsOutcomes", - "signature": "getFlowsOutcomes(pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "nameOrDescription", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "FlowOutcomeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet _description: String = \"\" // Description\nlet nameOrDescription: String = \"\" // Name or description\nlet divisionId: [String] = [\"\"] // division ID(s)\n\n// Get a pageable list of flow outcomes, filtered by query parameters\nGetFlowsOutcomesRequest.getFlowsOutcomes(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsOutcomesRequest.getFlowsOutcomes was successful\")\n dump(response)\n }\n}" - }, - "getflowsoutcomesdivisionviews": { - "operationId": "getflowsoutcomesdivisionviews", - "functionName": "getFlowsOutcomesDivisionviews", - "signature": "getFlowsOutcomesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "FlowOutcomeDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet _id: [String] = [\"\"] // ID\nlet name: String = \"\" // Name\nlet divisionId: [String] = [\"\"] // division ID(s)\n\n// Get a pageable list of basic flow outcome information objects filterable by query parameters.\nGetFlowsOutcomesDivisionviewsRequest.getFlowsOutcomesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFlowsOutcomesDivisionviewsRequest.getFlowsOutcomesDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "postarchitectdependencytrackingbuild": { - "operationId": "postarchitectdependencytrackingbuild", - "functionName": "postArchitectDependencytrackingBuild", - "signature": "postArchitectDependencytrackingBuild()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Rebuild Dependency Tracking data for an organization\nPostArchitectDependencytrackingBuildRequest.postArchitectDependencytrackingBuild() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostArchitectDependencytrackingBuildRequest.postArchitectDependencytrackingBuild was successful\")\n }\n}" - }, - "postarchitectemergencygroups": { - "operationId": "postarchitectemergencygroups", - "functionName": "postArchitectEmergencygroups", - "signature": "postArchitectEmergencygroups(body)", - "parameters": [ - { - "name": "body", - "type": "EmergencyGroup", - "required": "true" - } - ], - "return": "EmergencyGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EmergencyGroup = new EmergencyGroup(...) // \n\n// Creates a new emergency group\nPostArchitectEmergencygroupsRequest.postArchitectEmergencygroups(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectEmergencygroupsRequest.postArchitectEmergencygroups was successful\")\n dump(response)\n }\n}" - }, - "postarchitectivrs": { - "operationId": "postarchitectivrs", - "functionName": "postArchitectIvrs", - "signature": "postArchitectIvrs(body)", - "parameters": [ - { - "name": "body", - "type": "IVR", - "required": "true" - } - ], - "return": "IVR", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: IVR = new IVR(...) // \n\n// Create IVR config.\nPostArchitectIvrsRequest.postArchitectIvrs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectIvrsRequest.postArchitectIvrs was successful\")\n dump(response)\n }\n}" - }, - "postarchitectprompthistory": { - "operationId": "postarchitectprompthistory", - "functionName": "postArchitectPromptHistory", - "signature": "postArchitectPromptHistory(promptId)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\n\n// Generate prompt history\nPostArchitectPromptHistoryRequest.postArchitectPromptHistory(promptId: promptId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectPromptHistoryRequest.postArchitectPromptHistory was successful\")\n dump(response)\n }\n}" - }, - "postarchitectpromptresources": { - "operationId": "postarchitectpromptresources", - "functionName": "postArchitectPromptResources", - "signature": "postArchitectPromptResources(promptId, body)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PromptAssetCreate", - "required": "true" - } - ], - "return": "PromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet body: PromptAssetCreate = new PromptAssetCreate(...) // \n\n// Create a new user prompt resource\nPostArchitectPromptResourcesRequest.postArchitectPromptResources(promptId: promptId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectPromptResourcesRequest.postArchitectPromptResources was successful\")\n dump(response)\n }\n}" - }, - "postarchitectprompts": { - "operationId": "postarchitectprompts", - "functionName": "postArchitectPrompts", - "signature": "postArchitectPrompts(body)", - "parameters": [ - { - "name": "body", - "type": "Prompt", - "required": "true" - } - ], - "return": "Prompt", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Prompt = new Prompt(...) // \n\n// Create a new user prompt\nPostArchitectPromptsRequest.postArchitectPrompts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectPromptsRequest.postArchitectPrompts was successful\")\n dump(response)\n }\n}" - }, - "postarchitectschedulegroups": { - "operationId": "postarchitectschedulegroups", - "functionName": "postArchitectSchedulegroups", - "signature": "postArchitectSchedulegroups(body)", - "parameters": [ - { - "name": "body", - "type": "ScheduleGroup", - "required": "true" - } - ], - "return": "ScheduleGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ScheduleGroup = new ScheduleGroup(...) // \n\n// Creates a new schedule group\nPostArchitectSchedulegroupsRequest.postArchitectSchedulegroups(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectSchedulegroupsRequest.postArchitectSchedulegroups was successful\")\n dump(response)\n }\n}" - }, - "postarchitectschedules": { - "operationId": "postarchitectschedules", - "functionName": "postArchitectSchedules", - "signature": "postArchitectSchedules(body)", - "parameters": [ - { - "name": "body", - "type": "Schedule", - "required": "true" - } - ], - "return": "Schedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Schedule = new Schedule(...) // \n\n// Create a new schedule.\nPostArchitectSchedulesRequest.postArchitectSchedules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectSchedulesRequest.postArchitectSchedules was successful\")\n dump(response)\n }\n}" - }, - "postarchitectsystemprompthistory": { - "operationId": "postarchitectsystemprompthistory", - "functionName": "postArchitectSystempromptHistory", - "signature": "postArchitectSystempromptHistory(promptId)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // promptId\n\n// Generate system prompt history\nPostArchitectSystempromptHistoryRequest.postArchitectSystempromptHistory(promptId: promptId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectSystempromptHistoryRequest.postArchitectSystempromptHistory was successful\")\n dump(response)\n }\n}" - }, - "postarchitectsystempromptresources": { - "operationId": "postarchitectsystempromptresources", - "functionName": "postArchitectSystempromptResources", - "signature": "postArchitectSystempromptResources(promptId, body)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SystemPromptAsset", - "required": "true" - } - ], - "return": "SystemPromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet body: SystemPromptAsset = new SystemPromptAsset(...) // \n\n// Create system prompt resource override.\nPostArchitectSystempromptResourcesRequest.postArchitectSystempromptResources(promptId: promptId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostArchitectSystempromptResourcesRequest.postArchitectSystempromptResources was successful\")\n dump(response)\n }\n}" - }, - "postflowhistory": { - "operationId": "postflowhistory", - "functionName": "postFlowHistory", - "signature": "postFlowHistory(flowId)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\n\n// Generate flow history\nPostFlowHistoryRequest.postFlowHistory(flowId: flowId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowHistoryRequest.postFlowHistory was successful\")\n dump(response)\n }\n}" - }, - "postflowversions": { - "operationId": "postflowversions", - "functionName": "postFlowVersions", - "signature": "postFlowVersions(flowId, body)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String:JSON]", - "required": "true" - } - ], - "return": "FlowVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet body: [String:JSON] = new JSON(...) // \n\n// Create flow version\nPostFlowVersionsRequest.postFlowVersions(flowId: flowId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowVersionsRequest.postFlowVersions was successful\")\n dump(response)\n }\n}" - }, - "postflows": { - "operationId": "postflows", - "functionName": "postFlows", - "signature": "postFlows(body, language)", - "parameters": [ - { - "name": "body", - "type": "Flow", - "required": "true" - }, - { - "name": "language", - "type": "String", - "required": "false" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Flow = new Flow(...) // \nlet language: String = \"\" // Language\n\n// Create flow\nPostFlowsRequest.postFlows(body: body, language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsRequest.postFlows was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionscheckin": { - "operationId": "postflowsactionscheckin", - "functionName": "postFlowsActionsCheckin", - "signature": "postFlowsActionsCheckin(flow)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\n\n// Check-in flow\nPostFlowsActionsCheckinRequest.postFlowsActionsCheckin(flow: flow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsCheckinRequest.postFlowsActionsCheckin was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionscheckout": { - "operationId": "postflowsactionscheckout", - "functionName": "postFlowsActionsCheckout", - "signature": "postFlowsActionsCheckout(flow)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\n\n// Check-out flow\nPostFlowsActionsCheckoutRequest.postFlowsActionsCheckout(flow: flow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsCheckoutRequest.postFlowsActionsCheckout was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionsdeactivate": { - "operationId": "postflowsactionsdeactivate", - "functionName": "postFlowsActionsDeactivate", - "signature": "postFlowsActionsDeactivate(flow)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\n\n// Deactivate flow\nPostFlowsActionsDeactivateRequest.postFlowsActionsDeactivate(flow: flow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsDeactivateRequest.postFlowsActionsDeactivate was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionspublish": { - "operationId": "postflowsactionspublish", - "functionName": "postFlowsActionsPublish", - "signature": "postFlowsActionsPublish(flow, version)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - }, - { - "name": "version", - "type": "String", - "required": "false" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\nlet version: String = \"\" // version\n\n// Publish flow\nPostFlowsActionsPublishRequest.postFlowsActionsPublish(flow: flow, version: version) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsPublishRequest.postFlowsActionsPublish was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionsrevert": { - "operationId": "postflowsactionsrevert", - "functionName": "postFlowsActionsRevert", - "signature": "postFlowsActionsRevert(flow)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\n\n// Revert flow\nPostFlowsActionsRevertRequest.postFlowsActionsRevert(flow: flow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsRevertRequest.postFlowsActionsRevert was successful\")\n dump(response)\n }\n}" - }, - "postflowsactionsunlock": { - "operationId": "postflowsactionsunlock", - "functionName": "postFlowsActionsUnlock", - "signature": "postFlowsActionsUnlock(flow)", - "parameters": [ - { - "name": "flow", - "type": "String", - "required": "true" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flow: String = \"\" // Flow ID\n\n// Unlock flow\nPostFlowsActionsUnlockRequest.postFlowsActionsUnlock(flow: flow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsActionsUnlockRequest.postFlowsActionsUnlock was successful\")\n dump(response)\n }\n}" - }, - "postflowsdatatableexportjobs": { - "operationId": "postflowsdatatableexportjobs", - "functionName": "postFlowsDatatableExportJobs", - "signature": "postFlowsDatatableExportJobs(datatableId)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - } - ], - "return": "DataTableExportJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\n\n// Begin an export process for exporting all rows from a datatable\nPostFlowsDatatableExportJobsRequest.postFlowsDatatableExportJobs(datatableId: datatableId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsDatatableExportJobsRequest.postFlowsDatatableExportJobs was successful\")\n dump(response)\n }\n}" - }, - "postflowsdatatableimportjobs": { - "operationId": "postflowsdatatableimportjobs", - "functionName": "postFlowsDatatableImportJobs", - "signature": "postFlowsDatatableImportJobs(datatableId, body)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DataTableImportJob", - "required": "true" - } - ], - "return": "DataTableImportJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet body: DataTableImportJob = new DataTableImportJob(...) // import job information\n\n// Begin an import process for importing rows into a datatable\nPostFlowsDatatableImportJobsRequest.postFlowsDatatableImportJobs(datatableId: datatableId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsDatatableImportJobsRequest.postFlowsDatatableImportJobs was successful\")\n dump(response)\n }\n}" - }, - "postflowsdatatablerows": { - "operationId": "postflowsdatatablerows", - "functionName": "postFlowsDatatableRows", - "signature": "postFlowsDatatableRows(datatableId, dataTableRow)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "dataTableRow", - "type": "[String:JSON]", - "required": "true" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet dataTableRow: [String:JSON] = new JSON(...) // \n\n// Create a new row entry for the datatable.\nPostFlowsDatatableRowsRequest.postFlowsDatatableRows(datatableId: datatableId, dataTableRow: dataTableRow) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsDatatableRowsRequest.postFlowsDatatableRows was successful\")\n dump(response)\n }\n}" - }, - "postflowsdatatables": { - "operationId": "postflowsdatatables", - "functionName": "postFlowsDatatables", - "signature": "postFlowsDatatables(body)", - "parameters": [ - { - "name": "body", - "type": "DataTable", - "required": "true" - } - ], - "return": "DataTable", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DataTable = new DataTable(...) // datatable json-schema\n\n// Create a new datatable with the specified json-schema definition\nPostFlowsDatatablesRequest.postFlowsDatatables(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsDatatablesRequest.postFlowsDatatables was successful\")\n dump(response)\n }\n}" - }, - "postflowsexecutions": { - "operationId": "postflowsexecutions", - "functionName": "postFlowsExecutions", - "signature": "postFlowsExecutions(flowLaunchRequest)", - "parameters": [ - { - "name": "flowLaunchRequest", - "type": "FlowExecutionLaunchRequest", - "required": "true" - } - ], - "return": "FlowExecutionLaunchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowLaunchRequest: FlowExecutionLaunchRequest = new FlowExecutionLaunchRequest(...) // \n\n// Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.\nPostFlowsExecutionsRequest.postFlowsExecutions(flowLaunchRequest: flowLaunchRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsExecutionsRequest.postFlowsExecutions was successful\")\n dump(response)\n }\n}" - }, - "postflowsjobs": { - "operationId": "postflowsjobs", - "functionName": "postFlowsJobs", - "signature": "postFlowsJobs()", - "return": "RegisterArchitectJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.\nPostFlowsJobsRequest.postFlowsJobs() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsJobsRequest.postFlowsJobs was successful\")\n dump(response)\n }\n}" - }, - "postflowsmilestones": { - "operationId": "postflowsmilestones", - "functionName": "postFlowsMilestones", - "signature": "postFlowsMilestones(body)", - "parameters": [ - { - "name": "body", - "type": "FlowMilestone", - "required": "false" - } - ], - "return": "FlowMilestone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FlowMilestone = new FlowMilestone(...) // \n\n// Create a flow milestone\nPostFlowsMilestonesRequest.postFlowsMilestones(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsMilestonesRequest.postFlowsMilestones was successful\")\n dump(response)\n }\n}" - }, - "postflowsoutcomes": { - "operationId": "postflowsoutcomes", - "functionName": "postFlowsOutcomes", - "signature": "postFlowsOutcomes(body)", - "parameters": [ - { - "name": "body", - "type": "FlowOutcome", - "required": "false" - } - ], - "return": "FlowOutcome", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FlowOutcome = new FlowOutcome(...) // \n\n// Create a flow outcome\nPostFlowsOutcomesRequest.postFlowsOutcomes(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostFlowsOutcomesRequest.postFlowsOutcomes was successful\")\n dump(response)\n }\n}" - }, - "putarchitectemergencygroup": { - "operationId": "putarchitectemergencygroup", - "functionName": "putArchitectEmergencygroup", - "signature": "putArchitectEmergencygroup(emergencyGroupId, body)", - "parameters": [ - { - "name": "emergencyGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EmergencyGroup", - "required": "true" - } - ], - "return": "EmergencyGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emergencyGroupId: String = \"\" // Emergency group ID\nlet body: EmergencyGroup = new EmergencyGroup(...) // \n\n// Updates a emergency group by ID\nPutArchitectEmergencygroupRequest.putArchitectEmergencygroup(emergencyGroupId: emergencyGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectEmergencygroupRequest.putArchitectEmergencygroup was successful\")\n dump(response)\n }\n}" - }, - "putarchitectivr": { - "operationId": "putarchitectivr", - "functionName": "putArchitectIvr", - "signature": "putArchitectIvr(ivrId, body)", - "parameters": [ - { - "name": "ivrId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "IVR", - "required": "true" - } - ], - "return": "IVR", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ivrId: String = \"\" // IVR id\nlet body: IVR = new IVR(...) // \n\n// Update an IVR Config.\nPutArchitectIvrRequest.putArchitectIvr(ivrId: ivrId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectIvrRequest.putArchitectIvr was successful\")\n dump(response)\n }\n}" - }, - "putarchitectprompt": { - "operationId": "putarchitectprompt", - "functionName": "putArchitectPrompt", - "signature": "putArchitectPrompt(promptId, body)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Prompt", - "required": "true" - } - ], - "return": "Prompt", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet body: Prompt = new Prompt(...) // \n\n// Update specified user prompt\nPutArchitectPromptRequest.putArchitectPrompt(promptId: promptId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectPromptRequest.putArchitectPrompt was successful\")\n dump(response)\n }\n}" - }, - "putarchitectpromptresource": { - "operationId": "putarchitectpromptresource", - "functionName": "putArchitectPromptResource", - "signature": "putArchitectPromptResource(promptId, languageCode, body)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PromptAsset", - "required": "true" - } - ], - "return": "PromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\nlet body: PromptAsset = new PromptAsset(...) // \n\n// Update specified user prompt resource\nPutArchitectPromptResourceRequest.putArchitectPromptResource(promptId: promptId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectPromptResourceRequest.putArchitectPromptResource was successful\")\n dump(response)\n }\n}" - }, - "putarchitectschedule": { - "operationId": "putarchitectschedule", - "functionName": "putArchitectSchedule", - "signature": "putArchitectSchedule(scheduleId, body)", - "parameters": [ - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Schedule", - "required": "true" - } - ], - "return": "Schedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleId: String = \"\" // Schedule ID\nlet body: Schedule = new Schedule(...) // \n\n// Update schedule by ID\nPutArchitectScheduleRequest.putArchitectSchedule(scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectScheduleRequest.putArchitectSchedule was successful\")\n dump(response)\n }\n}" - }, - "putarchitectschedulegroup": { - "operationId": "putarchitectschedulegroup", - "functionName": "putArchitectSchedulegroup", - "signature": "putArchitectSchedulegroup(scheduleGroupId, body)", - "parameters": [ - { - "name": "scheduleGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScheduleGroup", - "required": "true" - } - ], - "return": "ScheduleGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scheduleGroupId: String = \"\" // Schedule group ID\nlet body: ScheduleGroup = new ScheduleGroup(...) // \n\n// Updates a schedule group by ID\nPutArchitectSchedulegroupRequest.putArchitectSchedulegroup(scheduleGroupId: scheduleGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectSchedulegroupRequest.putArchitectSchedulegroup was successful\")\n dump(response)\n }\n}" - }, - "putarchitectsystempromptresource": { - "operationId": "putarchitectsystempromptresource", - "functionName": "putArchitectSystempromptResource", - "signature": "putArchitectSystempromptResource(promptId, languageCode, body)", - "parameters": [ - { - "name": "promptId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SystemPromptAsset", - "required": "true" - } - ], - "return": "SystemPromptAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet promptId: String = \"\" // Prompt ID\nlet languageCode: String = \"\" // Language\nlet body: SystemPromptAsset = new SystemPromptAsset(...) // \n\n// Updates a system prompt resource override.\nPutArchitectSystempromptResourceRequest.putArchitectSystempromptResource(promptId: promptId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutArchitectSystempromptResourceRequest.putArchitectSystempromptResource was successful\")\n dump(response)\n }\n}" - }, - "putflow": { - "operationId": "putflow", - "functionName": "putFlow", - "signature": "putFlow(flowId, body)", - "parameters": [ - { - "name": "flowId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Flow", - "required": "true" - } - ], - "return": "Flow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowId: String = \"\" // Flow ID\nlet body: Flow = new Flow(...) // \n\n// Update flow\nPutFlowRequest.putFlow(flowId: flowId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFlowRequest.putFlow was successful\")\n dump(response)\n }\n}" - }, - "putflowsdatatable": { - "operationId": "putflowsdatatable", - "functionName": "putFlowsDatatable", - "signature": "putFlowsDatatable(datatableId, body, expand)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DataTable", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "DataTable", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet body: DataTable = new DataTable(...) // datatable json-schema\nlet expand: PutFlowsDatatableRequest.Expand_putFlowsDatatable = PutFlowsDatatableRequest.Expand_putFlowsDatatable.enummember // Expand instructions for the result\n\n// Updates a specific datatable by id\nPutFlowsDatatableRequest.putFlowsDatatable(datatableId: datatableId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFlowsDatatableRequest.putFlowsDatatable was successful\")\n dump(response)\n }\n}" - }, - "putflowsdatatablerow": { - "operationId": "putflowsdatatablerow", - "functionName": "putFlowsDatatableRow", - "signature": "putFlowsDatatableRow(datatableId, rowId, body)", - "parameters": [ - { - "name": "datatableId", - "type": "String", - "required": "true" - }, - { - "name": "rowId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String:JSON]", - "required": "false" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet datatableId: String = \"\" // id of datatable\nlet rowId: String = \"\" // the key for the row\nlet body: [String:JSON] = new JSON(...) // datatable row\n\n// Update a row entry\nPutFlowsDatatableRowRequest.putFlowsDatatableRow(datatableId: datatableId, rowId: rowId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFlowsDatatableRowRequest.putFlowsDatatableRow was successful\")\n dump(response)\n }\n}" - }, - "putflowsmilestone": { - "operationId": "putflowsmilestone", - "functionName": "putFlowsMilestone", - "signature": "putFlowsMilestone(milestoneId, body)", - "parameters": [ - { - "name": "milestoneId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "FlowMilestone", - "required": "false" - } - ], - "return": "FlowMilestone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet milestoneId: String = \"\" // flow milestone ID\nlet body: FlowMilestone = new FlowMilestone(...) // \n\n// Updates a flow milestone\nPutFlowsMilestoneRequest.putFlowsMilestone(milestoneId: milestoneId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFlowsMilestoneRequest.putFlowsMilestone was successful\")\n dump(response)\n }\n}" - }, - "putflowsoutcome": { - "operationId": "putflowsoutcome", - "functionName": "putFlowsOutcome", - "signature": "putFlowsOutcome(flowOutcomeId, body)", - "parameters": [ - { - "name": "flowOutcomeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "FlowOutcome", - "required": "false" - } - ], - "return": "Operation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet flowOutcomeId: String = \"\" // flow outcome ID\nlet body: FlowOutcome = new FlowOutcome(...) // \n\n// Updates a flow outcome\nPutFlowsOutcomeRequest.putFlowsOutcome(flowOutcomeId: flowOutcomeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFlowsOutcomeRequest.putFlowsOutcome was successful\")\n dump(response)\n }\n}" - }, - "getauditsqueryrealtimeservicemapping": { - "operationId": "getauditsqueryrealtimeservicemapping", - "functionName": "getAuditsQueryRealtimeServicemapping", - "signature": "getAuditsQueryRealtimeServicemapping()", - "return": "AuditQueryServiceMapping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get service mapping information used in realtime audits.\nGetAuditsQueryRealtimeServicemappingRequest.getAuditsQueryRealtimeServicemapping() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuditsQueryRealtimeServicemappingRequest.getAuditsQueryRealtimeServicemapping was successful\")\n dump(response)\n }\n}" - }, - "getauditsqueryservicemapping": { - "operationId": "getauditsqueryservicemapping", - "functionName": "getAuditsQueryServicemapping", - "signature": "getAuditsQueryServicemapping()", - "return": "AuditQueryServiceMapping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get service mapping information used in audits.\nGetAuditsQueryServicemappingRequest.getAuditsQueryServicemapping() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuditsQueryServicemappingRequest.getAuditsQueryServicemapping was successful\")\n dump(response)\n }\n}" - }, - "getauditsquerytransactionid": { - "operationId": "getauditsquerytransactionid", - "functionName": "getAuditsQueryTransactionId", - "signature": "getAuditsQueryTransactionId(transactionId)", - "parameters": [ - { - "name": "transactionId", - "type": "String", - "required": "true" - } - ], - "return": "AuditQueryExecutionStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet transactionId: String = \"\" // Transaction ID\n\n// Get status of audit query execution\nGetAuditsQueryTransactionIdRequest.getAuditsQueryTransactionId(transactionId: transactionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuditsQueryTransactionIdRequest.getAuditsQueryTransactionId was successful\")\n dump(response)\n }\n}" - }, - "getauditsquerytransactionidresults": { - "operationId": "getauditsquerytransactionidresults", - "functionName": "getAuditsQueryTransactionIdResults", - "signature": "getAuditsQueryTransactionIdResults(transactionId, cursor, pageSize, expand)", - "parameters": [ - { - "name": "transactionId", - "type": "String", - "required": "true" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "AuditQueryExecutionResultsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet transactionId: String = \"\" // Transaction ID\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\nlet pageSize: Int = 0 // Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500.\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get results of audit query\nGetAuditsQueryTransactionIdResultsRequest.getAuditsQueryTransactionIdResults(transactionId: transactionId, cursor: cursor, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuditsQueryTransactionIdResultsRequest.getAuditsQueryTransactionIdResults was successful\")\n dump(response)\n }\n}" - }, - "postauditsquery": { - "operationId": "postauditsquery", - "functionName": "postAuditsQuery", - "signature": "postAuditsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "AuditQueryRequest", - "required": "true" - } - ], - "return": "AuditQueryExecutionStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AuditQueryRequest = new AuditQueryRequest(...) // query\n\n// Create audit query execution\nPostAuditsQueryRequest.postAuditsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuditsQueryRequest.postAuditsQuery was successful\")\n dump(response)\n }\n}" - }, - "postauditsqueryrealtime": { - "operationId": "postauditsqueryrealtime", - "functionName": "postAuditsQueryRealtime", - "signature": "postAuditsQueryRealtime(body, expand)", - "parameters": [ - { - "name": "body", - "type": "AuditRealtimeQueryRequest", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "AuditRealtimeQueryResultsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AuditRealtimeQueryRequest = new AuditRealtimeQueryRequest(...) // query\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.\nPostAuditsQueryRealtimeRequest.postAuditsQueryRealtime(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuditsQueryRealtimeRequest.postAuditsQueryRealtime was successful\")\n dump(response)\n }\n}" - }, - "deleteauthorizationdivision": { - "operationId": "deleteauthorizationdivision", - "functionName": "deleteAuthorizationDivision", - "signature": "deleteAuthorizationDivision(divisionId, force)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "force", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet force: Bool = true // Force delete this division as well as the grants and objects associated with it\n\n// Delete a division.\nDeleteAuthorizationDivisionRequest.deleteAuthorizationDivision(divisionId: divisionId, force: force) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAuthorizationDivisionRequest.deleteAuthorizationDivision was successful\")\n }\n}" - }, - "deleteauthorizationrole": { - "operationId": "deleteauthorizationrole", - "functionName": "deleteAuthorizationRole", - "signature": "deleteAuthorizationRole(roleId)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\n\n// Delete an organization role.\nDeleteAuthorizationRoleRequest.deleteAuthorizationRole(roleId: roleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAuthorizationRoleRequest.deleteAuthorizationRole was successful\")\n }\n}" - }, - "deleteauthorizationsubjectdivisionrole": { - "operationId": "deleteauthorizationsubjectdivisionrole", - "functionName": "deleteAuthorizationSubjectDivisionRole", - "signature": "deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "roleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet divisionId: String = \"\" // the id of the division of the grant\nlet roleId: String = \"\" // the id of the role of the grant\n\n// Delete a grant of a role in a division\nDeleteAuthorizationSubjectDivisionRoleRequest.deleteAuthorizationSubjectDivisionRole(subjectId: subjectId, divisionId: divisionId, roleId: roleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteAuthorizationSubjectDivisionRoleRequest.deleteAuthorizationSubjectDivisionRole was successful\")\n }\n}" - }, - "getauthorizationdivision": { - "operationId": "getauthorizationdivision", - "functionName": "getAuthorizationDivision", - "signature": "getAuthorizationDivision(divisionId, objectCount)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "objectCount", - "type": "Bool", - "required": "false" - } - ], - "return": "AuthzDivision", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet objectCount: Bool = true // Get count of objects in this division, grouped by type\n\n// Returns an authorization division.\nGetAuthorizationDivisionRequest.getAuthorizationDivision(divisionId: divisionId, objectCount: objectCount) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionRequest.getAuthorizationDivision was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisiongrants": { - "operationId": "getauthorizationdivisiongrants", - "functionName": "getAuthorizationDivisionGrants", - "signature": "getAuthorizationDivisionGrants(divisionId, pageNumber, pageSize)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "AuthzDivisionGrantEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Gets all grants for a given division.\nGetAuthorizationDivisionGrantsRequest.getAuthorizationDivisionGrants(divisionId: divisionId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionGrantsRequest.getAuthorizationDivisionGrants was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisions": { - "operationId": "getauthorizationdivisions", - "functionName": "getAuthorizationDivisions", - "signature": "getAuthorizationDivisions(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, objectCount, _id, name)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "objectCount", - "type": "Bool", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "AuthzDivisionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet objectCount: Bool = true // Include the count of objects contained in the division\nlet _id: [String] = [\"\"] // Optionally request specific divisions by their IDs\nlet name: String = \"\" // Search term to filter by division name\n\n// Retrieve a list of all divisions defined for the organization\nGetAuthorizationDivisionsRequest.getAuthorizationDivisions(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, objectCount: objectCount, _id: _id, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionsRequest.getAuthorizationDivisions was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisionshome": { - "operationId": "getauthorizationdivisionshome", - "functionName": "getAuthorizationDivisionsHome", - "signature": "getAuthorizationDivisionsHome()", - "return": "AuthzDivision", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieve the home division for the organization.\nGetAuthorizationDivisionsHomeRequest.getAuthorizationDivisionsHome() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionsHomeRequest.getAuthorizationDivisionsHome was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisionslimit": { - "operationId": "getauthorizationdivisionslimit", - "functionName": "getAuthorizationDivisionsLimit", - "signature": "getAuthorizationDivisionsLimit()", - "return": "Int", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Returns the maximum allowed number of divisions.\nGetAuthorizationDivisionsLimitRequest.getAuthorizationDivisionsLimit() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionsLimitRequest.getAuthorizationDivisionsLimit was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisionspermittedme": { - "operationId": "getauthorizationdivisionspermittedme", - "functionName": "getAuthorizationDivisionspermittedMe", - "signature": "getAuthorizationDivisionspermittedMe(permission, name)", - "parameters": [ - { - "name": "permission", - "type": "String", - "required": "true" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "[AuthzDivision]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet permission: String = \"\" // The permission string, including the object to access, e.g. routing:queue:view\nlet name: String = \"\" // Search term to filter by division name\n\n// Returns which divisions the current user has the given permission in.\nGetAuthorizationDivisionspermittedMeRequest.getAuthorizationDivisionspermittedMe(permission: permission, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionspermittedMeRequest.getAuthorizationDivisionspermittedMe was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisionspermittedpagedme": { - "operationId": "getauthorizationdivisionspermittedpagedme", - "functionName": "getAuthorizationDivisionspermittedPagedMe", - "signature": "getAuthorizationDivisionspermittedPagedMe(permission, pageNumber, pageSize)", - "parameters": [ - { - "name": "permission", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DivsPermittedEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet permission: String = \"\" // The permission string, including the object to access, e.g. routing:queue:view\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Returns which divisions the current user has the given permission in.\nGetAuthorizationDivisionspermittedPagedMeRequest.getAuthorizationDivisionspermittedPagedMe(permission: permission, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionspermittedPagedMeRequest.getAuthorizationDivisionspermittedPagedMe was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationdivisionspermittedpagedsubjectid": { - "operationId": "getauthorizationdivisionspermittedpagedsubjectid", - "functionName": "getAuthorizationDivisionspermittedPagedSubjectId", - "signature": "getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, pageNumber, pageSize)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "permission", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DivsPermittedEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet permission: String = \"\" // The permission string, including the object to access, e.g. routing:queue:view\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Returns which divisions the specified user has the given permission in.\nGetAuthorizationDivisionspermittedPagedSubjectIdRequest.getAuthorizationDivisionspermittedPagedSubjectId(subjectId: subjectId, permission: permission, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationDivisionspermittedPagedSubjectIdRequest.getAuthorizationDivisionspermittedPagedSubjectId was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationpermissions": { - "operationId": "getauthorizationpermissions", - "functionName": "getAuthorizationPermissions", - "signature": "getAuthorizationPermissions(pageSize, pageNumber, queryType, query)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "queryType", - "type": "String", - "required": "false" - }, - { - "name": "query", - "type": "String", - "required": "false" - } - ], - "return": "PermissionCollectionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet queryType: GetAuthorizationPermissionsRequest.QueryType_getAuthorizationPermissions = GetAuthorizationPermissionsRequest.QueryType_getAuthorizationPermissions.enummember // Query filter type\nlet query: String = \"\" // Comma-separated list of permissions or domains to query\n\n// Get all permissions.\nGetAuthorizationPermissionsRequest.getAuthorizationPermissions(pageSize: pageSize, pageNumber: pageNumber, queryType: queryType, query: query) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationPermissionsRequest.getAuthorizationPermissions was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationproducts": { - "operationId": "getauthorizationproducts", - "functionName": "getAuthorizationProducts", - "signature": "getAuthorizationProducts()", - "return": "OrganizationProductEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of enabled products\nGetAuthorizationProductsRequest.getAuthorizationProducts() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationProductsRequest.getAuthorizationProducts was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationrole": { - "operationId": "getauthorizationrole", - "functionName": "getAuthorizationRole", - "signature": "getAuthorizationRole(roleId, userCount, expand)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "userCount", - "type": "Bool", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "DomainOrganizationRole", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet userCount: Bool = true // Fetch the count of users who have this role granted in at least one division\nlet expand: [String] = [\"\"] // Which fields, if any, to expand. \\\"unusedPermissions\\\" returns the permissions not used for the role\n\n// Get a single organization role.\nGetAuthorizationRoleRequest.getAuthorizationRole(roleId: roleId, userCount: userCount, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationRoleRequest.getAuthorizationRole was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationrolecomparedefaultrightroleid": { - "operationId": "getauthorizationrolecomparedefaultrightroleid", - "functionName": "getAuthorizationRoleComparedefaultRightRoleId", - "signature": "getAuthorizationRoleComparedefaultRightRoleId(leftRoleId, rightRoleId)", - "parameters": [ - { - "name": "leftRoleId", - "type": "String", - "required": "true" - }, - { - "name": "rightRoleId", - "type": "String", - "required": "true" - } - ], - "return": "DomainOrgRoleDifference", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet leftRoleId: String = \"\" // Left Role ID\nlet rightRoleId: String = \"\" // Right Role id\n\n// Get an org role to default role comparison\nGetAuthorizationRoleComparedefaultRightRoleIdRequest.getAuthorizationRoleComparedefaultRightRoleId(leftRoleId: leftRoleId, rightRoleId: rightRoleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationRoleComparedefaultRightRoleIdRequest.getAuthorizationRoleComparedefaultRightRoleId was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationrolesubjectgrants": { - "operationId": "getauthorizationrolesubjectgrants", - "functionName": "getAuthorizationRoleSubjectgrants", - "signature": "getAuthorizationRoleSubjectgrants(roleId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "SubjectDivisionGrantsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// Get the subjects' granted divisions in the specified role.\nGetAuthorizationRoleSubjectgrantsRequest.getAuthorizationRoleSubjectgrants(roleId: roleId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationRoleSubjectgrantsRequest.getAuthorizationRoleSubjectgrants was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationroleusers": { - "operationId": "getauthorizationroleusers", - "functionName": "getAuthorizationRoleUsers", - "signature": "getAuthorizationRoleUsers(roleId, pageSize, pageNumber)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of the users in a specified role.\nGetAuthorizationRoleUsersRequest.getAuthorizationRoleUsers(roleId: roleId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationRoleUsersRequest.getAuthorizationRoleUsers was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationroles": { - "operationId": "getauthorizationroles", - "functionName": "getAuthorizationRoles", - "signature": "getAuthorizationRoles(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, permission, defaultRoleId, userCount, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "permission", - "type": "[String]", - "required": "false" - }, - { - "name": "defaultRoleId", - "type": "[String]", - "required": "false" - }, - { - "name": "userCount", - "type": "Bool", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "OrganizationRoleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet name: String = \"\" // \nlet permission: [String] = [\"\"] // \nlet defaultRoleId: [String] = [\"\"] // \nlet userCount: Bool = true // \nlet _id: [String] = [\"\"] // id\n\n// Retrieve a list of all roles defined for the organization\nGetAuthorizationRolesRequest.getAuthorizationRoles(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, permission: permission, defaultRoleId: defaultRoleId, userCount: userCount, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationRolesRequest.getAuthorizationRoles was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationsettings": { - "operationId": "getauthorizationsettings", - "functionName": "getAuthorizationSettings", - "signature": "getAuthorizationSettings()", - "return": "AuthorizationSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get authorization settings\nGetAuthorizationSettingsRequest.getAuthorizationSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationSettingsRequest.getAuthorizationSettings was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationsubject": { - "operationId": "getauthorizationsubject", - "functionName": "getAuthorizationSubject", - "signature": "getAuthorizationSubject(subjectId)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - } - ], - "return": "AuthzSubject", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\n\n// Returns a listing of roles and permissions for a user.\nGetAuthorizationSubjectRequest.getAuthorizationSubject(subjectId: subjectId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationSubjectRequest.getAuthorizationSubject was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationsubjectsme": { - "operationId": "getauthorizationsubjectsme", - "functionName": "getAuthorizationSubjectsMe", - "signature": "getAuthorizationSubjectsMe()", - "return": "AuthzSubject", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Returns a listing of roles and permissions for the currently authenticated user.\nGetAuthorizationSubjectsMeRequest.getAuthorizationSubjectsMe() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationSubjectsMeRequest.getAuthorizationSubjectsMe was successful\")\n dump(response)\n }\n}" - }, - "getauthorizationsubjectsrolecounts": { - "operationId": "getauthorizationsubjectsrolecounts", - "functionName": "getAuthorizationSubjectsRolecounts", - "signature": "getAuthorizationSubjectsRolecounts(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // id\n\n// Get the count of roles granted to a list of subjects\nGetAuthorizationSubjectsRolecountsRequest.getAuthorizationSubjectsRolecounts(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetAuthorizationSubjectsRolecountsRequest.getAuthorizationSubjectsRolecounts was successful\")\n dump(response)\n }\n}" - }, - "getuserroles": { - "operationId": "getuserroles", - "functionName": "getUserRoles", - "signature": "getUserRoles(subjectId)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // User ID\n\n// Returns a listing of roles and permissions for a user.\nGetUserRolesRequest.getUserRoles(subjectId: subjectId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserRolesRequest.getUserRoles was successful\")\n dump(response)\n }\n}" - }, - "patchauthorizationrole": { - "operationId": "patchauthorizationrole", - "functionName": "patchAuthorizationRole", - "signature": "patchAuthorizationRole(roleId, body)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainOrganizationRole", - "required": "true" - } - ], - "return": "DomainOrganizationRole", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet body: DomainOrganizationRole = new DomainOrganizationRole(...) // Organization role\n\n// Patch Organization Role for needsUpdate Field\nPatchAuthorizationRoleRequest.patchAuthorizationRole(roleId: roleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAuthorizationRoleRequest.patchAuthorizationRole was successful\")\n dump(response)\n }\n}" - }, - "patchauthorizationsettings": { - "operationId": "patchauthorizationsettings", - "functionName": "patchAuthorizationSettings", - "signature": "patchAuthorizationSettings(body)", - "parameters": [ - { - "name": "body", - "type": "AuthorizationSettings", - "required": "true" - } - ], - "return": "AuthorizationSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AuthorizationSettings = new AuthorizationSettings(...) // Authorization Settings\n\n// Change authorization settings\nPatchAuthorizationSettingsRequest.patchAuthorizationSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchAuthorizationSettingsRequest.patchAuthorizationSettings was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationdivisionobject": { - "operationId": "postauthorizationdivisionobject", - "functionName": "postAuthorizationDivisionObject", - "signature": "postAuthorizationDivisionObject(divisionId, objectType, body)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "objectType", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet objectType: PostAuthorizationDivisionObjectRequest.ObjectType_postAuthorizationDivisionObject = PostAuthorizationDivisionObjectRequest.ObjectType_postAuthorizationDivisionObject.enummember // The type of the objects. Must be one of the valid object types\nlet body: [String] = [\"\"] // Object Id List\n\n// Assign a list of objects to a division\nPostAuthorizationDivisionObjectRequest.postAuthorizationDivisionObject(divisionId: divisionId, objectType: objectType, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationDivisionObjectRequest.postAuthorizationDivisionObject was successful\")\n }\n}" - }, - "postauthorizationdivisionrestore": { - "operationId": "postauthorizationdivisionrestore", - "functionName": "postAuthorizationDivisionRestore", - "signature": "postAuthorizationDivisionRestore(divisionId, body)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AuthzDivision", - "required": "true" - } - ], - "return": "AuthzDivision", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet body: AuthzDivision = new AuthzDivision(...) // Recreated division data\n\n// Recreate a previously deleted division.\nPostAuthorizationDivisionRestoreRequest.postAuthorizationDivisionRestore(divisionId: divisionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuthorizationDivisionRestoreRequest.postAuthorizationDivisionRestore was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationdivisions": { - "operationId": "postauthorizationdivisions", - "functionName": "postAuthorizationDivisions", - "signature": "postAuthorizationDivisions(body)", - "parameters": [ - { - "name": "body", - "type": "AuthzDivision", - "required": "true" - } - ], - "return": "AuthzDivision", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AuthzDivision = new AuthzDivision(...) // Division\n\n// Create a division.\nPostAuthorizationDivisionsRequest.postAuthorizationDivisions(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuthorizationDivisionsRequest.postAuthorizationDivisions was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationrole": { - "operationId": "postauthorizationrole", - "functionName": "postAuthorizationRole", - "signature": "postAuthorizationRole(roleId, body, subjectType)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SubjectDivisions", - "required": "true" - }, - { - "name": "subjectType", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet body: SubjectDivisions = new SubjectDivisions(...) // Subjects and Divisions\nlet subjectType: String = \"\" // what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)\n\n// Bulk-grant subjects and divisions with an organization role.\nPostAuthorizationRoleRequest.postAuthorizationRole(roleId: roleId, body: body, subjectType: subjectType) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationRoleRequest.postAuthorizationRole was successful\")\n }\n}" - }, - "postauthorizationrolecomparedefaultrightroleid": { - "operationId": "postauthorizationrolecomparedefaultrightroleid", - "functionName": "postAuthorizationRoleComparedefaultRightRoleId", - "signature": "postAuthorizationRoleComparedefaultRightRoleId(leftRoleId, rightRoleId, body)", - "parameters": [ - { - "name": "leftRoleId", - "type": "String", - "required": "true" - }, - { - "name": "rightRoleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainOrganizationRole", - "required": "true" - } - ], - "return": "DomainOrgRoleDifference", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet leftRoleId: String = \"\" // Left Role ID\nlet rightRoleId: String = \"\" // Right Role id\nlet body: DomainOrganizationRole = new DomainOrganizationRole(...) // Organization role\n\n// Get an unsaved org role to default role comparison\nPostAuthorizationRoleComparedefaultRightRoleIdRequest.postAuthorizationRoleComparedefaultRightRoleId(leftRoleId: leftRoleId, rightRoleId: rightRoleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuthorizationRoleComparedefaultRightRoleIdRequest.postAuthorizationRoleComparedefaultRightRoleId was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationroles": { - "operationId": "postauthorizationroles", - "functionName": "postAuthorizationRoles", - "signature": "postAuthorizationRoles(body)", - "parameters": [ - { - "name": "body", - "type": "DomainOrganizationRoleCreate", - "required": "true" - } - ], - "return": "DomainOrganizationRole", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DomainOrganizationRoleCreate = new DomainOrganizationRoleCreate(...) // Organization role\n\n// Create an organization role.\nPostAuthorizationRolesRequest.postAuthorizationRoles(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuthorizationRolesRequest.postAuthorizationRoles was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationrolesdefault": { - "operationId": "postauthorizationrolesdefault", - "functionName": "postAuthorizationRolesDefault", - "signature": "postAuthorizationRolesDefault(force)", - "parameters": [ - { - "name": "force", - "type": "Bool", - "required": "false" - } - ], - "return": "OrganizationRoleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet force: Bool = true // Restore default roles\n\n// Restores all default roles\nPostAuthorizationRolesDefaultRequest.postAuthorizationRolesDefault(force: force) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostAuthorizationRolesDefaultRequest.postAuthorizationRolesDefault was successful\")\n dump(response)\n }\n}" - }, - "postauthorizationsubjectbulkadd": { - "operationId": "postauthorizationsubjectbulkadd", - "functionName": "postAuthorizationSubjectBulkadd", - "signature": "postAuthorizationSubjectBulkadd(subjectId, body, subjectType)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoleDivisionGrants", - "required": "true" - }, - { - "name": "subjectType", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs\nlet subjectType: String = \"\" // what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)\n\n// Bulk-grant roles and divisions to a subject.\nPostAuthorizationSubjectBulkaddRequest.postAuthorizationSubjectBulkadd(subjectId: subjectId, body: body, subjectType: subjectType) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationSubjectBulkaddRequest.postAuthorizationSubjectBulkadd was successful\")\n }\n}" - }, - "postauthorizationsubjectbulkremove": { - "operationId": "postauthorizationsubjectbulkremove", - "functionName": "postAuthorizationSubjectBulkremove", - "signature": "postAuthorizationSubjectBulkremove(subjectId, body)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoleDivisionGrants", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs\n\n// Bulk-remove grants from a subject.\nPostAuthorizationSubjectBulkremoveRequest.postAuthorizationSubjectBulkremove(subjectId: subjectId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationSubjectBulkremoveRequest.postAuthorizationSubjectBulkremove was successful\")\n }\n}" - }, - "postauthorizationsubjectbulkreplace": { - "operationId": "postauthorizationsubjectbulkreplace", - "functionName": "postAuthorizationSubjectBulkreplace", - "signature": "postAuthorizationSubjectBulkreplace(subjectId, body, subjectType)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoleDivisionGrants", - "required": "true" - }, - { - "name": "subjectType", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs\nlet subjectType: String = \"\" // what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)\n\n// Replace subject's roles and divisions with the exact list supplied in the request.\nPostAuthorizationSubjectBulkreplaceRequest.postAuthorizationSubjectBulkreplace(subjectId: subjectId, body: body, subjectType: subjectType) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationSubjectBulkreplaceRequest.postAuthorizationSubjectBulkreplace was successful\")\n }\n}" - }, - "postauthorizationsubjectdivisionrole": { - "operationId": "postauthorizationsubjectdivisionrole", - "functionName": "postAuthorizationSubjectDivisionRole", - "signature": "postAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId, subjectType)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "subjectType", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // Subject ID (user or group)\nlet divisionId: String = \"\" // the id of the division to which to make the grant\nlet roleId: String = \"\" // the id of the role to grant\nlet subjectType: String = \"\" // 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)\n\n// Make a grant of a role in a division\nPostAuthorizationSubjectDivisionRoleRequest.postAuthorizationSubjectDivisionRole(subjectId: subjectId, divisionId: divisionId, roleId: roleId, subjectType: subjectType) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostAuthorizationSubjectDivisionRoleRequest.postAuthorizationSubjectDivisionRole was successful\")\n }\n}" - }, - "putauthorizationdivision": { - "operationId": "putauthorizationdivision", - "functionName": "putAuthorizationDivision", - "signature": "putAuthorizationDivision(divisionId, body)", - "parameters": [ - { - "name": "divisionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AuthzDivision", - "required": "true" - } - ], - "return": "AuthzDivision", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: String = \"\" // Division ID\nlet body: AuthzDivision = new AuthzDivision(...) // Updated division data\n\n// Update a division.\nPutAuthorizationDivisionRequest.putAuthorizationDivision(divisionId: divisionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAuthorizationDivisionRequest.putAuthorizationDivision was successful\")\n dump(response)\n }\n}" - }, - "putauthorizationrole": { - "operationId": "putauthorizationrole", - "functionName": "putAuthorizationRole", - "signature": "putAuthorizationRole(roleId, body)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainOrganizationRoleUpdate", - "required": "true" - } - ], - "return": "DomainOrganizationRole", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet body: DomainOrganizationRoleUpdate = new DomainOrganizationRoleUpdate(...) // Organization role\n\n// Update an organization role.\nPutAuthorizationRoleRequest.putAuthorizationRole(roleId: roleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAuthorizationRoleRequest.putAuthorizationRole was successful\")\n dump(response)\n }\n}" - }, - "putauthorizationroleusersadd": { - "operationId": "putauthorizationroleusersadd", - "functionName": "putAuthorizationRoleUsersAdd", - "signature": "putAuthorizationRoleUsersAdd(roleId, body)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet body: [String] = [\"\"] // List of user IDs\n\n// Sets the users for the role\nPutAuthorizationRoleUsersAddRequest.putAuthorizationRoleUsersAdd(roleId: roleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAuthorizationRoleUsersAddRequest.putAuthorizationRoleUsersAdd was successful\")\n dump(response)\n }\n}" - }, - "putauthorizationroleusersremove": { - "operationId": "putauthorizationroleusersremove", - "functionName": "putAuthorizationRoleUsersRemove", - "signature": "putAuthorizationRoleUsersRemove(roleId, body)", - "parameters": [ - { - "name": "roleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet roleId: String = \"\" // Role ID\nlet body: [String] = [\"\"] // List of user IDs\n\n// Removes the users from the role\nPutAuthorizationRoleUsersRemoveRequest.putAuthorizationRoleUsersRemove(roleId: roleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAuthorizationRoleUsersRemoveRequest.putAuthorizationRoleUsersRemove was successful\")\n dump(response)\n }\n}" - }, - "putauthorizationrolesdefault": { - "operationId": "putauthorizationrolesdefault", - "functionName": "putAuthorizationRolesDefault", - "signature": "putAuthorizationRolesDefault(body)", - "parameters": [ - { - "name": "body", - "type": "[DomainOrganizationRole]", - "required": "true" - } - ], - "return": "OrganizationRoleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [DomainOrganizationRole] = [new DomainOrganizationRole(...)] // Organization roles list\n\n// Restore specified default roles\nPutAuthorizationRolesDefaultRequest.putAuthorizationRolesDefault(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutAuthorizationRolesDefaultRequest.putAuthorizationRolesDefault was successful\")\n dump(response)\n }\n}" - }, - "putuserroles": { - "operationId": "putuserroles", - "functionName": "putUserRoles", - "signature": "putUserRoles(subjectId, body)", - "parameters": [ - { - "name": "subjectId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet subjectId: String = \"\" // User ID\nlet body: [String] = [\"\"] // List of roles\n\n// Sets the user's roles\nPutUserRolesRequest.putUserRoles(subjectId: subjectId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserRolesRequest.putUserRoles was successful\")\n dump(response)\n }\n}" - }, - "getbillingreportsbillableusage": { - "operationId": "getbillingreportsbillableusage", - "functionName": "getBillingReportsBillableusage", - "signature": "getBillingReportsBillableusage(startDate, endDate)", - "parameters": [ - { - "name": "startDate", - "type": "Date", - "required": "true" - }, - { - "name": "endDate", - "type": "Date", - "required": "true" - } - ], - "return": "BillingUsageReport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startDate: Date = new Date(...) // The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet endDate: Date = new Date(...) // The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\n\n// Get a report of the billable license usages\nGetBillingReportsBillableusageRequest.getBillingReportsBillableusage(startDate: startDate, endDate: endDate) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetBillingReportsBillableusageRequest.getBillingReportsBillableusage was successful\")\n dump(response)\n }\n}" - }, - "getbillingtrusteebillingoverviewtrustororgid": { - "operationId": "getbillingtrusteebillingoverviewtrustororgid", - "functionName": "getBillingTrusteebillingoverviewTrustorOrgId", - "signature": "getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId, billingPeriodIndex)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "billingPeriodIndex", - "type": "Int", - "required": "false" - } - ], - "return": "TrusteeBillingOverview", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // The organization ID of the trustor (customer) organization.\nlet billingPeriodIndex: Int = 0 // 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.\n\n// Get the billing overview for an organization that is managed by a partner.\nGetBillingTrusteebillingoverviewTrustorOrgIdRequest.getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId: trustorOrgId, billingPeriodIndex: billingPeriodIndex) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetBillingTrusteebillingoverviewTrustorOrgIdRequest.getBillingTrusteebillingoverviewTrustorOrgId was successful\")\n dump(response)\n }\n}" - }, - "getcarrierservicesintegrationsemergencylocationsme": { - "operationId": "getcarrierservicesintegrationsemergencylocationsme", - "functionName": "getCarrierservicesIntegrationsEmergencylocationsMe", - "signature": "getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber)", - "parameters": [ - { - "name": "phoneNumber", - "type": "String", - "required": "true" - } - ], - "return": "EmergencyLocation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneNumber: String = \"\" // Phone number in E164 format\n\n// Get location for the logged in user\nGetCarrierservicesIntegrationsEmergencylocationsMeRequest.getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber: phoneNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCarrierservicesIntegrationsEmergencylocationsMeRequest.getCarrierservicesIntegrationsEmergencylocationsMe was successful\")\n dump(response)\n }\n}" - }, - "postcarrierservicesintegrationsemergencylocationsme": { - "operationId": "postcarrierservicesintegrationsemergencylocationsme", - "functionName": "postCarrierservicesIntegrationsEmergencylocationsMe", - "signature": "postCarrierservicesIntegrationsEmergencylocationsMe(body)", - "parameters": [ - { - "name": "body", - "type": "EmergencyLocation", - "required": "false" - } - ], - "return": "EmergencyLocation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EmergencyLocation = new EmergencyLocation(...) // \n\n// Set current location for the logged in user\nPostCarrierservicesIntegrationsEmergencylocationsMeRequest.postCarrierservicesIntegrationsEmergencylocationsMe(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCarrierservicesIntegrationsEmergencylocationsMeRequest.postCarrierservicesIntegrationsEmergencylocationsMe was successful\")\n dump(response)\n }\n}" - }, - "getchatsettings": { - "operationId": "getchatsettings", - "functionName": "getChatSettings", - "signature": "getChatSettings()", - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Chat Settings.\nGetChatSettingsRequest.getChatSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetChatSettingsRequest.getChatSettings was successful\")\n dump(response)\n }\n}" - }, - "getchatssettings": { - "operationId": "getchatssettings", - "functionName": "getChatsSettings", - "signature": "getChatsSettings()", - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Chat Settings.\nGetChatsSettingsRequest.getChatsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetChatsSettingsRequest.getChatsSettings was successful\")\n dump(response)\n }\n}" - }, - "patchchatsettings": { - "operationId": "patchchatsettings", - "functionName": "patchChatSettings", - "signature": "patchChatSettings(body)", - "parameters": [ - { - "name": "body", - "type": "ChatSettings", - "required": "true" - } - ], - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ChatSettings = new ChatSettings(...) // Chat\n\n// Patch Chat Settings.\nPatchChatSettingsRequest.patchChatSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchChatSettingsRequest.patchChatSettings was successful\")\n dump(response)\n }\n}" - }, - "patchchatssettings": { - "operationId": "patchchatssettings", - "functionName": "patchChatsSettings", - "signature": "patchChatsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "ChatSettings", - "required": "true" - } - ], - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ChatSettings = new ChatSettings(...) // Chat\n\n// Patch Chat Settings.\nPatchChatsSettingsRequest.patchChatsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchChatsSettingsRequest.patchChatsSettings was successful\")\n dump(response)\n }\n}" - }, - "putchatsettings": { - "operationId": "putchatsettings", - "functionName": "putChatSettings", - "signature": "putChatSettings(body)", - "parameters": [ - { - "name": "body", - "type": "ChatSettings", - "required": "true" - } - ], - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ChatSettings = new ChatSettings(...) // Chat\n\n// Update Chat Settings.\nPutChatSettingsRequest.putChatSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutChatSettingsRequest.putChatSettings was successful\")\n dump(response)\n }\n}" - }, - "putchatssettings": { - "operationId": "putchatssettings", - "functionName": "putChatsSettings", - "signature": "putChatsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "ChatSettings", - "required": "true" - } - ], - "return": "ChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ChatSettings = new ChatSettings(...) // Chat\n\n// Update Chat Settings.\nPutChatsSettingsRequest.putChatsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutChatsSettingsRequest.putChatsSettings was successful\")\n dump(response)\n }\n}" - }, - "deletecoachingappointment": { - "operationId": "deletecoachingappointment", - "functionName": "deleteCoachingAppointment", - "signature": "deleteCoachingAppointment(appointmentId)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - } - ], - "return": "CoachingAppointmentReference", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\n\n// Delete an existing appointment\nDeleteCoachingAppointmentRequest.deleteCoachingAppointment(appointmentId: appointmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteCoachingAppointmentRequest.deleteCoachingAppointment was successful\")\n dump(response)\n }\n}" - }, - "deletecoachingappointmentannotation": { - "operationId": "deletecoachingappointmentannotation", - "functionName": "deleteCoachingAppointmentAnnotation", - "signature": "deleteCoachingAppointmentAnnotation(appointmentId, annotationId)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet annotationId: String = \"\" // The ID of the annotation.\n\n// Delete an existing annotation\nDeleteCoachingAppointmentAnnotationRequest.deleteCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteCoachingAppointmentAnnotationRequest.deleteCoachingAppointmentAnnotation was successful\")\n }\n}" - }, - "getcoachingappointment": { - "operationId": "getcoachingappointment", - "functionName": "getCoachingAppointment", - "signature": "getCoachingAppointment(appointmentId)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - } - ], - "return": "CoachingAppointmentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\n\n// Retrieve an appointment\nGetCoachingAppointmentRequest.getCoachingAppointment(appointmentId: appointmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentRequest.getCoachingAppointment was successful\")\n dump(response)\n }\n}" - }, - "getcoachingappointmentannotation": { - "operationId": "getcoachingappointmentannotation", - "functionName": "getCoachingAppointmentAnnotation", - "signature": "getCoachingAppointmentAnnotation(appointmentId, annotationId)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - } - ], - "return": "CoachingAnnotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet annotationId: String = \"\" // The ID of the annotation.\n\n// Retrieve an annotation.\nGetCoachingAppointmentAnnotationRequest.getCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentAnnotationRequest.getCoachingAppointmentAnnotation was successful\")\n dump(response)\n }\n}" - }, - "getcoachingappointmentannotations": { - "operationId": "getcoachingappointmentannotations", - "functionName": "getCoachingAppointmentAnnotations", - "signature": "getCoachingAppointmentAnnotations(appointmentId, pageNumber, pageSize)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "CoachingAnnotationList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a list of annotations.\nGetCoachingAppointmentAnnotationsRequest.getCoachingAppointmentAnnotations(appointmentId: appointmentId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentAnnotationsRequest.getCoachingAppointmentAnnotations was successful\")\n dump(response)\n }\n}" - }, - "getcoachingappointmentstatuses": { - "operationId": "getcoachingappointmentstatuses", - "functionName": "getCoachingAppointmentStatuses", - "signature": "getCoachingAppointmentStatuses(appointmentId, pageNumber, pageSize)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "CoachingAppointmentStatusResponseList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get the list of status changes for a coaching appointment.\nGetCoachingAppointmentStatusesRequest.getCoachingAppointmentStatuses(appointmentId: appointmentId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentStatusesRequest.getCoachingAppointmentStatuses was successful\")\n dump(response)\n }\n}" - }, - "getcoachingappointments": { - "operationId": "getcoachingappointments", - "functionName": "getCoachingAppointments", - "signature": "getCoachingAppointments(userIds, interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue, intervalCondition)", - "parameters": [ - { - "name": "userIds", - "type": "[String]", - "required": "true" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "statuses", - "type": "[String]", - "required": "false" - }, - { - "name": "facilitatorIds", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "relationships", - "type": "[String]", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "intervalCondition", - "type": "String", - "required": "false" - } - ], - "return": "CoachingAppointmentResponseList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userIds: [String] = [\"\"] // The user IDs for which to retrieve appointments\nlet interval: String = \"\" // 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\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet statuses: [String] = [\"\"] // Appointment Statuses to filter by\nlet facilitatorIds: [String] = [\"\"] // The facilitator IDs for which to retrieve appointments\nlet sortOrder: GetCoachingAppointmentsRequest.SortOrder_getCoachingAppointments = GetCoachingAppointmentsRequest.SortOrder_getCoachingAppointments.enummember // Sort (by due date) either Asc or Desc\nlet relationships: [String] = [\"\"] // Relationships to filter by\nlet completionInterval: String = \"\" // 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\nlet overdue: GetCoachingAppointmentsRequest.Overdue_getCoachingAppointments = GetCoachingAppointmentsRequest.Overdue_getCoachingAppointments.enummember // Overdue status to filter by\nlet intervalCondition: GetCoachingAppointmentsRequest.IntervalCondition_getCoachingAppointments = GetCoachingAppointmentsRequest.IntervalCondition_getCoachingAppointments.enummember // Filter condition for interval\n\n// Get appointments for users and optional date range\nGetCoachingAppointmentsRequest.getCoachingAppointments(userIds: userIds, interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue, intervalCondition: intervalCondition) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentsRequest.getCoachingAppointments was successful\")\n dump(response)\n }\n}" - }, - "getcoachingappointmentsme": { - "operationId": "getcoachingappointmentsme", - "functionName": "getCoachingAppointmentsMe", - "signature": "getCoachingAppointmentsMe(interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue, intervalCondition)", - "parameters": [ - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "statuses", - "type": "[String]", - "required": "false" - }, - { - "name": "facilitatorIds", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "relationships", - "type": "[String]", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "intervalCondition", - "type": "String", - "required": "false" - } - ], - "return": "CoachingAppointmentResponseList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet interval: String = \"\" // 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\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet statuses: [String] = [\"\"] // Appointment Statuses to filter by\nlet facilitatorIds: [String] = [\"\"] // The facilitator IDs for which to retrieve appointments\nlet sortOrder: GetCoachingAppointmentsMeRequest.SortOrder_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.SortOrder_getCoachingAppointmentsMe.enummember // Sort (by due date) either Asc or Desc\nlet relationships: [String] = [\"\"] // Relationships to filter by\nlet completionInterval: String = \"\" // 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\nlet overdue: GetCoachingAppointmentsMeRequest.Overdue_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.Overdue_getCoachingAppointmentsMe.enummember // Overdue status to filter by\nlet intervalCondition: GetCoachingAppointmentsMeRequest.IntervalCondition_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.IntervalCondition_getCoachingAppointmentsMe.enummember // Filter condition for interval\n\n// Get my appointments for a given date range\nGetCoachingAppointmentsMeRequest.getCoachingAppointmentsMe(interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue, intervalCondition: intervalCondition) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingAppointmentsMeRequest.getCoachingAppointmentsMe was successful\")\n dump(response)\n }\n}" - }, - "getcoachingnotification": { - "operationId": "getcoachingnotification", - "functionName": "getCoachingNotification", - "signature": "getCoachingNotification(notificationId, expand)", - "parameters": [ - { - "name": "notificationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "CoachingNotification", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet notificationId: String = \"\" // The ID of the notification.\nlet expand: [String] = [\"\"] // Indicates a field in the response which should be expanded.\n\n// Get an existing notification\nGetCoachingNotificationRequest.getCoachingNotification(notificationId: notificationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingNotificationRequest.getCoachingNotification was successful\")\n dump(response)\n }\n}" - }, - "getcoachingnotifications": { - "operationId": "getcoachingnotifications", - "functionName": "getCoachingNotifications", - "signature": "getCoachingNotifications(pageNumber, pageSize, expand)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "CoachingNotificationList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet expand: [String] = [\"\"] // Indicates a field in the response which should be expanded.\n\n// Retrieve the list of your notifications.\nGetCoachingNotificationsRequest.getCoachingNotifications(pageNumber: pageNumber, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetCoachingNotificationsRequest.getCoachingNotifications was successful\")\n dump(response)\n }\n}" - }, - "patchcoachingappointment": { - "operationId": "patchcoachingappointment", - "functionName": "patchCoachingAppointment", - "signature": "patchCoachingAppointment(appointmentId, body)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateCoachingAppointmentRequest", - "required": "true" - } - ], - "return": "CoachingAppointmentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet body: UpdateCoachingAppointmentRequest = new UpdateCoachingAppointmentRequest(...) // The new version of the appointment\n\n// Update an existing appointment\nPatchCoachingAppointmentRequest.patchCoachingAppointment(appointmentId: appointmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchCoachingAppointmentRequest.patchCoachingAppointment was successful\")\n dump(response)\n }\n}" - }, - "patchcoachingappointmentannotation": { - "operationId": "patchcoachingappointmentannotation", - "functionName": "patchCoachingAppointmentAnnotation", - "signature": "patchCoachingAppointmentAnnotation(appointmentId, annotationId, body)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CoachingAnnotation", - "required": "true" - } - ], - "return": "CoachingAnnotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet annotationId: String = \"\" // The ID of the annotation.\nlet body: CoachingAnnotation = new CoachingAnnotation(...) // The new version of the annotation\n\n// Update an existing annotation.\nPatchCoachingAppointmentAnnotationRequest.patchCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchCoachingAppointmentAnnotationRequest.patchCoachingAppointmentAnnotation was successful\")\n dump(response)\n }\n}" - }, - "patchcoachingappointmentstatus": { - "operationId": "patchcoachingappointmentstatus", - "functionName": "patchCoachingAppointmentStatus", - "signature": "patchCoachingAppointmentStatus(appointmentId, body)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CoachingAppointmentStatusRequest", - "required": "true" - } - ], - "return": "CoachingAppointmentStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet body: CoachingAppointmentStatusRequest = new CoachingAppointmentStatusRequest(...) // Updated status of the coaching appointment\n\n// Update the status of a coaching appointment\nPatchCoachingAppointmentStatusRequest.patchCoachingAppointmentStatus(appointmentId: appointmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchCoachingAppointmentStatusRequest.patchCoachingAppointmentStatus was successful\")\n dump(response)\n }\n}" - }, - "patchcoachingnotification": { - "operationId": "patchcoachingnotification", - "functionName": "patchCoachingNotification", - "signature": "patchCoachingNotification(notificationId, body)", - "parameters": [ - { - "name": "notificationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CoachingNotification", - "required": "true" - } - ], - "return": "CoachingNotification", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet notificationId: String = \"\" // The ID of the notification.\nlet body: CoachingNotification = new CoachingNotification(...) // Change the read state of a notification\n\n// Update an existing notification.\nPatchCoachingNotificationRequest.patchCoachingNotification(notificationId: notificationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchCoachingNotificationRequest.patchCoachingNotification was successful\")\n dump(response)\n }\n}" - }, - "postcoachingappointmentannotations": { - "operationId": "postcoachingappointmentannotations", - "functionName": "postCoachingAppointmentAnnotations", - "signature": "postCoachingAppointmentAnnotations(appointmentId, body)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CoachingAnnotationCreateRequest", - "required": "true" - } - ], - "return": "CoachingAnnotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet body: CoachingAnnotationCreateRequest = new CoachingAnnotationCreateRequest(...) // The annotation to add\n\n// Create a new annotation.\nPostCoachingAppointmentAnnotationsRequest.postCoachingAppointmentAnnotations(appointmentId: appointmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCoachingAppointmentAnnotationsRequest.postCoachingAppointmentAnnotations was successful\")\n dump(response)\n }\n}" - }, - "postcoachingappointmentconversations": { - "operationId": "postcoachingappointmentconversations", - "functionName": "postCoachingAppointmentConversations", - "signature": "postCoachingAppointmentConversations(appointmentId, body)", - "parameters": [ - { - "name": "appointmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AddConversationRequest", - "required": "true" - } - ], - "return": "AddConversationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet appointmentId: String = \"\" // The ID of the coaching appointment.\nlet body: AddConversationRequest = new AddConversationRequest(...) // body\n\n// Add a conversation to an appointment\nPostCoachingAppointmentConversationsRequest.postCoachingAppointmentConversations(appointmentId: appointmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCoachingAppointmentConversationsRequest.postCoachingAppointmentConversations was successful\")\n dump(response)\n }\n}" - }, - "postcoachingappointments": { - "operationId": "postcoachingappointments", - "functionName": "postCoachingAppointments", - "signature": "postCoachingAppointments(body)", - "parameters": [ - { - "name": "body", - "type": "CreateCoachingAppointmentRequest", - "required": "true" - } - ], - "return": "CoachingAppointmentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateCoachingAppointmentRequest = new CreateCoachingAppointmentRequest(...) // The appointment to add\n\n// Create a new appointment\nPostCoachingAppointmentsRequest.postCoachingAppointments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCoachingAppointmentsRequest.postCoachingAppointments was successful\")\n dump(response)\n }\n}" - }, - "postcoachingappointmentsaggregatesquery": { - "operationId": "postcoachingappointmentsaggregatesquery", - "functionName": "postCoachingAppointmentsAggregatesQuery", - "signature": "postCoachingAppointmentsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "CoachingAppointmentAggregateRequest", - "required": "true" - } - ], - "return": "CoachingAppointmentAggregateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CoachingAppointmentAggregateRequest = new CoachingAppointmentAggregateRequest(...) // Aggregate Request\n\n// Retrieve aggregated appointment data\nPostCoachingAppointmentsAggregatesQueryRequest.postCoachingAppointmentsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCoachingAppointmentsAggregatesQueryRequest.postCoachingAppointmentsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postcoachingscheduleslotsquery": { - "operationId": "postcoachingscheduleslotsquery", - "functionName": "postCoachingScheduleslotsQuery", - "signature": "postCoachingScheduleslotsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "CoachingSlotsRequest", - "required": "true" - } - ], - "return": "CoachingSlotsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CoachingSlotsRequest = new CoachingSlotsRequest(...) // The slot search request\n\n// Get list of possible slots where a coaching appointment can be scheduled.\nPostCoachingScheduleslotsQueryRequest.postCoachingScheduleslotsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCoachingScheduleslotsQueryRequest.postCoachingScheduleslotsQuery was successful\")\n dump(response)\n }\n}" - }, - "deletecontentmanagementdocument": { - "operationId": "deletecontentmanagementdocument", - "functionName": "deleteContentmanagementDocument", - "signature": "deleteContentmanagementDocument(documentId, _override)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "_override", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet _override: Bool = true // Override any lock on the document\n\n// Delete a document.\nDeleteContentmanagementDocumentRequest.deleteContentmanagementDocument(documentId: documentId, _override: _override) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementDocumentRequest.deleteContentmanagementDocument was successful\")\n }\n}" - }, - "deletecontentmanagementshare": { - "operationId": "deletecontentmanagementshare", - "functionName": "deleteContentmanagementShare", - "signature": "deleteContentmanagementShare(shareId)", - "parameters": [ - { - "name": "shareId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet shareId: String = \"\" // Share ID\n\n// Deletes an existing share.\nDeleteContentmanagementShareRequest.deleteContentmanagementShare(shareId: shareId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementShareRequest.deleteContentmanagementShare was successful\")\n }\n}" - }, - "deletecontentmanagementstatusstatusid": { - "operationId": "deletecontentmanagementstatusstatusid", - "functionName": "deleteContentmanagementStatusStatusId", - "signature": "deleteContentmanagementStatusStatusId(statusId)", - "parameters": [ - { - "name": "statusId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet statusId: String = \"\" // Status ID\n\n// Cancel the command for this status\nDeleteContentmanagementStatusStatusIdRequest.deleteContentmanagementStatusStatusId(statusId: statusId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementStatusStatusIdRequest.deleteContentmanagementStatusStatusId was successful\")\n }\n}" - }, - "deletecontentmanagementworkspace": { - "operationId": "deletecontentmanagementworkspace", - "functionName": "deleteContentmanagementWorkspace", - "signature": "deleteContentmanagementWorkspace(workspaceId, moveChildrenToWorkspaceId)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "moveChildrenToWorkspaceId", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet moveChildrenToWorkspaceId: String = \"\" // New location for objects in deleted workspace.\n\n// Delete a workspace\nDeleteContentmanagementWorkspaceRequest.deleteContentmanagementWorkspace(workspaceId: workspaceId, moveChildrenToWorkspaceId: moveChildrenToWorkspaceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementWorkspaceRequest.deleteContentmanagementWorkspace was successful\")\n }\n}" - }, - "deletecontentmanagementworkspacemember": { - "operationId": "deletecontentmanagementworkspacemember", - "functionName": "deleteContentmanagementWorkspaceMember", - "signature": "deleteContentmanagementWorkspaceMember(workspaceId, memberId)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet memberId: String = \"\" // Member ID\n\n// Delete a member from a workspace\nDeleteContentmanagementWorkspaceMemberRequest.deleteContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementWorkspaceMemberRequest.deleteContentmanagementWorkspaceMember was successful\")\n }\n}" - }, - "deletecontentmanagementworkspacetagvalue": { - "operationId": "deletecontentmanagementworkspacetagvalue", - "functionName": "deleteContentmanagementWorkspaceTagvalue", - "signature": "deleteContentmanagementWorkspaceTagvalue(workspaceId, tagId)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "tagId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet tagId: String = \"\" // Tag ID\n\n// Delete workspace tag\nDeleteContentmanagementWorkspaceTagvalueRequest.deleteContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteContentmanagementWorkspaceTagvalueRequest.deleteContentmanagementWorkspaceTagvalue was successful\")\n }\n}" - }, - "getcontentmanagementdocument": { - "operationId": "getcontentmanagementdocument", - "functionName": "getContentmanagementDocument", - "signature": "getContentmanagementDocument(documentId, expand)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Document", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a document.\nGetContentmanagementDocumentRequest.getContentmanagementDocument(documentId: documentId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementDocumentRequest.getContentmanagementDocument was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementdocumentaudits": { - "operationId": "getcontentmanagementdocumentaudits", - "functionName": "getContentmanagementDocumentAudits", - "signature": "getContentmanagementDocumentAudits(documentId, pageSize, pageNumber, transactionFilter, level, sortBy, sortOrder)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "transactionFilter", - "type": "String", - "required": "false" - }, - { - "name": "level", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DocumentAuditEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet transactionFilter: String = \"\" // Transaction filter\nlet level: String = \"\" // level\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\n\n// Get a list of audits for a document.\nGetContentmanagementDocumentAuditsRequest.getContentmanagementDocumentAudits(documentId: documentId, pageSize: pageSize, pageNumber: pageNumber, transactionFilter: transactionFilter, level: level, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementDocumentAuditsRequest.getContentmanagementDocumentAudits was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementdocumentcontent": { - "operationId": "getcontentmanagementdocumentcontent", - "functionName": "getContentmanagementDocumentContent", - "signature": "getContentmanagementDocumentContent(documentId, disposition, contentType)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "disposition", - "type": "String", - "required": "false" - }, - { - "name": "contentType", - "type": "String", - "required": "false" - } - ], - "return": "DownloadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet disposition: GetContentmanagementDocumentContentRequest.Disposition_getContentmanagementDocumentContent = GetContentmanagementDocumentContentRequest.Disposition_getContentmanagementDocumentContent.enummember // Request how the content will be downloaded: a file attachment or inline. Default is attachment.\nlet contentType: String = \"\" // The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav\n\n// Download a document.\nGetContentmanagementDocumentContentRequest.getContentmanagementDocumentContent(documentId: documentId, disposition: disposition, contentType: contentType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementDocumentContentRequest.getContentmanagementDocumentContent was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementdocuments": { - "operationId": "getcontentmanagementdocuments", - "functionName": "getContentmanagementDocuments", - "signature": "getContentmanagementDocuments(workspaceId, name, expand, pageSize, pageNumber, sortBy, sortOrder)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DocumentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet name: String = \"\" // Name\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // name or dateCreated\nlet sortOrder: String = \"\" // ascending or descending\n\n// Get a list of documents.\nGetContentmanagementDocumentsRequest.getContentmanagementDocuments(workspaceId: workspaceId, name: name, expand: expand, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementDocumentsRequest.getContentmanagementDocuments was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementquery": { - "operationId": "getcontentmanagementquery", - "functionName": "getContentmanagementQuery", - "signature": "getContentmanagementQuery(queryPhrase, pageSize, pageNumber, sortBy, sortOrder, expand)", - "parameters": [ - { - "name": "queryPhrase", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "QueryResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queryPhrase: String = \"\" // Phrase tokens are ANDed together over all searchable fields\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // name or dateCreated\nlet sortOrder: String = \"\" // ascending or descending\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Query content\nGetContentmanagementQueryRequest.getContentmanagementQuery(queryPhrase: queryPhrase, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementQueryRequest.getContentmanagementQuery was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementsecurityprofile": { - "operationId": "getcontentmanagementsecurityprofile", - "functionName": "getContentmanagementSecurityprofile", - "signature": "getContentmanagementSecurityprofile(securityProfileId)", - "parameters": [ - { - "name": "securityProfileId", - "type": "String", - "required": "true" - } - ], - "return": "SecurityProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet securityProfileId: String = \"\" // Security Profile Id\n\n// Get a Security Profile\nGetContentmanagementSecurityprofileRequest.getContentmanagementSecurityprofile(securityProfileId: securityProfileId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementSecurityprofileRequest.getContentmanagementSecurityprofile was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementsecurityprofiles": { - "operationId": "getcontentmanagementsecurityprofiles", - "functionName": "getContentmanagementSecurityprofiles", - "signature": "getContentmanagementSecurityprofiles()", - "return": "SecurityProfileEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a List of Security Profiles\nGetContentmanagementSecurityprofilesRequest.getContentmanagementSecurityprofiles() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementSecurityprofilesRequest.getContentmanagementSecurityprofiles was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementshare": { - "operationId": "getcontentmanagementshare", - "functionName": "getContentmanagementShare", - "signature": "getContentmanagementShare(shareId, expand)", - "parameters": [ - { - "name": "shareId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Share", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet shareId: String = \"\" // Share ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Retrieve details about an existing share.\nGetContentmanagementShareRequest.getContentmanagementShare(shareId: shareId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementShareRequest.getContentmanagementShare was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementsharedsharedid": { - "operationId": "getcontentmanagementsharedsharedid", - "functionName": "getContentmanagementSharedSharedId", - "signature": "getContentmanagementSharedSharedId(sharedId, redirect, disposition, contentType, expand)", - "parameters": [ - { - "name": "sharedId", - "type": "String", - "required": "true" - }, - { - "name": "redirect", - "type": "Bool", - "required": "false" - }, - { - "name": "disposition", - "type": "String", - "required": "false" - }, - { - "name": "contentType", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "SharedResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sharedId: String = \"\" // Shared ID\nlet redirect: Bool = true // Turn on or off redirect\nlet disposition: GetContentmanagementSharedSharedIdRequest.Disposition_getContentmanagementSharedSharedId = GetContentmanagementSharedSharedIdRequest.Disposition_getContentmanagementSharedSharedId.enummember // Request how the share content will be downloaded: attached as a file or inline. Default is attachment.\nlet contentType: String = \"\" // The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav\nlet expand: GetContentmanagementSharedSharedIdRequest.Expand_getContentmanagementSharedSharedId = GetContentmanagementSharedSharedIdRequest.Expand_getContentmanagementSharedSharedId.enummember // Expand some document fields\n\n// Get shared documents. Securely download a shared document.\nGetContentmanagementSharedSharedIdRequest.getContentmanagementSharedSharedId(sharedId: sharedId, redirect: redirect, disposition: disposition, contentType: contentType, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementSharedSharedIdRequest.getContentmanagementSharedSharedId was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementshares": { - "operationId": "getcontentmanagementshares", - "functionName": "getContentmanagementShares", - "signature": "getContentmanagementShares(entityId, expand, pageSize, pageNumber)", - "parameters": [ - { - "name": "entityId", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "ShareEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet entityId: String = \"\" // Filters the shares returned to only the entity specified by the value of this parameter.\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Gets a list of shares. You must specify at least one filter (e.g. entityId).\nGetContentmanagementSharesRequest.getContentmanagementShares(entityId: entityId, expand: expand, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementSharesRequest.getContentmanagementShares was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementstatus": { - "operationId": "getcontentmanagementstatus", - "functionName": "getContentmanagementStatus", - "signature": "getContentmanagementStatus(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "CommandStatusEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of statuses for pending operations\nGetContentmanagementStatusRequest.getContentmanagementStatus(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementStatusRequest.getContentmanagementStatus was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementstatusstatusid": { - "operationId": "getcontentmanagementstatusstatusid", - "functionName": "getContentmanagementStatusStatusId", - "signature": "getContentmanagementStatusStatusId(statusId)", - "parameters": [ - { - "name": "statusId", - "type": "String", - "required": "true" - } - ], - "return": "CommandStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet statusId: String = \"\" // Status ID\n\n// Get a status.\nGetContentmanagementStatusStatusIdRequest.getContentmanagementStatusStatusId(statusId: statusId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementStatusStatusIdRequest.getContentmanagementStatusStatusId was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementusage": { - "operationId": "getcontentmanagementusage", - "functionName": "getContentmanagementUsage", - "signature": "getContentmanagementUsage()", - "return": "Usage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get usage details.\nGetContentmanagementUsageRequest.getContentmanagementUsage() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementUsageRequest.getContentmanagementUsage was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspace": { - "operationId": "getcontentmanagementworkspace", - "functionName": "getContentmanagementWorkspace", - "signature": "getContentmanagementWorkspace(workspaceId, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Workspace", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a workspace.\nGetContentmanagementWorkspaceRequest.getContentmanagementWorkspace(workspaceId: workspaceId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceRequest.getContentmanagementWorkspace was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspacedocuments": { - "operationId": "getcontentmanagementworkspacedocuments", - "functionName": "getContentmanagementWorkspaceDocuments", - "signature": "getContentmanagementWorkspaceDocuments(workspaceId, expand, pageSize, pageNumber, sortBy, sortOrder)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DocumentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // name or dateCreated\nlet sortOrder: String = \"\" // ascending or descending\n\n// Get a list of documents.\nGetContentmanagementWorkspaceDocumentsRequest.getContentmanagementWorkspaceDocuments(workspaceId: workspaceId, expand: expand, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceDocumentsRequest.getContentmanagementWorkspaceDocuments was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspacemember": { - "operationId": "getcontentmanagementworkspacemember", - "functionName": "getContentmanagementWorkspaceMember", - "signature": "getContentmanagementWorkspaceMember(workspaceId, memberId, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkspaceMember", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet memberId: String = \"\" // Member ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a workspace member\nGetContentmanagementWorkspaceMemberRequest.getContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceMemberRequest.getContentmanagementWorkspaceMember was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspacemembers": { - "operationId": "getcontentmanagementworkspacemembers", - "functionName": "getContentmanagementWorkspaceMembers", - "signature": "getContentmanagementWorkspaceMembers(workspaceId, pageSize, pageNumber, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkspaceMemberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a list workspace members\nGetContentmanagementWorkspaceMembersRequest.getContentmanagementWorkspaceMembers(workspaceId: workspaceId, pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceMembersRequest.getContentmanagementWorkspaceMembers was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspacetagvalue": { - "operationId": "getcontentmanagementworkspacetagvalue", - "functionName": "getContentmanagementWorkspaceTagvalue", - "signature": "getContentmanagementWorkspaceTagvalue(workspaceId, tagId, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "tagId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "TagValue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet tagId: String = \"\" // Tag ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a workspace tag\nGetContentmanagementWorkspaceTagvalueRequest.getContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceTagvalueRequest.getContentmanagementWorkspaceTagvalue was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspacetagvalues": { - "operationId": "getcontentmanagementworkspacetagvalues", - "functionName": "getContentmanagementWorkspaceTagvalues", - "signature": "getContentmanagementWorkspaceTagvalues(workspaceId, value, pageSize, pageNumber, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "value", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "TagValueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet value: String = \"\" // filter the list of tags returned\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a list of workspace tags\nGetContentmanagementWorkspaceTagvaluesRequest.getContentmanagementWorkspaceTagvalues(workspaceId: workspaceId, value: value, pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspaceTagvaluesRequest.getContentmanagementWorkspaceTagvalues was successful\")\n dump(response)\n }\n}" - }, - "getcontentmanagementworkspaces": { - "operationId": "getcontentmanagementworkspaces", - "functionName": "getContentmanagementWorkspaces", - "signature": "getContentmanagementWorkspaces(pageSize, pageNumber, access, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "access", - "type": "[String]", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkspaceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet access: [String] = [\"\"] // Requested access level.\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a list of workspaces.\nGetContentmanagementWorkspacesRequest.getContentmanagementWorkspaces(pageSize: pageSize, pageNumber: pageNumber, access: access, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetContentmanagementWorkspacesRequest.getContentmanagementWorkspaces was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementauditquery": { - "operationId": "postcontentmanagementauditquery", - "functionName": "postContentmanagementAuditquery", - "signature": "postContentmanagementAuditquery(body)", - "parameters": [ - { - "name": "body", - "type": "ContentQueryRequest", - "required": "true" - } - ], - "return": "QueryResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContentQueryRequest = new ContentQueryRequest(...) // Allows for a filtered query returning facet information\n\n// Query audits\nPostContentmanagementAuditqueryRequest.postContentmanagementAuditquery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementAuditqueryRequest.postContentmanagementAuditquery was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementdocument": { - "operationId": "postcontentmanagementdocument", - "functionName": "postContentmanagementDocument", - "signature": "postContentmanagementDocument(documentId, body, expand, _override)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DocumentUpdate", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "_override", - "type": "Bool", - "required": "false" - } - ], - "return": "Document", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet body: DocumentUpdate = new DocumentUpdate(...) // Document\nlet expand: PostContentmanagementDocumentRequest.Expand_postContentmanagementDocument = PostContentmanagementDocumentRequest.Expand_postContentmanagementDocument.enummember // Expand some document fields\nlet _override: Bool = true // Override any lock on the document\n\n// Update a document.\nPostContentmanagementDocumentRequest.postContentmanagementDocument(documentId: documentId, body: body, expand: expand, _override: _override) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementDocumentRequest.postContentmanagementDocument was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementdocumentcontent": { - "operationId": "postcontentmanagementdocumentcontent", - "functionName": "postContentmanagementDocumentContent", - "signature": "postContentmanagementDocumentContent(documentId, body, _override)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ReplaceRequest", - "required": "true" - }, - { - "name": "_override", - "type": "Bool", - "required": "false" - } - ], - "return": "ReplaceResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet body: ReplaceRequest = new ReplaceRequest(...) // Replace Request\nlet _override: Bool = true // Override any lock on the document\n\n// Replace the contents of a document.\nPostContentmanagementDocumentContentRequest.postContentmanagementDocumentContent(documentId: documentId, body: body, _override: _override) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementDocumentContentRequest.postContentmanagementDocumentContent was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementdocuments": { - "operationId": "postcontentmanagementdocuments", - "functionName": "postContentmanagementDocuments", - "signature": "postContentmanagementDocuments(body, copySource, moveSource, _override)", - "parameters": [ - { - "name": "body", - "type": "DocumentUpload", - "required": "true" - }, - { - "name": "copySource", - "type": "String", - "required": "false" - }, - { - "name": "moveSource", - "type": "String", - "required": "false" - }, - { - "name": "_override", - "type": "Bool", - "required": "false" - } - ], - "return": "Document", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DocumentUpload = new DocumentUpload(...) // Document\nlet copySource: String = \"\" // Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.\nlet moveSource: String = \"\" // Move a document to a new workspace. Provide a document ID as the move source.\nlet _override: Bool = true // Override any lock on the source document\n\n// Add a document.\nPostContentmanagementDocumentsRequest.postContentmanagementDocuments(body: body, copySource: copySource, moveSource: moveSource, _override: _override) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementDocumentsRequest.postContentmanagementDocuments was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementquery": { - "operationId": "postcontentmanagementquery", - "functionName": "postContentmanagementQuery", - "signature": "postContentmanagementQuery(body, expand)", - "parameters": [ - { - "name": "body", - "type": "QueryRequest", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "QueryResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: QueryRequest = new QueryRequest(...) // Allows for a filtered query returning facet information\nlet expand: PostContentmanagementQueryRequest.Expand_postContentmanagementQuery = PostContentmanagementQueryRequest.Expand_postContentmanagementQuery.enummember // Expand some document fields\n\n// Query content\nPostContentmanagementQueryRequest.postContentmanagementQuery(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementQueryRequest.postContentmanagementQuery was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementshares": { - "operationId": "postcontentmanagementshares", - "functionName": "postContentmanagementShares", - "signature": "postContentmanagementShares(body)", - "parameters": [ - { - "name": "body", - "type": "CreateShareRequest", - "required": "true" - } - ], - "return": "CreateShareResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateShareRequest = new CreateShareRequest(...) // CreateShareRequest - entity id and type and a single member or list of members are required\n\n// Creates a new share or updates an existing share if the entity has already been shared\nPostContentmanagementSharesRequest.postContentmanagementShares(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementSharesRequest.postContentmanagementShares was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementworkspacetagvalues": { - "operationId": "postcontentmanagementworkspacetagvalues", - "functionName": "postContentmanagementWorkspaceTagvalues", - "signature": "postContentmanagementWorkspaceTagvalues(workspaceId, body)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TagValue", - "required": "true" - } - ], - "return": "TagValue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet body: TagValue = new TagValue(...) // tag\n\n// Create a workspace tag\nPostContentmanagementWorkspaceTagvaluesRequest.postContentmanagementWorkspaceTagvalues(workspaceId: workspaceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementWorkspaceTagvaluesRequest.postContentmanagementWorkspaceTagvalues was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementworkspacetagvaluesquery": { - "operationId": "postcontentmanagementworkspacetagvaluesquery", - "functionName": "postContentmanagementWorkspaceTagvaluesQuery", - "signature": "postContentmanagementWorkspaceTagvaluesQuery(workspaceId, body, expand)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TagQueryRequest", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "TagValueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet body: TagQueryRequest = new TagQueryRequest(...) // query\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Perform a prefix query on tags in the workspace\nPostContentmanagementWorkspaceTagvaluesQueryRequest.postContentmanagementWorkspaceTagvaluesQuery(workspaceId: workspaceId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementWorkspaceTagvaluesQueryRequest.postContentmanagementWorkspaceTagvaluesQuery was successful\")\n dump(response)\n }\n}" - }, - "postcontentmanagementworkspaces": { - "operationId": "postcontentmanagementworkspaces", - "functionName": "postContentmanagementWorkspaces", - "signature": "postContentmanagementWorkspaces(body)", - "parameters": [ - { - "name": "body", - "type": "WorkspaceCreate", - "required": "true" - } - ], - "return": "Workspace", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WorkspaceCreate = new WorkspaceCreate(...) // Workspace\n\n// Create a group workspace\nPostContentmanagementWorkspacesRequest.postContentmanagementWorkspaces(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostContentmanagementWorkspacesRequest.postContentmanagementWorkspaces was successful\")\n dump(response)\n }\n}" - }, - "putcontentmanagementworkspace": { - "operationId": "putcontentmanagementworkspace", - "functionName": "putContentmanagementWorkspace", - "signature": "putContentmanagementWorkspace(workspaceId, body)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Workspace", - "required": "true" - } - ], - "return": "Workspace", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet body: Workspace = new Workspace(...) // Workspace\n\n// Update a workspace\nPutContentmanagementWorkspaceRequest.putContentmanagementWorkspace(workspaceId: workspaceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutContentmanagementWorkspaceRequest.putContentmanagementWorkspace was successful\")\n dump(response)\n }\n}" - }, - "putcontentmanagementworkspacemember": { - "operationId": "putcontentmanagementworkspacemember", - "functionName": "putContentmanagementWorkspaceMember", - "signature": "putContentmanagementWorkspaceMember(workspaceId, memberId, body)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WorkspaceMember", - "required": "true" - } - ], - "return": "WorkspaceMember", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet memberId: String = \"\" // Member ID\nlet body: WorkspaceMember = new WorkspaceMember(...) // Workspace Member\n\n// Add a member to a workspace\nPutContentmanagementWorkspaceMemberRequest.putContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutContentmanagementWorkspaceMemberRequest.putContentmanagementWorkspaceMember was successful\")\n dump(response)\n }\n}" - }, - "putcontentmanagementworkspacetagvalue": { - "operationId": "putcontentmanagementworkspacetagvalue", - "functionName": "putContentmanagementWorkspaceTagvalue", - "signature": "putContentmanagementWorkspaceTagvalue(workspaceId, tagId, body)", - "parameters": [ - { - "name": "workspaceId", - "type": "String", - "required": "true" - }, - { - "name": "tagId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TagValue", - "required": "true" - } - ], - "return": "TagValue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workspaceId: String = \"\" // Workspace ID\nlet tagId: String = \"\" // Tag ID\nlet body: TagValue = new TagValue(...) // Workspace\n\n// Update a workspace tag. Will update all documents with the new tag value.\nPutContentmanagementWorkspaceTagvalueRequest.putContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutContentmanagementWorkspaceTagvalueRequest.putContentmanagementWorkspaceTagvalue was successful\")\n dump(response)\n }\n}" - }, - "deleteconversationparticipantcode": { - "operationId": "deleteconversationparticipantcode", - "functionName": "deleteConversationParticipantCode", - "signature": "deleteConversationParticipantCode(conversationId, participantId, addCommunicationCode)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "addCommunicationCode", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet addCommunicationCode: String = \"\" // addCommunicationCode\n\n// Delete a code used to add a communication to this participant\nDeleteConversationParticipantCodeRequest.deleteConversationParticipantCode(conversationId: conversationId, participantId: participantId, addCommunicationCode: addCommunicationCode) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationParticipantCodeRequest.deleteConversationParticipantCode was successful\")\n }\n}" - }, - "deleteconversationparticipantflaggedreason": { - "operationId": "deleteconversationparticipantflaggedreason", - "functionName": "deleteConversationParticipantFlaggedreason", - "signature": "deleteConversationParticipantFlaggedreason(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\n\n// Remove flagged reason from conversation participant.\nDeleteConversationParticipantFlaggedreasonRequest.deleteConversationParticipantFlaggedreason(conversationId: conversationId, participantId: participantId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationParticipantFlaggedreasonRequest.deleteConversationParticipantFlaggedreason was successful\")\n }\n}" - }, - "deleteconversationscallparticipantconsult": { - "operationId": "deleteconversationscallparticipantconsult", - "functionName": "deleteConversationsCallParticipantConsult", - "signature": "deleteConversationsCallParticipantConsult(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Cancel the transfer\nDeleteConversationsCallParticipantConsultRequest.deleteConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsCallParticipantConsultRequest.deleteConversationsCallParticipantConsult was successful\")\n }\n}" - }, - "deleteconversationsemailmessagesdraftattachment": { - "operationId": "deleteconversationsemailmessagesdraftattachment", - "functionName": "deleteConversationsEmailMessagesDraftAttachment", - "signature": "deleteConversationsEmailMessagesDraftAttachment(conversationId, attachmentId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "attachmentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet attachmentId: String = \"\" // attachmentId\n\n// Delete attachment from draft\nDeleteConversationsEmailMessagesDraftAttachmentRequest.deleteConversationsEmailMessagesDraftAttachment(conversationId: conversationId, attachmentId: attachmentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsEmailMessagesDraftAttachmentRequest.deleteConversationsEmailMessagesDraftAttachment was successful\")\n }\n}" - }, - "deleteconversationsmessagescachedmediacachedmediaitemid": { - "operationId": "deleteconversationsmessagescachedmediacachedmediaitemid", - "functionName": "deleteConversationsMessagesCachedmediaCachedMediaItemId", - "signature": "deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId)", - "parameters": [ - { - "name": "cachedMediaItemId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet cachedMediaItemId: String = \"\" // cachedMediaItemId\n\n// Remove a cached media item asychronously\nDeleteConversationsMessagesCachedmediaCachedMediaItemIdRequest.deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId: cachedMediaItemId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagesCachedmediaCachedMediaItemIdRequest.deleteConversationsMessagesCachedmediaCachedMediaItemId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationsfacebookintegrationid": { - "operationId": "deleteconversationsmessagingintegrationsfacebookintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsFacebookIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete a Facebook messaging integration\nDeleteConversationsMessagingIntegrationsFacebookIntegrationIdRequest.deleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingIntegrationsFacebookIntegrationIdRequest.deleteConversationsMessagingIntegrationsFacebookIntegrationId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationsinstagramintegrationid": { - "operationId": "deleteconversationsmessagingintegrationsinstagramintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsInstagramIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete Instagram messaging integration\nDeleteConversationsMessagingIntegrationsInstagramIntegrationIdRequest.deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingIntegrationsInstagramIntegrationIdRequest.deleteConversationsMessagingIntegrationsInstagramIntegrationId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationslineintegrationid": { - "operationId": "deleteconversationsmessagingintegrationslineintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsLineIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete a LINE messenger integration\nDeleteConversationsMessagingIntegrationsLineIntegrationIdRequest.deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingIntegrationsLineIntegrationIdRequest.deleteConversationsMessagingIntegrationsLineIntegrationId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationsopenintegrationid": { - "operationId": "deleteconversationsmessagingintegrationsopenintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsOpenIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete an Open messaging integration\nDeleteConversationsMessagingIntegrationsOpenIntegrationIdRequest.deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingIntegrationsOpenIntegrationIdRequest.deleteConversationsMessagingIntegrationsOpenIntegrationId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationstwitterintegrationid": { - "operationId": "deleteconversationsmessagingintegrationstwitterintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsTwitterIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete a Twitter messaging integration\nDeleteConversationsMessagingIntegrationsTwitterIntegrationIdRequest.deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingIntegrationsTwitterIntegrationIdRequest.deleteConversationsMessagingIntegrationsTwitterIntegrationId was successful\")\n }\n}" - }, - "deleteconversationsmessagingintegrationswhatsappintegrationid": { - "operationId": "deleteconversationsmessagingintegrationswhatsappintegrationid", - "functionName": "deleteConversationsMessagingIntegrationsWhatsappIntegrationId", - "signature": "deleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "return": "WhatsAppIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\n\n// Delete a WhatsApp messaging integration\nDeleteConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.deleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.deleteConversationsMessagingIntegrationsWhatsappIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "deleteconversationsmessagingsetting": { - "operationId": "deleteconversationsmessagingsetting", - "functionName": "deleteConversationsMessagingSetting", - "signature": "deleteConversationsMessagingSetting(messageSettingId)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Setting ID\n\n// Delete a messaging setting\nDeleteConversationsMessagingSettingRequest.deleteConversationsMessagingSetting(messageSettingId: messageSettingId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingSettingRequest.deleteConversationsMessagingSetting was successful\")\n }\n}" - }, - "deleteconversationsmessagingsettingsdefault": { - "operationId": "deleteconversationsmessagingsettingsdefault", - "functionName": "deleteConversationsMessagingSettingsDefault", - "signature": "deleteConversationsMessagingSettingsDefault()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete the organization's default setting, a global default will be applied to integrations without settings\nDeleteConversationsMessagingSettingsDefaultRequest.deleteConversationsMessagingSettingsDefault() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingSettingsDefaultRequest.deleteConversationsMessagingSettingsDefault was successful\")\n }\n}" - }, - "deleteconversationsmessagingsupportedcontentsupportedcontentid": { - "operationId": "deleteconversationsmessagingsupportedcontentsupportedcontentid", - "functionName": "deleteConversationsMessagingSupportedcontentSupportedContentId", - "signature": "deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\n\n// Delete a supported content profile\nDeleteConversationsMessagingSupportedcontentSupportedContentIdRequest.deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationsMessagingSupportedcontentSupportedContentIdRequest.deleteConversationsMessagingSupportedcontentSupportedContentId was successful\")\n }\n}" - }, - "getconversation": { - "operationId": "getconversation", - "functionName": "getConversation", - "signature": "getConversation(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\n\n// Get conversation\nGetConversationRequest.getConversation(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRequest.getConversation was successful\")\n dump(response)\n }\n}" - }, - "getconversationparticipantsecureivrsession": { - "operationId": "getconversationparticipantsecureivrsession", - "functionName": "getConversationParticipantSecureivrsession", - "signature": "getConversationParticipantSecureivrsession(conversationId, participantId, secureSessionId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "secureSessionId", - "type": "String", - "required": "true" - } - ], - "return": "SecureSession", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet secureSessionId: String = \"\" // secure IVR session ID\n\n// Fetch info on a secure session\nGetConversationParticipantSecureivrsessionRequest.getConversationParticipantSecureivrsession(conversationId: conversationId, participantId: participantId, secureSessionId: secureSessionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationParticipantSecureivrsessionRequest.getConversationParticipantSecureivrsession was successful\")\n dump(response)\n }\n}" - }, - "getconversationparticipantsecureivrsessions": { - "operationId": "getconversationparticipantsecureivrsessions", - "functionName": "getConversationParticipantSecureivrsessions", - "signature": "getConversationParticipantSecureivrsessions(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "SecureSessionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\n\n// Get a list of secure sessions for this participant.\nGetConversationParticipantSecureivrsessionsRequest.getConversationParticipantSecureivrsessions(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationParticipantSecureivrsessionsRequest.getConversationParticipantSecureivrsessions was successful\")\n dump(response)\n }\n}" - }, - "getconversationparticipantwrapup": { - "operationId": "getconversationparticipantwrapup", - "functionName": "getConversationParticipantWrapup", - "signature": "getConversationParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationParticipantWrapupRequest.getConversationParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationParticipantWrapupRequest.getConversationParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationparticipantwrapupcodes": { - "operationId": "getconversationparticipantwrapupcodes", - "functionName": "getConversationParticipantWrapupcodes", - "signature": "getConversationParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\n\n// Get list of wrapup codes for this conversation participant\nGetConversationParticipantWrapupcodesRequest.getConversationParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationParticipantWrapupcodesRequest.getConversationParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationsecureattributes": { - "operationId": "getconversationsecureattributes", - "functionName": "getConversationSecureattributes", - "signature": "getConversationSecureattributes(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "ConversationSecureAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\n\n// Get the secure attributes on a conversation.\nGetConversationSecureattributesRequest.getConversationSecureattributes(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationSecureattributesRequest.getConversationSecureattributes was successful\")\n dump(response)\n }\n}" - }, - "getconversations": { - "operationId": "getconversations", - "functionName": "getConversations", - "signature": "getConversations(communicationType)", - "parameters": [ - { - "name": "communicationType", - "type": "String", - "required": "false" - } - ], - "return": "ConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet communicationType: String = \"\" // Call or Chat communication filtering\n\n// Get active conversations for the logged in user\nGetConversationsRequest.getConversations(communicationType: communicationType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsRequest.getConversations was successful\")\n dump(response)\n }\n}" - }, - "getconversationscall": { - "operationId": "getconversationscall", - "functionName": "getConversationsCall", - "signature": "getConversationsCall(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "CallConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get call conversation\nGetConversationsCallRequest.getConversationsCall(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallRequest.getConversationsCall was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallparticipantcommunicationwrapup": { - "operationId": "getconversationscallparticipantcommunicationwrapup", - "functionName": "getConversationsCallParticipantCommunicationWrapup", - "signature": "getConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsCallParticipantCommunicationWrapupRequest.getConversationsCallParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallParticipantCommunicationWrapupRequest.getConversationsCallParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallparticipantwrapup": { - "operationId": "getconversationscallparticipantwrapup", - "functionName": "getConversationsCallParticipantWrapup", - "signature": "getConversationsCallParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsCallParticipantWrapupRequest.getConversationsCallParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallParticipantWrapupRequest.getConversationsCallParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallparticipantwrapupcodes": { - "operationId": "getconversationscallparticipantwrapupcodes", - "functionName": "getConversationsCallParticipantWrapupcodes", - "signature": "getConversationsCallParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsCallParticipantWrapupcodesRequest.getConversationsCallParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallParticipantWrapupcodesRequest.getConversationsCallParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallback": { - "operationId": "getconversationscallback", - "functionName": "getConversationsCallback", - "signature": "getConversationsCallback(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "CallbackConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get callback conversation\nGetConversationsCallbackRequest.getConversationsCallback(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallbackRequest.getConversationsCallback was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallbackparticipantcommunicationwrapup": { - "operationId": "getconversationscallbackparticipantcommunicationwrapup", - "functionName": "getConversationsCallbackParticipantCommunicationWrapup", - "signature": "getConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsCallbackParticipantCommunicationWrapupRequest.getConversationsCallbackParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallbackParticipantCommunicationWrapupRequest.getConversationsCallbackParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallbackparticipantwrapup": { - "operationId": "getconversationscallbackparticipantwrapup", - "functionName": "getConversationsCallbackParticipantWrapup", - "signature": "getConversationsCallbackParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsCallbackParticipantWrapupRequest.getConversationsCallbackParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallbackParticipantWrapupRequest.getConversationsCallbackParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallbackparticipantwrapupcodes": { - "operationId": "getconversationscallbackparticipantwrapupcodes", - "functionName": "getConversationsCallbackParticipantWrapupcodes", - "signature": "getConversationsCallbackParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsCallbackParticipantWrapupcodesRequest.getConversationsCallbackParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallbackParticipantWrapupcodesRequest.getConversationsCallbackParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallbacks": { - "operationId": "getconversationscallbacks", - "functionName": "getConversationsCallbacks", - "signature": "getConversationsCallbacks()", - "return": "CallbackConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active callback conversations for the logged in user\nGetConversationsCallbacksRequest.getConversationsCallbacks() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallbacksRequest.getConversationsCallbacks was successful\")\n dump(response)\n }\n}" - }, - "getconversationscalls": { - "operationId": "getconversationscalls", - "functionName": "getConversationsCalls", - "signature": "getConversationsCalls()", - "return": "CallConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active call conversations for the logged in user\nGetConversationsCallsRequest.getConversationsCalls() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallsRequest.getConversationsCalls was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallshistory": { - "operationId": "getconversationscallshistory", - "functionName": "getConversationsCallsHistory", - "signature": "getConversationsCallsHistory(pageSize, pageNumber, interval, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "CallHistoryConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size, maximum 50\nlet pageNumber: Int = 0 // Page number\nlet interval: String = \"\" // Interval string; format is ISO-8601. Separate start and end times with forward slash '/'\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get call history\nGetConversationsCallsHistoryRequest.getConversationsCallsHistory(pageSize: pageSize, pageNumber: pageNumber, interval: interval, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallsHistoryRequest.getConversationsCallsHistory was successful\")\n dump(response)\n }\n}" - }, - "getconversationscallsmaximumconferenceparties": { - "operationId": "getconversationscallsmaximumconferenceparties", - "functionName": "getConversationsCallsMaximumconferenceparties", - "signature": "getConversationsCallsMaximumconferenceparties()", - "return": "MaxParticipants", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the maximum number of participants that this user can have on a conference\nGetConversationsCallsMaximumconferencepartiesRequest.getConversationsCallsMaximumconferenceparties() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCallsMaximumconferencepartiesRequest.getConversationsCallsMaximumconferenceparties was successful\")\n dump(response)\n }\n}" - }, - "getconversationschat": { - "operationId": "getconversationschat", - "functionName": "getConversationsChat", - "signature": "getConversationsChat(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "ChatConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get chat conversation\nGetConversationsChatRequest.getConversationsChat(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatRequest.getConversationsChat was successful\")\n dump(response)\n }\n}" - }, - "getconversationschatmessage": { - "operationId": "getconversationschatmessage", - "functionName": "getConversationsChatMessage", - "signature": "getConversationsChatMessage(conversationId, messageId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "messageId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet messageId: String = \"\" // messageId\n\n// Get a web chat conversation message\nGetConversationsChatMessageRequest.getConversationsChatMessage(conversationId: conversationId, messageId: messageId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatMessageRequest.getConversationsChatMessage was successful\")\n dump(response)\n }\n}" - }, - "getconversationschatmessages": { - "operationId": "getconversationschatmessages", - "functionName": "getConversationsChatMessages", - "signature": "getConversationsChatMessages(conversationId, after, before, sortOrder, maxResults)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "maxResults", - "type": "Int", - "required": "false" - } - ], - "return": "WebChatMessageEntityList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet after: String = \"\" // If specified, get the messages chronologically after the id of this message\nlet before: String = \"\" // If specified, get the messages chronologically before the id of this message\nlet sortOrder: GetConversationsChatMessagesRequest.SortOrder_getConversationsChatMessages = GetConversationsChatMessagesRequest.SortOrder_getConversationsChatMessages.enummember // Sort order\nlet maxResults: Int = 0 // Limit the returned number of messages, up to a maximum of 100\n\n// Get the messages of a chat conversation.\nGetConversationsChatMessagesRequest.getConversationsChatMessages(conversationId: conversationId, after: after, before: before, sortOrder: sortOrder, maxResults: maxResults) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatMessagesRequest.getConversationsChatMessages was successful\")\n dump(response)\n }\n}" - }, - "getconversationschatparticipantcommunicationwrapup": { - "operationId": "getconversationschatparticipantcommunicationwrapup", - "functionName": "getConversationsChatParticipantCommunicationWrapup", - "signature": "getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsChatParticipantCommunicationWrapupRequest.getConversationsChatParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatParticipantCommunicationWrapupRequest.getConversationsChatParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationschatparticipantwrapup": { - "operationId": "getconversationschatparticipantwrapup", - "functionName": "getConversationsChatParticipantWrapup", - "signature": "getConversationsChatParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsChatParticipantWrapupRequest.getConversationsChatParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatParticipantWrapupRequest.getConversationsChatParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationschatparticipantwrapupcodes": { - "operationId": "getconversationschatparticipantwrapupcodes", - "functionName": "getConversationsChatParticipantWrapupcodes", - "signature": "getConversationsChatParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsChatParticipantWrapupcodesRequest.getConversationsChatParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatParticipantWrapupcodesRequest.getConversationsChatParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationschats": { - "operationId": "getconversationschats", - "functionName": "getConversationsChats", - "signature": "getConversationsChats()", - "return": "ChatConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active chat conversations for the logged in user\nGetConversationsChatsRequest.getConversationsChats() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsChatsRequest.getConversationsChats was successful\")\n dump(response)\n }\n}" - }, - "getconversationscobrowsesession": { - "operationId": "getconversationscobrowsesession", - "functionName": "getConversationsCobrowsesession", - "signature": "getConversationsCobrowsesession(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "CobrowseConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get cobrowse conversation\nGetConversationsCobrowsesessionRequest.getConversationsCobrowsesession(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCobrowsesessionRequest.getConversationsCobrowsesession was successful\")\n dump(response)\n }\n}" - }, - "getconversationscobrowsesessionparticipantcommunicationwrapup": { - "operationId": "getconversationscobrowsesessionparticipantcommunicationwrapup", - "functionName": "getConversationsCobrowsesessionParticipantCommunicationWrapup", - "signature": "getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsCobrowsesessionParticipantCommunicationWrapupRequest.getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCobrowsesessionParticipantCommunicationWrapupRequest.getConversationsCobrowsesessionParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscobrowsesessionparticipantwrapup": { - "operationId": "getconversationscobrowsesessionparticipantwrapup", - "functionName": "getConversationsCobrowsesessionParticipantWrapup", - "signature": "getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsCobrowsesessionParticipantWrapupRequest.getConversationsCobrowsesessionParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCobrowsesessionParticipantWrapupRequest.getConversationsCobrowsesessionParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationscobrowsesessionparticipantwrapupcodes": { - "operationId": "getconversationscobrowsesessionparticipantwrapupcodes", - "functionName": "getConversationsCobrowsesessionParticipantWrapupcodes", - "signature": "getConversationsCobrowsesessionParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsCobrowsesessionParticipantWrapupcodesRequest.getConversationsCobrowsesessionParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCobrowsesessionParticipantWrapupcodesRequest.getConversationsCobrowsesessionParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationscobrowsesessions": { - "operationId": "getconversationscobrowsesessions", - "functionName": "getConversationsCobrowsesessions", - "signature": "getConversationsCobrowsesessions()", - "return": "CobrowseConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active cobrowse conversations for the logged in user\nGetConversationsCobrowsesessionsRequest.getConversationsCobrowsesessions() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsCobrowsesessionsRequest.getConversationsCobrowsesessions was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemail": { - "operationId": "getconversationsemail", - "functionName": "getConversationsEmail", - "signature": "getConversationsEmail(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "EmailConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get email conversation\nGetConversationsEmailRequest.getConversationsEmail(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailRequest.getConversationsEmail was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailmessage": { - "operationId": "getconversationsemailmessage", - "functionName": "getConversationsEmailMessage", - "signature": "getConversationsEmailMessage(conversationId, messageId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "messageId", - "type": "String", - "required": "true" - } - ], - "return": "EmailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet messageId: String = \"\" // messageId\n\n// Get conversation message\nGetConversationsEmailMessageRequest.getConversationsEmailMessage(conversationId: conversationId, messageId: messageId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailMessageRequest.getConversationsEmailMessage was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailmessages": { - "operationId": "getconversationsemailmessages", - "functionName": "getConversationsEmailMessages", - "signature": "getConversationsEmailMessages(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "EmailMessagePreviewListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get conversation messages\nGetConversationsEmailMessagesRequest.getConversationsEmailMessages(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailMessagesRequest.getConversationsEmailMessages was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailmessagesdraft": { - "operationId": "getconversationsemailmessagesdraft", - "functionName": "getConversationsEmailMessagesDraft", - "signature": "getConversationsEmailMessagesDraft(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "EmailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get conversation draft reply\nGetConversationsEmailMessagesDraftRequest.getConversationsEmailMessagesDraft(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailMessagesDraftRequest.getConversationsEmailMessagesDraft was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailparticipantcommunicationwrapup": { - "operationId": "getconversationsemailparticipantcommunicationwrapup", - "functionName": "getConversationsEmailParticipantCommunicationWrapup", - "signature": "getConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsEmailParticipantCommunicationWrapupRequest.getConversationsEmailParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailParticipantCommunicationWrapupRequest.getConversationsEmailParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailparticipantwrapup": { - "operationId": "getconversationsemailparticipantwrapup", - "functionName": "getConversationsEmailParticipantWrapup", - "signature": "getConversationsEmailParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsEmailParticipantWrapupRequest.getConversationsEmailParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailParticipantWrapupRequest.getConversationsEmailParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailparticipantwrapupcodes": { - "operationId": "getconversationsemailparticipantwrapupcodes", - "functionName": "getConversationsEmailParticipantWrapupcodes", - "signature": "getConversationsEmailParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsEmailParticipantWrapupcodesRequest.getConversationsEmailParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailParticipantWrapupcodesRequest.getConversationsEmailParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemailsettings": { - "operationId": "getconversationsemailsettings", - "functionName": "getConversationsEmailSettings", - "signature": "getConversationsEmailSettings(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "EmailsSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get emails settings for a given conversation\nGetConversationsEmailSettingsRequest.getConversationsEmailSettings(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailSettingsRequest.getConversationsEmailSettings was successful\")\n dump(response)\n }\n}" - }, - "getconversationsemails": { - "operationId": "getconversationsemails", - "functionName": "getConversationsEmails", - "signature": "getConversationsEmails()", - "return": "EmailConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active email conversations for the logged in user\nGetConversationsEmailsRequest.getConversationsEmails() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsEmailsRequest.getConversationsEmails was successful\")\n dump(response)\n }\n}" - }, - "getconversationskeyconfiguration": { - "operationId": "getconversationskeyconfiguration", - "functionName": "getConversationsKeyconfiguration", - "signature": "getConversationsKeyconfiguration(keyconfigurationsId)", - "parameters": [ - { - "name": "keyconfigurationsId", - "type": "String", - "required": "true" - } - ], - "return": "ConversationEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet keyconfigurationsId: String = \"\" // Key Configurations Id\n\n// Get the encryption key configurations\nGetConversationsKeyconfigurationRequest.getConversationsKeyconfiguration(keyconfigurationsId: keyconfigurationsId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsKeyconfigurationRequest.getConversationsKeyconfiguration was successful\")\n dump(response)\n }\n}" - }, - "getconversationskeyconfigurations": { - "operationId": "getconversationskeyconfigurations", - "functionName": "getConversationsKeyconfigurations", - "signature": "getConversationsKeyconfigurations()", - "return": "ConversationEncryptionConfigurationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of key configurations data\nGetConversationsKeyconfigurationsRequest.getConversationsKeyconfigurations() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsKeyconfigurationsRequest.getConversationsKeyconfigurations was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessage": { - "operationId": "getconversationsmessage", - "functionName": "getConversationsMessage", - "signature": "getConversationsMessage(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "MessageConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get message conversation\nGetConversationsMessageRequest.getConversationsMessage(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageRequest.getConversationsMessage was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagecommunicationmessagesmediamediaid": { - "operationId": "getconversationsmessagecommunicationmessagesmediamediaid", - "functionName": "getConversationsMessageCommunicationMessagesMediaMediaId", - "signature": "getConversationsMessageCommunicationMessagesMediaMediaId(conversationId, communicationId, mediaId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "mediaId", - "type": "String", - "required": "true" - } - ], - "return": "MessageMediaData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\nlet mediaId: String = \"\" // mediaId\n\n// Get media\nGetConversationsMessageCommunicationMessagesMediaMediaIdRequest.getConversationsMessageCommunicationMessagesMediaMediaId(conversationId: conversationId, communicationId: communicationId, mediaId: mediaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageCommunicationMessagesMediaMediaIdRequest.getConversationsMessageCommunicationMessagesMediaMediaId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagedetails": { - "operationId": "getconversationsmessagedetails", - "functionName": "getConversationsMessageDetails", - "signature": "getConversationsMessageDetails(messageId, useNormalizedMessage)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "useNormalizedMessage", - "type": "Bool", - "required": "false" - } - ], - "return": "MessageData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // messageId\nlet useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers)\n\n// Get message\nGetConversationsMessageDetailsRequest.getConversationsMessageDetails(messageId: messageId, useNormalizedMessage: useNormalizedMessage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageDetailsRequest.getConversationsMessageDetails was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagemessage": { - "operationId": "getconversationsmessagemessage", - "functionName": "getConversationsMessageMessage", - "signature": "getConversationsMessageMessage(conversationId, messageId, useNormalizedMessage)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "useNormalizedMessage", - "type": "Bool", - "required": "false" - } - ], - "return": "MessageData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet messageId: String = \"\" // messageId\nlet useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers)\n\n// Get conversation message\nGetConversationsMessageMessageRequest.getConversationsMessageMessage(conversationId: conversationId, messageId: messageId, useNormalizedMessage: useNormalizedMessage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageMessageRequest.getConversationsMessageMessage was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessageparticipantcommunicationwrapup": { - "operationId": "getconversationsmessageparticipantcommunicationwrapup", - "functionName": "getConversationsMessageParticipantCommunicationWrapup", - "signature": "getConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsMessageParticipantCommunicationWrapupRequest.getConversationsMessageParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageParticipantCommunicationWrapupRequest.getConversationsMessageParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessageparticipantwrapup": { - "operationId": "getconversationsmessageparticipantwrapup", - "functionName": "getConversationsMessageParticipantWrapup", - "signature": "getConversationsMessageParticipantWrapup(conversationId, participantId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation participant. \nGetConversationsMessageParticipantWrapupRequest.getConversationsMessageParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageParticipantWrapupRequest.getConversationsMessageParticipantWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessageparticipantwrapupcodes": { - "operationId": "getconversationsmessageparticipantwrapupcodes", - "functionName": "getConversationsMessageParticipantWrapupcodes", - "signature": "getConversationsMessageParticipantWrapupcodes(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Get list of wrapup codes for this conversation participant\nGetConversationsMessageParticipantWrapupcodesRequest.getConversationsMessageParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessageParticipantWrapupcodesRequest.getConversationsMessageParticipantWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessages": { - "operationId": "getconversationsmessages", - "functionName": "getConversationsMessages", - "signature": "getConversationsMessages()", - "return": "MessageConversationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get active message conversations for the logged in user\nGetConversationsMessagesRequest.getConversationsMessages() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagesRequest.getConversationsMessages was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagescachedmedia": { - "operationId": "getconversationsmessagescachedmedia", - "functionName": "getConversationsMessagesCachedmedia", - "signature": "getConversationsMessagesCachedmedia(pageSize, pageNumber, url)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "url", - "type": "String", - "required": "false" - } - ], - "return": "CachedMediaItemEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet url: String = \"\" // URL to search for\n\n// Get a list of cached media items\nGetConversationsMessagesCachedmediaRequest.getConversationsMessagesCachedmedia(pageSize: pageSize, pageNumber: pageNumber, url: url) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagesCachedmediaRequest.getConversationsMessagesCachedmedia was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagescachedmediacachedmediaitemid": { - "operationId": "getconversationsmessagescachedmediacachedmediaitemid", - "functionName": "getConversationsMessagesCachedmediaCachedMediaItemId", - "signature": "getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId)", - "parameters": [ - { - "name": "cachedMediaItemId", - "type": "String", - "required": "true" - } - ], - "return": "CachedMediaItem", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet cachedMediaItemId: String = \"\" // cachedMediaItemId\n\n// Get a cached media item\nGetConversationsMessagesCachedmediaCachedMediaItemIdRequest.getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId: cachedMediaItemId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagesCachedmediaCachedMediaItemIdRequest.getConversationsMessagesCachedmediaCachedMediaItemId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingfacebookapp": { - "operationId": "getconversationsmessagingfacebookapp", - "functionName": "getConversationsMessagingFacebookApp", - "signature": "getConversationsMessagingFacebookApp()", - "return": "FacebookAppCredentials", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Genesys Facebook App Id\nGetConversationsMessagingFacebookAppRequest.getConversationsMessagingFacebookApp() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingFacebookAppRequest.getConversationsMessagingFacebookApp was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrations": { - "operationId": "getconversationsmessagingintegrations", - "functionName": "getConversationsMessagingIntegrations", - "signature": "getConversationsMessagingIntegrations(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "MessagingIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: [String] = [\"\"] // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of Integrations\nGetConversationsMessagingIntegrationsRequest.getConversationsMessagingIntegrations(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsRequest.getConversationsMessagingIntegrations was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsfacebook": { - "operationId": "getconversationsmessagingintegrationsfacebook", - "functionName": "getConversationsMessagingIntegrationsFacebook", - "signature": "getConversationsMessagingIntegrationsFacebook(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "FacebookIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsFacebookRequest.Expand_getConversationsMessagingIntegrationsFacebook = GetConversationsMessagingIntegrationsFacebookRequest.Expand_getConversationsMessagingIntegrationsFacebook.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of Facebook Integrations\nGetConversationsMessagingIntegrationsFacebookRequest.getConversationsMessagingIntegrationsFacebook(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsFacebookRequest.getConversationsMessagingIntegrationsFacebook was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsfacebookintegrationid": { - "operationId": "getconversationsmessagingintegrationsfacebookintegrationid", - "functionName": "getConversationsMessagingIntegrationsFacebookIntegrationId", - "signature": "getConversationsMessagingIntegrationsFacebookIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "FacebookIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsFacebookIntegrationId = GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsFacebookIntegrationId.enummember // Expand instructions for the return value.\n\n// Get a Facebook messaging integration\nGetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.getConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.getConversationsMessagingIntegrationsFacebookIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsinstagram": { - "operationId": "getconversationsmessagingintegrationsinstagram", - "functionName": "getConversationsMessagingIntegrationsInstagram", - "signature": "getConversationsMessagingIntegrationsInstagram(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "InstagramIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsInstagramRequest.Expand_getConversationsMessagingIntegrationsInstagram = GetConversationsMessagingIntegrationsInstagramRequest.Expand_getConversationsMessagingIntegrationsInstagram.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of Instagram Integrations\nGetConversationsMessagingIntegrationsInstagramRequest.getConversationsMessagingIntegrationsInstagram(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsInstagramRequest.getConversationsMessagingIntegrationsInstagram was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsinstagramintegrationid": { - "operationId": "getconversationsmessagingintegrationsinstagramintegrationid", - "functionName": "getConversationsMessagingIntegrationsInstagramIntegrationId", - "signature": "getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "InstagramIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsInstagramIntegrationId = GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsInstagramIntegrationId.enummember // Expand instructions for the return value.\n\n// Get Instagram messaging integration\nGetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.getConversationsMessagingIntegrationsInstagramIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsline": { - "operationId": "getconversationsmessagingintegrationsline", - "functionName": "getConversationsMessagingIntegrationsLine", - "signature": "getConversationsMessagingIntegrationsLine(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "LineIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsLineRequest.Expand_getConversationsMessagingIntegrationsLine = GetConversationsMessagingIntegrationsLineRequest.Expand_getConversationsMessagingIntegrationsLine.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of LINE messenger Integrations\nGetConversationsMessagingIntegrationsLineRequest.getConversationsMessagingIntegrationsLine(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsLineRequest.getConversationsMessagingIntegrationsLine was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationslineintegrationid": { - "operationId": "getconversationsmessagingintegrationslineintegrationid", - "functionName": "getConversationsMessagingIntegrationsLineIntegrationId", - "signature": "getConversationsMessagingIntegrationsLineIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "LineIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsLineIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsLineIntegrationId = GetConversationsMessagingIntegrationsLineIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsLineIntegrationId.enummember // Expand instructions for the return value.\n\n// Get a LINE messenger integration\nGetConversationsMessagingIntegrationsLineIntegrationIdRequest.getConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsLineIntegrationIdRequest.getConversationsMessagingIntegrationsLineIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsopen": { - "operationId": "getconversationsmessagingintegrationsopen", - "functionName": "getConversationsMessagingIntegrationsOpen", - "signature": "getConversationsMessagingIntegrationsOpen(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "OpenIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsOpenRequest.Expand_getConversationsMessagingIntegrationsOpen = GetConversationsMessagingIntegrationsOpenRequest.Expand_getConversationsMessagingIntegrationsOpen.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of Open messaging integrations\nGetConversationsMessagingIntegrationsOpenRequest.getConversationsMessagingIntegrationsOpen(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsOpenRequest.getConversationsMessagingIntegrationsOpen was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationsopenintegrationid": { - "operationId": "getconversationsmessagingintegrationsopenintegrationid", - "functionName": "getConversationsMessagingIntegrationsOpenIntegrationId", - "signature": "getConversationsMessagingIntegrationsOpenIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "OpenIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsOpenIntegrationId = GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsOpenIntegrationId.enummember // Expand instructions for the return value.\n\n// Get an Open messaging integration\nGetConversationsMessagingIntegrationsOpenIntegrationIdRequest.getConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.getConversationsMessagingIntegrationsOpenIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationstwitter": { - "operationId": "getconversationsmessagingintegrationstwitter", - "functionName": "getConversationsMessagingIntegrationsTwitter", - "signature": "getConversationsMessagingIntegrationsTwitter(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "TwitterIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsTwitterRequest.Expand_getConversationsMessagingIntegrationsTwitter = GetConversationsMessagingIntegrationsTwitterRequest.Expand_getConversationsMessagingIntegrationsTwitter.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of Twitter Integrations\nGetConversationsMessagingIntegrationsTwitterRequest.getConversationsMessagingIntegrationsTwitter(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsTwitterRequest.getConversationsMessagingIntegrationsTwitter was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationstwitterintegrationid": { - "operationId": "getconversationsmessagingintegrationstwitterintegrationid", - "functionName": "getConversationsMessagingIntegrationsTwitterIntegrationId", - "signature": "getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "TwitterIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsTwitterIntegrationId = GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsTwitterIntegrationId.enummember // Expand instructions for the return value.\n\n// Get a Twitter messaging integration\nGetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.getConversationsMessagingIntegrationsTwitterIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationswhatsapp": { - "operationId": "getconversationsmessagingintegrationswhatsapp", - "functionName": "getConversationsMessagingIntegrationsWhatsapp", - "signature": "getConversationsMessagingIntegrationsWhatsapp(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "supportedContentId", - "type": "String", - "required": "false" - }, - { - "name": "messagingSettingId", - "type": "String", - "required": "false" - } - ], - "return": "WhatsAppIntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: GetConversationsMessagingIntegrationsWhatsappRequest.Expand_getConversationsMessagingIntegrationsWhatsapp = GetConversationsMessagingIntegrationsWhatsappRequest.Expand_getConversationsMessagingIntegrationsWhatsapp.enummember // Expand instructions for the return value.\nlet supportedContentId: String = \"\" // Filter integrations returned based on the supported content ID\nlet messagingSettingId: String = \"\" // Filter integrations returned based on the setting ID\n\n// Get a list of WhatsApp Integrations\nGetConversationsMessagingIntegrationsWhatsappRequest.getConversationsMessagingIntegrationsWhatsapp(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsWhatsappRequest.getConversationsMessagingIntegrationsWhatsapp was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingintegrationswhatsappintegrationid": { - "operationId": "getconversationsmessagingintegrationswhatsappintegrationid", - "functionName": "getConversationsMessagingIntegrationsWhatsappIntegrationId", - "signature": "getConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId, expand)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "WhatsAppIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet expand: GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsWhatsappIntegrationId = GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsWhatsappIntegrationId.enummember // Expand instructions for the return value.\n\n// Get a WhatsApp messaging integration\nGetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.getConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.getConversationsMessagingIntegrationsWhatsappIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsetting": { - "operationId": "getconversationsmessagingsetting", - "functionName": "getConversationsMessagingSetting", - "signature": "getConversationsMessagingSetting(messageSettingId)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Setting ID\n\n// Get a messaging setting\nGetConversationsMessagingSettingRequest.getConversationsMessagingSetting(messageSettingId: messageSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSettingRequest.getConversationsMessagingSetting was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsettings": { - "operationId": "getconversationsmessagingsettings", - "functionName": "getConversationsMessagingSettings", - "signature": "getConversationsMessagingSettings(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "MessagingConfigListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of messaging settings\nGetConversationsMessagingSettingsRequest.getConversationsMessagingSettings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSettingsRequest.getConversationsMessagingSettings was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsettingsdefault": { - "operationId": "getconversationsmessagingsettingsdefault", - "functionName": "getConversationsMessagingSettingsDefault", - "signature": "getConversationsMessagingSettingsDefault()", - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the organization's default settings that will be used as the default when creating an integration.\nGetConversationsMessagingSettingsDefaultRequest.getConversationsMessagingSettingsDefault() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSettingsDefaultRequest.getConversationsMessagingSettingsDefault was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsticker": { - "operationId": "getconversationsmessagingsticker", - "functionName": "getConversationsMessagingSticker", - "signature": "getConversationsMessagingSticker(messengerType, pageSize, pageNumber)", - "parameters": [ - { - "name": "messengerType", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "MessagingStickerEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messengerType: GetConversationsMessagingStickerRequest.MessengerType_getConversationsMessagingSticker = GetConversationsMessagingStickerRequest.MessengerType_getConversationsMessagingSticker.enummember // Messenger Type\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of Messaging Stickers\nGetConversationsMessagingStickerRequest.getConversationsMessagingSticker(messengerType: messengerType, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingStickerRequest.getConversationsMessagingSticker was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsupportedcontent": { - "operationId": "getconversationsmessagingsupportedcontent", - "functionName": "getConversationsMessagingSupportedcontent", - "signature": "getConversationsMessagingSupportedcontent(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "SupportedContentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of Supported Content profiles\nGetConversationsMessagingSupportedcontentRequest.getConversationsMessagingSupportedcontent(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSupportedcontentRequest.getConversationsMessagingSupportedcontent was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsupportedcontentdefault": { - "operationId": "getconversationsmessagingsupportedcontentdefault", - "functionName": "getConversationsMessagingSupportedcontentDefault", - "signature": "getConversationsMessagingSupportedcontentDefault()", - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the organization's default supported content profile that will be used as the default when creating an integration.\nGetConversationsMessagingSupportedcontentDefaultRequest.getConversationsMessagingSupportedcontentDefault() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSupportedcontentDefaultRequest.getConversationsMessagingSupportedcontentDefault was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingsupportedcontentsupportedcontentid": { - "operationId": "getconversationsmessagingsupportedcontentsupportedcontentid", - "functionName": "getConversationsMessagingSupportedcontentSupportedContentId", - "signature": "getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\n\n// Get a supported content profile\nGetConversationsMessagingSupportedcontentSupportedContentIdRequest.getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingSupportedcontentSupportedContentIdRequest.getConversationsMessagingSupportedcontentSupportedContentId was successful\")\n dump(response)\n }\n}" - }, - "getconversationsmessagingthreadingtimeline": { - "operationId": "getconversationsmessagingthreadingtimeline", - "functionName": "getConversationsMessagingThreadingtimeline", - "signature": "getConversationsMessagingThreadingtimeline()", - "return": "ConversationThreadingWindow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get conversation threading window timeline for each messaging type\nGetConversationsMessagingThreadingtimelineRequest.getConversationsMessagingThreadingtimeline() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsMessagingThreadingtimelineRequest.getConversationsMessagingThreadingtimeline was successful\")\n dump(response)\n }\n}" - }, - "getconversationsscreenshareparticipantcommunicationwrapup": { - "operationId": "getconversationsscreenshareparticipantcommunicationwrapup", - "functionName": "getConversationsScreenshareParticipantCommunicationWrapup", - "signature": "getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsScreenshareParticipantCommunicationWrapupRequest.getConversationsScreenshareParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsScreenshareParticipantCommunicationWrapupRequest.getConversationsScreenshareParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationssettings": { - "operationId": "getconversationssettings", - "functionName": "getConversationsSettings", - "signature": "getConversationsSettings()", - "return": "Settings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Settings\nGetConversationsSettingsRequest.getConversationsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsSettingsRequest.getConversationsSettings was successful\")\n dump(response)\n }\n}" - }, - "getconversationssocialparticipantcommunicationwrapup": { - "operationId": "getconversationssocialparticipantcommunicationwrapup", - "functionName": "getConversationsSocialParticipantCommunicationWrapup", - "signature": "getConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsSocialParticipantCommunicationWrapupRequest.getConversationsSocialParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsSocialParticipantCommunicationWrapupRequest.getConversationsSocialParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "getconversationsvideoparticipantcommunicationwrapup": { - "operationId": "getconversationsvideoparticipantcommunicationwrapup", - "functionName": "getConversationsVideoParticipantCommunicationWrapup", - "signature": "getConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "provisional", - "type": "Bool", - "required": "false" - } - ], - "return": "AssignedWrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet provisional: Bool = true // Indicates if the wrap-up code is provisional.\n\n// Get the wrap-up for this conversation communication. \nGetConversationsVideoParticipantCommunicationWrapupRequest.getConversationsVideoParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationsVideoParticipantCommunicationWrapupRequest.getConversationsVideoParticipantCommunicationWrapup was successful\")\n dump(response)\n }\n}" - }, - "patchconversationparticipant": { - "operationId": "patchconversationparticipant", - "functionName": "patchConversationParticipant", - "signature": "patchConversationParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request\n\n// Update a participant.\nPatchConversationParticipantRequest.patchConversationParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationParticipantRequest.patchConversationParticipant was successful\")\n }\n}" - }, - "patchconversationparticipantattributes": { - "operationId": "patchconversationparticipantattributes", - "functionName": "patchConversationParticipantAttributes", - "signature": "patchConversationParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes\n\n// Update the attributes on a conversation participant.\nPatchConversationParticipantAttributesRequest.patchConversationParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationParticipantAttributesRequest.patchConversationParticipantAttributes was successful\")\n }\n}" - }, - "patchconversationsecureattributes": { - "operationId": "patchconversationsecureattributes", - "functionName": "patchConversationSecureattributes", - "signature": "patchConversationSecureattributes(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationSecureAttributes", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet body: ConversationSecureAttributes = new ConversationSecureAttributes(...) // Conversation Secure Attributes\n\n// Update the secure attributes on a conversation.\nPatchConversationSecureattributesRequest.patchConversationSecureattributes(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationSecureattributesRequest.patchConversationSecureattributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsaftercallworkconversationidparticipantcommunication": { - "operationId": "patchconversationsaftercallworkconversationidparticipantcommunication", - "functionName": "patchConversationsAftercallworkConversationIdParticipantCommunication", - "signature": "patchConversationsAftercallworkConversationIdParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AfterCallWorkUpdate", - "required": "true" - } - ], - "return": "AfterCallWorkUpdate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: AfterCallWorkUpdate = new AfterCallWorkUpdate(...) // AfterCallWorkUpdate\n\n// Update after-call work for this conversation communication.\nPatchConversationsAftercallworkConversationIdParticipantCommunicationRequest.patchConversationsAftercallworkConversationIdParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsAftercallworkConversationIdParticipantCommunicationRequest.patchConversationsAftercallworkConversationIdParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscall": { - "operationId": "patchconversationscall", - "functionName": "patchConversationsCall", - "signature": "patchConversationsCall(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants\nPatchConversationsCallRequest.patchConversationsCall(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallRequest.patchConversationsCall was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallparticipant": { - "operationId": "patchconversationscallparticipant", - "functionName": "patchConversationsCallParticipant", - "signature": "patchConversationsCallParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant request\n\n// Update conversation participant\nPatchConversationsCallParticipantRequest.patchConversationsCallParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsCallParticipantRequest.patchConversationsCallParticipant was successful\")\n }\n}" - }, - "patchconversationscallparticipantattributes": { - "operationId": "patchconversationscallparticipantattributes", - "functionName": "patchConversationsCallParticipantAttributes", - "signature": "patchConversationsCallParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "true" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes\n\n// Update the attributes on a conversation participant.\nPatchConversationsCallParticipantAttributesRequest.patchConversationsCallParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallParticipantAttributesRequest.patchConversationsCallParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallparticipantcommunication": { - "operationId": "patchconversationscallparticipantcommunication", - "functionName": "patchConversationsCallParticipantCommunication", - "signature": "patchConversationsCallParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsCallParticipantCommunicationRequest.patchConversationsCallParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallParticipantCommunicationRequest.patchConversationsCallParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallparticipantconsult": { - "operationId": "patchconversationscallparticipantconsult", - "functionName": "patchConversationsCallParticipantConsult", - "signature": "patchConversationsCallParticipantConsult(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConsultTransferUpdate", - "required": "true" - } - ], - "return": "ConsultTransferResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ConsultTransferUpdate = new ConsultTransferUpdate(...) // new speak to\n\n// Change who can speak\nPatchConversationsCallParticipantConsultRequest.patchConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallParticipantConsultRequest.patchConversationsCallParticipantConsult was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallback": { - "operationId": "patchconversationscallback", - "functionName": "patchConversationsCallback", - "signature": "patchConversationsCallback(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by disconnecting all of the participants\nPatchConversationsCallbackRequest.patchConversationsCallback(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallbackRequest.patchConversationsCallback was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallbackparticipant": { - "operationId": "patchconversationscallbackparticipant", - "functionName": "patchConversationsCallbackParticipant", - "signature": "patchConversationsCallbackParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant\nPatchConversationsCallbackParticipantRequest.patchConversationsCallbackParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsCallbackParticipantRequest.patchConversationsCallbackParticipant was successful\")\n }\n}" - }, - "patchconversationscallbackparticipantattributes": { - "operationId": "patchconversationscallbackparticipantattributes", - "functionName": "patchConversationsCallbackParticipantAttributes", - "signature": "patchConversationsCallbackParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "true" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // Attributes\n\n// Update the attributes on a conversation participant.\nPatchConversationsCallbackParticipantAttributesRequest.patchConversationsCallbackParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallbackParticipantAttributesRequest.patchConversationsCallbackParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallbackparticipantcommunication": { - "operationId": "patchconversationscallbackparticipantcommunication", - "functionName": "patchConversationsCallbackParticipantCommunication", - "signature": "patchConversationsCallbackParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsCallbackParticipantCommunicationRequest.patchConversationsCallbackParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallbackParticipantCommunicationRequest.patchConversationsCallbackParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscallbacks": { - "operationId": "patchconversationscallbacks", - "functionName": "patchConversationsCallbacks", - "signature": "patchConversationsCallbacks(body)", - "parameters": [ - { - "name": "body", - "type": "PatchCallbackRequest", - "required": "true" - } - ], - "return": "PatchCallbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PatchCallbackRequest = new PatchCallbackRequest(...) // PatchCallbackRequest\n\n// Update a scheduled callback\nPatchConversationsCallbacksRequest.patchConversationsCallbacks(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCallbacksRequest.patchConversationsCallbacks was successful\")\n dump(response)\n }\n}" - }, - "patchconversationschat": { - "operationId": "patchconversationschat", - "functionName": "patchConversationsChat", - "signature": "patchConversationsChat(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by disconnecting all of the participants\nPatchConversationsChatRequest.patchConversationsChat(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsChatRequest.patchConversationsChat was successful\")\n dump(response)\n }\n}" - }, - "patchconversationschatparticipant": { - "operationId": "patchconversationschatparticipant", - "functionName": "patchConversationsChatParticipant", - "signature": "patchConversationsChatParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request\n\n// Update conversation participant\nPatchConversationsChatParticipantRequest.patchConversationsChatParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsChatParticipantRequest.patchConversationsChatParticipant was successful\")\n }\n}" - }, - "patchconversationschatparticipantattributes": { - "operationId": "patchconversationschatparticipantattributes", - "functionName": "patchConversationsChatParticipantAttributes", - "signature": "patchConversationsChatParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "true" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes\n\n// Update the attributes on a conversation participant.\nPatchConversationsChatParticipantAttributesRequest.patchConversationsChatParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsChatParticipantAttributesRequest.patchConversationsChatParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationschatparticipantcommunication": { - "operationId": "patchconversationschatparticipantcommunication", - "functionName": "patchConversationsChatParticipantCommunication", - "signature": "patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsChatParticipantCommunicationRequest.patchConversationsChatParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsChatParticipantCommunicationRequest.patchConversationsChatParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscobrowsesession": { - "operationId": "patchconversationscobrowsesession", - "functionName": "patchConversationsCobrowsesession", - "signature": "patchConversationsCobrowsesession(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by disconnecting all of the participants\nPatchConversationsCobrowsesessionRequest.patchConversationsCobrowsesession(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCobrowsesessionRequest.patchConversationsCobrowsesession was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscobrowsesessionparticipant": { - "operationId": "patchconversationscobrowsesessionparticipant", - "functionName": "patchConversationsCobrowsesessionParticipant", - "signature": "patchConversationsCobrowsesessionParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // \n\n// Update conversation participant\nPatchConversationsCobrowsesessionParticipantRequest.patchConversationsCobrowsesessionParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsCobrowsesessionParticipantRequest.patchConversationsCobrowsesessionParticipant was successful\")\n }\n}" - }, - "patchconversationscobrowsesessionparticipantattributes": { - "operationId": "patchconversationscobrowsesessionparticipantattributes", - "functionName": "patchConversationsCobrowsesessionParticipantAttributes", - "signature": "patchConversationsCobrowsesessionParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "false" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // \n\n// Update the attributes on a conversation participant.\nPatchConversationsCobrowsesessionParticipantAttributesRequest.patchConversationsCobrowsesessionParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCobrowsesessionParticipantAttributesRequest.patchConversationsCobrowsesessionParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationscobrowsesessionparticipantcommunication": { - "operationId": "patchconversationscobrowsesessionparticipantcommunication", - "functionName": "patchConversationsCobrowsesessionParticipantCommunication", - "signature": "patchConversationsCobrowsesessionParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsCobrowsesessionParticipantCommunicationRequest.patchConversationsCobrowsesessionParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsCobrowsesessionParticipantCommunicationRequest.patchConversationsCobrowsesessionParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsemail": { - "operationId": "patchconversationsemail", - "functionName": "patchConversationsEmail", - "signature": "patchConversationsEmail(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by disconnecting all of the participants\nPatchConversationsEmailRequest.patchConversationsEmail(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsEmailRequest.patchConversationsEmail was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsemailmessagesdraft": { - "operationId": "patchconversationsemailmessagesdraft", - "functionName": "patchConversationsEmailMessagesDraft", - "signature": "patchConversationsEmailMessagesDraft(conversationId, autoFill, discard, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "autoFill", - "type": "Bool", - "required": "false" - }, - { - "name": "discard", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "DraftManipulationRequest", - "required": "false" - } - ], - "return": "EmailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet autoFill: Bool = true // autoFill\nlet discard: Bool = true // discard\nlet body: DraftManipulationRequest = new DraftManipulationRequest(...) // Draft Manipulation Request\n\n// Reset conversation draft to its initial state and/or auto-fill draft content\nPatchConversationsEmailMessagesDraftRequest.patchConversationsEmailMessagesDraft(conversationId: conversationId, autoFill: autoFill, discard: discard, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsEmailMessagesDraftRequest.patchConversationsEmailMessagesDraft was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsemailparticipant": { - "operationId": "patchconversationsemailparticipant", - "functionName": "patchConversationsEmailParticipant", - "signature": "patchConversationsEmailParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request\n\n// Update conversation participant\nPatchConversationsEmailParticipantRequest.patchConversationsEmailParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsEmailParticipantRequest.patchConversationsEmailParticipant was successful\")\n }\n}" - }, - "patchconversationsemailparticipantattributes": { - "operationId": "patchconversationsemailparticipantattributes", - "functionName": "patchConversationsEmailParticipantAttributes", - "signature": "patchConversationsEmailParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "true" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes\n\n// Update the attributes on a conversation participant.\nPatchConversationsEmailParticipantAttributesRequest.patchConversationsEmailParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsEmailParticipantAttributesRequest.patchConversationsEmailParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsemailparticipantcommunication": { - "operationId": "patchconversationsemailparticipantcommunication", - "functionName": "patchConversationsEmailParticipantCommunication", - "signature": "patchConversationsEmailParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsEmailParticipantCommunicationRequest.patchConversationsEmailParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsEmailParticipantCommunicationRequest.patchConversationsEmailParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessage": { - "operationId": "patchconversationsmessage", - "functionName": "patchConversationsMessage", - "signature": "patchConversationsMessage(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Update a conversation by disconnecting all of the participants\nPatchConversationsMessageRequest.patchConversationsMessage(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessageRequest.patchConversationsMessage was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessageparticipant": { - "operationId": "patchconversationsmessageparticipant", - "functionName": "patchConversationsMessageParticipant", - "signature": "patchConversationsMessageParticipant(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // \n\n// Update conversation participant\nPatchConversationsMessageParticipantRequest.patchConversationsMessageParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsMessageParticipantRequest.patchConversationsMessageParticipant was successful\")\n }\n}" - }, - "patchconversationsmessageparticipantattributes": { - "operationId": "patchconversationsmessageparticipantattributes", - "functionName": "patchConversationsMessageParticipantAttributes", - "signature": "patchConversationsMessageParticipantAttributes(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ParticipantAttributes", - "required": "false" - } - ], - "return": "ParticipantAttributes", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ParticipantAttributes = new ParticipantAttributes(...) // \n\n// Update the attributes on a conversation participant.\nPatchConversationsMessageParticipantAttributesRequest.patchConversationsMessageParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessageParticipantAttributesRequest.patchConversationsMessageParticipantAttributes was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessageparticipantcommunication": { - "operationId": "patchconversationsmessageparticipantcommunication", - "functionName": "patchConversationsMessageParticipantCommunication", - "signature": "patchConversationsMessageParticipantCommunication(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MediaParticipantRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant\n\n// Update conversation participant's communication by disconnecting it.\nPatchConversationsMessageParticipantCommunicationRequest.patchConversationsMessageParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessageParticipantCommunicationRequest.patchConversationsMessageParticipantCommunication was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingintegrationsfacebookintegrationid": { - "operationId": "patchconversationsmessagingintegrationsfacebookintegrationid", - "functionName": "patchConversationsMessagingIntegrationsFacebookIntegrationId", - "signature": "patchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "FacebookIntegrationUpdateRequest", - "required": "true" - } - ], - "return": "FacebookIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: FacebookIntegrationUpdateRequest = new FacebookIntegrationUpdateRequest(...) // FacebookIntegrationUpdateRequest\n\n// Update Facebook messaging integration\nPatchConversationsMessagingIntegrationsFacebookIntegrationIdRequest.patchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingIntegrationsFacebookIntegrationIdRequest.patchConversationsMessagingIntegrationsFacebookIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingintegrationsinstagramintegrationid": { - "operationId": "patchconversationsmessagingintegrationsinstagramintegrationid", - "functionName": "patchConversationsMessagingIntegrationsInstagramIntegrationId", - "signature": "patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InstagramIntegrationUpdateRequest", - "required": "true" - } - ], - "return": "InstagramIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: InstagramIntegrationUpdateRequest = new InstagramIntegrationUpdateRequest(...) // InstagramIntegrationUpdateRequest\n\n// Update Instagram messaging integration\nPatchConversationsMessagingIntegrationsInstagramIntegrationIdRequest.patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingIntegrationsInstagramIntegrationIdRequest.patchConversationsMessagingIntegrationsInstagramIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingintegrationsopenintegrationid": { - "operationId": "patchconversationsmessagingintegrationsopenintegrationid", - "functionName": "patchConversationsMessagingIntegrationsOpenIntegrationId", - "signature": "patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OpenIntegrationUpdateRequest", - "required": "true" - } - ], - "return": "OpenIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: OpenIntegrationUpdateRequest = new OpenIntegrationUpdateRequest(...) // OpenIntegrationUpdateRequest\n\n// Update an Open messaging integration\nPatchConversationsMessagingIntegrationsOpenIntegrationIdRequest.patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingIntegrationsOpenIntegrationIdRequest.patchConversationsMessagingIntegrationsOpenIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingintegrationstwitterintegrationid": { - "operationId": "patchconversationsmessagingintegrationstwitterintegrationid", - "functionName": "patchConversationsMessagingIntegrationsTwitterIntegrationId", - "signature": "patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TwitterIntegrationRequest", - "required": "true" - } - ], - "return": "TwitterIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: TwitterIntegrationRequest = new TwitterIntegrationRequest(...) // TwitterIntegrationRequest\n\n// Update Twitter messaging integration\nPatchConversationsMessagingIntegrationsTwitterIntegrationIdRequest.patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingIntegrationsTwitterIntegrationIdRequest.patchConversationsMessagingIntegrationsTwitterIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingintegrationswhatsappintegrationid": { - "operationId": "patchconversationsmessagingintegrationswhatsappintegrationid", - "functionName": "patchConversationsMessagingIntegrationsWhatsappIntegrationId", - "signature": "patchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WhatsAppIntegrationUpdateRequest", - "required": "true" - } - ], - "return": "WhatsAppIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: WhatsAppIntegrationUpdateRequest = new WhatsAppIntegrationUpdateRequest(...) // WhatsAppIntegrationUpdateRequest\n\n// Update or activate a WhatsApp messaging integration\nPatchConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.patchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.patchConversationsMessagingIntegrationsWhatsappIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingsetting": { - "operationId": "patchconversationsmessagingsetting", - "functionName": "patchConversationsMessagingSetting", - "signature": "patchConversationsMessagingSetting(messageSettingId, body)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MessagingSettingPatchRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Setting ID\nlet body: MessagingSettingPatchRequest = new MessagingSettingPatchRequest(...) // MessagingSetting\n\n// Update a messaging setting\nPatchConversationsMessagingSettingRequest.patchConversationsMessagingSetting(messageSettingId: messageSettingId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingSettingRequest.patchConversationsMessagingSetting was successful\")\n dump(response)\n }\n}" - }, - "patchconversationsmessagingsupportedcontentsupportedcontentid": { - "operationId": "patchconversationsmessagingsupportedcontentsupportedcontentid", - "functionName": "patchConversationsMessagingSupportedcontentSupportedContentId", - "signature": "patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SupportedContent", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\nlet body: SupportedContent = new SupportedContent(...) // SupportedContent\n\n// Update a supported content profile\nPatchConversationsMessagingSupportedcontentSupportedContentIdRequest.patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchConversationsMessagingSupportedcontentSupportedContentIdRequest.patchConversationsMessagingSupportedcontentSupportedContentId was successful\")\n dump(response)\n }\n}" - }, - "patchconversationssettings": { - "operationId": "patchconversationssettings", - "functionName": "patchConversationsSettings", - "signature": "patchConversationsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "Settings", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Settings = new Settings(...) // Settings\n\n// Update Settings\nPatchConversationsSettingsRequest.patchConversationsSettings(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchConversationsSettingsRequest.patchConversationsSettings was successful\")\n }\n}" - }, - "postconversationassign": { - "operationId": "postconversationassign", - "functionName": "postConversationAssign", - "signature": "postConversationAssign(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationUser", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet body: ConversationUser = new ConversationUser(...) // Targeted user\n\n// Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.\nPostConversationAssignRequest.postConversationAssign(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationAssignRequest.postConversationAssign was successful\")\n dump(response)\n }\n}" - }, - "postconversationcobrowse": { - "operationId": "postconversationcobrowse", - "functionName": "postConversationCobrowse", - "signature": "postConversationCobrowse(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "CobrowseWebMessagingSession", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\n\n// Creates a cobrowse session. Requires \\\"conversation:cobrowse:add\\\" (for web messaging) or \\\"conversation:cobrowsevoice:add\\\" permission.\nPostConversationCobrowseRequest.postConversationCobrowse(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationCobrowseRequest.postConversationCobrowse was successful\")\n dump(response)\n }\n}" - }, - "postconversationdisconnect": { - "operationId": "postconversationdisconnect", - "functionName": "postConversationDisconnect", - "signature": "postConversationDisconnect(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\n\n// 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.\nPostConversationDisconnectRequest.postConversationDisconnect(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationDisconnectRequest.postConversationDisconnect was successful\")\n dump(response)\n }\n}" - }, - "postconversationparticipantcallbacks": { - "operationId": "postconversationparticipantcallbacks", - "functionName": "postConversationParticipantCallbacks", - "signature": "postConversationParticipantCallbacks(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateCallbackOnConversationCommand", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: CreateCallbackOnConversationCommand = new CreateCallbackOnConversationCommand(...) // \n\n// Create a new callback for the specified participant on the conversation.\nPostConversationParticipantCallbacksRequest.postConversationParticipantCallbacks(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationParticipantCallbacksRequest.postConversationParticipantCallbacks was successful\")\n }\n}" - }, - "postconversationparticipantdigits": { - "operationId": "postconversationparticipantdigits", - "functionName": "postConversationParticipantDigits", - "signature": "postConversationParticipantDigits(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Digits", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: Digits = new Digits(...) // Digits\n\n// Sends DTMF to the participant\nPostConversationParticipantDigitsRequest.postConversationParticipantDigits(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationParticipantDigitsRequest.postConversationParticipantDigits was successful\")\n }\n}" - }, - "postconversationparticipantreplace": { - "operationId": "postconversationparticipantreplace", - "functionName": "postConversationParticipantReplace", - "signature": "postConversationParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationParticipantReplaceRequest.postConversationParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationParticipantReplaceRequest.postConversationParticipantReplace was successful\")\n }\n}" - }, - "postconversationparticipantsecureivrsessions": { - "operationId": "postconversationparticipantsecureivrsessions", - "functionName": "postConversationParticipantSecureivrsessions", - "signature": "postConversationParticipantSecureivrsessions(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateSecureSession", - "required": "false" - } - ], - "return": "SecureSession", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\nlet body: CreateSecureSession = new CreateSecureSession(...) // \n\n// Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.\nPostConversationParticipantSecureivrsessionsRequest.postConversationParticipantSecureivrsessions(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationParticipantSecureivrsessionsRequest.postConversationParticipantSecureivrsessions was successful\")\n dump(response)\n }\n}" - }, - "postconversationscall": { - "operationId": "postconversationscall", - "functionName": "postConversationsCall", - "signature": "postConversationsCall(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CallCommand", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: CallCommand = new CallCommand(...) // Conversation\n\n// Place a new call as part of a callback conversation.\nPostConversationsCallRequest.postConversationsCall(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallRequest.postConversationsCall was successful\")\n dump(response)\n }\n}" - }, - "postconversationscallparticipantcoach": { - "operationId": "postconversationscallparticipantcoach", - "functionName": "postConversationsCallParticipantCoach", - "signature": "postConversationsCallParticipantCoach(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.\nPostConversationsCallParticipantCoachRequest.postConversationsCallParticipantCoach(conversationId: conversationId, participantId: participantId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallParticipantCoachRequest.postConversationsCallParticipantCoach was successful\")\n }\n}" - }, - "postconversationscallparticipantcommunicationwrapup": { - "operationId": "postconversationscallparticipantcommunicationwrapup", - "functionName": "postConversationsCallParticipantCommunicationWrapup", - "signature": "postConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsCallParticipantCommunicationWrapupRequest.postConversationsCallParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallParticipantCommunicationWrapupRequest.postConversationsCallParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationscallparticipantconsult": { - "operationId": "postconversationscallparticipantconsult", - "functionName": "postConversationsCallParticipantConsult", - "signature": "postConversationsCallParticipantConsult(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConsultTransfer", - "required": "true" - } - ], - "return": "ConsultTransferResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: ConsultTransfer = new ConsultTransfer(...) // Destination address & initial speak to\n\n// Initiate and update consult transfer\nPostConversationsCallParticipantConsultRequest.postConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallParticipantConsultRequest.postConversationsCallParticipantConsult was successful\")\n dump(response)\n }\n}" - }, - "postconversationscallparticipantmonitor": { - "operationId": "postconversationscallparticipantmonitor", - "functionName": "postConversationsCallParticipantMonitor", - "signature": "postConversationsCallParticipantMonitor(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\n\n// Listen in on the conversation from the point of view of a given participant.\nPostConversationsCallParticipantMonitorRequest.postConversationsCallParticipantMonitor(conversationId: conversationId, participantId: participantId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallParticipantMonitorRequest.postConversationsCallParticipantMonitor was successful\")\n }\n}" - }, - "postconversationscallparticipantreplace": { - "operationId": "postconversationscallparticipantreplace", - "functionName": "postConversationsCallParticipantReplace", - "signature": "postConversationsCallParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationsCallParticipantReplaceRequest.postConversationsCallParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallParticipantReplaceRequest.postConversationsCallParticipantReplace was successful\")\n }\n}" - }, - "postconversationscallparticipants": { - "operationId": "postconversationscallparticipants", - "functionName": "postConversationsCallParticipants", - "signature": "postConversationsCallParticipants(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Conversation", - "required": "true" - } - ], - "return": "Conversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Conversation = new Conversation(...) // Conversation\n\n// Add participants to a conversation\nPostConversationsCallParticipantsRequest.postConversationsCallParticipants(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallParticipantsRequest.postConversationsCallParticipants was successful\")\n dump(response)\n }\n}" - }, - "postconversationscallbackparticipantcommunicationwrapup": { - "operationId": "postconversationscallbackparticipantcommunicationwrapup", - "functionName": "postConversationsCallbackParticipantCommunicationWrapup", - "signature": "postConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsCallbackParticipantCommunicationWrapupRequest.postConversationsCallbackParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallbackParticipantCommunicationWrapupRequest.postConversationsCallbackParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationscallbackparticipantreplace": { - "operationId": "postconversationscallbackparticipantreplace", - "functionName": "postConversationsCallbackParticipantReplace", - "signature": "postConversationsCallbackParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationsCallbackParticipantReplaceRequest.postConversationsCallbackParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallbackParticipantReplaceRequest.postConversationsCallbackParticipantReplace was successful\")\n }\n}" - }, - "postconversationscallbacks": { - "operationId": "postconversationscallbacks", - "functionName": "postConversationsCallbacks", - "signature": "postConversationsCallbacks(body)", - "parameters": [ - { - "name": "body", - "type": "CreateCallbackCommand", - "required": "true" - } - ], - "return": "CreateCallbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateCallbackCommand = new CreateCallbackCommand(...) // Callback\n\n// Create a Callback\nPostConversationsCallbacksRequest.postConversationsCallbacks(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallbacksRequest.postConversationsCallbacks was successful\")\n dump(response)\n }\n}" - }, - "postconversationscallbacksbulkdisconnect": { - "operationId": "postconversationscallbacksbulkdisconnect", - "functionName": "postConversationsCallbacksBulkDisconnect", - "signature": "postConversationsCallbacksBulkDisconnect(body)", - "parameters": [ - { - "name": "body", - "type": "BulkCallbackDisconnectRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkCallbackDisconnectRequest = new BulkCallbackDisconnectRequest(...) // BulkCallbackDisconnectRequest\n\n// Disconnect multiple scheduled callbacks\nPostConversationsCallbacksBulkDisconnectRequest.postConversationsCallbacksBulkDisconnect(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCallbacksBulkDisconnectRequest.postConversationsCallbacksBulkDisconnect was successful\")\n }\n}" - }, - "postconversationscallbacksbulkupdate": { - "operationId": "postconversationscallbacksbulkupdate", - "functionName": "postConversationsCallbacksBulkUpdate", - "signature": "postConversationsCallbacksBulkUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "BulkCallbackPatchRequest", - "required": "true" - } - ], - "return": "BulkCallbackPatchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkCallbackPatchRequest = new BulkCallbackPatchRequest(...) // BulkCallbackPatchRequest\n\n// Update multiple scheduled callbacks\nPostConversationsCallbacksBulkUpdateRequest.postConversationsCallbacksBulkUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallbacksBulkUpdateRequest.postConversationsCallbacksBulkUpdate was successful\")\n dump(response)\n }\n}" - }, - "postconversationscalls": { - "operationId": "postconversationscalls", - "functionName": "postConversationsCalls", - "signature": "postConversationsCalls(body)", - "parameters": [ - { - "name": "body", - "type": "CreateCallRequest", - "required": "true" - } - ], - "return": "CreateCallResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateCallRequest = new CreateCallRequest(...) // Call request\n\n// Create a call conversation\nPostConversationsCallsRequest.postConversationsCalls(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsCallsRequest.postConversationsCalls was successful\")\n dump(response)\n }\n}" - }, - "postconversationschatcommunicationmessages": { - "operationId": "postconversationschatcommunicationmessages", - "functionName": "postConversationsChatCommunicationMessages", - "signature": "postConversationsChatCommunicationMessages(conversationId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateWebChatMessageRequest", - "required": "true" - } - ], - "return": "WebChatMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\nlet body: CreateWebChatMessageRequest = new CreateWebChatMessageRequest(...) // Message\n\n// Send a message on behalf of a communication in a chat conversation.\nPostConversationsChatCommunicationMessagesRequest.postConversationsChatCommunicationMessages(conversationId: conversationId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsChatCommunicationMessagesRequest.postConversationsChatCommunicationMessages was successful\")\n dump(response)\n }\n}" - }, - "postconversationschatcommunicationtyping": { - "operationId": "postconversationschatcommunicationtyping", - "functionName": "postConversationsChatCommunicationTyping", - "signature": "postConversationsChatCommunicationTyping(conversationId, communicationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatTyping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\n\n// Send a typing-indicator on behalf of a communication in a chat conversation.\nPostConversationsChatCommunicationTypingRequest.postConversationsChatCommunicationTyping(conversationId: conversationId, communicationId: communicationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsChatCommunicationTypingRequest.postConversationsChatCommunicationTyping was successful\")\n dump(response)\n }\n}" - }, - "postconversationschatparticipantcommunicationwrapup": { - "operationId": "postconversationschatparticipantcommunicationwrapup", - "functionName": "postConversationsChatParticipantCommunicationWrapup", - "signature": "postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsChatParticipantCommunicationWrapupRequest.postConversationsChatParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsChatParticipantCommunicationWrapupRequest.postConversationsChatParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationschatparticipantreplace": { - "operationId": "postconversationschatparticipantreplace", - "functionName": "postConversationsChatParticipantReplace", - "signature": "postConversationsChatParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationsChatParticipantReplaceRequest.postConversationsChatParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsChatParticipantReplaceRequest.postConversationsChatParticipantReplace was successful\")\n }\n}" - }, - "postconversationschats": { - "operationId": "postconversationschats", - "functionName": "postConversationsChats", - "signature": "postConversationsChats(body)", - "parameters": [ - { - "name": "body", - "type": "CreateWebChatRequest", - "required": "true" - } - ], - "return": "ChatConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateWebChatRequest = new CreateWebChatRequest(...) // Create web chat request\n\n// Create a web chat conversation\nPostConversationsChatsRequest.postConversationsChats(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsChatsRequest.postConversationsChats was successful\")\n dump(response)\n }\n}" - }, - "postconversationscobrowsesessionparticipantcommunicationwrapup": { - "operationId": "postconversationscobrowsesessionparticipantcommunicationwrapup", - "functionName": "postConversationsCobrowsesessionParticipantCommunicationWrapup", - "signature": "postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsCobrowsesessionParticipantCommunicationWrapupRequest.postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCobrowsesessionParticipantCommunicationWrapupRequest.postConversationsCobrowsesessionParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationscobrowsesessionparticipantreplace": { - "operationId": "postconversationscobrowsesessionparticipantreplace", - "functionName": "postConversationsCobrowsesessionParticipantReplace", - "signature": "postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // \n\n// Replace this participant with the specified user and/or address\nPostConversationsCobrowsesessionParticipantReplaceRequest.postConversationsCobrowsesessionParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsCobrowsesessionParticipantReplaceRequest.postConversationsCobrowsesessionParticipantReplace was successful\")\n }\n}" - }, - "postconversationsemailinboundmessages": { - "operationId": "postconversationsemailinboundmessages", - "functionName": "postConversationsEmailInboundmessages", - "signature": "postConversationsEmailInboundmessages(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InboundMessageRequest", - "required": "true" - } - ], - "return": "EmailConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: InboundMessageRequest = new InboundMessageRequest(...) // Send external email reply\n\n// 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.\nPostConversationsEmailInboundmessagesRequest.postConversationsEmailInboundmessages(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsEmailInboundmessagesRequest.postConversationsEmailInboundmessages was successful\")\n dump(response)\n }\n}" - }, - "postconversationsemailmessages": { - "operationId": "postconversationsemailmessages", - "functionName": "postConversationsEmailMessages", - "signature": "postConversationsEmailMessages(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EmailMessage", - "required": "true" - } - ], - "return": "EmailMessageReply", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: EmailMessage = new EmailMessage(...) // Reply\n\n// Send an email reply\nPostConversationsEmailMessagesRequest.postConversationsEmailMessages(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsEmailMessagesRequest.postConversationsEmailMessages was successful\")\n dump(response)\n }\n}" - }, - "postconversationsemailmessagesdraftattachmentscopy": { - "operationId": "postconversationsemailmessagesdraftattachmentscopy", - "functionName": "postConversationsEmailMessagesDraftAttachmentsCopy", - "signature": "postConversationsEmailMessagesDraftAttachmentsCopy(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CopyAttachmentsRequest", - "required": "true" - } - ], - "return": "EmailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: CopyAttachmentsRequest = new CopyAttachmentsRequest(...) // Copy Attachment Request\n\n// Copy attachments from an email message to the current draft.\nPostConversationsEmailMessagesDraftAttachmentsCopyRequest.postConversationsEmailMessagesDraftAttachmentsCopy(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsEmailMessagesDraftAttachmentsCopyRequest.postConversationsEmailMessagesDraftAttachmentsCopy was successful\")\n dump(response)\n }\n}" - }, - "postconversationsemailparticipantcommunicationwrapup": { - "operationId": "postconversationsemailparticipantcommunicationwrapup", - "functionName": "postConversationsEmailParticipantCommunicationWrapup", - "signature": "postConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsEmailParticipantCommunicationWrapupRequest.postConversationsEmailParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsEmailParticipantCommunicationWrapupRequest.postConversationsEmailParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationsemailparticipantreplace": { - "operationId": "postconversationsemailparticipantreplace", - "functionName": "postConversationsEmailParticipantReplace", - "signature": "postConversationsEmailParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationsEmailParticipantReplaceRequest.postConversationsEmailParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsEmailParticipantReplaceRequest.postConversationsEmailParticipantReplace was successful\")\n }\n}" - }, - "postconversationsemails": { - "operationId": "postconversationsemails", - "functionName": "postConversationsEmails", - "signature": "postConversationsEmails(body)", - "parameters": [ - { - "name": "body", - "type": "CreateEmailRequest", - "required": "true" - } - ], - "return": "EmailConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateEmailRequest = new CreateEmailRequest(...) // Create email request\n\n// Create an email conversation\nPostConversationsEmailsRequest.postConversationsEmails(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsEmailsRequest.postConversationsEmails was successful\")\n dump(response)\n }\n}" - }, - "postconversationsemailsagentless": { - "operationId": "postconversationsemailsagentless", - "functionName": "postConversationsEmailsAgentless", - "signature": "postConversationsEmailsAgentless(body)", - "parameters": [ - { - "name": "body", - "type": "AgentlessEmailSendRequestDto", - "required": "true" - } - ], - "return": "AgentlessEmailSendResponseDto", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AgentlessEmailSendRequestDto = new AgentlessEmailSendRequestDto(...) // Create agentless email request\n\n// Create an email conversation, per API\nPostConversationsEmailsAgentlessRequest.postConversationsEmailsAgentless(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsEmailsAgentlessRequest.postConversationsEmailsAgentless was successful\")\n dump(response)\n }\n}" - }, - "postconversationsfaxes": { - "operationId": "postconversationsfaxes", - "functionName": "postConversationsFaxes", - "signature": "postConversationsFaxes(body)", - "parameters": [ - { - "name": "body", - "type": "FaxSendRequest", - "required": "true" - } - ], - "return": "FaxSendResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FaxSendRequest = new FaxSendRequest(...) // Fax\n\n// Create Fax Conversation\nPostConversationsFaxesRequest.postConversationsFaxes(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsFaxesRequest.postConversationsFaxes was successful\")\n dump(response)\n }\n}" - }, - "postconversationskeyconfigurations": { - "operationId": "postconversationskeyconfigurations", - "functionName": "postConversationsKeyconfigurations", - "signature": "postConversationsKeyconfigurations(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationEncryptionConfiguration", - "required": "true" - } - ], - "return": "ConversationEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption Configuration\n\n// Setup configurations for encryption key creation\nPostConversationsKeyconfigurationsRequest.postConversationsKeyconfigurations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsKeyconfigurationsRequest.postConversationsKeyconfigurations was successful\")\n dump(response)\n }\n}" - }, - "postconversationskeyconfigurationsvalidate": { - "operationId": "postconversationskeyconfigurationsvalidate", - "functionName": "postConversationsKeyconfigurationsValidate", - "signature": "postConversationsKeyconfigurationsValidate(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationEncryptionConfiguration", - "required": "true" - } - ], - "return": "ConversationEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption Configuration\n\n// Validate encryption key configurations without saving it\nPostConversationsKeyconfigurationsValidateRequest.postConversationsKeyconfigurationsValidate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsKeyconfigurationsValidateRequest.postConversationsKeyconfigurationsValidate was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagecommunicationmessages": { - "operationId": "postconversationsmessagecommunicationmessages", - "functionName": "postConversationsMessageCommunicationMessages", - "signature": "postConversationsMessageCommunicationMessages(conversationId, communicationId, body, useNormalizedMessage)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AdditionalMessage", - "required": "true" - }, - { - "name": "useNormalizedMessage", - "type": "Bool", - "required": "false" - } - ], - "return": "MessageData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\nlet body: AdditionalMessage = new AdditionalMessage(...) // Message\nlet useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers)\n\n// Send message\nPostConversationsMessageCommunicationMessagesRequest.postConversationsMessageCommunicationMessages(conversationId: conversationId, communicationId: communicationId, body: body, useNormalizedMessage: useNormalizedMessage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageCommunicationMessagesRequest.postConversationsMessageCommunicationMessages was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagecommunicationmessagesmedia": { - "operationId": "postconversationsmessagecommunicationmessagesmedia", - "functionName": "postConversationsMessageCommunicationMessagesMedia", - "signature": "postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - } - ], - "return": "MessageMediaData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\n\n// Create media\nPostConversationsMessageCommunicationMessagesMediaRequest.postConversationsMessageCommunicationMessagesMedia(conversationId: conversationId, communicationId: communicationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageCommunicationMessagesMediaRequest.postConversationsMessageCommunicationMessagesMedia was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagecommunicationtyping": { - "operationId": "postconversationsmessagecommunicationtyping", - "functionName": "postConversationsMessageCommunicationTyping", - "signature": "postConversationsMessageCommunicationTyping(conversationId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MessageTypingEventRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet communicationId: String = \"\" // communicationId\nlet body: MessageTypingEventRequest = new MessageTypingEventRequest(...) // MessageTypingEvent\n\n// Send message typing event\nPostConversationsMessageCommunicationTypingRequest.postConversationsMessageCommunicationTyping(conversationId: conversationId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsMessageCommunicationTypingRequest.postConversationsMessageCommunicationTyping was successful\")\n }\n}" - }, - "postconversationsmessageinboundopenevent": { - "operationId": "postconversationsmessageinboundopenevent", - "functionName": "postConversationsMessageInboundOpenEvent", - "signature": "postConversationsMessageInboundOpenEvent(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OpenInboundNormalizedEvent", - "required": "true" - } - ], - "return": "OpenEventNormalizedMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // integrationId\nlet body: OpenInboundNormalizedEvent = new OpenInboundNormalizedEvent(...) // NormalizedMessage\n\n// Send an inbound Open Event Message\nPostConversationsMessageInboundOpenEventRequest.postConversationsMessageInboundOpenEvent(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageInboundOpenEventRequest.postConversationsMessageInboundOpenEvent was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessageinboundopenmessage": { - "operationId": "postconversationsmessageinboundopenmessage", - "functionName": "postConversationsMessageInboundOpenMessage", - "signature": "postConversationsMessageInboundOpenMessage(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OpenInboundNormalizedMessage", - "required": "true" - } - ], - "return": "OpenMessageNormalizedMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // integrationId\nlet body: OpenInboundNormalizedMessage = new OpenInboundNormalizedMessage(...) // NormalizedMessage\n\n// Send inbound Open Message\nPostConversationsMessageInboundOpenMessageRequest.postConversationsMessageInboundOpenMessage(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageInboundOpenMessageRequest.postConversationsMessageInboundOpenMessage was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessageinboundopenreceipt": { - "operationId": "postconversationsmessageinboundopenreceipt", - "functionName": "postConversationsMessageInboundOpenReceipt", - "signature": "postConversationsMessageInboundOpenReceipt(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OpenInboundNormalizedReceipt", - "required": "true" - } - ], - "return": "OpenReceiptNormalizedMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // integrationId\nlet body: OpenInboundNormalizedReceipt = new OpenInboundNormalizedReceipt(...) // NormalizedMessage\n\n// Send an inbound Open Receipt Message\nPostConversationsMessageInboundOpenReceiptRequest.postConversationsMessageInboundOpenReceipt(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageInboundOpenReceiptRequest.postConversationsMessageInboundOpenReceipt was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagemessagesbulk": { - "operationId": "postconversationsmessagemessagesbulk", - "functionName": "postConversationsMessageMessagesBulk", - "signature": "postConversationsMessageMessagesBulk(conversationId, useNormalizedMessage, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "useNormalizedMessage", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "[String]", - "required": "false" - } - ], - "return": "TextMessageListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // \nlet useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers)\nlet body: [String] = [\"\"] // messageIds\n\n// Get messages in batch\nPostConversationsMessageMessagesBulkRequest.postConversationsMessageMessagesBulk(conversationId: conversationId, useNormalizedMessage: useNormalizedMessage, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessageMessagesBulkRequest.postConversationsMessageMessagesBulk was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessageparticipantcommunicationwrapup": { - "operationId": "postconversationsmessageparticipantcommunicationwrapup", - "functionName": "postConversationsMessageParticipantCommunicationWrapup", - "signature": "postConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsMessageParticipantCommunicationWrapupRequest.postConversationsMessageParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsMessageParticipantCommunicationWrapupRequest.postConversationsMessageParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationsmessageparticipantreplace": { - "operationId": "postconversationsmessageparticipantreplace", - "functionName": "postConversationsMessageParticipantReplace", - "signature": "postConversationsMessageParticipantReplace(conversationId, participantId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TransferRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet body: TransferRequest = new TransferRequest(...) // Transfer request\n\n// Replace this participant with the specified user and/or address\nPostConversationsMessageParticipantReplaceRequest.postConversationsMessageParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsMessageParticipantReplaceRequest.postConversationsMessageParticipantReplace was successful\")\n }\n}" - }, - "postconversationsmessages": { - "operationId": "postconversationsmessages", - "functionName": "postConversationsMessages", - "signature": "postConversationsMessages(body)", - "parameters": [ - { - "name": "body", - "type": "CreateOutboundMessagingConversationRequest", - "required": "true" - } - ], - "return": "MessageConversation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateOutboundMessagingConversationRequest = new CreateOutboundMessagingConversationRequest(...) // Create outbound messaging conversation\n\n// Create an outbound messaging conversation.\nPostConversationsMessagesRequest.postConversationsMessages(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagesRequest.postConversationsMessages was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagesagentless": { - "operationId": "postconversationsmessagesagentless", - "functionName": "postConversationsMessagesAgentless", - "signature": "postConversationsMessagesAgentless(body)", - "parameters": [ - { - "name": "body", - "type": "SendAgentlessOutboundMessageRequest", - "required": "true" - } - ], - "return": "SendAgentlessOutboundMessageResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SendAgentlessOutboundMessageRequest = new SendAgentlessOutboundMessageRequest(...) // Create agentless outbound messaging request\n\n// Send an agentless outbound message\nPostConversationsMessagesAgentlessRequest.postConversationsMessagesAgentless(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagesAgentlessRequest.postConversationsMessagesAgentless was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagesinboundopen": { - "operationId": "postconversationsmessagesinboundopen", - "functionName": "postConversationsMessagesInboundOpen", - "signature": "postConversationsMessagesInboundOpen(body)", - "parameters": [ - { - "name": "body", - "type": "OpenNormalizedMessage", - "required": "true" - } - ], - "return": "OpenNormalizedMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OpenNormalizedMessage = new OpenNormalizedMessage(...) // NormalizedMessage\n\n// Send an inbound Open Message\nPostConversationsMessagesInboundOpenRequest.postConversationsMessagesInboundOpen(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagesInboundOpenRequest.postConversationsMessagesInboundOpen was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationsfacebook": { - "operationId": "postconversationsmessagingintegrationsfacebook", - "functionName": "postConversationsMessagingIntegrationsFacebook", - "signature": "postConversationsMessagingIntegrationsFacebook(body)", - "parameters": [ - { - "name": "body", - "type": "FacebookIntegrationRequest", - "required": "true" - } - ], - "return": "FacebookIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: FacebookIntegrationRequest = new FacebookIntegrationRequest(...) // FacebookIntegrationRequest\n\n// Create a Facebook Integration\nPostConversationsMessagingIntegrationsFacebookRequest.postConversationsMessagingIntegrationsFacebook(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsFacebookRequest.postConversationsMessagingIntegrationsFacebook was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationsinstagram": { - "operationId": "postconversationsmessagingintegrationsinstagram", - "functionName": "postConversationsMessagingIntegrationsInstagram", - "signature": "postConversationsMessagingIntegrationsInstagram(body)", - "parameters": [ - { - "name": "body", - "type": "InstagramIntegrationRequest", - "required": "true" - } - ], - "return": "InstagramIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: InstagramIntegrationRequest = new InstagramIntegrationRequest(...) // InstagramIntegrationRequest\n\n// Create Instagram Integration\nPostConversationsMessagingIntegrationsInstagramRequest.postConversationsMessagingIntegrationsInstagram(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsInstagramRequest.postConversationsMessagingIntegrationsInstagram was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationsline": { - "operationId": "postconversationsmessagingintegrationsline", - "functionName": "postConversationsMessagingIntegrationsLine", - "signature": "postConversationsMessagingIntegrationsLine(body)", - "parameters": [ - { - "name": "body", - "type": "LineIntegrationRequest", - "required": "true" - } - ], - "return": "LineIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LineIntegrationRequest = new LineIntegrationRequest(...) // LineIntegrationRequest\n\n// Create a LINE messenger Integration\nPostConversationsMessagingIntegrationsLineRequest.postConversationsMessagingIntegrationsLine(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsLineRequest.postConversationsMessagingIntegrationsLine was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationsopen": { - "operationId": "postconversationsmessagingintegrationsopen", - "functionName": "postConversationsMessagingIntegrationsOpen", - "signature": "postConversationsMessagingIntegrationsOpen(body)", - "parameters": [ - { - "name": "body", - "type": "OpenIntegrationRequest", - "required": "true" - } - ], - "return": "OpenIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OpenIntegrationRequest = new OpenIntegrationRequest(...) // OpenIntegrationRequest\n\n// Create an Open messaging integration\nPostConversationsMessagingIntegrationsOpenRequest.postConversationsMessagingIntegrationsOpen(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsOpenRequest.postConversationsMessagingIntegrationsOpen was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationstwitter": { - "operationId": "postconversationsmessagingintegrationstwitter", - "functionName": "postConversationsMessagingIntegrationsTwitter", - "signature": "postConversationsMessagingIntegrationsTwitter(body)", - "parameters": [ - { - "name": "body", - "type": "TwitterIntegrationRequest", - "required": "true" - } - ], - "return": "TwitterIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TwitterIntegrationRequest = new TwitterIntegrationRequest(...) // TwitterIntegrationRequest\n\n// Create a Twitter Integration\nPostConversationsMessagingIntegrationsTwitterRequest.postConversationsMessagingIntegrationsTwitter(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsTwitterRequest.postConversationsMessagingIntegrationsTwitter was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingintegrationswhatsapp": { - "operationId": "postconversationsmessagingintegrationswhatsapp", - "functionName": "postConversationsMessagingIntegrationsWhatsapp", - "signature": "postConversationsMessagingIntegrationsWhatsapp(body)", - "parameters": [ - { - "name": "body", - "type": "WhatsAppIntegrationRequest", - "required": "true" - } - ], - "return": "WhatsAppIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WhatsAppIntegrationRequest = new WhatsAppIntegrationRequest(...) // WhatsAppIntegrationRequest\n\n// Create a WhatsApp Integration\nPostConversationsMessagingIntegrationsWhatsappRequest.postConversationsMessagingIntegrationsWhatsapp(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingIntegrationsWhatsappRequest.postConversationsMessagingIntegrationsWhatsapp was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingsettings": { - "operationId": "postconversationsmessagingsettings", - "functionName": "postConversationsMessagingSettings", - "signature": "postConversationsMessagingSettings(body)", - "parameters": [ - { - "name": "body", - "type": "MessagingSettingRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting\n\n// Create a messaging setting\nPostConversationsMessagingSettingsRequest.postConversationsMessagingSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingSettingsRequest.postConversationsMessagingSettings was successful\")\n dump(response)\n }\n}" - }, - "postconversationsmessagingsupportedcontent": { - "operationId": "postconversationsmessagingsupportedcontent", - "functionName": "postConversationsMessagingSupportedcontent", - "signature": "postConversationsMessagingSupportedcontent(body)", - "parameters": [ - { - "name": "body", - "type": "SupportedContent", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SupportedContent = new SupportedContent(...) // SupportedContent\n\n// Create a Supported Content profile\nPostConversationsMessagingSupportedcontentRequest.postConversationsMessagingSupportedcontent(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsMessagingSupportedcontentRequest.postConversationsMessagingSupportedcontent was successful\")\n dump(response)\n }\n}" - }, - "postconversationsparticipantsattributessearch": { - "operationId": "postconversationsparticipantsattributessearch", - "functionName": "postConversationsParticipantsAttributesSearch", - "signature": "postConversationsParticipantsAttributesSearch(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationParticipantSearchRequest", - "required": "true" - } - ], - "return": "JsonCursorSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationParticipantSearchRequest = new ConversationParticipantSearchRequest(...) // Search request options\n\n// Search conversations\nPostConversationsParticipantsAttributesSearchRequest.postConversationsParticipantsAttributesSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationsParticipantsAttributesSearchRequest.postConversationsParticipantsAttributesSearch was successful\")\n dump(response)\n }\n}" - }, - "postconversationsscreenshareparticipantcommunicationwrapup": { - "operationId": "postconversationsscreenshareparticipantcommunicationwrapup", - "functionName": "postConversationsScreenshareParticipantCommunicationWrapup", - "signature": "postConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsScreenshareParticipantCommunicationWrapupRequest.postConversationsScreenshareParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsScreenshareParticipantCommunicationWrapupRequest.postConversationsScreenshareParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationssocialparticipantcommunicationwrapup": { - "operationId": "postconversationssocialparticipantcommunicationwrapup", - "functionName": "postConversationsSocialParticipantCommunicationWrapup", - "signature": "postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsSocialParticipantCommunicationWrapupRequest.postConversationsSocialParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsSocialParticipantCommunicationWrapupRequest.postConversationsSocialParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "postconversationsvideoparticipantcommunicationwrapup": { - "operationId": "postconversationsvideoparticipantcommunicationwrapup", - "functionName": "postConversationsVideoParticipantCommunicationWrapup", - "signature": "postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupInput", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: WrapupInput = new WrapupInput(...) // Wrap-up\n\n// Apply wrap-up for this conversation communication\nPostConversationsVideoParticipantCommunicationWrapupRequest.postConversationsVideoParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostConversationsVideoParticipantCommunicationWrapupRequest.postConversationsVideoParticipantCommunicationWrapup was successful\")\n }\n}" - }, - "putconversationparticipantflaggedreason": { - "operationId": "putconversationparticipantflaggedreason", - "functionName": "putConversationParticipantFlaggedreason", - "signature": "putConversationParticipantFlaggedreason(conversationId, participantId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet participantId: String = \"\" // participant ID\n\n// Set flagged reason on conversation participant to indicate bad conversation quality.\nPutConversationParticipantFlaggedreasonRequest.putConversationParticipantFlaggedreason(conversationId: conversationId, participantId: participantId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutConversationParticipantFlaggedreasonRequest.putConversationParticipantFlaggedreason was successful\")\n }\n}" - }, - "putconversationsecureattributes": { - "operationId": "putconversationsecureattributes", - "functionName": "putConversationSecureattributes", - "signature": "putConversationSecureattributes(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationSecureAttributes", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet body: ConversationSecureAttributes = new ConversationSecureAttributes(...) // Conversation Secure Attributes\n\n// Set the secure attributes on a conversation.\nPutConversationSecureattributesRequest.putConversationSecureattributes(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationSecureattributesRequest.putConversationSecureattributes was successful\")\n dump(response)\n }\n}" - }, - "putconversationtags": { - "operationId": "putconversationtags", - "functionName": "putConversationTags", - "signature": "putConversationTags(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationTagsUpdate", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversation ID\nlet body: ConversationTagsUpdate = new ConversationTagsUpdate(...) // Conversation Tags\n\n// Update the tags on a conversation.\nPutConversationTagsRequest.putConversationTags(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationTagsRequest.putConversationTags was successful\")\n dump(response)\n }\n}" - }, - "putconversationscallparticipantcommunicationuuidata": { - "operationId": "putconversationscallparticipantcommunicationuuidata", - "functionName": "putConversationsCallParticipantCommunicationUuidata", - "signature": "putConversationsCallParticipantCommunicationUuidata(conversationId, participantId, communicationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "participantId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetUuiDataRequest", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet participantId: String = \"\" // participantId\nlet communicationId: String = \"\" // communicationId\nlet body: SetUuiDataRequest = new SetUuiDataRequest(...) // UUIData Request\n\n// Set uuiData to be sent on future commands.\nPutConversationsCallParticipantCommunicationUuidataRequest.putConversationsCallParticipantCommunicationUuidata(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsCallParticipantCommunicationUuidataRequest.putConversationsCallParticipantCommunicationUuidata was successful\")\n dump(response)\n }\n}" - }, - "putconversationscallrecordingstate": { - "operationId": "putconversationscallrecordingstate", - "functionName": "putConversationsCallRecordingstate", - "signature": "putConversationsCallRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsCallRecordingstateRequest.putConversationsCallRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsCallRecordingstateRequest.putConversationsCallRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationscallbackrecordingstate": { - "operationId": "putconversationscallbackrecordingstate", - "functionName": "putConversationsCallbackRecordingstate", - "signature": "putConversationsCallbackRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsCallbackRecordingstateRequest.putConversationsCallbackRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsCallbackRecordingstateRequest.putConversationsCallbackRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationschatrecordingstate": { - "operationId": "putconversationschatrecordingstate", - "functionName": "putConversationsChatRecordingstate", - "signature": "putConversationsChatRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsChatRecordingstateRequest.putConversationsChatRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsChatRecordingstateRequest.putConversationsChatRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationscobrowsesessionrecordingstate": { - "operationId": "putconversationscobrowsesessionrecordingstate", - "functionName": "putConversationsCobrowsesessionRecordingstate", - "signature": "putConversationsCobrowsesessionRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsCobrowsesessionRecordingstateRequest.putConversationsCobrowsesessionRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsCobrowsesessionRecordingstateRequest.putConversationsCobrowsesessionRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationsemailmessagesdraft": { - "operationId": "putconversationsemailmessagesdraft", - "functionName": "putConversationsEmailMessagesDraft", - "signature": "putConversationsEmailMessagesDraft(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EmailMessage", - "required": "true" - } - ], - "return": "EmailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: EmailMessage = new EmailMessage(...) // Draft\n\n// Update conversation draft reply\nPutConversationsEmailMessagesDraftRequest.putConversationsEmailMessagesDraft(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsEmailMessagesDraftRequest.putConversationsEmailMessagesDraft was successful\")\n dump(response)\n }\n}" - }, - "putconversationsemailrecordingstate": { - "operationId": "putconversationsemailrecordingstate", - "functionName": "putConversationsEmailRecordingstate", - "signature": "putConversationsEmailRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsEmailRecordingstateRequest.putConversationsEmailRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsEmailRecordingstateRequest.putConversationsEmailRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationskeyconfiguration": { - "operationId": "putconversationskeyconfiguration", - "functionName": "putConversationsKeyconfiguration", - "signature": "putConversationsKeyconfiguration(keyconfigurationsId, body)", - "parameters": [ - { - "name": "keyconfigurationsId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationEncryptionConfiguration", - "required": "true" - } - ], - "return": "ConversationEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet keyconfigurationsId: String = \"\" // Key Configurations Id\nlet body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption key configuration metadata\n\n// Update the encryption key configurations\nPutConversationsKeyconfigurationRequest.putConversationsKeyconfiguration(keyconfigurationsId: keyconfigurationsId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsKeyconfigurationRequest.putConversationsKeyconfiguration was successful\")\n dump(response)\n }\n}" - }, - "putconversationsmessagerecordingstate": { - "operationId": "putconversationsmessagerecordingstate", - "functionName": "putConversationsMessageRecordingstate", - "signature": "putConversationsMessageRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsMessageRecordingstateRequest.putConversationsMessageRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsMessageRecordingstateRequest.putConversationsMessageRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationsmessagingintegrationslineintegrationid": { - "operationId": "putconversationsmessagingintegrationslineintegrationid", - "functionName": "putConversationsMessagingIntegrationsLineIntegrationId", - "signature": "putConversationsMessagingIntegrationsLineIntegrationId(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LineIntegrationRequest", - "required": "true" - } - ], - "return": "LineIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration ID\nlet body: LineIntegrationRequest = new LineIntegrationRequest(...) // LineIntegrationRequest\n\n// Update a LINE messenger integration\nPutConversationsMessagingIntegrationsLineIntegrationIdRequest.putConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsMessagingIntegrationsLineIntegrationIdRequest.putConversationsMessagingIntegrationsLineIntegrationId was successful\")\n dump(response)\n }\n}" - }, - "putconversationsmessagingsettingsdefault": { - "operationId": "putconversationsmessagingsettingsdefault", - "functionName": "putConversationsMessagingSettingsDefault", - "signature": "putConversationsMessagingSettingsDefault(body)", - "parameters": [ - { - "name": "body", - "type": "MessagingSettingDefaultRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MessagingSettingDefaultRequest = new MessagingSettingDefaultRequest(...) // MessagingSetting\n\n// Set the organization's default setting that may be applied to to integrations without settings\nPutConversationsMessagingSettingsDefaultRequest.putConversationsMessagingSettingsDefault(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsMessagingSettingsDefaultRequest.putConversationsMessagingSettingsDefault was successful\")\n dump(response)\n }\n}" - }, - "putconversationsmessagingsupportedcontentdefault": { - "operationId": "putconversationsmessagingsupportedcontentdefault", - "functionName": "putConversationsMessagingSupportedcontentDefault", - "signature": "putConversationsMessagingSupportedcontentDefault(body)", - "parameters": [ - { - "name": "body", - "type": "SupportedContentReference", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SupportedContentReference = new SupportedContentReference(...) // SupportedContent\n\n// Set the organization's default supported content profile that may be assigned to an integration when it is created.\nPutConversationsMessagingSupportedcontentDefaultRequest.putConversationsMessagingSupportedcontentDefault(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsMessagingSupportedcontentDefaultRequest.putConversationsMessagingSupportedcontentDefault was successful\")\n dump(response)\n }\n}" - }, - "putconversationsmessagingthreadingtimeline": { - "operationId": "putconversationsmessagingthreadingtimeline", - "functionName": "putConversationsMessagingThreadingtimeline", - "signature": "putConversationsMessagingThreadingtimeline(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationThreadingWindow", - "required": "true" - } - ], - "return": "ConversationThreadingWindow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationThreadingWindow = new ConversationThreadingWindow(...) // ConversationThreadingWindowRequest\n\n// Update conversation threading window timeline for each messaging type\nPutConversationsMessagingThreadingtimelineRequest.putConversationsMessagingThreadingtimeline(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsMessagingThreadingtimelineRequest.putConversationsMessagingThreadingtimeline was successful\")\n dump(response)\n }\n}" - }, - "putconversationsscreensharerecordingstate": { - "operationId": "putconversationsscreensharerecordingstate", - "functionName": "putConversationsScreenshareRecordingstate", - "signature": "putConversationsScreenshareRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsScreenshareRecordingstateRequest.putConversationsScreenshareRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsScreenshareRecordingstateRequest.putConversationsScreenshareRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationssocialrecordingstate": { - "operationId": "putconversationssocialrecordingstate", - "functionName": "putConversationsSocialRecordingstate", - "signature": "putConversationsSocialRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsSocialRecordingstateRequest.putConversationsSocialRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsSocialRecordingstateRequest.putConversationsSocialRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "putconversationsvideorecordingstate": { - "operationId": "putconversationsvideorecordingstate", - "functionName": "putConversationsVideoRecordingstate", - "signature": "putConversationsVideoRecordingstate(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetRecordingState", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: SetRecordingState = new SetRecordingState(...) // SetRecordingState\n\n// Update a conversation by setting its recording state\nPutConversationsVideoRecordingstateRequest.putConversationsVideoRecordingstate(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationsVideoRecordingstateRequest.putConversationsVideoRecordingstate was successful\")\n dump(response)\n }\n}" - }, - "getdataextensionscoretype": { - "operationId": "getdataextensionscoretype", - "functionName": "getDataextensionsCoretype", - "signature": "getDataextensionsCoretype(coretypeName)", - "parameters": [ - { - "name": "coretypeName", - "type": "String", - "required": "true" - } - ], - "return": "Coretype", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet coretypeName: GetDataextensionsCoretypeRequest.CoretypeName_getDataextensionsCoretype = GetDataextensionsCoretypeRequest.CoretypeName_getDataextensionsCoretype.enummember // The core type's name\n\n// Get a specific named core type.\nGetDataextensionsCoretypeRequest.getDataextensionsCoretype(coretypeName: coretypeName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataextensionsCoretypeRequest.getDataextensionsCoretype was successful\")\n dump(response)\n }\n}" - }, - "getdataextensionscoretypes": { - "operationId": "getdataextensionscoretypes", - "functionName": "getDataextensionsCoretypes", - "signature": "getDataextensionsCoretypes()", - "return": "CoretypeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the core types from which all schemas are built.\nGetDataextensionsCoretypesRequest.getDataextensionsCoretypes() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataextensionsCoretypesRequest.getDataextensionsCoretypes was successful\")\n dump(response)\n }\n}" - }, - "getdataextensionslimits": { - "operationId": "getdataextensionslimits", - "functionName": "getDataextensionsLimits", - "signature": "getDataextensionsLimits()", - "return": "SchemaQuantityLimits", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get quantitative limits on schemas\nGetDataextensionsLimitsRequest.getDataextensionsLimits() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataextensionsLimitsRequest.getDataextensionsLimits was successful\")\n dump(response)\n }\n}" - }, - "getdownload": { - "operationId": "getdownload", - "functionName": "getDownload", - "signature": "getDownload(downloadId, contentDisposition, issueRedirect, redirectToAuth)", - "parameters": [ - { - "name": "downloadId", - "type": "String", - "required": "true" - }, - { - "name": "contentDisposition", - "type": "String", - "required": "false" - }, - { - "name": "issueRedirect", - "type": "Bool", - "required": "false" - }, - { - "name": "redirectToAuth", - "type": "Bool", - "required": "false" - } - ], - "return": "UrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet downloadId: String = \"\" // Download ID\nlet contentDisposition: String = \"\" // \nlet issueRedirect: Bool = true // \nlet redirectToAuth: Bool = true // \n\n// Issues a redirect to a signed secure download URL for specified download\nGetDownloadRequest.getDownload(downloadId: downloadId, contentDisposition: contentDisposition, issueRedirect: issueRedirect, redirectToAuth: redirectToAuth) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDownloadRequest.getDownload was successful\")\n dump(response)\n }\n}" - }, - "getemailssettings": { - "operationId": "getemailssettings", - "functionName": "getEmailsSettings", - "signature": "getEmailsSettings()", - "return": "EmailSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get email Contact Center settings\nGetEmailsSettingsRequest.getEmailsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetEmailsSettingsRequest.getEmailsSettings was successful\")\n dump(response)\n }\n}" - }, - "patchemailssettings": { - "operationId": "patchemailssettings", - "functionName": "patchEmailsSettings", - "signature": "patchEmailsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "EmailSettings", - "required": "false" - } - ], - "return": "EmailSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EmailSettings = new EmailSettings(...) // \n\n// Patch email Contact Center settings\nPatchEmailsSettingsRequest.patchEmailsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchEmailsSettingsRequest.patchEmailsSettings was successful\")\n dump(response)\n }\n}" - }, - "posteventsconversations": { - "operationId": "posteventsconversations", - "functionName": "postEventsConversations", - "signature": "postEventsConversations(body)", - "parameters": [ - { - "name": "body", - "type": "BatchConversationEventRequest", - "required": "true" - } - ], - "return": "BatchEventResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BatchConversationEventRequest = new BatchConversationEventRequest(...) // batchRequest\n\n// Publish Conversation Batch Events\nPostEventsConversationsRequest.postEventsConversations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostEventsConversationsRequest.postEventsConversations was successful\")\n dump(response)\n }\n}" - }, - "posteventsuserspresence": { - "operationId": "posteventsuserspresence", - "functionName": "postEventsUsersPresence", - "signature": "postEventsUsersPresence(body)", - "parameters": [ - { - "name": "body", - "type": "BatchUserPresenceEventRequest", - "required": "true" - } - ], - "return": "BatchEventResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BatchUserPresenceEventRequest = new BatchUserPresenceEventRequest(...) // batchRequest\n\n// Publish User Presence Status Batch Events\nPostEventsUsersPresenceRequest.postEventsUsersPresence(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostEventsUsersPresenceRequest.postEventsUsersPresence was successful\")\n dump(response)\n }\n}" - }, - "posteventsusersroutingstatus": { - "operationId": "posteventsusersroutingstatus", - "functionName": "postEventsUsersRoutingstatus", - "signature": "postEventsUsersRoutingstatus(body)", - "parameters": [ - { - "name": "body", - "type": "BatchUserRoutingStatusEventRequest", - "required": "true" - } - ], - "return": "BatchEventResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BatchUserRoutingStatusEventRequest = new BatchUserRoutingStatusEventRequest(...) // batchRequest\n\n// Publish Agent Routing Status Batch Events\nPostEventsUsersRoutingstatusRequest.postEventsUsersRoutingstatus(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostEventsUsersRoutingstatusRequest.postEventsUsersRoutingstatus was successful\")\n dump(response)\n }\n}" - }, - "deleteexternalcontactscontact": { - "operationId": "deleteexternalcontactscontact", - "functionName": "deleteExternalcontactsContact", - "signature": "deleteExternalcontactsContact(contactId)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\n\n// Delete an external contact\nDeleteExternalcontactsContactRequest.deleteExternalcontactsContact(contactId: contactId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteExternalcontactsContactRequest.deleteExternalcontactsContact was successful\")\n dump(response)\n }\n}" - }, - "deleteexternalcontactscontactnote": { - "operationId": "deleteexternalcontactscontactnote", - "functionName": "deleteExternalcontactsContactNote", - "signature": "deleteExternalcontactsContactNote(contactId, noteId)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact Id\nlet noteId: String = \"\" // Note Id\n\n// Delete a note for an external contact\nDeleteExternalcontactsContactNoteRequest.deleteExternalcontactsContactNote(contactId: contactId, noteId: noteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteExternalcontactsContactNoteRequest.deleteExternalcontactsContactNote was successful\")\n dump(response)\n }\n}" - }, - "deleteexternalcontactscontactsschema": { - "operationId": "deleteexternalcontactscontactsschema", - "functionName": "deleteExternalcontactsContactsSchema", - "signature": "deleteExternalcontactsContactsSchema(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\n\n// Delete a schema\nDeleteExternalcontactsContactsSchemaRequest.deleteExternalcontactsContactsSchema(schemaId: schemaId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteExternalcontactsContactsSchemaRequest.deleteExternalcontactsContactsSchema was successful\")\n }\n}" - }, - "deleteexternalcontactsorganization": { - "operationId": "deleteexternalcontactsorganization", - "functionName": "deleteExternalcontactsOrganization", - "signature": "deleteExternalcontactsOrganization(externalOrganizationId)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\n\n// Delete an external organization\nDeleteExternalcontactsOrganizationRequest.deleteExternalcontactsOrganization(externalOrganizationId: externalOrganizationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteExternalcontactsOrganizationRequest.deleteExternalcontactsOrganization was successful\")\n dump(response)\n }\n}" - }, - "deleteexternalcontactsorganizationnote": { - "operationId": "deleteexternalcontactsorganizationnote", - "functionName": "deleteExternalcontactsOrganizationNote", - "signature": "deleteExternalcontactsOrganizationNote(externalOrganizationId, noteId)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization Id\nlet noteId: String = \"\" // Note Id\n\n// Delete a note for an external organization\nDeleteExternalcontactsOrganizationNoteRequest.deleteExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteExternalcontactsOrganizationNoteRequest.deleteExternalcontactsOrganizationNote was successful\")\n dump(response)\n }\n}" - }, - "deleteexternalcontactsorganizationtrustor": { - "operationId": "deleteexternalcontactsorganizationtrustor", - "functionName": "deleteExternalcontactsOrganizationTrustor", - "signature": "deleteExternalcontactsOrganizationTrustor(externalOrganizationId)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\n\n// Unlink the Trustor for this External Organization\nDeleteExternalcontactsOrganizationTrustorRequest.deleteExternalcontactsOrganizationTrustor(externalOrganizationId: externalOrganizationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteExternalcontactsOrganizationTrustorRequest.deleteExternalcontactsOrganizationTrustor was successful\")\n }\n}" - }, - "deleteexternalcontactsrelationship": { - "operationId": "deleteexternalcontactsrelationship", - "functionName": "deleteExternalcontactsRelationship", - "signature": "deleteExternalcontactsRelationship(relationshipId)", - "parameters": [ - { - "name": "relationshipId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet relationshipId: String = \"\" // Relationship Id\n\n// Delete a relationship\nDeleteExternalcontactsRelationshipRequest.deleteExternalcontactsRelationship(relationshipId: relationshipId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteExternalcontactsRelationshipRequest.deleteExternalcontactsRelationship was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontact": { - "operationId": "getexternalcontactscontact", - "functionName": "getExternalcontactsContact", - "signature": "getExternalcontactsContact(contactId, expand)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\nlet expand: [String] = [\"\"] // which fields, if any, to expand (externalOrganization,externalDataSources)\n\n// Fetch an external contact\nGetExternalcontactsContactRequest.getExternalcontactsContact(contactId: contactId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactRequest.getExternalcontactsContact was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactidentifiers": { - "operationId": "getexternalcontactscontactidentifiers", - "functionName": "getExternalcontactsContactIdentifiers", - "signature": "getExternalcontactsContactIdentifiers(contactId)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - } - ], - "return": "EntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\n\n// List the identifiers for a contact\nGetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers(contactId: contactId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactjourneysessions": { - "operationId": "getexternalcontactscontactjourneysessions", - "functionName": "getExternalcontactsContactJourneySessions", - "signature": "getExternalcontactsContactJourneySessions(contactId, pageSize, after, includeMerged)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "includeMerged", - "type": "Bool", - "required": "false" - } - ], - "return": "SessionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet includeMerged: Bool = true // Indicates whether to return sessions from all external contacts in the merge-set of the given one.\n\n// Retrieve all sessions for a given external contact.\nGetExternalcontactsContactJourneySessionsRequest.getExternalcontactsContactJourneySessions(contactId: contactId, pageSize: pageSize, after: after, includeMerged: includeMerged) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactJourneySessionsRequest.getExternalcontactsContactJourneySessions was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactnote": { - "operationId": "getexternalcontactscontactnote", - "functionName": "getExternalcontactsContactNote", - "signature": "getExternalcontactsContactNote(contactId, noteId, expand)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact Id\nlet noteId: String = \"\" // Note Id\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// Fetch a note for an external contact\nGetExternalcontactsContactNoteRequest.getExternalcontactsContactNote(contactId: contactId, noteId: noteId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactNoteRequest.getExternalcontactsContactNote was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactnotes": { - "operationId": "getexternalcontactscontactnotes", - "functionName": "getExternalcontactsContactNotes", - "signature": "getExternalcontactsContactNotes(contactId, pageSize, pageNumber, sortOrder, expand)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "NoteListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact Id\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// List notes for an external contact\nGetExternalcontactsContactNotesRequest.getExternalcontactsContactNotes(contactId: contactId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactNotesRequest.getExternalcontactsContactNotes was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactunresolved": { - "operationId": "getexternalcontactscontactunresolved", - "functionName": "getExternalcontactsContactUnresolved", - "signature": "getExternalcontactsContactUnresolved(contactId, expand)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\nlet expand: [String] = [\"\"] // which fields, if any, to expand (externalOrganization,externalDataSources)\n\n// Fetch an unresolved external contact\nGetExternalcontactsContactUnresolvedRequest.getExternalcontactsContactUnresolved(contactId: contactId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactUnresolvedRequest.getExternalcontactsContactUnresolved was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontacts": { - "operationId": "getexternalcontactscontacts", - "functionName": "getExternalcontactsContacts", - "signature": "getExternalcontactsContacts(pageSize, pageNumber, q, sortOrder, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "q", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ContactListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet q: String = \"\" // User supplied search keywords (no special syntax is currently supported)\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// Search for external contacts\nGetExternalcontactsContactsRequest.getExternalcontactsContacts(pageSize: pageSize, pageNumber: pageNumber, q: q, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactsRequest.getExternalcontactsContacts was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactsschema": { - "operationId": "getexternalcontactscontactsschema", - "functionName": "getExternalcontactsContactsSchema", - "signature": "getExternalcontactsContactsSchema(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\n\n// Get a schema\nGetExternalcontactsContactsSchemaRequest.getExternalcontactsContactsSchema(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactsSchemaRequest.getExternalcontactsContactsSchema was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactsschemaversion": { - "operationId": "getexternalcontactscontactsschemaversion", - "functionName": "getExternalcontactsContactsSchemaVersion", - "signature": "getExternalcontactsContactsSchemaVersion(schemaId, versionId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\nlet versionId: String = \"\" // Schema version\n\n// Get a specific version of a schema\nGetExternalcontactsContactsSchemaVersionRequest.getExternalcontactsContactsSchemaVersion(schemaId: schemaId, versionId: versionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactsSchemaVersionRequest.getExternalcontactsContactsSchemaVersion was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactsschemaversions": { - "operationId": "getexternalcontactscontactsschemaversions", - "functionName": "getExternalcontactsContactsSchemaVersions", - "signature": "getExternalcontactsContactsSchemaVersions(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\n\n// Get all versions of an external contact's schema\nGetExternalcontactsContactsSchemaVersionsRequest.getExternalcontactsContactsSchemaVersions(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactsSchemaVersionsRequest.getExternalcontactsContactsSchemaVersions was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactscontactsschemas": { - "operationId": "getexternalcontactscontactsschemas", - "functionName": "getExternalcontactsContactsSchemas", - "signature": "getExternalcontactsContactsSchemas()", - "return": "DataSchemaListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of schemas.\nGetExternalcontactsContactsSchemasRequest.getExternalcontactsContactsSchemas() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactsSchemasRequest.getExternalcontactsContactsSchemas was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganization": { - "operationId": "getexternalcontactsorganization", - "functionName": "getExternalcontactsOrganization", - "signature": "getExternalcontactsOrganization(externalOrganizationId, expand, includeTrustors)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "includeTrustors", - "type": "Bool", - "required": "false" - } - ], - "return": "ExternalOrganization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\nlet expand: GetExternalcontactsOrganizationRequest.Expand_getExternalcontactsOrganization = GetExternalcontactsOrganizationRequest.Expand_getExternalcontactsOrganization.enummember // which fields, if any, to expand (externalDataSources)\nlet includeTrustors: Bool = true // (true or false) whether or not to include trustor information embedded in the externalOrganization\n\n// Fetch an external organization\nGetExternalcontactsOrganizationRequest.getExternalcontactsOrganization(externalOrganizationId: externalOrganizationId, expand: expand, includeTrustors: includeTrustors) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationRequest.getExternalcontactsOrganization was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationcontacts": { - "operationId": "getexternalcontactsorganizationcontacts", - "functionName": "getExternalcontactsOrganizationContacts", - "signature": "getExternalcontactsOrganizationContacts(externalOrganizationId, pageSize, pageNumber, q, sortOrder, expand)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "q", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ContactListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet q: String = \"\" // User supplied search keywords (no special syntax is currently supported)\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// Search for external contacts in an external organization\nGetExternalcontactsOrganizationContactsRequest.getExternalcontactsOrganizationContacts(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, q: q, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationContactsRequest.getExternalcontactsOrganizationContacts was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationnote": { - "operationId": "getexternalcontactsorganizationnote", - "functionName": "getExternalcontactsOrganizationNote", - "signature": "getExternalcontactsOrganizationNote(externalOrganizationId, noteId, expand)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization Id\nlet noteId: String = \"\" // Note Id\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// Fetch a note for an external organization\nGetExternalcontactsOrganizationNoteRequest.getExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationNoteRequest.getExternalcontactsOrganizationNote was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationnotes": { - "operationId": "getexternalcontactsorganizationnotes", - "functionName": "getExternalcontactsOrganizationNotes", - "signature": "getExternalcontactsOrganizationNotes(externalOrganizationId, pageSize, pageNumber, sortOrder, expand)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "NoteListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization Id\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // which fields, if any, to expand\n\n// List notes for an external organization\nGetExternalcontactsOrganizationNotesRequest.getExternalcontactsOrganizationNotes(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationNotesRequest.getExternalcontactsOrganizationNotes was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationrelationships": { - "operationId": "getexternalcontactsorganizationrelationships", - "functionName": "getExternalcontactsOrganizationRelationships", - "signature": "getExternalcontactsOrganizationRelationships(externalOrganizationId, pageSize, pageNumber, expand, sortOrder)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "RelationshipListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet expand: GetExternalcontactsOrganizationRelationshipsRequest.Expand_getExternalcontactsOrganizationRelationships = GetExternalcontactsOrganizationRelationshipsRequest.Expand_getExternalcontactsOrganizationRelationships.enummember // which fields, if any, to expand\nlet sortOrder: String = \"\" // Sort order\n\n// Fetch a relationship for an external organization\nGetExternalcontactsOrganizationRelationshipsRequest.getExternalcontactsOrganizationRelationships(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, expand: expand, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationRelationshipsRequest.getExternalcontactsOrganizationRelationships was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizations": { - "operationId": "getexternalcontactsorganizations", - "functionName": "getExternalcontactsOrganizations", - "signature": "getExternalcontactsOrganizations(pageSize, pageNumber, q, trustorId, sortOrder, expand, includeTrustors)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "q", - "type": "String", - "required": "false" - }, - { - "name": "trustorId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "includeTrustors", - "type": "Bool", - "required": "false" - } - ], - "return": "ExternalOrganizationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\nlet q: String = \"\" // Search query\nlet trustorId: [String] = [\"\"] // Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // which fields, if any, to expand\nlet includeTrustors: Bool = true // (true or false) whether or not to include trustor information embedded in the externalOrganization\n\n// Search for external organizations\nGetExternalcontactsOrganizationsRequest.getExternalcontactsOrganizations(pageSize: pageSize, pageNumber: pageNumber, q: q, trustorId: trustorId, sortOrder: sortOrder, expand: expand, includeTrustors: includeTrustors) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationsRequest.getExternalcontactsOrganizations was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationsschema": { - "operationId": "getexternalcontactsorganizationsschema", - "functionName": "getExternalcontactsOrganizationsSchema", - "signature": "getExternalcontactsOrganizationsSchema(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\n\n// Get a schema\nGetExternalcontactsOrganizationsSchemaRequest.getExternalcontactsOrganizationsSchema(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationsSchemaRequest.getExternalcontactsOrganizationsSchema was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationsschemaversion": { - "operationId": "getexternalcontactsorganizationsschemaversion", - "functionName": "getExternalcontactsOrganizationsSchemaVersion", - "signature": "getExternalcontactsOrganizationsSchemaVersion(schemaId, versionId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\nlet versionId: String = \"\" // Schema version\n\n// Get a specific version of a schema\nGetExternalcontactsOrganizationsSchemaVersionRequest.getExternalcontactsOrganizationsSchemaVersion(schemaId: schemaId, versionId: versionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationsSchemaVersionRequest.getExternalcontactsOrganizationsSchemaVersion was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationsschemaversions": { - "operationId": "getexternalcontactsorganizationsschemaversions", - "functionName": "getExternalcontactsOrganizationsSchemaVersions", - "signature": "getExternalcontactsOrganizationsSchemaVersions(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\n\n// Get all versions of an external organization's schema\nGetExternalcontactsOrganizationsSchemaVersionsRequest.getExternalcontactsOrganizationsSchemaVersions(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationsSchemaVersionsRequest.getExternalcontactsOrganizationsSchemaVersions was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsorganizationsschemas": { - "operationId": "getexternalcontactsorganizationsschemas", - "functionName": "getExternalcontactsOrganizationsSchemas", - "signature": "getExternalcontactsOrganizationsSchemas()", - "return": "DataSchemaListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of schemas.\nGetExternalcontactsOrganizationsSchemasRequest.getExternalcontactsOrganizationsSchemas() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsOrganizationsSchemasRequest.getExternalcontactsOrganizationsSchemas was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsrelationship": { - "operationId": "getexternalcontactsrelationship", - "functionName": "getExternalcontactsRelationship", - "signature": "getExternalcontactsRelationship(relationshipId, expand)", - "parameters": [ - { - "name": "relationshipId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "Relationship", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet relationshipId: String = \"\" // Relationship Id\nlet expand: GetExternalcontactsRelationshipRequest.Expand_getExternalcontactsRelationship = GetExternalcontactsRelationshipRequest.Expand_getExternalcontactsRelationship.enummember // which fields, if any, to expand\n\n// Fetch a relationship\nGetExternalcontactsRelationshipRequest.getExternalcontactsRelationship(relationshipId: relationshipId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsRelationshipRequest.getExternalcontactsRelationship was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsreversewhitepageslookup": { - "operationId": "getexternalcontactsreversewhitepageslookup", - "functionName": "getExternalcontactsReversewhitepageslookup", - "signature": "getExternalcontactsReversewhitepageslookup(lookupVal, expand)", - "parameters": [ - { - "name": "lookupVal", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ReverseWhitepagesLookupResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet lookupVal: String = \"\" // User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)\nlet expand: [String] = [\"\"] // which field, if any, to expand\n\n// Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.\nGetExternalcontactsReversewhitepageslookupRequest.getExternalcontactsReversewhitepageslookup(lookupVal: lookupVal, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsReversewhitepageslookupRequest.getExternalcontactsReversewhitepageslookup was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsscancontacts": { - "operationId": "getexternalcontactsscancontacts", - "functionName": "getExternalcontactsScanContacts", - "signature": "getExternalcontactsScanContacts(limit, cursor)", - "parameters": [ - { - "name": "limit", - "type": "Int", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "CursorContactListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet limit: Int = 0 // The number of contacts per page; must be between 10 and 200, default is 100)\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL\n\n// Scan for external contacts using paging\nGetExternalcontactsScanContactsRequest.getExternalcontactsScanContacts(limit: limit, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsScanContactsRequest.getExternalcontactsScanContacts was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsscannotes": { - "operationId": "getexternalcontactsscannotes", - "functionName": "getExternalcontactsScanNotes", - "signature": "getExternalcontactsScanNotes(limit, cursor)", - "parameters": [ - { - "name": "limit", - "type": "Int", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "CursorNoteListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet limit: Int = 0 // The number of notes per page; must be between 10 and 200, default is 100)\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL\n\n// Scan for notes using paging\nGetExternalcontactsScanNotesRequest.getExternalcontactsScanNotes(limit: limit, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsScanNotesRequest.getExternalcontactsScanNotes was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsscanorganizations": { - "operationId": "getexternalcontactsscanorganizations", - "functionName": "getExternalcontactsScanOrganizations", - "signature": "getExternalcontactsScanOrganizations(limit, cursor)", - "parameters": [ - { - "name": "limit", - "type": "Int", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "CursorOrganizationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet limit: Int = 0 // The number of organizations per page; must be between 10 and 200, default is 100)\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL\n\n// Scan for external organizations using paging\nGetExternalcontactsScanOrganizationsRequest.getExternalcontactsScanOrganizations(limit: limit, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsScanOrganizationsRequest.getExternalcontactsScanOrganizations was successful\")\n dump(response)\n }\n}" - }, - "getexternalcontactsscanrelationships": { - "operationId": "getexternalcontactsscanrelationships", - "functionName": "getExternalcontactsScanRelationships", - "signature": "getExternalcontactsScanRelationships(limit, cursor)", - "parameters": [ - { - "name": "limit", - "type": "Int", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "CursorRelationshipListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet limit: Int = 0 // The number of relationships per page; must be between 10 and 200, default is 100)\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL\n\n// Scan for relationships\nGetExternalcontactsScanRelationshipsRequest.getExternalcontactsScanRelationships(limit: limit, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsScanRelationshipsRequest.getExternalcontactsScanRelationships was successful\")\n dump(response)\n }\n}" - }, - "patchexternalcontactscontactidentifiers": { - "operationId": "patchexternalcontactscontactidentifiers", - "functionName": "patchExternalcontactsContactIdentifiers", - "signature": "patchExternalcontactsContactIdentifiers(contactId, body)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "IdentifierClaimRequest", - "required": "true" - } - ], - "return": "ContactIdentifier", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\nlet body: IdentifierClaimRequest = new IdentifierClaimRequest(...) // ClaimRequest\n\n// Claim or release identifiers for a contact\nPatchExternalcontactsContactIdentifiersRequest.patchExternalcontactsContactIdentifiers(contactId: contactId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchExternalcontactsContactIdentifiersRequest.patchExternalcontactsContactIdentifiers was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkcontacts": { - "operationId": "postexternalcontactsbulkcontacts", - "functionName": "postExternalcontactsBulkContacts", - "signature": "postExternalcontactsBulkContacts(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkFetchContactsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids\n\n// Bulk fetch contacts\nPostExternalcontactsBulkContactsRequest.postExternalcontactsBulkContacts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkContactsRequest.postExternalcontactsBulkContacts was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkcontactsadd": { - "operationId": "postexternalcontactsbulkcontactsadd", - "functionName": "postExternalcontactsBulkContactsAdd", - "signature": "postExternalcontactsBulkContactsAdd(body)", - "parameters": [ - { - "name": "body", - "type": "BulkContactsRequest", - "required": "true" - } - ], - "return": "BulkContactsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkContactsRequest = new BulkContactsRequest(...) // Contacts\n\n// Bulk add contacts\nPostExternalcontactsBulkContactsAddRequest.postExternalcontactsBulkContactsAdd(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkContactsAddRequest.postExternalcontactsBulkContactsAdd was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkcontactsremove": { - "operationId": "postexternalcontactsbulkcontactsremove", - "functionName": "postExternalcontactsBulkContactsRemove", - "signature": "postExternalcontactsBulkContactsRemove(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkDeleteResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids\n\n// Bulk remove contacts\nPostExternalcontactsBulkContactsRemoveRequest.postExternalcontactsBulkContactsRemove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkContactsRemoveRequest.postExternalcontactsBulkContactsRemove was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkcontactsunresolved": { - "operationId": "postexternalcontactsbulkcontactsunresolved", - "functionName": "postExternalcontactsBulkContactsUnresolved", - "signature": "postExternalcontactsBulkContactsUnresolved(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkFetchContactsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids\n\n// Bulk fetch unresolved ancestor contacts\nPostExternalcontactsBulkContactsUnresolvedRequest.postExternalcontactsBulkContactsUnresolved(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkContactsUnresolvedRequest.postExternalcontactsBulkContactsUnresolved was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkcontactsupdate": { - "operationId": "postexternalcontactsbulkcontactsupdate", - "functionName": "postExternalcontactsBulkContactsUpdate", - "signature": "postExternalcontactsBulkContactsUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "BulkContactsRequest", - "required": "true" - } - ], - "return": "BulkContactsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkContactsRequest = new BulkContactsRequest(...) // Contacts\n\n// Bulk update contacts\nPostExternalcontactsBulkContactsUpdateRequest.postExternalcontactsBulkContactsUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkContactsUpdateRequest.postExternalcontactsBulkContactsUpdate was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulknotes": { - "operationId": "postexternalcontactsbulknotes", - "functionName": "postExternalcontactsBulkNotes", - "signature": "postExternalcontactsBulkNotes(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkFetchNotesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Note ids\n\n// Bulk fetch notes\nPostExternalcontactsBulkNotesRequest.postExternalcontactsBulkNotes(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkNotesRequest.postExternalcontactsBulkNotes was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulknotesadd": { - "operationId": "postexternalcontactsbulknotesadd", - "functionName": "postExternalcontactsBulkNotesAdd", - "signature": "postExternalcontactsBulkNotesAdd(body)", - "parameters": [ - { - "name": "body", - "type": "BulkNotesRequest", - "required": "true" - } - ], - "return": "BulkNotesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkNotesRequest = new BulkNotesRequest(...) // Notes\n\n// Bulk add notes\nPostExternalcontactsBulkNotesAddRequest.postExternalcontactsBulkNotesAdd(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkNotesAddRequest.postExternalcontactsBulkNotesAdd was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulknotesremove": { - "operationId": "postexternalcontactsbulknotesremove", - "functionName": "postExternalcontactsBulkNotesRemove", - "signature": "postExternalcontactsBulkNotesRemove(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkDeleteResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Note ids\n\n// Bulk remove notes\nPostExternalcontactsBulkNotesRemoveRequest.postExternalcontactsBulkNotesRemove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkNotesRemoveRequest.postExternalcontactsBulkNotesRemove was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulknotesupdate": { - "operationId": "postexternalcontactsbulknotesupdate", - "functionName": "postExternalcontactsBulkNotesUpdate", - "signature": "postExternalcontactsBulkNotesUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "BulkNotesRequest", - "required": "true" - } - ], - "return": "BulkNotesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkNotesRequest = new BulkNotesRequest(...) // Notes\n\n// Bulk update notes\nPostExternalcontactsBulkNotesUpdateRequest.postExternalcontactsBulkNotesUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkNotesUpdateRequest.postExternalcontactsBulkNotesUpdate was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkorganizations": { - "operationId": "postexternalcontactsbulkorganizations", - "functionName": "postExternalcontactsBulkOrganizations", - "signature": "postExternalcontactsBulkOrganizations(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkFetchOrganizationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Organizations ids\n\n// Bulk fetch organizations\nPostExternalcontactsBulkOrganizationsRequest.postExternalcontactsBulkOrganizations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkOrganizationsRequest.postExternalcontactsBulkOrganizations was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkorganizationsadd": { - "operationId": "postexternalcontactsbulkorganizationsadd", - "functionName": "postExternalcontactsBulkOrganizationsAdd", - "signature": "postExternalcontactsBulkOrganizationsAdd(body)", - "parameters": [ - { - "name": "body", - "type": "BulkOrganizationsRequest", - "required": "true" - } - ], - "return": "BulkOrganizationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkOrganizationsRequest = new BulkOrganizationsRequest(...) // Organizations\n\n// Bulk add organizations\nPostExternalcontactsBulkOrganizationsAddRequest.postExternalcontactsBulkOrganizationsAdd(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkOrganizationsAddRequest.postExternalcontactsBulkOrganizationsAdd was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkorganizationsremove": { - "operationId": "postexternalcontactsbulkorganizationsremove", - "functionName": "postExternalcontactsBulkOrganizationsRemove", - "signature": "postExternalcontactsBulkOrganizationsRemove(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkDeleteResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Organization ids\n\n// Bulk remove organizations\nPostExternalcontactsBulkOrganizationsRemoveRequest.postExternalcontactsBulkOrganizationsRemove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkOrganizationsRemoveRequest.postExternalcontactsBulkOrganizationsRemove was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkorganizationsupdate": { - "operationId": "postexternalcontactsbulkorganizationsupdate", - "functionName": "postExternalcontactsBulkOrganizationsUpdate", - "signature": "postExternalcontactsBulkOrganizationsUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "BulkOrganizationsRequest", - "required": "true" - } - ], - "return": "BulkOrganizationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkOrganizationsRequest = new BulkOrganizationsRequest(...) // Organizations\n\n// Bulk update organizations\nPostExternalcontactsBulkOrganizationsUpdateRequest.postExternalcontactsBulkOrganizationsUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkOrganizationsUpdateRequest.postExternalcontactsBulkOrganizationsUpdate was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkrelationships": { - "operationId": "postexternalcontactsbulkrelationships", - "functionName": "postExternalcontactsBulkRelationships", - "signature": "postExternalcontactsBulkRelationships(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkFetchRelationshipsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Relationships ids\n\n// Bulk fetch relationships\nPostExternalcontactsBulkRelationshipsRequest.postExternalcontactsBulkRelationships(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkRelationshipsRequest.postExternalcontactsBulkRelationships was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkrelationshipsadd": { - "operationId": "postexternalcontactsbulkrelationshipsadd", - "functionName": "postExternalcontactsBulkRelationshipsAdd", - "signature": "postExternalcontactsBulkRelationshipsAdd(body)", - "parameters": [ - { - "name": "body", - "type": "BulkRelationshipsRequest", - "required": "true" - } - ], - "return": "BulkRelationshipsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkRelationshipsRequest = new BulkRelationshipsRequest(...) // Relationships\n\n// Bulk add relationships\nPostExternalcontactsBulkRelationshipsAddRequest.postExternalcontactsBulkRelationshipsAdd(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkRelationshipsAddRequest.postExternalcontactsBulkRelationshipsAdd was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkrelationshipsremove": { - "operationId": "postexternalcontactsbulkrelationshipsremove", - "functionName": "postExternalcontactsBulkRelationshipsRemove", - "signature": "postExternalcontactsBulkRelationshipsRemove(body)", - "parameters": [ - { - "name": "body", - "type": "BulkIdsRequest", - "required": "true" - } - ], - "return": "BulkDeleteResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkIdsRequest = new BulkIdsRequest(...) // Relationships ids\n\n// Bulk remove relationships\nPostExternalcontactsBulkRelationshipsRemoveRequest.postExternalcontactsBulkRelationshipsRemove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkRelationshipsRemoveRequest.postExternalcontactsBulkRelationshipsRemove was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsbulkrelationshipsupdate": { - "operationId": "postexternalcontactsbulkrelationshipsupdate", - "functionName": "postExternalcontactsBulkRelationshipsUpdate", - "signature": "postExternalcontactsBulkRelationshipsUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "BulkRelationshipsRequest", - "required": "true" - } - ], - "return": "BulkRelationshipsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BulkRelationshipsRequest = new BulkRelationshipsRequest(...) // Relationships\n\n// Bulk update relationships\nPostExternalcontactsBulkRelationshipsUpdateRequest.postExternalcontactsBulkRelationshipsUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsBulkRelationshipsUpdateRequest.postExternalcontactsBulkRelationshipsUpdate was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactscontactnotes": { - "operationId": "postexternalcontactscontactnotes", - "functionName": "postExternalcontactsContactNotes", - "signature": "postExternalcontactsContactNotes(contactId, body)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Note", - "required": "true" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact Id\nlet body: Note = new Note(...) // ExternalContact\n\n// Create a note for an external contact\nPostExternalcontactsContactNotesRequest.postExternalcontactsContactNotes(contactId: contactId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsContactNotesRequest.postExternalcontactsContactNotes was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactscontactpromotion": { - "operationId": "postexternalcontactscontactpromotion", - "functionName": "postExternalcontactsContactPromotion", - "signature": "postExternalcontactsContactPromotion(contactId)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\n\n// Promote an observed contact (ephemeral or identified) to a curated contact\nPostExternalcontactsContactPromotionRequest.postExternalcontactsContactPromotion(contactId: contactId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsContactPromotionRequest.postExternalcontactsContactPromotion was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactscontacts": { - "operationId": "postexternalcontactscontacts", - "functionName": "postExternalcontactsContacts", - "signature": "postExternalcontactsContacts(body)", - "parameters": [ - { - "name": "body", - "type": "ExternalContact", - "required": "true" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ExternalContact = new ExternalContact(...) // ExternalContact\n\n// Create an external contact\nPostExternalcontactsContactsRequest.postExternalcontactsContacts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsContactsRequest.postExternalcontactsContacts was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactscontactsschemas": { - "operationId": "postexternalcontactscontactsschemas", - "functionName": "postExternalcontactsContactsSchemas", - "signature": "postExternalcontactsContactsSchemas(body)", - "parameters": [ - { - "name": "body", - "type": "DataSchema", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DataSchema = new DataSchema(...) // Schema\n\n// Create a schema\nPostExternalcontactsContactsSchemasRequest.postExternalcontactsContactsSchemas(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsContactsSchemasRequest.postExternalcontactsContactsSchemas was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsidentifierlookup": { - "operationId": "postexternalcontactsidentifierlookup", - "functionName": "postExternalcontactsIdentifierlookup", - "signature": "postExternalcontactsIdentifierlookup(identifier)", - "parameters": [ - { - "name": "identifier", - "type": "ContactIdentifier", - "required": "true" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet identifier: ContactIdentifier = new ContactIdentifier(...) // \n\n// Fetch a contact using an identifier type and value.\nPostExternalcontactsIdentifierlookupRequest.postExternalcontactsIdentifierlookup(identifier: identifier) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsIdentifierlookupRequest.postExternalcontactsIdentifierlookup was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsmergecontacts": { - "operationId": "postexternalcontactsmergecontacts", - "functionName": "postExternalcontactsMergeContacts", - "signature": "postExternalcontactsMergeContacts(body)", - "parameters": [ - { - "name": "body", - "type": "MergeRequest", - "required": "true" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MergeRequest = new MergeRequest(...) // MergeRequest\n\n// Merge two contacts into a new contact record\nPostExternalcontactsMergeContactsRequest.postExternalcontactsMergeContacts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsMergeContactsRequest.postExternalcontactsMergeContacts was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsorganizationnotes": { - "operationId": "postexternalcontactsorganizationnotes", - "functionName": "postExternalcontactsOrganizationNotes", - "signature": "postExternalcontactsOrganizationNotes(externalOrganizationId, body)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Note", - "required": "true" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization Id\nlet body: Note = new Note(...) // ExternalContact\n\n// Create a note for an external organization\nPostExternalcontactsOrganizationNotesRequest.postExternalcontactsOrganizationNotes(externalOrganizationId: externalOrganizationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsOrganizationNotesRequest.postExternalcontactsOrganizationNotes was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsorganizations": { - "operationId": "postexternalcontactsorganizations", - "functionName": "postExternalcontactsOrganizations", - "signature": "postExternalcontactsOrganizations(body)", - "parameters": [ - { - "name": "body", - "type": "ExternalOrganization", - "required": "true" - } - ], - "return": "ExternalOrganization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ExternalOrganization = new ExternalOrganization(...) // ExternalOrganization\n\n// Create an external organization\nPostExternalcontactsOrganizationsRequest.postExternalcontactsOrganizations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsOrganizationsRequest.postExternalcontactsOrganizations was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsorganizationsschemas": { - "operationId": "postexternalcontactsorganizationsschemas", - "functionName": "postExternalcontactsOrganizationsSchemas", - "signature": "postExternalcontactsOrganizationsSchemas(body)", - "parameters": [ - { - "name": "body", - "type": "DataSchema", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DataSchema = new DataSchema(...) // Schema\n\n// Create a schema\nPostExternalcontactsOrganizationsSchemasRequest.postExternalcontactsOrganizationsSchemas(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsOrganizationsSchemasRequest.postExternalcontactsOrganizationsSchemas was successful\")\n dump(response)\n }\n}" - }, - "postexternalcontactsrelationships": { - "operationId": "postexternalcontactsrelationships", - "functionName": "postExternalcontactsRelationships", - "signature": "postExternalcontactsRelationships(body)", - "parameters": [ - { - "name": "body", - "type": "Relationship", - "required": "true" - } - ], - "return": "Relationship", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Relationship = new Relationship(...) // Relationship\n\n// Create a relationship\nPostExternalcontactsRelationshipsRequest.postExternalcontactsRelationships(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsRelationshipsRequest.postExternalcontactsRelationships was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactscontact": { - "operationId": "putexternalcontactscontact", - "functionName": "putExternalcontactsContact", - "signature": "putExternalcontactsContact(contactId, body)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExternalContact", - "required": "true" - } - ], - "return": "ExternalContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\nlet body: ExternalContact = new ExternalContact(...) // ExternalContact\n\n// Update an external contact\nPutExternalcontactsContactRequest.putExternalcontactsContact(contactId: contactId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsContactRequest.putExternalcontactsContact was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactscontactnote": { - "operationId": "putexternalcontactscontactnote", - "functionName": "putExternalcontactsContactNote", - "signature": "putExternalcontactsContactNote(contactId, noteId, body)", - "parameters": [ - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Note", - "required": "true" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact Id\nlet noteId: String = \"\" // Note Id\nlet body: Note = new Note(...) // Note\n\n// Update a note for an external contact\nPutExternalcontactsContactNoteRequest.putExternalcontactsContactNote(contactId: contactId, noteId: noteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsContactNoteRequest.putExternalcontactsContactNote was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactscontactsschema": { - "operationId": "putexternalcontactscontactsschema", - "functionName": "putExternalcontactsContactsSchema", - "signature": "putExternalcontactsContactsSchema(schemaId, body)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DataSchema", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\nlet body: DataSchema = new DataSchema(...) // Data Schema\n\n// Update a schema\nPutExternalcontactsContactsSchemaRequest.putExternalcontactsContactsSchema(schemaId: schemaId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsContactsSchemaRequest.putExternalcontactsContactsSchema was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactsconversation": { - "operationId": "putexternalcontactsconversation", - "functionName": "putExternalcontactsConversation", - "signature": "putExternalcontactsConversation(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ConversationAssociation", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet body: ConversationAssociation = new ConversationAssociation(...) // ConversationAssociation\n\n// Associate/disassociate an external contact with a conversation\nPutExternalcontactsConversationRequest.putExternalcontactsConversation(conversationId: conversationId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutExternalcontactsConversationRequest.putExternalcontactsConversation was successful\")\n }\n}" - }, - "putexternalcontactsorganization": { - "operationId": "putexternalcontactsorganization", - "functionName": "putExternalcontactsOrganization", - "signature": "putExternalcontactsOrganization(externalOrganizationId, body)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExternalOrganization", - "required": "true" - } - ], - "return": "ExternalOrganization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\nlet body: ExternalOrganization = new ExternalOrganization(...) // ExternalOrganization\n\n// Update an external organization\nPutExternalcontactsOrganizationRequest.putExternalcontactsOrganization(externalOrganizationId: externalOrganizationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsOrganizationRequest.putExternalcontactsOrganization was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactsorganizationnote": { - "operationId": "putexternalcontactsorganizationnote", - "functionName": "putExternalcontactsOrganizationNote", - "signature": "putExternalcontactsOrganizationNote(externalOrganizationId, noteId, body)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "noteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Note", - "required": "true" - } - ], - "return": "Note", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization Id\nlet noteId: String = \"\" // Note Id\nlet body: Note = new Note(...) // Note\n\n// Update a note for an external organization\nPutExternalcontactsOrganizationNoteRequest.putExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsOrganizationNoteRequest.putExternalcontactsOrganizationNote was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactsorganizationtrustortrustorid": { - "operationId": "putexternalcontactsorganizationtrustortrustorid", - "functionName": "putExternalcontactsOrganizationTrustorTrustorId", - "signature": "putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId, trustorId)", - "parameters": [ - { - "name": "externalOrganizationId", - "type": "String", - "required": "true" - }, - { - "name": "trustorId", - "type": "String", - "required": "true" - } - ], - "return": "ExternalOrganizationTrustorLink", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet externalOrganizationId: String = \"\" // External Organization ID\nlet trustorId: String = \"\" // Trustor ID\n\n// Links a Trustor with an External Organization\nPutExternalcontactsOrganizationTrustorTrustorIdRequest.putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId: externalOrganizationId, trustorId: trustorId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsOrganizationTrustorTrustorIdRequest.putExternalcontactsOrganizationTrustorTrustorId was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactsorganizationsschema": { - "operationId": "putexternalcontactsorganizationsschema", - "functionName": "putExternalcontactsOrganizationsSchema", - "signature": "putExternalcontactsOrganizationsSchema(schemaId, body)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DataSchema", - "required": "true" - } - ], - "return": "DataSchema", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: String = \"\" // Schema ID\nlet body: DataSchema = new DataSchema(...) // Data Schema\n\n// Update a schema\nPutExternalcontactsOrganizationsSchemaRequest.putExternalcontactsOrganizationsSchema(schemaId: schemaId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsOrganizationsSchemaRequest.putExternalcontactsOrganizationsSchema was successful\")\n dump(response)\n }\n}" - }, - "putexternalcontactsrelationship": { - "operationId": "putexternalcontactsrelationship", - "functionName": "putExternalcontactsRelationship", - "signature": "putExternalcontactsRelationship(relationshipId, body)", - "parameters": [ - { - "name": "relationshipId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Relationship", - "required": "true" - } - ], - "return": "Relationship", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet relationshipId: String = \"\" // Relationship Id\nlet body: Relationship = new Relationship(...) // Relationship\n\n// Update a relationship\nPutExternalcontactsRelationshipRequest.putExternalcontactsRelationship(relationshipId: relationshipId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsRelationshipRequest.putExternalcontactsRelationship was successful\")\n dump(response)\n }\n}" - }, - "deletefaxdocument": { - "operationId": "deletefaxdocument", - "functionName": "deleteFaxDocument", - "signature": "deleteFaxDocument(documentId)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\n\n// Delete a fax document.\nDeleteFaxDocumentRequest.deleteFaxDocument(documentId: documentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteFaxDocumentRequest.deleteFaxDocument was successful\")\n }\n}" - }, - "getfaxdocument": { - "operationId": "getfaxdocument", - "functionName": "getFaxDocument", - "signature": "getFaxDocument(documentId)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - } - ], - "return": "FaxDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\n\n// Get a document.\nGetFaxDocumentRequest.getFaxDocument(documentId: documentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFaxDocumentRequest.getFaxDocument was successful\")\n dump(response)\n }\n}" - }, - "getfaxdocumentcontent": { - "operationId": "getfaxdocumentcontent", - "functionName": "getFaxDocumentContent", - "signature": "getFaxDocumentContent(documentId)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - } - ], - "return": "DownloadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\n\n// Download a fax document.\nGetFaxDocumentContentRequest.getFaxDocumentContent(documentId: documentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFaxDocumentContentRequest.getFaxDocumentContent was successful\")\n dump(response)\n }\n}" - }, - "getfaxdocuments": { - "operationId": "getfaxdocuments", - "functionName": "getFaxDocuments", - "signature": "getFaxDocuments(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "FaxDocumentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of fax documents.\nGetFaxDocumentsRequest.getFaxDocuments(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFaxDocumentsRequest.getFaxDocuments was successful\")\n dump(response)\n }\n}" - }, - "getfaxsummary": { - "operationId": "getfaxsummary", - "functionName": "getFaxSummary", - "signature": "getFaxSummary()", - "return": "FaxSummary", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get fax summary\nGetFaxSummaryRequest.getFaxSummary() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFaxSummaryRequest.getFaxSummary was successful\")\n dump(response)\n }\n}" - }, - "putfaxdocument": { - "operationId": "putfaxdocument", - "functionName": "putFaxDocument", - "signature": "putFaxDocument(documentId, body)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "FaxDocument", - "required": "true" - } - ], - "return": "FaxDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet body: FaxDocument = new FaxDocument(...) // Document\n\n// Update a fax document.\nPutFaxDocumentRequest.putFaxDocument(documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutFaxDocumentRequest.putFaxDocument was successful\")\n dump(response)\n }\n}" - }, - "deleteemployeeperformanceexternalmetricsdefinition": { - "operationId": "deleteemployeeperformanceexternalmetricsdefinition", - "functionName": "deleteEmployeeperformanceExternalmetricsDefinition", - "signature": "deleteEmployeeperformanceExternalmetricsDefinition(metricId)", - "parameters": [ - { - "name": "metricId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet metricId: String = \"\" // Specifies the External Metric Definition ID\n\n// Delete an External Metric Definition\nDeleteEmployeeperformanceExternalmetricsDefinitionRequest.deleteEmployeeperformanceExternalmetricsDefinition(metricId: metricId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteEmployeeperformanceExternalmetricsDefinitionRequest.deleteEmployeeperformanceExternalmetricsDefinition was successful\")\n }\n}" - }, - "getemployeeperformanceexternalmetricsdefinition": { - "operationId": "getemployeeperformanceexternalmetricsdefinition", - "functionName": "getEmployeeperformanceExternalmetricsDefinition", - "signature": "getEmployeeperformanceExternalmetricsDefinition(metricId)", - "parameters": [ - { - "name": "metricId", - "type": "String", - "required": "true" - } - ], - "return": "ExternalMetricDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet metricId: String = \"\" // Specifies the External Metric Definition ID\n\n// Get an External Metric Definition\nGetEmployeeperformanceExternalmetricsDefinitionRequest.getEmployeeperformanceExternalmetricsDefinition(metricId: metricId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetEmployeeperformanceExternalmetricsDefinitionRequest.getEmployeeperformanceExternalmetricsDefinition was successful\")\n dump(response)\n }\n}" - }, - "getemployeeperformanceexternalmetricsdefinitions": { - "operationId": "getemployeeperformanceexternalmetricsdefinitions", - "functionName": "getEmployeeperformanceExternalmetricsDefinitions", - "signature": "getEmployeeperformanceExternalmetricsDefinitions(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "ExternalMetricDefinitionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of External Metric Definitions of an organization, sorted by name in ascending order\nGetEmployeeperformanceExternalmetricsDefinitionsRequest.getEmployeeperformanceExternalmetricsDefinitions(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetEmployeeperformanceExternalmetricsDefinitionsRequest.getEmployeeperformanceExternalmetricsDefinitions was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsights": { - "operationId": "getgamificationinsights", - "functionName": "getGamificationInsights", - "signature": "getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, pageSize, pageNumber, sortKey, sortMetricId, sortOrder, userIds)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortKey", - "type": "String", - "required": "false" - }, - { - "name": "sortMetricId", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "userIds", - "type": "String", - "required": "false" - } - ], - "return": "InsightsSummary", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsRequest.FilterType_getGamificationInsights = GetGamificationInsightsRequest.FilterType_getGamificationInsights.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsRequest.Granularity_getGamificationInsights = GetGamificationInsightsRequest.Granularity_getGamificationInsights.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortKey: GetGamificationInsightsRequest.SortKey_getGamificationInsights = GetGamificationInsightsRequest.SortKey_getGamificationInsights.enummember // Sort key\nlet sortMetricId: String = \"\" // Sort Metric Id\nlet sortOrder: GetGamificationInsightsRequest.SortOrder_getGamificationInsights = GetGamificationInsightsRequest.SortOrder_getGamificationInsights.enummember // Sort order\nlet userIds: String = \"\" // A list of up to 100 comma-separated user Ids\n\n// Get insights summary\nGetGamificationInsightsRequest.getGamificationInsights(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, pageSize: pageSize, pageNumber: pageNumber, sortKey: sortKey, sortMetricId: sortMetricId, sortOrder: sortOrder, userIds: userIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsRequest.getGamificationInsights was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsdetails": { - "operationId": "getgamificationinsightsdetails", - "functionName": "getGamificationInsightsDetails", - "signature": "getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "InsightsDetails", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsDetailsRequest.FilterType_getGamificationInsightsDetails = GetGamificationInsightsDetailsRequest.FilterType_getGamificationInsightsDetails.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsDetailsRequest.Granularity_getGamificationInsightsDetails = GetGamificationInsightsDetailsRequest.Granularity_getGamificationInsightsDetails.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights details for the current user\nGetGamificationInsightsDetailsRequest.getGamificationInsightsDetails(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsDetailsRequest.getGamificationInsightsDetails was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsgroupstrends": { - "operationId": "getgamificationinsightsgroupstrends", - "functionName": "getGamificationInsightsGroupsTrends", - "signature": "getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "comparativePeriodEndWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodEndWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "InsightsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsGroupsTrendsRequest.FilterType_getGamificationInsightsGroupsTrends = GetGamificationInsightsGroupsTrendsRequest.FilterType_getGamificationInsightsGroupsTrends.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsGroupsTrendsRequest.Granularity_getGamificationInsightsGroupsTrends = GetGamificationInsightsGroupsTrendsRequest.Granularity_getGamificationInsightsGroupsTrends.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights overall trend for the current user\nGetGamificationInsightsGroupsTrendsRequest.getGamificationInsightsGroupsTrends(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsGroupsTrendsRequest.getGamificationInsightsGroupsTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsgroupstrendsall": { - "operationId": "getgamificationinsightsgroupstrendsall", - "functionName": "getGamificationInsightsGroupsTrendsAll", - "signature": "getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "comparativePeriodEndWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodEndWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "InsightsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsGroupsTrendsAllRequest.FilterType_getGamificationInsightsGroupsTrendsAll = GetGamificationInsightsGroupsTrendsAllRequest.FilterType_getGamificationInsightsGroupsTrendsAll.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsGroupsTrendsAllRequest.Granularity_getGamificationInsightsGroupsTrendsAll = GetGamificationInsightsGroupsTrendsAllRequest.Granularity_getGamificationInsightsGroupsTrendsAll.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights overall trend\nGetGamificationInsightsGroupsTrendsAllRequest.getGamificationInsightsGroupsTrendsAll(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsGroupsTrendsAllRequest.getGamificationInsightsGroupsTrendsAll was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsmembers": { - "operationId": "getgamificationinsightsmembers", - "functionName": "getGamificationInsightsMembers", - "signature": "getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "InsightsAgents", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsMembersRequest.FilterType_getGamificationInsightsMembers = GetGamificationInsightsMembersRequest.FilterType_getGamificationInsightsMembers.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsMembersRequest.Granularity_getGamificationInsightsMembers = GetGamificationInsightsMembersRequest.Granularity_getGamificationInsightsMembers.enummember // Granularity\nlet startWorkday: Date = new Date(...) // The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Query users in a profile during a period of time\nGetGamificationInsightsMembersRequest.getGamificationInsightsMembers(filterType: filterType, filterId: filterId, granularity: granularity, startWorkday: startWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsMembersRequest.getGamificationInsightsMembers was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightstrends": { - "operationId": "getgamificationinsightstrends", - "functionName": "getGamificationInsightsTrends", - "signature": "getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "comparativePeriodEndWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodEndWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "UserInsightsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationInsightsTrendsRequest.FilterType_getGamificationInsightsTrends = GetGamificationInsightsTrendsRequest.FilterType_getGamificationInsightsTrends.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsTrendsRequest.Granularity_getGamificationInsightsTrends = GetGamificationInsightsTrendsRequest.Granularity_getGamificationInsightsTrends.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights user trend for the current user\nGetGamificationInsightsTrendsRequest.getGamificationInsightsTrends(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsTrendsRequest.getGamificationInsightsTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsuserdetails": { - "operationId": "getgamificationinsightsuserdetails", - "functionName": "getGamificationInsightsUserDetails", - "signature": "getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "InsightsDetails", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user.\nlet filterType: GetGamificationInsightsUserDetailsRequest.FilterType_getGamificationInsightsUserDetails = GetGamificationInsightsUserDetailsRequest.FilterType_getGamificationInsightsUserDetails.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsUserDetailsRequest.Granularity_getGamificationInsightsUserDetails = GetGamificationInsightsUserDetailsRequest.Granularity_getGamificationInsightsUserDetails.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights details for the user\nGetGamificationInsightsUserDetailsRequest.getGamificationInsightsUserDetails(userId: userId, filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsUserDetailsRequest.getGamificationInsightsUserDetails was successful\")\n dump(response)\n }\n}" - }, - "getgamificationinsightsusertrends": { - "operationId": "getgamificationinsightsusertrends", - "functionName": "getGamificationInsightsUserTrends", - "signature": "getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "granularity", - "type": "String", - "required": "true" - }, - { - "name": "comparativePeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "comparativePeriodEndWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodStartWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "primaryPeriodEndWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "UserInsightsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user.\nlet filterType: GetGamificationInsightsUserTrendsRequest.FilterType_getGamificationInsightsUserTrends = GetGamificationInsightsUserTrendsRequest.FilterType_getGamificationInsightsUserTrends.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet granularity: GetGamificationInsightsUserTrendsRequest.Granularity_getGamificationInsightsUserTrends = GetGamificationInsightsUserTrendsRequest.Granularity_getGamificationInsightsUserTrends.enummember // Granularity\nlet comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get insights user trend for the user\nGetGamificationInsightsUserTrendsRequest.getGamificationInsightsUserTrends(userId: userId, filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationInsightsUserTrendsRequest.getGamificationInsightsUserTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationleaderboard": { - "operationId": "getgamificationleaderboard", - "functionName": "getGamificationLeaderboard", - "signature": "getGamificationLeaderboard(startWorkday, endWorkday, metricId)", - "parameters": [ - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "false" - } - ], - "return": "Leaderboard", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startWorkday: Date = new Date(...) // Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet metricId: String = \"\" // Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.\n\n// Leaderboard of the requesting user's division or performance profile\nGetGamificationLeaderboardRequest.getGamificationLeaderboard(startWorkday: startWorkday, endWorkday: endWorkday, metricId: metricId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationLeaderboardRequest.getGamificationLeaderboard was successful\")\n dump(response)\n }\n}" - }, - "getgamificationleaderboardall": { - "operationId": "getgamificationleaderboardall", - "functionName": "getGamificationLeaderboardAll", - "signature": "getGamificationLeaderboardAll(filterType, filterId, startWorkday, endWorkday, metricId)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "false" - } - ], - "return": "Leaderboard", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationLeaderboardAllRequest.FilterType_getGamificationLeaderboardAll = GetGamificationLeaderboardAllRequest.FilterType_getGamificationLeaderboardAll.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type. For example, division or performance profile Id\nlet startWorkday: Date = new Date(...) // Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet metricId: String = \"\" // Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.\n\n// Leaderboard by filter type\nGetGamificationLeaderboardAllRequest.getGamificationLeaderboardAll(filterType: filterType, filterId: filterId, startWorkday: startWorkday, endWorkday: endWorkday, metricId: metricId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationLeaderboardAllRequest.getGamificationLeaderboardAll was successful\")\n dump(response)\n }\n}" - }, - "getgamificationleaderboardallbestpoints": { - "operationId": "getgamificationleaderboardallbestpoints", - "functionName": "getGamificationLeaderboardAllBestpoints", - "signature": "getGamificationLeaderboardAllBestpoints(filterType, filterId)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - } - ], - "return": "OverallBestPoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationLeaderboardAllBestpointsRequest.FilterType_getGamificationLeaderboardAllBestpoints = GetGamificationLeaderboardAllBestpointsRequest.FilterType_getGamificationLeaderboardAllBestpoints.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type. For example, division or performance profile Id\n\n// Best Points by division or performance profile\nGetGamificationLeaderboardAllBestpointsRequest.getGamificationLeaderboardAllBestpoints(filterType: filterType, filterId: filterId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationLeaderboardAllBestpointsRequest.getGamificationLeaderboardAllBestpoints was successful\")\n dump(response)\n }\n}" - }, - "getgamificationleaderboardbestpoints": { - "operationId": "getgamificationleaderboardbestpoints", - "functionName": "getGamificationLeaderboardBestpoints", - "signature": "getGamificationLeaderboardBestpoints()", - "return": "OverallBestPoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Best Points of the requesting user's current performance profile or division\nGetGamificationLeaderboardBestpointsRequest.getGamificationLeaderboardBestpoints() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationLeaderboardBestpointsRequest.getGamificationLeaderboardBestpoints was successful\")\n dump(response)\n }\n}" - }, - "getgamificationmetricdefinition": { - "operationId": "getgamificationmetricdefinition", - "functionName": "getGamificationMetricdefinition", - "signature": "getGamificationMetricdefinition(metricDefinitionId)", - "parameters": [ - { - "name": "metricDefinitionId", - "type": "String", - "required": "true" - } - ], - "return": "MetricDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet metricDefinitionId: String = \"\" // metric definition id\n\n// Metric definition by id\nGetGamificationMetricdefinitionRequest.getGamificationMetricdefinition(metricDefinitionId: metricDefinitionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationMetricdefinitionRequest.getGamificationMetricdefinition was successful\")\n dump(response)\n }\n}" - }, - "getgamificationmetricdefinitions": { - "operationId": "getgamificationmetricdefinitions", - "functionName": "getGamificationMetricdefinitions", - "signature": "getGamificationMetricdefinitions()", - "return": "GetMetricDefinitionsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// All metric definitions\nGetGamificationMetricdefinitionsRequest.getGamificationMetricdefinitions() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationMetricdefinitionsRequest.getGamificationMetricdefinitions was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofile": { - "operationId": "getgamificationprofile", - "functionName": "getGamificationProfile", - "signature": "getGamificationProfile(profileId)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\n\n// Performance profile by id\nGetGamificationProfileRequest.getGamificationProfile(profileId: profileId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfileRequest.getGamificationProfile was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilemembers": { - "operationId": "getgamificationprofilemembers", - "functionName": "getGamificationProfileMembers", - "signature": "getGamificationProfileMembers(profileId)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - } - ], - "return": "MemberListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Profile Id\n\n// Members of a given performance profile\nGetGamificationProfileMembersRequest.getGamificationProfileMembers(profileId: profileId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfileMembersRequest.getGamificationProfileMembers was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilemetric": { - "operationId": "getgamificationprofilemetric", - "functionName": "getGamificationProfileMetric", - "signature": "getGamificationProfileMetric(profileId, metricId, workday)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "false" - } - ], - "return": "Metric", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Performance Profile Id\nlet metricId: String = \"\" // Metric Id\nlet workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Performance profile gamified metric by id\nGetGamificationProfileMetricRequest.getGamificationProfileMetric(profileId: profileId, metricId: metricId, workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfileMetricRequest.getGamificationProfileMetric was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilemetrics": { - "operationId": "getgamificationprofilemetrics", - "functionName": "getGamificationProfileMetrics", - "signature": "getGamificationProfileMetrics(profileId, expand, workday, metricIds)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "workday", - "type": "Date", - "required": "false" - }, - { - "name": "metricIds", - "type": "String", - "required": "false" - } - ], - "return": "GetMetricResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Performance Profile Id\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet metricIds: String = \"\" // List of metric ids to filter the response (Optional, comma-separated).\n\n// All gamified metrics for a given performance profile\nGetGamificationProfileMetricsRequest.getGamificationProfileMetrics(profileId: profileId, expand: expand, workday: workday, metricIds: metricIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfileMetricsRequest.getGamificationProfileMetrics was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilemetricsobjectivedetails": { - "operationId": "getgamificationprofilemetricsobjectivedetails", - "functionName": "getGamificationProfileMetricsObjectivedetails", - "signature": "getGamificationProfileMetricsObjectivedetails(profileId, workday)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "false" - } - ], - "return": "GetMetricsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Performance Profile Id\nlet workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// All metrics for a given performance profile with objective details such as order and maxPoints\nGetGamificationProfileMetricsObjectivedetailsRequest.getGamificationProfileMetricsObjectivedetails(profileId: profileId, workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfileMetricsObjectivedetailsRequest.getGamificationProfileMetricsObjectivedetails was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofiles": { - "operationId": "getgamificationprofiles", - "functionName": "getGamificationProfiles", - "signature": "getGamificationProfiles()", - "return": "GetProfilesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// All performance profiles\nGetGamificationProfilesRequest.getGamificationProfiles() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfilesRequest.getGamificationProfiles was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilesuser": { - "operationId": "getgamificationprofilesuser", - "functionName": "getGamificationProfilesUser", - "signature": "getGamificationProfilesUser(userId, workday)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "false" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet workday: Date = new Date(...) // Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Performance profile of a user\nGetGamificationProfilesUserRequest.getGamificationProfilesUser(userId: userId, workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfilesUserRequest.getGamificationProfilesUser was successful\")\n dump(response)\n }\n}" - }, - "getgamificationprofilesusersme": { - "operationId": "getgamificationprofilesusersme", - "functionName": "getGamificationProfilesUsersMe", - "signature": "getGamificationProfilesUsersMe(workday)", - "parameters": [ - { - "name": "workday", - "type": "Date", - "required": "false" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workday: Date = new Date(...) // Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Performance profile of the requesting user\nGetGamificationProfilesUsersMeRequest.getGamificationProfilesUsersMe(workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationProfilesUsersMeRequest.getGamificationProfilesUsersMe was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecards": { - "operationId": "getgamificationscorecards", - "functionName": "getGamificationScorecards", - "signature": "getGamificationScorecards(workday, expand)", - "parameters": [ - { - "name": "workday", - "type": "Date", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkdayMetricListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workday: Date = new Date(...) // Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Workday performance metrics of the requesting user\nGetGamificationScorecardsRequest.getGamificationScorecards(workday: workday, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsRequest.getGamificationScorecards was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsattendance": { - "operationId": "getgamificationscorecardsattendance", - "functionName": "getGamificationScorecardsAttendance", - "signature": "getGamificationScorecardsAttendance(startWorkday, endWorkday)", - "parameters": [ - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "AttendanceStatusListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Attendance status metrics of the requesting user\nGetGamificationScorecardsAttendanceRequest.getGamificationScorecardsAttendance(startWorkday: startWorkday, endWorkday: endWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsAttendanceRequest.getGamificationScorecardsAttendance was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsbestpoints": { - "operationId": "getgamificationscorecardsbestpoints", - "functionName": "getGamificationScorecardsBestpoints", - "signature": "getGamificationScorecardsBestpoints()", - "return": "UserBestPoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Best points of the requesting user\nGetGamificationScorecardsBestpointsRequest.getGamificationScorecardsBestpoints() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsBestpointsRequest.getGamificationScorecardsBestpoints was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardspointsalltime": { - "operationId": "getgamificationscorecardspointsalltime", - "functionName": "getGamificationScorecardsPointsAlltime", - "signature": "getGamificationScorecardsPointsAlltime(endWorkday)", - "parameters": [ - { - "name": "endWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "AllTimePoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// All-time points of the requesting user\nGetGamificationScorecardsPointsAlltimeRequest.getGamificationScorecardsPointsAlltime(endWorkday: endWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsPointsAlltimeRequest.getGamificationScorecardsPointsAlltime was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardspointsaverage": { - "operationId": "getgamificationscorecardspointsaverage", - "functionName": "getGamificationScorecardsPointsAverage", - "signature": "getGamificationScorecardsPointsAverage(workday)", - "parameters": [ - { - "name": "workday", - "type": "Date", - "required": "true" - } - ], - "return": "SingleWorkdayAveragePoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Average points of the requesting user's division or performance profile\nGetGamificationScorecardsPointsAverageRequest.getGamificationScorecardsPointsAverage(workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsPointsAverageRequest.getGamificationScorecardsPointsAverage was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardspointstrends": { - "operationId": "getgamificationscorecardspointstrends", - "functionName": "getGamificationScorecardsPointsTrends", - "signature": "getGamificationScorecardsPointsTrends(startWorkday, endWorkday, dayOfWeek)", - "parameters": [ - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "dayOfWeek", - "type": "String", - "required": "false" - } - ], - "return": "WorkdayPointsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet dayOfWeek: GetGamificationScorecardsPointsTrendsRequest.DayOfWeek_getGamificationScorecardsPointsTrends = GetGamificationScorecardsPointsTrendsRequest.DayOfWeek_getGamificationScorecardsPointsTrends.enummember // Optional filter to specify which day of weeks to be included in the response\n\n// Points trends of the requesting user\nGetGamificationScorecardsPointsTrendsRequest.getGamificationScorecardsPointsTrends(startWorkday: startWorkday, endWorkday: endWorkday, dayOfWeek: dayOfWeek) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsPointsTrendsRequest.getGamificationScorecardsPointsTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsprofilemetricuservaluestrends": { - "operationId": "getgamificationscorecardsprofilemetricuservaluestrends", - "functionName": "getGamificationScorecardsProfileMetricUserValuesTrends", - "signature": "getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, referenceWorkday, timeZone)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "referenceWorkday", - "type": "Date", - "required": "false" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "MetricValueTrendAverage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\nlet metricId: String = \"\" // metricId\nlet userId: String = \"\" // \nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Average performance values trends by metric of a user\nGetGamificationScorecardsProfileMetricUserValuesTrendsRequest.getGamificationScorecardsProfileMetricUserValuesTrends(profileId: profileId, metricId: metricId, userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsProfileMetricUserValuesTrendsRequest.getGamificationScorecardsProfileMetricUserValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsprofilemetricusersvaluestrends": { - "operationId": "getgamificationscorecardsprofilemetricusersvaluestrends", - "functionName": "getGamificationScorecardsProfileMetricUsersValuesTrends", - "signature": "getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, filterId, referenceWorkday, timeZone)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "false" - }, - { - "name": "referenceWorkday", - "type": "Date", - "required": "false" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "MetricValueTrendAverage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\nlet metricId: String = \"\" // metricId\nlet filterType: GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricUsersValuesTrends = GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricUsersValuesTrends.enummember // Filter type for the query request.\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet filterId: String = \"\" // ID for the filter type. Only required when filterType is Division.\nlet referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Average performance values trends by metric of a division or a performance profile\nGetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.getGamificationScorecardsProfileMetricUsersValuesTrends(profileId: profileId, metricId: metricId, filterType: filterType, startWorkday: startWorkday, endWorkday: endWorkday, filterId: filterId, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.getGamificationScorecardsProfileMetricUsersValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsprofilemetricvaluestrends": { - "operationId": "getgamificationscorecardsprofilemetricvaluestrends", - "functionName": "getGamificationScorecardsProfileMetricValuesTrends", - "signature": "getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, filterType, referenceWorkday, timeZone)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "referenceWorkday", - "type": "Date", - "required": "false" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "MetricValueTrendAverage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\nlet metricId: String = \"\" // metricId\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet filterType: GetGamificationScorecardsProfileMetricValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricValuesTrends = GetGamificationScorecardsProfileMetricValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricValuesTrends.enummember // Filter type for the query request. If not set, returns the values trends of the requesting user\nlet referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Average performance values trends by metric of the requesting user\nGetGamificationScorecardsProfileMetricValuesTrendsRequest.getGamificationScorecardsProfileMetricValuesTrends(profileId: profileId, metricId: metricId, startWorkday: startWorkday, endWorkday: endWorkday, filterType: filterType, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsProfileMetricValuesTrendsRequest.getGamificationScorecardsProfileMetricValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuser": { - "operationId": "getgamificationscorecardsuser", - "functionName": "getGamificationScorecardsUser", - "signature": "getGamificationScorecardsUser(userId, workday, expand)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkdayMetricListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet workday: Date = new Date(...) // Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Workday performance metrics for a user\nGetGamificationScorecardsUserRequest.getGamificationScorecardsUser(userId: userId, workday: workday, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserRequest.getGamificationScorecardsUser was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuserattendance": { - "operationId": "getgamificationscorecardsuserattendance", - "functionName": "getGamificationScorecardsUserAttendance", - "signature": "getGamificationScorecardsUserAttendance(userId, startWorkday, endWorkday)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "AttendanceStatusListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Attendance status metrics for a user\nGetGamificationScorecardsUserAttendanceRequest.getGamificationScorecardsUserAttendance(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserAttendanceRequest.getGamificationScorecardsUserAttendance was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuserbestpoints": { - "operationId": "getgamificationscorecardsuserbestpoints", - "functionName": "getGamificationScorecardsUserBestpoints", - "signature": "getGamificationScorecardsUserBestpoints(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "UserBestPoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \n\n// Best points of a user\nGetGamificationScorecardsUserBestpointsRequest.getGamificationScorecardsUserBestpoints(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserBestpointsRequest.getGamificationScorecardsUserBestpoints was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuserpointsalltime": { - "operationId": "getgamificationscorecardsuserpointsalltime", - "functionName": "getGamificationScorecardsUserPointsAlltime", - "signature": "getGamificationScorecardsUserPointsAlltime(userId, endWorkday)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - } - ], - "return": "AllTimePoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// All-time points for a user\nGetGamificationScorecardsUserPointsAlltimeRequest.getGamificationScorecardsUserPointsAlltime(userId: userId, endWorkday: endWorkday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserPointsAlltimeRequest.getGamificationScorecardsUserPointsAlltime was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuserpointstrends": { - "operationId": "getgamificationscorecardsuserpointstrends", - "functionName": "getGamificationScorecardsUserPointsTrends", - "signature": "getGamificationScorecardsUserPointsTrends(userId, startWorkday, endWorkday, dayOfWeek)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "dayOfWeek", - "type": "String", - "required": "false" - } - ], - "return": "WorkdayPointsTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet dayOfWeek: GetGamificationScorecardsUserPointsTrendsRequest.DayOfWeek_getGamificationScorecardsUserPointsTrends = GetGamificationScorecardsUserPointsTrendsRequest.DayOfWeek_getGamificationScorecardsUserPointsTrends.enummember // Optional filter to specify which day of weeks to be included in the response\n\n// Points trend for a user\nGetGamificationScorecardsUserPointsTrendsRequest.getGamificationScorecardsUserPointsTrends(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, dayOfWeek: dayOfWeek) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserPointsTrendsRequest.getGamificationScorecardsUserPointsTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuservaluestrends": { - "operationId": "getgamificationscorecardsuservaluestrends", - "functionName": "getGamificationScorecardsUserValuesTrends", - "signature": "getGamificationScorecardsUserValuesTrends(userId, startWorkday, endWorkday, timeZone)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "WorkdayValuesTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // \nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Values trends of a user\nGetGamificationScorecardsUserValuesTrendsRequest.getGamificationScorecardsUserValuesTrends(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUserValuesTrendsRequest.getGamificationScorecardsUserValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsuserspointsaverage": { - "operationId": "getgamificationscorecardsuserspointsaverage", - "functionName": "getGamificationScorecardsUsersPointsAverage", - "signature": "getGamificationScorecardsUsersPointsAverage(filterType, filterId, workday)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "true" - } - ], - "return": "SingleWorkdayAveragePoints", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationScorecardsUsersPointsAverageRequest.FilterType_getGamificationScorecardsUsersPointsAverage = GetGamificationScorecardsUsersPointsAverageRequest.FilterType_getGamificationScorecardsUsersPointsAverage.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Workday average points by target group\nGetGamificationScorecardsUsersPointsAverageRequest.getGamificationScorecardsUsersPointsAverage(filterType: filterType, filterId: filterId, workday: workday) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUsersPointsAverageRequest.getGamificationScorecardsUsersPointsAverage was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsusersvaluesaverage": { - "operationId": "getgamificationscorecardsusersvaluesaverage", - "functionName": "getGamificationScorecardsUsersValuesAverage", - "signature": "getGamificationScorecardsUsersValuesAverage(filterType, filterId, workday, timeZone)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "workday", - "type": "Date", - "required": "true" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "SingleWorkdayAverageValues", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationScorecardsUsersValuesAverageRequest.FilterType_getGamificationScorecardsUsersValuesAverage = GetGamificationScorecardsUsersValuesAverageRequest.FilterType_getGamificationScorecardsUsersValuesAverage.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type. For example, division Id\nlet workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Workday average values by target group\nGetGamificationScorecardsUsersValuesAverageRequest.getGamificationScorecardsUsersValuesAverage(filterType: filterType, filterId: filterId, workday: workday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUsersValuesAverageRequest.getGamificationScorecardsUsersValuesAverage was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsusersvaluestrends": { - "operationId": "getgamificationscorecardsusersvaluestrends", - "functionName": "getGamificationScorecardsUsersValuesTrends", - "signature": "getGamificationScorecardsUsersValuesTrends(filterType, filterId, startWorkday, endWorkday, timeZone)", - "parameters": [ - { - "name": "filterType", - "type": "String", - "required": "true" - }, - { - "name": "filterId", - "type": "String", - "required": "true" - }, - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "WorkdayValuesTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filterType: GetGamificationScorecardsUsersValuesTrendsRequest.FilterType_getGamificationScorecardsUsersValuesTrends = GetGamificationScorecardsUsersValuesTrendsRequest.FilterType_getGamificationScorecardsUsersValuesTrends.enummember // Filter type for the query request.\nlet filterId: String = \"\" // ID for the filter type.\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Values trend by target group\nGetGamificationScorecardsUsersValuesTrendsRequest.getGamificationScorecardsUsersValuesTrends(filterType: filterType, filterId: filterId, startWorkday: startWorkday, endWorkday: endWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsUsersValuesTrendsRequest.getGamificationScorecardsUsersValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsvaluesaverage": { - "operationId": "getgamificationscorecardsvaluesaverage", - "functionName": "getGamificationScorecardsValuesAverage", - "signature": "getGamificationScorecardsValuesAverage(workday, timeZone)", - "parameters": [ - { - "name": "workday", - "type": "Date", - "required": "true" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "SingleWorkdayAverageValues", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Average values of the requesting user's division or performance profile\nGetGamificationScorecardsValuesAverageRequest.getGamificationScorecardsValuesAverage(workday: workday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsValuesAverageRequest.getGamificationScorecardsValuesAverage was successful\")\n dump(response)\n }\n}" - }, - "getgamificationscorecardsvaluestrends": { - "operationId": "getgamificationscorecardsvaluestrends", - "functionName": "getGamificationScorecardsValuesTrends", - "signature": "getGamificationScorecardsValuesTrends(startWorkday, endWorkday, filterType, referenceWorkday, timeZone)", - "parameters": [ - { - "name": "startWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "endWorkday", - "type": "Date", - "required": "true" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "referenceWorkday", - "type": "Date", - "required": "false" - }, - { - "name": "timeZone", - "type": "String", - "required": "false" - } - ], - "return": "WorkdayValuesTrend", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet filterType: GetGamificationScorecardsValuesTrendsRequest.FilterType_getGamificationScorecardsValuesTrends = GetGamificationScorecardsValuesTrendsRequest.FilterType_getGamificationScorecardsValuesTrends.enummember // Filter type for the query request. If not set, then the request is for the requesting user.\nlet referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet timeZone: String = \"\" // Timezone for the workday. Defaults to UTC\n\n// Values trends of the requesting user or group\nGetGamificationScorecardsValuesTrendsRequest.getGamificationScorecardsValuesTrends(startWorkday: startWorkday, endWorkday: endWorkday, filterType: filterType, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationScorecardsValuesTrendsRequest.getGamificationScorecardsValuesTrends was successful\")\n dump(response)\n }\n}" - }, - "getgamificationstatus": { - "operationId": "getgamificationstatus", - "functionName": "getGamificationStatus", - "signature": "getGamificationStatus()", - "return": "GamificationStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Gamification activation status\nGetGamificationStatusRequest.getGamificationStatus() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationStatusRequest.getGamificationStatus was successful\")\n dump(response)\n }\n}" - }, - "getgamificationtemplate": { - "operationId": "getgamificationtemplate", - "functionName": "getGamificationTemplate", - "signature": "getGamificationTemplate(templateId)", - "parameters": [ - { - "name": "templateId", - "type": "String", - "required": "true" - } - ], - "return": "ObjectiveTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet templateId: String = \"\" // template id\n\n// Objective template by id\nGetGamificationTemplateRequest.getGamificationTemplate(templateId: templateId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationTemplateRequest.getGamificationTemplate was successful\")\n dump(response)\n }\n}" - }, - "getgamificationtemplates": { - "operationId": "getgamificationtemplates", - "functionName": "getGamificationTemplates", - "signature": "getGamificationTemplates()", - "return": "GetTemplatesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// All objective templates\nGetGamificationTemplatesRequest.getGamificationTemplates() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGamificationTemplatesRequest.getGamificationTemplates was successful\")\n dump(response)\n }\n}" - }, - "patchemployeeperformanceexternalmetricsdefinition": { - "operationId": "patchemployeeperformanceexternalmetricsdefinition", - "functionName": "patchEmployeeperformanceExternalmetricsDefinition", - "signature": "patchEmployeeperformanceExternalmetricsDefinition(metricId, body)", - "parameters": [ - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExternalMetricDefinitionUpdateRequest", - "required": "true" - } - ], - "return": "ExternalMetricDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet metricId: String = \"\" // Specifies the metric definition ID\nlet body: ExternalMetricDefinitionUpdateRequest = new ExternalMetricDefinitionUpdateRequest(...) // The External Metric Definition parameters to be updated\n\n// Update External Metric Definition\nPatchEmployeeperformanceExternalmetricsDefinitionRequest.patchEmployeeperformanceExternalmetricsDefinition(metricId: metricId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchEmployeeperformanceExternalmetricsDefinitionRequest.patchEmployeeperformanceExternalmetricsDefinition was successful\")\n dump(response)\n }\n}" - }, - "postemployeeperformanceexternalmetricsdata": { - "operationId": "postemployeeperformanceexternalmetricsdata", - "functionName": "postEmployeeperformanceExternalmetricsData", - "signature": "postEmployeeperformanceExternalmetricsData(body)", - "parameters": [ - { - "name": "body", - "type": "ExternalMetricDataWriteRequest", - "required": "false" - } - ], - "return": "ExternalMetricDataWriteResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ExternalMetricDataWriteRequest = new ExternalMetricDataWriteRequest(...) // The External Metric Data to be added\n\n// Write External Metric Data\nPostEmployeeperformanceExternalmetricsDataRequest.postEmployeeperformanceExternalmetricsData(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostEmployeeperformanceExternalmetricsDataRequest.postEmployeeperformanceExternalmetricsData was successful\")\n dump(response)\n }\n}" - }, - "postemployeeperformanceexternalmetricsdefinitions": { - "operationId": "postemployeeperformanceexternalmetricsdefinitions", - "functionName": "postEmployeeperformanceExternalmetricsDefinitions", - "signature": "postEmployeeperformanceExternalmetricsDefinitions(body)", - "parameters": [ - { - "name": "body", - "type": "ExternalMetricDefinitionCreateRequest", - "required": "false" - } - ], - "return": "ExternalMetricDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ExternalMetricDefinitionCreateRequest = new ExternalMetricDefinitionCreateRequest(...) // The External Metric Definition to be created\n\n// Create External Metric Definition\nPostEmployeeperformanceExternalmetricsDefinitionsRequest.postEmployeeperformanceExternalmetricsDefinitions(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostEmployeeperformanceExternalmetricsDefinitionsRequest.postEmployeeperformanceExternalmetricsDefinitions was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofileactivate": { - "operationId": "postgamificationprofileactivate", - "functionName": "postGamificationProfileActivate", - "signature": "postGamificationProfileActivate(profileId)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\n\n// Activate a performance profile\nPostGamificationProfileActivateRequest.postGamificationProfileActivate(profileId: profileId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileActivateRequest.postGamificationProfileActivate was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofiledeactivate": { - "operationId": "postgamificationprofiledeactivate", - "functionName": "postGamificationProfileDeactivate", - "signature": "postGamificationProfileDeactivate(profileId)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\n\n// Deactivate a performance profile\nPostGamificationProfileDeactivateRequest.postGamificationProfileDeactivate(profileId: profileId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileDeactivateRequest.postGamificationProfileDeactivate was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilemembers": { - "operationId": "postgamificationprofilemembers", - "functionName": "postGamificationProfileMembers", - "signature": "postGamificationProfileMembers(profileId, body)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AssignUsers", - "required": "true" - } - ], - "return": "Assignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Profile Id\nlet body: AssignUsers = new AssignUsers(...) // assignUsers\n\n// Assign members to a given performance profile\nPostGamificationProfileMembersRequest.postGamificationProfileMembers(profileId: profileId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileMembersRequest.postGamificationProfileMembers was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilemembersvalidate": { - "operationId": "postgamificationprofilemembersvalidate", - "functionName": "postGamificationProfileMembersValidate", - "signature": "postGamificationProfileMembersValidate(profileId, body)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ValidateAssignUsers", - "required": "true" - } - ], - "return": "AssignmentValidation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Profile Id\nlet body: ValidateAssignUsers = new ValidateAssignUsers(...) // memberAssignments\n\n// Validate member assignment\nPostGamificationProfileMembersValidateRequest.postGamificationProfileMembersValidate(profileId: profileId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileMembersValidateRequest.postGamificationProfileMembersValidate was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilemetriclink": { - "operationId": "postgamificationprofilemetriclink", - "functionName": "postGamificationProfileMetricLink", - "signature": "postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body)", - "parameters": [ - { - "name": "sourceProfileId", - "type": "String", - "required": "true" - }, - { - "name": "sourceMetricId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TargetPerformanceProfile", - "required": "true" - } - ], - "return": "Metric", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sourceProfileId: String = \"\" // Source Performance Profile Id\nlet sourceMetricId: String = \"\" // Source Metric Id\nlet body: TargetPerformanceProfile = new TargetPerformanceProfile(...) // linkedMetric\n\n// Creates a linked metric\nPostGamificationProfileMetricLinkRequest.postGamificationProfileMetricLink(sourceProfileId: sourceProfileId, sourceMetricId: sourceMetricId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileMetricLinkRequest.postGamificationProfileMetricLink was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilemetrics": { - "operationId": "postgamificationprofilemetrics", - "functionName": "postGamificationProfileMetrics", - "signature": "postGamificationProfileMetrics(profileId, body)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateMetric", - "required": "true" - } - ], - "return": "Metric", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Performance Profile Id\nlet body: CreateMetric = new CreateMetric(...) // Metric\n\n// Creates a gamified metric with a given metric definition and metric objective under in a performance profile\nPostGamificationProfileMetricsRequest.postGamificationProfileMetrics(profileId: profileId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfileMetricsRequest.postGamificationProfileMetrics was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofiles": { - "operationId": "postgamificationprofiles", - "functionName": "postGamificationProfiles", - "signature": "postGamificationProfiles(body, copyMetrics)", - "parameters": [ - { - "name": "body", - "type": "CreatePerformanceProfile", - "required": "true" - }, - { - "name": "copyMetrics", - "type": "Bool", - "required": "false" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreatePerformanceProfile = new CreatePerformanceProfile(...) // performanceProfile\nlet copyMetrics: Bool = true // Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile.\n\n// Create a new custom performance profile\nPostGamificationProfilesRequest.postGamificationProfiles(body: body, copyMetrics: copyMetrics) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfilesRequest.postGamificationProfiles was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilesuserquery": { - "operationId": "postgamificationprofilesuserquery", - "functionName": "postGamificationProfilesUserQuery", - "signature": "postGamificationProfilesUserQuery(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserProfilesInDateRangeRequest", - "required": "true" - } - ], - "return": "UserProfilesInDateRange", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user.\nlet body: UserProfilesInDateRangeRequest = new UserProfilesInDateRangeRequest(...) // The date range of work day.\n\n// Query performance profiles in date range for a user\nPostGamificationProfilesUserQueryRequest.postGamificationProfilesUserQuery(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfilesUserQueryRequest.postGamificationProfilesUserQuery was successful\")\n dump(response)\n }\n}" - }, - "postgamificationprofilesusersmequery": { - "operationId": "postgamificationprofilesusersmequery", - "functionName": "postGamificationProfilesUsersMeQuery", - "signature": "postGamificationProfilesUsersMeQuery(body)", - "parameters": [ - { - "name": "body", - "type": "UserProfilesInDateRangeRequest", - "required": "true" - } - ], - "return": "UserProfilesInDateRange", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserProfilesInDateRangeRequest = new UserProfilesInDateRangeRequest(...) // The date range of work day.\n\n// Query performance profiles in date range for the current user\nPostGamificationProfilesUsersMeQueryRequest.postGamificationProfilesUsersMeQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGamificationProfilesUsersMeQueryRequest.postGamificationProfilesUsersMeQuery was successful\")\n dump(response)\n }\n}" - }, - "putgamificationprofile": { - "operationId": "putgamificationprofile", - "functionName": "putGamificationProfile", - "signature": "putGamificationProfile(profileId, body)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PerformanceProfile", - "required": "false" - } - ], - "return": "PerformanceProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // performanceProfileId\nlet body: PerformanceProfile = new PerformanceProfile(...) // performanceProfile\n\n// Updates a performance profile\nPutGamificationProfileRequest.putGamificationProfile(profileId: profileId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGamificationProfileRequest.putGamificationProfile was successful\")\n dump(response)\n }\n}" - }, - "putgamificationprofilemetric": { - "operationId": "putgamificationprofilemetric", - "functionName": "putGamificationProfileMetric", - "signature": "putGamificationProfileMetric(profileId, metricId, body)", - "parameters": [ - { - "name": "profileId", - "type": "String", - "required": "true" - }, - { - "name": "metricId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateMetric", - "required": "true" - } - ], - "return": "Metric", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet profileId: String = \"\" // Performance Profile Id\nlet metricId: String = \"\" // Metric Id\nlet body: CreateMetric = new CreateMetric(...) // Metric\n\n// Updates a metric in performance profile\nPutGamificationProfileMetricRequest.putGamificationProfileMetric(profileId: profileId, metricId: metricId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGamificationProfileMetricRequest.putGamificationProfileMetric was successful\")\n dump(response)\n }\n}" - }, - "putgamificationstatus": { - "operationId": "putgamificationstatus", - "functionName": "putGamificationStatus", - "signature": "putGamificationStatus(status)", - "parameters": [ - { - "name": "status", - "type": "GamificationStatus", - "required": "true" - } - ], - "return": "GamificationStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet status: GamificationStatus = new GamificationStatus(...) // Gamification status\n\n// Update gamification activation status\nPutGamificationStatusRequest.putGamificationStatus(status: status) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGamificationStatusRequest.putGamificationStatus was successful\")\n dump(response)\n }\n}" - }, - "getgdprrequest": { - "operationId": "getgdprrequest", - "functionName": "getGdprRequest", - "signature": "getGdprRequest(requestId)", - "parameters": [ - { - "name": "requestId", - "type": "String", - "required": "true" - } - ], - "return": "GDPRRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet requestId: String = \"\" // Request id\n\n// Get an existing GDPR request\nGetGdprRequestRequest.getGdprRequest(requestId: requestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGdprRequestRequest.getGdprRequest was successful\")\n dump(response)\n }\n}" - }, - "getgdprrequests": { - "operationId": "getgdprrequests", - "functionName": "getGdprRequests", - "signature": "getGdprRequests(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "GDPRRequestEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get all GDPR requests\nGetGdprRequestsRequest.getGdprRequests(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGdprRequestsRequest.getGdprRequests was successful\")\n dump(response)\n }\n}" - }, - "getgdprsubjects": { - "operationId": "getgdprsubjects", - "functionName": "getGdprSubjects", - "signature": "getGdprSubjects(searchType, searchValue)", - "parameters": [ - { - "name": "searchType", - "type": "String", - "required": "true" - }, - { - "name": "searchValue", - "type": "String", - "required": "true" - } - ], - "return": "GDPRSubjectEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet searchType: GetGdprSubjectsRequest.SearchType_getGdprSubjects = GetGdprSubjectsRequest.SearchType_getGdprSubjects.enummember // Search Type\nlet searchValue: String = \"\" // Search Value\n\n// Get GDPR subjects\nGetGdprSubjectsRequest.getGdprSubjects(searchType: searchType, searchValue: searchValue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGdprSubjectsRequest.getGdprSubjects was successful\")\n dump(response)\n }\n}" - }, - "postgdprrequests": { - "operationId": "postgdprrequests", - "functionName": "postGdprRequests", - "signature": "postGdprRequests(body, deleteConfirmed)", - "parameters": [ - { - "name": "body", - "type": "GDPRRequest", - "required": "true" - }, - { - "name": "deleteConfirmed", - "type": "Bool", - "required": "false" - } - ], - "return": "GDPRRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GDPRRequest = new GDPRRequest(...) // GDPR request\nlet deleteConfirmed: Bool = true // Confirm delete\n\n// Submit a new GDPR request\nPostGdprRequestsRequest.postGdprRequests(body: body, deleteConfirmed: deleteConfirmed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGdprRequestsRequest.postGdprRequests was successful\")\n dump(response)\n }\n}" - }, - "getgeolocationssettings": { - "operationId": "getgeolocationssettings", - "functionName": "getGeolocationsSettings", - "signature": "getGeolocationsSettings()", - "return": "GeolocationSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a organization's GeolocationSettings\nGetGeolocationsSettingsRequest.getGeolocationsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGeolocationsSettingsRequest.getGeolocationsSettings was successful\")\n dump(response)\n }\n}" - }, - "getusergeolocation": { - "operationId": "getusergeolocation", - "functionName": "getUserGeolocation", - "signature": "getUserGeolocation(userId, clientId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "clientId", - "type": "String", - "required": "true" - } - ], - "return": "Geolocation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\nlet clientId: String = \"\" // client Id\n\n// Get a user's Geolocation\nGetUserGeolocationRequest.getUserGeolocation(userId: userId, clientId: clientId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserGeolocationRequest.getUserGeolocation was successful\")\n dump(response)\n }\n}" - }, - "patchgeolocationssettings": { - "operationId": "patchgeolocationssettings", - "functionName": "patchGeolocationsSettings", - "signature": "patchGeolocationsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "GeolocationSettings", - "required": "true" - } - ], - "return": "GeolocationSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GeolocationSettings = new GeolocationSettings(...) // Geolocation settings\n\n// Patch a organization's GeolocationSettings\nPatchGeolocationsSettingsRequest.patchGeolocationsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchGeolocationsSettingsRequest.patchGeolocationsSettings was successful\")\n dump(response)\n }\n}" - }, - "patchusergeolocation": { - "operationId": "patchusergeolocation", - "functionName": "patchUserGeolocation", - "signature": "patchUserGeolocation(userId, clientId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "clientId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Geolocation", - "required": "true" - } - ], - "return": "Geolocation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\nlet clientId: String = \"\" // client Id\nlet body: Geolocation = new Geolocation(...) // Geolocation\n\n// Patch a user's Geolocation\nPatchUserGeolocationRequest.patchUserGeolocation(userId: userId, clientId: clientId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserGeolocationRequest.patchUserGeolocation was successful\")\n dump(response)\n }\n}" - }, - "deletegreeting": { - "operationId": "deletegreeting", - "functionName": "deleteGreeting", - "signature": "deleteGreeting(greetingId)", - "parameters": [ - { - "name": "greetingId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet greetingId: String = \"\" // Greeting ID\n\n// Deletes a Greeting with the given GreetingId\nDeleteGreetingRequest.deleteGreeting(greetingId: greetingId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteGreetingRequest.deleteGreeting was successful\")\n }\n}" - }, - "getgreeting": { - "operationId": "getgreeting", - "functionName": "getGreeting", - "signature": "getGreeting(greetingId)", - "parameters": [ - { - "name": "greetingId", - "type": "String", - "required": "true" - } - ], - "return": "Greeting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet greetingId: String = \"\" // Greeting ID\n\n// Get a Greeting with the given GreetingId\nGetGreetingRequest.getGreeting(greetingId: greetingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGreetingRequest.getGreeting was successful\")\n dump(response)\n }\n}" - }, - "getgreetingmedia": { - "operationId": "getgreetingmedia", - "functionName": "getGreetingMedia", - "signature": "getGreetingMedia(greetingId, formatId)", - "parameters": [ - { - "name": "greetingId", - "type": "String", - "required": "true" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - } - ], - "return": "GreetingMediaInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet greetingId: String = \"\" // Greeting ID\nlet formatId: GetGreetingMediaRequest.FormatId_getGreetingMedia = GetGreetingMediaRequest.FormatId_getGreetingMedia.enummember // The desired media format.\n\n// Get media playback URI for this greeting\nGetGreetingMediaRequest.getGreetingMedia(greetingId: greetingId, formatId: formatId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGreetingMediaRequest.getGreetingMedia was successful\")\n dump(response)\n }\n}" - }, - "getgreetings": { - "operationId": "getgreetings", - "functionName": "getGreetings", - "signature": "getGreetings(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "DomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Gets an Organization's Greetings\nGetGreetingsRequest.getGreetings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGreetingsRequest.getGreetings was successful\")\n dump(response)\n }\n}" - }, - "getgreetingsdefaults": { - "operationId": "getgreetingsdefaults", - "functionName": "getGreetingsDefaults", - "signature": "getGreetingsDefaults()", - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get an Organization's DefaultGreetingList\nGetGreetingsDefaultsRequest.getGreetingsDefaults() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGreetingsDefaultsRequest.getGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "getgroupgreetings": { - "operationId": "getgroupgreetings", - "functionName": "getGroupGreetings", - "signature": "getGroupGreetings(groupId, pageSize, pageNumber)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "GreetingListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of the Group's Greetings\nGetGroupGreetingsRequest.getGroupGreetings(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupGreetingsRequest.getGroupGreetings was successful\")\n dump(response)\n }\n}" - }, - "getgroupgreetingsdefaults": { - "operationId": "getgroupgreetingsdefaults", - "functionName": "getGroupGreetingsDefaults", - "signature": "getGroupGreetingsDefaults(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\n\n// Grabs the list of Default Greetings given a Group's ID\nGetGroupGreetingsDefaultsRequest.getGroupGreetingsDefaults(groupId: groupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupGreetingsDefaultsRequest.getGroupGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "getusergreetings": { - "operationId": "getusergreetings", - "functionName": "getUserGreetings", - "signature": "getUserGreetings(userId, pageSize, pageNumber)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "DomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of the User's Greetings\nGetUserGreetingsRequest.getUserGreetings(userId: userId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserGreetingsRequest.getUserGreetings was successful\")\n dump(response)\n }\n}" - }, - "getusergreetingsdefaults": { - "operationId": "getusergreetingsdefaults", - "functionName": "getUserGreetingsDefaults", - "signature": "getUserGreetingsDefaults(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Grabs the list of Default Greetings given a User's ID\nGetUserGreetingsDefaultsRequest.getUserGreetingsDefaults(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserGreetingsDefaultsRequest.getUserGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "postgreetings": { - "operationId": "postgreetings", - "functionName": "postGreetings", - "signature": "postGreetings(body)", - "parameters": [ - { - "name": "body", - "type": "Greeting", - "required": "true" - } - ], - "return": "Greeting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Greeting = new Greeting(...) // The Greeting to create\n\n// Create a Greeting for an Organization\nPostGreetingsRequest.postGreetings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGreetingsRequest.postGreetings was successful\")\n dump(response)\n }\n}" - }, - "postgroupgreetings": { - "operationId": "postgroupgreetings", - "functionName": "postGroupGreetings", - "signature": "postGroupGreetings(groupId, body)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Greeting", - "required": "true" - } - ], - "return": "Greeting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet body: Greeting = new Greeting(...) // The Greeting to create\n\n// Creates a Greeting for a Group\nPostGroupGreetingsRequest.postGroupGreetings(groupId: groupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGroupGreetingsRequest.postGroupGreetings was successful\")\n dump(response)\n }\n}" - }, - "postusergreetings": { - "operationId": "postusergreetings", - "functionName": "postUserGreetings", - "signature": "postUserGreetings(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Greeting", - "required": "true" - } - ], - "return": "Greeting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: Greeting = new Greeting(...) // The Greeting to create\n\n// Creates a Greeting for a User\nPostUserGreetingsRequest.postUserGreetings(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUserGreetingsRequest.postUserGreetings was successful\")\n dump(response)\n }\n}" - }, - "putgreeting": { - "operationId": "putgreeting", - "functionName": "putGreeting", - "signature": "putGreeting(greetingId, body)", - "parameters": [ - { - "name": "greetingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Greeting", - "required": "true" - } - ], - "return": "Greeting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet greetingId: String = \"\" // Greeting ID\nlet body: Greeting = new Greeting(...) // The updated Greeting\n\n// Updates the Greeting with the given GreetingId\nPutGreetingRequest.putGreeting(greetingId: greetingId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGreetingRequest.putGreeting was successful\")\n dump(response)\n }\n}" - }, - "putgreetingsdefaults": { - "operationId": "putgreetingsdefaults", - "functionName": "putGreetingsDefaults", - "signature": "putGreetingsDefaults(body)", - "parameters": [ - { - "name": "body", - "type": "DefaultGreetingList", - "required": "true" - } - ], - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList\n\n// Update an Organization's DefaultGreetingList\nPutGreetingsDefaultsRequest.putGreetingsDefaults(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGreetingsDefaultsRequest.putGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "putgroupgreetingsdefaults": { - "operationId": "putgroupgreetingsdefaults", - "functionName": "putGroupGreetingsDefaults", - "signature": "putGroupGreetingsDefaults(groupId, body)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DefaultGreetingList", - "required": "true" - } - ], - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList\n\n// Updates the DefaultGreetingList of the specified Group\nPutGroupGreetingsDefaultsRequest.putGroupGreetingsDefaults(groupId: groupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGroupGreetingsDefaultsRequest.putGroupGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "putusergreetingsdefaults": { - "operationId": "putusergreetingsdefaults", - "functionName": "putUserGreetingsDefaults", - "signature": "putUserGreetingsDefaults(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DefaultGreetingList", - "required": "true" - } - ], - "return": "DefaultGreetingList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList\n\n// Updates the DefaultGreetingList of the specified User\nPutUserGreetingsDefaultsRequest.putUserGreetingsDefaults(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserGreetingsDefaultsRequest.putUserGreetingsDefaults was successful\")\n dump(response)\n }\n}" - }, - "deletegroup": { - "operationId": "deletegroup", - "functionName": "deleteGroup", - "signature": "deleteGroup(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\n\n// Delete group\nDeleteGroupRequest.deleteGroup(groupId: groupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteGroupRequest.deleteGroup was successful\")\n }\n}" - }, - "deletegroupmembers": { - "operationId": "deletegroupmembers", - "functionName": "deleteGroupMembers", - "signature": "deleteGroupMembers(groupId, ids)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "ids", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet ids: String = \"\" // Comma separated list of userIds to remove\n\n// Remove members\nDeleteGroupMembersRequest.deleteGroupMembers(groupId: groupId, ids: ids) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteGroupMembersRequest.deleteGroupMembers was successful\")\n dump(response)\n }\n}" - }, - "getfieldconfig": { - "operationId": "getfieldconfig", - "functionName": "getFieldconfig", - "signature": "getFieldconfig(type)", - "parameters": [ - { - "name": "type", - "type": "String", - "required": "true" - } - ], - "return": "FieldConfig", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet type: GetFieldconfigRequest.ModelType_getFieldconfig = GetFieldconfigRequest.ModelType_getFieldconfig.enummember // Field type\n\n// Fetch field config for an entity type\nGetFieldconfigRequest.getFieldconfig(type: type) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetFieldconfigRequest.getFieldconfig was successful\")\n dump(response)\n }\n}" - }, - "getgroup": { - "operationId": "getgroup", - "functionName": "getGroup", - "signature": "getGroup(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "return": "Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\n\n// Get group\nGetGroupRequest.getGroup(groupId: groupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupRequest.getGroup was successful\")\n dump(response)\n }\n}" - }, - "getgroupindividuals": { - "operationId": "getgroupindividuals", - "functionName": "getGroupIndividuals", - "signature": "getGroupIndividuals(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\n\n// Get all individuals associated with the group\nGetGroupIndividualsRequest.getGroupIndividuals(groupId: groupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupIndividualsRequest.getGroupIndividuals was successful\")\n dump(response)\n }\n}" - }, - "getgroupmembers": { - "operationId": "getgroupmembers", - "functionName": "getGroupMembers", - "signature": "getGroupMembers(groupId, pageSize, pageNumber, sortOrder, expand)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetGroupMembersRequest.SortOrder_getGroupMembers = GetGroupMembersRequest.SortOrder_getGroupMembers.enummember // Ascending or descending sort order\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get group members, includes individuals, owners, and dynamically included people\nGetGroupMembersRequest.getGroupMembers(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupMembersRequest.getGroupMembers was successful\")\n dump(response)\n }\n}" - }, - "getgroupprofile": { - "operationId": "getgroupprofile", - "functionName": "getGroupProfile", - "signature": "getGroupProfile(groupId, fields)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "fields", - "type": "String", - "required": "false" - } - ], - "return": "GroupProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // groupId\nlet fields: String = \"\" // 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\n\n// Get group profile\nGetGroupProfileRequest.getGroupProfile(groupId: groupId, fields: fields) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupProfileRequest.getGroupProfile was successful\")\n dump(response)\n }\n}" - }, - "getgroups": { - "operationId": "getgroups", - "functionName": "getGroups", - "signature": "getGroups(pageSize, pageNumber, _id, jabberId, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "jabberId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "GroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // id\nlet jabberId: [String] = [\"\"] // A list of jabberIds to fetch by bulk (cannot be used with the \\\"id\\\" parameter)\nlet sortOrder: GetGroupsRequest.SortOrder_getGroups = GetGroupsRequest.SortOrder_getGroups.enummember // Ascending or descending sort order\n\n// Get a group list\nGetGroupsRequest.getGroups(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupsRequest.getGroups was successful\")\n dump(response)\n }\n}" - }, - "getgroupssearch": { - "operationId": "getgroupssearch", - "functionName": "getGroupsSearch", - "signature": "getGroupsSearch(q64, expand)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "GroupsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // expand\n\n// Search groups using the q64 value returned from a previous search\nGetGroupsSearchRequest.getGroupsSearch(q64: q64, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetGroupsSearchRequest.getGroupsSearch was successful\")\n dump(response)\n }\n}" - }, - "getprofilesgroups": { - "operationId": "getprofilesgroups", - "functionName": "getProfilesGroups", - "signature": "getProfilesGroups(pageSize, pageNumber, _id, jabberId, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "jabberId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "GroupProfileEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // id\nlet jabberId: [String] = [\"\"] // A list of jabberIds to fetch by bulk (cannot be used with the \\\"id\\\" parameter)\nlet sortOrder: GetProfilesGroupsRequest.SortOrder_getProfilesGroups = GetProfilesGroupsRequest.SortOrder_getProfilesGroups.enummember // Ascending or descending sort order\n\n// Get group profile listing\nGetProfilesGroupsRequest.getProfilesGroups(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetProfilesGroupsRequest.getProfilesGroups was successful\")\n dump(response)\n }\n}" - }, - "postgroupmembers": { - "operationId": "postgroupmembers", - "functionName": "postGroupMembers", - "signature": "postGroupMembers(groupId, body)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "GroupMembersUpdate", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet body: GroupMembersUpdate = new GroupMembersUpdate(...) // Add members\n\n// Add members\nPostGroupMembersRequest.postGroupMembers(groupId: groupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGroupMembersRequest.postGroupMembers was successful\")\n dump(response)\n }\n}" - }, - "postgroups": { - "operationId": "postgroups", - "functionName": "postGroups", - "signature": "postGroups(body)", - "parameters": [ - { - "name": "body", - "type": "GroupCreate", - "required": "true" - } - ], - "return": "Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GroupCreate = new GroupCreate(...) // Group\n\n// Create a group\nPostGroupsRequest.postGroups(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGroupsRequest.postGroups was successful\")\n dump(response)\n }\n}" - }, - "postgroupssearch": { - "operationId": "postgroupssearch", - "functionName": "postGroupsSearch", - "signature": "postGroupsSearch(body)", - "parameters": [ - { - "name": "body", - "type": "GroupSearchRequest", - "required": "true" - } - ], - "return": "GroupsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GroupSearchRequest = new GroupSearchRequest(...) // Search request options\n\n// Search groups\nPostGroupsSearchRequest.postGroupsSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostGroupsSearchRequest.postGroupsSearch was successful\")\n dump(response)\n }\n}" - }, - "putgroup": { - "operationId": "putgroup", - "functionName": "putGroup", - "signature": "putGroup(groupId, body)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "GroupUpdate", - "required": "false" - } - ], - "return": "Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet body: GroupUpdate = new GroupUpdate(...) // Group\n\n// Update group\nPutGroupRequest.putGroup(groupId: groupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutGroupRequest.putGroup was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersadfs": { - "operationId": "deleteidentityprovidersadfs", - "functionName": "deleteIdentityprovidersAdfs", - "signature": "deleteIdentityprovidersAdfs()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete ADFS Identity Provider\nDeleteIdentityprovidersAdfsRequest.deleteIdentityprovidersAdfs() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersAdfsRequest.deleteIdentityprovidersAdfs was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityproviderscic": { - "operationId": "deleteidentityproviderscic", - "functionName": "deleteIdentityprovidersCic", - "signature": "deleteIdentityprovidersCic()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete Customer Interaction Center (CIC) Identity Provider\nDeleteIdentityprovidersCicRequest.deleteIdentityprovidersCic() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersCicRequest.deleteIdentityprovidersCic was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersgeneric": { - "operationId": "deleteidentityprovidersgeneric", - "functionName": "deleteIdentityprovidersGeneric", - "signature": "deleteIdentityprovidersGeneric()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete Generic SAML Identity Provider\nDeleteIdentityprovidersGenericRequest.deleteIdentityprovidersGeneric() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersGenericRequest.deleteIdentityprovidersGeneric was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersgsuite": { - "operationId": "deleteidentityprovidersgsuite", - "functionName": "deleteIdentityprovidersGsuite", - "signature": "deleteIdentityprovidersGsuite()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete G Suite Identity Provider\nDeleteIdentityprovidersGsuiteRequest.deleteIdentityprovidersGsuite() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersGsuiteRequest.deleteIdentityprovidersGsuite was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersidentitynow": { - "operationId": "deleteidentityprovidersidentitynow", - "functionName": "deleteIdentityprovidersIdentitynow", - "signature": "deleteIdentityprovidersIdentitynow()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete IdentityNow Provider\nDeleteIdentityprovidersIdentitynowRequest.deleteIdentityprovidersIdentitynow() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersIdentitynowRequest.deleteIdentityprovidersIdentitynow was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersokta": { - "operationId": "deleteidentityprovidersokta", - "functionName": "deleteIdentityprovidersOkta", - "signature": "deleteIdentityprovidersOkta()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete Okta Identity Provider\nDeleteIdentityprovidersOktaRequest.deleteIdentityprovidersOkta() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersOktaRequest.deleteIdentityprovidersOkta was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersonelogin": { - "operationId": "deleteidentityprovidersonelogin", - "functionName": "deleteIdentityprovidersOnelogin", - "signature": "deleteIdentityprovidersOnelogin()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete OneLogin Identity Provider\nDeleteIdentityprovidersOneloginRequest.deleteIdentityprovidersOnelogin() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersOneloginRequest.deleteIdentityprovidersOnelogin was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityprovidersping": { - "operationId": "deleteidentityprovidersping", - "functionName": "deleteIdentityprovidersPing", - "signature": "deleteIdentityprovidersPing()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete Ping Identity Provider\nDeleteIdentityprovidersPingRequest.deleteIdentityprovidersPing() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersPingRequest.deleteIdentityprovidersPing was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityproviderspurecloud": { - "operationId": "deleteidentityproviderspurecloud", - "functionName": "deleteIdentityprovidersPurecloud", - "signature": "deleteIdentityprovidersPurecloud()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete PureCloud Identity Provider\nDeleteIdentityprovidersPurecloudRequest.deleteIdentityprovidersPurecloud() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersPurecloudRequest.deleteIdentityprovidersPurecloud was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityproviderspureengage": { - "operationId": "deleteidentityproviderspureengage", - "functionName": "deleteIdentityprovidersPureengage", - "signature": "deleteIdentityprovidersPureengage()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete PureEngage Identity Provider\nDeleteIdentityprovidersPureengageRequest.deleteIdentityprovidersPureengage() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersPureengageRequest.deleteIdentityprovidersPureengage was successful\")\n dump(response)\n }\n}" - }, - "deleteidentityproviderssalesforce": { - "operationId": "deleteidentityproviderssalesforce", - "functionName": "deleteIdentityprovidersSalesforce", - "signature": "deleteIdentityprovidersSalesforce()", - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete Salesforce Identity Provider\nDeleteIdentityprovidersSalesforceRequest.deleteIdentityprovidersSalesforce() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIdentityprovidersSalesforceRequest.deleteIdentityprovidersSalesforce was successful\")\n dump(response)\n }\n}" - }, - "getidentityproviders": { - "operationId": "getidentityproviders", - "functionName": "getIdentityproviders", - "signature": "getIdentityproviders()", - "return": "OAuthProviderEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// The list of identity providers\nGetIdentityprovidersRequest.getIdentityproviders() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersRequest.getIdentityproviders was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersadfs": { - "operationId": "getidentityprovidersadfs", - "functionName": "getIdentityprovidersAdfs", - "signature": "getIdentityprovidersAdfs()", - "return": "ADFS", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get ADFS Identity Provider\nGetIdentityprovidersAdfsRequest.getIdentityprovidersAdfs() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersAdfsRequest.getIdentityprovidersAdfs was successful\")\n dump(response)\n }\n}" - }, - "getidentityproviderscic": { - "operationId": "getidentityproviderscic", - "functionName": "getIdentityprovidersCic", - "signature": "getIdentityprovidersCic()", - "return": "CustomerInteractionCenter", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Customer Interaction Center (CIC) Identity Provider\nGetIdentityprovidersCicRequest.getIdentityprovidersCic() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersCicRequest.getIdentityprovidersCic was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersgeneric": { - "operationId": "getidentityprovidersgeneric", - "functionName": "getIdentityprovidersGeneric", - "signature": "getIdentityprovidersGeneric()", - "return": "GenericSAML", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Generic SAML Identity Provider\nGetIdentityprovidersGenericRequest.getIdentityprovidersGeneric() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersGenericRequest.getIdentityprovidersGeneric was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersgsuite": { - "operationId": "getidentityprovidersgsuite", - "functionName": "getIdentityprovidersGsuite", - "signature": "getIdentityprovidersGsuite()", - "return": "GSuite", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get G Suite Identity Provider\nGetIdentityprovidersGsuiteRequest.getIdentityprovidersGsuite() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersGsuiteRequest.getIdentityprovidersGsuite was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersidentitynow": { - "operationId": "getidentityprovidersidentitynow", - "functionName": "getIdentityprovidersIdentitynow", - "signature": "getIdentityprovidersIdentitynow()", - "return": "IdentityNow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get IdentityNow Provider\nGetIdentityprovidersIdentitynowRequest.getIdentityprovidersIdentitynow() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersIdentitynowRequest.getIdentityprovidersIdentitynow was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersokta": { - "operationId": "getidentityprovidersokta", - "functionName": "getIdentityprovidersOkta", - "signature": "getIdentityprovidersOkta()", - "return": "Okta", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Okta Identity Provider\nGetIdentityprovidersOktaRequest.getIdentityprovidersOkta() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersOktaRequest.getIdentityprovidersOkta was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersonelogin": { - "operationId": "getidentityprovidersonelogin", - "functionName": "getIdentityprovidersOnelogin", - "signature": "getIdentityprovidersOnelogin()", - "return": "OneLogin", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get OneLogin Identity Provider\nGetIdentityprovidersOneloginRequest.getIdentityprovidersOnelogin() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersOneloginRequest.getIdentityprovidersOnelogin was successful\")\n dump(response)\n }\n}" - }, - "getidentityprovidersping": { - "operationId": "getidentityprovidersping", - "functionName": "getIdentityprovidersPing", - "signature": "getIdentityprovidersPing()", - "return": "PingIdentity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Ping Identity Provider\nGetIdentityprovidersPingRequest.getIdentityprovidersPing() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersPingRequest.getIdentityprovidersPing was successful\")\n dump(response)\n }\n}" - }, - "getidentityproviderspurecloud": { - "operationId": "getidentityproviderspurecloud", - "functionName": "getIdentityprovidersPurecloud", - "signature": "getIdentityprovidersPurecloud()", - "return": "PureCloud", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get PureCloud Identity Provider\nGetIdentityprovidersPurecloudRequest.getIdentityprovidersPurecloud() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersPurecloudRequest.getIdentityprovidersPurecloud was successful\")\n dump(response)\n }\n}" - }, - "getidentityproviderspureengage": { - "operationId": "getidentityproviderspureengage", - "functionName": "getIdentityprovidersPureengage", - "signature": "getIdentityprovidersPureengage()", - "return": "PureEngage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get PureEngage Identity Provider\nGetIdentityprovidersPureengageRequest.getIdentityprovidersPureengage() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersPureengageRequest.getIdentityprovidersPureengage was successful\")\n dump(response)\n }\n}" - }, - "getidentityproviderssalesforce": { - "operationId": "getidentityproviderssalesforce", - "functionName": "getIdentityprovidersSalesforce", - "signature": "getIdentityprovidersSalesforce()", - "return": "Salesforce", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Salesforce Identity Provider\nGetIdentityprovidersSalesforceRequest.getIdentityprovidersSalesforce() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIdentityprovidersSalesforceRequest.getIdentityprovidersSalesforce was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersadfs": { - "operationId": "putidentityprovidersadfs", - "functionName": "putIdentityprovidersAdfs", - "signature": "putIdentityprovidersAdfs(body)", - "parameters": [ - { - "name": "body", - "type": "ADFS", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ADFS = new ADFS(...) // Provider\n\n// Update/Create ADFS Identity Provider\nPutIdentityprovidersAdfsRequest.putIdentityprovidersAdfs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersAdfsRequest.putIdentityprovidersAdfs was successful\")\n dump(response)\n }\n}" - }, - "putidentityproviderscic": { - "operationId": "putidentityproviderscic", - "functionName": "putIdentityprovidersCic", - "signature": "putIdentityprovidersCic(body)", - "parameters": [ - { - "name": "body", - "type": "CustomerInteractionCenter", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CustomerInteractionCenter = new CustomerInteractionCenter(...) // Provider\n\n// Update/Create Customer Interaction Center (CIC) Identity Provider\nPutIdentityprovidersCicRequest.putIdentityprovidersCic(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersCicRequest.putIdentityprovidersCic was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersgeneric": { - "operationId": "putidentityprovidersgeneric", - "functionName": "putIdentityprovidersGeneric", - "signature": "putIdentityprovidersGeneric(body)", - "parameters": [ - { - "name": "body", - "type": "GenericSAML", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GenericSAML = new GenericSAML(...) // Provider\n\n// Update/Create Generic SAML Identity Provider\nPutIdentityprovidersGenericRequest.putIdentityprovidersGeneric(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersGenericRequest.putIdentityprovidersGeneric was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersgsuite": { - "operationId": "putidentityprovidersgsuite", - "functionName": "putIdentityprovidersGsuite", - "signature": "putIdentityprovidersGsuite(body)", - "parameters": [ - { - "name": "body", - "type": "GSuite", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GSuite = new GSuite(...) // Provider\n\n// Update/Create G Suite Identity Provider\nPutIdentityprovidersGsuiteRequest.putIdentityprovidersGsuite(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersGsuiteRequest.putIdentityprovidersGsuite was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersidentitynow": { - "operationId": "putidentityprovidersidentitynow", - "functionName": "putIdentityprovidersIdentitynow", - "signature": "putIdentityprovidersIdentitynow(body)", - "parameters": [ - { - "name": "body", - "type": "IdentityNow", - "required": "true" - } - ], - "return": "IdentityNow", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: IdentityNow = new IdentityNow(...) // Provider\n\n// Update/Create IdentityNow Provider\nPutIdentityprovidersIdentitynowRequest.putIdentityprovidersIdentitynow(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersIdentitynowRequest.putIdentityprovidersIdentitynow was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersokta": { - "operationId": "putidentityprovidersokta", - "functionName": "putIdentityprovidersOkta", - "signature": "putIdentityprovidersOkta(body)", - "parameters": [ - { - "name": "body", - "type": "Okta", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Okta = new Okta(...) // Provider\n\n// Update/Create Okta Identity Provider\nPutIdentityprovidersOktaRequest.putIdentityprovidersOkta(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersOktaRequest.putIdentityprovidersOkta was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersonelogin": { - "operationId": "putidentityprovidersonelogin", - "functionName": "putIdentityprovidersOnelogin", - "signature": "putIdentityprovidersOnelogin(body)", - "parameters": [ - { - "name": "body", - "type": "OneLogin", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OneLogin = new OneLogin(...) // Provider\n\n// Update/Create OneLogin Identity Provider\nPutIdentityprovidersOneloginRequest.putIdentityprovidersOnelogin(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersOneloginRequest.putIdentityprovidersOnelogin was successful\")\n dump(response)\n }\n}" - }, - "putidentityprovidersping": { - "operationId": "putidentityprovidersping", - "functionName": "putIdentityprovidersPing", - "signature": "putIdentityprovidersPing(body)", - "parameters": [ - { - "name": "body", - "type": "PingIdentity", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PingIdentity = new PingIdentity(...) // Provider\n\n// Update/Create Ping Identity Provider\nPutIdentityprovidersPingRequest.putIdentityprovidersPing(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersPingRequest.putIdentityprovidersPing was successful\")\n dump(response)\n }\n}" - }, - "putidentityproviderspurecloud": { - "operationId": "putidentityproviderspurecloud", - "functionName": "putIdentityprovidersPurecloud", - "signature": "putIdentityprovidersPurecloud(body)", - "parameters": [ - { - "name": "body", - "type": "PureCloud", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PureCloud = new PureCloud(...) // Provider\n\n// Update/Create PureCloud Identity Provider\nPutIdentityprovidersPurecloudRequest.putIdentityprovidersPurecloud(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersPurecloudRequest.putIdentityprovidersPurecloud was successful\")\n dump(response)\n }\n}" - }, - "putidentityproviderspureengage": { - "operationId": "putidentityproviderspureengage", - "functionName": "putIdentityprovidersPureengage", - "signature": "putIdentityprovidersPureengage(body)", - "parameters": [ - { - "name": "body", - "type": "PureEngage", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PureEngage = new PureEngage(...) // Provider\n\n// Update/Create PureEngage Identity Provider\nPutIdentityprovidersPureengageRequest.putIdentityprovidersPureengage(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersPureengageRequest.putIdentityprovidersPureengage was successful\")\n dump(response)\n }\n}" - }, - "putidentityproviderssalesforce": { - "operationId": "putidentityproviderssalesforce", - "functionName": "putIdentityprovidersSalesforce", - "signature": "putIdentityprovidersSalesforce(body)", - "parameters": [ - { - "name": "body", - "type": "Salesforce", - "required": "true" - } - ], - "return": "OAuthProvider", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Salesforce = new Salesforce(...) // Provider\n\n// Update/Create Salesforce Identity Provider\nPutIdentityprovidersSalesforceRequest.putIdentityprovidersSalesforce(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIdentityprovidersSalesforceRequest.putIdentityprovidersSalesforce was successful\")\n dump(response)\n }\n}" - }, - "getinfrastructureascodeaccelerator": { - "operationId": "getinfrastructureascodeaccelerator", - "functionName": "getInfrastructureascodeAccelerator", - "signature": "getInfrastructureascodeAccelerator(acceleratorId, preferredLanguage)", - "parameters": [ - { - "name": "acceleratorId", - "type": "String", - "required": "true" - }, - { - "name": "preferredLanguage", - "type": "String", - "required": "false" - } - ], - "return": "AcceleratorSpecification", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet acceleratorId: String = \"\" // Accelerator ID\nlet preferredLanguage: GetInfrastructureascodeAcceleratorRequest.PreferredLanguage_getInfrastructureascodeAccelerator = GetInfrastructureascodeAcceleratorRequest.PreferredLanguage_getInfrastructureascodeAccelerator.enummember // Preferred Language\n\n// Get information about an accelerator\nGetInfrastructureascodeAcceleratorRequest.getInfrastructureascodeAccelerator(acceleratorId: acceleratorId, preferredLanguage: preferredLanguage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetInfrastructureascodeAcceleratorRequest.getInfrastructureascodeAccelerator was successful\")\n dump(response)\n }\n}" - }, - "getinfrastructureascodeaccelerators": { - "operationId": "getinfrastructureascodeaccelerators", - "functionName": "getInfrastructureascodeAccelerators", - "signature": "getInfrastructureascodeAccelerators(pageSize, pageNumber, sortBy, sortOrder, name, _description, origin, type, classification, tags)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_description", - "type": "String", - "required": "false" - }, - { - "name": "origin", - "type": "String", - "required": "false" - }, - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "classification", - "type": "String", - "required": "false" - }, - { - "name": "tags", - "type": "String", - "required": "false" - } - ], - "return": "AcceleratorList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet sortOrder: GetInfrastructureascodeAcceleratorsRequest.SortOrder_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.SortOrder_getInfrastructureascodeAccelerators.enummember // Sort order\nlet name: String = \"\" // Filter by name\nlet _description: String = \"\" // Filter by description\nlet origin: GetInfrastructureascodeAcceleratorsRequest.Origin_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.Origin_getInfrastructureascodeAccelerators.enummember // Filter by origin\nlet type: GetInfrastructureascodeAcceleratorsRequest.ModelType_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.ModelType_getInfrastructureascodeAccelerators.enummember // Filter by type\nlet classification: String = \"\" // Filter by classification\nlet tags: String = \"\" // Filter by tags\n\n// Get a list of available accelerators\nGetInfrastructureascodeAcceleratorsRequest.getInfrastructureascodeAccelerators(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _description: _description, origin: origin, type: type, classification: classification, tags: tags) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetInfrastructureascodeAcceleratorsRequest.getInfrastructureascodeAccelerators was successful\")\n dump(response)\n }\n}" - }, - "getinfrastructureascodejob": { - "operationId": "getinfrastructureascodejob", - "functionName": "getInfrastructureascodeJob", - "signature": "getInfrastructureascodeJob(jobId, details)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "details", - "type": "Bool", - "required": "false" - } - ], - "return": "InfrastructureascodeJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // Job ID\nlet details: Bool = true // Include details of execution, including job results or error information\n\n// Get job status and results\nGetInfrastructureascodeJobRequest.getInfrastructureascodeJob(jobId: jobId, details: details) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetInfrastructureascodeJobRequest.getInfrastructureascodeJob was successful\")\n dump(response)\n }\n}" - }, - "getinfrastructureascodejobs": { - "operationId": "getinfrastructureascodejobs", - "functionName": "getInfrastructureascodeJobs", - "signature": "getInfrastructureascodeJobs(maxResults, includeErrors, sortBy, sortOrder, acceleratorId, submittedBy, status)", - "parameters": [ - { - "name": "maxResults", - "type": "Int", - "required": "false" - }, - { - "name": "includeErrors", - "type": "Bool", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "acceleratorId", - "type": "String", - "required": "false" - }, - { - "name": "submittedBy", - "type": "String", - "required": "false" - }, - { - "name": "status", - "type": "String", - "required": "false" - } - ], - "return": "InfrastructureascodeJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet maxResults: Int = 0 // Number of jobs to show\nlet includeErrors: Bool = true // Include error messages\nlet sortBy: GetInfrastructureascodeJobsRequest.SortBy_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.SortBy_getInfrastructureascodeJobs.enummember // Sort by\nlet sortOrder: GetInfrastructureascodeJobsRequest.SortOrder_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.SortOrder_getInfrastructureascodeJobs.enummember // Sort order\nlet acceleratorId: String = \"\" // Find only jobs associated with this accelerator\nlet submittedBy: String = \"\" // Find only jobs submitted by this user\nlet status: GetInfrastructureascodeJobsRequest.Status_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.Status_getInfrastructureascodeJobs.enummember // Find only jobs in this state\n\n// Get job history\nGetInfrastructureascodeJobsRequest.getInfrastructureascodeJobs(maxResults: maxResults, includeErrors: includeErrors, sortBy: sortBy, sortOrder: sortOrder, acceleratorId: acceleratorId, submittedBy: submittedBy, status: status) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetInfrastructureascodeJobsRequest.getInfrastructureascodeJobs was successful\")\n dump(response)\n }\n}" - }, - "postinfrastructureascodejobs": { - "operationId": "postinfrastructureascodejobs", - "functionName": "postInfrastructureascodeJobs", - "signature": "postInfrastructureascodeJobs(body)", - "parameters": [ - { - "name": "body", - "type": "AcceleratorInput", - "required": "true" - } - ], - "return": "InfrastructureascodeJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AcceleratorInput = new AcceleratorInput(...) // \n\n// Create a Job\nPostInfrastructureascodeJobsRequest.postInfrastructureascodeJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostInfrastructureascodeJobsRequest.postInfrastructureascodeJobs was successful\")\n dump(response)\n }\n}" - }, - "deleteintegration": { - "operationId": "deleteintegration", - "functionName": "deleteIntegration", - "signature": "deleteIntegration(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "return": "Integration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration Id\n\n// Delete integration.\nDeleteIntegrationRequest.deleteIntegration(integrationId: integrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteIntegrationRequest.deleteIntegration was successful\")\n dump(response)\n }\n}" - }, - "deleteintegrationsaction": { - "operationId": "deleteintegrationsaction", - "functionName": "deleteIntegrationsAction", - "signature": "deleteIntegrationsAction(actionId)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\n\n// Delete an Action\nDeleteIntegrationsActionRequest.deleteIntegrationsAction(actionId: actionId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteIntegrationsActionRequest.deleteIntegrationsAction was successful\")\n }\n}" - }, - "deleteintegrationsactiondraft": { - "operationId": "deleteintegrationsactiondraft", - "functionName": "deleteIntegrationsActionDraft", - "signature": "deleteIntegrationsActionDraft(actionId)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\n\n// Delete a Draft\nDeleteIntegrationsActionDraftRequest.deleteIntegrationsActionDraft(actionId: actionId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteIntegrationsActionDraftRequest.deleteIntegrationsActionDraft was successful\")\n }\n}" - }, - "deleteintegrationscredential": { - "operationId": "deleteintegrationscredential", - "functionName": "deleteIntegrationsCredential", - "signature": "deleteIntegrationsCredential(credentialId)", - "parameters": [ - { - "name": "credentialId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet credentialId: String = \"\" // Credential ID\n\n// Delete a set of credentials\nDeleteIntegrationsCredentialRequest.deleteIntegrationsCredential(credentialId: credentialId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteIntegrationsCredentialRequest.deleteIntegrationsCredential was successful\")\n }\n}" - }, - "getintegration": { - "operationId": "getintegration", - "functionName": "getIntegration", - "signature": "getIntegration(integrationId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "Integration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration Id\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// Get integration.\nGetIntegrationRequest.getIntegration(integrationId: integrationId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationRequest.getIntegration was successful\")\n dump(response)\n }\n}" - }, - "getintegrationconfigcurrent": { - "operationId": "getintegrationconfigcurrent", - "functionName": "getIntegrationConfigCurrent", - "signature": "getIntegrationConfigCurrent(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "return": "IntegrationConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration Id\n\n// Get integration configuration.\nGetIntegrationConfigCurrentRequest.getIntegrationConfigCurrent(integrationId: integrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationConfigCurrentRequest.getIntegrationConfigCurrent was successful\")\n dump(response)\n }\n}" - }, - "getintegrations": { - "operationId": "getintegrations", - "functionName": "getIntegrations", - "signature": "getIntegrations(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "IntegrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// List integrations\nGetIntegrationsRequest.getIntegrations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsRequest.getIntegrations was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsaction": { - "operationId": "getintegrationsaction", - "functionName": "getIntegrationsAction", - "signature": "getIntegrationsAction(actionId, expand, includeConfig)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "includeConfig", - "type": "Bool", - "required": "false" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet expand: GetIntegrationsActionRequest.Expand_getIntegrationsAction = GetIntegrationsActionRequest.Expand_getIntegrationsAction.enummember // Indicates a field in the response which should be expanded.\nlet includeConfig: Bool = true // Return config in response.\n\n// Retrieves a single Action matching id.\nGetIntegrationsActionRequest.getIntegrationsAction(actionId: actionId, expand: expand, includeConfig: includeConfig) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionRequest.getIntegrationsAction was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactiondraft": { - "operationId": "getintegrationsactiondraft", - "functionName": "getIntegrationsActionDraft", - "signature": "getIntegrationsActionDraft(actionId, expand, includeConfig)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "includeConfig", - "type": "Bool", - "required": "false" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet expand: GetIntegrationsActionDraftRequest.Expand_getIntegrationsActionDraft = GetIntegrationsActionDraftRequest.Expand_getIntegrationsActionDraft.enummember // Indicates a field in the response which should be expanded.\nlet includeConfig: Bool = true // Return config in response.\n\n// Retrieve a Draft\nGetIntegrationsActionDraftRequest.getIntegrationsActionDraft(actionId: actionId, expand: expand, includeConfig: includeConfig) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionDraftRequest.getIntegrationsActionDraft was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactiondraftschema": { - "operationId": "getintegrationsactiondraftschema", - "functionName": "getIntegrationsActionDraftSchema", - "signature": "getIntegrationsActionDraftSchema(actionId, fileName)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "fileName", - "type": "String", - "required": "true" - } - ], - "return": "JsonSchemaDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet fileName: String = \"\" // Name of schema file to be retrieved for this draft.\n\n// Retrieve schema for a Draft based on filename.\nGetIntegrationsActionDraftSchemaRequest.getIntegrationsActionDraftSchema(actionId: actionId, fileName: fileName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionDraftSchemaRequest.getIntegrationsActionDraftSchema was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactiondrafttemplate": { - "operationId": "getintegrationsactiondrafttemplate", - "functionName": "getIntegrationsActionDraftTemplate", - "signature": "getIntegrationsActionDraftTemplate(actionId, fileName)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "fileName", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet fileName: String = \"\" // Name of template file to be retrieved for this action draft.\n\n// Retrieve templates for a Draft based on filename.\nGetIntegrationsActionDraftTemplateRequest.getIntegrationsActionDraftTemplate(actionId: actionId, fileName: fileName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionDraftTemplateRequest.getIntegrationsActionDraftTemplate was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactiondraftvalidation": { - "operationId": "getintegrationsactiondraftvalidation", - "functionName": "getIntegrationsActionDraftValidation", - "signature": "getIntegrationsActionDraftValidation(actionId)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - } - ], - "return": "DraftValidationResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\n\n// Validate current Draft configuration.\nGetIntegrationsActionDraftValidationRequest.getIntegrationsActionDraftValidation(actionId: actionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionDraftValidationRequest.getIntegrationsActionDraftValidation was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactionschema": { - "operationId": "getintegrationsactionschema", - "functionName": "getIntegrationsActionSchema", - "signature": "getIntegrationsActionSchema(actionId, fileName)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "fileName", - "type": "String", - "required": "true" - } - ], - "return": "JsonSchemaDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet fileName: String = \"\" // Name of schema file to be retrieved for this action.\n\n// Retrieve schema for an action based on filename.\nGetIntegrationsActionSchemaRequest.getIntegrationsActionSchema(actionId: actionId, fileName: fileName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionSchemaRequest.getIntegrationsActionSchema was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactiontemplate": { - "operationId": "getintegrationsactiontemplate", - "functionName": "getIntegrationsActionTemplate", - "signature": "getIntegrationsActionTemplate(actionId, fileName)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "fileName", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet fileName: String = \"\" // Name of template file to be retrieved for this action.\n\n// Retrieve text of templates for an action based on filename.\nGetIntegrationsActionTemplateRequest.getIntegrationsActionTemplate(actionId: actionId, fileName: fileName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionTemplateRequest.getIntegrationsActionTemplate was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactions": { - "operationId": "getintegrationsactions", - "functionName": "getIntegrationsActions", - "signature": "getIntegrationsActions(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, category, name, ids, secure, includeAuthActions)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "category", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "ids", - "type": "String", - "required": "false" - }, - { - "name": "secure", - "type": "String", - "required": "false" - }, - { - "name": "includeAuthActions", - "type": "String", - "required": "false" - } - ], - "return": "ActionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet sortBy: String = \"\" // Root level field name to sort on.\nlet sortOrder: GetIntegrationsActionsRequest.SortOrder_getIntegrationsActions = GetIntegrationsActionsRequest.SortOrder_getIntegrationsActions.enummember // Direction to sort 'sortBy' field.\nlet category: String = \"\" // Filter by category name.\nlet name: String = \"\" // Filter by partial or complete action name.\nlet ids: String = \"\" // Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.\nlet secure: GetIntegrationsActionsRequest.Secure_getIntegrationsActions = GetIntegrationsActionsRequest.Secure_getIntegrationsActions.enummember // Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.\nlet includeAuthActions: GetIntegrationsActionsRequest.IncludeAuthActions_getIntegrationsActions = GetIntegrationsActionsRequest.IncludeAuthActions_getIntegrationsActions.enummember // 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.\n\n// Retrieves all actions associated with filters passed in via query param.\nGetIntegrationsActionsRequest.getIntegrationsActions(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, category: category, name: name, ids: ids, secure: secure, includeAuthActions: includeAuthActions) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionsRequest.getIntegrationsActions was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactionscategories": { - "operationId": "getintegrationsactionscategories", - "functionName": "getIntegrationsActionsCategories", - "signature": "getIntegrationsActionsCategories(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, secure)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "secure", - "type": "String", - "required": "false" - } - ], - "return": "CategoryEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet sortBy: String = \"\" // Root level field name to sort on. Only 'name' is supported on this endpoint.\nlet sortOrder: GetIntegrationsActionsCategoriesRequest.SortOrder_getIntegrationsActionsCategories = GetIntegrationsActionsCategoriesRequest.SortOrder_getIntegrationsActionsCategories.enummember // Direction to sort 'sortBy' field.\nlet secure: GetIntegrationsActionsCategoriesRequest.Secure_getIntegrationsActionsCategories = GetIntegrationsActionsCategoriesRequest.Secure_getIntegrationsActionsCategories.enummember // 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.\n\n// Retrieves all categories of available Actions\nGetIntegrationsActionsCategoriesRequest.getIntegrationsActionsCategories(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, secure: secure) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionsCategoriesRequest.getIntegrationsActionsCategories was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsactionsdrafts": { - "operationId": "getintegrationsactionsdrafts", - "functionName": "getIntegrationsActionsDrafts", - "signature": "getIntegrationsActionsDrafts(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, category, name, ids, secure, includeAuthActions)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "category", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "ids", - "type": "String", - "required": "false" - }, - { - "name": "secure", - "type": "String", - "required": "false" - }, - { - "name": "includeAuthActions", - "type": "String", - "required": "false" - } - ], - "return": "ActionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet sortBy: String = \"\" // Root level field name to sort on.\nlet sortOrder: GetIntegrationsActionsDraftsRequest.SortOrder_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.SortOrder_getIntegrationsActionsDrafts.enummember // Direction to sort 'sortBy' field.\nlet category: String = \"\" // Filter by category name.\nlet name: String = \"\" // Filter by partial or complete action name.\nlet ids: String = \"\" // Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.\nlet secure: GetIntegrationsActionsDraftsRequest.Secure_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.Secure_getIntegrationsActionsDrafts.enummember // Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.\nlet includeAuthActions: GetIntegrationsActionsDraftsRequest.IncludeAuthActions_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.IncludeAuthActions_getIntegrationsActionsDrafts.enummember // 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.\n\n// Retrieves all action drafts associated with the filters passed in via query param.\nGetIntegrationsActionsDraftsRequest.getIntegrationsActionsDrafts(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, category: category, name: name, ids: ids, secure: secure, includeAuthActions: includeAuthActions) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsActionsDraftsRequest.getIntegrationsActionsDrafts was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsbotconnectorintegrationidbot": { - "operationId": "getintegrationsbotconnectorintegrationidbot", - "functionName": "getIntegrationsBotconnectorIntegrationIdBot", - "signature": "getIntegrationsBotconnectorIntegrationIdBot(integrationId, botId, version)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "botId", - "type": "String", - "required": "true" - }, - { - "name": "version", - "type": "String", - "required": "false" - } - ], - "return": "BotConnectorBot", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // The integration ID for this group of bots\nlet botId: String = \"\" // The botID for this bot\nlet version: String = \"\" // Specific Version\n\n// Get a specific botConnector bot, plus versions, for this integration\nGetIntegrationsBotconnectorIntegrationIdBotRequest.getIntegrationsBotconnectorIntegrationIdBot(integrationId: integrationId, botId: botId, version: version) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsBotconnectorIntegrationIdBotRequest.getIntegrationsBotconnectorIntegrationIdBot was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsbotconnectorintegrationidbotversions": { - "operationId": "getintegrationsbotconnectorintegrationidbotversions", - "functionName": "getIntegrationsBotconnectorIntegrationIdBotVersions", - "signature": "getIntegrationsBotconnectorIntegrationIdBotVersions(integrationId, botId, pageNumber, pageSize)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "botId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "BotConnectorBotVersionSummaryEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // The integration ID for this bot group\nlet botId: String = \"\" // The botID for this bot\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a list of bot versions for a bot\nGetIntegrationsBotconnectorIntegrationIdBotVersionsRequest.getIntegrationsBotconnectorIntegrationIdBotVersions(integrationId: integrationId, botId: botId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsBotconnectorIntegrationIdBotVersionsRequest.getIntegrationsBotconnectorIntegrationIdBotVersions was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsbotconnectorintegrationidbots": { - "operationId": "getintegrationsbotconnectorintegrationidbots", - "functionName": "getIntegrationsBotconnectorIntegrationIdBots", - "signature": "getIntegrationsBotconnectorIntegrationIdBots(integrationId)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - } - ], - "return": "BotList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // The integration ID for this group of bots\n\n// Get a list of botConnector bots for this integration\nGetIntegrationsBotconnectorIntegrationIdBotsRequest.getIntegrationsBotconnectorIntegrationIdBots(integrationId: integrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsBotconnectorIntegrationIdBotsRequest.getIntegrationsBotconnectorIntegrationIdBots was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsbotconnectorintegrationidbotssummaries": { - "operationId": "getintegrationsbotconnectorintegrationidbotssummaries", - "functionName": "getIntegrationsBotconnectorIntegrationIdBotsSummaries", - "signature": "getIntegrationsBotconnectorIntegrationIdBotsSummaries(integrationId, pageNumber, pageSize)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "BotConnectorBotSummaryEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // The integration ID for this group of bots\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a summary list of botConnector bots for this integration\nGetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest.getIntegrationsBotconnectorIntegrationIdBotsSummaries(integrationId: integrationId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest.getIntegrationsBotconnectorIntegrationIdBotsSummaries was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsclientapps": { - "operationId": "getintegrationsclientapps", - "functionName": "getIntegrationsClientapps", - "signature": "getIntegrationsClientapps(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "ClientAppEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// List permitted client app integrations for the logged in user\nGetIntegrationsClientappsRequest.getIntegrationsClientapps(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsClientappsRequest.getIntegrationsClientapps was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsclientappsunifiedcommunications": { - "operationId": "getintegrationsclientappsunifiedcommunications", - "functionName": "getIntegrationsClientappsUnifiedcommunications", - "signature": "getIntegrationsClientappsUnifiedcommunications(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "UCIntegrationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// UC integration client application configuration.\nGetIntegrationsClientappsUnifiedcommunicationsRequest.getIntegrationsClientappsUnifiedcommunications(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsClientappsUnifiedcommunicationsRequest.getIntegrationsClientappsUnifiedcommunications was successful\")\n dump(response)\n }\n}" - }, - "getintegrationscredential": { - "operationId": "getintegrationscredential", - "functionName": "getIntegrationsCredential", - "signature": "getIntegrationsCredential(credentialId)", - "parameters": [ - { - "name": "credentialId", - "type": "String", - "required": "true" - } - ], - "return": "Credential", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet credentialId: String = \"\" // Credential ID\n\n// Get a single credential with sensitive fields redacted\nGetIntegrationsCredentialRequest.getIntegrationsCredential(credentialId: credentialId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsCredentialRequest.getIntegrationsCredential was successful\")\n dump(response)\n }\n}" - }, - "getintegrationscredentials": { - "operationId": "getintegrationscredentials", - "functionName": "getIntegrationsCredentials", - "signature": "getIntegrationsCredentials(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "CredentialInfoListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// List multiple sets of credentials\nGetIntegrationsCredentialsRequest.getIntegrationsCredentials(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsCredentialsRequest.getIntegrationsCredentials was successful\")\n dump(response)\n }\n}" - }, - "getintegrationscredentialstypes": { - "operationId": "getintegrationscredentialstypes", - "functionName": "getIntegrationsCredentialsTypes", - "signature": "getIntegrationsCredentialsTypes()", - "return": "CredentialTypeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// List all credential types\nGetIntegrationsCredentialsTypesRequest.getIntegrationsCredentialsTypes() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsCredentialsTypesRequest.getIntegrationsCredentialsTypes was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechdialogflowagent": { - "operationId": "getintegrationsspeechdialogflowagent", - "functionName": "getIntegrationsSpeechDialogflowAgent", - "signature": "getIntegrationsSpeechDialogflowAgent(agentId)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - } - ], - "return": "DialogflowAgent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The agent ID\n\n// Get details about a Dialogflow agent\nGetIntegrationsSpeechDialogflowAgentRequest.getIntegrationsSpeechDialogflowAgent(agentId: agentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechDialogflowAgentRequest.getIntegrationsSpeechDialogflowAgent was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechdialogflowagents": { - "operationId": "getintegrationsspeechdialogflowagents", - "functionName": "getIntegrationsSpeechDialogflowAgents", - "signature": "getIntegrationsSpeechDialogflowAgents(pageNumber, pageSize, name)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "DialogflowAgentSummaryEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet name: String = \"\" // Filter on agent name\n\n// Get a list of Dialogflow agents in the customers' Google accounts\nGetIntegrationsSpeechDialogflowAgentsRequest.getIntegrationsSpeechDialogflowAgents(pageNumber: pageNumber, pageSize: pageSize, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechDialogflowAgentsRequest.getIntegrationsSpeechDialogflowAgents was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechlexbotalias": { - "operationId": "getintegrationsspeechlexbotalias", - "functionName": "getIntegrationsSpeechLexBotAlias", - "signature": "getIntegrationsSpeechLexBotAlias(aliasId)", - "parameters": [ - { - "name": "aliasId", - "type": "String", - "required": "true" - } - ], - "return": "LexBotAlias", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet aliasId: String = \"\" // The alias ID\n\n// Get details about a Lex bot alias\nGetIntegrationsSpeechLexBotAliasRequest.getIntegrationsSpeechLexBotAlias(aliasId: aliasId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechLexBotAliasRequest.getIntegrationsSpeechLexBotAlias was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechlexbotbotidaliases": { - "operationId": "getintegrationsspeechlexbotbotidaliases", - "functionName": "getIntegrationsSpeechLexBotBotIdAliases", - "signature": "getIntegrationsSpeechLexBotBotIdAliases(botId, pageNumber, pageSize, status, name)", - "parameters": [ - { - "name": "botId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "status", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "LexBotAliasEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet botId: String = \"\" // The bot ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet status: GetIntegrationsSpeechLexBotBotIdAliasesRequest.Status_getIntegrationsSpeechLexBotBotIdAliases = GetIntegrationsSpeechLexBotBotIdAliasesRequest.Status_getIntegrationsSpeechLexBotBotIdAliases.enummember // Filter on alias status\nlet name: String = \"\" // Filter on alias name\n\n// Get a list of aliases for a bot in the customer's AWS accounts\nGetIntegrationsSpeechLexBotBotIdAliasesRequest.getIntegrationsSpeechLexBotBotIdAliases(botId: botId, pageNumber: pageNumber, pageSize: pageSize, status: status, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechLexBotBotIdAliasesRequest.getIntegrationsSpeechLexBotBotIdAliases was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechlexbots": { - "operationId": "getintegrationsspeechlexbots", - "functionName": "getIntegrationsSpeechLexBots", - "signature": "getIntegrationsSpeechLexBots(pageNumber, pageSize, name)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "LexBotEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet name: String = \"\" // Filter on bot name\n\n// Get a list of Lex bots in the customers' AWS accounts\nGetIntegrationsSpeechLexBotsRequest.getIntegrationsSpeechLexBots(pageNumber: pageNumber, pageSize: pageSize, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechLexBotsRequest.getIntegrationsSpeechLexBots was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechttsengine": { - "operationId": "getintegrationsspeechttsengine", - "functionName": "getIntegrationsSpeechTtsEngine", - "signature": "getIntegrationsSpeechTtsEngine(engineId, includeVoices)", - "parameters": [ - { - "name": "engineId", - "type": "String", - "required": "true" - }, - { - "name": "includeVoices", - "type": "Bool", - "required": "false" - } - ], - "return": "TtsEngineEntity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet engineId: String = \"\" // The engine ID\nlet includeVoices: Bool = true // Include voices for the engine\n\n// Get details about a TTS engine\nGetIntegrationsSpeechTtsEngineRequest.getIntegrationsSpeechTtsEngine(engineId: engineId, includeVoices: includeVoices) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechTtsEngineRequest.getIntegrationsSpeechTtsEngine was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechttsenginevoice": { - "operationId": "getintegrationsspeechttsenginevoice", - "functionName": "getIntegrationsSpeechTtsEngineVoice", - "signature": "getIntegrationsSpeechTtsEngineVoice(engineId, voiceId)", - "parameters": [ - { - "name": "engineId", - "type": "String", - "required": "true" - }, - { - "name": "voiceId", - "type": "String", - "required": "true" - } - ], - "return": "TtsVoiceEntity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet engineId: String = \"\" // The engine ID\nlet voiceId: String = \"\" // The voice ID\n\n// Get details about a specific voice for a TTS engine\nGetIntegrationsSpeechTtsEngineVoiceRequest.getIntegrationsSpeechTtsEngineVoice(engineId: engineId, voiceId: voiceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechTtsEngineVoiceRequest.getIntegrationsSpeechTtsEngineVoice was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechttsenginevoices": { - "operationId": "getintegrationsspeechttsenginevoices", - "functionName": "getIntegrationsSpeechTtsEngineVoices", - "signature": "getIntegrationsSpeechTtsEngineVoices(engineId, pageNumber, pageSize)", - "parameters": [ - { - "name": "engineId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "TtsVoiceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet engineId: String = \"\" // The engine ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get a list of voices for a TTS engine\nGetIntegrationsSpeechTtsEngineVoicesRequest.getIntegrationsSpeechTtsEngineVoices(engineId: engineId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechTtsEngineVoicesRequest.getIntegrationsSpeechTtsEngineVoices was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechttsengines": { - "operationId": "getintegrationsspeechttsengines", - "functionName": "getIntegrationsSpeechTtsEngines", - "signature": "getIntegrationsSpeechTtsEngines(pageNumber, pageSize, includeVoices, name, language)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "includeVoices", - "type": "Bool", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "language", - "type": "String", - "required": "false" - } - ], - "return": "TtsEngineEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet includeVoices: Bool = true // Include voices for the engine\nlet name: String = \"\" // Filter on engine name\nlet language: String = \"\" // Filter on supported language. If includeVoices=true then the voices are also filtered.\n\n// Get a list of TTS engines enabled for org\nGetIntegrationsSpeechTtsEnginesRequest.getIntegrationsSpeechTtsEngines(pageNumber: pageNumber, pageSize: pageSize, includeVoices: includeVoices, name: name, language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechTtsEnginesRequest.getIntegrationsSpeechTtsEngines was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsspeechttssettings": { - "operationId": "getintegrationsspeechttssettings", - "functionName": "getIntegrationsSpeechTtsSettings", - "signature": "getIntegrationsSpeechTtsSettings()", - "return": "TtsSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get TTS settings for an org\nGetIntegrationsSpeechTtsSettingsRequest.getIntegrationsSpeechTtsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsSpeechTtsSettingsRequest.getIntegrationsSpeechTtsSettings was successful\")\n dump(response)\n }\n}" - }, - "getintegrationstype": { - "operationId": "getintegrationstype", - "functionName": "getIntegrationsType", - "signature": "getIntegrationsType(typeId)", - "parameters": [ - { - "name": "typeId", - "type": "String", - "required": "true" - } - ], - "return": "IntegrationType", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet typeId: String = \"\" // Integration Type Id\n\n// Get integration type.\nGetIntegrationsTypeRequest.getIntegrationsType(typeId: typeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsTypeRequest.getIntegrationsType was successful\")\n dump(response)\n }\n}" - }, - "getintegrationstypeconfigschema": { - "operationId": "getintegrationstypeconfigschema", - "functionName": "getIntegrationsTypeConfigschema", - "signature": "getIntegrationsTypeConfigschema(typeId, configType)", - "parameters": [ - { - "name": "typeId", - "type": "String", - "required": "true" - }, - { - "name": "configType", - "type": "String", - "required": "true" - } - ], - "return": "JsonSchemaDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet typeId: String = \"\" // Integration Type Id\nlet configType: GetIntegrationsTypeConfigschemaRequest.ConfigType_getIntegrationsTypeConfigschema = GetIntegrationsTypeConfigschemaRequest.ConfigType_getIntegrationsTypeConfigschema.enummember // Config schema type\n\n// Get properties config schema for an integration type.\nGetIntegrationsTypeConfigschemaRequest.getIntegrationsTypeConfigschema(typeId: typeId, configType: configType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsTypeConfigschemaRequest.getIntegrationsTypeConfigschema was successful\")\n dump(response)\n }\n}" - }, - "getintegrationstypes": { - "operationId": "getintegrationstypes", - "functionName": "getIntegrationsTypes", - "signature": "getIntegrationsTypes(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - } - ], - "return": "IntegrationTypeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\n\n// List integration types\nGetIntegrationsTypesRequest.getIntegrationsTypes(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsTypesRequest.getIntegrationsTypes was successful\")\n dump(response)\n }\n}" - }, - "getintegrationsuserapps": { - "operationId": "getintegrationsuserapps", - "functionName": "getIntegrationsUserapps", - "signature": "getIntegrationsUserapps(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, appHost)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "appHost", - "type": "String", - "required": "false" - } - ], - "return": "UserAppEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet appHost: String = \"\" // The type of UserApp to filter by\n\n// List permitted user app integrations for the logged in user\nGetIntegrationsUserappsRequest.getIntegrationsUserapps(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, appHost: appHost) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIntegrationsUserappsRequest.getIntegrationsUserapps was successful\")\n dump(response)\n }\n}" - }, - "patchintegration": { - "operationId": "patchintegration", - "functionName": "patchIntegration", - "signature": "patchIntegration(integrationId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "body", - "type": "Integration", - "required": "false" - } - ], - "return": "Integration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration Id\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet body: Integration = new Integration(...) // Integration Update\n\n// Update an integration.\nPatchIntegrationRequest.patchIntegration(integrationId: integrationId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchIntegrationRequest.patchIntegration was successful\")\n dump(response)\n }\n}" - }, - "patchintegrationsaction": { - "operationId": "patchintegrationsaction", - "functionName": "patchIntegrationsAction", - "signature": "patchIntegrationsAction(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateActionInput", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: UpdateActionInput = new UpdateActionInput(...) // Input used to patch the Action.\n\n// Patch an Action\nPatchIntegrationsActionRequest.patchIntegrationsAction(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchIntegrationsActionRequest.patchIntegrationsAction was successful\")\n dump(response)\n }\n}" - }, - "patchintegrationsactiondraft": { - "operationId": "patchintegrationsactiondraft", - "functionName": "patchIntegrationsActionDraft", - "signature": "patchIntegrationsActionDraft(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateDraftInput", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: UpdateDraftInput = new UpdateDraftInput(...) // Input used to patch the Action Draft.\n\n// Update an existing Draft\nPatchIntegrationsActionDraftRequest.patchIntegrationsActionDraft(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchIntegrationsActionDraftRequest.patchIntegrationsActionDraft was successful\")\n dump(response)\n }\n}" - }, - "postintegrations": { - "operationId": "postintegrations", - "functionName": "postIntegrations", - "signature": "postIntegrations(body)", - "parameters": [ - { - "name": "body", - "type": "CreateIntegrationRequest", - "required": "false" - } - ], - "return": "Integration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateIntegrationRequest = new CreateIntegrationRequest(...) // Integration\n\n// Create an integration.\nPostIntegrationsRequest.postIntegrations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsRequest.postIntegrations was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactiondraft": { - "operationId": "postintegrationsactiondraft", - "functionName": "postIntegrationsActionDraft", - "signature": "postIntegrationsActionDraft(actionId)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\n\n// Create a new Draft from existing Action\nPostIntegrationsActionDraftRequest.postIntegrationsActionDraft(actionId: actionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionDraftRequest.postIntegrationsActionDraft was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactiondraftpublish": { - "operationId": "postintegrationsactiondraftpublish", - "functionName": "postIntegrationsActionDraftPublish", - "signature": "postIntegrationsActionDraftPublish(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PublishDraftInput", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: PublishDraftInput = new PublishDraftInput(...) // Input used to patch the Action.\n\n// Publish a Draft and make it the active Action configuration\nPostIntegrationsActionDraftPublishRequest.postIntegrationsActionDraftPublish(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionDraftPublishRequest.postIntegrationsActionDraftPublish was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactiondrafttest": { - "operationId": "postintegrationsactiondrafttest", - "functionName": "postIntegrationsActionDraftTest", - "signature": "postIntegrationsActionDraftTest(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String:JSON]", - "required": "true" - } - ], - "return": "TestExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution.\n\n// Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.\nPostIntegrationsActionDraftTestRequest.postIntegrationsActionDraftTest(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionDraftTestRequest.postIntegrationsActionDraftTest was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactionexecute": { - "operationId": "postintegrationsactionexecute", - "functionName": "postIntegrationsActionExecute", - "signature": "postIntegrationsActionExecute(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String:JSON]", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution.\n\n// Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.\nPostIntegrationsActionExecuteRequest.postIntegrationsActionExecute(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionExecuteRequest.postIntegrationsActionExecute was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactiontest": { - "operationId": "postintegrationsactiontest", - "functionName": "postIntegrationsActionTest", - "signature": "postIntegrationsActionTest(actionId, body)", - "parameters": [ - { - "name": "actionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String:JSON]", - "required": "true" - } - ], - "return": "TestExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionId: String = \"\" // actionId\nlet body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution.\n\n// Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.\nPostIntegrationsActionTestRequest.postIntegrationsActionTest(actionId: actionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionTestRequest.postIntegrationsActionTest was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactions": { - "operationId": "postintegrationsactions", - "functionName": "postIntegrationsActions", - "signature": "postIntegrationsActions(body)", - "parameters": [ - { - "name": "body", - "type": "PostActionInput", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PostActionInput = new PostActionInput(...) // Input used to create Action.\n\n// Create a new Action\nPostIntegrationsActionsRequest.postIntegrationsActions(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionsRequest.postIntegrationsActions was successful\")\n dump(response)\n }\n}" - }, - "postintegrationsactionsdrafts": { - "operationId": "postintegrationsactionsdrafts", - "functionName": "postIntegrationsActionsDrafts", - "signature": "postIntegrationsActionsDrafts(body)", - "parameters": [ - { - "name": "body", - "type": "PostActionInput", - "required": "true" - } - ], - "return": "Action", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PostActionInput = new PostActionInput(...) // Input used to create Action Draft.\n\n// Create a new Draft\nPostIntegrationsActionsDraftsRequest.postIntegrationsActionsDrafts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsActionsDraftsRequest.postIntegrationsActionsDrafts was successful\")\n dump(response)\n }\n}" - }, - "postintegrationscredentials": { - "operationId": "postintegrationscredentials", - "functionName": "postIntegrationsCredentials", - "signature": "postIntegrationsCredentials(body)", - "parameters": [ - { - "name": "body", - "type": "Credential", - "required": "false" - } - ], - "return": "CredentialInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Credential = new Credential(...) // Credential\n\n// Create a set of credentials\nPostIntegrationsCredentialsRequest.postIntegrationsCredentials(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostIntegrationsCredentialsRequest.postIntegrationsCredentials was successful\")\n dump(response)\n }\n}" - }, - "putintegrationconfigcurrent": { - "operationId": "putintegrationconfigcurrent", - "functionName": "putIntegrationConfigCurrent", - "signature": "putIntegrationConfigCurrent(integrationId, body)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "IntegrationConfiguration", - "required": "false" - } - ], - "return": "IntegrationConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // Integration Id\nlet body: IntegrationConfiguration = new IntegrationConfiguration(...) // Integration Configuration\n\n// Update integration configuration.\nPutIntegrationConfigCurrentRequest.putIntegrationConfigCurrent(integrationId: integrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIntegrationConfigCurrentRequest.putIntegrationConfigCurrent was successful\")\n dump(response)\n }\n}" - }, - "putintegrationsbotconnectorintegrationidbots": { - "operationId": "putintegrationsbotconnectorintegrationidbots", - "functionName": "putIntegrationsBotconnectorIntegrationIdBots", - "signature": "putIntegrationsBotconnectorIntegrationIdBots(integrationId, botList)", - "parameters": [ - { - "name": "integrationId", - "type": "String", - "required": "true" - }, - { - "name": "botList", - "type": "BotList", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet integrationId: String = \"\" // The integration ID for this group of bots\nlet botList: BotList = new BotList(...) // \n\n// Set a list of botConnector bots plus versions for this integration\nPutIntegrationsBotconnectorIntegrationIdBotsRequest.putIntegrationsBotconnectorIntegrationIdBots(integrationId: integrationId, botList: botList) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutIntegrationsBotconnectorIntegrationIdBotsRequest.putIntegrationsBotconnectorIntegrationIdBots was successful\")\n }\n}" - }, - "putintegrationscredential": { - "operationId": "putintegrationscredential", - "functionName": "putIntegrationsCredential", - "signature": "putIntegrationsCredential(credentialId, body)", - "parameters": [ - { - "name": "credentialId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Credential", - "required": "false" - } - ], - "return": "CredentialInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet credentialId: String = \"\" // Credential ID\nlet body: Credential = new Credential(...) // Credential\n\n// Update a set of credentials\nPutIntegrationsCredentialRequest.putIntegrationsCredential(credentialId: credentialId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIntegrationsCredentialRequest.putIntegrationsCredential was successful\")\n dump(response)\n }\n}" - }, - "putintegrationsspeechttssettings": { - "operationId": "putintegrationsspeechttssettings", - "functionName": "putIntegrationsSpeechTtsSettings", - "signature": "putIntegrationsSpeechTtsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "TtsSettings", - "required": "true" - } - ], - "return": "TtsSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TtsSettings = new TtsSettings(...) // Updated TtsSettings\n\n// Update TTS settings for an org\nPutIntegrationsSpeechTtsSettingsRequest.putIntegrationsSpeechTtsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIntegrationsSpeechTtsSettingsRequest.putIntegrationsSpeechTtsSettings was successful\")\n dump(response)\n }\n}" - }, - "putintegrationsunifiedcommunicationthirdpartypresences": { - "operationId": "putintegrationsunifiedcommunicationthirdpartypresences", - "functionName": "putIntegrationsUnifiedcommunicationThirdpartypresences", - "signature": "putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body)", - "parameters": [ - { - "name": "ucIntegrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[UCThirdPartyPresence]", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ucIntegrationId: String = \"\" // UC Integration ID\nlet body: [UCThirdPartyPresence] = [new UCThirdPartyPresence(...)] // List of User presences\n\n// Bulk integration presence ingestion\nPutIntegrationsUnifiedcommunicationThirdpartypresencesRequest.putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId: ucIntegrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutIntegrationsUnifiedcommunicationThirdpartypresencesRequest.putIntegrationsUnifiedcommunicationThirdpartypresences was successful\")\n dump(response)\n }\n}" - }, - "deletejourneyactionmap": { - "operationId": "deletejourneyactionmap", - "functionName": "deleteJourneyActionmap", - "signature": "deleteJourneyActionmap(actionMapId)", - "parameters": [ - { - "name": "actionMapId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionMapId: String = \"\" // ID of the action map.\n\n// Delete single action map.\nDeleteJourneyActionmapRequest.deleteJourneyActionmap(actionMapId: actionMapId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteJourneyActionmapRequest.deleteJourneyActionmap was successful\")\n }\n}" - }, - "deletejourneyactiontemplate": { - "operationId": "deletejourneyactiontemplate", - "functionName": "deleteJourneyActiontemplate", - "signature": "deleteJourneyActiontemplate(actionTemplateId, hardDelete)", - "parameters": [ - { - "name": "actionTemplateId", - "type": "String", - "required": "true" - }, - { - "name": "hardDelete", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionTemplateId: String = \"\" // ID of the action template.\nlet hardDelete: Bool = true // 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.\n\n// Delete a single action template.\nDeleteJourneyActiontemplateRequest.deleteJourneyActiontemplate(actionTemplateId: actionTemplateId, hardDelete: hardDelete) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteJourneyActiontemplateRequest.deleteJourneyActiontemplate was successful\")\n }\n}" - }, - "deletejourneyoutcome": { - "operationId": "deletejourneyoutcome", - "functionName": "deleteJourneyOutcome", - "signature": "deleteJourneyOutcome(outcomeId)", - "parameters": [ - { - "name": "outcomeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet outcomeId: String = \"\" // ID of the outcome.\n\n// Delete an outcome.\nDeleteJourneyOutcomeRequest.deleteJourneyOutcome(outcomeId: outcomeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteJourneyOutcomeRequest.deleteJourneyOutcome was successful\")\n }\n}" - }, - "deletejourneyoutcomespredictor": { - "operationId": "deletejourneyoutcomespredictor", - "functionName": "deleteJourneyOutcomesPredictor", - "signature": "deleteJourneyOutcomesPredictor(predictorId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // ID of predictor\n\n// Delete an outcome predictor.\nDeleteJourneyOutcomesPredictorRequest.deleteJourneyOutcomesPredictor(predictorId: predictorId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteJourneyOutcomesPredictorRequest.deleteJourneyOutcomesPredictor was successful\")\n }\n}" - }, - "deletejourneysegment": { - "operationId": "deletejourneysegment", - "functionName": "deleteJourneySegment", - "signature": "deleteJourneySegment(segmentId)", - "parameters": [ - { - "name": "segmentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet segmentId: String = \"\" // ID of the segment.\n\n// Delete a segment.\nDeleteJourneySegmentRequest.deleteJourneySegment(segmentId: segmentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteJourneySegmentRequest.deleteJourneySegment was successful\")\n }\n}" - }, - "getjourneyactionmap": { - "operationId": "getjourneyactionmap", - "functionName": "getJourneyActionmap", - "signature": "getJourneyActionmap(actionMapId)", - "parameters": [ - { - "name": "actionMapId", - "type": "String", - "required": "true" - } - ], - "return": "ActionMap", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionMapId: String = \"\" // ID of the action map.\n\n// Retrieve a single action map.\nGetJourneyActionmapRequest.getJourneyActionmap(actionMapId: actionMapId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActionmapRequest.getJourneyActionmap was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactionmaps": { - "operationId": "getjourneyactionmaps", - "functionName": "getJourneyActionmaps", - "signature": "getJourneyActionmaps(pageNumber, pageSize, sortBy, filterField, filterValue, actionMapIds, queryFields, queryValue)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "filterField", - "type": "String", - "required": "false" - }, - { - "name": "filterValue", - "type": "String", - "required": "false" - }, - { - "name": "actionMapIds", - "type": "[String]", - "required": "false" - }, - { - "name": "queryFields", - "type": "[String]", - "required": "false" - }, - { - "name": "queryValue", - "type": "String", - "required": "false" - } - ], - "return": "ActionMapListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).\nlet filterField: String = \"\" // Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.\nlet filterValue: String = \"\" // Value to filter by. Requires 'filterValue' to also be set.\nlet actionMapIds: [String] = [\"\"] // IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.\nlet queryFields: [String] = [\"\"] // Action Map field(s) to query on. Requires 'queryValue' to also be set.\nlet queryValue: String = \"\" // Value to query on. Requires 'queryFields' to also be set.\n\n// Retrieve all action maps.\nGetJourneyActionmapsRequest.getJourneyActionmaps(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, filterField: filterField, filterValue: filterValue, actionMapIds: actionMapIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActionmapsRequest.getJourneyActionmaps was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactionmapsestimatesjob": { - "operationId": "getjourneyactionmapsestimatesjob", - "functionName": "getJourneyActionmapsEstimatesJob", - "signature": "getJourneyActionmapsEstimatesJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // ID of the job.\n\n// Get status of job.\nGetJourneyActionmapsEstimatesJobRequest.getJourneyActionmapsEstimatesJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActionmapsEstimatesJobRequest.getJourneyActionmapsEstimatesJob was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactionmapsestimatesjobresults": { - "operationId": "getjourneyactionmapsestimatesjobresults", - "functionName": "getJourneyActionmapsEstimatesJobResults", - "signature": "getJourneyActionmapsEstimatesJobResults(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "ActionMapEstimateResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // ID of the job.\n\n// Get estimates from completed job.\nGetJourneyActionmapsEstimatesJobResultsRequest.getJourneyActionmapsEstimatesJobResults(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActionmapsEstimatesJobResultsRequest.getJourneyActionmapsEstimatesJobResults was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactiontarget": { - "operationId": "getjourneyactiontarget", - "functionName": "getJourneyActiontarget", - "signature": "getJourneyActiontarget(actionTargetId)", - "parameters": [ - { - "name": "actionTargetId", - "type": "String", - "required": "true" - } - ], - "return": "ActionTarget", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionTargetId: String = \"\" // ID of the action target.\n\n// Retrieve a single action target.\nGetJourneyActiontargetRequest.getJourneyActiontarget(actionTargetId: actionTargetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActiontargetRequest.getJourneyActiontarget was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactiontargets": { - "operationId": "getjourneyactiontargets", - "functionName": "getJourneyActiontargets", - "signature": "getJourneyActiontargets(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ActionTargetListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Retrieve all action targets.\nGetJourneyActiontargetsRequest.getJourneyActiontargets(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActiontargetsRequest.getJourneyActiontargets was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactiontemplate": { - "operationId": "getjourneyactiontemplate", - "functionName": "getJourneyActiontemplate", - "signature": "getJourneyActiontemplate(actionTemplateId)", - "parameters": [ - { - "name": "actionTemplateId", - "type": "String", - "required": "true" - } - ], - "return": "ActionTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionTemplateId: String = \"\" // ID of the action template.\n\n// Retrieve a single action template.\nGetJourneyActiontemplateRequest.getJourneyActiontemplate(actionTemplateId: actionTemplateId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActiontemplateRequest.getJourneyActiontemplate was successful\")\n dump(response)\n }\n}" - }, - "getjourneyactiontemplates": { - "operationId": "getjourneyactiontemplates", - "functionName": "getJourneyActiontemplates", - "signature": "getJourneyActiontemplates(pageNumber, pageSize, sortBy, mediaType, state, queryFields, queryValue)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "mediaType", - "type": "String", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - }, - { - "name": "queryFields", - "type": "[String]", - "required": "false" - }, - { - "name": "queryValue", - "type": "String", - "required": "false" - } - ], - "return": "ActionTemplateListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).\nlet mediaType: GetJourneyActiontemplatesRequest.MediaType_getJourneyActiontemplates = GetJourneyActiontemplatesRequest.MediaType_getJourneyActiontemplates.enummember // Media type\nlet state: GetJourneyActiontemplatesRequest.State_getJourneyActiontemplates = GetJourneyActiontemplatesRequest.State_getJourneyActiontemplates.enummember // Action template state.\nlet queryFields: [String] = [\"\"] // ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.\nlet queryValue: String = \"\" // Value to query on. Requires 'queryFields' to also be set.\n\n// Retrieve all action templates.\nGetJourneyActiontemplatesRequest.getJourneyActiontemplates(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, mediaType: mediaType, state: state, queryFields: queryFields, queryValue: queryValue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyActiontemplatesRequest.getJourneyActiontemplates was successful\")\n dump(response)\n }\n}" - }, - "getjourneyoutcome": { - "operationId": "getjourneyoutcome", - "functionName": "getJourneyOutcome", - "signature": "getJourneyOutcome(outcomeId)", - "parameters": [ - { - "name": "outcomeId", - "type": "String", - "required": "true" - } - ], - "return": "Outcome", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet outcomeId: String = \"\" // ID of the outcome.\n\n// Retrieve a single outcome.\nGetJourneyOutcomeRequest.getJourneyOutcome(outcomeId: outcomeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyOutcomeRequest.getJourneyOutcome was successful\")\n dump(response)\n }\n}" - }, - "getjourneyoutcomes": { - "operationId": "getjourneyoutcomes", - "functionName": "getJourneyOutcomes", - "signature": "getJourneyOutcomes(pageNumber, pageSize, sortBy, outcomeIds, queryFields, queryValue)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "outcomeIds", - "type": "[String]", - "required": "false" - }, - { - "name": "queryFields", - "type": "[String]", - "required": "false" - }, - { - "name": "queryValue", - "type": "String", - "required": "false" - } - ], - "return": "OutcomeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // 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).\nlet outcomeIds: [String] = [\"\"] // IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.\nlet queryFields: [String] = [\"\"] // Outcome field(s) to query on. Requires 'queryValue' to also be set.\nlet queryValue: String = \"\" // Value to query on. Requires 'queryFields' to also be set.\n\n// Retrieve all outcomes.\nGetJourneyOutcomesRequest.getJourneyOutcomes(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, outcomeIds: outcomeIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyOutcomesRequest.getJourneyOutcomes was successful\")\n dump(response)\n }\n}" - }, - "getjourneyoutcomespredictor": { - "operationId": "getjourneyoutcomespredictor", - "functionName": "getJourneyOutcomesPredictor", - "signature": "getJourneyOutcomesPredictor(predictorId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - } - ], - "return": "OutcomePredictor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // ID of predictor\n\n// Retrieve a single outcome predictor.\nGetJourneyOutcomesPredictorRequest.getJourneyOutcomesPredictor(predictorId: predictorId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyOutcomesPredictorRequest.getJourneyOutcomesPredictor was successful\")\n dump(response)\n }\n}" - }, - "getjourneyoutcomespredictors": { - "operationId": "getjourneyoutcomespredictors", - "functionName": "getJourneyOutcomesPredictors", - "signature": "getJourneyOutcomesPredictors()", - "return": "OutcomePredictorListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieve all outcome predictors.\nGetJourneyOutcomesPredictorsRequest.getJourneyOutcomesPredictors() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneyOutcomesPredictorsRequest.getJourneyOutcomesPredictors was successful\")\n dump(response)\n }\n}" - }, - "getjourneysegment": { - "operationId": "getjourneysegment", - "functionName": "getJourneySegment", - "signature": "getJourneySegment(segmentId)", - "parameters": [ - { - "name": "segmentId", - "type": "String", - "required": "true" - } - ], - "return": "JourneySegment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet segmentId: String = \"\" // ID of the segment.\n\n// Retrieve a single segment.\nGetJourneySegmentRequest.getJourneySegment(segmentId: segmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneySegmentRequest.getJourneySegment was successful\")\n dump(response)\n }\n}" - }, - "getjourneysegments": { - "operationId": "getjourneysegments", - "functionName": "getJourneySegments", - "signature": "getJourneySegments(sortBy, pageSize, pageNumber, isActive, segmentIds, queryFields, queryValue)", - "parameters": [ - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "isActive", - "type": "Bool", - "required": "false" - }, - { - "name": "segmentIds", - "type": "[String]", - "required": "false" - }, - { - "name": "queryFields", - "type": "[String]", - "required": "false" - }, - { - "name": "queryValue", - "type": "String", - "required": "false" - } - ], - "return": "SegmentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sortBy: String = \"\" // 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).\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet isActive: Bool = true // Determines whether or not to show only active segments.\nlet segmentIds: [String] = [\"\"] // IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.\nlet queryFields: [String] = [\"\"] // Segment field(s) to query on. Requires 'queryValue' to also be set.\nlet queryValue: String = \"\" // Value to query on. Requires 'queryFields' to also be set.\n\n// Retrieve all segments.\nGetJourneySegmentsRequest.getJourneySegments(sortBy: sortBy, pageSize: pageSize, pageNumber: pageNumber, isActive: isActive, segmentIds: segmentIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneySegmentsRequest.getJourneySegments was successful\")\n dump(response)\n }\n}" - }, - "getjourneysession": { - "operationId": "getjourneysession", - "functionName": "getJourneySession", - "signature": "getJourneySession(sessionId)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - } - ], - "return": "Session", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // ID of the session.\n\n// Retrieve a single session.\nGetJourneySessionRequest.getJourneySession(sessionId: sessionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneySessionRequest.getJourneySession was successful\")\n dump(response)\n }\n}" - }, - "getjourneysessionoutcomescores": { - "operationId": "getjourneysessionoutcomescores", - "functionName": "getJourneySessionOutcomescores", - "signature": "getJourneySessionOutcomescores(sessionId)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - } - ], - "return": "OutcomeScoresResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // ID of the session.\n\n// Retrieve latest outcome score associated with a session for all outcomes.\nGetJourneySessionOutcomescoresRequest.getJourneySessionOutcomescores(sessionId: sessionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetJourneySessionOutcomescoresRequest.getJourneySessionOutcomescores was successful\")\n dump(response)\n }\n}" - }, - "patchjourneyactionmap": { - "operationId": "patchjourneyactionmap", - "functionName": "patchJourneyActionmap", - "signature": "patchJourneyActionmap(actionMapId, body)", - "parameters": [ - { - "name": "actionMapId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchActionMap", - "required": "false" - } - ], - "return": "ActionMap", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionMapId: String = \"\" // ID of the action map.\nlet body: PatchActionMap = new PatchActionMap(...) // \n\n// Update single action map.\nPatchJourneyActionmapRequest.patchJourneyActionmap(actionMapId: actionMapId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchJourneyActionmapRequest.patchJourneyActionmap was successful\")\n dump(response)\n }\n}" - }, - "patchjourneyactiontarget": { - "operationId": "patchjourneyactiontarget", - "functionName": "patchJourneyActiontarget", - "signature": "patchJourneyActiontarget(actionTargetId, body)", - "parameters": [ - { - "name": "actionTargetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchActionTarget", - "required": "false" - } - ], - "return": "ActionTarget", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionTargetId: String = \"\" // ID of the action target.\nlet body: PatchActionTarget = new PatchActionTarget(...) // \n\n// Update a single action target.\nPatchJourneyActiontargetRequest.patchJourneyActiontarget(actionTargetId: actionTargetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchJourneyActiontargetRequest.patchJourneyActiontarget was successful\")\n dump(response)\n }\n}" - }, - "patchjourneyactiontemplate": { - "operationId": "patchjourneyactiontemplate", - "functionName": "patchJourneyActiontemplate", - "signature": "patchJourneyActiontemplate(actionTemplateId, body)", - "parameters": [ - { - "name": "actionTemplateId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchActionTemplate", - "required": "false" - } - ], - "return": "ActionTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet actionTemplateId: String = \"\" // ID of the action template.\nlet body: PatchActionTemplate = new PatchActionTemplate(...) // \n\n// Update a single action template.\nPatchJourneyActiontemplateRequest.patchJourneyActiontemplate(actionTemplateId: actionTemplateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchJourneyActiontemplateRequest.patchJourneyActiontemplate was successful\")\n dump(response)\n }\n}" - }, - "patchjourneyoutcome": { - "operationId": "patchjourneyoutcome", - "functionName": "patchJourneyOutcome", - "signature": "patchJourneyOutcome(outcomeId, body)", - "parameters": [ - { - "name": "outcomeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchOutcome", - "required": "false" - } - ], - "return": "Outcome", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet outcomeId: String = \"\" // ID of the outcome.\nlet body: PatchOutcome = new PatchOutcome(...) // \n\n// Update an outcome.\nPatchJourneyOutcomeRequest.patchJourneyOutcome(outcomeId: outcomeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchJourneyOutcomeRequest.patchJourneyOutcome was successful\")\n dump(response)\n }\n}" - }, - "patchjourneysegment": { - "operationId": "patchjourneysegment", - "functionName": "patchJourneySegment", - "signature": "patchJourneySegment(segmentId, body)", - "parameters": [ - { - "name": "segmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchSegment", - "required": "false" - } - ], - "return": "JourneySegment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet segmentId: String = \"\" // ID of the segment.\nlet body: PatchSegment = new PatchSegment(...) // \n\n// Update a segment.\nPatchJourneySegmentRequest.patchJourneySegment(segmentId: segmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchJourneySegmentRequest.patchJourneySegment was successful\")\n dump(response)\n }\n}" - }, - "postjourneyactionmaps": { - "operationId": "postjourneyactionmaps", - "functionName": "postJourneyActionmaps", - "signature": "postJourneyActionmaps(body)", - "parameters": [ - { - "name": "body", - "type": "ActionMap", - "required": "false" - } - ], - "return": "ActionMap", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ActionMap = new ActionMap(...) // \n\n// Create an action map.\nPostJourneyActionmapsRequest.postJourneyActionmaps(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneyActionmapsRequest.postJourneyActionmaps was successful\")\n dump(response)\n }\n}" - }, - "postjourneyactionmapsestimatesjobs": { - "operationId": "postjourneyactionmapsestimatesjobs", - "functionName": "postJourneyActionmapsEstimatesJobs", - "signature": "postJourneyActionmapsEstimatesJobs(body)", - "parameters": [ - { - "name": "body", - "type": "ActionMapEstimateRequest", - "required": "true" - } - ], - "return": "EstimateJobAsyncResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ActionMapEstimateRequest = new ActionMapEstimateRequest(...) // audience estimator request\n\n// Query for estimates\nPostJourneyActionmapsEstimatesJobsRequest.postJourneyActionmapsEstimatesJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneyActionmapsEstimatesJobsRequest.postJourneyActionmapsEstimatesJobs was successful\")\n dump(response)\n }\n}" - }, - "postjourneyactiontemplates": { - "operationId": "postjourneyactiontemplates", - "functionName": "postJourneyActiontemplates", - "signature": "postJourneyActiontemplates(body)", - "parameters": [ - { - "name": "body", - "type": "ActionTemplate", - "required": "false" - } - ], - "return": "ActionTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ActionTemplate = new ActionTemplate(...) // \n\n// Create a single action template.\nPostJourneyActiontemplatesRequest.postJourneyActiontemplates(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneyActiontemplatesRequest.postJourneyActiontemplates was successful\")\n dump(response)\n }\n}" - }, - "postjourneyoutcomes": { - "operationId": "postjourneyoutcomes", - "functionName": "postJourneyOutcomes", - "signature": "postJourneyOutcomes(body)", - "parameters": [ - { - "name": "body", - "type": "Outcome", - "required": "false" - } - ], - "return": "Outcome", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Outcome = new Outcome(...) // \n\n// Create an outcome.\nPostJourneyOutcomesRequest.postJourneyOutcomes(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneyOutcomesRequest.postJourneyOutcomes was successful\")\n dump(response)\n }\n}" - }, - "postjourneyoutcomespredictors": { - "operationId": "postjourneyoutcomespredictors", - "functionName": "postJourneyOutcomesPredictors", - "signature": "postJourneyOutcomesPredictors(body)", - "parameters": [ - { - "name": "body", - "type": "OutcomePredictorRequest", - "required": "false" - } - ], - "return": "OutcomePredictor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OutcomePredictorRequest = new OutcomePredictorRequest(...) // \n\n// Create an outcome predictor.\nPostJourneyOutcomesPredictorsRequest.postJourneyOutcomesPredictors(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneyOutcomesPredictorsRequest.postJourneyOutcomesPredictors was successful\")\n dump(response)\n }\n}" - }, - "postjourneysegments": { - "operationId": "postjourneysegments", - "functionName": "postJourneySegments", - "signature": "postJourneySegments(body)", - "parameters": [ - { - "name": "body", - "type": "JourneySegment", - "required": "false" - } - ], - "return": "JourneySegment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: JourneySegment = new JourneySegment(...) // \n\n// Create a segment.\nPostJourneySegmentsRequest.postJourneySegments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostJourneySegmentsRequest.postJourneySegments was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebase": { - "operationId": "deleteknowledgeknowledgebase", - "functionName": "deleteKnowledgeKnowledgebase", - "signature": "deleteKnowledgeKnowledgebase(knowledgeBaseId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\n\n// Delete knowledge base\nDeleteKnowledgeKnowledgebaseRequest.deleteKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteKnowledgeKnowledgebaseRequest.deleteKnowledgeKnowledgebase was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebasecategory": { - "operationId": "deleteknowledgeknowledgebasecategory", - "functionName": "deleteKnowledgeKnowledgebaseCategory", - "signature": "deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "categoryId", - "type": "String", - "required": "true" - } - ], - "return": "CategoryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet categoryId: String = \"\" // Category ID\n\n// Delete category\nDeleteKnowledgeKnowledgebaseCategoryRequest.deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteKnowledgeKnowledgebaseCategoryRequest.deleteKnowledgeKnowledgebaseCategory was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebasedocument": { - "operationId": "deleteknowledgeknowledgebasedocument", - "functionName": "deleteKnowledgeKnowledgebaseDocument", - "signature": "deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\n\n// Delete document.\nDeleteKnowledgeKnowledgebaseDocumentRequest.deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteKnowledgeKnowledgebaseDocumentRequest.deleteKnowledgeKnowledgebaseDocument was successful\")\n }\n}" - }, - "deleteknowledgeknowledgebasedocumentvariation": { - "operationId": "deleteknowledgeknowledgebasedocumentvariation", - "functionName": "deleteKnowledgeKnowledgebaseDocumentVariation", - "signature": "deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId)", - "parameters": [ - { - "name": "documentVariationId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentVariationId: String = \"\" // Globally unique identifier for a document variation.\nlet documentId: String = \"\" // Globally unique identifier for a document.\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for a knowledge base.\n\n// Delete a variation for a document.\nDeleteKnowledgeKnowledgebaseDocumentVariationRequest.deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteKnowledgeKnowledgebaseDocumentVariationRequest.deleteKnowledgeKnowledgebaseDocumentVariation was successful\")\n }\n}" - }, - "deleteknowledgeknowledgebaseexportjob": { - "operationId": "deleteknowledgeknowledgebaseexportjob", - "functionName": "deleteKnowledgeKnowledgebaseExportJob", - "signature": "deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "exportJobId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet exportJobId: String = \"\" // Export job ID\n\n// Delete export job\nDeleteKnowledgeKnowledgebaseExportJobRequest.deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId: knowledgeBaseId, exportJobId: exportJobId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteKnowledgeKnowledgebaseExportJobRequest.deleteKnowledgeKnowledgebaseExportJob was successful\")\n }\n}" - }, - "deleteknowledgeknowledgebaseimportjob": { - "operationId": "deleteknowledgeknowledgebaseimportjob", - "functionName": "deleteKnowledgeKnowledgebaseImportJob", - "signature": "deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "importJobId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet importJobId: String = \"\" // Import job ID\n\n// Delete import job\nDeleteKnowledgeKnowledgebaseImportJobRequest.deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteKnowledgeKnowledgebaseImportJobRequest.deleteKnowledgeKnowledgebaseImportJob was successful\")\n }\n}" - }, - "deleteknowledgeknowledgebaselabel": { - "operationId": "deleteknowledgeknowledgebaselabel", - "functionName": "deleteKnowledgeKnowledgebaseLabel", - "signature": "deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "labelId", - "type": "String", - "required": "true" - } - ], - "return": "LabelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet labelId: String = \"\" // Label ID\n\n// Delete label\nDeleteKnowledgeKnowledgebaseLabelRequest.deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteKnowledgeKnowledgebaseLabelRequest.deleteKnowledgeKnowledgebaseLabel was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebaselanguagecategory": { - "operationId": "deleteknowledgeknowledgebaselanguagecategory", - "functionName": "deleteKnowledgeKnowledgebaseLanguageCategory", - "signature": "deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode)", - "parameters": [ - { - "name": "categoryId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeCategory", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet categoryId: String = \"\" // Category ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageCategory = DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE\n\n// Delete category\nDeleteKnowledgeKnowledgebaseLanguageCategoryRequest.deleteKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.deleteKnowledgeKnowledgebaseLanguageCategory was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebaselanguagedocument": { - "operationId": "deleteknowledgeknowledgebaselanguagedocument", - "functionName": "deleteKnowledgeKnowledgebaseLanguageDocument", - "signature": "deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocument = DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE\n\n// Delete document\nDeleteKnowledgeKnowledgebaseLanguageDocumentRequest.deleteKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.deleteKnowledgeKnowledgebaseLanguageDocument was successful\")\n dump(response)\n }\n}" - }, - "deleteknowledgeknowledgebaselanguagedocumentsimport": { - "operationId": "deleteknowledgeknowledgebaselanguagedocumentsimport", - "functionName": "deleteKnowledgeKnowledgebaseLanguageDocumentsImport", - "signature": "deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "importId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocumentsImport = DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE\nlet importId: String = \"\" // Import ID\n\n// Delete import operation\nDeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.deleteKnowledgeKnowledgebaseLanguageDocumentsImport was successful\")\n }\n}" - }, - "getknowledgeguestsessioncategories": { - "operationId": "getknowledgeguestsessioncategories", - "functionName": "getKnowledgeGuestSessionCategories", - "signature": "getKnowledgeGuestSessionCategories(sessionId, before, after, pageSize, parentId, isRoot, name, sortBy, expand, includeDocumentCount)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "parentId", - "type": "String", - "required": "false" - }, - { - "name": "isRoot", - "type": "Bool", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "includeDocumentCount", - "type": "Bool", - "required": "false" - } - ], - "return": "GuestCategoryResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet parentId: String = \"\" // If specified, retrieves the children categories by parent category ID.\nlet isRoot: Bool = true // If specified, retrieves only the root categories.\nlet name: String = \"\" // Filter to return the categories that starts with the given category name.\nlet sortBy: GetKnowledgeGuestSessionCategoriesRequest.SortBy_getKnowledgeGuestSessionCategories = GetKnowledgeGuestSessionCategoriesRequest.SortBy_getKnowledgeGuestSessionCategories.enummember // Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically\nlet expand: String = \"\" // The specified entity attribute will be filled. Supported value:\\\"Ancestors\\\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.\nlet includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to category.\n\n// Get categories\nGetKnowledgeGuestSessionCategoriesRequest.getKnowledgeGuestSessionCategories(sessionId: sessionId, before: before, after: after, pageSize: pageSize, parentId: parentId, isRoot: isRoot, name: name, sortBy: sortBy, expand: expand, includeDocumentCount: includeDocumentCount) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeGuestSessionCategoriesRequest.getKnowledgeGuestSessionCategories was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeguestsessiondocument": { - "operationId": "getknowledgeguestsessiondocument", - "functionName": "getKnowledgeGuestSessionDocument", - "signature": "getKnowledgeGuestSessionDocument(sessionId, documentId)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeGuestDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet documentId: String = \"\" // Document ID\n\n// Get a knowledge document by ID.\nGetKnowledgeGuestSessionDocumentRequest.getKnowledgeGuestSessionDocument(sessionId: sessionId, documentId: documentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeGuestSessionDocumentRequest.getKnowledgeGuestSessionDocument was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeguestsessiondocuments": { - "operationId": "getknowledgeguestsessiondocuments", - "functionName": "getKnowledgeGuestSessionDocuments", - "signature": "getKnowledgeGuestSessionDocuments(sessionId, categoryId, pageSize)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "categoryId", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "KnowledgeGuestDocumentResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet categoryId: [String] = [\"\"] // If specified, retrieves documents associated with category ids, comma separated values expected.\nlet pageSize: Int = 0 // Number of entities to return. Maximum of 200.\n\n// Get documents.\nGetKnowledgeGuestSessionDocumentsRequest.getKnowledgeGuestSessionDocuments(sessionId: sessionId, categoryId: categoryId, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeGuestSessionDocumentsRequest.getKnowledgeGuestSessionDocuments was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebase": { - "operationId": "getknowledgeknowledgebase", - "functionName": "getKnowledgeKnowledgebase", - "signature": "getKnowledgeKnowledgebase(knowledgeBaseId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\n\n// Get knowledge base\nGetKnowledgeKnowledgebaseRequest.getKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseRequest.getKnowledgeKnowledgebase was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasecategories": { - "operationId": "getknowledgeknowledgebasecategories", - "functionName": "getKnowledgeKnowledgebaseCategories", - "signature": "getKnowledgeKnowledgebaseCategories(knowledgeBaseId, before, after, pageSize, parentId, isRoot, name, sortBy, expand, includeDocumentCount)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "parentId", - "type": "String", - "required": "false" - }, - { - "name": "isRoot", - "type": "Bool", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "includeDocumentCount", - "type": "Bool", - "required": "false" - } - ], - "return": "CategoryResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet parentId: String = \"\" // If specified, retrieves the children categories by parent category ID.\nlet isRoot: Bool = true // If specified, retrieves only the root categories.\nlet name: String = \"\" // Filter to return the categories that starts with the given category name.\nlet sortBy: GetKnowledgeKnowledgebaseCategoriesRequest.SortBy_getKnowledgeKnowledgebaseCategories = GetKnowledgeKnowledgebaseCategoriesRequest.SortBy_getKnowledgeKnowledgebaseCategories.enummember // Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically\nlet expand: String = \"\" // The specified entity attribute will be filled. Supported value:\\\"Ancestors\\\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.\nlet includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to category.\n\n// Get categories\nGetKnowledgeKnowledgebaseCategoriesRequest.getKnowledgeKnowledgebaseCategories(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, parentId: parentId, isRoot: isRoot, name: name, sortBy: sortBy, expand: expand, includeDocumentCount: includeDocumentCount) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseCategoriesRequest.getKnowledgeKnowledgebaseCategories was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasecategory": { - "operationId": "getknowledgeknowledgebasecategory", - "functionName": "getKnowledgeKnowledgebaseCategory", - "signature": "getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "categoryId", - "type": "String", - "required": "true" - } - ], - "return": "CategoryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet categoryId: String = \"\" // Category ID\n\n// Get category\nGetKnowledgeKnowledgebaseCategoryRequest.getKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseCategoryRequest.getKnowledgeKnowledgebaseCategory was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocument": { - "operationId": "getknowledgeknowledgebasedocument", - "functionName": "getKnowledgeKnowledgebaseDocument", - "signature": "getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, expand, state)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - } - ], - "return": "KnowledgeDocumentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.\nlet state: GetKnowledgeKnowledgebaseDocumentRequest.State_getKnowledgeKnowledgebaseDocument = GetKnowledgeKnowledgebaseDocumentRequest.State_getKnowledgeKnowledgebaseDocument.enummember // \\\"when state is \\\"Draft\\\", draft version of the document is returned,otherwise by default published version is returned in the response.\n\n// Get document.\nGetKnowledgeKnowledgebaseDocumentRequest.getKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId, expand: expand, state: state) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentRequest.getKnowledgeKnowledgebaseDocument was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentfeedback": { - "operationId": "getknowledgeknowledgebasedocumentfeedback", - "functionName": "getKnowledgeKnowledgebaseDocumentFeedback", - "signature": "getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, before, after, pageSize, onlyCommented, documentVersionId, documentVariationId, appType, queryType, userId, queueId, state)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "onlyCommented", - "type": "Bool", - "required": "false" - }, - { - "name": "documentVersionId", - "type": "String", - "required": "false" - }, - { - "name": "documentVariationId", - "type": "String", - "required": "false" - }, - { - "name": "appType", - "type": "String", - "required": "false" - }, - { - "name": "queryType", - "type": "String", - "required": "false" - }, - { - "name": "userId", - "type": "String", - "required": "false" - }, - { - "name": "queueId", - "type": "String", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - } - ], - "return": "KnowledgeDocumentFeedbackResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet onlyCommented: Bool = true // If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.\nlet documentVersionId: String = \"\" // Document version ID to filter by. Supported only if onlyCommented=true is set.\nlet documentVariationId: String = \"\" // Document variation ID to filter by. Supported only if onlyCommented=true is set.\nlet appType: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.AppType_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.AppType_getKnowledgeKnowledgebaseDocumentFeedback.enummember // Application type to filter by. Supported only if onlyCommented=true is set.\nlet queryType: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.QueryType_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.QueryType_getKnowledgeKnowledgebaseDocumentFeedback.enummember // Query type to filter by. Supported only if onlyCommented=true is set.\nlet userId: String = \"\" // The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.\nlet queueId: String = \"\" // Queue ID to filter by. Supported only if onlyCommented=true is set.\nlet state: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.State_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.State_getKnowledgeKnowledgebaseDocumentFeedback.enummember // State to filter by. Supported only if onlyCommented=true is set. Default: Final\n\n// Get a list of feedback records given on a document\nGetKnowledgeKnowledgebaseDocumentFeedbackRequest.getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, onlyCommented: onlyCommented, documentVersionId: documentVersionId, documentVariationId: documentVariationId, appType: appType, queryType: queryType, userId: userId, queueId: queueId, state: state) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentFeedbackRequest.getKnowledgeKnowledgebaseDocumentFeedback was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentfeedbackfeedbackid": { - "operationId": "getknowledgeknowledgebasedocumentfeedbackfeedbackid", - "functionName": "getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId", - "signature": "getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "feedbackId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeDocumentFeedbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet feedbackId: String = \"\" // Feedback ID.\n\n// Get a single feedback record given on a document\nGetKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest.getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId: knowledgeBaseId, documentId: documentId, feedbackId: feedbackId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest.getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentvariation": { - "operationId": "getknowledgeknowledgebasedocumentvariation", - "functionName": "getKnowledgeKnowledgebaseDocumentVariation", - "signature": "getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, documentState)", - "parameters": [ - { - "name": "documentVariationId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentState", - "type": "String", - "required": "false" - } - ], - "return": "DocumentVariation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentVariationId: String = \"\" // Globally unique identifier for a document variation.\nlet documentId: String = \"\" // Globally unique identifier for a document.\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for a knowledge base.\nlet documentState: GetKnowledgeKnowledgebaseDocumentVariationRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariation = GetKnowledgeKnowledgebaseDocumentVariationRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariation.enummember // The state of the document.\n\n// Get a variation for a document.\nGetKnowledgeKnowledgebaseDocumentVariationRequest.getKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId, documentState: documentState) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVariationRequest.getKnowledgeKnowledgebaseDocumentVariation was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentvariations": { - "operationId": "getknowledgeknowledgebasedocumentvariations", - "functionName": "getKnowledgeKnowledgebaseDocumentVariations", - "signature": "getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, before, after, pageSize, documentState)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "documentState", - "type": "String", - "required": "false" - } - ], - "return": "DocumentVariationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet documentState: GetKnowledgeKnowledgebaseDocumentVariationsRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariations = GetKnowledgeKnowledgebaseDocumentVariationsRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariations.enummember // The state of the document.\n\n// Get variations for a document.\nGetKnowledgeKnowledgebaseDocumentVariationsRequest.getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, documentState: documentState) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVariationsRequest.getKnowledgeKnowledgebaseDocumentVariations was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentversion": { - "operationId": "getknowledgeknowledgebasedocumentversion", - "functionName": "getKnowledgeKnowledgebaseDocumentVersion", - "signature": "getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, expand)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "KnowledgeDocumentVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet versionId: String = \"\" // Globally unique identifier for the document version.\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected.\n\n// Get document version.\nGetKnowledgeKnowledgebaseDocumentVersionRequest.getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVersionRequest.getKnowledgeKnowledgebaseDocumentVersion was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentversionvariation": { - "operationId": "getknowledgeknowledgebasedocumentversionvariation", - "functionName": "getKnowledgeKnowledgebaseDocumentVersionVariation", - "signature": "getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "variationId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeDocumentVersionVariation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet versionId: String = \"\" // Globally unique identifier for the document version.\nlet variationId: String = \"\" // Globally unique identifier for the document version variation.\n\n// Get variation for the given document version.\nGetKnowledgeKnowledgebaseDocumentVersionVariationRequest.getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, variationId: variationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVersionVariationRequest.getKnowledgeKnowledgebaseDocumentVersionVariation was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentversionvariations": { - "operationId": "getknowledgeknowledgebasedocumentversionvariations", - "functionName": "getKnowledgeKnowledgebaseDocumentVersionVariations", - "signature": "getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, before, after, pageSize)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - } - ], - "return": "KnowledgeDocumentVersionVariationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet versionId: String = \"\" // Globally unique identifier for the document version.\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\n\n// Get variations for the given document version.\nGetKnowledgeKnowledgebaseDocumentVersionVariationsRequest.getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, before: before, after: after, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVersionVariationsRequest.getKnowledgeKnowledgebaseDocumentVersionVariations was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocumentversions": { - "operationId": "getknowledgeknowledgebasedocumentversions", - "functionName": "getKnowledgeKnowledgebaseDocumentVersions", - "signature": "getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, before, after, pageSize, expand)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "KnowledgeDocumentVersionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected.\n\n// Get document versions.\nGetKnowledgeKnowledgebaseDocumentVersionsRequest.getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentVersionsRequest.getKnowledgeKnowledgebaseDocumentVersions was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebasedocuments": { - "operationId": "getknowledgeknowledgebasedocuments", - "functionName": "getKnowledgeKnowledgebaseDocuments", - "signature": "getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, before, after, pageSize, interval, documentId, categoryId, includeSubcategories, includeDrafts, labelIds, expand, externalIds)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "documentId", - "type": "[String]", - "required": "false" - }, - { - "name": "categoryId", - "type": "[String]", - "required": "false" - }, - { - "name": "includeSubcategories", - "type": "Bool", - "required": "false" - }, - { - "name": "includeDrafts", - "type": "Bool", - "required": "false" - }, - { - "name": "labelIds", - "type": "[String]", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "externalIds", - "type": "[String]", - "required": "false" - } - ], - "return": "KnowledgeDocumentResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet interval: String = \"\" // Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ\nlet documentId: [String] = [\"\"] // Retrieves the specified documents, comma separated values expected.\nlet categoryId: [String] = [\"\"] // If specified, retrieves documents associated with category ids, comma separated values expected.\nlet includeSubcategories: Bool = true // Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.\nlet includeDrafts: Bool = true // If includeDrafts is true, Documents in the draft state are also returned in the response.\nlet labelIds: [String] = [\"\"] // If specified, retrieves documents associated with label ids, comma separated values expected.\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected.\nlet externalIds: [String] = [\"\"] // If specified, retrieves documents associated with external ids, comma separated values expected.\n\n// Get documents.\nGetKnowledgeKnowledgebaseDocumentsRequest.getKnowledgeKnowledgebaseDocuments(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, interval: interval, documentId: documentId, categoryId: categoryId, includeSubcategories: includeSubcategories, includeDrafts: includeDrafts, labelIds: labelIds, expand: expand, externalIds: externalIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseDocumentsRequest.getKnowledgeKnowledgebaseDocuments was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaseexportjob": { - "operationId": "getknowledgeknowledgebaseexportjob", - "functionName": "getKnowledgeKnowledgebaseExportJob", - "signature": "getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "exportJobId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeExportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet exportJobId: String = \"\" // Export job ID\n\n// Get export job report\nGetKnowledgeKnowledgebaseExportJobRequest.getKnowledgeKnowledgebaseExportJob(knowledgeBaseId: knowledgeBaseId, exportJobId: exportJobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseExportJobRequest.getKnowledgeKnowledgebaseExportJob was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaseimportjob": { - "operationId": "getknowledgeknowledgebaseimportjob", - "functionName": "getKnowledgeKnowledgebaseImportJob", - "signature": "getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, expand)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "importJobId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "KnowledgeImportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet importJobId: String = \"\" // Import job ID\nlet expand: [String] = [\"\"] // If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.\n\n// Get import job report\nGetKnowledgeKnowledgebaseImportJobRequest.getKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseImportJobRequest.getKnowledgeKnowledgebaseImportJob was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselabel": { - "operationId": "getknowledgeknowledgebaselabel", - "functionName": "getKnowledgeKnowledgebaseLabel", - "signature": "getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "labelId", - "type": "String", - "required": "true" - } - ], - "return": "LabelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet labelId: String = \"\" // Label ID\n\n// Get label\nGetKnowledgeKnowledgebaseLabelRequest.getKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLabelRequest.getKnowledgeKnowledgebaseLabel was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselabels": { - "operationId": "getknowledgeknowledgebaselabels", - "functionName": "getKnowledgeKnowledgebaseLabels", - "signature": "getKnowledgeKnowledgebaseLabels(knowledgeBaseId, before, after, pageSize, name, includeDocumentCount)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "includeDocumentCount", - "type": "Bool", - "required": "false" - } - ], - "return": "LabelListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet name: String = \"\" // Filter to return the labels that contains the given phrase in the name.\nlet includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to label.\n\n// Get labels\nGetKnowledgeKnowledgebaseLabelsRequest.getKnowledgeKnowledgebaseLabels(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, name: name, includeDocumentCount: includeDocumentCount) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLabelsRequest.getKnowledgeKnowledgebaseLabels was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagecategories": { - "operationId": "getknowledgeknowledgebaselanguagecategories", - "functionName": "getKnowledgeKnowledgebaseLanguageCategories", - "signature": "getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, before, after, limit, pageSize, name)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "CategoryListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategories = GetKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategories.enummember // Language code, format: iso2-LOCALE\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet name: String = \"\" // Filter to return the categories that starts with the given category name.\n\n// Get categories\nGetKnowledgeKnowledgebaseLanguageCategoriesRequest.getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageCategoriesRequest.getKnowledgeKnowledgebaseLanguageCategories was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagecategory": { - "operationId": "getknowledgeknowledgebaselanguagecategory", - "functionName": "getKnowledgeKnowledgebaseLanguageCategory", - "signature": "getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode)", - "parameters": [ - { - "name": "categoryId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeExtendedCategory", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet categoryId: String = \"\" // Category ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategory = GetKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE\n\n// Get category\nGetKnowledgeKnowledgebaseLanguageCategoryRequest.getKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageCategoryRequest.getKnowledgeKnowledgebaseLanguageCategory was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagedocument": { - "operationId": "getknowledgeknowledgebaselanguagedocument", - "functionName": "getKnowledgeKnowledgebaseLanguageDocument", - "signature": "getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocument = GetKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE\n\n// Get document\nGetKnowledgeKnowledgebaseLanguageDocumentRequest.getKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageDocumentRequest.getKnowledgeKnowledgebaseLanguageDocument was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagedocuments": { - "operationId": "getknowledgeknowledgebaselanguagedocuments", - "functionName": "getKnowledgeKnowledgebaseLanguageDocuments", - "signature": "getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, before, after, limit, pageSize, categories, title, sortBy, sortOrder, documentIds)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "categories", - "type": "String", - "required": "false" - }, - { - "name": "title", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "documentIds", - "type": "[String]", - "required": "false" - } - ], - "return": "DocumentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet categories: String = \"\" // Filter by categories ids, comma separated values expected.\nlet title: String = \"\" // Filter by document title.\nlet sortBy: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortBy_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortBy_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Sort by.\nlet sortOrder: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortOrder_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortOrder_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Sort Order.\nlet documentIds: [String] = [\"\"] // Comma-separated list of document identifiers to fetch by.\n\n// Get documents\nGetKnowledgeKnowledgebaseLanguageDocumentsRequest.getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, categories: categories, title: title, sortBy: sortBy, sortOrder: sortOrder, documentIds: documentIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageDocumentsRequest.getKnowledgeKnowledgebaseLanguageDocuments was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagedocumentsimport": { - "operationId": "getknowledgeknowledgebaselanguagedocumentsimport", - "functionName": "getKnowledgeKnowledgebaseLanguageDocumentsImport", - "signature": "getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "importId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeImport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocumentsImport = GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE\nlet importId: String = \"\" // Import ID\n\n// Get import operation report\nGetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.getKnowledgeKnowledgebaseLanguageDocumentsImport was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagetraining": { - "operationId": "getknowledgeknowledgebaselanguagetraining", - "functionName": "getKnowledgeKnowledgebaseLanguageTraining", - "signature": "getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "trainingId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeTraining", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageTrainingRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTraining = GetKnowledgeKnowledgebaseLanguageTrainingRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTraining.enummember // Language code, format: iso2-LOCALE\nlet trainingId: String = \"\" // Training ID\n\n// Get training detail\nGetKnowledgeKnowledgebaseLanguageTrainingRequest.getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, trainingId: trainingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageTrainingRequest.getKnowledgeKnowledgebaseLanguageTraining was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaselanguagetrainings": { - "operationId": "getknowledgeknowledgebaselanguagetrainings", - "functionName": "getKnowledgeKnowledgebaseLanguageTrainings", - "signature": "getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, before, after, limit, pageSize, knowledgeDocumentsState)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "knowledgeDocumentsState", - "type": "String", - "required": "false" - } - ], - "return": "TrainingListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: GetKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTrainings = GetKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTrainings.enummember // Language code, format: iso2-LOCALE\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet knowledgeDocumentsState: GetKnowledgeKnowledgebaseLanguageTrainingsRequest.KnowledgeDocumentsState_getKnowledgeKnowledgebaseLanguageTrainings = GetKnowledgeKnowledgebaseLanguageTrainingsRequest.KnowledgeDocumentsState_getKnowledgeKnowledgebaseLanguageTrainings.enummember // Return the training with the specified state of the trained documents.\n\n// Get all trainings information for a knowledgebase\nGetKnowledgeKnowledgebaseLanguageTrainingsRequest.getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, knowledgeDocumentsState: knowledgeDocumentsState) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseLanguageTrainingsRequest.getKnowledgeKnowledgebaseLanguageTrainings was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaseunansweredgroup": { - "operationId": "getknowledgeknowledgebaseunansweredgroup", - "functionName": "getKnowledgeKnowledgebaseUnansweredGroup", - "signature": "getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, app, dateStart, dateEnd)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "app", - "type": "String", - "required": "false" - }, - { - "name": "dateStart", - "type": "Date", - "required": "false" - }, - { - "name": "dateEnd", - "type": "Date", - "required": "false" - } - ], - "return": "UnansweredGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet groupId: String = \"\" // The ID of the group to be retrieved.\nlet app: GetKnowledgeKnowledgebaseUnansweredGroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroup = GetKnowledgeKnowledgebaseUnansweredGroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroup.enummember // The app value to be used for filtering phrases.\nlet dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get knowledge base unanswered group for a particular groupId\nGetKnowledgeKnowledgebaseUnansweredGroupRequest.getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseUnansweredGroupRequest.getKnowledgeKnowledgebaseUnansweredGroup was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaseunansweredgroupphrasegroup": { - "operationId": "getknowledgeknowledgebaseunansweredgroupphrasegroup", - "functionName": "getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup", - "signature": "getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, app, dateStart, dateEnd)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "phraseGroupId", - "type": "String", - "required": "true" - }, - { - "name": "app", - "type": "String", - "required": "false" - }, - { - "name": "dateStart", - "type": "Date", - "required": "false" - }, - { - "name": "dateEnd", - "type": "Date", - "required": "false" - } - ], - "return": "UnansweredPhraseGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet groupId: String = \"\" // The ID of the group to be retrieved.\nlet phraseGroupId: String = \"\" // The ID of the phraseGroup to be retrieved.\nlet app: GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup = GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup.enummember // The app value to be used for filtering phrases.\nlet dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get knowledge base unanswered phrase group for a particular phraseGroupId\nGetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, phraseGroupId: phraseGroupId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebaseunansweredgroups": { - "operationId": "getknowledgeknowledgebaseunansweredgroups", - "functionName": "getKnowledgeKnowledgebaseUnansweredGroups", - "signature": "getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, app, dateStart, dateEnd)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "app", - "type": "String", - "required": "false" - }, - { - "name": "dateStart", - "type": "Date", - "required": "false" - }, - { - "name": "dateEnd", - "type": "Date", - "required": "false" - } - ], - "return": "UnansweredGroups", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet app: GetKnowledgeKnowledgebaseUnansweredGroupsRequest.App_getKnowledgeKnowledgebaseUnansweredGroups = GetKnowledgeKnowledgebaseUnansweredGroupsRequest.App_getKnowledgeKnowledgebaseUnansweredGroups.enummember // The app value to be used for filtering phrases.\nlet dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\n\n// Get knowledge base unanswered groups\nGetKnowledgeKnowledgebaseUnansweredGroupsRequest.getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId: knowledgeBaseId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebaseUnansweredGroupsRequest.getKnowledgeKnowledgebaseUnansweredGroups was successful\")\n dump(response)\n }\n}" - }, - "getknowledgeknowledgebases": { - "operationId": "getknowledgeknowledgebases", - "functionName": "getKnowledgeKnowledgebases", - "signature": "getKnowledgeKnowledgebases(before, after, limit, pageSize, name, coreLanguage, published, sortBy, sortOrder)", - "parameters": [ - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "coreLanguage", - "type": "String", - "required": "false" - }, - { - "name": "published", - "type": "Bool", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "KnowledgeBaseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 100. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 100.\nlet name: String = \"\" // Filter by Name.\nlet coreLanguage: GetKnowledgeKnowledgebasesRequest.CoreLanguage_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.CoreLanguage_getKnowledgeKnowledgebases.enummember // Filter by core language.\nlet published: Bool = true // Filter by published status.\nlet sortBy: GetKnowledgeKnowledgebasesRequest.SortBy_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.SortBy_getKnowledgeKnowledgebases.enummember // Sort by.\nlet sortOrder: GetKnowledgeKnowledgebasesRequest.SortOrder_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.SortOrder_getKnowledgeKnowledgebases.enummember // Sort Order.\n\n// Get knowledge bases\nGetKnowledgeKnowledgebasesRequest.getKnowledgeKnowledgebases(before: before, after: after, limit: limit, pageSize: pageSize, name: name, coreLanguage: coreLanguage, published: published, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetKnowledgeKnowledgebasesRequest.getKnowledgeKnowledgebases was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeguestsessiondocumentssearchsearchid": { - "operationId": "patchknowledgeguestsessiondocumentssearchsearchid", - "functionName": "patchKnowledgeGuestSessionDocumentsSearchSearchId", - "signature": "patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "searchId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SearchUpdateRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet searchId: String = \"\" // Search Result ID\nlet body: SearchUpdateRequest = new SearchUpdateRequest(...) // \n\n// Update search result.\nPatchKnowledgeGuestSessionDocumentsSearchSearchIdRequest.patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId: sessionId, searchId: searchId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchKnowledgeGuestSessionDocumentsSearchSearchIdRequest.patchKnowledgeGuestSessionDocumentsSearchSearchId was successful\")\n }\n}" - }, - "patchknowledgeknowledgebase": { - "operationId": "patchknowledgeknowledgebase", - "functionName": "patchKnowledgeKnowledgebase", - "signature": "patchKnowledgeKnowledgebase(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeBaseUpdateRequest", - "required": "true" - } - ], - "return": "KnowledgeBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: KnowledgeBaseUpdateRequest = new KnowledgeBaseUpdateRequest(...) // \n\n// Update knowledge base\nPatchKnowledgeKnowledgebaseRequest.patchKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseRequest.patchKnowledgeKnowledgebase was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebasecategory": { - "operationId": "patchknowledgeknowledgebasecategory", - "functionName": "patchKnowledgeKnowledgebaseCategory", - "signature": "patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "categoryId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CategoryUpdateRequest", - "required": "true" - } - ], - "return": "CategoryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet categoryId: String = \"\" // Category ID\nlet body: CategoryUpdateRequest = new CategoryUpdateRequest(...) // \n\n// Update category\nPatchKnowledgeKnowledgebaseCategoryRequest.patchKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseCategoryRequest.patchKnowledgeKnowledgebaseCategory was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebasedocument": { - "operationId": "patchknowledgeknowledgebasedocument", - "functionName": "patchKnowledgeKnowledgebaseDocument", - "signature": "patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentReq", - "required": "true" - } - ], - "return": "KnowledgeDocumentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet body: KnowledgeDocumentReq = new KnowledgeDocumentReq(...) // \n\n// Update document.\nPatchKnowledgeKnowledgebaseDocumentRequest.patchKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseDocumentRequest.patchKnowledgeKnowledgebaseDocument was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebasedocumentvariation": { - "operationId": "patchknowledgeknowledgebasedocumentvariation", - "functionName": "patchKnowledgeKnowledgebaseDocumentVariation", - "signature": "patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body)", - "parameters": [ - { - "name": "documentVariationId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DocumentVariation", - "required": "true" - } - ], - "return": "DocumentVariation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentVariationId: String = \"\" // Globally unique identifier for a document variation.\nlet documentId: String = \"\" // Globally unique identifier for a document.\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for a knowledge base.\nlet body: DocumentVariation = new DocumentVariation(...) // \n\n// Update a variation for a document.\nPatchKnowledgeKnowledgebaseDocumentVariationRequest.patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseDocumentVariationRequest.patchKnowledgeKnowledgebaseDocumentVariation was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebasedocumentssearchsearchid": { - "operationId": "patchknowledgeknowledgebasedocumentssearchsearchid", - "functionName": "patchKnowledgeKnowledgebaseDocumentsSearchSearchId", - "signature": "patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "searchId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SearchUpdateRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // The ID of knowledge base containing the documents to query.\nlet searchId: String = \"\" // Search Result ID\nlet body: SearchUpdateRequest = new SearchUpdateRequest(...) // \n\n// Update search result.\nPatchKnowledgeKnowledgebaseDocumentsSearchSearchIdRequest.patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId: knowledgeBaseId, searchId: searchId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchKnowledgeKnowledgebaseDocumentsSearchSearchIdRequest.patchKnowledgeKnowledgebaseDocumentsSearchSearchId was successful\")\n }\n}" - }, - "patchknowledgeknowledgebaseimportjob": { - "operationId": "patchknowledgeknowledgebaseimportjob", - "functionName": "patchKnowledgeKnowledgebaseImportJob", - "signature": "patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "importJobId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ImportStatusRequest", - "required": "true" - } - ], - "return": "KnowledgeImportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet importJobId: String = \"\" // Import job ID\nlet body: ImportStatusRequest = new ImportStatusRequest(...) // \n\n// Start import job\nPatchKnowledgeKnowledgebaseImportJobRequest.patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseImportJobRequest.patchKnowledgeKnowledgebaseImportJob was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaselabel": { - "operationId": "patchknowledgeknowledgebaselabel", - "functionName": "patchKnowledgeKnowledgebaseLabel", - "signature": "patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "labelId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LabelUpdateRequest", - "required": "true" - } - ], - "return": "LabelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet labelId: String = \"\" // Label ID\nlet body: LabelUpdateRequest = new LabelUpdateRequest(...) // \n\n// Update label\nPatchKnowledgeKnowledgebaseLabelRequest.patchKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseLabelRequest.patchKnowledgeKnowledgebaseLabel was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaselanguagecategory": { - "operationId": "patchknowledgeknowledgebaselanguagecategory", - "functionName": "patchKnowledgeKnowledgebaseLanguageCategory", - "signature": "patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "categoryId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeCategoryRequest", - "required": "true" - } - ], - "return": "KnowledgeExtendedCategory", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet categoryId: String = \"\" // Category ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PatchKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageCategory = PatchKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE\nlet body: KnowledgeCategoryRequest = new KnowledgeCategoryRequest(...) // \n\n// Update category\nPatchKnowledgeKnowledgebaseLanguageCategoryRequest.patchKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseLanguageCategoryRequest.patchKnowledgeKnowledgebaseLanguageCategory was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaselanguagedocument": { - "operationId": "patchknowledgeknowledgebaselanguagedocument", - "functionName": "patchKnowledgeKnowledgebaseLanguageDocument", - "signature": "patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentRequest", - "required": "true" - } - ], - "return": "KnowledgeDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet documentId: String = \"\" // Document ID\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocument = PatchKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE\nlet body: KnowledgeDocumentRequest = new KnowledgeDocumentRequest(...) // \n\n// Update document\nPatchKnowledgeKnowledgebaseLanguageDocumentRequest.patchKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseLanguageDocumentRequest.patchKnowledgeKnowledgebaseLanguageDocument was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaselanguagedocuments": { - "operationId": "patchknowledgeknowledgebaselanguagedocuments", - "functionName": "patchKnowledgeKnowledgebaseLanguageDocuments", - "signature": "patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[KnowledgeDocumentBulkRequest]", - "required": "true" - } - ], - "return": "DocumentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocuments = PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE\nlet body: [KnowledgeDocumentBulkRequest] = [new KnowledgeDocumentBulkRequest(...)] // \n\n// Update documents collection\nPatchKnowledgeKnowledgebaseLanguageDocumentsRequest.patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.patchKnowledgeKnowledgebaseLanguageDocuments was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaselanguagedocumentsimport": { - "operationId": "patchknowledgeknowledgebaselanguagedocumentsimport", - "functionName": "patchKnowledgeKnowledgebaseLanguageDocumentsImport", - "signature": "patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "importId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ImportStatusRequest", - "required": "true" - } - ], - "return": "KnowledgeImport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocumentsImport = PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE\nlet importId: String = \"\" // Import ID\nlet body: ImportStatusRequest = new ImportStatusRequest(...) // \n\n// Start import operation\nPatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.patchKnowledgeKnowledgebaseLanguageDocumentsImport was successful\")\n dump(response)\n }\n}" - }, - "patchknowledgeknowledgebaseunansweredgroupphrasegroup": { - "operationId": "patchknowledgeknowledgebaseunansweredgroupphrasegroup", - "functionName": "patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup", - "signature": "patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "phraseGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UnansweredPhraseGroupPatchRequestBody", - "required": "true" - } - ], - "return": "UnansweredPhraseGroupUpdateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet groupId: String = \"\" // The ID of the group to be updated.\nlet phraseGroupId: String = \"\" // The ID of the phraseGroup to be updated.\nlet body: UnansweredPhraseGroupPatchRequestBody = new UnansweredPhraseGroupPatchRequestBody(...) // Request body of the update unanswered group endpoint.\n\n// Update a Knowledge base unanswered phrase group\nPatchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, phraseGroupId: phraseGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup was successful\")\n dump(response)\n }\n}" - }, - "postknowledgedocumentuploads": { - "operationId": "postknowledgedocumentuploads", - "functionName": "postKnowledgeDocumentuploads", - "signature": "postKnowledgeDocumentuploads(body)", - "parameters": [ - { - "name": "body", - "type": "UploadUrlRequest", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UploadUrlRequest = new UploadUrlRequest(...) // query\n\n// Creates a presigned URL for uploading a knowledge import file with a set of documents\nPostKnowledgeDocumentuploadsRequest.postKnowledgeDocumentuploads(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeDocumentuploadsRequest.postKnowledgeDocumentuploads was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeguestsessiondocumentfeedback": { - "operationId": "postknowledgeguestsessiondocumentfeedback", - "functionName": "postKnowledgeGuestSessionDocumentFeedback", - "signature": "postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, body)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeGuestDocumentFeedback", - "required": "false" - } - ], - "return": "KnowledgeGuestDocumentFeedback", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet documentId: String = \"\" // Document ID.\nlet body: KnowledgeGuestDocumentFeedback = new KnowledgeGuestDocumentFeedback(...) // \n\n// Give feedback on a document\nPostKnowledgeGuestSessionDocumentFeedbackRequest.postKnowledgeGuestSessionDocumentFeedback(sessionId: sessionId, documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeGuestSessionDocumentFeedbackRequest.postKnowledgeGuestSessionDocumentFeedback was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeguestsessiondocumentssearch": { - "operationId": "postknowledgeguestsessiondocumentssearch", - "functionName": "postKnowledgeGuestSessionDocumentsSearch", - "signature": "postKnowledgeGuestSessionDocumentsSearch(sessionId, expand, body)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "body", - "type": "KnowledgeDocumentGuestSearchRequest", - "required": "false" - } - ], - "return": "KnowledgeDocumentGuestSearch", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet expand: [String] = [\"\"] // Fields, if any, to expand for each document in the search result matching the query.\nlet body: KnowledgeDocumentGuestSearchRequest = new KnowledgeDocumentGuestSearchRequest(...) // \n\n// Search the documents in a guest session.\nPostKnowledgeGuestSessionDocumentsSearchRequest.postKnowledgeGuestSessionDocumentsSearch(sessionId: sessionId, expand: expand, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeGuestSessionDocumentsSearchRequest.postKnowledgeGuestSessionDocumentsSearch was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeguestsessiondocumentssearchsuggestions": { - "operationId": "postknowledgeguestsessiondocumentssearchsuggestions", - "functionName": "postKnowledgeGuestSessionDocumentsSearchSuggestions", - "signature": "postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, body)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeGuestDocumentSuggestionRequest", - "required": "false" - } - ], - "return": "KnowledgeGuestDocumentSuggestion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // Knowledge guest session ID.\nlet body: KnowledgeGuestDocumentSuggestionRequest = new KnowledgeGuestDocumentSuggestionRequest(...) // \n\n// Query the knowledge documents to provide suggestions for auto completion.\nPostKnowledgeGuestSessionDocumentsSearchSuggestionsRequest.postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId: sessionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeGuestSessionDocumentsSearchSuggestionsRequest.postKnowledgeGuestSessionDocumentsSearchSuggestions was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeguestsessions": { - "operationId": "postknowledgeguestsessions", - "functionName": "postKnowledgeGuestSessions", - "signature": "postKnowledgeGuestSessions(body)", - "parameters": [ - { - "name": "body", - "type": "KnowledgeGuestSession", - "required": "true" - } - ], - "return": "KnowledgeGuestSession", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: KnowledgeGuestSession = new KnowledgeGuestSession(...) // \n\n// Create guest session\nPostKnowledgeGuestSessionsRequest.postKnowledgeGuestSessions(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeGuestSessionsRequest.postKnowledgeGuestSessions was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasecategories": { - "operationId": "postknowledgeknowledgebasecategories", - "functionName": "postKnowledgeKnowledgebaseCategories", - "signature": "postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CategoryCreateRequest", - "required": "true" - } - ], - "return": "CategoryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: CategoryCreateRequest = new CategoryCreateRequest(...) // \n\n// Create new category\nPostKnowledgeKnowledgebaseCategoriesRequest.postKnowledgeKnowledgebaseCategories(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseCategoriesRequest.postKnowledgeKnowledgebaseCategories was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentfeedback": { - "operationId": "postknowledgeknowledgebasedocumentfeedback", - "functionName": "postKnowledgeKnowledgebaseDocumentFeedback", - "signature": "postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentFeedback", - "required": "false" - } - ], - "return": "KnowledgeDocumentFeedbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet body: KnowledgeDocumentFeedback = new KnowledgeDocumentFeedback(...) // \n\n// Give feedback on a document\nPostKnowledgeKnowledgebaseDocumentFeedbackRequest.postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentFeedbackRequest.postKnowledgeKnowledgebaseDocumentFeedback was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentvariations": { - "operationId": "postknowledgeknowledgebasedocumentvariations", - "functionName": "postKnowledgeKnowledgebaseDocumentVariations", - "signature": "postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DocumentVariation", - "required": "true" - } - ], - "return": "DocumentVariation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet body: DocumentVariation = new DocumentVariation(...) // \n\n// Create a variation for a document.\nPostKnowledgeKnowledgebaseDocumentVariationsRequest.postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentVariationsRequest.postKnowledgeKnowledgebaseDocumentVariations was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentversions": { - "operationId": "postknowledgeknowledgebasedocumentversions", - "functionName": "postKnowledgeKnowledgebaseDocumentVersions", - "signature": "postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentVersion", - "required": "true" - } - ], - "return": "KnowledgeDocumentVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Globally unique identifier for the knowledge base.\nlet documentId: String = \"\" // Globally unique identifier for the document.\nlet body: KnowledgeDocumentVersion = new KnowledgeDocumentVersion(...) // \n\n// Creates or restores a document version.\nPostKnowledgeKnowledgebaseDocumentVersionsRequest.postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentVersionsRequest.postKnowledgeKnowledgebaseDocumentVersions was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentviews": { - "operationId": "postknowledgeknowledgebasedocumentviews", - "functionName": "postKnowledgeKnowledgebaseDocumentViews", - "signature": "postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "documentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentView", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID.\nlet documentId: String = \"\" // Document ID.\nlet body: KnowledgeDocumentView = new KnowledgeDocumentView(...) // \n\n// Create view for a document.\nPostKnowledgeKnowledgebaseDocumentViewsRequest.postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostKnowledgeKnowledgebaseDocumentViewsRequest.postKnowledgeKnowledgebaseDocumentViews was successful\")\n }\n}" - }, - "postknowledgeknowledgebasedocuments": { - "operationId": "postknowledgeknowledgebasedocuments", - "functionName": "postKnowledgeKnowledgebaseDocuments", - "signature": "postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentReq", - "required": "true" - } - ], - "return": "KnowledgeDocumentResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: KnowledgeDocumentReq = new KnowledgeDocumentReq(...) // \n\n// Create document.\nPostKnowledgeKnowledgebaseDocumentsRequest.postKnowledgeKnowledgebaseDocuments(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentsRequest.postKnowledgeKnowledgebaseDocuments was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentssearch": { - "operationId": "postknowledgeknowledgebasedocumentssearch", - "functionName": "postKnowledgeKnowledgebaseDocumentsSearch", - "signature": "postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, expand, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "body", - "type": "KnowledgeDocumentSearchRequest", - "required": "false" - } - ], - "return": "KnowledgeDocumentSearch", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // The ID of knowledge base containing the documents to query.\nlet expand: [String] = [\"\"] // Fields, if any, to expand for each document in the search result matching the query.\nlet body: KnowledgeDocumentSearchRequest = new KnowledgeDocumentSearchRequest(...) // \n\n// Search the documents in a knowledge base.\nPostKnowledgeKnowledgebaseDocumentsSearchRequest.postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId: knowledgeBaseId, expand: expand, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentsSearchRequest.postKnowledgeKnowledgebaseDocumentsSearch was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasedocumentssearchsuggestions": { - "operationId": "postknowledgeknowledgebasedocumentssearchsuggestions", - "functionName": "postKnowledgeKnowledgebaseDocumentsSearchSuggestions", - "signature": "postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentSuggestionRequest", - "required": "false" - } - ], - "return": "KnowledgeDocumentSuggestion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // The ID of knowledge base containing the documents to query.\nlet body: KnowledgeDocumentSuggestionRequest = new KnowledgeDocumentSuggestionRequest(...) // \n\n// Query the knowledge documents to provide suggestions for auto completion.\nPostKnowledgeKnowledgebaseDocumentsSearchSuggestionsRequest.postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseDocumentsSearchSuggestionsRequest.postKnowledgeKnowledgebaseDocumentsSearchSuggestions was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaseexportjobs": { - "operationId": "postknowledgeknowledgebaseexportjobs", - "functionName": "postKnowledgeKnowledgebaseExportJobs", - "signature": "postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeExportJobRequest", - "required": "true" - } - ], - "return": "KnowledgeExportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: KnowledgeExportJobRequest = new KnowledgeExportJobRequest(...) // \n\n// Create export job\nPostKnowledgeKnowledgebaseExportJobsRequest.postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseExportJobsRequest.postKnowledgeKnowledgebaseExportJobs was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaseimportjobs": { - "operationId": "postknowledgeknowledgebaseimportjobs", - "functionName": "postKnowledgeKnowledgebaseImportJobs", - "signature": "postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeImportJobRequest", - "required": "true" - } - ], - "return": "KnowledgeImportJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: KnowledgeImportJobRequest = new KnowledgeImportJobRequest(...) // \n\n// Create import job\nPostKnowledgeKnowledgebaseImportJobsRequest.postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseImportJobsRequest.postKnowledgeKnowledgebaseImportJobs was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselabels": { - "operationId": "postknowledgeknowledgebaselabels", - "functionName": "postKnowledgeKnowledgebaseLabels", - "signature": "postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LabelCreateRequest", - "required": "true" - } - ], - "return": "LabelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: LabelCreateRequest = new LabelCreateRequest(...) // \n\n// Create new label\nPostKnowledgeKnowledgebaseLabelsRequest.postKnowledgeKnowledgebaseLabels(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLabelsRequest.postKnowledgeKnowledgebaseLabels was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselanguagecategories": { - "operationId": "postknowledgeknowledgebaselanguagecategories", - "functionName": "postKnowledgeKnowledgebaseLanguageCategories", - "signature": "postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeCategoryRequest", - "required": "true" - } - ], - "return": "KnowledgeExtendedCategory", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PostKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageCategories = PostKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageCategories.enummember // Language code, format: iso2-LOCALE\nlet body: KnowledgeCategoryRequest = new KnowledgeCategoryRequest(...) // \n\n// Create new category\nPostKnowledgeKnowledgebaseLanguageCategoriesRequest.postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLanguageCategoriesRequest.postKnowledgeKnowledgebaseLanguageCategories was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselanguagedocuments": { - "operationId": "postknowledgeknowledgebaselanguagedocuments", - "functionName": "postKnowledgeKnowledgebaseLanguageDocuments", - "signature": "postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeDocumentRequest", - "required": "true" - } - ], - "return": "KnowledgeDocument", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PostKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocuments = PostKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE\nlet body: KnowledgeDocumentRequest = new KnowledgeDocumentRequest(...) // \n\n// Create document\nPostKnowledgeKnowledgebaseLanguageDocumentsRequest.postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLanguageDocumentsRequest.postKnowledgeKnowledgebaseLanguageDocuments was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselanguagedocumentsimports": { - "operationId": "postknowledgeknowledgebaselanguagedocumentsimports", - "functionName": "postKnowledgeKnowledgebaseLanguageDocumentsImports", - "signature": "postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeImport", - "required": "true" - } - ], - "return": "KnowledgeImport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocumentsImports = PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocumentsImports.enummember // Language code, format: iso2-LOCALE\nlet body: KnowledgeImport = new KnowledgeImport(...) // \n\n// Create import operation\nPostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.postKnowledgeKnowledgebaseLanguageDocumentsImports was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselanguagetrainingpromote": { - "operationId": "postknowledgeknowledgebaselanguagetrainingpromote", - "functionName": "postKnowledgeKnowledgebaseLanguageTrainingPromote", - "signature": "postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - }, - { - "name": "trainingId", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeTraining", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainingPromote = PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainingPromote.enummember // Language code, format: iso2-LOCALE\nlet trainingId: String = \"\" // Training ID\n\n// Promote trained documents from draft state to active.\nPostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, trainingId: trainingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.postKnowledgeKnowledgebaseLanguageTrainingPromote was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebaselanguagetrainings": { - "operationId": "postknowledgeknowledgebaselanguagetrainings", - "functionName": "postKnowledgeKnowledgebaseLanguageTrainings", - "signature": "postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "languageCode", - "type": "String", - "required": "true" - } - ], - "return": "KnowledgeTraining", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet languageCode: PostKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainings = PostKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainings.enummember // Language code, format: iso2-LOCALE\n\n// Trigger training\nPostKnowledgeKnowledgebaseLanguageTrainingsRequest.postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseLanguageTrainingsRequest.postKnowledgeKnowledgebaseLanguageTrainings was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebasesearch": { - "operationId": "postknowledgeknowledgebasesearch", - "functionName": "postKnowledgeKnowledgebaseSearch", - "signature": "postKnowledgeKnowledgebaseSearch(knowledgeBaseId, body)", - "parameters": [ - { - "name": "knowledgeBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "KnowledgeSearchRequest", - "required": "false" - } - ], - "return": "KnowledgeSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet knowledgeBaseId: String = \"\" // Knowledge base ID\nlet body: KnowledgeSearchRequest = new KnowledgeSearchRequest(...) // \n\n// Search Documents\nPostKnowledgeKnowledgebaseSearchRequest.postKnowledgeKnowledgebaseSearch(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebaseSearchRequest.postKnowledgeKnowledgebaseSearch was successful\")\n dump(response)\n }\n}" - }, - "postknowledgeknowledgebases": { - "operationId": "postknowledgeknowledgebases", - "functionName": "postKnowledgeKnowledgebases", - "signature": "postKnowledgeKnowledgebases(body)", - "parameters": [ - { - "name": "body", - "type": "KnowledgeBaseCreateRequest", - "required": "true" - } - ], - "return": "KnowledgeBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: KnowledgeBaseCreateRequest = new KnowledgeBaseCreateRequest(...) // \n\n// Create new knowledge base\nPostKnowledgeKnowledgebasesRequest.postKnowledgeKnowledgebases(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostKnowledgeKnowledgebasesRequest.postKnowledgeKnowledgebases was successful\")\n dump(response)\n }\n}" - }, - "deletelanguageunderstandingdomain": { - "operationId": "deletelanguageunderstandingdomain", - "functionName": "deleteLanguageunderstandingDomain", - "signature": "deleteLanguageunderstandingDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\n\n// Delete an NLU Domain.\nDeleteLanguageunderstandingDomainRequest.deleteLanguageunderstandingDomain(domainId: domainId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageunderstandingDomainRequest.deleteLanguageunderstandingDomain was successful\")\n }\n}" - }, - "deletelanguageunderstandingdomainfeedbackfeedbackid": { - "operationId": "deletelanguageunderstandingdomainfeedbackfeedbackid", - "functionName": "deleteLanguageunderstandingDomainFeedbackFeedbackId", - "signature": "deleteLanguageunderstandingDomainFeedbackFeedbackId(domainId, feedbackId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "feedbackId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet feedbackId: String = \"\" // ID of the Feedback\n\n// Delete the feedback on the NLU Domain Version.\nDeleteLanguageunderstandingDomainFeedbackFeedbackIdRequest.deleteLanguageunderstandingDomainFeedbackFeedbackId(domainId: domainId, feedbackId: feedbackId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageunderstandingDomainFeedbackFeedbackIdRequest.deleteLanguageunderstandingDomainFeedbackFeedbackId was successful\")\n }\n}" - }, - "deletelanguageunderstandingdomainversion": { - "operationId": "deletelanguageunderstandingdomainversion", - "functionName": "deleteLanguageunderstandingDomainVersion", - "signature": "deleteLanguageunderstandingDomainVersion(domainId, domainVersionId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\n\n// Delete an NLU Domain Version\nDeleteLanguageunderstandingDomainVersionRequest.deleteLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageunderstandingDomainVersionRequest.deleteLanguageunderstandingDomainVersion was successful\")\n }\n}" - }, - "deletelanguageunderstandingminer": { - "operationId": "deletelanguageunderstandingminer", - "functionName": "deleteLanguageunderstandingMiner", - "signature": "deleteLanguageunderstandingMiner(minerId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\n\n// Delete a miner.\nDeleteLanguageunderstandingMinerRequest.deleteLanguageunderstandingMiner(minerId: minerId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageunderstandingMinerRequest.deleteLanguageunderstandingMiner was successful\")\n }\n}" - }, - "deletelanguageunderstandingminerdraft": { - "operationId": "deletelanguageunderstandingminerdraft", - "functionName": "deleteLanguageunderstandingMinerDraft", - "signature": "deleteLanguageunderstandingMinerDraft(minerId, draftId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "draftId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet draftId: String = \"\" // Draft ID\n\n// Delete a draft\nDeleteLanguageunderstandingMinerDraftRequest.deleteLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageunderstandingMinerDraftRequest.deleteLanguageunderstandingMinerDraft was successful\")\n }\n}" - }, - "getlanguageunderstandingdomain": { - "operationId": "getlanguageunderstandingdomain", - "functionName": "getLanguageunderstandingDomain", - "signature": "getLanguageunderstandingDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "NluDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\n\n// Find an NLU Domain.\nGetLanguageunderstandingDomainRequest.getLanguageunderstandingDomain(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainRequest.getLanguageunderstandingDomain was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomainfeedback": { - "operationId": "getlanguageunderstandingdomainfeedback", - "functionName": "getLanguageunderstandingDomainFeedback", - "signature": "getLanguageunderstandingDomainFeedback(domainId, intentName, assessment, dateStart, dateEnd, includeDeleted, language, pageNumber, pageSize, enableCursorPagination, includeTrainingUtterances, after, fields)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "intentName", - "type": "String", - "required": "false" - }, - { - "name": "assessment", - "type": "String", - "required": "false" - }, - { - "name": "dateStart", - "type": "Date", - "required": "false" - }, - { - "name": "dateEnd", - "type": "Date", - "required": "false" - }, - { - "name": "includeDeleted", - "type": "Bool", - "required": "false" - }, - { - "name": "language", - "type": "String", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "enableCursorPagination", - "type": "Bool", - "required": "false" - }, - { - "name": "includeTrainingUtterances", - "type": "Bool", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "fields", - "type": "[String]", - "required": "false" - } - ], - "return": "NluFeedbackListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet intentName: String = \"\" // The top intent name to retrieve feedback for.\nlet assessment: GetLanguageunderstandingDomainFeedbackRequest.Assessment_getLanguageunderstandingDomainFeedback = GetLanguageunderstandingDomainFeedbackRequest.Assessment_getLanguageunderstandingDomainFeedback.enummember // The top assessment to retrieve feedback for.\nlet dateStart: Date = new Date(...) // Begin of time window as ISO-8601 date.\nlet dateEnd: Date = new Date(...) // End of time window as ISO-8601 date.\nlet includeDeleted: Bool = true // Whether to include soft-deleted items in the result.\nlet language: String = \"\" // Whether to filter response based on the language, e.g. en-us, pt-br.\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet enableCursorPagination: Bool = true // Enable Cursor Pagination\nlet includeTrainingUtterances: Bool = true // Include Training Utterances. By default they're included.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true\nlet fields: [String] = [\"\"] // Fields and properties to get, comma-separated\n\n// Get all feedback in the given NLU Domain Version.\nGetLanguageunderstandingDomainFeedbackRequest.getLanguageunderstandingDomainFeedback(domainId: domainId, intentName: intentName, assessment: assessment, dateStart: dateStart, dateEnd: dateEnd, includeDeleted: includeDeleted, language: language, pageNumber: pageNumber, pageSize: pageSize, enableCursorPagination: enableCursorPagination, includeTrainingUtterances: includeTrainingUtterances, after: after, fields: fields) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainFeedbackRequest.getLanguageunderstandingDomainFeedback was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomainfeedbackfeedbackid": { - "operationId": "getlanguageunderstandingdomainfeedbackfeedbackid", - "functionName": "getLanguageunderstandingDomainFeedbackFeedbackId", - "signature": "getLanguageunderstandingDomainFeedbackFeedbackId(domainId, feedbackId, fields)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "feedbackId", - "type": "String", - "required": "true" - }, - { - "name": "fields", - "type": "[String]", - "required": "false" - } - ], - "return": "NluFeedbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet feedbackId: String = \"\" // ID of the Feedback\nlet fields: [String] = [\"\"] // Fields and properties to get, comma-separated\n\n// Find a Feedback\nGetLanguageunderstandingDomainFeedbackFeedbackIdRequest.getLanguageunderstandingDomainFeedbackFeedbackId(domainId: domainId, feedbackId: feedbackId, fields: fields) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainFeedbackFeedbackIdRequest.getLanguageunderstandingDomainFeedbackFeedbackId was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomainversion": { - "operationId": "getlanguageunderstandingdomainversion", - "functionName": "getLanguageunderstandingDomainVersion", - "signature": "getLanguageunderstandingDomainVersion(domainId, domainVersionId, includeUtterances)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - }, - { - "name": "includeUtterances", - "type": "Bool", - "required": "false" - } - ], - "return": "NluDomainVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\nlet includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response.\n\n// Find an NLU Domain Version.\nGetLanguageunderstandingDomainVersionRequest.getLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId, includeUtterances: includeUtterances) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainVersionRequest.getLanguageunderstandingDomainVersion was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomainversionreport": { - "operationId": "getlanguageunderstandingdomainversionreport", - "functionName": "getLanguageunderstandingDomainVersionReport", - "signature": "getLanguageunderstandingDomainVersionReport(domainId, domainVersionId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - } - ], - "return": "NluDomainVersionQualityReport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\n\n// Retrieved quality report for the specified NLU Domain Version\nGetLanguageunderstandingDomainVersionReportRequest.getLanguageunderstandingDomainVersionReport(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainVersionReportRequest.getLanguageunderstandingDomainVersionReport was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomainversions": { - "operationId": "getlanguageunderstandingdomainversions", - "functionName": "getLanguageunderstandingDomainVersions", - "signature": "getLanguageunderstandingDomainVersions(domainId, includeUtterances, pageNumber, pageSize)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "includeUtterances", - "type": "Bool", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "NluDomainVersionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response.\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get all NLU Domain Versions for a given Domain.\nGetLanguageunderstandingDomainVersionsRequest.getLanguageunderstandingDomainVersions(domainId: domainId, includeUtterances: includeUtterances, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainVersionsRequest.getLanguageunderstandingDomainVersions was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingdomains": { - "operationId": "getlanguageunderstandingdomains", - "functionName": "getLanguageunderstandingDomains", - "signature": "getLanguageunderstandingDomains(pageNumber, pageSize)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "NluDomainListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\n\n// Get all NLU Domains.\nGetLanguageunderstandingDomainsRequest.getLanguageunderstandingDomains(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingDomainsRequest.getLanguageunderstandingDomains was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminer": { - "operationId": "getlanguageunderstandingminer", - "functionName": "getLanguageunderstandingMiner", - "signature": "getLanguageunderstandingMiner(minerId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - } - ], - "return": "Miner", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\n\n// Get information about a miner.\nGetLanguageunderstandingMinerRequest.getLanguageunderstandingMiner(minerId: minerId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerRequest.getLanguageunderstandingMiner was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminerdraft": { - "operationId": "getlanguageunderstandingminerdraft", - "functionName": "getLanguageunderstandingMinerDraft", - "signature": "getLanguageunderstandingMinerDraft(minerId, draftId, draftIntentId, draftTopicId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "draftId", - "type": "String", - "required": "true" - }, - { - "name": "draftIntentId", - "type": "String", - "required": "false" - }, - { - "name": "draftTopicId", - "type": "String", - "required": "false" - } - ], - "return": "Draft", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet draftId: String = \"\" // Draft ID\nlet draftIntentId: String = \"\" // Parameter to filter a specific intent.\nlet draftTopicId: String = \"\" // Parameter to filter a specific topic.\n\n// Get information about a draft.\nGetLanguageunderstandingMinerDraftRequest.getLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId, draftIntentId: draftIntentId, draftTopicId: draftTopicId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerDraftRequest.getLanguageunderstandingMinerDraft was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminerdrafts": { - "operationId": "getlanguageunderstandingminerdrafts", - "functionName": "getLanguageunderstandingMinerDrafts", - "signature": "getLanguageunderstandingMinerDrafts(minerId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - } - ], - "return": "DraftListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\n\n// Retrieve the list of drafts created.\nGetLanguageunderstandingMinerDraftsRequest.getLanguageunderstandingMinerDrafts(minerId: minerId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerDraftsRequest.getLanguageunderstandingMinerDrafts was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminerintent": { - "operationId": "getlanguageunderstandingminerintent", - "functionName": "getLanguageunderstandingMinerIntent", - "signature": "getLanguageunderstandingMinerIntent(minerId, intentId, expand)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "intentId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "MinerIntent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet intentId: String = \"\" // The ID of the intent to be retrieved.\nlet expand: GetLanguageunderstandingMinerIntentRequest.Expand_getLanguageunderstandingMinerIntent = GetLanguageunderstandingMinerIntentRequest.Expand_getLanguageunderstandingMinerIntent.enummember // Option to fetch utterances\n\n// Get information about a mined intent\nGetLanguageunderstandingMinerIntentRequest.getLanguageunderstandingMinerIntent(minerId: minerId, intentId: intentId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerIntentRequest.getLanguageunderstandingMinerIntent was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminerintents": { - "operationId": "getlanguageunderstandingminerintents", - "functionName": "getLanguageunderstandingMinerIntents", - "signature": "getLanguageunderstandingMinerIntents(minerId, expand)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "MinedIntentsListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet expand: GetLanguageunderstandingMinerIntentsRequest.Expand_getLanguageunderstandingMinerIntents = GetLanguageunderstandingMinerIntentsRequest.Expand_getLanguageunderstandingMinerIntents.enummember // Option to fetch utterances.\n\n// Retrieve a list of mined intents.\nGetLanguageunderstandingMinerIntentsRequest.getLanguageunderstandingMinerIntents(minerId: minerId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerIntentsRequest.getLanguageunderstandingMinerIntents was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminertopic": { - "operationId": "getlanguageunderstandingminertopic", - "functionName": "getLanguageunderstandingMinerTopic", - "signature": "getLanguageunderstandingMinerTopic(minerId, topicId, expand)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "topicId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "MinerTopic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet topicId: String = \"\" // The ID of the topic to be retrieved.\nlet expand: GetLanguageunderstandingMinerTopicRequest.Expand_getLanguageunderstandingMinerTopic = GetLanguageunderstandingMinerTopicRequest.Expand_getLanguageunderstandingMinerTopic.enummember // Option to fetch phrases\n\n// Retrieves details of a particular topic.\nGetLanguageunderstandingMinerTopicRequest.getLanguageunderstandingMinerTopic(minerId: minerId, topicId: topicId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerTopicRequest.getLanguageunderstandingMinerTopic was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminertopicphrase": { - "operationId": "getlanguageunderstandingminertopicphrase", - "functionName": "getLanguageunderstandingMinerTopicPhrase", - "signature": "getLanguageunderstandingMinerTopicPhrase(minerId, topicId, phraseId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "topicId", - "type": "String", - "required": "true" - }, - { - "name": "phraseId", - "type": "String", - "required": "true" - } - ], - "return": "MinerTopicPhrase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet topicId: String = \"\" // The ID of the topic to be retrieved.\nlet phraseId: String = \"\" // The ID of the phrase to be retrieved.\n\n// Retrieves utterances related to a phrase in a topic.\nGetLanguageunderstandingMinerTopicPhraseRequest.getLanguageunderstandingMinerTopicPhrase(minerId: minerId, topicId: topicId, phraseId: phraseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerTopicPhraseRequest.getLanguageunderstandingMinerTopicPhrase was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminertopics": { - "operationId": "getlanguageunderstandingminertopics", - "functionName": "getLanguageunderstandingMinerTopics", - "signature": "getLanguageunderstandingMinerTopics(minerId)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - } - ], - "return": "MinerTopicsListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\n\n// Retrieve a list of mined topics.\nGetLanguageunderstandingMinerTopicsRequest.getLanguageunderstandingMinerTopics(minerId: minerId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinerTopicsRequest.getLanguageunderstandingMinerTopics was successful\")\n dump(response)\n }\n}" - }, - "getlanguageunderstandingminers": { - "operationId": "getlanguageunderstandingminers", - "functionName": "getLanguageunderstandingMiners", - "signature": "getLanguageunderstandingMiners(minerType)", - "parameters": [ - { - "name": "minerType", - "type": "String", - "required": "false" - } - ], - "return": "MinerListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerType: String = \"\" // Type of miner, either intent or topic\n\n// Retrieve the list of miners created.\nGetLanguageunderstandingMinersRequest.getLanguageunderstandingMiners(minerType: minerType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageunderstandingMinersRequest.getLanguageunderstandingMiners was successful\")\n dump(response)\n }\n}" - }, - "patchlanguageunderstandingdomain": { - "operationId": "patchlanguageunderstandingdomain", - "functionName": "patchLanguageunderstandingDomain", - "signature": "patchLanguageunderstandingDomain(domainId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "NluDomain", - "required": "true" - } - ], - "return": "NluDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet body: NluDomain = new NluDomain(...) // The updated NLU Domain.\n\n// Update an NLU Domain.\nPatchLanguageunderstandingDomainRequest.patchLanguageunderstandingDomain(domainId: domainId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchLanguageunderstandingDomainRequest.patchLanguageunderstandingDomain was successful\")\n dump(response)\n }\n}" - }, - "patchlanguageunderstandingminerdraft": { - "operationId": "patchlanguageunderstandingminerdraft", - "functionName": "patchLanguageunderstandingMinerDraft", - "signature": "patchLanguageunderstandingMinerDraft(minerId, draftId, body)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "draftId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DraftRequest", - "required": "false" - } - ], - "return": "Draft", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet draftId: String = \"\" // Draft ID\nlet body: DraftRequest = new DraftRequest(...) // \n\n// Save information for the draft. Either topic draft or intent draft should be sent.\nPatchLanguageunderstandingMinerDraftRequest.patchLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchLanguageunderstandingMinerDraftRequest.patchLanguageunderstandingMinerDraft was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomainfeedback": { - "operationId": "postlanguageunderstandingdomainfeedback", - "functionName": "postLanguageunderstandingDomainFeedback", - "signature": "postLanguageunderstandingDomainFeedback(domainId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "NluFeedbackRequest", - "required": "true" - } - ], - "return": "NluFeedbackResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet body: NluFeedbackRequest = new NluFeedbackRequest(...) // The Feedback to create.\n\n// Create feedback for the NLU Domain Version.\nPostLanguageunderstandingDomainFeedbackRequest.postLanguageunderstandingDomainFeedback(domainId: domainId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainFeedbackRequest.postLanguageunderstandingDomainFeedback was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomainversiondetect": { - "operationId": "postlanguageunderstandingdomainversiondetect", - "functionName": "postLanguageunderstandingDomainVersionDetect", - "signature": "postLanguageunderstandingDomainVersionDetect(domainId, domainVersionId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "NluDetectionRequest", - "required": "true" - } - ], - "return": "NluDetectionResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\nlet body: NluDetectionRequest = new NluDetectionRequest(...) // The input data to perform detection on.\n\n// Detect intent, entities, etc. in the submitted text using the specified NLU domain version.\nPostLanguageunderstandingDomainVersionDetectRequest.postLanguageunderstandingDomainVersionDetect(domainId: domainId, domainVersionId: domainVersionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainVersionDetectRequest.postLanguageunderstandingDomainVersionDetect was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomainversionpublish": { - "operationId": "postlanguageunderstandingdomainversionpublish", - "functionName": "postLanguageunderstandingDomainVersionPublish", - "signature": "postLanguageunderstandingDomainVersionPublish(domainId, domainVersionId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - } - ], - "return": "NluDomainVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\n\n// Publish the draft NLU Domain Version.\nPostLanguageunderstandingDomainVersionPublishRequest.postLanguageunderstandingDomainVersionPublish(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainVersionPublishRequest.postLanguageunderstandingDomainVersionPublish was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomainversiontrain": { - "operationId": "postlanguageunderstandingdomainversiontrain", - "functionName": "postLanguageunderstandingDomainVersionTrain", - "signature": "postLanguageunderstandingDomainVersionTrain(domainId, domainVersionId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - } - ], - "return": "NluDomainVersionTrainingResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\n\n// Train the draft NLU Domain Version.\nPostLanguageunderstandingDomainVersionTrainRequest.postLanguageunderstandingDomainVersionTrain(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainVersionTrainRequest.postLanguageunderstandingDomainVersionTrain was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomainversions": { - "operationId": "postlanguageunderstandingdomainversions", - "functionName": "postLanguageunderstandingDomainVersions", - "signature": "postLanguageunderstandingDomainVersions(domainId, body, includeUtterances)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "NluDomainVersion", - "required": "true" - }, - { - "name": "includeUtterances", - "type": "Bool", - "required": "false" - } - ], - "return": "NluDomainVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet body: NluDomainVersion = new NluDomainVersion(...) // The NLU Domain Version to create.\nlet includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response.\n\n// Create an NLU Domain Version.\nPostLanguageunderstandingDomainVersionsRequest.postLanguageunderstandingDomainVersions(domainId: domainId, body: body, includeUtterances: includeUtterances) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainVersionsRequest.postLanguageunderstandingDomainVersions was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingdomains": { - "operationId": "postlanguageunderstandingdomains", - "functionName": "postLanguageunderstandingDomains", - "signature": "postLanguageunderstandingDomains(body)", - "parameters": [ - { - "name": "body", - "type": "NluDomain", - "required": "true" - } - ], - "return": "NluDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: NluDomain = new NluDomain(...) // The NLU Domain to create.\n\n// Create an NLU Domain.\nPostLanguageunderstandingDomainsRequest.postLanguageunderstandingDomains(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingDomainsRequest.postLanguageunderstandingDomains was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingminerdrafts": { - "operationId": "postlanguageunderstandingminerdrafts", - "functionName": "postLanguageunderstandingMinerDrafts", - "signature": "postLanguageunderstandingMinerDrafts(minerId, body)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Draft", - "required": "true" - } - ], - "return": "Draft", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet body: Draft = new Draft(...) // Details for creating draft resource\n\n// Create a new draft resource.\nPostLanguageunderstandingMinerDraftsRequest.postLanguageunderstandingMinerDrafts(minerId: minerId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingMinerDraftsRequest.postLanguageunderstandingMinerDrafts was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingminerexecute": { - "operationId": "postlanguageunderstandingminerexecute", - "functionName": "postLanguageunderstandingMinerExecute", - "signature": "postLanguageunderstandingMinerExecute(minerId, body)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MinerExecuteRequest", - "required": "false" - } - ], - "return": "Miner", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet body: MinerExecuteRequest = new MinerExecuteRequest(...) // \n\n// Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.\nPostLanguageunderstandingMinerExecuteRequest.postLanguageunderstandingMinerExecute(minerId: minerId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingMinerExecuteRequest.postLanguageunderstandingMinerExecute was successful\")\n dump(response)\n }\n}" - }, - "postlanguageunderstandingminers": { - "operationId": "postlanguageunderstandingminers", - "functionName": "postLanguageunderstandingMiners", - "signature": "postLanguageunderstandingMiners(body)", - "parameters": [ - { - "name": "body", - "type": "Miner", - "required": "true" - } - ], - "return": "Miner", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Miner = new Miner(...) // Details for creating a new miner resource.\n\n// Create a unique miner.\nPostLanguageunderstandingMinersRequest.postLanguageunderstandingMiners(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingMinersRequest.postLanguageunderstandingMiners was successful\")\n dump(response)\n }\n}" - }, - "putlanguageunderstandingdomainversion": { - "operationId": "putlanguageunderstandingdomainversion", - "functionName": "putLanguageunderstandingDomainVersion", - "signature": "putLanguageunderstandingDomainVersion(domainId, domainVersionId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "domainVersionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "NluDomainVersion", - "required": "true" - } - ], - "return": "NluDomainVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // ID of the NLU domain.\nlet domainVersionId: String = \"\" // ID of the NLU domain version.\nlet body: NluDomainVersion = new NluDomainVersion(...) // The updated NLU Domain Version.\n\n// Update an NLU Domain Version.\nPutLanguageunderstandingDomainVersionRequest.putLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutLanguageunderstandingDomainVersionRequest.putLanguageunderstandingDomainVersion was successful\")\n dump(response)\n }\n}" - }, - "deletelanguage": { - "operationId": "deletelanguage", - "functionName": "deleteLanguage", - "signature": "deleteLanguage(languageId)", - "parameters": [ - { - "name": "languageId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet languageId: String = \"\" // Language ID\n\n// Delete Language (Deprecated)\nDeleteLanguageRequest.deleteLanguage(languageId: languageId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLanguageRequest.deleteLanguage was successful\")\n }\n}" - }, - "getlanguage": { - "operationId": "getlanguage", - "functionName": "getLanguage", - "signature": "getLanguage(languageId)", - "parameters": [ - { - "name": "languageId", - "type": "String", - "required": "true" - } - ], - "return": "Language", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet languageId: String = \"\" // Language ID\n\n// Get Language (Deprecated)\nGetLanguageRequest.getLanguage(languageId: languageId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguageRequest.getLanguage was successful\")\n dump(response)\n }\n}" - }, - "getlanguages": { - "operationId": "getlanguages", - "functionName": "getLanguages", - "signature": "getLanguages(pageSize, pageNumber, sortOrder, name)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "LanguageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetLanguagesRequest.SortOrder_getLanguages = GetLanguagesRequest.SortOrder_getLanguages.enummember // Ascending or descending sort order\nlet name: String = \"\" // Name\n\n// Get the list of supported languages. (Deprecated)\nGetLanguagesRequest.getLanguages(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguagesRequest.getLanguages was successful\")\n dump(response)\n }\n}" - }, - "getlanguagestranslations": { - "operationId": "getlanguagestranslations", - "functionName": "getLanguagesTranslations", - "signature": "getLanguagesTranslations()", - "return": "AvailableTranslations", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get all available languages for translation\nGetLanguagesTranslationsRequest.getLanguagesTranslations() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguagesTranslationsRequest.getLanguagesTranslations was successful\")\n dump(response)\n }\n}" - }, - "getlanguagestranslationsbuiltin": { - "operationId": "getlanguagestranslationsbuiltin", - "functionName": "getLanguagesTranslationsBuiltin", - "signature": "getLanguagesTranslationsBuiltin(language)", - "parameters": [ - { - "name": "language", - "type": "String", - "required": "true" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet language: String = \"\" // The language of the builtin translation to retrieve\n\n// Get the builtin translation for a language\nGetLanguagesTranslationsBuiltinRequest.getLanguagesTranslationsBuiltin(language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguagesTranslationsBuiltinRequest.getLanguagesTranslationsBuiltin was successful\")\n dump(response)\n }\n}" - }, - "getlanguagestranslationsorganization": { - "operationId": "getlanguagestranslationsorganization", - "functionName": "getLanguagesTranslationsOrganization", - "signature": "getLanguagesTranslationsOrganization(language)", - "parameters": [ - { - "name": "language", - "type": "String", - "required": "true" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet language: String = \"\" // The language of the translation to retrieve for the organization\n\n// Get effective translation for an organization by language\nGetLanguagesTranslationsOrganizationRequest.getLanguagesTranslationsOrganization(language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguagesTranslationsOrganizationRequest.getLanguagesTranslationsOrganization was successful\")\n dump(response)\n }\n}" - }, - "getlanguagestranslationsuser": { - "operationId": "getlanguagestranslationsuser", - "functionName": "getLanguagesTranslationsUser", - "signature": "getLanguagesTranslationsUser(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The user id\n\n// Get effective language translation for a user\nGetLanguagesTranslationsUserRequest.getLanguagesTranslationsUser(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLanguagesTranslationsUserRequest.getLanguagesTranslationsUser was successful\")\n dump(response)\n }\n}" - }, - "postlanguages": { - "operationId": "postlanguages", - "functionName": "postLanguages", - "signature": "postLanguages(body)", - "parameters": [ - { - "name": "body", - "type": "Language", - "required": "true" - } - ], - "return": "Language", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Language = new Language(...) // Language\n\n// Create Language (Deprecated)\nPostLanguagesRequest.postLanguages(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguagesRequest.postLanguages was successful\")\n dump(response)\n }\n}" - }, - "deletelearningassignment": { - "operationId": "deletelearningassignment", - "functionName": "deleteLearningAssignment", - "signature": "deleteLearningAssignment(assignmentId)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The Learning Assignment ID\n\n// Delete a learning assignment\nDeleteLearningAssignmentRequest.deleteLearningAssignment(assignmentId: assignmentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLearningAssignmentRequest.deleteLearningAssignment was successful\")\n }\n}" - }, - "deletelearningmodule": { - "operationId": "deletelearningmodule", - "functionName": "deleteLearningModule", - "signature": "deleteLearningModule(moduleId)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\n\n// Delete a learning module\nDeleteLearningModuleRequest.deleteLearningModule(moduleId: moduleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLearningModuleRequest.deleteLearningModule was successful\")\n }\n}" - }, - "getlearningassignment": { - "operationId": "getlearningassignment", - "functionName": "getLearningAssignment", - "signature": "getLearningAssignment(assignmentId, expand)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The ID of Learning Assignment\nlet expand: [String] = [\"\"] // Fields to expand in response\n\n// Get Learning Assignment\nGetLearningAssignmentRequest.getLearningAssignment(assignmentId: assignmentId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningAssignmentRequest.getLearningAssignment was successful\")\n dump(response)\n }\n}" - }, - "getlearningassignments": { - "operationId": "getlearningassignments", - "functionName": "getLearningAssignments", - "signature": "getLearningAssignments(moduleId, interval, completionInterval, overdue, pageSize, pageNumber, pass, minPercentageScore, maxPercentageScore, sortOrder, sortBy, userId, types, states, expand)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pass", - "type": "String", - "required": "false" - }, - { - "name": "minPercentageScore", - "type": "Float", - "required": "false" - }, - { - "name": "maxPercentageScore", - "type": "Float", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "userId", - "type": "[String]", - "required": "false" - }, - { - "name": "types", - "type": "[String]", - "required": "false" - }, - { - "name": "states", - "type": "[String]", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningAssignmentsDomainEntity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // Specifies the ID of the learning module. Fetch assignments for learning module ID\nlet interval: String = \"\" // Specifies the range of dueDates 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\nlet completionInterval: String = \"\" // 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\nlet overdue: GetLearningAssignmentsRequest.Overdue_getLearningAssignments = GetLearningAssignmentsRequest.Overdue_getLearningAssignments.enummember // Specifies if only the non-overdue (overdue is \\\"False\\\") or overdue (overdue is \\\"True\\\") assignments are returned. If overdue is \\\"Any\\\" or if the overdue parameter is not supplied, all assignments are returned\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet pass: GetLearningAssignmentsRequest.Pass_getLearningAssignments = GetLearningAssignmentsRequest.Pass_getLearningAssignments.enummember // Specifies if only the failed (pass is \\\"False\\\") or passed (pass is \\\"True\\\") assignments (completed with assessment)are returned. If pass is \\\"Any\\\" or if the pass parameter is not supplied, all assignments are returned\nlet minPercentageScore: Float = 0 // The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)\nlet maxPercentageScore: Float = 0 // The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)\nlet sortOrder: GetLearningAssignmentsRequest.SortOrder_getLearningAssignments = GetLearningAssignmentsRequest.SortOrder_getLearningAssignments.enummember // Specifies result set sort order; if not specified, default sort order is descending (Desc)\nlet sortBy: GetLearningAssignmentsRequest.SortBy_getLearningAssignments = GetLearningAssignmentsRequest.SortBy_getLearningAssignments.enummember // Specifies which field to sort the results by, default sort is by recommendedCompletionDate\nlet userId: [String] = [\"\"] // Specifies the list of user IDs to be queried, up to 100 user IDs.\nlet types: [String] = [\"\"] // Specifies the module types to filter by\nlet states: [String] = [\"\"] // Specifies the assignment states to filter by\nlet expand: [String] = [\"\"] // Specifies the expand option for returning additional information\n\n// List of Learning module Assignments\nGetLearningAssignmentsRequest.getLearningAssignments(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pageSize: pageSize, pageNumber: pageNumber, pass: pass, minPercentageScore: minPercentageScore, maxPercentageScore: maxPercentageScore, sortOrder: sortOrder, sortBy: sortBy, userId: userId, types: types, states: states, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningAssignmentsRequest.getLearningAssignments was successful\")\n dump(response)\n }\n}" - }, - "getlearningassignmentsme": { - "operationId": "getlearningassignmentsme", - "functionName": "getLearningAssignmentsMe", - "signature": "getLearningAssignmentsMe(moduleId, interval, completionInterval, overdue, pageSize, pageNumber, pass, minPercentageScore, maxPercentageScore, sortOrder, sortBy, types, states, expand)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pass", - "type": "String", - "required": "false" - }, - { - "name": "minPercentageScore", - "type": "Float", - "required": "false" - }, - { - "name": "maxPercentageScore", - "type": "Float", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "types", - "type": "[String]", - "required": "false" - }, - { - "name": "states", - "type": "[String]", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningAssignmentsDomainEntity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // Specifies the ID of the learning module. Fetch assignments for learning module ID\nlet interval: String = \"\" // Specifies the range of dueDates 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\nlet completionInterval: String = \"\" // 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\nlet overdue: GetLearningAssignmentsMeRequest.Overdue_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.Overdue_getLearningAssignmentsMe.enummember // Specifies if only the non-overdue (overdue is \\\"False\\\") or overdue (overdue is \\\"True\\\") assignments are returned. If overdue is \\\"Any\\\" or if the overdue parameter is not supplied, all assignments are returned\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet pass: GetLearningAssignmentsMeRequest.Pass_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.Pass_getLearningAssignmentsMe.enummember // Specifies if only the failed (pass is \\\"False\\\") or passed (pass is \\\"True\\\") assignments (completed with assessment)are returned. If pass is \\\"Any\\\" or if the pass parameter is not supplied, all assignments are returned\nlet minPercentageScore: Float = 0 // The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)\nlet maxPercentageScore: Float = 0 // The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)\nlet sortOrder: GetLearningAssignmentsMeRequest.SortOrder_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.SortOrder_getLearningAssignmentsMe.enummember // Specifies result set sort order; if not specified, default sort order is descending (Desc)\nlet sortBy: GetLearningAssignmentsMeRequest.SortBy_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.SortBy_getLearningAssignmentsMe.enummember // Specifies which field to sort the results by, default sort is by recommendedCompletionDate\nlet types: [String] = [\"\"] // Specifies the module types to filter by\nlet states: [String] = [\"\"] // Specifies the assignment states to filter by\nlet expand: [String] = [\"\"] // Specifies the expand option for returning additional information\n\n// List of Learning Assignments assigned to current user\nGetLearningAssignmentsMeRequest.getLearningAssignmentsMe(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pageSize: pageSize, pageNumber: pageNumber, pass: pass, minPercentageScore: minPercentageScore, maxPercentageScore: maxPercentageScore, sortOrder: sortOrder, sortBy: sortBy, types: types, states: states, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningAssignmentsMeRequest.getLearningAssignmentsMe was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodule": { - "operationId": "getlearningmodule", - "functionName": "getLearningModule", - "signature": "getLearningModule(moduleId, expand)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningModule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet expand: [String] = [\"\"] // Fields to expand in response(case insensitive)\n\n// Get a learning module\nGetLearningModuleRequest.getLearningModule(moduleId: moduleId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModuleRequest.getLearningModule was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodulejob": { - "operationId": "getlearningmodulejob", - "functionName": "getLearningModuleJob", - "signature": "getLearningModuleJob(moduleId, jobId)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "LearningModuleJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet jobId: String = \"\" // The ID of the learning module job\n\n// Get a specific Learning Module job status\nGetLearningModuleJobRequest.getLearningModuleJob(moduleId: moduleId, jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModuleJobRequest.getLearningModuleJob was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodulerule": { - "operationId": "getlearningmodulerule", - "functionName": "getLearningModuleRule", - "signature": "getLearningModuleRule(moduleId)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - } - ], - "return": "LearningModuleRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\n\n// Get a learning module rule\nGetLearningModuleRuleRequest.getLearningModuleRule(moduleId: moduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModuleRuleRequest.getLearningModuleRule was successful\")\n dump(response)\n }\n}" - }, - "getlearningmoduleversion": { - "operationId": "getlearningmoduleversion", - "functionName": "getLearningModuleVersion", - "signature": "getLearningModuleVersion(moduleId, versionId, expand)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningModule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet versionId: String = \"\" // The version of learning module\nlet expand: [String] = [\"\"] // Fields to expand in response(case insensitive)\n\n// Get specific version of a published module\nGetLearningModuleVersionRequest.getLearningModuleVersion(moduleId: moduleId, versionId: versionId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModuleVersionRequest.getLearningModuleVersion was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodules": { - "operationId": "getlearningmodules", - "functionName": "getLearningModules", - "signature": "getLearningModules(isArchived, types, pageSize, pageNumber, sortOrder, sortBy, searchTerm, expand, isPublished, statuses)", - "parameters": [ - { - "name": "isArchived", - "type": "Bool", - "required": "false" - }, - { - "name": "types", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "searchTerm", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "isPublished", - "type": "String", - "required": "false" - }, - { - "name": "statuses", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningModulesDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet isArchived: Bool = true // Archive status\nlet types: [String] = [\"\"] // Specifies the module types.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetLearningModulesRequest.SortOrder_getLearningModules = GetLearningModulesRequest.SortOrder_getLearningModules.enummember // Sort order\nlet sortBy: GetLearningModulesRequest.SortBy_getLearningModules = GetLearningModulesRequest.SortBy_getLearningModules.enummember // Sort by\nlet searchTerm: String = \"\" // Search Term (searchable by name)\nlet expand: [String] = [\"\"] // Fields to expand in response(case insensitive)\nlet isPublished: GetLearningModulesRequest.IsPublished_getLearningModules = GetLearningModulesRequest.IsPublished_getLearningModules.enummember // Specifies if only the Unpublished (isPublished is \\\"False\\\") or Published (isPublished is \\\"True\\\") modules are returned. If isPublished is \\\"Any\\\" or omitted, both types are returned\nlet statuses: [String] = [\"\"] // Specifies the module statuses to filter by\n\n// Get all learning modules of an organization\nGetLearningModulesRequest.getLearningModules(isArchived: isArchived, types: types, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, sortBy: sortBy, searchTerm: searchTerm, expand: expand, isPublished: isPublished, statuses: statuses) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModulesRequest.getLearningModules was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodulesassignments": { - "operationId": "getlearningmodulesassignments", - "functionName": "getLearningModulesAssignments", - "signature": "getLearningModulesAssignments(userIds, pageSize, pageNumber, searchTerm, overdue, assignmentStates, expand)", - "parameters": [ - { - "name": "userIds", - "type": "[String]", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "searchTerm", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "assignmentStates", - "type": "[String]", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "AssignedLearningModuleDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userIds: [String] = [\"\"] // The IDs of the users to include\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet searchTerm: String = \"\" // Search Term (searches by name and description)\nlet overdue: GetLearningModulesAssignmentsRequest.Overdue_getLearningModulesAssignments = GetLearningModulesAssignmentsRequest.Overdue_getLearningModulesAssignments.enummember // Specifies if only modules with overdue/not overdue (overdue is \\\"True\\\" or \\\"False\\\") assignments are returned. If overdue is \\\"Any\\\" or omitted, both are returned and can including modules that are unassigned.\nlet assignmentStates: [String] = [\"\"] // Specifies the assignment states to return.\nlet expand: [String] = [\"\"] // Fields to expand in response(case insensitive)\n\n// Get all learning modules of an organization including assignments for a specific user\nGetLearningModulesAssignmentsRequest.getLearningModulesAssignments(userIds: userIds, pageSize: pageSize, pageNumber: pageNumber, searchTerm: searchTerm, overdue: overdue, assignmentStates: assignmentStates, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModulesAssignmentsRequest.getLearningModulesAssignments was successful\")\n dump(response)\n }\n}" - }, - "getlearningmodulescoverartcoverartid": { - "operationId": "getlearningmodulescoverartcoverartid", - "functionName": "getLearningModulesCoverartCoverArtId", - "signature": "getLearningModulesCoverartCoverArtId(coverArtId)", - "parameters": [ - { - "name": "coverArtId", - "type": "String", - "required": "true" - } - ], - "return": "LearningModuleCoverArtResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet coverArtId: String = \"\" // Key identifier for the cover art\n\n// Get a specific Learning Module cover art using ID\nGetLearningModulesCoverartCoverArtIdRequest.getLearningModulesCoverartCoverArtId(coverArtId: coverArtId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLearningModulesCoverartCoverArtIdRequest.getLearningModulesCoverartCoverArtId was successful\")\n dump(response)\n }\n}" - }, - "patchlearningassignment": { - "operationId": "patchlearningassignment", - "functionName": "patchLearningAssignment", - "signature": "patchLearningAssignment(assignmentId, body)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningAssignmentUpdate", - "required": "false" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The ID of Learning Assignment\nlet body: LearningAssignmentUpdate = new LearningAssignmentUpdate(...) // The Learning Assignment to be updated\n\n// Update Learning Assignment\nPatchLearningAssignmentRequest.patchLearningAssignment(assignmentId: assignmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchLearningAssignmentRequest.patchLearningAssignment was successful\")\n dump(response)\n }\n}" - }, - "patchlearningassignmentreschedule": { - "operationId": "patchlearningassignmentreschedule", - "functionName": "patchLearningAssignmentReschedule", - "signature": "patchLearningAssignmentReschedule(assignmentId, body)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningAssignmentReschedule", - "required": "false" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The ID of Learning Assignment\nlet body: LearningAssignmentReschedule = new LearningAssignmentReschedule(...) // The Learning assignment reschedule model\n\n// Reschedule Learning Assignment\nPatchLearningAssignmentRescheduleRequest.patchLearningAssignmentReschedule(assignmentId: assignmentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchLearningAssignmentRescheduleRequest.patchLearningAssignmentReschedule was successful\")\n dump(response)\n }\n}" - }, - "postlearningassessmentsscoring": { - "operationId": "postlearningassessmentsscoring", - "functionName": "postLearningAssessmentsScoring", - "signature": "postLearningAssessmentsScoring(body)", - "parameters": [ - { - "name": "body", - "type": "LearningAssessmentScoringRequest", - "required": "true" - } - ], - "return": "AssessmentScoringSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningAssessmentScoringRequest = new LearningAssessmentScoringRequest(...) // Assessment form and answers to score\n\n// Score learning assessment for preview\nPostLearningAssessmentsScoringRequest.postLearningAssessmentsScoring(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssessmentsScoringRequest.postLearningAssessmentsScoring was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignmentreassign": { - "operationId": "postlearningassignmentreassign", - "functionName": "postLearningAssignmentReassign", - "signature": "postLearningAssignmentReassign(assignmentId)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The Learning Assignment ID\n\n// Reassign Learning Assignment\nPostLearningAssignmentReassignRequest.postLearningAssignmentReassign(assignmentId: assignmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentReassignRequest.postLearningAssignmentReassign was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignmentreset": { - "operationId": "postlearningassignmentreset", - "functionName": "postLearningAssignmentReset", - "signature": "postLearningAssignmentReset(assignmentId)", - "parameters": [ - { - "name": "assignmentId", - "type": "String", - "required": "true" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignmentId: String = \"\" // The Learning Assignment ID\n\n// Reset Learning Assignment\nPostLearningAssignmentResetRequest.postLearningAssignmentReset(assignmentId: assignmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentResetRequest.postLearningAssignmentReset was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignments": { - "operationId": "postlearningassignments", - "functionName": "postLearningAssignments", - "signature": "postLearningAssignments(body)", - "parameters": [ - { - "name": "body", - "type": "LearningAssignmentCreate", - "required": "false" - } - ], - "return": "LearningAssignment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningAssignmentCreate = new LearningAssignmentCreate(...) // The Learning Assignment to be created\n\n// Create Learning Assignment\nPostLearningAssignmentsRequest.postLearningAssignments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentsRequest.postLearningAssignments was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignmentsaggregatesquery": { - "operationId": "postlearningassignmentsaggregatesquery", - "functionName": "postLearningAssignmentsAggregatesQuery", - "signature": "postLearningAssignmentsAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "LearningAssignmentAggregateParam", - "required": "true" - } - ], - "return": "LearningAssignmentAggregateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningAssignmentAggregateParam = new LearningAssignmentAggregateParam(...) // Aggregate Request\n\n// Retrieve aggregated assignment data\nPostLearningAssignmentsAggregatesQueryRequest.postLearningAssignmentsAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentsAggregatesQueryRequest.postLearningAssignmentsAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignmentsbulkadd": { - "operationId": "postlearningassignmentsbulkadd", - "functionName": "postLearningAssignmentsBulkadd", - "signature": "postLearningAssignmentsBulkadd(body)", - "parameters": [ - { - "name": "body", - "type": "[LearningAssignmentItem]", - "required": "false" - } - ], - "return": "LearningAssignmentBulkAddResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [LearningAssignmentItem] = [new LearningAssignmentItem(...)] // The learning assignments to be created\n\n// Add multiple learning assignments\nPostLearningAssignmentsBulkaddRequest.postLearningAssignmentsBulkadd(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentsBulkaddRequest.postLearningAssignmentsBulkadd was successful\")\n dump(response)\n }\n}" - }, - "postlearningassignmentsbulkremove": { - "operationId": "postlearningassignmentsbulkremove", - "functionName": "postLearningAssignmentsBulkremove", - "signature": "postLearningAssignmentsBulkremove(body)", - "parameters": [ - { - "name": "body", - "type": "[String]", - "required": "false" - } - ], - "return": "LearningAssignmentBulkRemoveResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [String] = [\"\"] // The IDs of the learning assignments to be removed\n\n// Remove multiple Learning Assignments\nPostLearningAssignmentsBulkremoveRequest.postLearningAssignmentsBulkremove(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningAssignmentsBulkremoveRequest.postLearningAssignmentsBulkremove was successful\")\n dump(response)\n }\n}" - }, - "postlearningmodulejobs": { - "operationId": "postlearningmodulejobs", - "functionName": "postLearningModuleJobs", - "signature": "postLearningModuleJobs(moduleId, body)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningModuleJobRequest", - "required": "true" - } - ], - "return": "LearningModuleJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet body: LearningModuleJobRequest = new LearningModuleJobRequest(...) // The learning module job request\n\n// Starts a specified operation on learning module\nPostLearningModuleJobsRequest.postLearningModuleJobs(moduleId: moduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningModuleJobsRequest.postLearningModuleJobs was successful\")\n dump(response)\n }\n}" - }, - "postlearningmodulepublish": { - "operationId": "postlearningmodulepublish", - "functionName": "postLearningModulePublish", - "signature": "postLearningModulePublish(moduleId, body)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningModulePublishRequest", - "required": "false" - } - ], - "return": "LearningModulePublishResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet body: LearningModulePublishRequest = new LearningModulePublishRequest(...) // The request body\n\n// Publish a Learning module\nPostLearningModulePublishRequest.postLearningModulePublish(moduleId: moduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningModulePublishRequest.postLearningModulePublish was successful\")\n dump(response)\n }\n}" - }, - "postlearningmodules": { - "operationId": "postlearningmodules", - "functionName": "postLearningModules", - "signature": "postLearningModules(body)", - "parameters": [ - { - "name": "body", - "type": "LearningModuleRequest", - "required": "true" - } - ], - "return": "LearningModule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningModuleRequest = new LearningModuleRequest(...) // The learning module to be created\n\n// Create a new learning module\nPostLearningModulesRequest.postLearningModules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningModulesRequest.postLearningModules was successful\")\n dump(response)\n }\n}" - }, - "postlearningrulesquery": { - "operationId": "postlearningrulesquery", - "functionName": "postLearningRulesQuery", - "signature": "postLearningRulesQuery(pageSize, pageNumber, body)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "true" - }, - { - "name": "body", - "type": "LearningAssignmentUserQuery", - "required": "true" - } - ], - "return": "LearningAssignmentUserListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet body: LearningAssignmentUserQuery = new LearningAssignmentUserQuery(...) // The learning module rule to fetch users\n\n// Get users for learning module rule\nPostLearningRulesQueryRequest.postLearningRulesQuery(pageSize: pageSize, pageNumber: pageNumber, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningRulesQueryRequest.postLearningRulesQuery was successful\")\n dump(response)\n }\n}" - }, - "postlearningscheduleslotsquery": { - "operationId": "postlearningscheduleslotsquery", - "functionName": "postLearningScheduleslotsQuery", - "signature": "postLearningScheduleslotsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "LearningScheduleSlotsQueryRequest", - "required": "true" - } - ], - "return": "LearningScheduleSlotsQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningScheduleSlotsQueryRequest = new LearningScheduleSlotsQueryRequest(...) // The slot search request\n\n// Get list of possible slots where a learning activity can be scheduled.\nPostLearningScheduleslotsQueryRequest.postLearningScheduleslotsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLearningScheduleslotsQueryRequest.postLearningScheduleslotsQuery was successful\")\n dump(response)\n }\n}" - }, - "putlearningmodule": { - "operationId": "putlearningmodule", - "functionName": "putLearningModule", - "signature": "putLearningModule(moduleId, body)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningModuleRequest", - "required": "true" - } - ], - "return": "LearningModule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet body: LearningModuleRequest = new LearningModuleRequest(...) // The learning module to be updated\n\n// Update a learning module\nPutLearningModuleRequest.putLearningModule(moduleId: moduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutLearningModuleRequest.putLearningModule was successful\")\n dump(response)\n }\n}" - }, - "putlearningmodulerule": { - "operationId": "putlearningmodulerule", - "functionName": "putLearningModuleRule", - "signature": "putLearningModuleRule(moduleId, body)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LearningModuleRule", - "required": "true" - } - ], - "return": "LearningModuleRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // The ID of the learning module\nlet body: LearningModuleRule = new LearningModuleRule(...) // The learning module rule to be updated\n\n// Update a learning module rule\nPutLearningModuleRuleRequest.putLearningModuleRule(moduleId: moduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutLearningModuleRuleRequest.putLearningModuleRule was successful\")\n dump(response)\n }\n}" - }, - "getlicensedefinition": { - "operationId": "getlicensedefinition", - "functionName": "getLicenseDefinition", - "signature": "getLicenseDefinition(licenseId)", - "parameters": [ - { - "name": "licenseId", - "type": "String", - "required": "true" - } - ], - "return": "LicenseDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet licenseId: String = \"\" // ID\n\n// Get PureCloud license definition.\nGetLicenseDefinitionRequest.getLicenseDefinition(licenseId: licenseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLicenseDefinitionRequest.getLicenseDefinition was successful\")\n dump(response)\n }\n}" - }, - "getlicensedefinitions": { - "operationId": "getlicensedefinitions", - "functionName": "getLicenseDefinitions", - "signature": "getLicenseDefinitions()", - "return": "[LicenseDefinition]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get all PureCloud license definitions available for the organization.\nGetLicenseDefinitionsRequest.getLicenseDefinitions() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLicenseDefinitionsRequest.getLicenseDefinitions was successful\")\n dump(response)\n }\n}" - }, - "getlicensetoggle": { - "operationId": "getlicensetoggle", - "functionName": "getLicenseToggle", - "signature": "getLicenseToggle(featureName)", - "parameters": [ - { - "name": "featureName", - "type": "String", - "required": "true" - } - ], - "return": "LicenseOrgToggle", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet featureName: String = \"\" // featureName\n\n// Deprecated - no alternative required. This operation will always return 'true' for requested toggles\nGetLicenseToggleRequest.getLicenseToggle(featureName: featureName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLicenseToggleRequest.getLicenseToggle was successful\")\n dump(response)\n }\n}" - }, - "getlicenseuser": { - "operationId": "getlicenseuser", - "functionName": "getLicenseUser", - "signature": "getLicenseUser(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "LicenseUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // ID\n\n// Get licenses for specified user.\nGetLicenseUserRequest.getLicenseUser(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLicenseUserRequest.getLicenseUser was successful\")\n dump(response)\n }\n}" - }, - "getlicenseusers": { - "operationId": "getlicenseusers", - "functionName": "getLicenseUsers", - "signature": "getLicenseUsers(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "UserLicensesEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a page of users and their licenses\nGetLicenseUsersRequest.getLicenseUsers(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLicenseUsersRequest.getLicenseUsers was successful\")\n dump(response)\n }\n}" - }, - "postlicenseinfer": { - "operationId": "postlicenseinfer", - "functionName": "postLicenseInfer", - "signature": "postLicenseInfer(body)", - "parameters": [ - { - "name": "body", - "type": "[String]", - "required": "false" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [String] = [\"\"] // The roleIds to use while inferring licenses\n\n// Get a list of licenses inferred based on a list of roleIds\nPostLicenseInferRequest.postLicenseInfer(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLicenseInferRequest.postLicenseInfer was successful\")\n dump(response)\n }\n}" - }, - "postlicenseorganization": { - "operationId": "postlicenseorganization", - "functionName": "postLicenseOrganization", - "signature": "postLicenseOrganization(body)", - "parameters": [ - { - "name": "body", - "type": "LicenseBatchAssignmentRequest", - "required": "false" - } - ], - "return": "[LicenseUpdateStatus]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LicenseBatchAssignmentRequest = new LicenseBatchAssignmentRequest(...) // The license assignments to update.\n\n// Update the organization's license assignments in a batch.\nPostLicenseOrganizationRequest.postLicenseOrganization(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLicenseOrganizationRequest.postLicenseOrganization was successful\")\n dump(response)\n }\n}" - }, - "postlicensetoggle": { - "operationId": "postlicensetoggle", - "functionName": "postLicenseToggle", - "signature": "postLicenseToggle(featureName)", - "parameters": [ - { - "name": "featureName", - "type": "String", - "required": "true" - } - ], - "return": "LicenseOrgToggle", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet featureName: String = \"\" // featureName\n\n// Deprecated. No alternative required - this endpoint has no effect\nPostLicenseToggleRequest.postLicenseToggle(featureName: featureName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLicenseToggleRequest.postLicenseToggle was successful\")\n dump(response)\n }\n}" - }, - "postlicenseusers": { - "operationId": "postlicenseusers", - "functionName": "postLicenseUsers", - "signature": "postLicenseUsers(body)", - "parameters": [ - { - "name": "body", - "type": "[String]", - "required": "false" - } - ], - "return": "[String:JSON]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [String] = [\"\"] // The user IDs to fetch.\n\n// Fetch user licenses in a batch.\nPostLicenseUsersRequest.postLicenseUsers(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLicenseUsersRequest.postLicenseUsers was successful\")\n dump(response)\n }\n}" - }, - "deletelocation": { - "operationId": "deletelocation", - "functionName": "deleteLocation", - "signature": "deleteLocation(locationId)", - "parameters": [ - { - "name": "locationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet locationId: String = \"\" // Location ID\n\n// Delete a location\nDeleteLocationRequest.deleteLocation(locationId: locationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteLocationRequest.deleteLocation was successful\")\n }\n}" - }, - "getlocation": { - "operationId": "getlocation", - "functionName": "getLocation", - "signature": "getLocation(locationId, expand)", - "parameters": [ - { - "name": "locationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LocationDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet locationId: String = \"\" // Location ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get Location by ID.\nGetLocationRequest.getLocation(locationId: locationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLocationRequest.getLocation was successful\")\n dump(response)\n }\n}" - }, - "getlocationsublocations": { - "operationId": "getlocationsublocations", - "functionName": "getLocationSublocations", - "signature": "getLocationSublocations(locationId)", - "parameters": [ - { - "name": "locationId", - "type": "String", - "required": "true" - } - ], - "return": "LocationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet locationId: String = \"\" // Location ID\n\n// Get sublocations for location ID.\nGetLocationSublocationsRequest.getLocationSublocations(locationId: locationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLocationSublocationsRequest.getLocationSublocations was successful\")\n dump(response)\n }\n}" - }, - "getlocations": { - "operationId": "getlocations", - "functionName": "getLocations", - "signature": "getLocations(pageSize, pageNumber, _id, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "LocationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // id\nlet sortOrder: GetLocationsRequest.SortOrder_getLocations = GetLocationsRequest.SortOrder_getLocations.enummember // Sort order\n\n// Get a list of all locations.\nGetLocationsRequest.getLocations(pageSize: pageSize, pageNumber: pageNumber, _id: _id, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLocationsRequest.getLocations was successful\")\n dump(response)\n }\n}" - }, - "getlocationssearch": { - "operationId": "getlocationssearch", - "functionName": "getLocationsSearch", - "signature": "getLocationsSearch(q64, expand)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LocationsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // Provides more details about a specified resource\n\n// Search locations using the q64 value returned from a previous search\nGetLocationsSearchRequest.getLocationsSearch(q64: q64, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetLocationsSearchRequest.getLocationsSearch was successful\")\n dump(response)\n }\n}" - }, - "patchlocation": { - "operationId": "patchlocation", - "functionName": "patchLocation", - "signature": "patchLocation(locationId, body)", - "parameters": [ - { - "name": "locationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "LocationUpdateDefinition", - "required": "true" - } - ], - "return": "LocationDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet locationId: String = \"\" // Location ID\nlet body: LocationUpdateDefinition = new LocationUpdateDefinition(...) // Location\n\n// Update a location\nPatchLocationRequest.patchLocation(locationId: locationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchLocationRequest.patchLocation was successful\")\n dump(response)\n }\n}" - }, - "postlocations": { - "operationId": "postlocations", - "functionName": "postLocations", - "signature": "postLocations(body)", - "parameters": [ - { - "name": "body", - "type": "LocationCreateDefinition", - "required": "true" - } - ], - "return": "LocationDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LocationCreateDefinition = new LocationCreateDefinition(...) // Location\n\n// Create a location\nPostLocationsRequest.postLocations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLocationsRequest.postLocations was successful\")\n dump(response)\n }\n}" - }, - "postlocationssearch": { - "operationId": "postlocationssearch", - "functionName": "postLocationsSearch", - "signature": "postLocationsSearch(body)", - "parameters": [ - { - "name": "body", - "type": "LocationSearchRequest", - "required": "true" - } - ], - "return": "LocationsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LocationSearchRequest = new LocationSearchRequest(...) // Search request options\n\n// Search locations\nPostLocationsSearchRequest.postLocationsSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLocationsSearchRequest.postLocationsSearch was successful\")\n dump(response)\n }\n}" - }, - "deletemessagingsetting": { - "operationId": "deletemessagingsetting", - "functionName": "deleteMessagingSetting", - "signature": "deleteMessagingSetting(messageSettingId)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Settings ID\n\n// Delete a messaging setting\nDeleteMessagingSettingRequest.deleteMessagingSetting(messageSettingId: messageSettingId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteMessagingSettingRequest.deleteMessagingSetting was successful\")\n }\n}" - }, - "deletemessagingsettingsdefault": { - "operationId": "deletemessagingsettingsdefault", - "functionName": "deleteMessagingSettingsDefault", - "signature": "deleteMessagingSettingsDefault()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete the organization's default setting, a global default will be applied to integrations without settings\nDeleteMessagingSettingsDefaultRequest.deleteMessagingSettingsDefault() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteMessagingSettingsDefaultRequest.deleteMessagingSettingsDefault was successful\")\n }\n}" - }, - "deletemessagingsupportedcontentsupportedcontentid": { - "operationId": "deletemessagingsupportedcontentsupportedcontentid", - "functionName": "deleteMessagingSupportedcontentSupportedContentId", - "signature": "deleteMessagingSupportedcontentSupportedContentId(supportedContentId)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\n\n// Delete a supported content profile\nDeleteMessagingSupportedcontentSupportedContentIdRequest.deleteMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteMessagingSupportedcontentSupportedContentIdRequest.deleteMessagingSupportedcontentSupportedContentId was successful\")\n }\n}" - }, - "getmessagingsetting": { - "operationId": "getmessagingsetting", - "functionName": "getMessagingSetting", - "signature": "getMessagingSetting(messageSettingId)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Settings ID\n\n// Get a messaging setting\nGetMessagingSettingRequest.getMessagingSetting(messageSettingId: messageSettingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMessagingSettingRequest.getMessagingSetting was successful\")\n dump(response)\n }\n}" - }, - "getmessagingsettings": { - "operationId": "getmessagingsettings", - "functionName": "getMessagingSettings", - "signature": "getMessagingSettings(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "MessagingConfigListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of messaging settings\nGetMessagingSettingsRequest.getMessagingSettings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMessagingSettingsRequest.getMessagingSettings was successful\")\n dump(response)\n }\n}" - }, - "getmessagingsettingsdefault": { - "operationId": "getmessagingsettingsdefault", - "functionName": "getMessagingSettingsDefault", - "signature": "getMessagingSettingsDefault()", - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the organization's default settings that will be used as the default when creating an integration.\nGetMessagingSettingsDefaultRequest.getMessagingSettingsDefault() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMessagingSettingsDefaultRequest.getMessagingSettingsDefault was successful\")\n dump(response)\n }\n}" - }, - "getmessagingsupportedcontent": { - "operationId": "getmessagingsupportedcontent", - "functionName": "getMessagingSupportedcontent", - "signature": "getMessagingSupportedcontent(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "SupportedContentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of Supported Content profiles\nGetMessagingSupportedcontentRequest.getMessagingSupportedcontent(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMessagingSupportedcontentRequest.getMessagingSupportedcontent was successful\")\n dump(response)\n }\n}" - }, - "getmessagingsupportedcontentsupportedcontentid": { - "operationId": "getmessagingsupportedcontentsupportedcontentid", - "functionName": "getMessagingSupportedcontentSupportedContentId", - "signature": "getMessagingSupportedcontentSupportedContentId(supportedContentId)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\n\n// Get a supported content profile\nGetMessagingSupportedcontentSupportedContentIdRequest.getMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMessagingSupportedcontentSupportedContentIdRequest.getMessagingSupportedcontentSupportedContentId was successful\")\n dump(response)\n }\n}" - }, - "patchmessagingsetting": { - "operationId": "patchmessagingsetting", - "functionName": "patchMessagingSetting", - "signature": "patchMessagingSetting(messageSettingId, body)", - "parameters": [ - { - "name": "messageSettingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MessagingSettingRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageSettingId: String = \"\" // Message Settings ID\nlet body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting\n\n// Update a messaging setting\nPatchMessagingSettingRequest.patchMessagingSetting(messageSettingId: messageSettingId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchMessagingSettingRequest.patchMessagingSetting was successful\")\n dump(response)\n }\n}" - }, - "patchmessagingsupportedcontentsupportedcontentid": { - "operationId": "patchmessagingsupportedcontentsupportedcontentid", - "functionName": "patchMessagingSupportedcontentSupportedContentId", - "signature": "patchMessagingSupportedcontentSupportedContentId(supportedContentId, body)", - "parameters": [ - { - "name": "supportedContentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SupportedContent", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet supportedContentId: String = \"\" // Supported Content ID\nlet body: SupportedContent = new SupportedContent(...) // SupportedContent\n\n// Update a supported content profile\nPatchMessagingSupportedcontentSupportedContentIdRequest.patchMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchMessagingSupportedcontentSupportedContentIdRequest.patchMessagingSupportedcontentSupportedContentId was successful\")\n dump(response)\n }\n}" - }, - "postmessagingsettings": { - "operationId": "postmessagingsettings", - "functionName": "postMessagingSettings", - "signature": "postMessagingSettings(body)", - "parameters": [ - { - "name": "body", - "type": "MessagingSettingRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting\n\n// Create a messaging setting\nPostMessagingSettingsRequest.postMessagingSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostMessagingSettingsRequest.postMessagingSettings was successful\")\n dump(response)\n }\n}" - }, - "postmessagingsupportedcontent": { - "operationId": "postmessagingsupportedcontent", - "functionName": "postMessagingSupportedcontent", - "signature": "postMessagingSupportedcontent(body)", - "parameters": [ - { - "name": "body", - "type": "SupportedContent", - "required": "true" - } - ], - "return": "SupportedContent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SupportedContent = new SupportedContent(...) // SupportedContent\n\n// Create a Supported Content profile\nPostMessagingSupportedcontentRequest.postMessagingSupportedcontent(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostMessagingSupportedcontentRequest.postMessagingSupportedcontent was successful\")\n dump(response)\n }\n}" - }, - "putmessagingsettingsdefault": { - "operationId": "putmessagingsettingsdefault", - "functionName": "putMessagingSettingsDefault", - "signature": "putMessagingSettingsDefault(body)", - "parameters": [ - { - "name": "body", - "type": "MessagingSettingDefaultRequest", - "required": "true" - } - ], - "return": "MessagingSetting", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MessagingSettingDefaultRequest = new MessagingSettingDefaultRequest(...) // Messaging Setting ID\n\n// Set the organization's default settings that may be applied to an integration when it is created.\nPutMessagingSettingsDefaultRequest.putMessagingSettingsDefault(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutMessagingSettingsDefaultRequest.putMessagingSettingsDefault was successful\")\n dump(response)\n }\n}" - }, - "deletemobiledevice": { - "operationId": "deletemobiledevice", - "functionName": "deleteMobiledevice", - "signature": "deleteMobiledevice(deviceId)", - "parameters": [ - { - "name": "deviceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deviceId: String = \"\" // Device ID\n\n// Delete device\nDeleteMobiledeviceRequest.deleteMobiledevice(deviceId: deviceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteMobiledeviceRequest.deleteMobiledevice was successful\")\n }\n}" - }, - "getmobiledevice": { - "operationId": "getmobiledevice", - "functionName": "getMobiledevice", - "signature": "getMobiledevice(deviceId)", - "parameters": [ - { - "name": "deviceId", - "type": "String", - "required": "true" - } - ], - "return": "UserDevice", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deviceId: String = \"\" // Device ID\n\n// Get device\nGetMobiledeviceRequest.getMobiledevice(deviceId: deviceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMobiledeviceRequest.getMobiledevice was successful\")\n dump(response)\n }\n}" - }, - "getmobiledevices": { - "operationId": "getmobiledevices", - "functionName": "getMobiledevices", - "signature": "getMobiledevices(pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DirectoryUserDevicesListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetMobiledevicesRequest.SortOrder_getMobiledevices = GetMobiledevicesRequest.SortOrder_getMobiledevices.enummember // Ascending or descending sort order\n\n// Get a list of all devices.\nGetMobiledevicesRequest.getMobiledevices(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetMobiledevicesRequest.getMobiledevices was successful\")\n dump(response)\n }\n}" - }, - "postmobiledevices": { - "operationId": "postmobiledevices", - "functionName": "postMobiledevices", - "signature": "postMobiledevices(body)", - "parameters": [ - { - "name": "body", - "type": "UserDevice", - "required": "true" - } - ], - "return": "UserDevice", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserDevice = new UserDevice(...) // Device\n\n// Create User device\nPostMobiledevicesRequest.postMobiledevices(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostMobiledevicesRequest.postMobiledevices was successful\")\n dump(response)\n }\n}" - }, - "putmobiledevice": { - "operationId": "putmobiledevice", - "functionName": "putMobiledevice", - "signature": "putMobiledevice(deviceId, body)", - "parameters": [ - { - "name": "deviceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserDevice", - "required": "false" - } - ], - "return": "UserDevice", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deviceId: String = \"\" // Device ID\nlet body: UserDevice = new UserDevice(...) // Device\n\n// Update device\nPutMobiledeviceRequest.putMobiledevice(deviceId: deviceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutMobiledeviceRequest.putMobiledevice was successful\")\n dump(response)\n }\n}" - }, - "deletenotificationschannelsubscriptions": { - "operationId": "deletenotificationschannelsubscriptions", - "functionName": "deleteNotificationsChannelSubscriptions", - "signature": "deleteNotificationsChannelSubscriptions(channelId)", - "parameters": [ - { - "name": "channelId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet channelId: String = \"\" // Channel ID\n\n// Remove all subscriptions\nDeleteNotificationsChannelSubscriptionsRequest.deleteNotificationsChannelSubscriptions(channelId: channelId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteNotificationsChannelSubscriptionsRequest.deleteNotificationsChannelSubscriptions was successful\")\n }\n}" - }, - "getnotificationsavailabletopics": { - "operationId": "getnotificationsavailabletopics", - "functionName": "getNotificationsAvailabletopics", - "signature": "getNotificationsAvailabletopics(expand, includePreview)", - "parameters": [ - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "includePreview", - "type": "Bool", - "required": "false" - } - ], - "return": "AvailableTopicEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet includePreview: Bool = true // Whether or not to include Preview topics\n\n// Get available notification topics.\nGetNotificationsAvailabletopicsRequest.getNotificationsAvailabletopics(expand: expand, includePreview: includePreview) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetNotificationsAvailabletopicsRequest.getNotificationsAvailabletopics was successful\")\n dump(response)\n }\n}" - }, - "getnotificationschannelsubscriptions": { - "operationId": "getnotificationschannelsubscriptions", - "functionName": "getNotificationsChannelSubscriptions", - "signature": "getNotificationsChannelSubscriptions(channelId)", - "parameters": [ - { - "name": "channelId", - "type": "String", - "required": "true" - } - ], - "return": "ChannelTopicEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet channelId: String = \"\" // Channel ID\n\n// The list of all subscriptions for this channel\nGetNotificationsChannelSubscriptionsRequest.getNotificationsChannelSubscriptions(channelId: channelId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetNotificationsChannelSubscriptionsRequest.getNotificationsChannelSubscriptions was successful\")\n dump(response)\n }\n}" - }, - "getnotificationschannels": { - "operationId": "getnotificationschannels", - "functionName": "getNotificationsChannels", - "signature": "getNotificationsChannels(includechannels)", - "parameters": [ - { - "name": "includechannels", - "type": "String", - "required": "false" - } - ], - "return": "ChannelEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet includechannels: GetNotificationsChannelsRequest.Includechannels_getNotificationsChannels = GetNotificationsChannelsRequest.Includechannels_getNotificationsChannels.enummember // 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.\n\n// The list of existing channels\nGetNotificationsChannelsRequest.getNotificationsChannels(includechannels: includechannels) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetNotificationsChannelsRequest.getNotificationsChannels was successful\")\n dump(response)\n }\n}" - }, - "headnotificationschannel": { - "operationId": "headnotificationschannel", - "functionName": "headNotificationsChannel", - "signature": "headNotificationsChannel(channelId)", - "parameters": [ - { - "name": "channelId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet channelId: String = \"\" // Channel ID\n\n// Verify a channel still exists and is valid\nHeadNotificationsChannelRequest.headNotificationsChannel(channelId: channelId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"HeadNotificationsChannelRequest.headNotificationsChannel was successful\")\n }\n}" - }, - "postnotificationschannelsubscriptions": { - "operationId": "postnotificationschannelsubscriptions", - "functionName": "postNotificationsChannelSubscriptions", - "signature": "postNotificationsChannelSubscriptions(channelId, body, ignoreErrors)", - "parameters": [ - { - "name": "channelId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[ChannelTopic]", - "required": "true" - }, - { - "name": "ignoreErrors", - "type": "Bool", - "required": "false" - } - ], - "return": "ChannelTopicEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet channelId: String = \"\" // Channel ID\nlet body: [ChannelTopic] = [new ChannelTopic(...)] // Body\nlet ignoreErrors: Bool = true // Optionally prevent throwing of errors for failed permissions checks.\n\n// Add a list of subscriptions to the existing list of subscriptions\nPostNotificationsChannelSubscriptionsRequest.postNotificationsChannelSubscriptions(channelId: channelId, body: body, ignoreErrors: ignoreErrors) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostNotificationsChannelSubscriptionsRequest.postNotificationsChannelSubscriptions was successful\")\n dump(response)\n }\n}" - }, - "postnotificationschannels": { - "operationId": "postnotificationschannels", - "functionName": "postNotificationsChannels", - "signature": "postNotificationsChannels()", - "return": "Channel", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Create a new channel\nPostNotificationsChannelsRequest.postNotificationsChannels() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostNotificationsChannelsRequest.postNotificationsChannels was successful\")\n dump(response)\n }\n}" - }, - "putnotificationschannelsubscriptions": { - "operationId": "putnotificationschannelsubscriptions", - "functionName": "putNotificationsChannelSubscriptions", - "signature": "putNotificationsChannelSubscriptions(channelId, body, ignoreErrors)", - "parameters": [ - { - "name": "channelId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[ChannelTopic]", - "required": "true" - }, - { - "name": "ignoreErrors", - "type": "Bool", - "required": "false" - } - ], - "return": "ChannelTopicEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet channelId: String = \"\" // Channel ID\nlet body: [ChannelTopic] = [new ChannelTopic(...)] // Body\nlet ignoreErrors: Bool = true // Optionally prevent throwing of errors for failed permissions checks.\n\n// Replace the current list of subscriptions with a new list.\nPutNotificationsChannelSubscriptionsRequest.putNotificationsChannelSubscriptions(channelId: channelId, body: body, ignoreErrors: ignoreErrors) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutNotificationsChannelSubscriptionsRequest.putNotificationsChannelSubscriptions was successful\")\n dump(response)\n }\n}" - }, - "deleteoauthclient": { - "operationId": "deleteoauthclient", - "functionName": "deleteOauthClient", - "signature": "deleteOauthClient(clientId)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\n\n// Delete OAuth Client\nDeleteOauthClientRequest.deleteOauthClient(clientId: clientId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOauthClientRequest.deleteOauthClient was successful\")\n }\n}" - }, - "getoauthauthorization": { - "operationId": "getoauthauthorization", - "functionName": "getOauthAuthorization", - "signature": "getOauthAuthorization(clientId, acceptLanguage)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - }, - { - "name": "acceptLanguage", - "type": "String", - "required": "false" - } - ], - "return": "OAuthAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // The ID of client\nlet acceptLanguage: String = \"\" // The language in which to display the client descriptions.\n\n// Get a client that is authorized by the resource owner\nGetOauthAuthorizationRequest.getOauthAuthorization(clientId: clientId, acceptLanguage: acceptLanguage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthAuthorizationRequest.getOauthAuthorization was successful\")\n dump(response)\n }\n}" - }, - "getoauthauthorizations": { - "operationId": "getoauthauthorizations", - "functionName": "getOauthAuthorizations", - "signature": "getOauthAuthorizations(acceptLanguage)", - "parameters": [ - { - "name": "acceptLanguage", - "type": "String", - "required": "false" - } - ], - "return": "OAuthAuthorizationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet acceptLanguage: String = \"\" // The language in which to display the client descriptions.\n\n// List clients that have been authorized, requested, or revoked by the resource owner\nGetOauthAuthorizationsRequest.getOauthAuthorizations(acceptLanguage: acceptLanguage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthAuthorizationsRequest.getOauthAuthorizations was successful\")\n dump(response)\n }\n}" - }, - "getoauthclient": { - "operationId": "getoauthclient", - "functionName": "getOauthClient", - "signature": "getOauthClient(clientId)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - } - ], - "return": "OAuthClient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\n\n// Get OAuth Client\nGetOauthClientRequest.getOauthClient(clientId: clientId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthClientRequest.getOauthClient was successful\")\n dump(response)\n }\n}" - }, - "getoauthclientusagequeryresult": { - "operationId": "getoauthclientusagequeryresult", - "functionName": "getOauthClientUsageQueryResult", - "signature": "getOauthClientUsageQueryResult(executionId, clientId)", - "parameters": [ - { - "name": "executionId", - "type": "String", - "required": "true" - }, - { - "name": "clientId", - "type": "String", - "required": "true" - } - ], - "return": "ApiUsageQueryResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet executionId: String = \"\" // ID of the query execution\nlet clientId: String = \"\" // Client ID\n\n// Get the results of a usage query\nGetOauthClientUsageQueryResultRequest.getOauthClientUsageQueryResult(executionId: executionId, clientId: clientId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthClientUsageQueryResultRequest.getOauthClientUsageQueryResult was successful\")\n dump(response)\n }\n}" - }, - "getoauthclientusagesummary": { - "operationId": "getoauthclientusagesummary", - "functionName": "getOauthClientUsageSummary", - "signature": "getOauthClientUsageSummary(clientId, days)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - }, - { - "name": "days", - "type": "String", - "required": "false" - } - ], - "return": "UsageExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\nlet days: String = \"\" // Previous number of days to query\n\n// Get a summary of OAuth client API usage\nGetOauthClientUsageSummaryRequest.getOauthClientUsageSummary(clientId: clientId, days: days) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthClientUsageSummaryRequest.getOauthClientUsageSummary was successful\")\n dump(response)\n }\n}" - }, - "getoauthclients": { - "operationId": "getoauthclients", - "functionName": "getOauthClients", - "signature": "getOauthClients()", - "return": "OAuthClientEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// The list of OAuth clients\nGetOauthClientsRequest.getOauthClients() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthClientsRequest.getOauthClients was successful\")\n dump(response)\n }\n}" - }, - "getoauthscope": { - "operationId": "getoauthscope", - "functionName": "getOauthScope", - "signature": "getOauthScope(scopeId, acceptLanguage)", - "parameters": [ - { - "name": "scopeId", - "type": "String", - "required": "true" - }, - { - "name": "acceptLanguage", - "type": "String", - "required": "false" - } - ], - "return": "OAuthScope", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scopeId: String = \"\" // Scope ID\nlet acceptLanguage: String = \"\" // The language with which to display the scope description.\n\n// An OAuth scope\nGetOauthScopeRequest.getOauthScope(scopeId: scopeId, acceptLanguage: acceptLanguage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthScopeRequest.getOauthScope was successful\")\n dump(response)\n }\n}" - }, - "getoauthscopes": { - "operationId": "getoauthscopes", - "functionName": "getOauthScopes", - "signature": "getOauthScopes(acceptLanguage)", - "parameters": [ - { - "name": "acceptLanguage", - "type": "String", - "required": "false" - } - ], - "return": "OAuthScopeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet acceptLanguage: String = \"\" // The language with which to display the scope descriptions.\n\n// The list of OAuth scopes\nGetOauthScopesRequest.getOauthScopes(acceptLanguage: acceptLanguage) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOauthScopesRequest.getOauthScopes was successful\")\n dump(response)\n }\n}" - }, - "postoauthclientsecret": { - "operationId": "postoauthclientsecret", - "functionName": "postOauthClientSecret", - "signature": "postOauthClientSecret(clientId)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - } - ], - "return": "OAuthClient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\n\n// Regenerate Client Secret\nPostOauthClientSecretRequest.postOauthClientSecret(clientId: clientId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOauthClientSecretRequest.postOauthClientSecret was successful\")\n dump(response)\n }\n}" - }, - "postoauthclientusagequery": { - "operationId": "postoauthclientusagequery", - "functionName": "postOauthClientUsageQuery", - "signature": "postOauthClientUsageQuery(clientId, body)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ApiUsageClientQuery", - "required": "true" - } - ], - "return": "UsageExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\nlet body: ApiUsageClientQuery = new ApiUsageClientQuery(...) // Query\n\n// Query for OAuth client API usage\nPostOauthClientUsageQueryRequest.postOauthClientUsageQuery(clientId: clientId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOauthClientUsageQueryRequest.postOauthClientUsageQuery was successful\")\n dump(response)\n }\n}" - }, - "postoauthclients": { - "operationId": "postoauthclients", - "functionName": "postOauthClients", - "signature": "postOauthClients(body)", - "parameters": [ - { - "name": "body", - "type": "OAuthClientRequest", - "required": "true" - } - ], - "return": "OAuthClient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OAuthClientRequest = new OAuthClientRequest(...) // Client\n\n// Create OAuth client\nPostOauthClientsRequest.postOauthClients(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOauthClientsRequest.postOauthClients was successful\")\n dump(response)\n }\n}" - }, - "putoauthclient": { - "operationId": "putoauthclient", - "functionName": "putOauthClient", - "signature": "putOauthClient(clientId, body)", - "parameters": [ - { - "name": "clientId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OAuthClientRequest", - "required": "true" - } - ], - "return": "OAuthClient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet clientId: String = \"\" // Client ID\nlet body: OAuthClientRequest = new OAuthClientRequest(...) // Client\n\n// Update OAuth Client\nPutOauthClientRequest.putOauthClient(clientId: clientId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOauthClientRequest.putOauthClient was successful\")\n dump(response)\n }\n}" - }, - "getorganizationsauthenticationsettings": { - "operationId": "getorganizationsauthenticationsettings", - "functionName": "getOrganizationsAuthenticationSettings", - "signature": "getOrganizationsAuthenticationSettings()", - "return": "OrgAuthSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Gets the organization's settings\nGetOrganizationsAuthenticationSettingsRequest.getOrganizationsAuthenticationSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsAuthenticationSettingsRequest.getOrganizationsAuthenticationSettings was successful\")\n dump(response)\n }\n}" - }, - "getorganizationsembeddedintegration": { - "operationId": "getorganizationsembeddedintegration", - "functionName": "getOrganizationsEmbeddedintegration", - "signature": "getOrganizationsEmbeddedintegration()", - "return": "EmbeddedIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of domains that will be allowed to embed PureCloud applications\nGetOrganizationsEmbeddedintegrationRequest.getOrganizationsEmbeddedintegration() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsEmbeddedintegrationRequest.getOrganizationsEmbeddedintegration was successful\")\n dump(response)\n }\n}" - }, - "getorganizationsipaddressauthentication": { - "operationId": "getorganizationsipaddressauthentication", - "functionName": "getOrganizationsIpaddressauthentication", - "signature": "getOrganizationsIpaddressauthentication()", - "return": "IpAddressAuthentication", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get organization IP address whitelist settings\nGetOrganizationsIpaddressauthenticationRequest.getOrganizationsIpaddressauthentication() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsIpaddressauthenticationRequest.getOrganizationsIpaddressauthentication was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitschangerequest": { - "operationId": "getorganizationslimitschangerequest", - "functionName": "getOrganizationsLimitsChangerequest", - "signature": "getOrganizationsLimitsChangerequest(requestId)", - "parameters": [ - { - "name": "requestId", - "type": "String", - "required": "true" - } - ], - "return": "LimitChangeRequestDetails", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet requestId: String = \"\" // Unique id for the limit change request\n\n// Get a limit change request\nGetOrganizationsLimitsChangerequestRequest.getOrganizationsLimitsChangerequest(requestId: requestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsChangerequestRequest.getOrganizationsLimitsChangerequest was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitschangerequests": { - "operationId": "getorganizationslimitschangerequests", - "functionName": "getOrganizationsLimitsChangerequests", - "signature": "getOrganizationsLimitsChangerequests(after, before, status, pageSize, expand)", - "parameters": [ - { - "name": "after", - "type": "Int64", - "required": "false" - }, - { - "name": "before", - "type": "Int64", - "required": "false" - }, - { - "name": "status", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LimitChangeRequestsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet after: Int64 = 0 // Timestamp indicating the date to begin after when searching for requests.\nlet before: Int64 = 0 // Timestamp indicating the date to end before when searching for requests.\nlet status: GetOrganizationsLimitsChangerequestsRequest.Status_getOrganizationsLimitsChangerequests = GetOrganizationsLimitsChangerequestsRequest.Status_getOrganizationsLimitsChangerequests.enummember // Status of the request to be filtered by\nlet pageSize: Int = 0 // Page Size\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get the available limit change requests\nGetOrganizationsLimitsChangerequestsRequest.getOrganizationsLimitsChangerequests(after: after, before: before, status: status, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsChangerequestsRequest.getOrganizationsLimitsChangerequests was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitsdocs": { - "operationId": "getorganizationslimitsdocs", - "functionName": "getOrganizationsLimitsDocs", - "signature": "getOrganizationsLimitsDocs()", - "return": "UrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a link to the limit documentation\nGetOrganizationsLimitsDocsRequest.getOrganizationsLimitsDocs() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsDocsRequest.getOrganizationsLimitsDocs was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitsnamespace": { - "operationId": "getorganizationslimitsnamespace", - "functionName": "getOrganizationsLimitsNamespace", - "signature": "getOrganizationsLimitsNamespace(namespaceName)", - "parameters": [ - { - "name": "namespaceName", - "type": "String", - "required": "true" - } - ], - "return": "LimitsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet namespaceName: String = \"\" // The namespace to fetch limits for\n\n// Get the effective limits in a namespace for an organization\nGetOrganizationsLimitsNamespaceRequest.getOrganizationsLimitsNamespace(namespaceName: namespaceName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsNamespaceRequest.getOrganizationsLimitsNamespace was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitsnamespacedefaults": { - "operationId": "getorganizationslimitsnamespacedefaults", - "functionName": "getOrganizationsLimitsNamespaceDefaults", - "signature": "getOrganizationsLimitsNamespaceDefaults(namespaceName)", - "parameters": [ - { - "name": "namespaceName", - "type": "String", - "required": "true" - } - ], - "return": "LimitsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet namespaceName: String = \"\" // The namespace to fetch defaults limits for\n\n// Get the default limits in a namespace for an organization\nGetOrganizationsLimitsNamespaceDefaultsRequest.getOrganizationsLimitsNamespaceDefaults(namespaceName: namespaceName) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsNamespaceDefaultsRequest.getOrganizationsLimitsNamespaceDefaults was successful\")\n dump(response)\n }\n}" - }, - "getorganizationslimitsnamespaces": { - "operationId": "getorganizationslimitsnamespaces", - "functionName": "getOrganizationsLimitsNamespaces", - "signature": "getOrganizationsLimitsNamespaces(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get the available limit namespaces\nGetOrganizationsLimitsNamespacesRequest.getOrganizationsLimitsNamespaces(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsLimitsNamespacesRequest.getOrganizationsLimitsNamespaces was successful\")\n dump(response)\n }\n}" - }, - "getorganizationsme": { - "operationId": "getorganizationsme", - "functionName": "getOrganizationsMe", - "signature": "getOrganizationsMe()", - "return": "Organization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get organization.\nGetOrganizationsMeRequest.getOrganizationsMe() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsMeRequest.getOrganizationsMe was successful\")\n dump(response)\n }\n}" - }, - "getorganizationswhitelist": { - "operationId": "getorganizationswhitelist", - "functionName": "getOrganizationsWhitelist", - "signature": "getOrganizationsWhitelist()", - "return": "OrgWhitelistSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// This route is deprecated, please use /api/v2/organizations/authentication/settings instead\nGetOrganizationsWhitelistRequest.getOrganizationsWhitelist() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrganizationsWhitelistRequest.getOrganizationsWhitelist was successful\")\n dump(response)\n }\n}" - }, - "patchorganizationsauthenticationsettings": { - "operationId": "patchorganizationsauthenticationsettings", - "functionName": "patchOrganizationsAuthenticationSettings", - "signature": "patchOrganizationsAuthenticationSettings(body)", - "parameters": [ - { - "name": "body", - "type": "OrgAuthSettings", - "required": "true" - } - ], - "return": "OrgAuthSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OrgAuthSettings = new OrgAuthSettings(...) // Org settings\n\n// Update the organization's settings\nPatchOrganizationsAuthenticationSettingsRequest.patchOrganizationsAuthenticationSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchOrganizationsAuthenticationSettingsRequest.patchOrganizationsAuthenticationSettings was successful\")\n dump(response)\n }\n}" - }, - "patchorganizationsfeature": { - "operationId": "patchorganizationsfeature", - "functionName": "patchOrganizationsFeature", - "signature": "patchOrganizationsFeature(featureName, enabled)", - "parameters": [ - { - "name": "featureName", - "type": "String", - "required": "true" - }, - { - "name": "enabled", - "type": "FeatureState", - "required": "true" - } - ], - "return": "OrganizationFeatures", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet featureName: PatchOrganizationsFeatureRequest.FeatureName_patchOrganizationsFeature = PatchOrganizationsFeatureRequest.FeatureName_patchOrganizationsFeature.enummember // Organization feature\nlet enabled: FeatureState = new FeatureState(...) // New state of feature\n\n// Update organization\nPatchOrganizationsFeatureRequest.patchOrganizationsFeature(featureName: featureName, enabled: enabled) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchOrganizationsFeatureRequest.patchOrganizationsFeature was successful\")\n dump(response)\n }\n}" - }, - "putorganizationsembeddedintegration": { - "operationId": "putorganizationsembeddedintegration", - "functionName": "putOrganizationsEmbeddedintegration", - "signature": "putOrganizationsEmbeddedintegration(body)", - "parameters": [ - { - "name": "body", - "type": "EmbeddedIntegration", - "required": "true" - } - ], - "return": "EmbeddedIntegration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EmbeddedIntegration = new EmbeddedIntegration(...) // Whitelist settings\n\n// Update the list of domains that will be allowed to embed PureCloud applications\nPutOrganizationsEmbeddedintegrationRequest.putOrganizationsEmbeddedintegration(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrganizationsEmbeddedintegrationRequest.putOrganizationsEmbeddedintegration was successful\")\n dump(response)\n }\n}" - }, - "putorganizationsipaddressauthentication": { - "operationId": "putorganizationsipaddressauthentication", - "functionName": "putOrganizationsIpaddressauthentication", - "signature": "putOrganizationsIpaddressauthentication(body)", - "parameters": [ - { - "name": "body", - "type": "IpAddressAuthentication", - "required": "true" - } - ], - "return": "IpAddressAuthentication", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: IpAddressAuthentication = new IpAddressAuthentication(...) // IP address Whitelist settings\n\n// Update organization IP address whitelist settings\nPutOrganizationsIpaddressauthenticationRequest.putOrganizationsIpaddressauthentication(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrganizationsIpaddressauthenticationRequest.putOrganizationsIpaddressauthentication was successful\")\n dump(response)\n }\n}" - }, - "putorganizationsme": { - "operationId": "putorganizationsme", - "functionName": "putOrganizationsMe", - "signature": "putOrganizationsMe(body)", - "parameters": [ - { - "name": "body", - "type": "Organization", - "required": "false" - } - ], - "return": "Organization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Organization = new Organization(...) // Organization\n\n// Update organization.\nPutOrganizationsMeRequest.putOrganizationsMe(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrganizationsMeRequest.putOrganizationsMe was successful\")\n dump(response)\n }\n}" - }, - "putorganizationswhitelist": { - "operationId": "putorganizationswhitelist", - "functionName": "putOrganizationsWhitelist", - "signature": "putOrganizationsWhitelist(body)", - "parameters": [ - { - "name": "body", - "type": "OrgWhitelistSettings", - "required": "true" - } - ], - "return": "OrgWhitelistSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OrgWhitelistSettings = new OrgWhitelistSettings(...) // Whitelist settings\n\n// This route is deprecated, please use /api/v2/organizations/authentication/settings instead\nPutOrganizationsWhitelistRequest.putOrganizationsWhitelist(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrganizationsWhitelistRequest.putOrganizationsWhitelist was successful\")\n dump(response)\n }\n}" - }, - "deleteorgauthorizationtrustee": { - "operationId": "deleteorgauthorizationtrustee", - "functionName": "deleteOrgauthorizationTrustee", - "signature": "deleteOrgauthorizationTrustee(trusteeOrgId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\n\n// Delete Org Trust\nDeleteOrgauthorizationTrusteeRequest.deleteOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeRequest.deleteOrgauthorizationTrustee was successful\")\n }\n}" - }, - "deleteorgauthorizationtrusteecloneduser": { - "operationId": "deleteorgauthorizationtrusteecloneduser", - "functionName": "deleteOrgauthorizationTrusteeCloneduser", - "signature": "deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Id of the cloned user to delete\n\n// Deletes cloned user\nDeleteOrgauthorizationTrusteeCloneduserRequest.deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeCloneduserRequest.deleteOrgauthorizationTrusteeCloneduser was successful\")\n }\n}" - }, - "deleteorgauthorizationtrusteegroup": { - "operationId": "deleteorgauthorizationtrusteegroup", - "functionName": "deleteOrgauthorizationTrusteeGroup", - "signature": "deleteOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\n\n// Delete Trustee Group\nDeleteOrgauthorizationTrusteeGroupRequest.deleteOrgauthorizationTrusteeGroup(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeGroupRequest.deleteOrgauthorizationTrusteeGroup was successful\")\n }\n}" - }, - "deleteorgauthorizationtrusteegrouproles": { - "operationId": "deleteorgauthorizationtrusteegrouproles", - "functionName": "deleteOrgauthorizationTrusteeGroupRoles", - "signature": "deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\n\n// Delete Trustee Group Roles\nDeleteOrgauthorizationTrusteeGroupRolesRequest.deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeGroupRolesRequest.deleteOrgauthorizationTrusteeGroupRoles was successful\")\n }\n}" - }, - "deleteorgauthorizationtrusteeuser": { - "operationId": "deleteorgauthorizationtrusteeuser", - "functionName": "deleteOrgauthorizationTrusteeUser", - "signature": "deleteOrgauthorizationTrusteeUser(trusteeOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Delete Trustee User\nDeleteOrgauthorizationTrusteeUserRequest.deleteOrgauthorizationTrusteeUser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeUserRequest.deleteOrgauthorizationTrusteeUser was successful\")\n }\n}" - }, - "deleteorgauthorizationtrusteeuserroles": { - "operationId": "deleteorgauthorizationtrusteeuserroles", - "functionName": "deleteOrgauthorizationTrusteeUserRoles", - "signature": "deleteOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Delete Trustee User Roles\nDeleteOrgauthorizationTrusteeUserRolesRequest.deleteOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrusteeUserRolesRequest.deleteOrgauthorizationTrusteeUserRoles was successful\")\n }\n}" - }, - "deleteorgauthorizationtrustor": { - "operationId": "deleteorgauthorizationtrustor", - "functionName": "deleteOrgauthorizationTrustor", - "signature": "deleteOrgauthorizationTrustor(trustorOrgId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\n\n// Delete Org Trust\nDeleteOrgauthorizationTrustorRequest.deleteOrgauthorizationTrustor(trustorOrgId: trustorOrgId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrustorRequest.deleteOrgauthorizationTrustor was successful\")\n }\n}" - }, - "deleteorgauthorizationtrustorcloneduser": { - "operationId": "deleteorgauthorizationtrustorcloneduser", - "functionName": "deleteOrgauthorizationTrustorCloneduser", - "signature": "deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Delete Cloned User\nDeleteOrgauthorizationTrustorCloneduserRequest.deleteOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrustorCloneduserRequest.deleteOrgauthorizationTrustorCloneduser was successful\")\n }\n}" - }, - "deleteorgauthorizationtrustorgroup": { - "operationId": "deleteorgauthorizationtrustorgroup", - "functionName": "deleteOrgauthorizationTrustorGroup", - "signature": "deleteOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trustorGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trustorGroupId: String = \"\" // Trustor Group Id\n\n// Delete Trustee Group\nDeleteOrgauthorizationTrustorGroupRequest.deleteOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrustorGroupRequest.deleteOrgauthorizationTrustorGroup was successful\")\n }\n}" - }, - "deleteorgauthorizationtrustoruser": { - "operationId": "deleteorgauthorizationtrustoruser", - "functionName": "deleteOrgauthorizationTrustorUser", - "signature": "deleteOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Delete Trustee User\nDeleteOrgauthorizationTrustorUserRequest.deleteOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOrgauthorizationTrustorUserRequest.deleteOrgauthorizationTrustorUser was successful\")\n }\n}" - }, - "getorgauthorizationpairing": { - "operationId": "getorgauthorizationpairing", - "functionName": "getOrgauthorizationPairing", - "signature": "getOrgauthorizationPairing(pairingId)", - "parameters": [ - { - "name": "pairingId", - "type": "String", - "required": "true" - } - ], - "return": "TrustRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pairingId: String = \"\" // Pairing Id\n\n// Get Pairing Info\nGetOrgauthorizationPairingRequest.getOrgauthorizationPairing(pairingId: pairingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationPairingRequest.getOrgauthorizationPairing was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustee": { - "operationId": "getorgauthorizationtrustee", - "functionName": "getOrgauthorizationTrustee", - "signature": "getOrgauthorizationTrustee(trusteeOrgId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - } - ], - "return": "Trustee", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\n\n// Get Org Trust\nGetOrgauthorizationTrusteeRequest.getOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeRequest.getOrgauthorizationTrustee was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteeclonedusers": { - "operationId": "getorgauthorizationtrusteeclonedusers", - "functionName": "getOrgauthorizationTrusteeClonedusers", - "signature": "getOrgauthorizationTrusteeClonedusers(trusteeOrgId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - } - ], - "return": "ClonedUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\n\n// The list of cloned users from the trustee organization (i.e. users with a native user record).\nGetOrgauthorizationTrusteeClonedusersRequest.getOrgauthorizationTrusteeClonedusers(trusteeOrgId: trusteeOrgId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeClonedusersRequest.getOrgauthorizationTrusteeClonedusers was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteegroup": { - "operationId": "getorgauthorizationtrusteegroup", - "functionName": "getOrgauthorizationTrusteeGroup", - "signature": "getOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - } - ], - "return": "TrustGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\n\n// Get Trustee Group\nGetOrgauthorizationTrusteeGroupRequest.getOrgauthorizationTrusteeGroup(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeGroupRequest.getOrgauthorizationTrusteeGroup was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteegrouproles": { - "operationId": "getorgauthorizationtrusteegrouproles", - "functionName": "getOrgauthorizationTrusteeGroupRoles", - "signature": "getOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\n\n// Get Trustee Group Roles\nGetOrgauthorizationTrusteeGroupRolesRequest.getOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeGroupRolesRequest.getOrgauthorizationTrusteeGroupRoles was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteegroups": { - "operationId": "getorgauthorizationtrusteegroups", - "functionName": "getOrgauthorizationTrusteeGroups", - "signature": "getOrgauthorizationTrusteeGroups(trusteeOrgId, pageSize, pageNumber)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of trustee groups for this organization (i.e. groups granted access to this organization).\nGetOrgauthorizationTrusteeGroupsRequest.getOrgauthorizationTrusteeGroups(trusteeOrgId: trusteeOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeGroupsRequest.getOrgauthorizationTrusteeGroups was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteeuser": { - "operationId": "getorgauthorizationtrusteeuser", - "functionName": "getOrgauthorizationTrusteeUser", - "signature": "getOrgauthorizationTrusteeUser(trusteeOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "TrustUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Get Trustee User\nGetOrgauthorizationTrusteeUserRequest.getOrgauthorizationTrusteeUser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeUserRequest.getOrgauthorizationTrusteeUser was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteeuserroles": { - "operationId": "getorgauthorizationtrusteeuserroles", - "functionName": "getOrgauthorizationTrusteeUserRoles", - "signature": "getOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Get Trustee User Roles\nGetOrgauthorizationTrusteeUserRolesRequest.getOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeUserRolesRequest.getOrgauthorizationTrusteeUserRoles was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteeusers": { - "operationId": "getorgauthorizationtrusteeusers", - "functionName": "getOrgauthorizationTrusteeUsers", - "signature": "getOrgauthorizationTrusteeUsers(trusteeOrgId, pageSize, pageNumber)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of trustee users for this organization (i.e. users granted access to this organization).\nGetOrgauthorizationTrusteeUsersRequest.getOrgauthorizationTrusteeUsers(trusteeOrgId: trusteeOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteeUsersRequest.getOrgauthorizationTrusteeUsers was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustees": { - "operationId": "getorgauthorizationtrustees", - "functionName": "getOrgauthorizationTrustees", - "signature": "getOrgauthorizationTrustees(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of trustees for this organization (i.e. organizations granted access to this organization).\nGetOrgauthorizationTrusteesRequest.getOrgauthorizationTrustees(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteesRequest.getOrgauthorizationTrustees was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrusteesdefault": { - "operationId": "getorgauthorizationtrusteesdefault", - "functionName": "getOrgauthorizationTrusteesDefault", - "signature": "getOrgauthorizationTrusteesDefault()", - "return": "Trustee", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get organization authorization trust with Customer Care, if one exists.\nGetOrgauthorizationTrusteesDefaultRequest.getOrgauthorizationTrusteesDefault() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrusteesDefaultRequest.getOrgauthorizationTrusteesDefault was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustor": { - "operationId": "getorgauthorizationtrustor", - "functionName": "getOrgauthorizationTrustor", - "signature": "getOrgauthorizationTrustor(trustorOrgId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - } - ], - "return": "Trustor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\n\n// Get Org Trust\nGetOrgauthorizationTrustorRequest.getOrgauthorizationTrustor(trustorOrgId: trustorOrgId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorRequest.getOrgauthorizationTrustor was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustorcloneduser": { - "operationId": "getorgauthorizationtrustorcloneduser", - "functionName": "getOrgauthorizationTrustorCloneduser", - "signature": "getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "ClonedUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Get Cloned User\nGetOrgauthorizationTrustorCloneduserRequest.getOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorCloneduserRequest.getOrgauthorizationTrustorCloneduser was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustorclonedusers": { - "operationId": "getorgauthorizationtrustorclonedusers", - "functionName": "getOrgauthorizationTrustorClonedusers", - "signature": "getOrgauthorizationTrustorClonedusers(trustorOrgId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - } - ], - "return": "ClonedUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\n\n// The list of cloned users in the trustor organization (i.e. users with a native user record).\nGetOrgauthorizationTrustorClonedusersRequest.getOrgauthorizationTrustorClonedusers(trustorOrgId: trustorOrgId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorClonedusersRequest.getOrgauthorizationTrustorClonedusers was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustorgroup": { - "operationId": "getorgauthorizationtrustorgroup", - "functionName": "getOrgauthorizationTrustorGroup", - "signature": "getOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trustorGroupId", - "type": "String", - "required": "true" - } - ], - "return": "TrustGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trustorGroupId: String = \"\" // Trustor Group Id\n\n// Get Trustee Group\nGetOrgauthorizationTrustorGroupRequest.getOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorGroupRequest.getOrgauthorizationTrustorGroup was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustorgroups": { - "operationId": "getorgauthorizationtrustorgroups", - "functionName": "getOrgauthorizationTrustorGroups", - "signature": "getOrgauthorizationTrustorGroups(trustorOrgId, pageSize, pageNumber)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustee Organization Id\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of groups in the trustor organization (i.e. groups granted access).\nGetOrgauthorizationTrustorGroupsRequest.getOrgauthorizationTrustorGroups(trustorOrgId: trustorOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorGroupsRequest.getOrgauthorizationTrustorGroups was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustoruser": { - "operationId": "getorgauthorizationtrustoruser", - "functionName": "getOrgauthorizationTrustorUser", - "signature": "getOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "TrustUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Get Trustee User\nGetOrgauthorizationTrustorUserRequest.getOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorUserRequest.getOrgauthorizationTrustorUser was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustorusers": { - "operationId": "getorgauthorizationtrustorusers", - "functionName": "getOrgauthorizationTrustorUsers", - "signature": "getOrgauthorizationTrustorUsers(trustorOrgId, pageSize, pageNumber)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustee Organization Id\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of users in the trustor organization (i.e. users granted access).\nGetOrgauthorizationTrustorUsersRequest.getOrgauthorizationTrustorUsers(trustorOrgId: trustorOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorUsersRequest.getOrgauthorizationTrustorUsers was successful\")\n dump(response)\n }\n}" - }, - "getorgauthorizationtrustors": { - "operationId": "getorgauthorizationtrustors", - "functionName": "getOrgauthorizationTrustors", - "signature": "getOrgauthorizationTrustors(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustorEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// The list of organizations that have authorized/trusted your organization.\nGetOrgauthorizationTrustorsRequest.getOrgauthorizationTrustors(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrgauthorizationTrustorsRequest.getOrgauthorizationTrustors was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationpairings": { - "operationId": "postorgauthorizationpairings", - "functionName": "postOrgauthorizationPairings", - "signature": "postOrgauthorizationPairings(body)", - "parameters": [ - { - "name": "body", - "type": "TrustRequestCreate", - "required": "true" - } - ], - "return": "TrustRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TrustRequestCreate = new TrustRequestCreate(...) // Pairing Info\n\n// A pairing id is created by the trustee and given to the trustor to create a trust.\nPostOrgauthorizationPairingsRequest.postOrgauthorizationPairings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationPairingsRequest.postOrgauthorizationPairings was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrusteegroups": { - "operationId": "postorgauthorizationtrusteegroups", - "functionName": "postOrgauthorizationTrusteeGroups", - "signature": "postOrgauthorizationTrusteeGroups(trusteeOrgId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TrustMemberCreate", - "required": "true" - } - ], - "return": "TrustGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet body: TrustMemberCreate = new TrustMemberCreate(...) // Trust\n\n// Add a group to the trust.\nPostOrgauthorizationTrusteeGroupsRequest.postOrgauthorizationTrusteeGroups(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrusteeGroupsRequest.postOrgauthorizationTrusteeGroups was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrusteeusers": { - "operationId": "postorgauthorizationtrusteeusers", - "functionName": "postOrgauthorizationTrusteeUsers", - "signature": "postOrgauthorizationTrusteeUsers(trusteeOrgId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TrustMemberCreate", - "required": "true" - } - ], - "return": "TrustUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet body: TrustMemberCreate = new TrustMemberCreate(...) // Trust\n\n// Add a user to the trust.\nPostOrgauthorizationTrusteeUsersRequest.postOrgauthorizationTrusteeUsers(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrusteeUsersRequest.postOrgauthorizationTrusteeUsers was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrustees": { - "operationId": "postorgauthorizationtrustees", - "functionName": "postOrgauthorizationTrustees", - "signature": "postOrgauthorizationTrustees(body)", - "parameters": [ - { - "name": "body", - "type": "TrustCreate", - "required": "true" - } - ], - "return": "Trustee", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TrustCreate = new TrustCreate(...) // Trust\n\n// Create a new organization authorization trust. This is required to grant other organizations access to your organization.\nPostOrgauthorizationTrusteesRequest.postOrgauthorizationTrustees(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrusteesRequest.postOrgauthorizationTrustees was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrusteesaudits": { - "operationId": "postorgauthorizationtrusteesaudits", - "functionName": "postOrgauthorizationTrusteesAudits", - "signature": "postOrgauthorizationTrusteesAudits(body, pageSize, pageNumber, sortBy, sortOrder)", - "parameters": [ - { - "name": "body", - "type": "TrusteeAuditQueryRequest", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TrusteeAuditQueryRequest = new TrusteeAuditQueryRequest(...) // Values to scope the request.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\n\n// Get Org Trustee Audits\nPostOrgauthorizationTrusteesAuditsRequest.postOrgauthorizationTrusteesAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrusteesAuditsRequest.postOrgauthorizationTrusteesAudits was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrusteesdefault": { - "operationId": "postorgauthorizationtrusteesdefault", - "functionName": "postOrgauthorizationTrusteesDefault", - "signature": "postOrgauthorizationTrusteesDefault(assignDefaultRole, autoExpire)", - "parameters": [ - { - "name": "assignDefaultRole", - "type": "Bool", - "required": "false" - }, - { - "name": "autoExpire", - "type": "Bool", - "required": "false" - } - ], - "return": "Trustee", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assignDefaultRole: Bool = true // Assign Admin role to default pairing with Customer Care\nlet autoExpire: Bool = true // Automatically expire pairing after 30 days\n\n// Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.\nPostOrgauthorizationTrusteesDefaultRequest.postOrgauthorizationTrusteesDefault(assignDefaultRole: assignDefaultRole, autoExpire: autoExpire) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrusteesDefaultRequest.postOrgauthorizationTrusteesDefault was successful\")\n dump(response)\n }\n}" - }, - "postorgauthorizationtrustoraudits": { - "operationId": "postorgauthorizationtrustoraudits", - "functionName": "postOrgauthorizationTrustorAudits", - "signature": "postOrgauthorizationTrustorAudits(body, pageSize, pageNumber, sortBy, sortOrder)", - "parameters": [ - { - "name": "body", - "type": "TrustorAuditQueryRequest", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TrustorAuditQueryRequest = new TrustorAuditQueryRequest(...) // Values to scope the request.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\n\n// Get Org Trustor Audits\nPostOrgauthorizationTrustorAuditsRequest.postOrgauthorizationTrustorAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOrgauthorizationTrustorAuditsRequest.postOrgauthorizationTrustorAudits was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrustee": { - "operationId": "putorgauthorizationtrustee", - "functionName": "putOrgauthorizationTrustee", - "signature": "putOrgauthorizationTrustee(trusteeOrgId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TrustUpdate", - "required": "true" - } - ], - "return": "Trustee", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet body: TrustUpdate = new TrustUpdate(...) // Client\n\n// Update Org Trust\nPutOrgauthorizationTrusteeRequest.putOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrusteeRequest.putOrgauthorizationTrustee was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrusteegrouproledivisions": { - "operationId": "putorgauthorizationtrusteegrouproledivisions", - "functionName": "putOrgauthorizationTrusteeGroupRoledivisions", - "signature": "putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId, trusteeGroupId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoleDivisionGrants", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\nlet body: RoleDivisionGrants = new RoleDivisionGrants(...) // Set of roles with corresponding divisions to apply\n\n// Update Trustee Group Roles\nPutOrgauthorizationTrusteeGroupRoledivisionsRequest.putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrusteeGroupRoledivisionsRequest.putOrgauthorizationTrusteeGroupRoledivisions was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrusteegrouproles": { - "operationId": "putorgauthorizationtrusteegrouproles", - "functionName": "putOrgauthorizationTrusteeGroupRoles", - "signature": "putOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeGroupId: String = \"\" // Trustee Group Id\nlet body: [String] = [\"\"] // List of roles\n\n// Update Trustee Group Roles\nPutOrgauthorizationTrusteeGroupRolesRequest.putOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrusteeGroupRolesRequest.putOrgauthorizationTrusteeGroupRoles was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrusteeuserroledivisions": { - "operationId": "putorgauthorizationtrusteeuserroledivisions", - "functionName": "putOrgauthorizationTrusteeUserRoledivisions", - "signature": "putOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId, trusteeUserId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoleDivisionGrants", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\nlet body: RoleDivisionGrants = new RoleDivisionGrants(...) // Set of roles with corresponding divisions to apply\n\n// Update Trustee User Roles\nPutOrgauthorizationTrusteeUserRoledivisionsRequest.putOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrusteeUserRoledivisionsRequest.putOrgauthorizationTrusteeUserRoledivisions was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrusteeuserroles": { - "operationId": "putorgauthorizationtrusteeuserroles", - "functionName": "putOrgauthorizationTrusteeUserRoles", - "signature": "putOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId, body)", - "parameters": [ - { - "name": "trusteeOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "UserAuthorization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trusteeOrgId: String = \"\" // Trustee Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\nlet body: [String] = [\"\"] // List of roles\n\n// Update Trustee User Roles\nPutOrgauthorizationTrusteeUserRolesRequest.putOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrusteeUserRolesRequest.putOrgauthorizationTrusteeUserRoles was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrustorcloneduser": { - "operationId": "putorgauthorizationtrustorcloneduser", - "functionName": "putOrgauthorizationTrustorCloneduser", - "signature": "putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "ClonedUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Creates a clone of the trustee user in the trustor org.\nPutOrgauthorizationTrustorCloneduserRequest.putOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrustorCloneduserRequest.putOrgauthorizationTrustorCloneduser was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrustorgroup": { - "operationId": "putorgauthorizationtrustorgroup", - "functionName": "putOrgauthorizationTrustorGroup", - "signature": "putOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trustorGroupId", - "type": "String", - "required": "true" - } - ], - "return": "TrustGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trustorGroupId: String = \"\" // Trustor Group Id\n\n// Add a Trustee Group to the trust.\nPutOrgauthorizationTrustorGroupRequest.putOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrustorGroupRequest.putOrgauthorizationTrustorGroup was successful\")\n dump(response)\n }\n}" - }, - "putorgauthorizationtrustoruser": { - "operationId": "putorgauthorizationtrustoruser", - "functionName": "putOrgauthorizationTrustorUser", - "signature": "putOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", - "parameters": [ - { - "name": "trustorOrgId", - "type": "String", - "required": "true" - }, - { - "name": "trusteeUserId", - "type": "String", - "required": "true" - } - ], - "return": "TrustUser", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trustorOrgId: String = \"\" // Trustor Organization Id\nlet trusteeUserId: String = \"\" // Trustee User Id\n\n// Add a Trustee user to the trust.\nPutOrgauthorizationTrustorUserRequest.putOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrgauthorizationTrustorUserRequest.putOrgauthorizationTrustorUser was successful\")\n dump(response)\n }\n}" - }, - "deleteoutboundattemptlimit": { - "operationId": "deleteoutboundattemptlimit", - "functionName": "deleteOutboundAttemptlimit", - "signature": "deleteOutboundAttemptlimit(attemptLimitsId)", - "parameters": [ - { - "name": "attemptLimitsId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet attemptLimitsId: String = \"\" // Attempt limits ID\n\n// Delete attempt limits\nDeleteOutboundAttemptlimitRequest.deleteOutboundAttemptlimit(attemptLimitsId: attemptLimitsId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundAttemptlimitRequest.deleteOutboundAttemptlimit was successful\")\n }\n}" - }, - "deleteoutboundcallabletimeset": { - "operationId": "deleteoutboundcallabletimeset", - "functionName": "deleteOutboundCallabletimeset", - "signature": "deleteOutboundCallabletimeset(callableTimeSetId)", - "parameters": [ - { - "name": "callableTimeSetId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callableTimeSetId: String = \"\" // Callable Time Set ID\n\n// Delete callable time set\nDeleteOutboundCallabletimesetRequest.deleteOutboundCallabletimeset(callableTimeSetId: callableTimeSetId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundCallabletimesetRequest.deleteOutboundCallabletimeset was successful\")\n }\n}" - }, - "deleteoutboundcallanalysisresponseset": { - "operationId": "deleteoutboundcallanalysisresponseset", - "functionName": "deleteOutboundCallanalysisresponseset", - "signature": "deleteOutboundCallanalysisresponseset(callAnalysisSetId)", - "parameters": [ - { - "name": "callAnalysisSetId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callAnalysisSetId: String = \"\" // Call Analysis Response Set ID\n\n// Delete a dialer call analysis response set.\nDeleteOutboundCallanalysisresponsesetRequest.deleteOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundCallanalysisresponsesetRequest.deleteOutboundCallanalysisresponseset was successful\")\n }\n}" - }, - "deleteoutboundcampaign": { - "operationId": "deleteoutboundcampaign", - "functionName": "deleteOutboundCampaign", - "signature": "deleteOutboundCampaign(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "Campaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Delete a campaign.\nDeleteOutboundCampaignRequest.deleteOutboundCampaign(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteOutboundCampaignRequest.deleteOutboundCampaign was successful\")\n dump(response)\n }\n}" - }, - "deleteoutboundcampaignprogress": { - "operationId": "deleteoutboundcampaignprogress", - "functionName": "deleteOutboundCampaignProgress", - "signature": "deleteOutboundCampaignProgress(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Reset campaign progress and recycle the campaign\nDeleteOutboundCampaignProgressRequest.deleteOutboundCampaignProgress(campaignId: campaignId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundCampaignProgressRequest.deleteOutboundCampaignProgress was successful\")\n }\n}" - }, - "deleteoutboundcampaignrule": { - "operationId": "deleteoutboundcampaignrule", - "functionName": "deleteOutboundCampaignrule", - "signature": "deleteOutboundCampaignrule(campaignRuleId)", - "parameters": [ - { - "name": "campaignRuleId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignRuleId: String = \"\" // Campaign Rule ID\n\n// Delete Campaign Rule\nDeleteOutboundCampaignruleRequest.deleteOutboundCampaignrule(campaignRuleId: campaignRuleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundCampaignruleRequest.deleteOutboundCampaignrule was successful\")\n }\n}" - }, - "deleteoutboundcontactlist": { - "operationId": "deleteoutboundcontactlist", - "functionName": "deleteOutboundContactlist", - "signature": "deleteOutboundContactlist(contactListId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\n\n// Delete a contact list.\nDeleteOutboundContactlistRequest.deleteOutboundContactlist(contactListId: contactListId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundContactlistRequest.deleteOutboundContactlist was successful\")\n }\n}" - }, - "deleteoutboundcontactlistcontact": { - "operationId": "deleteoutboundcontactlistcontact", - "functionName": "deleteOutboundContactlistContact", - "signature": "deleteOutboundContactlistContact(contactListId, contactId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "contactId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet contactId: String = \"\" // Contact ID\n\n// Delete a contact.\nDeleteOutboundContactlistContactRequest.deleteOutboundContactlistContact(contactListId: contactListId, contactId: contactId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundContactlistContactRequest.deleteOutboundContactlistContact was successful\")\n }\n}" - }, - "deleteoutboundcontactlistcontacts": { - "operationId": "deleteoutboundcontactlistcontacts", - "functionName": "deleteOutboundContactlistContacts", - "signature": "deleteOutboundContactlistContacts(contactListId, contactIds)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "contactIds", - "type": "[String]", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet contactIds: [String] = [\"\"] // ContactIds to delete.\n\n// Delete contacts from a contact list.\nDeleteOutboundContactlistContactsRequest.deleteOutboundContactlistContacts(contactListId: contactListId, contactIds: contactIds) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundContactlistContactsRequest.deleteOutboundContactlistContacts was successful\")\n }\n}" - }, - "deleteoutboundcontactlistfilter": { - "operationId": "deleteoutboundcontactlistfilter", - "functionName": "deleteOutboundContactlistfilter", - "signature": "deleteOutboundContactlistfilter(contactListFilterId)", - "parameters": [ - { - "name": "contactListFilterId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListFilterId: String = \"\" // Contact List Filter ID\n\n// Delete Contact List Filter\nDeleteOutboundContactlistfilterRequest.deleteOutboundContactlistfilter(contactListFilterId: contactListFilterId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundContactlistfilterRequest.deleteOutboundContactlistfilter was successful\")\n }\n}" - }, - "deleteoutboundcontactlists": { - "operationId": "deleteoutboundcontactlists", - "functionName": "deleteOutboundContactlists", - "signature": "deleteOutboundContactlists(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // contact list id(s) to delete\n\n// Delete multiple contact lists.\nDeleteOutboundContactlistsRequest.deleteOutboundContactlists(_id: _id) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundContactlistsRequest.deleteOutboundContactlists was successful\")\n }\n}" - }, - "deleteoutbounddigitalruleset": { - "operationId": "deleteoutbounddigitalruleset", - "functionName": "deleteOutboundDigitalruleset", - "signature": "deleteOutboundDigitalruleset(digitalRuleSetId)", - "parameters": [ - { - "name": "digitalRuleSetId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet digitalRuleSetId: String = \"\" // The Digital Rule Set ID\n\n// Delete an Outbound Digital Rule Set\nDeleteOutboundDigitalrulesetRequest.deleteOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundDigitalrulesetRequest.deleteOutboundDigitalruleset was successful\")\n }\n}" - }, - "deleteoutbounddnclist": { - "operationId": "deleteoutbounddnclist", - "functionName": "deleteOutboundDnclist", - "signature": "deleteOutboundDnclist(dncListId)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\n\n// Delete dialer DNC list\nDeleteOutboundDnclistRequest.deleteOutboundDnclist(dncListId: dncListId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundDnclistRequest.deleteOutboundDnclist was successful\")\n }\n}" - }, - "deleteoutbounddnclistcustomexclusioncolumns": { - "operationId": "deleteoutbounddnclistcustomexclusioncolumns", - "functionName": "deleteOutboundDnclistCustomexclusioncolumns", - "signature": "deleteOutboundDnclistCustomexclusioncolumns(dncListId, expiredOnly)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "expiredOnly", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired\n\n// Deletes all or expired custom exclusion column entries from a DNC list.\nDeleteOutboundDnclistCustomexclusioncolumnsRequest.deleteOutboundDnclistCustomexclusioncolumns(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundDnclistCustomexclusioncolumnsRequest.deleteOutboundDnclistCustomexclusioncolumns was successful\")\n }\n}" - }, - "deleteoutbounddnclistemailaddresses": { - "operationId": "deleteoutbounddnclistemailaddresses", - "functionName": "deleteOutboundDnclistEmailaddresses", - "signature": "deleteOutboundDnclistEmailaddresses(dncListId, expiredOnly)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "expiredOnly", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired\n\n// Deletes all or expired email addresses from a DNC list.\nDeleteOutboundDnclistEmailaddressesRequest.deleteOutboundDnclistEmailaddresses(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundDnclistEmailaddressesRequest.deleteOutboundDnclistEmailaddresses was successful\")\n }\n}" - }, - "deleteoutbounddnclistphonenumbers": { - "operationId": "deleteoutbounddnclistphonenumbers", - "functionName": "deleteOutboundDnclistPhonenumbers", - "signature": "deleteOutboundDnclistPhonenumbers(dncListId, expiredOnly)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "expiredOnly", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired\n\n// Deletes all or expired phone numbers from a DNC list.\nDeleteOutboundDnclistPhonenumbersRequest.deleteOutboundDnclistPhonenumbers(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundDnclistPhonenumbersRequest.deleteOutboundDnclistPhonenumbers was successful\")\n }\n}" - }, - "deleteoutboundmessagingcampaign": { - "operationId": "deleteoutboundmessagingcampaign", - "functionName": "deleteOutboundMessagingcampaign", - "signature": "deleteOutboundMessagingcampaign(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingCampaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Delete an Outbound Messaging Campaign\nDeleteOutboundMessagingcampaignRequest.deleteOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteOutboundMessagingcampaignRequest.deleteOutboundMessagingcampaign was successful\")\n dump(response)\n }\n}" - }, - "deleteoutboundmessagingcampaignprogress": { - "operationId": "deleteoutboundmessagingcampaignprogress", - "functionName": "deleteOutboundMessagingcampaignProgress", - "signature": "deleteOutboundMessagingcampaignProgress(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Reset messaging campaign progress and recycle the messaging campaign\nDeleteOutboundMessagingcampaignProgressRequest.deleteOutboundMessagingcampaignProgress(messagingCampaignId: messagingCampaignId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundMessagingcampaignProgressRequest.deleteOutboundMessagingcampaignProgress was successful\")\n }\n}" - }, - "deleteoutboundruleset": { - "operationId": "deleteoutboundruleset", - "functionName": "deleteOutboundRuleset", - "signature": "deleteOutboundRuleset(ruleSetId)", - "parameters": [ - { - "name": "ruleSetId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleSetId: String = \"\" // Rule Set ID\n\n// Delete a Rule Set.\nDeleteOutboundRulesetRequest.deleteOutboundRuleset(ruleSetId: ruleSetId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundRulesetRequest.deleteOutboundRuleset was successful\")\n }\n}" - }, - "deleteoutboundschedulescampaign": { - "operationId": "deleteoutboundschedulescampaign", - "functionName": "deleteOutboundSchedulesCampaign", - "signature": "deleteOutboundSchedulesCampaign(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Delete a dialer campaign schedule.\nDeleteOutboundSchedulesCampaignRequest.deleteOutboundSchedulesCampaign(campaignId: campaignId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundSchedulesCampaignRequest.deleteOutboundSchedulesCampaign was successful\")\n }\n}" - }, - "deleteoutboundschedulesemailcampaign": { - "operationId": "deleteoutboundschedulesemailcampaign", - "functionName": "deleteOutboundSchedulesEmailcampaign", - "signature": "deleteOutboundSchedulesEmailcampaign(emailCampaignId)", - "parameters": [ - { - "name": "emailCampaignId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emailCampaignId: String = \"\" // Email Campaign ID\n\n// Delete an email campaign schedule.\nDeleteOutboundSchedulesEmailcampaignRequest.deleteOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundSchedulesEmailcampaignRequest.deleteOutboundSchedulesEmailcampaign was successful\")\n }\n}" - }, - "deleteoutboundschedulesmessagingcampaign": { - "operationId": "deleteoutboundschedulesmessagingcampaign", - "functionName": "deleteOutboundSchedulesMessagingcampaign", - "signature": "deleteOutboundSchedulesMessagingcampaign(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // Messaging Campaign ID\n\n// Delete a messaging campaign schedule.\nDeleteOutboundSchedulesMessagingcampaignRequest.deleteOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundSchedulesMessagingcampaignRequest.deleteOutboundSchedulesMessagingcampaign was successful\")\n }\n}" - }, - "deleteoutboundschedulessequence": { - "operationId": "deleteoutboundschedulessequence", - "functionName": "deleteOutboundSchedulesSequence", - "signature": "deleteOutboundSchedulesSequence(sequenceId)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Sequence ID\n\n// Delete a dialer sequence schedule.\nDeleteOutboundSchedulesSequenceRequest.deleteOutboundSchedulesSequence(sequenceId: sequenceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundSchedulesSequenceRequest.deleteOutboundSchedulesSequence was successful\")\n }\n}" - }, - "deleteoutboundsequence": { - "operationId": "deleteoutboundsequence", - "functionName": "deleteOutboundSequence", - "signature": "deleteOutboundSequence(sequenceId)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Campaign Sequence ID\n\n// Delete a dialer campaign sequence.\nDeleteOutboundSequenceRequest.deleteOutboundSequence(sequenceId: sequenceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteOutboundSequenceRequest.deleteOutboundSequence was successful\")\n }\n}" - }, - "getoutboundattemptlimit": { - "operationId": "getoutboundattemptlimit", - "functionName": "getOutboundAttemptlimit", - "signature": "getOutboundAttemptlimit(attemptLimitsId)", - "parameters": [ - { - "name": "attemptLimitsId", - "type": "String", - "required": "true" - } - ], - "return": "AttemptLimits", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet attemptLimitsId: String = \"\" // Attempt limits ID\n\n// Get attempt limits\nGetOutboundAttemptlimitRequest.getOutboundAttemptlimit(attemptLimitsId: attemptLimitsId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundAttemptlimitRequest.getOutboundAttemptlimit was successful\")\n dump(response)\n }\n}" - }, - "getoutboundattemptlimits": { - "operationId": "getoutboundattemptlimits", - "functionName": "getOutboundAttemptlimits", - "signature": "getOutboundAttemptlimits(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "AttemptLimitsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundAttemptlimitsRequest.FilterType_getOutboundAttemptlimits = GetOutboundAttemptlimitsRequest.FilterType_getOutboundAttemptlimits.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundAttemptlimitsRequest.SortOrder_getOutboundAttemptlimits = GetOutboundAttemptlimitsRequest.SortOrder_getOutboundAttemptlimits.enummember // Sort order\n\n// Query attempt limits list\nGetOutboundAttemptlimitsRequest.getOutboundAttemptlimits(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundAttemptlimitsRequest.getOutboundAttemptlimits was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcallabletimeset": { - "operationId": "getoutboundcallabletimeset", - "functionName": "getOutboundCallabletimeset", - "signature": "getOutboundCallabletimeset(callableTimeSetId)", - "parameters": [ - { - "name": "callableTimeSetId", - "type": "String", - "required": "true" - } - ], - "return": "CallableTimeSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callableTimeSetId: String = \"\" // Callable Time Set ID\n\n// Get callable time set\nGetOutboundCallabletimesetRequest.getOutboundCallabletimeset(callableTimeSetId: callableTimeSetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCallabletimesetRequest.getOutboundCallabletimeset was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcallabletimesets": { - "operationId": "getoutboundcallabletimesets", - "functionName": "getOutboundCallabletimesets", - "signature": "getOutboundCallabletimesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CallableTimeSetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundCallabletimesetsRequest.FilterType_getOutboundCallabletimesets = GetOutboundCallabletimesetsRequest.FilterType_getOutboundCallabletimesets.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundCallabletimesetsRequest.SortOrder_getOutboundCallabletimesets = GetOutboundCallabletimesetsRequest.SortOrder_getOutboundCallabletimesets.enummember // Sort order\n\n// Query callable time set list\nGetOutboundCallabletimesetsRequest.getOutboundCallabletimesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCallabletimesetsRequest.getOutboundCallabletimesets was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcallanalysisresponseset": { - "operationId": "getoutboundcallanalysisresponseset", - "functionName": "getOutboundCallanalysisresponseset", - "signature": "getOutboundCallanalysisresponseset(callAnalysisSetId)", - "parameters": [ - { - "name": "callAnalysisSetId", - "type": "String", - "required": "true" - } - ], - "return": "ResponseSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callAnalysisSetId: String = \"\" // Call Analysis Response Set ID\n\n// Get a dialer call analysis response set.\nGetOutboundCallanalysisresponsesetRequest.getOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCallanalysisresponsesetRequest.getOutboundCallanalysisresponseset was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcallanalysisresponsesets": { - "operationId": "getoutboundcallanalysisresponsesets", - "functionName": "getOutboundCallanalysisresponsesets", - "signature": "getOutboundCallanalysisresponsesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "ResponseSetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundCallanalysisresponsesetsRequest.FilterType_getOutboundCallanalysisresponsesets = GetOutboundCallanalysisresponsesetsRequest.FilterType_getOutboundCallanalysisresponsesets.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundCallanalysisresponsesetsRequest.SortOrder_getOutboundCallanalysisresponsesets = GetOutboundCallanalysisresponsesetsRequest.SortOrder_getOutboundCallanalysisresponsesets.enummember // Sort order\n\n// Query a list of dialer call analysis response sets.\nGetOutboundCallanalysisresponsesetsRequest.getOutboundCallanalysisresponsesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCallanalysisresponsesetsRequest.getOutboundCallanalysisresponsesets was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaign": { - "operationId": "getoutboundcampaign", - "functionName": "getOutboundCampaign", - "signature": "getOutboundCampaign(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "Campaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get dialer campaign.\nGetOutboundCampaignRequest.getOutboundCampaign(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignRequest.getOutboundCampaign was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignagentownedmappingpreviewresults": { - "operationId": "getoutboundcampaignagentownedmappingpreviewresults", - "functionName": "getOutboundCampaignAgentownedmappingpreviewResults", - "signature": "getOutboundCampaignAgentownedmappingpreviewResults(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "AgentOwnedMappingPreviewListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get a preview of how agents will be mapped to this campaign's contact list.\nGetOutboundCampaignAgentownedmappingpreviewResultsRequest.getOutboundCampaignAgentownedmappingpreviewResults(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignAgentownedmappingpreviewResultsRequest.getOutboundCampaignAgentownedmappingpreviewResults was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaigndiagnostics": { - "operationId": "getoutboundcampaigndiagnostics", - "functionName": "getOutboundCampaignDiagnostics", - "signature": "getOutboundCampaignDiagnostics(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignDiagnostics", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get campaign diagnostics\nGetOutboundCampaignDiagnosticsRequest.getOutboundCampaignDiagnostics(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignDiagnosticsRequest.getOutboundCampaignDiagnostics was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaigninteractions": { - "operationId": "getoutboundcampaigninteractions", - "functionName": "getOutboundCampaignInteractions", - "signature": "getOutboundCampaignInteractions(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignInteractions", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get dialer campaign interactions.\nGetOutboundCampaignInteractionsRequest.getOutboundCampaignInteractions(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignInteractionsRequest.getOutboundCampaignInteractions was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignprogress": { - "operationId": "getoutboundcampaignprogress", - "functionName": "getOutboundCampaignProgress", - "signature": "getOutboundCampaignProgress(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignProgress", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get campaign progress\nGetOutboundCampaignProgressRequest.getOutboundCampaignProgress(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignProgressRequest.getOutboundCampaignProgress was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignstats": { - "operationId": "getoutboundcampaignstats", - "functionName": "getOutboundCampaignStats", - "signature": "getOutboundCampaignStats(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignStats", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get statistics about a Dialer Campaign\nGetOutboundCampaignStatsRequest.getOutboundCampaignStats(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignStatsRequest.getOutboundCampaignStats was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignrule": { - "operationId": "getoutboundcampaignrule", - "functionName": "getOutboundCampaignrule", - "signature": "getOutboundCampaignrule(campaignRuleId)", - "parameters": [ - { - "name": "campaignRuleId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignRuleId: String = \"\" // Campaign Rule ID\n\n// Get Campaign Rule\nGetOutboundCampaignruleRequest.getOutboundCampaignrule(campaignRuleId: campaignRuleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignruleRequest.getOutboundCampaignrule was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignrules": { - "operationId": "getoutboundcampaignrules", - "functionName": "getOutboundCampaignrules", - "signature": "getOutboundCampaignrules(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CampaignRuleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundCampaignrulesRequest.FilterType_getOutboundCampaignrules = GetOutboundCampaignrulesRequest.FilterType_getOutboundCampaignrules.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundCampaignrulesRequest.SortOrder_getOutboundCampaignrules = GetOutboundCampaignrulesRequest.SortOrder_getOutboundCampaignrules.enummember // Sort order\n\n// Query Campaign Rule list\nGetOutboundCampaignrulesRequest.getOutboundCampaignrules(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignrulesRequest.getOutboundCampaignrules was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaigns": { - "operationId": "getoutboundcampaigns", - "functionName": "getOutboundCampaigns", - "signature": "getOutboundCampaigns(pageSize, pageNumber, filterType, name, _id, contactListId, dncListIds, distributionQueueId, edgeGroupId, callAnalysisResponseSetId, divisionId, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "contactListId", - "type": "String", - "required": "false" - }, - { - "name": "dncListIds", - "type": "String", - "required": "false" - }, - { - "name": "distributionQueueId", - "type": "String", - "required": "false" - }, - { - "name": "edgeGroupId", - "type": "String", - "required": "false" - }, - { - "name": "callAnalysisResponseSetId", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CampaignEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet filterType: GetOutboundCampaignsRequest.FilterType_getOutboundCampaigns = GetOutboundCampaignsRequest.FilterType_getOutboundCampaigns.enummember // Filter type\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // id\nlet contactListId: String = \"\" // Contact List ID\nlet dncListIds: String = \"\" // DNC list ID\nlet distributionQueueId: String = \"\" // Distribution queue ID\nlet edgeGroupId: String = \"\" // Edge group ID\nlet callAnalysisResponseSetId: String = \"\" // Call analysis response set ID\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundCampaignsRequest.SortOrder_getOutboundCampaigns = GetOutboundCampaignsRequest.SortOrder_getOutboundCampaigns.enummember // Sort order\n\n// Query a list of dialer campaigns.\nGetOutboundCampaignsRequest.getOutboundCampaigns(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, contactListId: contactListId, dncListIds: dncListIds, distributionQueueId: distributionQueueId, edgeGroupId: edgeGroupId, callAnalysisResponseSetId: callAnalysisResponseSetId, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignsRequest.getOutboundCampaigns was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignsall": { - "operationId": "getoutboundcampaignsall", - "functionName": "getOutboundCampaignsAll", - "signature": "getOutboundCampaignsAll(pageSize, pageNumber, _id, name, divisionId, mediaType, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "mediaType", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CommonCampaignEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // Campaign ID(s)\nlet name: String = \"\" // Campaign name(s)\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet mediaType: [String] = [\"\"] // Media type(s)\nlet sortOrder: GetOutboundCampaignsAllRequest.SortOrder_getOutboundCampaignsAll = GetOutboundCampaignsAllRequest.SortOrder_getOutboundCampaignsAll.enummember // Sort order\n\n// Query across all types of campaigns by division\nGetOutboundCampaignsAllRequest.getOutboundCampaignsAll(pageSize: pageSize, pageNumber: pageNumber, _id: _id, name: name, divisionId: divisionId, mediaType: mediaType, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignsAllRequest.getOutboundCampaignsAll was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignsalldivisionviews": { - "operationId": "getoutboundcampaignsalldivisionviews", - "functionName": "getOutboundCampaignsAllDivisionviews", - "signature": "getOutboundCampaignsAllDivisionviews(pageSize, pageNumber, _id, name, divisionId, mediaType, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "mediaType", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CommonCampaignDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // Campaign ID(s)\nlet name: String = \"\" // Campaign name(s)\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet mediaType: [String] = [\"\"] // Media type(s)\nlet sortOrder: GetOutboundCampaignsAllDivisionviewsRequest.SortOrder_getOutboundCampaignsAllDivisionviews = GetOutboundCampaignsAllDivisionviewsRequest.SortOrder_getOutboundCampaignsAllDivisionviews.enummember // Sort order\n\n// Query across all types of campaigns\nGetOutboundCampaignsAllDivisionviewsRequest.getOutboundCampaignsAllDivisionviews(pageSize: pageSize, pageNumber: pageNumber, _id: _id, name: name, divisionId: divisionId, mediaType: mediaType, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignsAllDivisionviewsRequest.getOutboundCampaignsAllDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignsdivisionview": { - "operationId": "getoutboundcampaignsdivisionview", - "functionName": "getOutboundCampaignsDivisionview", - "signature": "getOutboundCampaignsDivisionview(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignDivisionView", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get a basic Campaign information object\nGetOutboundCampaignsDivisionviewRequest.getOutboundCampaignsDivisionview(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignsDivisionviewRequest.getOutboundCampaignsDivisionview was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcampaignsdivisionviews": { - "operationId": "getoutboundcampaignsdivisionviews", - "functionName": "getOutboundCampaignsDivisionviews", - "signature": "getOutboundCampaignsDivisionviews(pageSize, pageNumber, filterType, name, _id, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CampaignDivisionViewListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet filterType: GetOutboundCampaignsDivisionviewsRequest.FilterType_getOutboundCampaignsDivisionviews = GetOutboundCampaignsDivisionviewsRequest.FilterType_getOutboundCampaignsDivisionviews.enummember // Filter type\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // id\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundCampaignsDivisionviewsRequest.SortOrder_getOutboundCampaignsDivisionviews = GetOutboundCampaignsDivisionviewsRequest.SortOrder_getOutboundCampaignsDivisionviews.enummember // Sort order\n\n// Query a list of basic Campaign information objects\nGetOutboundCampaignsDivisionviewsRequest.getOutboundCampaignsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundCampaignsDivisionviewsRequest.getOutboundCampaignsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlist": { - "operationId": "getoutboundcontactlist", - "functionName": "getOutboundContactlist", - "signature": "getOutboundContactlist(contactListId, includeImportStatus, includeSize)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - } - ], - "return": "ContactList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\nlet includeImportStatus: Bool = true // Import status\nlet includeSize: Bool = true // Include size\n\n// Get a dialer contact list.\nGetOutboundContactlistRequest.getOutboundContactlist(contactListId: contactListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistRequest.getOutboundContactlist was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistcontact": { - "operationId": "getoutboundcontactlistcontact", - "functionName": "getOutboundContactlistContact", - "signature": "getOutboundContactlistContact(contactListId, contactId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "contactId", - "type": "String", - "required": "true" - } - ], - "return": "DialerContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet contactId: String = \"\" // Contact ID\n\n// Get a contact.\nGetOutboundContactlistContactRequest.getOutboundContactlistContact(contactListId: contactListId, contactId: contactId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistContactRequest.getOutboundContactlistContact was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistexport": { - "operationId": "getoutboundcontactlistexport", - "functionName": "getOutboundContactlistExport", - "signature": "getOutboundContactlistExport(contactListId, download)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "download", - "type": "String", - "required": "false" - } - ], - "return": "ExportUri", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\nlet download: String = \"\" // Redirect to download uri\n\n// Get the URI of a contact list export.\nGetOutboundContactlistExportRequest.getOutboundContactlistExport(contactListId: contactListId, download: download) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistExportRequest.getOutboundContactlistExport was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistimportstatus": { - "operationId": "getoutboundcontactlistimportstatus", - "functionName": "getOutboundContactlistImportstatus", - "signature": "getOutboundContactlistImportstatus(contactListId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - } - ], - "return": "ImportStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\n\n// Get dialer contactList import status.\nGetOutboundContactlistImportstatusRequest.getOutboundContactlistImportstatus(contactListId: contactListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistImportstatusRequest.getOutboundContactlistImportstatus was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlisttimezonemappingpreview": { - "operationId": "getoutboundcontactlisttimezonemappingpreview", - "functionName": "getOutboundContactlistTimezonemappingpreview", - "signature": "getOutboundContactlistTimezonemappingpreview(contactListId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - } - ], - "return": "TimeZoneMappingPreview", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\n\n// Preview the result of applying Automatic Time Zone Mapping to a contact list\nGetOutboundContactlistTimezonemappingpreviewRequest.getOutboundContactlistTimezonemappingpreview(contactListId: contactListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistTimezonemappingpreviewRequest.getOutboundContactlistTimezonemappingpreview was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistfilter": { - "operationId": "getoutboundcontactlistfilter", - "functionName": "getOutboundContactlistfilter", - "signature": "getOutboundContactlistfilter(contactListFilterId)", - "parameters": [ - { - "name": "contactListFilterId", - "type": "String", - "required": "true" - } - ], - "return": "ContactListFilter", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListFilterId: String = \"\" // Contact List Filter ID\n\n// Get Contact list filter\nGetOutboundContactlistfilterRequest.getOutboundContactlistfilter(contactListFilterId: contactListFilterId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistfilterRequest.getOutboundContactlistfilter was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistfilters": { - "operationId": "getoutboundcontactlistfilters", - "functionName": "getOutboundContactlistfilters", - "signature": "getOutboundContactlistfilters(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder, contactListId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "contactListId", - "type": "String", - "required": "false" - } - ], - "return": "ContactListFilterEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundContactlistfiltersRequest.FilterType_getOutboundContactlistfilters = GetOutboundContactlistfiltersRequest.FilterType_getOutboundContactlistfilters.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundContactlistfiltersRequest.SortOrder_getOutboundContactlistfilters = GetOutboundContactlistfiltersRequest.SortOrder_getOutboundContactlistfilters.enummember // Sort order\nlet contactListId: String = \"\" // Contact List ID\n\n// Query Contact list filters\nGetOutboundContactlistfiltersRequest.getOutboundContactlistfilters(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder, contactListId: contactListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistfiltersRequest.getOutboundContactlistfilters was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlists": { - "operationId": "getoutboundcontactlists", - "functionName": "getOutboundContactlists", - "signature": "getOutboundContactlists(includeImportStatus, includeSize, pageSize, pageNumber, allowEmptyResult, filterType, name, _id, divisionId, sortBy, sortOrder)", - "parameters": [ - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "ContactListEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet includeImportStatus: Bool = true // Include import status\nlet includeSize: Bool = true // Include size\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundContactlistsRequest.FilterType_getOutboundContactlists = GetOutboundContactlistsRequest.FilterType_getOutboundContactlists.enummember // Filter type\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // id\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundContactlistsRequest.SortOrder_getOutboundContactlists = GetOutboundContactlistsRequest.SortOrder_getOutboundContactlists.enummember // Sort order\n\n// Query a list of contact lists.\nGetOutboundContactlistsRequest.getOutboundContactlists(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, _id: _id, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistsRequest.getOutboundContactlists was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistsdivisionview": { - "operationId": "getoutboundcontactlistsdivisionview", - "functionName": "getOutboundContactlistsDivisionview", - "signature": "getOutboundContactlistsDivisionview(contactListId, includeImportStatus, includeSize)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - } - ], - "return": "ContactListDivisionView", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contactlist ID\nlet includeImportStatus: Bool = true // Include import status\nlet includeSize: Bool = true // Include size\n\n// Get a basic ContactList information object\nGetOutboundContactlistsDivisionviewRequest.getOutboundContactlistsDivisionview(contactListId: contactListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistsDivisionviewRequest.getOutboundContactlistsDivisionview was successful\")\n dump(response)\n }\n}" - }, - "getoutboundcontactlistsdivisionviews": { - "operationId": "getoutboundcontactlistsdivisionviews", - "functionName": "getOutboundContactlistsDivisionviews", - "signature": "getOutboundContactlistsDivisionviews(includeImportStatus, includeSize, pageSize, pageNumber, filterType, name, _id, sortBy, sortOrder)", - "parameters": [ - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "ContactListDivisionViewListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet includeImportStatus: Bool = true // Include import status\nlet includeSize: Bool = true // Include size\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet filterType: GetOutboundContactlistsDivisionviewsRequest.FilterType_getOutboundContactlistsDivisionviews = GetOutboundContactlistsDivisionviewsRequest.FilterType_getOutboundContactlistsDivisionviews.enummember // Filter type\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // id\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundContactlistsDivisionviewsRequest.SortOrder_getOutboundContactlistsDivisionviews = GetOutboundContactlistsDivisionviewsRequest.SortOrder_getOutboundContactlistsDivisionviews.enummember // Sort order\n\n// Query a list of simplified contact list objects.\nGetOutboundContactlistsDivisionviewsRequest.getOutboundContactlistsDivisionviews(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundContactlistsDivisionviewsRequest.getOutboundContactlistsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddigitalruleset": { - "operationId": "getoutbounddigitalruleset", - "functionName": "getOutboundDigitalruleset", - "signature": "getOutboundDigitalruleset(digitalRuleSetId)", - "parameters": [ - { - "name": "digitalRuleSetId", - "type": "String", - "required": "true" - } - ], - "return": "DigitalRuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet digitalRuleSetId: String = \"\" // The Digital Rule Set ID\n\n// Get an Outbound Digital Rule Set\nGetOutboundDigitalrulesetRequest.getOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDigitalrulesetRequest.getOutboundDigitalruleset was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddigitalrulesets": { - "operationId": "getoutbounddigitalrulesets", - "functionName": "getOutboundDigitalrulesets", - "signature": "getOutboundDigitalrulesets(pageSize, pageNumber, sortBy, sortOrder, name, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "DigitalRuleSetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet sortBy: GetOutboundDigitalrulesetsRequest.SortBy_getOutboundDigitalrulesets = GetOutboundDigitalrulesetsRequest.SortBy_getOutboundDigitalrulesets.enummember // The field to sort by\nlet sortOrder: GetOutboundDigitalrulesetsRequest.SortOrder_getOutboundDigitalrulesets = GetOutboundDigitalrulesetsRequest.SortOrder_getOutboundDigitalrulesets.enummember // The direction to sort\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // A list of digital rule set ids to bulk fetch\n\n// Query a list of Outbound Digital Rule Sets\nGetOutboundDigitalrulesetsRequest.getOutboundDigitalrulesets(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDigitalrulesetsRequest.getOutboundDigitalrulesets was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclist": { - "operationId": "getoutbounddnclist", - "functionName": "getOutboundDnclist", - "signature": "getOutboundDnclist(dncListId, includeImportStatus, includeSize)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - } - ], - "return": "DncList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet includeImportStatus: Bool = true // Import status\nlet includeSize: Bool = true // Include size\n\n// Get dialer DNC list\nGetOutboundDnclistRequest.getOutboundDnclist(dncListId: dncListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistRequest.getOutboundDnclist was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclistexport": { - "operationId": "getoutbounddnclistexport", - "functionName": "getOutboundDnclistExport", - "signature": "getOutboundDnclistExport(dncListId, download)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "download", - "type": "String", - "required": "false" - } - ], - "return": "ExportUri", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet download: String = \"\" // Redirect to download uri\n\n// Get the URI of a DNC list export.\nGetOutboundDnclistExportRequest.getOutboundDnclistExport(dncListId: dncListId, download: download) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistExportRequest.getOutboundDnclistExport was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclistimportstatus": { - "operationId": "getoutbounddnclistimportstatus", - "functionName": "getOutboundDnclistImportstatus", - "signature": "getOutboundDnclistImportstatus(dncListId)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - } - ], - "return": "ImportStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\n\n// Get dialer dncList import status.\nGetOutboundDnclistImportstatusRequest.getOutboundDnclistImportstatus(dncListId: dncListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistImportstatusRequest.getOutboundDnclistImportstatus was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclists": { - "operationId": "getoutbounddnclists", - "functionName": "getOutboundDnclists", - "signature": "getOutboundDnclists(includeImportStatus, includeSize, pageSize, pageNumber, allowEmptyResult, filterType, name, dncSourceType, divisionId, sortBy, sortOrder)", - "parameters": [ - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "dncSourceType", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DncListEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet includeImportStatus: Bool = true // Import status\nlet includeSize: Bool = true // Include size\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundDnclistsRequest.FilterType_getOutboundDnclists = GetOutboundDnclistsRequest.FilterType_getOutboundDnclists.enummember // Filter type\nlet name: String = \"\" // Name\nlet dncSourceType: GetOutboundDnclistsRequest.DncSourceType_getOutboundDnclists = GetOutboundDnclistsRequest.DncSourceType_getOutboundDnclists.enummember // DncSourceType\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundDnclistsRequest.SortOrder_getOutboundDnclists = GetOutboundDnclistsRequest.SortOrder_getOutboundDnclists.enummember // Sort order\n\n// Query dialer DNC lists\nGetOutboundDnclistsRequest.getOutboundDnclists(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, dncSourceType: dncSourceType, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistsRequest.getOutboundDnclists was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclistsdivisionview": { - "operationId": "getoutbounddnclistsdivisionview", - "functionName": "getOutboundDnclistsDivisionview", - "signature": "getOutboundDnclistsDivisionview(dncListId, includeImportStatus, includeSize)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - } - ], - "return": "DncListDivisionView", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // Dnclist ID\nlet includeImportStatus: Bool = true // Include import status\nlet includeSize: Bool = true // Include size\n\n// Get a basic DncList information object\nGetOutboundDnclistsDivisionviewRequest.getOutboundDnclistsDivisionview(dncListId: dncListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistsDivisionviewRequest.getOutboundDnclistsDivisionview was successful\")\n dump(response)\n }\n}" - }, - "getoutbounddnclistsdivisionviews": { - "operationId": "getoutbounddnclistsdivisionviews", - "functionName": "getOutboundDnclistsDivisionviews", - "signature": "getOutboundDnclistsDivisionviews(includeImportStatus, includeSize, pageSize, pageNumber, filterType, name, dncSourceType, _id, sortBy, sortOrder)", - "parameters": [ - { - "name": "includeImportStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "includeSize", - "type": "Bool", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "dncSourceType", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DncListDivisionViewListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet includeImportStatus: Bool = true // Include import status\nlet includeSize: Bool = true // Include size\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet filterType: GetOutboundDnclistsDivisionviewsRequest.FilterType_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.FilterType_getOutboundDnclistsDivisionviews.enummember // Filter type\nlet name: String = \"\" // Name\nlet dncSourceType: GetOutboundDnclistsDivisionviewsRequest.DncSourceType_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.DncSourceType_getOutboundDnclistsDivisionviews.enummember // DncSourceType\nlet _id: [String] = [\"\"] // id\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundDnclistsDivisionviewsRequest.SortOrder_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.SortOrder_getOutboundDnclistsDivisionviews.enummember // Sort order\n\n// Query a list of simplified dnc list objects.\nGetOutboundDnclistsDivisionviewsRequest.getOutboundDnclistsDivisionviews(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, dncSourceType: dncSourceType, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundDnclistsDivisionviewsRequest.getOutboundDnclistsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getoutboundevent": { - "operationId": "getoutboundevent", - "functionName": "getOutboundEvent", - "signature": "getOutboundEvent(eventId)", - "parameters": [ - { - "name": "eventId", - "type": "String", - "required": "true" - } - ], - "return": "EventLog", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet eventId: String = \"\" // Event Log ID\n\n// Get Dialer Event\nGetOutboundEventRequest.getOutboundEvent(eventId: eventId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundEventRequest.getOutboundEvent was successful\")\n dump(response)\n }\n}" - }, - "getoutboundevents": { - "operationId": "getoutboundevents", - "functionName": "getOutboundEvents", - "signature": "getOutboundEvents(pageSize, pageNumber, filterType, category, level, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "category", - "type": "String", - "required": "false" - }, - { - "name": "level", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DialerEventEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet filterType: GetOutboundEventsRequest.FilterType_getOutboundEvents = GetOutboundEventsRequest.FilterType_getOutboundEvents.enummember // Filter type\nlet category: String = \"\" // Category\nlet level: String = \"\" // Level\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundEventsRequest.SortOrder_getOutboundEvents = GetOutboundEventsRequest.SortOrder_getOutboundEvents.enummember // Sort order\n\n// Query Event Logs\nGetOutboundEventsRequest.getOutboundEvents(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, category: category, level: level, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundEventsRequest.getOutboundEvents was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaign": { - "operationId": "getoutboundmessagingcampaign", - "functionName": "getOutboundMessagingcampaign", - "signature": "getOutboundMessagingcampaign(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingCampaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Get an Outbound Messaging Campaign\nGetOutboundMessagingcampaignRequest.getOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignRequest.getOutboundMessagingcampaign was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaigndiagnostics": { - "operationId": "getoutboundmessagingcampaigndiagnostics", - "functionName": "getOutboundMessagingcampaignDiagnostics", - "signature": "getOutboundMessagingcampaignDiagnostics(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingCampaignDiagnostics", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Get messaging campaign diagnostics\nGetOutboundMessagingcampaignDiagnosticsRequest.getOutboundMessagingcampaignDiagnostics(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignDiagnosticsRequest.getOutboundMessagingcampaignDiagnostics was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaignprogress": { - "operationId": "getoutboundmessagingcampaignprogress", - "functionName": "getOutboundMessagingcampaignProgress", - "signature": "getOutboundMessagingcampaignProgress(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignProgress", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Get messaging campaign's progress\nGetOutboundMessagingcampaignProgressRequest.getOutboundMessagingcampaignProgress(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignProgressRequest.getOutboundMessagingcampaignProgress was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaigns": { - "operationId": "getoutboundmessagingcampaigns", - "functionName": "getOutboundMessagingcampaigns", - "signature": "getOutboundMessagingcampaigns(pageSize, pageNumber, sortBy, sortOrder, name, contactListId, divisionId, type, senderSmsPhoneNumber, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "contactListId", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "senderSmsPhoneNumber", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "MessagingCampaignEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet sortBy: GetOutboundMessagingcampaignsRequest.SortBy_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.SortBy_getOutboundMessagingcampaigns.enummember // The field to sort by\nlet sortOrder: GetOutboundMessagingcampaignsRequest.SortOrder_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.SortOrder_getOutboundMessagingcampaigns.enummember // The direction to sort\nlet name: String = \"\" // Name\nlet contactListId: String = \"\" // Contact List ID\nlet divisionId: [String] = [\"\"] // Division ID(s)\nlet type: GetOutboundMessagingcampaignsRequest.ModelType_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.ModelType_getOutboundMessagingcampaigns.enummember // Campaign Type\nlet senderSmsPhoneNumber: String = \"\" // Sender SMS Phone Number\nlet _id: [String] = [\"\"] // A list of messaging campaign ids to bulk fetch\n\n// Query a list of Messaging Campaigns\nGetOutboundMessagingcampaignsRequest.getOutboundMessagingcampaigns(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, contactListId: contactListId, divisionId: divisionId, type: type, senderSmsPhoneNumber: senderSmsPhoneNumber, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignsRequest.getOutboundMessagingcampaigns was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaignsdivisionview": { - "operationId": "getoutboundmessagingcampaignsdivisionview", - "functionName": "getOutboundMessagingcampaignsDivisionview", - "signature": "getOutboundMessagingcampaignsDivisionview(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingCampaignDivisionView", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\n\n// Get a basic Messaging Campaign information object\nGetOutboundMessagingcampaignsDivisionviewRequest.getOutboundMessagingcampaignsDivisionview(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignsDivisionviewRequest.getOutboundMessagingcampaignsDivisionview was successful\")\n dump(response)\n }\n}" - }, - "getoutboundmessagingcampaignsdivisionviews": { - "operationId": "getoutboundmessagingcampaignsdivisionviews", - "functionName": "getOutboundMessagingcampaignsDivisionviews", - "signature": "getOutboundMessagingcampaignsDivisionviews(pageSize, pageNumber, sortOrder, name, type, _id, senderSmsPhoneNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "senderSmsPhoneNumber", - "type": "String", - "required": "false" - } - ], - "return": "MessagingCampaignDivisionViewEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetOutboundMessagingcampaignsDivisionviewsRequest.SortOrder_getOutboundMessagingcampaignsDivisionviews = GetOutboundMessagingcampaignsDivisionviewsRequest.SortOrder_getOutboundMessagingcampaignsDivisionviews.enummember // The direction to sort\nlet name: String = \"\" // Name\nlet type: GetOutboundMessagingcampaignsDivisionviewsRequest.ModelType_getOutboundMessagingcampaignsDivisionviews = GetOutboundMessagingcampaignsDivisionviewsRequest.ModelType_getOutboundMessagingcampaignsDivisionviews.enummember // Campaign Type\nlet _id: [String] = [\"\"] // id\nlet senderSmsPhoneNumber: String = \"\" // Sender SMS Phone Number\n\n// Query a list of basic Messaging Campaign information objects\nGetOutboundMessagingcampaignsDivisionviewsRequest.getOutboundMessagingcampaignsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name, type: type, _id: _id, senderSmsPhoneNumber: senderSmsPhoneNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundMessagingcampaignsDivisionviewsRequest.getOutboundMessagingcampaignsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getoutboundruleset": { - "operationId": "getoutboundruleset", - "functionName": "getOutboundRuleset", - "signature": "getOutboundRuleset(ruleSetId)", - "parameters": [ - { - "name": "ruleSetId", - "type": "String", - "required": "true" - } - ], - "return": "RuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleSetId: String = \"\" // Rule Set ID\n\n// Get a Rule Set by ID.\nGetOutboundRulesetRequest.getOutboundRuleset(ruleSetId: ruleSetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundRulesetRequest.getOutboundRuleset was successful\")\n dump(response)\n }\n}" - }, - "getoutboundrulesets": { - "operationId": "getoutboundrulesets", - "functionName": "getOutboundRulesets", - "signature": "getOutboundRulesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "RuleSetEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundRulesetsRequest.FilterType_getOutboundRulesets = GetOutboundRulesetsRequest.FilterType_getOutboundRulesets.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundRulesetsRequest.SortOrder_getOutboundRulesets = GetOutboundRulesetsRequest.SortOrder_getOutboundRulesets.enummember // Sort order\n\n// Query a list of Rule Sets.\nGetOutboundRulesetsRequest.getOutboundRulesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundRulesetsRequest.getOutboundRulesets was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulescampaign": { - "operationId": "getoutboundschedulescampaign", - "functionName": "getOutboundSchedulesCampaign", - "signature": "getOutboundSchedulesCampaign(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Get a dialer campaign schedule.\nGetOutboundSchedulesCampaignRequest.getOutboundSchedulesCampaign(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesCampaignRequest.getOutboundSchedulesCampaign was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulescampaigns": { - "operationId": "getoutboundschedulescampaigns", - "functionName": "getOutboundSchedulesCampaigns", - "signature": "getOutboundSchedulesCampaigns()", - "return": "[CampaignSchedule]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Query for a list of dialer campaign schedules.\nGetOutboundSchedulesCampaignsRequest.getOutboundSchedulesCampaigns() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesCampaignsRequest.getOutboundSchedulesCampaigns was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulesemailcampaign": { - "operationId": "getoutboundschedulesemailcampaign", - "functionName": "getOutboundSchedulesEmailcampaign", - "signature": "getOutboundSchedulesEmailcampaign(emailCampaignId)", - "parameters": [ - { - "name": "emailCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "EmailCampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emailCampaignId: String = \"\" // Email Campaign ID\n\n// Get an email campaign schedule.\nGetOutboundSchedulesEmailcampaignRequest.getOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesEmailcampaignRequest.getOutboundSchedulesEmailcampaign was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulesemailcampaigns": { - "operationId": "getoutboundschedulesemailcampaigns", - "functionName": "getOutboundSchedulesEmailcampaigns", - "signature": "getOutboundSchedulesEmailcampaigns()", - "return": "MessagingCampaignScheduleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Query for a list of email campaign schedules.\nGetOutboundSchedulesEmailcampaignsRequest.getOutboundSchedulesEmailcampaigns() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesEmailcampaignsRequest.getOutboundSchedulesEmailcampaigns was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulesmessagingcampaign": { - "operationId": "getoutboundschedulesmessagingcampaign", - "functionName": "getOutboundSchedulesMessagingcampaign", - "signature": "getOutboundSchedulesMessagingcampaign(messagingCampaignId)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - } - ], - "return": "MessagingCampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // Messaging Campaign ID\n\n// Get a messaging campaign schedule.\nGetOutboundSchedulesMessagingcampaignRequest.getOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesMessagingcampaignRequest.getOutboundSchedulesMessagingcampaign was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulesmessagingcampaigns": { - "operationId": "getoutboundschedulesmessagingcampaigns", - "functionName": "getOutboundSchedulesMessagingcampaigns", - "signature": "getOutboundSchedulesMessagingcampaigns()", - "return": "MessagingCampaignScheduleEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Query for a list of messaging campaign schedules.\nGetOutboundSchedulesMessagingcampaignsRequest.getOutboundSchedulesMessagingcampaigns() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesMessagingcampaignsRequest.getOutboundSchedulesMessagingcampaigns was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulessequence": { - "operationId": "getoutboundschedulessequence", - "functionName": "getOutboundSchedulesSequence", - "signature": "getOutboundSchedulesSequence(sequenceId)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - } - ], - "return": "SequenceSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Sequence ID\n\n// Get a dialer sequence schedule.\nGetOutboundSchedulesSequenceRequest.getOutboundSchedulesSequence(sequenceId: sequenceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesSequenceRequest.getOutboundSchedulesSequence was successful\")\n dump(response)\n }\n}" - }, - "getoutboundschedulessequences": { - "operationId": "getoutboundschedulessequences", - "functionName": "getOutboundSchedulesSequences", - "signature": "getOutboundSchedulesSequences()", - "return": "[SequenceSchedule]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Query for a list of dialer sequence schedules.\nGetOutboundSchedulesSequencesRequest.getOutboundSchedulesSequences() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSchedulesSequencesRequest.getOutboundSchedulesSequences was successful\")\n dump(response)\n }\n}" - }, - "getoutboundsequence": { - "operationId": "getoutboundsequence", - "functionName": "getOutboundSequence", - "signature": "getOutboundSequence(sequenceId)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - } - ], - "return": "CampaignSequence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Campaign Sequence ID\n\n// Get a dialer campaign sequence.\nGetOutboundSequenceRequest.getOutboundSequence(sequenceId: sequenceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSequenceRequest.getOutboundSequence was successful\")\n dump(response)\n }\n}" - }, - "getoutboundsequences": { - "operationId": "getoutboundsequences", - "functionName": "getOutboundSequences", - "signature": "getOutboundSequences(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "allowEmptyResult", - "type": "Bool", - "required": "false" - }, - { - "name": "filterType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "CampaignSequenceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size. The max that will be returned is 100.\nlet pageNumber: Int = 0 // Page number\nlet allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page\nlet filterType: GetOutboundSequencesRequest.FilterType_getOutboundSequences = GetOutboundSequencesRequest.FilterType_getOutboundSequences.enummember // Filter type\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: GetOutboundSequencesRequest.SortOrder_getOutboundSequences = GetOutboundSequencesRequest.SortOrder_getOutboundSequences.enummember // Sort order\n\n// Query a list of dialer campaign sequences.\nGetOutboundSequencesRequest.getOutboundSequences(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSequencesRequest.getOutboundSequences was successful\")\n dump(response)\n }\n}" - }, - "getoutboundsettings": { - "operationId": "getoutboundsettings", - "functionName": "getOutboundSettings", - "signature": "getOutboundSettings()", - "return": "OutboundSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the outbound settings for this organization\nGetOutboundSettingsRequest.getOutboundSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundSettingsRequest.getOutboundSettings was successful\")\n dump(response)\n }\n}" - }, - "getoutboundwrapupcodemappings": { - "operationId": "getoutboundwrapupcodemappings", - "functionName": "getOutboundWrapupcodemappings", - "signature": "getOutboundWrapupcodemappings()", - "return": "WrapUpCodeMapping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the Dialer wrap up code mapping.\nGetOutboundWrapupcodemappingsRequest.getOutboundWrapupcodemappings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOutboundWrapupcodemappingsRequest.getOutboundWrapupcodemappings was successful\")\n dump(response)\n }\n}" - }, - "patchoutbounddnclistcustomexclusioncolumns": { - "operationId": "patchoutbounddnclistcustomexclusioncolumns", - "functionName": "patchOutboundDnclistCustomexclusioncolumns", - "signature": "patchOutboundDnclistCustomexclusioncolumns(dncListId, body)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DncPatchCustomExclusionColumnsRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: DncPatchCustomExclusionColumnsRequest = new DncPatchCustomExclusionColumnsRequest(...) // DNC Custom exclusion column entries\n\n// Add entries to or delete entries from a DNC list.\nPatchOutboundDnclistCustomexclusioncolumnsRequest.patchOutboundDnclistCustomexclusioncolumns(dncListId: dncListId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchOutboundDnclistCustomexclusioncolumnsRequest.patchOutboundDnclistCustomexclusioncolumns was successful\")\n }\n}" - }, - "patchoutbounddnclistemailaddresses": { - "operationId": "patchoutbounddnclistemailaddresses", - "functionName": "patchOutboundDnclistEmailaddresses", - "signature": "patchOutboundDnclistEmailaddresses(dncListId, body)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DncPatchEmailsRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: DncPatchEmailsRequest = new DncPatchEmailsRequest(...) // DNC Emails\n\n// Add emails to or Delete emails from a DNC list.\nPatchOutboundDnclistEmailaddressesRequest.patchOutboundDnclistEmailaddresses(dncListId: dncListId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchOutboundDnclistEmailaddressesRequest.patchOutboundDnclistEmailaddresses was successful\")\n }\n}" - }, - "patchoutbounddnclistphonenumbers": { - "operationId": "patchoutbounddnclistphonenumbers", - "functionName": "patchOutboundDnclistPhonenumbers", - "signature": "patchOutboundDnclistPhonenumbers(dncListId, body)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DncPatchPhoneNumbersRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: DncPatchPhoneNumbersRequest = new DncPatchPhoneNumbersRequest(...) // DNC Phone Numbers\n\n// Add numbers to or delete numbers from a DNC list.\nPatchOutboundDnclistPhonenumbersRequest.patchOutboundDnclistPhonenumbers(dncListId: dncListId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchOutboundDnclistPhonenumbersRequest.patchOutboundDnclistPhonenumbers was successful\")\n }\n}" - }, - "patchoutboundsettings": { - "operationId": "patchoutboundsettings", - "functionName": "patchOutboundSettings", - "signature": "patchOutboundSettings(body)", - "parameters": [ - { - "name": "body", - "type": "OutboundSettings", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OutboundSettings = new OutboundSettings(...) // outboundSettings\n\n// Update the outbound settings for this organization\nPatchOutboundSettingsRequest.patchOutboundSettings(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchOutboundSettingsRequest.patchOutboundSettings was successful\")\n }\n}" - }, - "postoutboundattemptlimits": { - "operationId": "postoutboundattemptlimits", - "functionName": "postOutboundAttemptlimits", - "signature": "postOutboundAttemptlimits(body)", - "parameters": [ - { - "name": "body", - "type": "AttemptLimits", - "required": "true" - } - ], - "return": "AttemptLimits", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AttemptLimits = new AttemptLimits(...) // AttemptLimits\n\n// Create attempt limits\nPostOutboundAttemptlimitsRequest.postOutboundAttemptlimits(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundAttemptlimitsRequest.postOutboundAttemptlimits was successful\")\n dump(response)\n }\n}" - }, - "postoutboundaudits": { - "operationId": "postoutboundaudits", - "functionName": "postOutboundAudits", - "signature": "postOutboundAudits(body, pageSize, pageNumber, sortBy, sortOrder, facetsOnly)", - "parameters": [ - { - "name": "body", - "type": "DialerAuditRequest", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "facetsOnly", - "type": "Bool", - "required": "false" - } - ], - "return": "AuditSearchResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DialerAuditRequest = new DialerAuditRequest(...) // AuditSearch\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet facetsOnly: Bool = true // Facets only\n\n// Retrieves audits for dialer.\nPostOutboundAuditsRequest.postOutboundAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, facetsOnly: facetsOnly) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundAuditsRequest.postOutboundAudits was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcallabletimesets": { - "operationId": "postoutboundcallabletimesets", - "functionName": "postOutboundCallabletimesets", - "signature": "postOutboundCallabletimesets(body)", - "parameters": [ - { - "name": "body", - "type": "CallableTimeSet", - "required": "true" - } - ], - "return": "CallableTimeSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CallableTimeSet = new CallableTimeSet(...) // DialerCallableTimeSet\n\n// Create callable time set\nPostOutboundCallabletimesetsRequest.postOutboundCallabletimesets(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCallabletimesetsRequest.postOutboundCallabletimesets was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcallanalysisresponsesets": { - "operationId": "postoutboundcallanalysisresponsesets", - "functionName": "postOutboundCallanalysisresponsesets", - "signature": "postOutboundCallanalysisresponsesets(body)", - "parameters": [ - { - "name": "body", - "type": "ResponseSet", - "required": "true" - } - ], - "return": "ResponseSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ResponseSet = new ResponseSet(...) // ResponseSet\n\n// Create a dialer call analysis response set.\nPostOutboundCallanalysisresponsesetsRequest.postOutboundCallanalysisresponsesets(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCallanalysisresponsesetsRequest.postOutboundCallanalysisresponsesets was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcampaignagentownedmappingpreview": { - "operationId": "postoutboundcampaignagentownedmappingpreview", - "functionName": "postOutboundCampaignAgentownedmappingpreview", - "signature": "postOutboundCampaignAgentownedmappingpreview(campaignId)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\n\n// Initiate request for a preview of how agents will be mapped to this campaign's contact list.\nPostOutboundCampaignAgentownedmappingpreviewRequest.postOutboundCampaignAgentownedmappingpreview(campaignId: campaignId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCampaignAgentownedmappingpreviewRequest.postOutboundCampaignAgentownedmappingpreview was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcampaigncallbackschedule": { - "operationId": "postoutboundcampaigncallbackschedule", - "functionName": "postOutboundCampaignCallbackSchedule", - "signature": "postOutboundCampaignCallbackSchedule(campaignId, body)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ContactCallbackRequest", - "required": "true" - } - ], - "return": "ContactCallbackRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\nlet body: ContactCallbackRequest = new ContactCallbackRequest(...) // ContactCallbackRequest\n\n// Schedule a Callback for a Dialer Campaign (Deprecated)\nPostOutboundCampaignCallbackScheduleRequest.postOutboundCampaignCallbackSchedule(campaignId: campaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCampaignCallbackScheduleRequest.postOutboundCampaignCallbackSchedule was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcampaignrules": { - "operationId": "postoutboundcampaignrules", - "functionName": "postOutboundCampaignrules", - "signature": "postOutboundCampaignrules(body)", - "parameters": [ - { - "name": "body", - "type": "CampaignRule", - "required": "true" - } - ], - "return": "CampaignRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CampaignRule = new CampaignRule(...) // CampaignRule\n\n// Create Campaign Rule\nPostOutboundCampaignrulesRequest.postOutboundCampaignrules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCampaignrulesRequest.postOutboundCampaignrules was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcampaigns": { - "operationId": "postoutboundcampaigns", - "functionName": "postOutboundCampaigns", - "signature": "postOutboundCampaigns(body)", - "parameters": [ - { - "name": "body", - "type": "Campaign", - "required": "true" - } - ], - "return": "Campaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Campaign = new Campaign(...) // Campaign\n\n// Create a campaign.\nPostOutboundCampaignsRequest.postOutboundCampaigns(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCampaignsRequest.postOutboundCampaigns was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcampaignsprogress": { - "operationId": "postoutboundcampaignsprogress", - "functionName": "postOutboundCampaignsProgress", - "signature": "postOutboundCampaignsProgress(body)", - "parameters": [ - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[CampaignProgress]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [String] = [\"\"] // Campaign IDs\n\n// Get progress for a list of campaigns\nPostOutboundCampaignsProgressRequest.postOutboundCampaignsProgress(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundCampaignsProgressRequest.postOutboundCampaignsProgress was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlistclear": { - "operationId": "postoutboundcontactlistclear", - "functionName": "postOutboundContactlistClear", - "signature": "postOutboundContactlistClear(contactListId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\n\n// 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.\nPostOutboundContactlistClearRequest.postOutboundContactlistClear(contactListId: contactListId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostOutboundContactlistClearRequest.postOutboundContactlistClear was successful\")\n }\n}" - }, - "postoutboundcontactlistcontacts": { - "operationId": "postoutboundcontactlistcontacts", - "functionName": "postOutboundContactlistContacts", - "signature": "postOutboundContactlistContacts(contactListId, body, priority, clearSystemData, doNotQueue)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[WritableDialerContact]", - "required": "true" - }, - { - "name": "priority", - "type": "Bool", - "required": "false" - }, - { - "name": "clearSystemData", - "type": "Bool", - "required": "false" - }, - { - "name": "doNotQueue", - "type": "Bool", - "required": "false" - } - ], - "return": "[DialerContact]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet body: [WritableDialerContact] = [new WritableDialerContact(...)] // Contact\nlet priority: Bool = true // Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.\nlet clearSystemData: Bool = true // 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.\nlet doNotQueue: Bool = true // 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.\n\n// Add contacts to a contact list.\nPostOutboundContactlistContactsRequest.postOutboundContactlistContacts(contactListId: contactListId, body: body, priority: priority, clearSystemData: clearSystemData, doNotQueue: doNotQueue) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistContactsRequest.postOutboundContactlistContacts was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlistcontactsbulk": { - "operationId": "postoutboundcontactlistcontactsbulk", - "functionName": "postOutboundContactlistContactsBulk", - "signature": "postOutboundContactlistContactsBulk(contactListId, body)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[DialerContact]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet body: [String] = [\"\"] // ContactIds to get.\n\n// Get contacts from a contact list.\nPostOutboundContactlistContactsBulkRequest.postOutboundContactlistContactsBulk(contactListId: contactListId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistContactsBulkRequest.postOutboundContactlistContactsBulk was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlistexport": { - "operationId": "postoutboundcontactlistexport", - "functionName": "postOutboundContactlistExport", - "signature": "postOutboundContactlistExport(contactListId)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - } - ], - "return": "DomainEntityRef", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\n\n// Initiate the export of a contact list.\nPostOutboundContactlistExportRequest.postOutboundContactlistExport(contactListId: contactListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistExportRequest.postOutboundContactlistExport was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlistfilters": { - "operationId": "postoutboundcontactlistfilters", - "functionName": "postOutboundContactlistfilters", - "signature": "postOutboundContactlistfilters(body)", - "parameters": [ - { - "name": "body", - "type": "ContactListFilter", - "required": "true" - } - ], - "return": "ContactListFilter", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactListFilter = new ContactListFilter(...) // ContactListFilter\n\n// Create Contact List Filter\nPostOutboundContactlistfiltersRequest.postOutboundContactlistfilters(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistfiltersRequest.postOutboundContactlistfilters was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlistfilterspreview": { - "operationId": "postoutboundcontactlistfilterspreview", - "functionName": "postOutboundContactlistfiltersPreview", - "signature": "postOutboundContactlistfiltersPreview(body)", - "parameters": [ - { - "name": "body", - "type": "ContactListFilter", - "required": "true" - } - ], - "return": "FilterPreviewResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactListFilter = new ContactListFilter(...) // ContactListFilter\n\n// Get a preview of the output of a contact list filter\nPostOutboundContactlistfiltersPreviewRequest.postOutboundContactlistfiltersPreview(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistfiltersPreviewRequest.postOutboundContactlistfiltersPreview was successful\")\n dump(response)\n }\n}" - }, - "postoutboundcontactlists": { - "operationId": "postoutboundcontactlists", - "functionName": "postOutboundContactlists", - "signature": "postOutboundContactlists(body)", - "parameters": [ - { - "name": "body", - "type": "ContactList", - "required": "true" - } - ], - "return": "ContactList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactList = new ContactList(...) // ContactList\n\n// Create a contact List.\nPostOutboundContactlistsRequest.postOutboundContactlists(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundContactlistsRequest.postOutboundContactlists was successful\")\n dump(response)\n }\n}" - }, - "postoutboundconversationdnc": { - "operationId": "postoutboundconversationdnc", - "functionName": "postOutboundConversationDnc", - "signature": "postOutboundConversationDnc(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\n\n// Add phone numbers to a Dialer DNC list.\nPostOutboundConversationDncRequest.postOutboundConversationDnc(conversationId: conversationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostOutboundConversationDncRequest.postOutboundConversationDnc was successful\")\n }\n}" - }, - "postoutbounddigitalrulesets": { - "operationId": "postoutbounddigitalrulesets", - "functionName": "postOutboundDigitalrulesets", - "signature": "postOutboundDigitalrulesets(body)", - "parameters": [ - { - "name": "body", - "type": "DigitalRuleSet", - "required": "true" - } - ], - "return": "DigitalRuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DigitalRuleSet = new DigitalRuleSet(...) // Digital Rule Set\n\n// Create an Outbound Digital Rule Set\nPostOutboundDigitalrulesetsRequest.postOutboundDigitalrulesets(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundDigitalrulesetsRequest.postOutboundDigitalrulesets was successful\")\n dump(response)\n }\n}" - }, - "postoutbounddnclistemailaddresses": { - "operationId": "postoutbounddnclistemailaddresses", - "functionName": "postOutboundDnclistEmailaddresses", - "signature": "postOutboundDnclistEmailaddresses(dncListId, body)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: [String] = [\"\"] // DNC email addresses\n\n// Add email addresses to a DNC list.\nPostOutboundDnclistEmailaddressesRequest.postOutboundDnclistEmailaddresses(dncListId: dncListId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostOutboundDnclistEmailaddressesRequest.postOutboundDnclistEmailaddresses was successful\")\n }\n}" - }, - "postoutbounddnclistexport": { - "operationId": "postoutbounddnclistexport", - "functionName": "postOutboundDnclistExport", - "signature": "postOutboundDnclistExport(dncListId)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - } - ], - "return": "DomainEntityRef", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\n\n// Initiate the export of a dnc list.\nPostOutboundDnclistExportRequest.postOutboundDnclistExport(dncListId: dncListId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundDnclistExportRequest.postOutboundDnclistExport was successful\")\n dump(response)\n }\n}" - }, - "postoutbounddnclistphonenumbers": { - "operationId": "postoutbounddnclistphonenumbers", - "functionName": "postOutboundDnclistPhonenumbers", - "signature": "postOutboundDnclistPhonenumbers(dncListId, body, expirationDateTime)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - }, - { - "name": "expirationDateTime", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: [String] = [\"\"] // DNC Phone Numbers\nlet expirationDateTime: String = \"\" // Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format\n\n// Add phone numbers to a DNC list.\nPostOutboundDnclistPhonenumbersRequest.postOutboundDnclistPhonenumbers(dncListId: dncListId, body: body, expirationDateTime: expirationDateTime) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostOutboundDnclistPhonenumbersRequest.postOutboundDnclistPhonenumbers was successful\")\n }\n}" - }, - "postoutbounddnclists": { - "operationId": "postoutbounddnclists", - "functionName": "postOutboundDnclists", - "signature": "postOutboundDnclists(body)", - "parameters": [ - { - "name": "body", - "type": "DncListCreate", - "required": "true" - } - ], - "return": "DncList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DncListCreate = new DncListCreate(...) // DncList\n\n// Create dialer DNC list\nPostOutboundDnclistsRequest.postOutboundDnclists(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundDnclistsRequest.postOutboundDnclists was successful\")\n dump(response)\n }\n}" - }, - "postoutboundmessagingcampaigns": { - "operationId": "postoutboundmessagingcampaigns", - "functionName": "postOutboundMessagingcampaigns", - "signature": "postOutboundMessagingcampaigns(body)", - "parameters": [ - { - "name": "body", - "type": "MessagingCampaign", - "required": "true" - } - ], - "return": "MessagingCampaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MessagingCampaign = new MessagingCampaign(...) // Messaging Campaign\n\n// Create a Messaging Campaign\nPostOutboundMessagingcampaignsRequest.postOutboundMessagingcampaigns(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundMessagingcampaignsRequest.postOutboundMessagingcampaigns was successful\")\n dump(response)\n }\n}" - }, - "postoutboundmessagingcampaignsprogress": { - "operationId": "postoutboundmessagingcampaignsprogress", - "functionName": "postOutboundMessagingcampaignsProgress", - "signature": "postOutboundMessagingcampaignsProgress(body)", - "parameters": [ - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[CampaignProgress]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [String] = [\"\"] // Messaging Campaign IDs\n\n// Get progress for a list of messaging campaigns\nPostOutboundMessagingcampaignsProgressRequest.postOutboundMessagingcampaignsProgress(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundMessagingcampaignsProgressRequest.postOutboundMessagingcampaignsProgress was successful\")\n dump(response)\n }\n}" - }, - "postoutboundrulesets": { - "operationId": "postoutboundrulesets", - "functionName": "postOutboundRulesets", - "signature": "postOutboundRulesets(body)", - "parameters": [ - { - "name": "body", - "type": "RuleSet", - "required": "true" - } - ], - "return": "RuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RuleSet = new RuleSet(...) // RuleSet\n\n// Create a Rule Set.\nPostOutboundRulesetsRequest.postOutboundRulesets(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundRulesetsRequest.postOutboundRulesets was successful\")\n dump(response)\n }\n}" - }, - "postoutboundsequences": { - "operationId": "postoutboundsequences", - "functionName": "postOutboundSequences", - "signature": "postOutboundSequences(body)", - "parameters": [ - { - "name": "body", - "type": "CampaignSequence", - "required": "true" - } - ], - "return": "CampaignSequence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CampaignSequence = new CampaignSequence(...) // Organization\n\n// Create a new campaign sequence.\nPostOutboundSequencesRequest.postOutboundSequences(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostOutboundSequencesRequest.postOutboundSequences was successful\")\n dump(response)\n }\n}" - }, - "putoutboundattemptlimit": { - "operationId": "putoutboundattemptlimit", - "functionName": "putOutboundAttemptlimit", - "signature": "putOutboundAttemptlimit(attemptLimitsId, body)", - "parameters": [ - { - "name": "attemptLimitsId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AttemptLimits", - "required": "true" - } - ], - "return": "AttemptLimits", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet attemptLimitsId: String = \"\" // Attempt limits ID\nlet body: AttemptLimits = new AttemptLimits(...) // AttemptLimits\n\n// Update attempt limits\nPutOutboundAttemptlimitRequest.putOutboundAttemptlimit(attemptLimitsId: attemptLimitsId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundAttemptlimitRequest.putOutboundAttemptlimit was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcallabletimeset": { - "operationId": "putoutboundcallabletimeset", - "functionName": "putOutboundCallabletimeset", - "signature": "putOutboundCallabletimeset(callableTimeSetId, body)", - "parameters": [ - { - "name": "callableTimeSetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CallableTimeSet", - "required": "true" - } - ], - "return": "CallableTimeSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callableTimeSetId: String = \"\" // Callable Time Set ID\nlet body: CallableTimeSet = new CallableTimeSet(...) // DialerCallableTimeSet\n\n// Update callable time set\nPutOutboundCallabletimesetRequest.putOutboundCallabletimeset(callableTimeSetId: callableTimeSetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundCallabletimesetRequest.putOutboundCallabletimeset was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcallanalysisresponseset": { - "operationId": "putoutboundcallanalysisresponseset", - "functionName": "putOutboundCallanalysisresponseset", - "signature": "putOutboundCallanalysisresponseset(callAnalysisSetId, body)", - "parameters": [ - { - "name": "callAnalysisSetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ResponseSet", - "required": "true" - } - ], - "return": "ResponseSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet callAnalysisSetId: String = \"\" // Call Analysis Response Set ID\nlet body: ResponseSet = new ResponseSet(...) // ResponseSet\n\n// Update a dialer call analysis response set.\nPutOutboundCallanalysisresponsesetRequest.putOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundCallanalysisresponsesetRequest.putOutboundCallanalysisresponseset was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcampaign": { - "operationId": "putoutboundcampaign", - "functionName": "putOutboundCampaign", - "signature": "putOutboundCampaign(campaignId, body)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Campaign", - "required": "true" - } - ], - "return": "Campaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\nlet body: Campaign = new Campaign(...) // Campaign\n\n// Update a campaign.\nPutOutboundCampaignRequest.putOutboundCampaign(campaignId: campaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundCampaignRequest.putOutboundCampaign was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcampaignagent": { - "operationId": "putoutboundcampaignagent", - "functionName": "putOutboundCampaignAgent", - "signature": "putOutboundCampaignAgent(campaignId, userId, body)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Agent", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\nlet userId: String = \"\" // Agent's user ID\nlet body: Agent = new Agent(...) // agent\n\n// Send notification that an agent's state changed \nPutOutboundCampaignAgentRequest.putOutboundCampaignAgent(campaignId: campaignId, userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundCampaignAgentRequest.putOutboundCampaignAgent was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcampaignrule": { - "operationId": "putoutboundcampaignrule", - "functionName": "putOutboundCampaignrule", - "signature": "putOutboundCampaignrule(campaignRuleId, body)", - "parameters": [ - { - "name": "campaignRuleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CampaignRule", - "required": "true" - } - ], - "return": "CampaignRule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignRuleId: String = \"\" // Campaign Rule ID\nlet body: CampaignRule = new CampaignRule(...) // CampaignRule\n\n// Update Campaign Rule\nPutOutboundCampaignruleRequest.putOutboundCampaignrule(campaignRuleId: campaignRuleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundCampaignruleRequest.putOutboundCampaignrule was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcontactlist": { - "operationId": "putoutboundcontactlist", - "functionName": "putOutboundContactlist", - "signature": "putOutboundContactlist(contactListId, body)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ContactList", - "required": "true" - } - ], - "return": "ContactList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // ContactList ID\nlet body: ContactList = new ContactList(...) // ContactList\n\n// Update a contact list.\nPutOutboundContactlistRequest.putOutboundContactlist(contactListId: contactListId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundContactlistRequest.putOutboundContactlist was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcontactlistcontact": { - "operationId": "putoutboundcontactlistcontact", - "functionName": "putOutboundContactlistContact", - "signature": "putOutboundContactlistContact(contactListId, contactId, body)", - "parameters": [ - { - "name": "contactListId", - "type": "String", - "required": "true" - }, - { - "name": "contactId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DialerContact", - "required": "true" - } - ], - "return": "DialerContact", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListId: String = \"\" // Contact List ID\nlet contactId: String = \"\" // Contact ID\nlet body: DialerContact = new DialerContact(...) // Contact\n\n// Update a contact.\nPutOutboundContactlistContactRequest.putOutboundContactlistContact(contactListId: contactListId, contactId: contactId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundContactlistContactRequest.putOutboundContactlistContact was successful\")\n dump(response)\n }\n}" - }, - "putoutboundcontactlistfilter": { - "operationId": "putoutboundcontactlistfilter", - "functionName": "putOutboundContactlistfilter", - "signature": "putOutboundContactlistfilter(contactListFilterId, body)", - "parameters": [ - { - "name": "contactListFilterId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ContactListFilter", - "required": "true" - } - ], - "return": "ContactListFilter", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactListFilterId: String = \"\" // Contact List Filter ID\nlet body: ContactListFilter = new ContactListFilter(...) // ContactListFilter\n\n// Update Contact List Filter\nPutOutboundContactlistfilterRequest.putOutboundContactlistfilter(contactListFilterId: contactListFilterId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundContactlistfilterRequest.putOutboundContactlistfilter was successful\")\n dump(response)\n }\n}" - }, - "putoutbounddigitalruleset": { - "operationId": "putoutbounddigitalruleset", - "functionName": "putOutboundDigitalruleset", - "signature": "putOutboundDigitalruleset(digitalRuleSetId, body)", - "parameters": [ - { - "name": "digitalRuleSetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DigitalRuleSet", - "required": "true" - } - ], - "return": "DigitalRuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet digitalRuleSetId: String = \"\" // The Digital Rule Set ID\nlet body: DigitalRuleSet = new DigitalRuleSet(...) // Digital Rule Set\n\n// Update an Outbound Digital Rule Set\nPutOutboundDigitalrulesetRequest.putOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundDigitalrulesetRequest.putOutboundDigitalruleset was successful\")\n dump(response)\n }\n}" - }, - "putoutbounddnclist": { - "operationId": "putoutbounddnclist", - "functionName": "putOutboundDnclist", - "signature": "putOutboundDnclist(dncListId, body)", - "parameters": [ - { - "name": "dncListId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DncList", - "required": "true" - } - ], - "return": "DncList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dncListId: String = \"\" // DncList ID\nlet body: DncList = new DncList(...) // DncList\n\n// Update dialer DNC list\nPutOutboundDnclistRequest.putOutboundDnclist(dncListId: dncListId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundDnclistRequest.putOutboundDnclist was successful\")\n dump(response)\n }\n}" - }, - "putoutboundmessagingcampaign": { - "operationId": "putoutboundmessagingcampaign", - "functionName": "putOutboundMessagingcampaign", - "signature": "putOutboundMessagingcampaign(messagingCampaignId, body)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MessagingCampaign", - "required": "true" - } - ], - "return": "MessagingCampaign", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // The Messaging Campaign ID\nlet body: MessagingCampaign = new MessagingCampaign(...) // MessagingCampaign\n\n// Update an Outbound Messaging Campaign\nPutOutboundMessagingcampaignRequest.putOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundMessagingcampaignRequest.putOutboundMessagingcampaign was successful\")\n dump(response)\n }\n}" - }, - "putoutboundruleset": { - "operationId": "putoutboundruleset", - "functionName": "putOutboundRuleset", - "signature": "putOutboundRuleset(ruleSetId, body)", - "parameters": [ - { - "name": "ruleSetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RuleSet", - "required": "true" - } - ], - "return": "RuleSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleSetId: String = \"\" // Rule Set ID\nlet body: RuleSet = new RuleSet(...) // RuleSet\n\n// Update a Rule Set.\nPutOutboundRulesetRequest.putOutboundRuleset(ruleSetId: ruleSetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundRulesetRequest.putOutboundRuleset was successful\")\n dump(response)\n }\n}" - }, - "putoutboundschedulescampaign": { - "operationId": "putoutboundschedulescampaign", - "functionName": "putOutboundSchedulesCampaign", - "signature": "putOutboundSchedulesCampaign(campaignId, body)", - "parameters": [ - { - "name": "campaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CampaignSchedule", - "required": "true" - } - ], - "return": "CampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet campaignId: String = \"\" // Campaign ID\nlet body: CampaignSchedule = new CampaignSchedule(...) // CampaignSchedule\n\n// Update a new campaign schedule.\nPutOutboundSchedulesCampaignRequest.putOutboundSchedulesCampaign(campaignId: campaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundSchedulesCampaignRequest.putOutboundSchedulesCampaign was successful\")\n dump(response)\n }\n}" - }, - "putoutboundschedulesemailcampaign": { - "operationId": "putoutboundschedulesemailcampaign", - "functionName": "putOutboundSchedulesEmailcampaign", - "signature": "putOutboundSchedulesEmailcampaign(emailCampaignId, body)", - "parameters": [ - { - "name": "emailCampaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EmailCampaignSchedule", - "required": "true" - } - ], - "return": "EmailCampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet emailCampaignId: String = \"\" // Email Campaign ID\nlet body: EmailCampaignSchedule = new EmailCampaignSchedule(...) // EmailCampaignSchedule\n\n// Update an email campaign schedule.\nPutOutboundSchedulesEmailcampaignRequest.putOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundSchedulesEmailcampaignRequest.putOutboundSchedulesEmailcampaign was successful\")\n dump(response)\n }\n}" - }, - "putoutboundschedulesmessagingcampaign": { - "operationId": "putoutboundschedulesmessagingcampaign", - "functionName": "putOutboundSchedulesMessagingcampaign", - "signature": "putOutboundSchedulesMessagingcampaign(messagingCampaignId, body)", - "parameters": [ - { - "name": "messagingCampaignId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MessagingCampaignSchedule", - "required": "true" - } - ], - "return": "MessagingCampaignSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messagingCampaignId: String = \"\" // Messaging Campaign ID\nlet body: MessagingCampaignSchedule = new MessagingCampaignSchedule(...) // MessagingCampaignSchedule\n\n// Update a new messaging campaign schedule.\nPutOutboundSchedulesMessagingcampaignRequest.putOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundSchedulesMessagingcampaignRequest.putOutboundSchedulesMessagingcampaign was successful\")\n dump(response)\n }\n}" - }, - "putoutboundschedulessequence": { - "operationId": "putoutboundschedulessequence", - "functionName": "putOutboundSchedulesSequence", - "signature": "putOutboundSchedulesSequence(sequenceId, body)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SequenceSchedule", - "required": "true" - } - ], - "return": "SequenceSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Sequence ID\nlet body: SequenceSchedule = new SequenceSchedule(...) // SequenceSchedule\n\n// Update a new sequence schedule.\nPutOutboundSchedulesSequenceRequest.putOutboundSchedulesSequence(sequenceId: sequenceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundSchedulesSequenceRequest.putOutboundSchedulesSequence was successful\")\n dump(response)\n }\n}" - }, - "putoutboundsequence": { - "operationId": "putoutboundsequence", - "functionName": "putOutboundSequence", - "signature": "putOutboundSequence(sequenceId, body)", - "parameters": [ - { - "name": "sequenceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CampaignSequence", - "required": "true" - } - ], - "return": "CampaignSequence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sequenceId: String = \"\" // Campaign Sequence ID\nlet body: CampaignSequence = new CampaignSequence(...) // Organization\n\n// Update a new campaign sequence.\nPutOutboundSequenceRequest.putOutboundSequence(sequenceId: sequenceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundSequenceRequest.putOutboundSequence was successful\")\n dump(response)\n }\n}" - }, - "putoutboundwrapupcodemappings": { - "operationId": "putoutboundwrapupcodemappings", - "functionName": "putOutboundWrapupcodemappings", - "signature": "putOutboundWrapupcodemappings(body)", - "parameters": [ - { - "name": "body", - "type": "WrapUpCodeMapping", - "required": "true" - } - ], - "return": "WrapUpCodeMapping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WrapUpCodeMapping = new WrapUpCodeMapping(...) // wrapUpCodeMapping\n\n// Update the Dialer wrap up code mapping.\nPutOutboundWrapupcodemappingsRequest.putOutboundWrapupcodemappings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOutboundWrapupcodemappingsRequest.putOutboundWrapupcodemappings was successful\")\n dump(response)\n }\n}" - }, - "deletepresencesource": { - "operationId": "deletepresencesource", - "functionName": "deletePresenceSource", - "signature": "deletePresenceSource(sourceId)", - "parameters": [ - { - "name": "sourceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sourceId: String = \"\" // Presence Source ID\n\n// Delete a Presence Source\nDeletePresenceSourceRequest.deletePresenceSource(sourceId: sourceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeletePresenceSourceRequest.deletePresenceSource was successful\")\n }\n}" - }, - "deletepresencedefinition": { - "operationId": "deletepresencedefinition", - "functionName": "deletePresencedefinition", - "signature": "deletePresencedefinition(presenceId)", - "parameters": [ - { - "name": "presenceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet presenceId: String = \"\" // Organization Presence ID\n\n// Delete a Presence Definition\nDeletePresencedefinitionRequest.deletePresencedefinition(presenceId: presenceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeletePresencedefinitionRequest.deletePresencedefinition was successful\")\n }\n}" - }, - "getpresencesettings": { - "operationId": "getpresencesettings", - "functionName": "getPresenceSettings", - "signature": "getPresenceSettings()", - "return": "PresenceSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the presence settings\nGetPresenceSettingsRequest.getPresenceSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresenceSettingsRequest.getPresenceSettings was successful\")\n dump(response)\n }\n}" - }, - "getpresencesource": { - "operationId": "getpresencesource", - "functionName": "getPresenceSource", - "signature": "getPresenceSource(sourceId)", - "parameters": [ - { - "name": "sourceId", - "type": "String", - "required": "true" - } - ], - "return": "Source", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sourceId: String = \"\" // Presence Source ID\n\n// Get a Presence Source\nGetPresenceSourceRequest.getPresenceSource(sourceId: sourceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresenceSourceRequest.getPresenceSource was successful\")\n dump(response)\n }\n}" - }, - "getpresencesources": { - "operationId": "getpresencesources", - "functionName": "getPresenceSources", - "signature": "getPresenceSources(deactivated)", - "parameters": [ - { - "name": "deactivated", - "type": "String", - "required": "false" - } - ], - "return": "SourceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deactivated: String = \"\" // Deactivated query can be TRUE or FALSE\n\n// Get a list of Presence Sources\nGetPresenceSourcesRequest.getPresenceSources(deactivated: deactivated) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresenceSourcesRequest.getPresenceSources was successful\")\n dump(response)\n }\n}" - }, - "getpresenceuserprimarysource": { - "operationId": "getpresenceuserprimarysource", - "functionName": "getPresenceUserPrimarysource", - "signature": "getPresenceUserPrimarysource(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "UserPrimarySource", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user ID\n\n// Get a user's Primary Presence Source\nGetPresenceUserPrimarysourceRequest.getPresenceUserPrimarysource(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresenceUserPrimarysourceRequest.getPresenceUserPrimarysource was successful\")\n dump(response)\n }\n}" - }, - "getpresencedefinition": { - "operationId": "getpresencedefinition", - "functionName": "getPresencedefinition", - "signature": "getPresencedefinition(presenceId, localeCode)", - "parameters": [ - { - "name": "presenceId", - "type": "String", - "required": "true" - }, - { - "name": "localeCode", - "type": "String", - "required": "false" - } - ], - "return": "OrganizationPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet presenceId: String = \"\" // Organization Presence ID\nlet localeCode: String = \"\" // The locale code to fetch for the presence definition. Use ALL to fetch everything.\n\n// Get a Presence Definition\nGetPresencedefinitionRequest.getPresencedefinition(presenceId: presenceId, localeCode: localeCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresencedefinitionRequest.getPresencedefinition was successful\")\n dump(response)\n }\n}" - }, - "getpresencedefinitions": { - "operationId": "getpresencedefinitions", - "functionName": "getPresencedefinitions", - "signature": "getPresencedefinitions(pageNumber, pageSize, deleted, localeCode)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "deleted", - "type": "String", - "required": "false" - }, - { - "name": "localeCode", - "type": "String", - "required": "false" - } - ], - "return": "OrganizationPresenceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet deleted: String = \"\" // Deleted query can be TRUE, FALSE or ALL\nlet localeCode: String = \"\" // The locale code to fetch for each presence definition. Use ALL to fetch everything.\n\n// Get an Organization's list of Presence Definitions\nGetPresencedefinitionsRequest.getPresencedefinitions(pageNumber: pageNumber, pageSize: pageSize, deleted: deleted, localeCode: localeCode) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetPresencedefinitionsRequest.getPresencedefinitions was successful\")\n dump(response)\n }\n}" - }, - "getsystempresences": { - "operationId": "getsystempresences", - "functionName": "getSystempresences", - "signature": "getSystempresences()", - "return": "[SystemPresence]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of SystemPresences\nGetSystempresencesRequest.getSystempresences() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSystempresencesRequest.getSystempresences was successful\")\n dump(response)\n }\n}" - }, - "getuserpresence": { - "operationId": "getuserpresence", - "functionName": "getUserPresence", - "signature": "getUserPresence(userId, sourceId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "sourceId", - "type": "String", - "required": "true" - } - ], - "return": "UserPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\nlet sourceId: String = \"\" // Presence source ID\n\n// Get a user's Presence\nGetUserPresenceRequest.getUserPresence(userId: userId, sourceId: sourceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserPresenceRequest.getUserPresence was successful\")\n dump(response)\n }\n}" - }, - "getuserpresencespurecloud": { - "operationId": "getuserpresencespurecloud", - "functionName": "getUserPresencesPurecloud", - "signature": "getUserPresencesPurecloud(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "UserPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\n\n// Get a user's Genesys Cloud presence.\nGetUserPresencesPurecloudRequest.getUserPresencesPurecloud(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserPresencesPurecloudRequest.getUserPresencesPurecloud was successful\")\n dump(response)\n }\n}" - }, - "getuserspresencebulk": { - "operationId": "getuserspresencebulk", - "functionName": "getUsersPresenceBulk", - "signature": "getUsersPresenceBulk(sourceId, _id)", - "parameters": [ - { - "name": "sourceId", - "type": "String", - "required": "true" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "[UcUserPresence]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sourceId: String = \"\" // The requested presence source ID.\nlet _id: [String] = [\"\"] // A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.\n\n// Get bulk user presences for a single presence source\nGetUsersPresenceBulkRequest.getUsersPresenceBulk(sourceId: sourceId, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersPresenceBulkRequest.getUsersPresenceBulk was successful\")\n dump(response)\n }\n}" - }, - "getuserspresencespurecloudbulk": { - "operationId": "getuserspresencespurecloudbulk", - "functionName": "getUsersPresencesPurecloudBulk", - "signature": "getUsersPresencesPurecloudBulk(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "[UcUserPresence]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.\n\n// Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source\nGetUsersPresencesPurecloudBulkRequest.getUsersPresencesPurecloudBulk(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersPresencesPurecloudBulkRequest.getUsersPresencesPurecloudBulk was successful\")\n dump(response)\n }\n}" - }, - "patchuserpresence": { - "operationId": "patchuserpresence", - "functionName": "patchUserPresence", - "signature": "patchUserPresence(userId, sourceId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "sourceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserPresence", - "required": "true" - } - ], - "return": "UserPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\nlet sourceId: String = \"\" // Presence source ID\nlet body: UserPresence = new UserPresence(...) // User presence\n\n// Patch a user's Presence\nPatchUserPresenceRequest.patchUserPresence(userId: userId, sourceId: sourceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserPresenceRequest.patchUserPresence was successful\")\n dump(response)\n }\n}" - }, - "patchuserpresencespurecloud": { - "operationId": "patchuserpresencespurecloud", - "functionName": "patchUserPresencesPurecloud", - "signature": "patchUserPresencesPurecloud(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserPresence", - "required": "true" - } - ], - "return": "UserPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user Id\nlet body: UserPresence = new UserPresence(...) // User presence\n\n// Patch a Genesys Cloud user's presence\nPatchUserPresencesPurecloudRequest.patchUserPresencesPurecloud(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserPresencesPurecloudRequest.patchUserPresencesPurecloud was successful\")\n dump(response)\n }\n}" - }, - "postpresencesources": { - "operationId": "postpresencesources", - "functionName": "postPresenceSources", - "signature": "postPresenceSources(body)", - "parameters": [ - { - "name": "body", - "type": "Source", - "required": "true" - } - ], - "return": "Source", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Source = new Source(...) // The Presence Source to create\n\n// Create a Presence Source\nPostPresenceSourcesRequest.postPresenceSources(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostPresenceSourcesRequest.postPresenceSources was successful\")\n dump(response)\n }\n}" - }, - "postpresencedefinitions": { - "operationId": "postpresencedefinitions", - "functionName": "postPresencedefinitions", - "signature": "postPresencedefinitions(body)", - "parameters": [ - { - "name": "body", - "type": "OrganizationPresence", - "required": "true" - } - ], - "return": "OrganizationPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OrganizationPresence = new OrganizationPresence(...) // The Presence Definition to create\n\n// Create a Presence Definition\nPostPresencedefinitionsRequest.postPresencedefinitions(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostPresencedefinitionsRequest.postPresencedefinitions was successful\")\n dump(response)\n }\n}" - }, - "putpresencesettings": { - "operationId": "putpresencesettings", - "functionName": "putPresenceSettings", - "signature": "putPresenceSettings(body)", - "parameters": [ - { - "name": "body", - "type": "PresenceSettings", - "required": "true" - } - ], - "return": "PresenceSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PresenceSettings = new PresenceSettings(...) // Presence Settings\n\n// Update the presence settings\nPutPresenceSettingsRequest.putPresenceSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutPresenceSettingsRequest.putPresenceSettings was successful\")\n dump(response)\n }\n}" - }, - "putpresencesource": { - "operationId": "putpresencesource", - "functionName": "putPresenceSource", - "signature": "putPresenceSource(sourceId, body)", - "parameters": [ - { - "name": "sourceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Source", - "required": "true" - } - ], - "return": "Source", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sourceId: String = \"\" // Presence Source ID\nlet body: Source = new Source(...) // The updated Presence Source\n\n// Update a Presence Source\nPutPresenceSourceRequest.putPresenceSource(sourceId: sourceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutPresenceSourceRequest.putPresenceSource was successful\")\n dump(response)\n }\n}" - }, - "putpresenceuserprimarysource": { - "operationId": "putpresenceuserprimarysource", - "functionName": "putPresenceUserPrimarysource", - "signature": "putPresenceUserPrimarysource(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserPrimarySource", - "required": "true" - } - ], - "return": "UserPrimarySource", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // user ID\nlet body: UserPrimarySource = new UserPrimarySource(...) // Primary Source\n\n// Update a user's Primary Presence Source\nPutPresenceUserPrimarysourceRequest.putPresenceUserPrimarysource(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutPresenceUserPrimarysourceRequest.putPresenceUserPrimarysource was successful\")\n dump(response)\n }\n}" - }, - "putpresencedefinition": { - "operationId": "putpresencedefinition", - "functionName": "putPresencedefinition", - "signature": "putPresencedefinition(presenceId, body)", - "parameters": [ - { - "name": "presenceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OrganizationPresence", - "required": "true" - } - ], - "return": "OrganizationPresence", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet presenceId: String = \"\" // Organization Presence ID\nlet body: OrganizationPresence = new OrganizationPresence(...) // The OrganizationPresence to update\n\n// Update a Presence Definition\nPutPresencedefinitionRequest.putPresencedefinition(presenceId: presenceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutPresencedefinitionRequest.putPresencedefinition was successful\")\n dump(response)\n }\n}" - }, - "putuserspresencesbulk": { - "operationId": "putuserspresencesbulk", - "functionName": "putUsersPresencesBulk", - "signature": "putUsersPresencesBulk(body)", - "parameters": [ - { - "name": "body", - "type": "[UserPresence]", - "required": "true" - } - ], - "return": "[UserPresence]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [UserPresence] = [new UserPresence(...)] // List of User presences\n\n// Update bulk user Presences\nPutUsersPresencesBulkRequest.putUsersPresencesBulk(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUsersPresencesBulkRequest.putUsersPresencesBulk was successful\")\n dump(response)\n }\n}" - }, - "deleteprocessautomationtrigger": { - "operationId": "deleteprocessautomationtrigger", - "functionName": "deleteProcessautomationTrigger", - "signature": "deleteProcessautomationTrigger(triggerId)", - "parameters": [ - { - "name": "triggerId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet triggerId: String = \"\" // triggerId\n\n// Delete a Trigger\nDeleteProcessautomationTriggerRequest.deleteProcessautomationTrigger(triggerId: triggerId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteProcessautomationTriggerRequest.deleteProcessautomationTrigger was successful\")\n }\n}" - }, - "getprocessautomationtrigger": { - "operationId": "getprocessautomationtrigger", - "functionName": "getProcessautomationTrigger", - "signature": "getProcessautomationTrigger(triggerId)", - "parameters": [ - { - "name": "triggerId", - "type": "String", - "required": "true" - } - ], - "return": "Trigger", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet triggerId: String = \"\" // triggerId\n\n// Retrieve a single Trigger matching id\nGetProcessautomationTriggerRequest.getProcessautomationTrigger(triggerId: triggerId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetProcessautomationTriggerRequest.getProcessautomationTrigger was successful\")\n dump(response)\n }\n}" - }, - "getprocessautomationtriggers": { - "operationId": "getprocessautomationtriggers", - "functionName": "getProcessautomationTriggers", - "signature": "getProcessautomationTriggers(before, after, pageSize, topicName, enabled, hasDelayBy)", - "parameters": [ - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "topicName", - "type": "String", - "required": "false" - }, - { - "name": "enabled", - "type": "Bool", - "required": "false" - }, - { - "name": "hasDelayBy", - "type": "Bool", - "required": "false" - } - ], - "return": "TriggerEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet topicName: String = \"\" // Topic name(s). Separated by commas\nlet enabled: Bool = true // Boolean indicating desired enabled state of triggers\nlet hasDelayBy: Bool = true // Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set.\n\n// Retrieves all triggers, optionally filtered by query parameters.\nGetProcessautomationTriggersRequest.getProcessautomationTriggers(before: before, after: after, pageSize: pageSize, topicName: topicName, enabled: enabled, hasDelayBy: hasDelayBy) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetProcessautomationTriggersRequest.getProcessautomationTriggers was successful\")\n dump(response)\n }\n}" - }, - "getprocessautomationtriggerstopics": { - "operationId": "getprocessautomationtriggerstopics", - "functionName": "getProcessautomationTriggersTopics", - "signature": "getProcessautomationTriggersTopics(before, after, pageSize)", - "parameters": [ - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - } - ], - "return": "TopicCursorEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\n\n// Get topics available for organization\nGetProcessautomationTriggersTopicsRequest.getProcessautomationTriggersTopics(before: before, after: after, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetProcessautomationTriggersTopicsRequest.getProcessautomationTriggersTopics was successful\")\n dump(response)\n }\n}" - }, - "postprocessautomationtriggertest": { - "operationId": "postprocessautomationtriggertest", - "functionName": "postProcessautomationTriggerTest", - "signature": "postProcessautomationTriggerTest(triggerId, body)", - "parameters": [ - { - "name": "triggerId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "String", - "required": "false" - } - ], - "return": "TestModeResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet triggerId: String = \"\" // triggerId\nlet body: String = \"\" // eventBody\n\n// Test the matching of a Trigger based on provided event body\nPostProcessautomationTriggerTestRequest.postProcessautomationTriggerTest(triggerId: triggerId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostProcessautomationTriggerTestRequest.postProcessautomationTriggerTest was successful\")\n dump(response)\n }\n}" - }, - "postprocessautomationtriggers": { - "operationId": "postprocessautomationtriggers", - "functionName": "postProcessautomationTriggers", - "signature": "postProcessautomationTriggers(body)", - "parameters": [ - { - "name": "body", - "type": "CreateTriggerRequest", - "required": "true" - } - ], - "return": "Trigger", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateTriggerRequest = new CreateTriggerRequest(...) // Input used to create a Trigger.\n\n// Create a Trigger\nPostProcessautomationTriggersRequest.postProcessautomationTriggers(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostProcessautomationTriggersRequest.postProcessautomationTriggers was successful\")\n dump(response)\n }\n}" - }, - "postprocessautomationtriggerstopictest": { - "operationId": "postprocessautomationtriggerstopictest", - "functionName": "postProcessautomationTriggersTopicTest", - "signature": "postProcessautomationTriggersTopicTest(topicName, body)", - "parameters": [ - { - "name": "topicName", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "String", - "required": "false" - } - ], - "return": "TestModeEventResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet topicName: String = \"\" // topicName\nlet body: String = \"\" // eventBody\n\n// Test the matching of all organization Triggers on given topic using provided event body\nPostProcessautomationTriggersTopicTestRequest.postProcessautomationTriggersTopicTest(topicName: topicName, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostProcessautomationTriggersTopicTestRequest.postProcessautomationTriggersTopicTest was successful\")\n dump(response)\n }\n}" - }, - "putprocessautomationtrigger": { - "operationId": "putprocessautomationtrigger", - "functionName": "putProcessautomationTrigger", - "signature": "putProcessautomationTrigger(triggerId, body)", - "parameters": [ - { - "name": "triggerId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateTriggerRequest", - "required": "true" - } - ], - "return": "Trigger", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet triggerId: String = \"\" // triggerId\nlet body: UpdateTriggerRequest = new UpdateTriggerRequest(...) // Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)\n\n// Update a Trigger\nPutProcessautomationTriggerRequest.putProcessautomationTrigger(triggerId: triggerId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutProcessautomationTriggerRequest.putProcessautomationTrigger was successful\")\n dump(response)\n }\n}" - }, - "deletequalitycalibration": { - "operationId": "deletequalitycalibration", - "functionName": "deleteQualityCalibration", - "signature": "deleteQualityCalibration(calibrationId, calibratorId)", - "parameters": [ - { - "name": "calibrationId", - "type": "String", - "required": "true" - }, - { - "name": "calibratorId", - "type": "String", - "required": "true" - } - ], - "return": "Calibration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet calibrationId: String = \"\" // Calibration ID\nlet calibratorId: String = \"\" // calibratorId\n\n// Delete a calibration by id.\nDeleteQualityCalibrationRequest.deleteQualityCalibration(calibrationId: calibrationId, calibratorId: calibratorId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteQualityCalibrationRequest.deleteQualityCalibration was successful\")\n dump(response)\n }\n}" - }, - "deletequalityconversationevaluation": { - "operationId": "deletequalityconversationevaluation", - "functionName": "deleteQualityConversationEvaluation", - "signature": "deleteQualityConversationEvaluation(conversationId, evaluationId, expand)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "evaluationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet evaluationId: String = \"\" // evaluationId\nlet expand: String = \"\" // evaluatorId, evaluationForm\n\n// Delete an evaluation\nDeleteQualityConversationEvaluationRequest.deleteQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteQualityConversationEvaluationRequest.deleteQualityConversationEvaluation was successful\")\n dump(response)\n }\n}" - }, - "deletequalityform": { - "operationId": "deletequalityform", - "functionName": "deleteQualityForm", - "signature": "deleteQualityForm(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Delete an evaluation form.\nDeleteQualityFormRequest.deleteQualityForm(formId: formId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteQualityFormRequest.deleteQualityForm was successful\")\n }\n}" - }, - "deletequalityformsevaluation": { - "operationId": "deletequalityformsevaluation", - "functionName": "deleteQualityFormsEvaluation", - "signature": "deleteQualityFormsEvaluation(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Delete an evaluation form.\nDeleteQualityFormsEvaluationRequest.deleteQualityFormsEvaluation(formId: formId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteQualityFormsEvaluationRequest.deleteQualityFormsEvaluation was successful\")\n }\n}" - }, - "deletequalityformssurvey": { - "operationId": "deletequalityformssurvey", - "functionName": "deleteQualityFormsSurvey", - "signature": "deleteQualityFormsSurvey(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Delete a survey form.\nDeleteQualityFormsSurveyRequest.deleteQualityFormsSurvey(formId: formId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteQualityFormsSurveyRequest.deleteQualityFormsSurvey was successful\")\n }\n}" - }, - "getqualityagentsactivity": { - "operationId": "getqualityagentsactivity", - "functionName": "getQualityAgentsActivity", - "signature": "getQualityAgentsActivity(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, startTime, endTime, agentUserId, evaluatorUserId, name, group, formContextId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "startTime", - "type": "Date", - "required": "false" - }, - { - "name": "endTime", - "type": "Date", - "required": "false" - }, - { - "name": "agentUserId", - "type": "[String]", - "required": "false" - }, - { - "name": "evaluatorUserId", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "group", - "type": "String", - "required": "false" - }, - { - "name": "formContextId", - "type": "String", - "required": "false" - } - ], - "return": "AgentActivityEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet startTime: Date = new Date(...) // Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet endTime: Date = new Date(...) // End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet agentUserId: [String] = [\"\"] // user id of agent requested\nlet evaluatorUserId: String = \"\" // user id of the evaluator\nlet name: String = \"\" // name\nlet group: String = \"\" // group id\nlet formContextId: String = \"\" // shared id between form versions\n\n// Gets a list of Agent Activities\nGetQualityAgentsActivityRequest.getQualityAgentsActivity(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, startTime: startTime, endTime: endTime, agentUserId: agentUserId, evaluatorUserId: evaluatorUserId, name: name, group: group, formContextId: formContextId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityAgentsActivityRequest.getQualityAgentsActivity was successful\")\n dump(response)\n }\n}" - }, - "getqualitycalibration": { - "operationId": "getqualitycalibration", - "functionName": "getQualityCalibration", - "signature": "getQualityCalibration(calibrationId, calibratorId, conversationId)", - "parameters": [ - { - "name": "calibrationId", - "type": "String", - "required": "true" - }, - { - "name": "calibratorId", - "type": "String", - "required": "false" - }, - { - "name": "conversationId", - "type": "String", - "required": "false" - } - ], - "return": "Calibration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet calibrationId: String = \"\" // Calibration ID\nlet calibratorId: String = \"\" // calibratorId\nlet conversationId: String = \"\" // conversationId\n\n// Get a calibration by id. Requires either calibrator id or conversation id\nGetQualityCalibrationRequest.getQualityCalibration(calibrationId: calibrationId, calibratorId: calibratorId, conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityCalibrationRequest.getQualityCalibration was successful\")\n dump(response)\n }\n}" - }, - "getqualitycalibrations": { - "operationId": "getqualitycalibrations", - "functionName": "getQualityCalibrations", - "signature": "getQualityCalibrations(calibratorId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage, conversationId, startTime, endTime)", - "parameters": [ - { - "name": "calibratorId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "conversationId", - "type": "String", - "required": "false" - }, - { - "name": "startTime", - "type": "Date", - "required": "false" - }, - { - "name": "endTime", - "type": "Date", - "required": "false" - } - ], - "return": "CalibrationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet calibratorId: String = \"\" // user id of calibrator\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet conversationId: String = \"\" // conversation id\nlet startTime: Date = new Date(...) // Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet endTime: Date = new Date(...) // end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\n\n// Get the list of calibrations\nGetQualityCalibrationsRequest.getQualityCalibrations(calibratorId: calibratorId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, conversationId: conversationId, startTime: startTime, endTime: endTime) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityCalibrationsRequest.getQualityCalibrations was successful\")\n dump(response)\n }\n}" - }, - "getqualityconversationevaluation": { - "operationId": "getqualityconversationevaluation", - "functionName": "getQualityConversationEvaluation", - "signature": "getQualityConversationEvaluation(conversationId, evaluationId, expand)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "evaluationId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet evaluationId: String = \"\" // evaluationId\nlet expand: String = \"\" // agent, assignee, evaluator, evaluationForm\n\n// Get an evaluation\nGetQualityConversationEvaluationRequest.getQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityConversationEvaluationRequest.getQualityConversationEvaluation was successful\")\n dump(response)\n }\n}" - }, - "getqualityconversationsurveys": { - "operationId": "getqualityconversationsurveys", - "functionName": "getQualityConversationSurveys", - "signature": "getQualityConversationSurveys(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "[Survey]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get the surveys for a conversation\nGetQualityConversationSurveysRequest.getQualityConversationSurveys(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityConversationSurveysRequest.getQualityConversationSurveys was successful\")\n dump(response)\n }\n}" - }, - "getqualityconversationsauditsquerytransactionid": { - "operationId": "getqualityconversationsauditsquerytransactionid", - "functionName": "getQualityConversationsAuditsQueryTransactionId", - "signature": "getQualityConversationsAuditsQueryTransactionId(transactionId)", - "parameters": [ - { - "name": "transactionId", - "type": "String", - "required": "true" - } - ], - "return": "QualityAuditQueryExecutionStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet transactionId: String = \"\" // Transaction ID\n\n// Get status of audit query execution\nGetQualityConversationsAuditsQueryTransactionIdRequest.getQualityConversationsAuditsQueryTransactionId(transactionId: transactionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityConversationsAuditsQueryTransactionIdRequest.getQualityConversationsAuditsQueryTransactionId was successful\")\n dump(response)\n }\n}" - }, - "getqualityconversationsauditsquerytransactionidresults": { - "operationId": "getqualityconversationsauditsquerytransactionidresults", - "functionName": "getQualityConversationsAuditsQueryTransactionIdResults", - "signature": "getQualityConversationsAuditsQueryTransactionIdResults(transactionId, cursor, pageSize, expand)", - "parameters": [ - { - "name": "transactionId", - "type": "String", - "required": "true" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "QualityAuditQueryExecutionResultsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet transactionId: String = \"\" // Transaction ID\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\nlet pageSize: Int = 0 // Page size\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get results of audit query\nGetQualityConversationsAuditsQueryTransactionIdResultsRequest.getQualityConversationsAuditsQueryTransactionIdResults(transactionId: transactionId, cursor: cursor, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityConversationsAuditsQueryTransactionIdResultsRequest.getQualityConversationsAuditsQueryTransactionIdResults was successful\")\n dump(response)\n }\n}" - }, - "getqualityevaluationsquery": { - "operationId": "getqualityevaluationsquery", - "functionName": "getQualityEvaluationsQuery", - "signature": "getQualityEvaluationsQuery(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, conversationId, agentUserId, evaluatorUserId, assigneeUserId, queueId, startTime, endTime, formContextId, evaluationState, isReleased, agentHasRead, expandAnswerTotalScores, maximum, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "conversationId", - "type": "String", - "required": "false" - }, - { - "name": "agentUserId", - "type": "String", - "required": "false" - }, - { - "name": "evaluatorUserId", - "type": "String", - "required": "false" - }, - { - "name": "assigneeUserId", - "type": "String", - "required": "false" - }, - { - "name": "queueId", - "type": "String", - "required": "false" - }, - { - "name": "startTime", - "type": "String", - "required": "false" - }, - { - "name": "endTime", - "type": "String", - "required": "false" - }, - { - "name": "formContextId", - "type": "String", - "required": "false" - }, - { - "name": "evaluationState", - "type": "[String]", - "required": "false" - }, - { - "name": "isReleased", - "type": "Bool", - "required": "false" - }, - { - "name": "agentHasRead", - "type": "Bool", - "required": "false" - }, - { - "name": "expandAnswerTotalScores", - "type": "Bool", - "required": "false" - }, - { - "name": "maximum", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // NOTE: Does not work when querying evaluations\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // NOTE: Does not work when querying evaluations\nlet previousPage: String = \"\" // Previous page token\nlet conversationId: String = \"\" // conversationId specified\nlet agentUserId: String = \"\" // user id of the agent\nlet evaluatorUserId: String = \"\" // evaluator user id\nlet assigneeUserId: String = \"\" // assignee user id\nlet queueId: String = \"\" // queue id\nlet startTime: String = \"\" // start time of the evaluation query\nlet endTime: String = \"\" // end time of the evaluation query\nlet formContextId: String = \"\" // shared id between form versions\nlet evaluationState: [String] = [\"\"] // \nlet isReleased: Bool = true // the evaluation has been released\nlet agentHasRead: Bool = true // agent has the evaluation\nlet expandAnswerTotalScores: Bool = true // get the total scores for evaluations\nlet maximum: Int = 0 // the maximum number of results to return\nlet sortOrder: String = \"\" // NOTE: Does not work when conversationId is supplied.\n\n// Queries Evaluations and returns a paged list\nGetQualityEvaluationsQueryRequest.getQualityEvaluationsQuery(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, conversationId: conversationId, agentUserId: agentUserId, evaluatorUserId: evaluatorUserId, assigneeUserId: assigneeUserId, queueId: queueId, startTime: startTime, endTime: endTime, formContextId: formContextId, evaluationState: evaluationState, isReleased: isReleased, agentHasRead: agentHasRead, expandAnswerTotalScores: expandAnswerTotalScores, maximum: maximum, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityEvaluationsQueryRequest.getQualityEvaluationsQuery was successful\")\n dump(response)\n }\n}" - }, - "getqualityevaluatorsactivity": { - "operationId": "getqualityevaluatorsactivity", - "functionName": "getQualityEvaluatorsActivity", - "signature": "getQualityEvaluatorsActivity(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, startTime, endTime, name, permission, group)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "startTime", - "type": "Date", - "required": "false" - }, - { - "name": "endTime", - "type": "Date", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "permission", - "type": "[String]", - "required": "false" - }, - { - "name": "group", - "type": "String", - "required": "false" - } - ], - "return": "EvaluatorActivityEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet startTime: Date = new Date(...) // The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet endTime: Date = new Date(...) // The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet name: String = \"\" // Evaluator name\nlet permission: [String] = [\"\"] // permission strings\nlet group: String = \"\" // group id\n\n// Get an evaluator activity\nGetQualityEvaluatorsActivityRequest.getQualityEvaluatorsActivity(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, startTime: startTime, endTime: endTime, name: name, permission: permission, group: group) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityEvaluatorsActivityRequest.getQualityEvaluatorsActivity was successful\")\n dump(response)\n }\n}" - }, - "getqualityform": { - "operationId": "getqualityform", - "functionName": "getQualityForm", - "signature": "getQualityForm(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get an evaluation form\nGetQualityFormRequest.getQualityForm(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormRequest.getQualityForm was successful\")\n dump(response)\n }\n}" - }, - "getqualityformversions": { - "operationId": "getqualityformversions", - "functionName": "getQualityFormVersions", - "signature": "getQualityFormVersions(formId, pageSize, pageNumber)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Gets all the revisions for a specific evaluation.\nGetQualityFormVersionsRequest.getQualityFormVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormVersionsRequest.getQualityFormVersions was successful\")\n dump(response)\n }\n}" - }, - "getqualityforms": { - "operationId": "getqualityforms", - "functionName": "getQualityForms", - "signature": "getQualityForms(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet expand: GetQualityFormsRequest.Expand_getQualityForms = GetQualityFormsRequest.Expand_getQualityForms.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions\nlet name: String = \"\" // Name\nlet sortOrder: String = \"\" // Order to sort results, either asc or desc\n\n// Get the list of evaluation forms\nGetQualityFormsRequest.getQualityForms(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsRequest.getQualityForms was successful\")\n dump(response)\n }\n}" - }, - "getqualityformsevaluation": { - "operationId": "getqualityformsevaluation", - "functionName": "getQualityFormsEvaluation", - "signature": "getQualityFormsEvaluation(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get an evaluation form\nGetQualityFormsEvaluationRequest.getQualityFormsEvaluation(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsEvaluationRequest.getQualityFormsEvaluation was successful\")\n dump(response)\n }\n}" - }, - "getqualityformsevaluationversions": { - "operationId": "getqualityformsevaluationversions", - "functionName": "getQualityFormsEvaluationVersions", - "signature": "getQualityFormsEvaluationVersions(formId, pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: String = \"\" // Sort order\n\n// Gets all the revisions for a specific evaluation.\nGetQualityFormsEvaluationVersionsRequest.getQualityFormsEvaluationVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsEvaluationVersionsRequest.getQualityFormsEvaluationVersions was successful\")\n dump(response)\n }\n}" - }, - "getqualityformsevaluations": { - "operationId": "getqualityformsevaluations", - "functionName": "getQualityFormsEvaluations", - "signature": "getQualityFormsEvaluations(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet expand: GetQualityFormsEvaluationsRequest.Expand_getQualityFormsEvaluations = GetQualityFormsEvaluationsRequest.Expand_getQualityFormsEvaluations.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions\nlet name: String = \"\" // Name\nlet sortOrder: String = \"\" // Order to sort results, either asc or desc\n\n// Get the list of evaluation forms\nGetQualityFormsEvaluationsRequest.getQualityFormsEvaluations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsEvaluationsRequest.getQualityFormsEvaluations was successful\")\n dump(response)\n }\n}" - }, - "getqualityformsevaluationsbulkcontexts": { - "operationId": "getqualityformsevaluationsbulkcontexts", - "functionName": "getQualityFormsEvaluationsBulkContexts", - "signature": "getQualityFormsEvaluationsBulkContexts(contextId)", - "parameters": [ - { - "name": "contextId", - "type": "[String]", - "required": "true" - } - ], - "return": "[EvaluationForm]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contextId: [String] = [\"\"] // A comma-delimited list of valid evaluation form context ids\n\n// Retrieve a list of the latest published evaluation form versions by context ids\nGetQualityFormsEvaluationsBulkContextsRequest.getQualityFormsEvaluationsBulkContexts(contextId: contextId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsEvaluationsBulkContextsRequest.getQualityFormsEvaluationsBulkContexts was successful\")\n dump(response)\n }\n}" - }, - "getqualityformssurvey": { - "operationId": "getqualityformssurvey", - "functionName": "getQualityFormsSurvey", - "signature": "getQualityFormsSurvey(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get a survey form\nGetQualityFormsSurveyRequest.getQualityFormsSurvey(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsSurveyRequest.getQualityFormsSurvey was successful\")\n dump(response)\n }\n}" - }, - "getqualityformssurveyversions": { - "operationId": "getqualityformssurveyversions", - "functionName": "getQualityFormsSurveyVersions", - "signature": "getQualityFormsSurveyVersions(formId, pageSize, pageNumber)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "SurveyFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Gets all the revisions for a specific survey.\nGetQualityFormsSurveyVersionsRequest.getQualityFormsSurveyVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsSurveyVersionsRequest.getQualityFormsSurveyVersions was successful\")\n dump(response)\n }\n}" - }, - "getqualityformssurveys": { - "operationId": "getqualityformssurveys", - "functionName": "getQualityFormsSurveys", - "signature": "getQualityFormsSurveys(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "SurveyFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet expand: GetQualityFormsSurveysRequest.Expand_getQualityFormsSurveys = GetQualityFormsSurveysRequest.Expand_getQualityFormsSurveys.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions\nlet name: String = \"\" // Name\nlet sortOrder: String = \"\" // Order to sort results, either asc or desc\n\n// Get the list of survey forms\nGetQualityFormsSurveysRequest.getQualityFormsSurveys(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsSurveysRequest.getQualityFormsSurveys was successful\")\n dump(response)\n }\n}" - }, - "getqualityformssurveysbulk": { - "operationId": "getqualityformssurveysbulk", - "functionName": "getQualityFormsSurveysBulk", - "signature": "getQualityFormsSurveysBulk(_id)", - "parameters": [ - { - "name": "_id", - "type": "[String]", - "required": "true" - } - ], - "return": "SurveyFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet _id: [String] = [\"\"] // A comma-delimited list of valid survey form ids\n\n// Retrieve a list of survey forms by their ids\nGetQualityFormsSurveysBulkRequest.getQualityFormsSurveysBulk(_id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsSurveysBulkRequest.getQualityFormsSurveysBulk was successful\")\n dump(response)\n }\n}" - }, - "getqualityformssurveysbulkcontexts": { - "operationId": "getqualityformssurveysbulkcontexts", - "functionName": "getQualityFormsSurveysBulkContexts", - "signature": "getQualityFormsSurveysBulkContexts(contextId, published)", - "parameters": [ - { - "name": "contextId", - "type": "[String]", - "required": "true" - }, - { - "name": "published", - "type": "Bool", - "required": "false" - } - ], - "return": "[SurveyForm]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contextId: [String] = [\"\"] // A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.\nlet published: Bool = true // If true, the latest published version will be included. If false, only the unpublished version will be included.\n\n// Retrieve a list of the latest form versions by context ids\nGetQualityFormsSurveysBulkContextsRequest.getQualityFormsSurveysBulkContexts(contextId: contextId, published: published) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityFormsSurveysBulkContextsRequest.getQualityFormsSurveysBulkContexts was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedform": { - "operationId": "getqualitypublishedform", - "functionName": "getQualityPublishedform", - "signature": "getQualityPublishedform(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get the published evaluation forms.\nGetQualityPublishedformRequest.getQualityPublishedform(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformRequest.getQualityPublishedform was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedforms": { - "operationId": "getqualitypublishedforms", - "functionName": "getQualityPublishedforms", - "signature": "getQualityPublishedforms(pageSize, pageNumber, name, onlyLatestPerContext)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "onlyLatestPerContext", - "type": "Bool", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet onlyLatestPerContext: Bool = true // onlyLatestPerContext\n\n// Get the published evaluation forms.\nGetQualityPublishedformsRequest.getQualityPublishedforms(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestPerContext: onlyLatestPerContext) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformsRequest.getQualityPublishedforms was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedformsevaluation": { - "operationId": "getqualitypublishedformsevaluation", - "functionName": "getQualityPublishedformsEvaluation", - "signature": "getQualityPublishedformsEvaluation(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get the most recent published version of an evaluation form.\nGetQualityPublishedformsEvaluationRequest.getQualityPublishedformsEvaluation(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformsEvaluationRequest.getQualityPublishedformsEvaluation was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedformsevaluations": { - "operationId": "getqualitypublishedformsevaluations", - "functionName": "getQualityPublishedformsEvaluations", - "signature": "getQualityPublishedformsEvaluations(pageSize, pageNumber, name, onlyLatestPerContext)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "onlyLatestPerContext", - "type": "Bool", - "required": "false" - } - ], - "return": "EvaluationFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet onlyLatestPerContext: Bool = true // onlyLatestPerContext\n\n// Get the published evaluation forms.\nGetQualityPublishedformsEvaluationsRequest.getQualityPublishedformsEvaluations(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestPerContext: onlyLatestPerContext) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformsEvaluationsRequest.getQualityPublishedformsEvaluations was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedformssurvey": { - "operationId": "getqualitypublishedformssurvey", - "functionName": "getQualityPublishedformsSurvey", - "signature": "getQualityPublishedformsSurvey(formId)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\n\n// Get the most recent published version of a survey form.\nGetQualityPublishedformsSurveyRequest.getQualityPublishedformsSurvey(formId: formId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformsSurveyRequest.getQualityPublishedformsSurvey was successful\")\n dump(response)\n }\n}" - }, - "getqualitypublishedformssurveys": { - "operationId": "getqualitypublishedformssurveys", - "functionName": "getQualityPublishedformsSurveys", - "signature": "getQualityPublishedformsSurveys(pageSize, pageNumber, name, onlyLatestEnabledPerContext)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "onlyLatestEnabledPerContext", - "type": "Bool", - "required": "false" - } - ], - "return": "SurveyFormEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet onlyLatestEnabledPerContext: Bool = true // onlyLatestEnabledPerContext\n\n// Get the published survey forms.\nGetQualityPublishedformsSurveysRequest.getQualityPublishedformsSurveys(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestEnabledPerContext: onlyLatestEnabledPerContext) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualityPublishedformsSurveysRequest.getQualityPublishedformsSurveys was successful\")\n dump(response)\n }\n}" - }, - "getqualitysurvey": { - "operationId": "getqualitysurvey", - "functionName": "getQualitySurvey", - "signature": "getQualitySurvey(surveyId)", - "parameters": [ - { - "name": "surveyId", - "type": "String", - "required": "true" - } - ], - "return": "Survey", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet surveyId: String = \"\" // surveyId\n\n// Get a survey for a conversation\nGetQualitySurveyRequest.getQualitySurvey(surveyId: surveyId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualitySurveyRequest.getQualitySurvey was successful\")\n dump(response)\n }\n}" - }, - "getqualitysurveysscorable": { - "operationId": "getqualitysurveysscorable", - "functionName": "getQualitySurveysScorable", - "signature": "getQualitySurveysScorable(customerSurveyUrl)", - "parameters": [ - { - "name": "customerSurveyUrl", - "type": "String", - "required": "true" - } - ], - "return": "ScorableSurvey", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet customerSurveyUrl: String = \"\" // customerSurveyUrl\n\n// Get a survey as an end-customer, for the purposes of scoring it.\nGetQualitySurveysScorableRequest.getQualitySurveysScorable(customerSurveyUrl: customerSurveyUrl) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetQualitySurveysScorableRequest.getQualitySurveysScorable was successful\")\n dump(response)\n }\n}" - }, - "patchqualityformssurvey": { - "operationId": "patchqualityformssurvey", - "functionName": "patchQualityFormsSurvey", - "signature": "patchQualityFormsSurvey(formId, body)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SurveyForm", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet body: SurveyForm = new SurveyForm(...) // Survey form\n\n// 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.\nPatchQualityFormsSurveyRequest.patchQualityFormsSurvey(formId: formId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchQualityFormsSurveyRequest.patchQualityFormsSurvey was successful\")\n dump(response)\n }\n}" - }, - "postqualitycalibrations": { - "operationId": "postqualitycalibrations", - "functionName": "postQualityCalibrations", - "signature": "postQualityCalibrations(body, expand)", - "parameters": [ - { - "name": "body", - "type": "CalibrationCreate", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "Calibration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CalibrationCreate = new CalibrationCreate(...) // calibration\nlet expand: String = \"\" // calibratorId\n\n// Create a calibration\nPostQualityCalibrationsRequest.postQualityCalibrations(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityCalibrationsRequest.postQualityCalibrations was successful\")\n dump(response)\n }\n}" - }, - "postqualityconversationevaluations": { - "operationId": "postqualityconversationevaluations", - "functionName": "postQualityConversationEvaluations", - "signature": "postQualityConversationEvaluations(conversationId, body, expand)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Evaluation", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "Evaluation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet body: Evaluation = new Evaluation(...) // evaluation\nlet expand: String = \"\" // evaluatorId\n\n// Create an evaluation\nPostQualityConversationEvaluationsRequest.postQualityConversationEvaluations(conversationId: conversationId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityConversationEvaluationsRequest.postQualityConversationEvaluations was successful\")\n dump(response)\n }\n}" - }, - "postqualityconversationsauditsquery": { - "operationId": "postqualityconversationsauditsquery", - "functionName": "postQualityConversationsAuditsQuery", - "signature": "postQualityConversationsAuditsQuery(body)", - "parameters": [ - { - "name": "body", - "type": "QMAuditQueryRequest", - "required": "true" - } - ], - "return": "QualityAuditQueryExecutionStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: QMAuditQueryRequest = new QMAuditQueryRequest(...) // query\n\n// Create audit query execution\nPostQualityConversationsAuditsQueryRequest.postQualityConversationsAuditsQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityConversationsAuditsQueryRequest.postQualityConversationsAuditsQuery was successful\")\n dump(response)\n }\n}" - }, - "postqualityevaluationsaggregatesqueryme": { - "operationId": "postqualityevaluationsaggregatesqueryme", - "functionName": "postQualityEvaluationsAggregatesQueryMe", - "signature": "postQualityEvaluationsAggregatesQueryMe(body)", - "parameters": [ - { - "name": "body", - "type": "EvaluationAggregationQueryMe", - "required": "true" - } - ], - "return": "EvaluationAggregateQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EvaluationAggregationQueryMe = new EvaluationAggregationQueryMe(...) // query\n\n// Query for evaluation aggregates for the current user\nPostQualityEvaluationsAggregatesQueryMeRequest.postQualityEvaluationsAggregatesQueryMe(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityEvaluationsAggregatesQueryMeRequest.postQualityEvaluationsAggregatesQueryMe was successful\")\n dump(response)\n }\n}" - }, - "postqualityevaluationsscoring": { - "operationId": "postqualityevaluationsscoring", - "functionName": "postQualityEvaluationsScoring", - "signature": "postQualityEvaluationsScoring(body)", - "parameters": [ - { - "name": "body", - "type": "EvaluationFormAndScoringSet", - "required": "true" - } - ], - "return": "EvaluationScoringSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EvaluationFormAndScoringSet = new EvaluationFormAndScoringSet(...) // evaluationAndScoringSet\n\n// Score evaluation\nPostQualityEvaluationsScoringRequest.postQualityEvaluationsScoring(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityEvaluationsScoringRequest.postQualityEvaluationsScoring was successful\")\n dump(response)\n }\n}" - }, - "postqualityforms": { - "operationId": "postqualityforms", - "functionName": "postQualityForms", - "signature": "postQualityForms(body)", - "parameters": [ - { - "name": "body", - "type": "EvaluationForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EvaluationForm = new EvaluationForm(...) // Evaluation form\n\n// Create an evaluation form.\nPostQualityFormsRequest.postQualityForms(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityFormsRequest.postQualityForms was successful\")\n dump(response)\n }\n}" - }, - "postqualityformsevaluations": { - "operationId": "postqualityformsevaluations", - "functionName": "postQualityFormsEvaluations", - "signature": "postQualityFormsEvaluations(body)", - "parameters": [ - { - "name": "body", - "type": "EvaluationForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EvaluationForm = new EvaluationForm(...) // Evaluation form\n\n// Create an evaluation form.\nPostQualityFormsEvaluationsRequest.postQualityFormsEvaluations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityFormsEvaluationsRequest.postQualityFormsEvaluations was successful\")\n dump(response)\n }\n}" - }, - "postqualityformssurveys": { - "operationId": "postqualityformssurveys", - "functionName": "postQualityFormsSurveys", - "signature": "postQualityFormsSurveys(body)", - "parameters": [ - { - "name": "body", - "type": "SurveyForm", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SurveyForm = new SurveyForm(...) // Survey form\n\n// Create a survey form.\nPostQualityFormsSurveysRequest.postQualityFormsSurveys(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityFormsSurveysRequest.postQualityFormsSurveys was successful\")\n dump(response)\n }\n}" - }, - "postqualitypublishedforms": { - "operationId": "postqualitypublishedforms", - "functionName": "postQualityPublishedforms", - "signature": "postQualityPublishedforms(body)", - "parameters": [ - { - "name": "body", - "type": "PublishForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PublishForm = new PublishForm(...) // Publish request containing id of form to publish\n\n// Publish an evaluation form.\nPostQualityPublishedformsRequest.postQualityPublishedforms(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityPublishedformsRequest.postQualityPublishedforms was successful\")\n dump(response)\n }\n}" - }, - "postqualitypublishedformsevaluations": { - "operationId": "postqualitypublishedformsevaluations", - "functionName": "postQualityPublishedformsEvaluations", - "signature": "postQualityPublishedformsEvaluations(body)", - "parameters": [ - { - "name": "body", - "type": "PublishForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PublishForm = new PublishForm(...) // Publish request containing id of form to publish\n\n// Publish an evaluation form.\nPostQualityPublishedformsEvaluationsRequest.postQualityPublishedformsEvaluations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityPublishedformsEvaluationsRequest.postQualityPublishedformsEvaluations was successful\")\n dump(response)\n }\n}" - }, - "postqualitypublishedformssurveys": { - "operationId": "postqualitypublishedformssurveys", - "functionName": "postQualityPublishedformsSurveys", - "signature": "postQualityPublishedformsSurveys(body)", - "parameters": [ - { - "name": "body", - "type": "PublishForm", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PublishForm = new PublishForm(...) // Survey form\n\n// Publish a survey form.\nPostQualityPublishedformsSurveysRequest.postQualityPublishedformsSurveys(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualityPublishedformsSurveysRequest.postQualityPublishedformsSurveys was successful\")\n dump(response)\n }\n}" - }, - "postqualitysurveysscoring": { - "operationId": "postqualitysurveysscoring", - "functionName": "postQualitySurveysScoring", - "signature": "postQualitySurveysScoring(body)", - "parameters": [ - { - "name": "body", - "type": "SurveyFormAndScoringSet", - "required": "true" - } - ], - "return": "SurveyScoringSet", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SurveyFormAndScoringSet = new SurveyFormAndScoringSet(...) // surveyAndScoringSet\n\n// Score survey\nPostQualitySurveysScoringRequest.postQualitySurveysScoring(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostQualitySurveysScoringRequest.postQualitySurveysScoring was successful\")\n dump(response)\n }\n}" - }, - "putqualitycalibration": { - "operationId": "putqualitycalibration", - "functionName": "putQualityCalibration", - "signature": "putQualityCalibration(calibrationId, body)", - "parameters": [ - { - "name": "calibrationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Calibration", - "required": "true" - } - ], - "return": "Calibration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet calibrationId: String = \"\" // Calibration ID\nlet body: Calibration = new Calibration(...) // Calibration\n\n// Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex\nPutQualityCalibrationRequest.putQualityCalibration(calibrationId: calibrationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualityCalibrationRequest.putQualityCalibration was successful\")\n dump(response)\n }\n}" - }, - "putqualityconversationevaluation": { - "operationId": "putqualityconversationevaluation", - "functionName": "putQualityConversationEvaluation", - "signature": "putQualityConversationEvaluation(conversationId, evaluationId, body, expand)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "evaluationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Evaluation", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "EvaluationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet evaluationId: String = \"\" // evaluationId\nlet body: Evaluation = new Evaluation(...) // evaluation\nlet expand: String = \"\" // evaluatorId, evaluationForm, assignee, evaluator\n\n// Update an evaluation\nPutQualityConversationEvaluationRequest.putQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualityConversationEvaluationRequest.putQualityConversationEvaluation was successful\")\n dump(response)\n }\n}" - }, - "putqualityform": { - "operationId": "putqualityform", - "functionName": "putQualityForm", - "signature": "putQualityForm(formId, body)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EvaluationForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet body: EvaluationForm = new EvaluationForm(...) // Evaluation form\n\n// Update an evaluation form.\nPutQualityFormRequest.putQualityForm(formId: formId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualityFormRequest.putQualityForm was successful\")\n dump(response)\n }\n}" - }, - "putqualityformsevaluation": { - "operationId": "putqualityformsevaluation", - "functionName": "putQualityFormsEvaluation", - "signature": "putQualityFormsEvaluation(formId, body)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EvaluationForm", - "required": "true" - } - ], - "return": "EvaluationForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet body: EvaluationForm = new EvaluationForm(...) // Evaluation form\n\n// Update an evaluation form.\nPutQualityFormsEvaluationRequest.putQualityFormsEvaluation(formId: formId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualityFormsEvaluationRequest.putQualityFormsEvaluation was successful\")\n dump(response)\n }\n}" - }, - "putqualityformssurvey": { - "operationId": "putqualityformssurvey", - "functionName": "putQualityFormsSurvey", - "signature": "putQualityFormsSurvey(formId, body)", - "parameters": [ - { - "name": "formId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SurveyForm", - "required": "true" - } - ], - "return": "SurveyForm", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet formId: String = \"\" // Form ID\nlet body: SurveyForm = new SurveyForm(...) // Survey form\n\n// Update a survey form.\nPutQualityFormsSurveyRequest.putQualityFormsSurvey(formId: formId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualityFormsSurveyRequest.putQualityFormsSurvey was successful\")\n dump(response)\n }\n}" - }, - "putqualitysurveysscorable": { - "operationId": "putqualitysurveysscorable", - "functionName": "putQualitySurveysScorable", - "signature": "putQualitySurveysScorable(customerSurveyUrl, body)", - "parameters": [ - { - "name": "customerSurveyUrl", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScorableSurvey", - "required": "true" - } - ], - "return": "ScorableSurvey", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet customerSurveyUrl: String = \"\" // customerSurveyUrl\nlet body: ScorableSurvey = new ScorableSurvey(...) // survey\n\n// Update a survey as an end-customer, for the purposes of scoring it.\nPutQualitySurveysScorableRequest.putQualitySurveysScorable(customerSurveyUrl: customerSurveyUrl, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutQualitySurveysScorableRequest.putQualitySurveysScorable was successful\")\n dump(response)\n }\n}" - }, - "deleteconversationrecordingannotation": { - "operationId": "deleteconversationrecordingannotation", - "functionName": "deleteConversationRecordingAnnotation", - "signature": "deleteConversationRecordingAnnotation(conversationId, recordingId, annotationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet annotationId: String = \"\" // Annotation ID\n\n// Delete annotation\nDeleteConversationRecordingAnnotationRequest.deleteConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteConversationRecordingAnnotationRequest.deleteConversationRecordingAnnotation was successful\")\n }\n}" - }, - "deleteorphanrecording": { - "operationId": "deleteorphanrecording", - "functionName": "deleteOrphanrecording", - "signature": "deleteOrphanrecording(orphanId)", - "parameters": [ - { - "name": "orphanId", - "type": "String", - "required": "true" - } - ], - "return": "OrphanRecording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet orphanId: String = \"\" // Orphan ID\n\n// Deletes a single orphan recording\nDeleteOrphanrecordingRequest.deleteOrphanrecording(orphanId: orphanId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteOrphanrecordingRequest.deleteOrphanrecording was successful\")\n dump(response)\n }\n}" - }, - "deleterecordingcrossplatformmediaretentionpolicies": { - "operationId": "deleterecordingcrossplatformmediaretentionpolicies", - "functionName": "deleteRecordingCrossplatformMediaretentionpolicies", - "signature": "deleteRecordingCrossplatformMediaretentionpolicies(ids)", - "parameters": [ - { - "name": "ids", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ids: String = \"\" // \n\n// Delete media retention policies\nDeleteRecordingCrossplatformMediaretentionpoliciesRequest.deleteRecordingCrossplatformMediaretentionpolicies(ids: ids) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRecordingCrossplatformMediaretentionpoliciesRequest.deleteRecordingCrossplatformMediaretentionpolicies was successful\")\n }\n}" - }, - "deleterecordingcrossplatformmediaretentionpolicy": { - "operationId": "deleterecordingcrossplatformmediaretentionpolicy", - "functionName": "deleteRecordingCrossplatformMediaretentionpolicy", - "signature": "deleteRecordingCrossplatformMediaretentionpolicy(policyId)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\n\n// Delete a media retention policy\nDeleteRecordingCrossplatformMediaretentionpolicyRequest.deleteRecordingCrossplatformMediaretentionpolicy(policyId: policyId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRecordingCrossplatformMediaretentionpolicyRequest.deleteRecordingCrossplatformMediaretentionpolicy was successful\")\n }\n}" - }, - "deleterecordingjob": { - "operationId": "deleterecordingjob", - "functionName": "deleteRecordingJob", - "signature": "deleteRecordingJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Delete the recording bulk job\nDeleteRecordingJobRequest.deleteRecordingJob(jobId: jobId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRecordingJobRequest.deleteRecordingJob was successful\")\n }\n}" - }, - "deleterecordingmediaretentionpolicies": { - "operationId": "deleterecordingmediaretentionpolicies", - "functionName": "deleteRecordingMediaretentionpolicies", - "signature": "deleteRecordingMediaretentionpolicies(ids)", - "parameters": [ - { - "name": "ids", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ids: String = \"\" // \n\n// Delete media retention policies\nDeleteRecordingMediaretentionpoliciesRequest.deleteRecordingMediaretentionpolicies(ids: ids) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRecordingMediaretentionpoliciesRequest.deleteRecordingMediaretentionpolicies was successful\")\n }\n}" - }, - "deleterecordingmediaretentionpolicy": { - "operationId": "deleterecordingmediaretentionpolicy", - "functionName": "deleteRecordingMediaretentionpolicy", - "signature": "deleteRecordingMediaretentionpolicy(policyId)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\n\n// Delete a media retention policy\nDeleteRecordingMediaretentionpolicyRequest.deleteRecordingMediaretentionpolicy(policyId: policyId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRecordingMediaretentionpolicyRequest.deleteRecordingMediaretentionpolicy was successful\")\n }\n}" - }, - "getconversationrecording": { - "operationId": "getconversationrecording", - "functionName": "getConversationRecording", - "signature": "getConversationRecording(conversationId, recordingId, formatId, emailFormatId, chatFormatId, messageFormatId, download, fileName, locale, mediaFormats)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - }, - { - "name": "emailFormatId", - "type": "String", - "required": "false" - }, - { - "name": "chatFormatId", - "type": "String", - "required": "false" - }, - { - "name": "messageFormatId", - "type": "String", - "required": "false" - }, - { - "name": "download", - "type": "Bool", - "required": "false" - }, - { - "name": "fileName", - "type": "String", - "required": "false" - }, - { - "name": "locale", - "type": "String", - "required": "false" - }, - { - "name": "mediaFormats", - "type": "[String]", - "required": "false" - } - ], - "return": "Recording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet formatId: GetConversationRecordingRequest.FormatId_getConversationRecording = GetConversationRecordingRequest.FormatId_getConversationRecording.enummember // The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE\nlet emailFormatId: GetConversationRecordingRequest.EmailFormatId_getConversationRecording = GetConversationRecordingRequest.EmailFormatId_getConversationRecording.enummember // The desired media format when downloading an email recording. Valid values:EML,NONE\nlet chatFormatId: GetConversationRecordingRequest.ChatFormatId_getConversationRecording = GetConversationRecordingRequest.ChatFormatId_getConversationRecording.enummember // The desired media format when downloading a chat recording. Valid values:ZIP,NONE \nlet messageFormatId: GetConversationRecordingRequest.MessageFormatId_getConversationRecording = GetConversationRecordingRequest.MessageFormatId_getConversationRecording.enummember // The desired media format when downloading a message recording. Valid values:ZIP,NONE\nlet download: Bool = true // requesting a download format of the recording. Valid values:true,false\nlet fileName: String = \"\" // the name of the downloaded fileName\nlet locale: String = \"\" // The locale for the requested file when downloading, as an ISO 639-1 code\nlet mediaFormats: [String] = [\"\"] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3\n\n// Gets a specific recording.\nGetConversationRecordingRequest.getConversationRecording(conversationId: conversationId, recordingId: recordingId, formatId: formatId, emailFormatId: emailFormatId, chatFormatId: chatFormatId, messageFormatId: messageFormatId, download: download, fileName: fileName, locale: locale, mediaFormats: mediaFormats) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingRequest.getConversationRecording was successful\")\n dump(response)\n }\n}" - }, - "getconversationrecordingannotation": { - "operationId": "getconversationrecordingannotation", - "functionName": "getConversationRecordingAnnotation", - "signature": "getConversationRecordingAnnotation(conversationId, recordingId, annotationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - } - ], - "return": "Annotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet annotationId: String = \"\" // Annotation ID\n\n// Get annotation\nGetConversationRecordingAnnotationRequest.getConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingAnnotationRequest.getConversationRecordingAnnotation was successful\")\n dump(response)\n }\n}" - }, - "getconversationrecordingannotations": { - "operationId": "getconversationrecordingannotations", - "functionName": "getConversationRecordingAnnotations", - "signature": "getConversationRecordingAnnotations(conversationId, recordingId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - } - ], - "return": "[Annotation]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\n\n// Get annotations for recording\nGetConversationRecordingAnnotationsRequest.getConversationRecordingAnnotations(conversationId: conversationId, recordingId: recordingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingAnnotationsRequest.getConversationRecordingAnnotations was successful\")\n dump(response)\n }\n}" - }, - "getconversationrecordingmetadata": { - "operationId": "getconversationrecordingmetadata", - "functionName": "getConversationRecordingmetadata", - "signature": "getConversationRecordingmetadata(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "[RecordingMetadata]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\n\n// Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.\nGetConversationRecordingmetadataRequest.getConversationRecordingmetadata(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingmetadataRequest.getConversationRecordingmetadata was successful\")\n dump(response)\n }\n}" - }, - "getconversationrecordingmetadatarecordingid": { - "operationId": "getconversationrecordingmetadatarecordingid", - "functionName": "getConversationRecordingmetadataRecordingId", - "signature": "getConversationRecordingmetadataRecordingId(conversationId, recordingId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - } - ], - "return": "RecordingMetadata", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\n\n// Get metadata for a specific recording. Does not return playable media.\nGetConversationRecordingmetadataRecordingIdRequest.getConversationRecordingmetadataRecordingId(conversationId: conversationId, recordingId: recordingId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingmetadataRecordingIdRequest.getConversationRecordingmetadataRecordingId was successful\")\n dump(response)\n }\n}" - }, - "getconversationrecordings": { - "operationId": "getconversationrecordings", - "functionName": "getConversationRecordings", - "signature": "getConversationRecordings(conversationId, maxWaitMs, formatId, mediaFormats)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "maxWaitMs", - "type": "Int", - "required": "false" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - }, - { - "name": "mediaFormats", - "type": "[String]", - "required": "false" - } - ], - "return": "[Recording]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet maxWaitMs: Int = 0 // The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.\nlet formatId: GetConversationRecordingsRequest.FormatId_getConversationRecordings = GetConversationRecordingsRequest.FormatId_getConversationRecordings.enummember // The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.\nlet mediaFormats: [String] = [\"\"] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.\n\n// Get all of a Conversation's Recordings.\nGetConversationRecordingsRequest.getConversationRecordings(conversationId: conversationId, maxWaitMs: maxWaitMs, formatId: formatId, mediaFormats: mediaFormats) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetConversationRecordingsRequest.getConversationRecordings was successful\")\n dump(response)\n }\n}" - }, - "getorphanrecording": { - "operationId": "getorphanrecording", - "functionName": "getOrphanrecording", - "signature": "getOrphanrecording(orphanId)", - "parameters": [ - { - "name": "orphanId", - "type": "String", - "required": "true" - } - ], - "return": "OrphanRecording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet orphanId: String = \"\" // Orphan ID\n\n// Gets a single orphan recording\nGetOrphanrecordingRequest.getOrphanrecording(orphanId: orphanId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrphanrecordingRequest.getOrphanrecording was successful\")\n dump(response)\n }\n}" - }, - "getorphanrecordingmedia": { - "operationId": "getorphanrecordingmedia", - "functionName": "getOrphanrecordingMedia", - "signature": "getOrphanrecordingMedia(orphanId, formatId, emailFormatId, chatFormatId, messageFormatId, download, fileName, locale, mediaFormats)", - "parameters": [ - { - "name": "orphanId", - "type": "String", - "required": "true" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - }, - { - "name": "emailFormatId", - "type": "String", - "required": "false" - }, - { - "name": "chatFormatId", - "type": "String", - "required": "false" - }, - { - "name": "messageFormatId", - "type": "String", - "required": "false" - }, - { - "name": "download", - "type": "Bool", - "required": "false" - }, - { - "name": "fileName", - "type": "String", - "required": "false" - }, - { - "name": "locale", - "type": "String", - "required": "false" - }, - { - "name": "mediaFormats", - "type": "[String]", - "required": "false" - } - ], - "return": "Recording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet orphanId: String = \"\" // Orphan ID\nlet formatId: GetOrphanrecordingMediaRequest.FormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.FormatId_getOrphanrecordingMedia.enummember // The desired media format.\nlet emailFormatId: GetOrphanrecordingMediaRequest.EmailFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.EmailFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading an email recording.\nlet chatFormatId: GetOrphanrecordingMediaRequest.ChatFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.ChatFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading a chat recording.\nlet messageFormatId: GetOrphanrecordingMediaRequest.MessageFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.MessageFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading a message recording.\nlet download: Bool = true // requesting a download format of the recording\nlet fileName: String = \"\" // the name of the downloaded fileName\nlet locale: String = \"\" // The locale for the requested file when downloading, as an ISO 639-1 code\nlet mediaFormats: [String] = [\"\"] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3\n\n// Gets the media of a single orphan recording\nGetOrphanrecordingMediaRequest.getOrphanrecordingMedia(orphanId: orphanId, formatId: formatId, emailFormatId: emailFormatId, chatFormatId: chatFormatId, messageFormatId: messageFormatId, download: download, fileName: fileName, locale: locale, mediaFormats: mediaFormats) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrphanrecordingMediaRequest.getOrphanrecordingMedia was successful\")\n dump(response)\n }\n}" - }, - "getorphanrecordings": { - "operationId": "getorphanrecordings", - "functionName": "getOrphanrecordings", - "signature": "getOrphanrecordings(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, hasConversation, media)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "hasConversation", - "type": "Bool", - "required": "false" - }, - { - "name": "media", - "type": "String", - "required": "false" - } - ], - "return": "OrphanRecordingListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet hasConversation: Bool = true // Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.\nlet media: GetOrphanrecordingsRequest.Media_getOrphanrecordings = GetOrphanrecordingsRequest.Media_getOrphanrecordings.enummember // Filter resulting orphans based on their media type\n\n// Gets all orphan recordings\nGetOrphanrecordingsRequest.getOrphanrecordings(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, hasConversation: hasConversation, media: media) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetOrphanrecordingsRequest.getOrphanrecordings was successful\")\n dump(response)\n }\n}" - }, - "getrecordingbatchrequest": { - "operationId": "getrecordingbatchrequest", - "functionName": "getRecordingBatchrequest", - "signature": "getRecordingBatchrequest(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "BatchDownloadJobStatusResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Get the status and results for a batch request job, only the user that submitted the job may retrieve results\nGetRecordingBatchrequestRequest.getRecordingBatchrequest(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingBatchrequestRequest.getRecordingBatchrequest was successful\")\n dump(response)\n }\n}" - }, - "getrecordingcrossplatformmediaretentionpolicies": { - "operationId": "getrecordingcrossplatformmediaretentionpolicies", - "functionName": "getRecordingCrossplatformMediaretentionpolicies", - "signature": "getRecordingCrossplatformMediaretentionpolicies(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, enabled, summary, hasErrors, deleteDaysThreshold)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "enabled", - "type": "Bool", - "required": "false" - }, - { - "name": "summary", - "type": "Bool", - "required": "false" - }, - { - "name": "hasErrors", - "type": "Bool", - "required": "false" - }, - { - "name": "deleteDaysThreshold", - "type": "Int", - "required": "false" - } - ], - "return": "PolicyEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet name: String = \"\" // the policy name - used for filtering results in searches.\nlet enabled: Bool = true // checks to see if policy is enabled - use enabled = true or enabled = false\nlet summary: Bool = true // provides a less verbose response of policy lists.\nlet hasErrors: Bool = true // provides a way to fetch all policies with errors or policies that do not have errors\nlet deleteDaysThreshold: Int = 0 // provides a way to fetch all policies with any actions having deleteDays exceeding the provided value\n\n// Gets media retention policy list with query options to filter on name and enabled.\nGetRecordingCrossplatformMediaretentionpoliciesRequest.getRecordingCrossplatformMediaretentionpolicies(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, enabled: enabled, summary: summary, hasErrors: hasErrors, deleteDaysThreshold: deleteDaysThreshold) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingCrossplatformMediaretentionpoliciesRequest.getRecordingCrossplatformMediaretentionpolicies was successful\")\n dump(response)\n }\n}" - }, - "getrecordingcrossplatformmediaretentionpolicy": { - "operationId": "getrecordingcrossplatformmediaretentionpolicy", - "functionName": "getRecordingCrossplatformMediaretentionpolicy", - "signature": "getRecordingCrossplatformMediaretentionpolicy(policyId)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - } - ], - "return": "CrossPlatformPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\n\n// Get a media retention policy\nGetRecordingCrossplatformMediaretentionpolicyRequest.getRecordingCrossplatformMediaretentionpolicy(policyId: policyId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingCrossplatformMediaretentionpolicyRequest.getRecordingCrossplatformMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "getrecordingjob": { - "operationId": "getrecordingjob", - "functionName": "getRecordingJob", - "signature": "getRecordingJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "RecordingJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Get the status of the job associated with the job id.\nGetRecordingJobRequest.getRecordingJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingJobRequest.getRecordingJob was successful\")\n dump(response)\n }\n}" - }, - "getrecordingjobfailedrecordings": { - "operationId": "getrecordingjobfailedrecordings", - "functionName": "getRecordingJobFailedrecordings", - "signature": "getRecordingJobFailedrecordings(jobId, pageSize, pageNumber, includeTotal, cursor)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "includeTotal", - "type": "Bool", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "FailedRecordingEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\nlet pageSize: Int = 0 // Page size. Maximum is 100.\nlet pageNumber: Int = 0 // Page number\nlet includeTotal: Bool = true // If false, cursor will be used to locate the page instead of pageNumber.\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\n\n// Get IDs of recordings that the bulk job failed for\nGetRecordingJobFailedrecordingsRequest.getRecordingJobFailedrecordings(jobId: jobId, pageSize: pageSize, pageNumber: pageNumber, includeTotal: includeTotal, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingJobFailedrecordingsRequest.getRecordingJobFailedrecordings was successful\")\n dump(response)\n }\n}" - }, - "getrecordingjobs": { - "operationId": "getrecordingjobs", - "functionName": "getRecordingJobs", - "signature": "getRecordingJobs(pageSize, pageNumber, sortBy, state, showOnlyMyJobs, jobType, includeTotal, cursor)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - }, - { - "name": "showOnlyMyJobs", - "type": "Bool", - "required": "false" - }, - { - "name": "jobType", - "type": "String", - "required": "false" - }, - { - "name": "includeTotal", - "type": "Bool", - "required": "false" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - } - ], - "return": "RecordingJobEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: GetRecordingJobsRequest.SortBy_getRecordingJobs = GetRecordingJobsRequest.SortBy_getRecordingJobs.enummember // Sort by\nlet state: GetRecordingJobsRequest.State_getRecordingJobs = GetRecordingJobsRequest.State_getRecordingJobs.enummember // Filter by state\nlet showOnlyMyJobs: Bool = true // Show only my jobs\nlet jobType: GetRecordingJobsRequest.JobType_getRecordingJobs = GetRecordingJobsRequest.JobType_getRecordingJobs.enummember // Job Type (Can be left empty for both)\nlet includeTotal: Bool = true // If false, cursor will be used to locate the page instead of pageNumber.\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\n\n// Get the status of all jobs within the user's organization\nGetRecordingJobsRequest.getRecordingJobs(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, state: state, showOnlyMyJobs: showOnlyMyJobs, jobType: jobType, includeTotal: includeTotal, cursor: cursor) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingJobsRequest.getRecordingJobs was successful\")\n dump(response)\n }\n}" - }, - "getrecordingkeyconfiguration": { - "operationId": "getrecordingkeyconfiguration", - "functionName": "getRecordingKeyconfiguration", - "signature": "getRecordingKeyconfiguration(keyConfigurationId)", - "parameters": [ - { - "name": "keyConfigurationId", - "type": "String", - "required": "true" - } - ], - "return": "RecordingEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet keyConfigurationId: String = \"\" // Key Configurations Id\n\n// Get the encryption key configurations\nGetRecordingKeyconfigurationRequest.getRecordingKeyconfiguration(keyConfigurationId: keyConfigurationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingKeyconfigurationRequest.getRecordingKeyconfiguration was successful\")\n dump(response)\n }\n}" - }, - "getrecordingkeyconfigurations": { - "operationId": "getrecordingkeyconfigurations", - "functionName": "getRecordingKeyconfigurations", - "signature": "getRecordingKeyconfigurations()", - "return": "RecordingEncryptionConfigurationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of key configurations data\nGetRecordingKeyconfigurationsRequest.getRecordingKeyconfigurations() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingKeyconfigurationsRequest.getRecordingKeyconfigurations was successful\")\n dump(response)\n }\n}" - }, - "getrecordingmediaretentionpolicies": { - "operationId": "getrecordingmediaretentionpolicies", - "functionName": "getRecordingMediaretentionpolicies", - "signature": "getRecordingMediaretentionpolicies(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, enabled, summary, hasErrors, deleteDaysThreshold)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "previousPage", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "enabled", - "type": "Bool", - "required": "false" - }, - { - "name": "summary", - "type": "Bool", - "required": "false" - }, - { - "name": "hasErrors", - "type": "Bool", - "required": "false" - }, - { - "name": "deleteDaysThreshold", - "type": "Int", - "required": "false" - } - ], - "return": "PolicyEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // The total page size requested\nlet pageNumber: Int = 0 // The page number requested\nlet sortBy: String = \"\" // variable name requested to sort by\nlet expand: [String] = [\"\"] // variable name requested by expand list\nlet nextPage: String = \"\" // next page token\nlet previousPage: String = \"\" // Previous page token\nlet name: String = \"\" // the policy name - used for filtering results in searches.\nlet enabled: Bool = true // checks to see if policy is enabled - use enabled = true or enabled = false\nlet summary: Bool = true // provides a less verbose response of policy lists.\nlet hasErrors: Bool = true // provides a way to fetch all policies with errors or policies that do not have errors\nlet deleteDaysThreshold: Int = 0 // provides a way to fetch all policies with any actions having deleteDays exceeding the provided value\n\n// Gets media retention policy list with query options to filter on name and enabled.\nGetRecordingMediaretentionpoliciesRequest.getRecordingMediaretentionpolicies(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, enabled: enabled, summary: summary, hasErrors: hasErrors, deleteDaysThreshold: deleteDaysThreshold) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingMediaretentionpoliciesRequest.getRecordingMediaretentionpolicies was successful\")\n dump(response)\n }\n}" - }, - "getrecordingmediaretentionpolicy": { - "operationId": "getrecordingmediaretentionpolicy", - "functionName": "getRecordingMediaretentionpolicy", - "signature": "getRecordingMediaretentionpolicy(policyId)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - } - ], - "return": "Policy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\n\n// Get a media retention policy\nGetRecordingMediaretentionpolicyRequest.getRecordingMediaretentionpolicy(policyId: policyId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingMediaretentionpolicyRequest.getRecordingMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "getrecordingrecordingkeys": { - "operationId": "getrecordingrecordingkeys", - "functionName": "getRecordingRecordingkeys", - "signature": "getRecordingRecordingkeys(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "EncryptionKeyEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get encryption key list\nGetRecordingRecordingkeysRequest.getRecordingRecordingkeys(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingRecordingkeysRequest.getRecordingRecordingkeys was successful\")\n dump(response)\n }\n}" - }, - "getrecordingrecordingkeysrotationschedule": { - "operationId": "getrecordingrecordingkeysrotationschedule", - "functionName": "getRecordingRecordingkeysRotationschedule", - "signature": "getRecordingRecordingkeysRotationschedule()", - "return": "KeyRotationSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get key rotation schedule\nGetRecordingRecordingkeysRotationscheduleRequest.getRecordingRecordingkeysRotationschedule() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingRecordingkeysRotationscheduleRequest.getRecordingRecordingkeysRotationschedule was successful\")\n dump(response)\n }\n}" - }, - "getrecordingsettings": { - "operationId": "getrecordingsettings", - "functionName": "getRecordingSettings", - "signature": "getRecordingSettings(createDefault)", - "parameters": [ - { - "name": "createDefault", - "type": "Bool", - "required": "false" - } - ], - "return": "RecordingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet createDefault: Bool = true // If no settings are found, a new one is created with default values\n\n// Get the Recording Settings for the Organization\nGetRecordingSettingsRequest.getRecordingSettings(createDefault: createDefault) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingSettingsRequest.getRecordingSettings was successful\")\n dump(response)\n }\n}" - }, - "getrecordinguploadsreport": { - "operationId": "getrecordinguploadsreport", - "functionName": "getRecordingUploadsReport", - "signature": "getRecordingUploadsReport(reportId)", - "parameters": [ - { - "name": "reportId", - "type": "String", - "required": "true" - } - ], - "return": "RecordingUploadReport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet reportId: String = \"\" // reportId\n\n// Get the status of a recording upload status report\nGetRecordingUploadsReportRequest.getRecordingUploadsReport(reportId: reportId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingUploadsReportRequest.getRecordingUploadsReport was successful\")\n dump(response)\n }\n}" - }, - "getrecordingsretentionquery": { - "operationId": "getrecordingsretentionquery", - "functionName": "getRecordingsRetentionQuery", - "signature": "getRecordingsRetentionQuery(retentionThresholdDays, cursor, pageSize)", - "parameters": [ - { - "name": "retentionThresholdDays", - "type": "Int", - "required": "true" - }, - { - "name": "cursor", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "RecordingRetentionCursorEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet retentionThresholdDays: Int = 0 // Fetch retention data for recordings retained for more days than the provided value.\nlet cursor: String = \"\" // Indicates where to resume query results (not required for first page)\nlet pageSize: Int = 0 // Page size. Maximum is 500.\n\n// Query for recording retention data\nGetRecordingsRetentionQueryRequest.getRecordingsRetentionQuery(retentionThresholdDays: retentionThresholdDays, cursor: cursor, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingsRetentionQueryRequest.getRecordingsRetentionQuery was successful\")\n dump(response)\n }\n}" - }, - "getrecordingsscreensessions": { - "operationId": "getrecordingsscreensessions", - "functionName": "getRecordingsScreensessions", - "signature": "getRecordingsScreensessions(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "ScreenRecordingSessionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Retrieves a paged listing of screen recording sessions\nGetRecordingsScreensessionsRequest.getRecordingsScreensessions(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRecordingsScreensessionsRequest.getRecordingsScreensessions was successful\")\n dump(response)\n }\n}" - }, - "patchrecordingcrossplatformmediaretentionpolicy": { - "operationId": "patchrecordingcrossplatformmediaretentionpolicy", - "functionName": "patchRecordingCrossplatformMediaretentionpolicy", - "signature": "patchRecordingCrossplatformMediaretentionpolicy(policyId, body)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CrossPlatformPolicyUpdate", - "required": "true" - } - ], - "return": "CrossPlatformPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\nlet body: CrossPlatformPolicyUpdate = new CrossPlatformPolicyUpdate(...) // Policy\n\n// Patch a media retention policy\nPatchRecordingCrossplatformMediaretentionpolicyRequest.patchRecordingCrossplatformMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRecordingCrossplatformMediaretentionpolicyRequest.patchRecordingCrossplatformMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "patchrecordingmediaretentionpolicy": { - "operationId": "patchrecordingmediaretentionpolicy", - "functionName": "patchRecordingMediaretentionpolicy", - "signature": "patchRecordingMediaretentionpolicy(policyId, body)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PolicyUpdate", - "required": "true" - } - ], - "return": "Policy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\nlet body: PolicyUpdate = new PolicyUpdate(...) // Policy\n\n// Patch a media retention policy\nPatchRecordingMediaretentionpolicyRequest.patchRecordingMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRecordingMediaretentionpolicyRequest.patchRecordingMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "patchrecordingsscreensession": { - "operationId": "patchrecordingsscreensession", - "functionName": "patchRecordingsScreensession", - "signature": "patchRecordingsScreensession(recordingSessionId, body)", - "parameters": [ - { - "name": "recordingSessionId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScreenRecordingSessionRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recordingSessionId: String = \"\" // Screen recording session ID\nlet body: ScreenRecordingSessionRequest = new ScreenRecordingSessionRequest(...) // \n\n// Update a screen recording session\nPatchRecordingsScreensessionRequest.patchRecordingsScreensession(recordingSessionId: recordingSessionId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchRecordingsScreensessionRequest.patchRecordingsScreensession was successful\")\n }\n}" - }, - "postconversationrecordingannotations": { - "operationId": "postconversationrecordingannotations", - "functionName": "postConversationRecordingAnnotations", - "signature": "postConversationRecordingAnnotations(conversationId, recordingId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Annotation", - "required": "true" - } - ], - "return": "Annotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet body: Annotation = new Annotation(...) // annotation\n\n// Create annotation\nPostConversationRecordingAnnotationsRequest.postConversationRecordingAnnotations(conversationId: conversationId, recordingId: recordingId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostConversationRecordingAnnotationsRequest.postConversationRecordingAnnotations was successful\")\n dump(response)\n }\n}" - }, - "postrecordingbatchrequests": { - "operationId": "postrecordingbatchrequests", - "functionName": "postRecordingBatchrequests", - "signature": "postRecordingBatchrequests(body)", - "parameters": [ - { - "name": "body", - "type": "BatchDownloadJobSubmission", - "required": "true" - } - ], - "return": "BatchDownloadJobSubmissionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BatchDownloadJobSubmission = new BatchDownloadJobSubmission(...) // Job submission criteria\n\n// Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.\nPostRecordingBatchrequestsRequest.postRecordingBatchrequests(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingBatchrequestsRequest.postRecordingBatchrequests was successful\")\n dump(response)\n }\n}" - }, - "postrecordingcrossplatformmediaretentionpolicies": { - "operationId": "postrecordingcrossplatformmediaretentionpolicies", - "functionName": "postRecordingCrossplatformMediaretentionpolicies", - "signature": "postRecordingCrossplatformMediaretentionpolicies(body)", - "parameters": [ - { - "name": "body", - "type": "CrossPlatformPolicyCreate", - "required": "true" - } - ], - "return": "CrossPlatformPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CrossPlatformPolicyCreate = new CrossPlatformPolicyCreate(...) // Policy\n\n// Create media retention policy\nPostRecordingCrossplatformMediaretentionpoliciesRequest.postRecordingCrossplatformMediaretentionpolicies(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingCrossplatformMediaretentionpoliciesRequest.postRecordingCrossplatformMediaretentionpolicies was successful\")\n dump(response)\n }\n}" - }, - "postrecordingjobs": { - "operationId": "postrecordingjobs", - "functionName": "postRecordingJobs", - "signature": "postRecordingJobs(body)", - "parameters": [ - { - "name": "body", - "type": "RecordingJobsQuery", - "required": "true" - } - ], - "return": "RecordingJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RecordingJobsQuery = new RecordingJobsQuery(...) // query\n\n// Create a recording bulk job.\nPostRecordingJobsRequest.postRecordingJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingJobsRequest.postRecordingJobs was successful\")\n dump(response)\n }\n}" - }, - "postrecordingkeyconfigurations": { - "operationId": "postrecordingkeyconfigurations", - "functionName": "postRecordingKeyconfigurations", - "signature": "postRecordingKeyconfigurations(body)", - "parameters": [ - { - "name": "body", - "type": "RecordingEncryptionConfiguration", - "required": "true" - } - ], - "return": "RecordingEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption Configuration\n\n// Setup configurations for encryption key creation\nPostRecordingKeyconfigurationsRequest.postRecordingKeyconfigurations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingKeyconfigurationsRequest.postRecordingKeyconfigurations was successful\")\n dump(response)\n }\n}" - }, - "postrecordingkeyconfigurationsvalidate": { - "operationId": "postrecordingkeyconfigurationsvalidate", - "functionName": "postRecordingKeyconfigurationsValidate", - "signature": "postRecordingKeyconfigurationsValidate(body)", - "parameters": [ - { - "name": "body", - "type": "RecordingEncryptionConfiguration", - "required": "true" - } - ], - "return": "RecordingEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption Configuration\n\n// Validate encryption key configurations without saving it\nPostRecordingKeyconfigurationsValidateRequest.postRecordingKeyconfigurationsValidate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingKeyconfigurationsValidateRequest.postRecordingKeyconfigurationsValidate was successful\")\n dump(response)\n }\n}" - }, - "postrecordinglocalkeys": { - "operationId": "postrecordinglocalkeys", - "functionName": "postRecordingLocalkeys", - "signature": "postRecordingLocalkeys(body)", - "parameters": [ - { - "name": "body", - "type": "LocalEncryptionKeyRequest", - "required": "true" - } - ], - "return": "EncryptionKey", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LocalEncryptionKeyRequest = new LocalEncryptionKeyRequest(...) // Local Encryption body\n\n// create a local key management recording key\nPostRecordingLocalkeysRequest.postRecordingLocalkeys(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingLocalkeysRequest.postRecordingLocalkeys was successful\")\n dump(response)\n }\n}" - }, - "postrecordingmediaretentionpolicies": { - "operationId": "postrecordingmediaretentionpolicies", - "functionName": "postRecordingMediaretentionpolicies", - "signature": "postRecordingMediaretentionpolicies(body)", - "parameters": [ - { - "name": "body", - "type": "PolicyCreate", - "required": "true" - } - ], - "return": "Policy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PolicyCreate = new PolicyCreate(...) // Policy\n\n// Create media retention policy\nPostRecordingMediaretentionpoliciesRequest.postRecordingMediaretentionpolicies(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingMediaretentionpoliciesRequest.postRecordingMediaretentionpolicies was successful\")\n dump(response)\n }\n}" - }, - "postrecordingrecordingkeys": { - "operationId": "postrecordingrecordingkeys", - "functionName": "postRecordingRecordingkeys", - "signature": "postRecordingRecordingkeys()", - "return": "EncryptionKey", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Create encryption key\nPostRecordingRecordingkeysRequest.postRecordingRecordingkeys() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingRecordingkeysRequest.postRecordingRecordingkeys was successful\")\n dump(response)\n }\n}" - }, - "postrecordinguploadsreports": { - "operationId": "postrecordinguploadsreports", - "functionName": "postRecordingUploadsReports", - "signature": "postRecordingUploadsReports(body)", - "parameters": [ - { - "name": "body", - "type": "RecordingUploadReportRequest", - "required": "true" - } - ], - "return": "RecordingUploadReport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RecordingUploadReportRequest = new RecordingUploadReportRequest(...) // Report parameters\n\n// Creates a recording upload status report\nPostRecordingUploadsReportsRequest.postRecordingUploadsReports(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingUploadsReportsRequest.postRecordingUploadsReports was successful\")\n dump(response)\n }\n}" - }, - "postrecordingsdeletionprotection": { - "operationId": "postrecordingsdeletionprotection", - "functionName": "postRecordingsDeletionprotection", - "signature": "postRecordingsDeletionprotection(body)", - "parameters": [ - { - "name": "body", - "type": "ConversationDeletionProtectionQuery", - "required": "true" - } - ], - "return": "[AddressableEntityRef]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ConversationDeletionProtectionQuery = new ConversationDeletionProtectionQuery(...) // conversationIds\n\n// Get a list of conversations with protected recordings\nPostRecordingsDeletionprotectionRequest.postRecordingsDeletionprotection(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRecordingsDeletionprotectionRequest.postRecordingsDeletionprotection was successful\")\n dump(response)\n }\n}" - }, - "postrecordingsscreensessionsacknowledge": { - "operationId": "postrecordingsscreensessionsacknowledge", - "functionName": "postRecordingsScreensessionsAcknowledge", - "signature": "postRecordingsScreensessionsAcknowledge(body)", - "parameters": [ - { - "name": "body", - "type": "AcknowledgeScreenRecordingRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AcknowledgeScreenRecordingRequest = new AcknowledgeScreenRecordingRequest(...) // AcknowledgeScreenRecordingRequest\n\n// Acknowledge a screen recording.\nPostRecordingsScreensessionsAcknowledgeRequest.postRecordingsScreensessionsAcknowledge(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostRecordingsScreensessionsAcknowledgeRequest.postRecordingsScreensessionsAcknowledge was successful\")\n }\n}" - }, - "postrecordingsscreensessionsmetadata": { - "operationId": "postrecordingsscreensessionsmetadata", - "functionName": "postRecordingsScreensessionsMetadata", - "signature": "postRecordingsScreensessionsMetadata(body)", - "parameters": [ - { - "name": "body", - "type": "ScreenRecordingMetaDataRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ScreenRecordingMetaDataRequest = new ScreenRecordingMetaDataRequest(...) // ScreenRecordingMetaDataRequest\n\n// Provide meta-data a screen recording.\nPostRecordingsScreensessionsMetadataRequest.postRecordingsScreensessionsMetadata(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostRecordingsScreensessionsMetadataRequest.postRecordingsScreensessionsMetadata was successful\")\n }\n}" - }, - "putconversationrecording": { - "operationId": "putconversationrecording", - "functionName": "putConversationRecording", - "signature": "putConversationRecording(conversationId, recordingId, body, clearExport)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Recording", - "required": "true" - }, - { - "name": "clearExport", - "type": "Bool", - "required": "false" - } - ], - "return": "Recording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet body: Recording = new Recording(...) // recording\nlet clearExport: Bool = true // Whether to clear the pending export for the recording\n\n// Updates the retention records on a recording.\nPutConversationRecordingRequest.putConversationRecording(conversationId: conversationId, recordingId: recordingId, body: body, clearExport: clearExport) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationRecordingRequest.putConversationRecording was successful\")\n dump(response)\n }\n}" - }, - "putconversationrecordingannotation": { - "operationId": "putconversationrecordingannotation", - "functionName": "putConversationRecordingAnnotation", - "signature": "putConversationRecordingAnnotation(conversationId, recordingId, annotationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "annotationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Annotation", - "required": "true" - } - ], - "return": "Annotation", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet recordingId: String = \"\" // Recording ID\nlet annotationId: String = \"\" // Annotation ID\nlet body: Annotation = new Annotation(...) // annotation\n\n// Update annotation\nPutConversationRecordingAnnotationRequest.putConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutConversationRecordingAnnotationRequest.putConversationRecordingAnnotation was successful\")\n dump(response)\n }\n}" - }, - "putorphanrecording": { - "operationId": "putorphanrecording", - "functionName": "putOrphanrecording", - "signature": "putOrphanrecording(orphanId, body)", - "parameters": [ - { - "name": "orphanId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OrphanUpdateRequest", - "required": "false" - } - ], - "return": "Recording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet orphanId: String = \"\" // Orphan ID\nlet body: OrphanUpdateRequest = new OrphanUpdateRequest(...) // \n\n// Updates an orphan recording to a regular recording with retention values\nPutOrphanrecordingRequest.putOrphanrecording(orphanId: orphanId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutOrphanrecordingRequest.putOrphanrecording was successful\")\n dump(response)\n }\n}" - }, - "putrecordingcrossplatformmediaretentionpolicy": { - "operationId": "putrecordingcrossplatformmediaretentionpolicy", - "functionName": "putRecordingCrossplatformMediaretentionpolicy", - "signature": "putRecordingCrossplatformMediaretentionpolicy(policyId, body)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CrossPlatformPolicy", - "required": "true" - } - ], - "return": "CrossPlatformPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\nlet body: CrossPlatformPolicy = new CrossPlatformPolicy(...) // Policy\n\n// Update a media retention policy\nPutRecordingCrossplatformMediaretentionpolicyRequest.putRecordingCrossplatformMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingCrossplatformMediaretentionpolicyRequest.putRecordingCrossplatformMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "putrecordingjob": { - "operationId": "putrecordingjob", - "functionName": "putRecordingJob", - "signature": "putRecordingJob(jobId, body)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExecuteRecordingJobsQuery", - "required": "true" - } - ], - "return": "RecordingJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\nlet body: ExecuteRecordingJobsQuery = new ExecuteRecordingJobsQuery(...) // query\n\n// Execute the recording bulk job.\nPutRecordingJobRequest.putRecordingJob(jobId: jobId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingJobRequest.putRecordingJob was successful\")\n dump(response)\n }\n}" - }, - "putrecordingkeyconfiguration": { - "operationId": "putrecordingkeyconfiguration", - "functionName": "putRecordingKeyconfiguration", - "signature": "putRecordingKeyconfiguration(keyConfigurationId, body)", - "parameters": [ - { - "name": "keyConfigurationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RecordingEncryptionConfiguration", - "required": "true" - } - ], - "return": "RecordingEncryptionConfiguration", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet keyConfigurationId: String = \"\" // Key Configurations Id\nlet body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption key configuration metadata\n\n// Update the encryption key configurations\nPutRecordingKeyconfigurationRequest.putRecordingKeyconfiguration(keyConfigurationId: keyConfigurationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingKeyconfigurationRequest.putRecordingKeyconfiguration was successful\")\n dump(response)\n }\n}" - }, - "putrecordingmediaretentionpolicy": { - "operationId": "putrecordingmediaretentionpolicy", - "functionName": "putRecordingMediaretentionpolicy", - "signature": "putRecordingMediaretentionpolicy(policyId, body)", - "parameters": [ - { - "name": "policyId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Policy", - "required": "true" - } - ], - "return": "Policy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet policyId: String = \"\" // Policy ID\nlet body: Policy = new Policy(...) // Policy\n\n// Update a media retention policy\nPutRecordingMediaretentionpolicyRequest.putRecordingMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingMediaretentionpolicyRequest.putRecordingMediaretentionpolicy was successful\")\n dump(response)\n }\n}" - }, - "putrecordingrecordingkeysrotationschedule": { - "operationId": "putrecordingrecordingkeysrotationschedule", - "functionName": "putRecordingRecordingkeysRotationschedule", - "signature": "putRecordingRecordingkeysRotationschedule(body)", - "parameters": [ - { - "name": "body", - "type": "KeyRotationSchedule", - "required": "true" - } - ], - "return": "KeyRotationSchedule", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: KeyRotationSchedule = new KeyRotationSchedule(...) // KeyRotationSchedule\n\n// Update key rotation schedule\nPutRecordingRecordingkeysRotationscheduleRequest.putRecordingRecordingkeysRotationschedule(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingRecordingkeysRotationscheduleRequest.putRecordingRecordingkeysRotationschedule was successful\")\n dump(response)\n }\n}" - }, - "putrecordingsettings": { - "operationId": "putrecordingsettings", - "functionName": "putRecordingSettings", - "signature": "putRecordingSettings(body)", - "parameters": [ - { - "name": "body", - "type": "RecordingSettings", - "required": "true" - } - ], - "return": "RecordingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RecordingSettings = new RecordingSettings(...) // Recording settings\n\n// Update the Recording Settings for the Organization\nPutRecordingSettingsRequest.putRecordingSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRecordingSettingsRequest.putRecordingSettings was successful\")\n dump(response)\n }\n}" - }, - "putrecordingsdeletionprotection": { - "operationId": "putrecordingsdeletionprotection", - "functionName": "putRecordingsDeletionprotection", - "signature": "putRecordingsDeletionprotection(protect, body)", - "parameters": [ - { - "name": "protect", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "ConversationDeletionProtectionQuery", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet protect: Bool = true // Check for apply, uncheck for revoke (each action requires the respective permission)\nlet body: ConversationDeletionProtectionQuery = new ConversationDeletionProtectionQuery(...) // \n\n// Apply or revoke recording protection for conversations\nPutRecordingsDeletionprotectionRequest.putRecordingsDeletionprotection(protect: protect, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutRecordingsDeletionprotectionRequest.putRecordingsDeletionprotection was successful\")\n }\n}" - }, - "deleteresponsemanagementlibrary": { - "operationId": "deleteresponsemanagementlibrary", - "functionName": "deleteResponsemanagementLibrary", - "signature": "deleteResponsemanagementLibrary(libraryId)", - "parameters": [ - { - "name": "libraryId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet libraryId: String = \"\" // Library ID\n\n// Delete an existing response library.\nDeleteResponsemanagementLibraryRequest.deleteResponsemanagementLibrary(libraryId: libraryId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteResponsemanagementLibraryRequest.deleteResponsemanagementLibrary was successful\")\n }\n}" - }, - "deleteresponsemanagementresponse": { - "operationId": "deleteresponsemanagementresponse", - "functionName": "deleteResponsemanagementResponse", - "signature": "deleteResponsemanagementResponse(responseId)", - "parameters": [ - { - "name": "responseId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseId: String = \"\" // Response ID\n\n// Delete an existing response.\nDeleteResponsemanagementResponseRequest.deleteResponsemanagementResponse(responseId: responseId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteResponsemanagementResponseRequest.deleteResponsemanagementResponse was successful\")\n }\n}" - }, - "deleteresponsemanagementresponseasset": { - "operationId": "deleteresponsemanagementresponseasset", - "functionName": "deleteResponsemanagementResponseasset", - "signature": "deleteResponsemanagementResponseasset(responseAssetId)", - "parameters": [ - { - "name": "responseAssetId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseAssetId: String = \"\" // Asset Id\n\n// Delete response asset\nDeleteResponsemanagementResponseassetRequest.deleteResponsemanagementResponseasset(responseAssetId: responseAssetId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteResponsemanagementResponseassetRequest.deleteResponsemanagementResponseasset was successful\")\n }\n}" - }, - "getresponsemanagementlibraries": { - "operationId": "getresponsemanagementlibraries", - "functionName": "getResponsemanagementLibraries", - "signature": "getResponsemanagementLibraries(pageNumber, pageSize, messagingTemplateFilter, libraryPrefix)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "messagingTemplateFilter", - "type": "String", - "required": "false" - }, - { - "name": "libraryPrefix", - "type": "String", - "required": "false" - } - ], - "return": "LibraryEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet messagingTemplateFilter: GetResponsemanagementLibrariesRequest.MessagingTemplateFilter_getResponsemanagementLibraries = GetResponsemanagementLibrariesRequest.MessagingTemplateFilter_getResponsemanagementLibraries.enummember // Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel\nlet libraryPrefix: String = \"\" // Returns a list of libraries that contain the prefix provided\n\n// Gets a list of existing response libraries.\nGetResponsemanagementLibrariesRequest.getResponsemanagementLibraries(pageNumber: pageNumber, pageSize: pageSize, messagingTemplateFilter: messagingTemplateFilter, libraryPrefix: libraryPrefix) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementLibrariesRequest.getResponsemanagementLibraries was successful\")\n dump(response)\n }\n}" - }, - "getresponsemanagementlibrary": { - "operationId": "getresponsemanagementlibrary", - "functionName": "getResponsemanagementLibrary", - "signature": "getResponsemanagementLibrary(libraryId)", - "parameters": [ - { - "name": "libraryId", - "type": "String", - "required": "true" - } - ], - "return": "Library", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet libraryId: String = \"\" // Library ID\n\n// Get details about an existing response library.\nGetResponsemanagementLibraryRequest.getResponsemanagementLibrary(libraryId: libraryId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementLibraryRequest.getResponsemanagementLibrary was successful\")\n dump(response)\n }\n}" - }, - "getresponsemanagementresponse": { - "operationId": "getresponsemanagementresponse", - "functionName": "getResponsemanagementResponse", - "signature": "getResponsemanagementResponse(responseId, expand)", - "parameters": [ - { - "name": "responseId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "ModelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseId: String = \"\" // Response ID\nlet expand: GetResponsemanagementResponseRequest.Expand_getResponsemanagementResponse = GetResponsemanagementResponseRequest.Expand_getResponsemanagementResponse.enummember // Expand instructions for the return value.\n\n// Get details about an existing response.\nGetResponsemanagementResponseRequest.getResponsemanagementResponse(responseId: responseId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementResponseRequest.getResponsemanagementResponse was successful\")\n dump(response)\n }\n}" - }, - "getresponsemanagementresponseasset": { - "operationId": "getresponsemanagementresponseasset", - "functionName": "getResponsemanagementResponseasset", - "signature": "getResponsemanagementResponseasset(responseAssetId)", - "parameters": [ - { - "name": "responseAssetId", - "type": "String", - "required": "true" - } - ], - "return": "ResponseAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseAssetId: String = \"\" // Asset Id\n\n// Get response asset information\nGetResponsemanagementResponseassetRequest.getResponsemanagementResponseasset(responseAssetId: responseAssetId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementResponseassetRequest.getResponsemanagementResponseasset was successful\")\n dump(response)\n }\n}" - }, - "getresponsemanagementresponseassetsstatusstatusid": { - "operationId": "getresponsemanagementresponseassetsstatusstatusid", - "functionName": "getResponsemanagementResponseassetsStatusStatusId", - "signature": "getResponsemanagementResponseassetsStatusStatusId(statusId)", - "parameters": [ - { - "name": "statusId", - "type": "String", - "required": "true" - } - ], - "return": "ResponseAssetStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet statusId: String = \"\" // Status Id\n\n// Get response asset upload status\nGetResponsemanagementResponseassetsStatusStatusIdRequest.getResponsemanagementResponseassetsStatusStatusId(statusId: statusId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementResponseassetsStatusStatusIdRequest.getResponsemanagementResponseassetsStatusStatusId was successful\")\n dump(response)\n }\n}" - }, - "getresponsemanagementresponses": { - "operationId": "getresponsemanagementresponses", - "functionName": "getResponsemanagementResponses", - "signature": "getResponsemanagementResponses(libraryId, pageNumber, pageSize, expand)", - "parameters": [ - { - "name": "libraryId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "ResponseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet libraryId: String = \"\" // Library ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet expand: GetResponsemanagementResponsesRequest.Expand_getResponsemanagementResponses = GetResponsemanagementResponsesRequest.Expand_getResponsemanagementResponses.enummember // Expand instructions for the return value.\n\n// Gets a list of existing responses.\nGetResponsemanagementResponsesRequest.getResponsemanagementResponses(libraryId: libraryId, pageNumber: pageNumber, pageSize: pageSize, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetResponsemanagementResponsesRequest.getResponsemanagementResponses was successful\")\n dump(response)\n }\n}" - }, - "postresponsemanagementlibraries": { - "operationId": "postresponsemanagementlibraries", - "functionName": "postResponsemanagementLibraries", - "signature": "postResponsemanagementLibraries(body)", - "parameters": [ - { - "name": "body", - "type": "Library", - "required": "true" - } - ], - "return": "Library", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Library = new Library(...) // Library\n\n// Create a response library.\nPostResponsemanagementLibrariesRequest.postResponsemanagementLibraries(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostResponsemanagementLibrariesRequest.postResponsemanagementLibraries was successful\")\n dump(response)\n }\n}" - }, - "postresponsemanagementresponseassetssearch": { - "operationId": "postresponsemanagementresponseassetssearch", - "functionName": "postResponsemanagementResponseassetsSearch", - "signature": "postResponsemanagementResponseassetsSearch(body, expand)", - "parameters": [ - { - "name": "body", - "type": "ResponseAssetSearchRequest", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ResponseAssetSearchResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ResponseAssetSearchRequest = new ResponseAssetSearchRequest(...) // request\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Search response assets\nPostResponsemanagementResponseassetsSearchRequest.postResponsemanagementResponseassetsSearch(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostResponsemanagementResponseassetsSearchRequest.postResponsemanagementResponseassetsSearch was successful\")\n dump(response)\n }\n}" - }, - "postresponsemanagementresponseassetsuploads": { - "operationId": "postresponsemanagementresponseassetsuploads", - "functionName": "postResponsemanagementResponseassetsUploads", - "signature": "postResponsemanagementResponseassetsUploads(body)", - "parameters": [ - { - "name": "body", - "type": "CreateResponseAssetRequest", - "required": "true" - } - ], - "return": "CreateResponseAssetResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateResponseAssetRequest = new CreateResponseAssetRequest(...) // request\n\n// Creates pre-signed url for uploading response asset\nPostResponsemanagementResponseassetsUploadsRequest.postResponsemanagementResponseassetsUploads(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostResponsemanagementResponseassetsUploadsRequest.postResponsemanagementResponseassetsUploads was successful\")\n dump(response)\n }\n}" - }, - "postresponsemanagementresponses": { - "operationId": "postresponsemanagementresponses", - "functionName": "postResponsemanagementResponses", - "signature": "postResponsemanagementResponses(body, expand)", - "parameters": [ - { - "name": "body", - "type": "ModelResponse", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "ModelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ModelResponse = new ModelResponse(...) // Response\nlet expand: PostResponsemanagementResponsesRequest.Expand_postResponsemanagementResponses = PostResponsemanagementResponsesRequest.Expand_postResponsemanagementResponses.enummember // Expand instructions for the return value.\n\n// Create a response.\nPostResponsemanagementResponsesRequest.postResponsemanagementResponses(body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostResponsemanagementResponsesRequest.postResponsemanagementResponses was successful\")\n dump(response)\n }\n}" - }, - "postresponsemanagementresponsesquery": { - "operationId": "postresponsemanagementresponsesquery", - "functionName": "postResponsemanagementResponsesQuery", - "signature": "postResponsemanagementResponsesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "ResponseQueryRequest", - "required": "true" - } - ], - "return": "ResponseQueryResults", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ResponseQueryRequest = new ResponseQueryRequest(...) // Response\n\n// Query responses\nPostResponsemanagementResponsesQueryRequest.postResponsemanagementResponsesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostResponsemanagementResponsesQueryRequest.postResponsemanagementResponsesQuery was successful\")\n dump(response)\n }\n}" - }, - "putresponsemanagementlibrary": { - "operationId": "putresponsemanagementlibrary", - "functionName": "putResponsemanagementLibrary", - "signature": "putResponsemanagementLibrary(libraryId, body)", - "parameters": [ - { - "name": "libraryId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Library", - "required": "true" - } - ], - "return": "Library", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet libraryId: String = \"\" // Library ID\nlet body: Library = new Library(...) // Library\n\n// Update an existing response library.\nPutResponsemanagementLibraryRequest.putResponsemanagementLibrary(libraryId: libraryId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutResponsemanagementLibraryRequest.putResponsemanagementLibrary was successful\")\n dump(response)\n }\n}" - }, - "putresponsemanagementresponse": { - "operationId": "putresponsemanagementresponse", - "functionName": "putResponsemanagementResponse", - "signature": "putResponsemanagementResponse(responseId, body, expand)", - "parameters": [ - { - "name": "responseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ModelResponse", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "ModelResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseId: String = \"\" // Response ID\nlet body: ModelResponse = new ModelResponse(...) // Response\nlet expand: PutResponsemanagementResponseRequest.Expand_putResponsemanagementResponse = PutResponsemanagementResponseRequest.Expand_putResponsemanagementResponse.enummember // Expand instructions for the return value.\n\n// Update an existing response.\nPutResponsemanagementResponseRequest.putResponsemanagementResponse(responseId: responseId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutResponsemanagementResponseRequest.putResponsemanagementResponse was successful\")\n dump(response)\n }\n}" - }, - "putresponsemanagementresponseasset": { - "operationId": "putresponsemanagementresponseasset", - "functionName": "putResponsemanagementResponseasset", - "signature": "putResponsemanagementResponseasset(responseAssetId, body)", - "parameters": [ - { - "name": "responseAssetId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ResponseAssetRequest", - "required": "true" - } - ], - "return": "ResponseAsset", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet responseAssetId: String = \"\" // Asset Id\nlet body: ResponseAssetRequest = new ResponseAssetRequest(...) // request\n\n// Update response asset\nPutResponsemanagementResponseassetRequest.putResponsemanagementResponseasset(responseAssetId: responseAssetId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutResponsemanagementResponseassetRequest.putResponsemanagementResponseasset was successful\")\n dump(response)\n }\n}" - }, - "deleteroutingassessment": { - "operationId": "deleteroutingassessment", - "functionName": "deleteRoutingAssessment", - "signature": "deleteRoutingAssessment(assessmentId)", - "parameters": [ - { - "name": "assessmentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assessmentId: String = \"\" // Benefit Assessment ID\n\n// Delete single benefit assessment.\nDeleteRoutingAssessmentRequest.deleteRoutingAssessment(assessmentId: assessmentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingAssessmentRequest.deleteRoutingAssessment was successful\")\n }\n}" - }, - "deleteroutingemaildomain": { - "operationId": "deleteroutingemaildomain", - "functionName": "deleteRoutingEmailDomain", - "signature": "deleteRoutingEmailDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Delete a domain\nDeleteRoutingEmailDomainRequest.deleteRoutingEmailDomain(domainId: domainId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingEmailDomainRequest.deleteRoutingEmailDomain was successful\")\n }\n}" - }, - "deleteroutingemaildomainroute": { - "operationId": "deleteroutingemaildomainroute", - "functionName": "deleteRoutingEmailDomainRoute", - "signature": "deleteRoutingEmailDomainRoute(domainName, routeId)", - "parameters": [ - { - "name": "domainName", - "type": "String", - "required": "true" - }, - { - "name": "routeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainName: String = \"\" // email domain\nlet routeId: String = \"\" // route ID\n\n// Delete a route\nDeleteRoutingEmailDomainRouteRequest.deleteRoutingEmailDomainRoute(domainName: domainName, routeId: routeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingEmailDomainRouteRequest.deleteRoutingEmailDomainRoute was successful\")\n }\n}" - }, - "deleteroutingemailoutbounddomain": { - "operationId": "deleteroutingemailoutbounddomain", - "functionName": "deleteRoutingEmailOutboundDomain", - "signature": "deleteRoutingEmailOutboundDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Delete an outbound domain\nDeleteRoutingEmailOutboundDomainRequest.deleteRoutingEmailOutboundDomain(domainId: domainId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingEmailOutboundDomainRequest.deleteRoutingEmailOutboundDomain was successful\")\n }\n}" - }, - "deleteroutinglanguage": { - "operationId": "deleteroutinglanguage", - "functionName": "deleteRoutingLanguage", - "signature": "deleteRoutingLanguage(languageId)", - "parameters": [ - { - "name": "languageId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet languageId: String = \"\" // Language ID\n\n// Delete a routing language\nDeleteRoutingLanguageRequest.deleteRoutingLanguage(languageId: languageId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingLanguageRequest.deleteRoutingLanguage was successful\")\n }\n}" - }, - "deleteroutingpredictor": { - "operationId": "deleteroutingpredictor", - "functionName": "deleteRoutingPredictor", - "signature": "deleteRoutingPredictor(predictorId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // Predictor ID\n\n// Delete single predictor.\nDeleteRoutingPredictorRequest.deleteRoutingPredictor(predictorId: predictorId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingPredictorRequest.deleteRoutingPredictor was successful\")\n }\n}" - }, - "deleteroutingqueue": { - "operationId": "deleteroutingqueue", - "functionName": "deleteRoutingQueue", - "signature": "deleteRoutingQueue(queueId, forceDelete)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "forceDelete", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet forceDelete: Bool = true // forceDelete\n\n// Delete a queue\nDeleteRoutingQueueRequest.deleteRoutingQueue(queueId: queueId, forceDelete: forceDelete) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingQueueRequest.deleteRoutingQueue was successful\")\n }\n}" - }, - "deleteroutingqueuemember": { - "operationId": "deleteroutingqueuemember", - "functionName": "deleteRoutingQueueMember", - "signature": "deleteRoutingQueueMember(queueId, memberId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet memberId: String = \"\" // Member ID\n\n// Delete a queue member.\nDeleteRoutingQueueMemberRequest.deleteRoutingQueueMember(queueId: queueId, memberId: memberId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingQueueMemberRequest.deleteRoutingQueueMember was successful\")\n }\n}" - }, - "deleteroutingqueueuser": { - "operationId": "deleteroutingqueueuser", - "functionName": "deleteRoutingQueueUser", - "signature": "deleteRoutingQueueUser(queueId, memberId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet memberId: String = \"\" // Member ID\n\n// DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.\nDeleteRoutingQueueUserRequest.deleteRoutingQueueUser(queueId: queueId, memberId: memberId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingQueueUserRequest.deleteRoutingQueueUser was successful\")\n }\n}" - }, - "deleteroutingqueuewrapupcode": { - "operationId": "deleteroutingqueuewrapupcode", - "functionName": "deleteRoutingQueueWrapupcode", - "signature": "deleteRoutingQueueWrapupcode(queueId, codeId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "codeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet codeId: String = \"\" // Code ID\n\n// Delete a wrap-up code from a queue\nDeleteRoutingQueueWrapupcodeRequest.deleteRoutingQueueWrapupcode(queueId: queueId, codeId: codeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingQueueWrapupcodeRequest.deleteRoutingQueueWrapupcode was successful\")\n }\n}" - }, - "deleteroutingsettings": { - "operationId": "deleteroutingsettings", - "functionName": "deleteRoutingSettings", - "signature": "deleteRoutingSettings()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete an organization's routing settings\nDeleteRoutingSettingsRequest.deleteRoutingSettings() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingSettingsRequest.deleteRoutingSettings was successful\")\n }\n}" - }, - "deleteroutingskill": { - "operationId": "deleteroutingskill", - "functionName": "deleteRoutingSkill", - "signature": "deleteRoutingSkill(skillId)", - "parameters": [ - { - "name": "skillId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillId: String = \"\" // Skill ID\n\n// Delete Routing Skill\nDeleteRoutingSkillRequest.deleteRoutingSkill(skillId: skillId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingSkillRequest.deleteRoutingSkill was successful\")\n }\n}" - }, - "deleteroutingskillgroup": { - "operationId": "deleteroutingskillgroup", - "functionName": "deleteRoutingSkillgroup", - "signature": "deleteRoutingSkillgroup(skillGroupId)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\n\n// Remove skill group definition\nDeleteRoutingSkillgroupRequest.deleteRoutingSkillgroup(skillGroupId: skillGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingSkillgroupRequest.deleteRoutingSkillgroup was successful\")\n }\n}" - }, - "deleteroutingsmsaddress": { - "operationId": "deleteroutingsmsaddress", - "functionName": "deleteRoutingSmsAddress", - "signature": "deleteRoutingSmsAddress(addressId)", - "parameters": [ - { - "name": "addressId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet addressId: String = \"\" // Address ID\n\n// Delete an Address by Id for SMS\nDeleteRoutingSmsAddressRequest.deleteRoutingSmsAddress(addressId: addressId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingSmsAddressRequest.deleteRoutingSmsAddress was successful\")\n }\n}" - }, - "deleteroutingsmsphonenumber": { - "operationId": "deleteroutingsmsphonenumber", - "functionName": "deleteRoutingSmsPhonenumber", - "signature": "deleteRoutingSmsPhonenumber(addressId)", - "parameters": [ - { - "name": "addressId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet addressId: String = \"\" // Address ID\n\n// Delete a phone number provisioned for SMS.\nDeleteRoutingSmsPhonenumberRequest.deleteRoutingSmsPhonenumber(addressId: addressId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingSmsPhonenumberRequest.deleteRoutingSmsPhonenumber was successful\")\n }\n}" - }, - "deleteroutinguserutilization": { - "operationId": "deleteroutinguserutilization", - "functionName": "deleteRoutingUserUtilization", - "signature": "deleteRoutingUserUtilization(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Delete the user's max utilization settings and revert to the organization-wide default.\nDeleteRoutingUserUtilizationRequest.deleteRoutingUserUtilization(userId: userId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingUserUtilizationRequest.deleteRoutingUserUtilization was successful\")\n }\n}" - }, - "deleteroutingutilization": { - "operationId": "deleteroutingutilization", - "functionName": "deleteRoutingUtilization", - "signature": "deleteRoutingUtilization()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete the organization-wide max utilization settings and revert to the system default.\nDeleteRoutingUtilizationRequest.deleteRoutingUtilization() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingUtilizationRequest.deleteRoutingUtilization was successful\")\n }\n}" - }, - "deleteroutingwrapupcode": { - "operationId": "deleteroutingwrapupcode", - "functionName": "deleteRoutingWrapupcode", - "signature": "deleteRoutingWrapupcode(codeId)", - "parameters": [ - { - "name": "codeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet codeId: String = \"\" // Wrapup Code ID\n\n// Delete wrap-up code\nDeleteRoutingWrapupcodeRequest.deleteRoutingWrapupcode(codeId: codeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteRoutingWrapupcodeRequest.deleteRoutingWrapupcode was successful\")\n }\n}" - }, - "deleteuserroutinglanguage": { - "operationId": "deleteuserroutinglanguage", - "functionName": "deleteUserRoutinglanguage", - "signature": "deleteUserRoutinglanguage(userId, languageId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "languageId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet languageId: String = \"\" // languageId\n\n// Remove routing language from user\nDeleteUserRoutinglanguageRequest.deleteUserRoutinglanguage(userId: userId, languageId: languageId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteUserRoutinglanguageRequest.deleteUserRoutinglanguage was successful\")\n }\n}" - }, - "deleteuserroutingskill": { - "operationId": "deleteuserroutingskill", - "functionName": "deleteUserRoutingskill", - "signature": "deleteUserRoutingskill(userId, skillId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "skillId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet skillId: String = \"\" // skillId\n\n// Remove routing skill from user\nDeleteUserRoutingskillRequest.deleteUserRoutingskill(userId: userId, skillId: skillId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteUserRoutingskillRequest.deleteUserRoutingskill was successful\")\n }\n}" - }, - "getroutingassessment": { - "operationId": "getroutingassessment", - "functionName": "getRoutingAssessment", - "signature": "getRoutingAssessment(assessmentId)", - "parameters": [ - { - "name": "assessmentId", - "type": "String", - "required": "true" - } - ], - "return": "BenefitAssessment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet assessmentId: String = \"\" // Benefit Assessment ID\n\n// Retrieve a single benefit assessment.\nGetRoutingAssessmentRequest.getRoutingAssessment(assessmentId: assessmentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingAssessmentRequest.getRoutingAssessment was successful\")\n dump(response)\n }\n}" - }, - "getroutingassessments": { - "operationId": "getroutingassessments", - "functionName": "getRoutingAssessments", - "signature": "getRoutingAssessments(before, after, limit, pageSize, queueId)", - "parameters": [ - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "queueId", - "type": "[String]", - "required": "false" - } - ], - "return": "AssessmentListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet queueId: [String] = [\"\"] // Queue ID(s) to filter assessments by.\n\n// Retrieve all benefit assessments.\nGetRoutingAssessmentsRequest.getRoutingAssessments(before: before, after: after, limit: limit, pageSize: pageSize, queueId: queueId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingAssessmentsRequest.getRoutingAssessments was successful\")\n dump(response)\n }\n}" - }, - "getroutingassessmentsjob": { - "operationId": "getroutingassessmentsjob", - "functionName": "getRoutingAssessmentsJob", - "signature": "getRoutingAssessmentsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "BenefitAssessmentJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // Benefit Assessment Job ID\n\n// Retrieve a single benefit assessments job.\nGetRoutingAssessmentsJobRequest.getRoutingAssessmentsJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingAssessmentsJobRequest.getRoutingAssessmentsJob was successful\")\n dump(response)\n }\n}" - }, - "getroutingassessmentsjobs": { - "operationId": "getroutingassessmentsjobs", - "functionName": "getRoutingAssessmentsJobs", - "signature": "getRoutingAssessmentsJobs(divisionId)", - "parameters": [ - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "AssessmentJobListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: [String] = [\"\"] // Division ID(s) to filter assessment jobs by.\n\n// Retrieve all benefit assessment jobs.\nGetRoutingAssessmentsJobsRequest.getRoutingAssessmentsJobs(divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingAssessmentsJobsRequest.getRoutingAssessmentsJobs was successful\")\n dump(response)\n }\n}" - }, - "getroutingavailablemediatypes": { - "operationId": "getroutingavailablemediatypes", - "functionName": "getRoutingAvailablemediatypes", - "signature": "getRoutingAvailablemediatypes()", - "return": "AvailableMediaTypeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get available media types\nGetRoutingAvailablemediatypesRequest.getRoutingAvailablemediatypes() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingAvailablemediatypesRequest.getRoutingAvailablemediatypes was successful\")\n dump(response)\n }\n}" - }, - "getroutingemaildomain": { - "operationId": "getroutingemaildomain", - "functionName": "getRoutingEmailDomain", - "signature": "getRoutingEmailDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "InboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Get domain\nGetRoutingEmailDomainRequest.getRoutingEmailDomain(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailDomainRequest.getRoutingEmailDomain was successful\")\n dump(response)\n }\n}" - }, - "getroutingemaildomainroute": { - "operationId": "getroutingemaildomainroute", - "functionName": "getRoutingEmailDomainRoute", - "signature": "getRoutingEmailDomainRoute(domainName, routeId)", - "parameters": [ - { - "name": "domainName", - "type": "String", - "required": "true" - }, - { - "name": "routeId", - "type": "String", - "required": "true" - } - ], - "return": "InboundRoute", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainName: String = \"\" // email domain\nlet routeId: String = \"\" // route ID\n\n// Get a route\nGetRoutingEmailDomainRouteRequest.getRoutingEmailDomainRoute(domainName: domainName, routeId: routeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailDomainRouteRequest.getRoutingEmailDomainRoute was successful\")\n dump(response)\n }\n}" - }, - "getroutingemaildomainroutes": { - "operationId": "getroutingemaildomainroutes", - "functionName": "getRoutingEmailDomainRoutes", - "signature": "getRoutingEmailDomainRoutes(domainName, pageSize, pageNumber, pattern)", - "parameters": [ - { - "name": "domainName", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pattern", - "type": "String", - "required": "false" - } - ], - "return": "InboundRouteEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainName: String = \"\" // email domain\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet pattern: String = \"\" // Filter routes by the route's pattern property\n\n// Get routes\nGetRoutingEmailDomainRoutesRequest.getRoutingEmailDomainRoutes(domainName: domainName, pageSize: pageSize, pageNumber: pageNumber, pattern: pattern) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailDomainRoutesRequest.getRoutingEmailDomainRoutes was successful\")\n dump(response)\n }\n}" - }, - "getroutingemaildomains": { - "operationId": "getroutingemaildomains", - "functionName": "getRoutingEmailDomains", - "signature": "getRoutingEmailDomains(pageSize, pageNumber, excludeStatus, filter)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "excludeStatus", - "type": "Bool", - "required": "false" - }, - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "InboundDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet excludeStatus: Bool = true // Exclude MX record data\nlet filter: String = \"\" // Optional search filter\n\n// Get domains\nGetRoutingEmailDomainsRequest.getRoutingEmailDomains(pageSize: pageSize, pageNumber: pageNumber, excludeStatus: excludeStatus, filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailDomainsRequest.getRoutingEmailDomains was successful\")\n dump(response)\n }\n}" - }, - "getroutingemailoutbounddomain": { - "operationId": "getroutingemailoutbounddomain", - "functionName": "getRoutingEmailOutboundDomain", - "signature": "getRoutingEmailOutboundDomain(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "OutboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Get domain\nGetRoutingEmailOutboundDomainRequest.getRoutingEmailOutboundDomain(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailOutboundDomainRequest.getRoutingEmailOutboundDomain was successful\")\n dump(response)\n }\n}" - }, - "getroutingemailoutbounddomainactivation": { - "operationId": "getroutingemailoutbounddomainactivation", - "functionName": "getRoutingEmailOutboundDomainActivation", - "signature": "getRoutingEmailOutboundDomainActivation(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "EmailOutboundDomainResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Get activation status (cname + dkim) of an outbound domain\nGetRoutingEmailOutboundDomainActivationRequest.getRoutingEmailOutboundDomainActivation(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailOutboundDomainActivationRequest.getRoutingEmailOutboundDomainActivation was successful\")\n dump(response)\n }\n}" - }, - "getroutingemailoutbounddomainsearch": { - "operationId": "getroutingemailoutbounddomainsearch", - "functionName": "getRoutingEmailOutboundDomainSearch", - "signature": "getRoutingEmailOutboundDomainSearch(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "OutboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Search a domain across organizations\nGetRoutingEmailOutboundDomainSearchRequest.getRoutingEmailOutboundDomainSearch(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailOutboundDomainSearchRequest.getRoutingEmailOutboundDomainSearch was successful\")\n dump(response)\n }\n}" - }, - "getroutingemailoutbounddomains": { - "operationId": "getroutingemailoutbounddomains", - "functionName": "getRoutingEmailOutboundDomains", - "signature": "getRoutingEmailOutboundDomains(filter)", - "parameters": [ - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "OutboundDomainEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filter: String = \"\" // Optional search filter\n\n// Get outbound domains\nGetRoutingEmailOutboundDomainsRequest.getRoutingEmailOutboundDomains(filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailOutboundDomainsRequest.getRoutingEmailOutboundDomains was successful\")\n dump(response)\n }\n}" - }, - "getroutingemailsetup": { - "operationId": "getroutingemailsetup", - "functionName": "getRoutingEmailSetup", - "signature": "getRoutingEmailSetup()", - "return": "EmailSetup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get email setup\nGetRoutingEmailSetupRequest.getRoutingEmailSetup() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingEmailSetupRequest.getRoutingEmailSetup was successful\")\n dump(response)\n }\n}" - }, - "getroutinglanguage": { - "operationId": "getroutinglanguage", - "functionName": "getRoutingLanguage", - "signature": "getRoutingLanguage(languageId)", - "parameters": [ - { - "name": "languageId", - "type": "String", - "required": "true" - } - ], - "return": "Language", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet languageId: String = \"\" // Language ID\n\n// Get a routing language\nGetRoutingLanguageRequest.getRoutingLanguage(languageId: languageId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingLanguageRequest.getRoutingLanguage was successful\")\n dump(response)\n }\n}" - }, - "getroutinglanguages": { - "operationId": "getroutinglanguages", - "functionName": "getRoutingLanguages", - "signature": "getRoutingLanguages(pageSize, pageNumber, sortOrder, name, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "LanguageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetRoutingLanguagesRequest.SortOrder_getRoutingLanguages = GetRoutingLanguagesRequest.SortOrder_getRoutingLanguages.enummember // Ascending or descending sort order\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // id\n\n// Get the list of supported languages.\nGetRoutingLanguagesRequest.getRoutingLanguages(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingLanguagesRequest.getRoutingLanguages was successful\")\n dump(response)\n }\n}" - }, - "getroutingmessagerecipient": { - "operationId": "getroutingmessagerecipient", - "functionName": "getRoutingMessageRecipient", - "signature": "getRoutingMessageRecipient(recipientId)", - "parameters": [ - { - "name": "recipientId", - "type": "String", - "required": "true" - } - ], - "return": "Recipient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recipientId: String = \"\" // Recipient ID\n\n// Get a recipient\nGetRoutingMessageRecipientRequest.getRoutingMessageRecipient(recipientId: recipientId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingMessageRecipientRequest.getRoutingMessageRecipient was successful\")\n dump(response)\n }\n}" - }, - "getroutingmessagerecipients": { - "operationId": "getroutingmessagerecipients", - "functionName": "getRoutingMessageRecipients", - "signature": "getRoutingMessageRecipients(messengerType, name, pageSize, pageNumber)", - "parameters": [ - { - "name": "messengerType", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "RecipientListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messengerType: GetRoutingMessageRecipientsRequest.MessengerType_getRoutingMessageRecipients = GetRoutingMessageRecipientsRequest.MessengerType_getRoutingMessageRecipients.enummember // Messenger Type\nlet name: String = \"\" // Recipient Name\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get recipients\nGetRoutingMessageRecipientsRequest.getRoutingMessageRecipients(messengerType: messengerType, name: name, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingMessageRecipientsRequest.getRoutingMessageRecipients was successful\")\n dump(response)\n }\n}" - }, - "getroutingpredictor": { - "operationId": "getroutingpredictor", - "functionName": "getRoutingPredictor", - "signature": "getRoutingPredictor(predictorId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - } - ], - "return": "Predictor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // Predictor ID\n\n// Retrieve a single predictor.\nGetRoutingPredictorRequest.getRoutingPredictor(predictorId: predictorId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingPredictorRequest.getRoutingPredictor was successful\")\n dump(response)\n }\n}" - }, - "getroutingpredictormodelfeatures": { - "operationId": "getroutingpredictormodelfeatures", - "functionName": "getRoutingPredictorModelFeatures", - "signature": "getRoutingPredictorModelFeatures(predictorId, modelId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - }, - { - "name": "modelId", - "type": "String", - "required": "true" - } - ], - "return": "PredictorModelFeatureListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // Predictor ID\nlet modelId: String = \"\" // Model ID\n\n// Retrieve Predictor Model Features.\nGetRoutingPredictorModelFeaturesRequest.getRoutingPredictorModelFeatures(predictorId: predictorId, modelId: modelId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingPredictorModelFeaturesRequest.getRoutingPredictorModelFeatures was successful\")\n dump(response)\n }\n}" - }, - "getroutingpredictormodels": { - "operationId": "getroutingpredictormodels", - "functionName": "getRoutingPredictorModels", - "signature": "getRoutingPredictorModels(predictorId)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - } - ], - "return": "PredictorModels", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // Predictor ID\n\n// Retrieve Predictor Models and Top Features.\nGetRoutingPredictorModelsRequest.getRoutingPredictorModels(predictorId: predictorId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingPredictorModelsRequest.getRoutingPredictorModels was successful\")\n dump(response)\n }\n}" - }, - "getroutingpredictors": { - "operationId": "getroutingpredictors", - "functionName": "getRoutingPredictors", - "signature": "getRoutingPredictors(before, after, limit, pageSize, queueId)", - "parameters": [ - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "limit", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "String", - "required": "false" - }, - { - "name": "queueId", - "type": "[String]", - "required": "false" - } - ], - "return": "PredictorListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet before: String = \"\" // The cursor that points to the start of the set of entities that has been returned.\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet limit: String = \"\" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 200.\nlet queueId: [String] = [\"\"] // Comma-separated list of queue Ids to filter by.\n\n// Retrieve all predictors.\nGetRoutingPredictorsRequest.getRoutingPredictors(before: before, after: after, limit: limit, pageSize: pageSize, queueId: queueId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingPredictorsRequest.getRoutingPredictors was successful\")\n dump(response)\n }\n}" - }, - "getroutingpredictorskeyperformanceindicators": { - "operationId": "getroutingpredictorskeyperformanceindicators", - "functionName": "getRoutingPredictorsKeyperformanceindicators", - "signature": "getRoutingPredictorsKeyperformanceindicators(kpiGroup, expand)", - "parameters": [ - { - "name": "kpiGroup", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "[KeyPerformanceIndicator]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet kpiGroup: GetRoutingPredictorsKeyperformanceindicatorsRequest.KpiGroup_getRoutingPredictorsKeyperformanceindicators = GetRoutingPredictorsKeyperformanceindicatorsRequest.KpiGroup_getRoutingPredictorsKeyperformanceindicators.enummember // The Group of Key Performance Indicators to return\nlet expand: [String] = [\"\"] // Parameter to request additional data to return in KPI payload\n\n// Get a list of Key Performance Indicators\nGetRoutingPredictorsKeyperformanceindicatorsRequest.getRoutingPredictorsKeyperformanceindicators(kpiGroup: kpiGroup, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingPredictorsKeyperformanceindicatorsRequest.getRoutingPredictorsKeyperformanceindicators was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueue": { - "operationId": "getroutingqueue", - "functionName": "getRoutingQueue", - "signature": "getRoutingQueue(queueId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - } - ], - "return": "Queue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\n\n// Get details about this queue.\nGetRoutingQueueRequest.getRoutingQueue(queueId: queueId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueRequest.getRoutingQueue was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuecomparisonperiod": { - "operationId": "getroutingqueuecomparisonperiod", - "functionName": "getRoutingQueueComparisonperiod", - "signature": "getRoutingQueueComparisonperiod(queueId, comparisonPeriodId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "comparisonPeriodId", - "type": "String", - "required": "true" - } - ], - "return": "ComparisonPeriod", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue id\nlet comparisonPeriodId: String = \"\" // ComparisonPeriod id\n\n// Get a Comparison Period.\nGetRoutingQueueComparisonperiodRequest.getRoutingQueueComparisonperiod(queueId: queueId, comparisonPeriodId: comparisonPeriodId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueComparisonperiodRequest.getRoutingQueueComparisonperiod was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuecomparisonperiods": { - "operationId": "getroutingqueuecomparisonperiods", - "functionName": "getRoutingQueueComparisonperiods", - "signature": "getRoutingQueueComparisonperiods(queueId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - } - ], - "return": "ComparisonPeriodListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue id\n\n// Get list of comparison periods\nGetRoutingQueueComparisonperiodsRequest.getRoutingQueueComparisonperiods(queueId: queueId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueComparisonperiodsRequest.getRoutingQueueComparisonperiods was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueueestimatedwaittime": { - "operationId": "getroutingqueueestimatedwaittime", - "functionName": "getRoutingQueueEstimatedwaittime", - "signature": "getRoutingQueueEstimatedwaittime(queueId, conversationId)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "conversationId", - "type": "String", - "required": "false" - } - ], - "return": "EstimatedWaitTimePredictions", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // queueId\nlet conversationId: String = \"\" // conversationId\n\n// Get Estimated Wait Time\nGetRoutingQueueEstimatedwaittimeRequest.getRoutingQueueEstimatedwaittime(queueId: queueId, conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueEstimatedwaittimeRequest.getRoutingQueueEstimatedwaittime was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuemediatypeestimatedwaittime": { - "operationId": "getroutingqueuemediatypeestimatedwaittime", - "functionName": "getRoutingQueueMediatypeEstimatedwaittime", - "signature": "getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "mediaType", - "type": "String", - "required": "true" - } - ], - "return": "EstimatedWaitTimePredictions", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // queueId\nlet mediaType: String = \"\" // mediaType\n\n// Get Estimated Wait Time\nGetRoutingQueueMediatypeEstimatedwaittimeRequest.getRoutingQueueMediatypeEstimatedwaittime(queueId: queueId, mediaType: mediaType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueMediatypeEstimatedwaittimeRequest.getRoutingQueueMediatypeEstimatedwaittime was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuemembers": { - "operationId": "getroutingqueuemembers", - "functionName": "getRoutingQueueMembers", - "signature": "getRoutingQueueMembers(queueId, pageNumber, pageSize, sortOrder, expand, name, profileSkills, skills, languages, routingStatus, presence, memberBy, joined)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "profileSkills", - "type": "[String]", - "required": "false" - }, - { - "name": "skills", - "type": "[String]", - "required": "false" - }, - { - "name": "languages", - "type": "[String]", - "required": "false" - }, - { - "name": "routingStatus", - "type": "[String]", - "required": "false" - }, - { - "name": "presence", - "type": "[String]", - "required": "false" - }, - { - "name": "memberBy", - "type": "String", - "required": "false" - }, - { - "name": "joined", - "type": "Bool", - "required": "false" - } - ], - "return": "QueueMemberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet pageNumber: Int = 0 // \nlet pageSize: Int = 0 // Max value is 100\nlet sortOrder: GetRoutingQueueMembersRequest.SortOrder_getRoutingQueueMembers = GetRoutingQueueMembersRequest.SortOrder_getRoutingQueueMembers.enummember // Note: results are sorted by name.\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet name: String = \"\" // Filter by queue member name (contains-style search)\nlet profileSkills: [String] = [\"\"] // Filter by profile skill (contains-style search)\nlet skills: [String] = [\"\"] // Filter by skill (contains-style search)\nlet languages: [String] = [\"\"] // Filter by language (contains-style search)\nlet routingStatus: [String] = [\"\"] // Filter by routing status\nlet presence: [String] = [\"\"] // Filter by presence\nlet memberBy: GetRoutingQueueMembersRequest.MemberBy_getRoutingQueueMembers = GetRoutingQueueMembersRequest.MemberBy_getRoutingQueueMembers.enummember // Filter by member type\nlet joined: Bool = true // Filter by joined status\n\n// Get the members of this queue.\nGetRoutingQueueMembersRequest.getRoutingQueueMembers(queueId: queueId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, expand: expand, name: name, profileSkills: profileSkills, skills: skills, languages: languages, routingStatus: routingStatus, presence: presence, memberBy: memberBy, joined: joined) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueMembersRequest.getRoutingQueueMembers was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueueusers": { - "operationId": "getroutingqueueusers", - "functionName": "getRoutingQueueUsers", - "signature": "getRoutingQueueUsers(queueId, pageNumber, pageSize, sortOrder, expand, joined, name, profileSkills, skills, languages, routingStatus, presence)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "joined", - "type": "Bool", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "profileSkills", - "type": "[String]", - "required": "false" - }, - { - "name": "skills", - "type": "[String]", - "required": "false" - }, - { - "name": "languages", - "type": "[String]", - "required": "false" - }, - { - "name": "routingStatus", - "type": "[String]", - "required": "false" - }, - { - "name": "presence", - "type": "[String]", - "required": "false" - } - ], - "return": "QueueMemberEntityListingV1", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet pageNumber: Int = 0 // \nlet pageSize: Int = 0 // Max value is 100\nlet sortOrder: GetRoutingQueueUsersRequest.SortOrder_getRoutingQueueUsers = GetRoutingQueueUsersRequest.SortOrder_getRoutingQueueUsers.enummember // Note: results are sorted by name.\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet joined: Bool = true // Filter by joined status\nlet name: String = \"\" // Filter by queue member name\nlet profileSkills: [String] = [\"\"] // Filter by profile skill\nlet skills: [String] = [\"\"] // Filter by skill\nlet languages: [String] = [\"\"] // Filter by language\nlet routingStatus: [String] = [\"\"] // Filter by routing status\nlet presence: [String] = [\"\"] // Filter by presence\n\n// DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.\nGetRoutingQueueUsersRequest.getRoutingQueueUsers(queueId: queueId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, expand: expand, joined: joined, name: name, profileSkills: profileSkills, skills: skills, languages: languages, routingStatus: routingStatus, presence: presence) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueUsersRequest.getRoutingQueueUsers was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuewrapupcodes": { - "operationId": "getroutingqueuewrapupcodes", - "functionName": "getRoutingQueueWrapupcodes", - "signature": "getRoutingQueueWrapupcodes(queueId, pageSize, pageNumber)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "WrapupCodeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get the wrap-up codes for a queue\nGetRoutingQueueWrapupcodesRequest.getRoutingQueueWrapupcodes(queueId: queueId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueueWrapupcodesRequest.getRoutingQueueWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueues": { - "operationId": "getroutingqueues", - "functionName": "getRoutingQueues", - "signature": "getRoutingQueues(pageNumber, pageSize, sortOrder, name, _id, divisionId, peerId, hasPeer)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - }, - { - "name": "peerId", - "type": "[String]", - "required": "false" - }, - { - "name": "hasPeer", - "type": "Bool", - "required": "false" - } - ], - "return": "QueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortOrder: GetRoutingQueuesRequest.SortOrder_getRoutingQueues = GetRoutingQueuesRequest.SortOrder_getRoutingQueues.enummember // Note: results are sorted by name.\nlet name: String = \"\" // Filter by queue name\nlet _id: [String] = [\"\"] // Filter by queue ID(s)\nlet divisionId: [String] = [\"\"] // Filter by queue division ID(s)\nlet peerId: [String] = [\"\"] // Filter by queue peer ID(s)\nlet hasPeer: Bool = true // Filter by queues associated with peer\n\n// Get list of queues.\nGetRoutingQueuesRequest.getRoutingQueues(pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId, peerId: peerId, hasPeer: hasPeer) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueuesRequest.getRoutingQueues was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuesdivisionviews": { - "operationId": "getroutingqueuesdivisionviews", - "functionName": "getRoutingQueuesDivisionviews", - "signature": "getRoutingQueuesDivisionviews(pageSize, pageNumber, sortBy, sortOrder, name, _id, divisionId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "QueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size [max value is 100]\nlet pageNumber: Int = 0 // Page number [max value is 5]\nlet sortBy: GetRoutingQueuesDivisionviewsRequest.SortBy_getRoutingQueuesDivisionviews = GetRoutingQueuesDivisionviewsRequest.SortBy_getRoutingQueuesDivisionviews.enummember // Sort by\nlet sortOrder: GetRoutingQueuesDivisionviewsRequest.SortOrder_getRoutingQueuesDivisionviews = GetRoutingQueuesDivisionviewsRequest.SortOrder_getRoutingQueuesDivisionviews.enummember // Sort order\nlet name: String = \"\" // Name\nlet _id: [String] = [\"\"] // Queue ID(s)\nlet divisionId: [String] = [\"\"] // Division ID(s)\n\n// Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).\nGetRoutingQueuesDivisionviewsRequest.getRoutingQueuesDivisionviews(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueuesDivisionviewsRequest.getRoutingQueuesDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuesdivisionviewsall": { - "operationId": "getroutingqueuesdivisionviewsall", - "functionName": "getRoutingQueuesDivisionviewsAll", - "signature": "getRoutingQueuesDivisionviewsAll(pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "QueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size [max value is 500]\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetRoutingQueuesDivisionviewsAllRequest.SortOrder_getRoutingQueuesDivisionviewsAll = GetRoutingQueuesDivisionviewsAllRequest.SortOrder_getRoutingQueuesDivisionviewsAll.enummember // Sort order\n\n// Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.\nGetRoutingQueuesDivisionviewsAllRequest.getRoutingQueuesDivisionviewsAll(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueuesDivisionviewsAllRequest.getRoutingQueuesDivisionviewsAll was successful\")\n dump(response)\n }\n}" - }, - "getroutingqueuesme": { - "operationId": "getroutingqueuesme", - "functionName": "getRoutingQueuesMe", - "signature": "getRoutingQueuesMe(pageNumber, pageSize, joined, sortOrder)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "joined", - "type": "Bool", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "UserQueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet joined: Bool = true // Filter by joined status.\nlet sortOrder: GetRoutingQueuesMeRequest.SortOrder_getRoutingQueuesMe = GetRoutingQueuesMeRequest.SortOrder_getRoutingQueuesMe.enummember // Note: results are sorted by name.\n\n// Get a paged listing of queues the user is a member of.\nGetRoutingQueuesMeRequest.getRoutingQueuesMe(pageNumber: pageNumber, pageSize: pageSize, joined: joined, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingQueuesMeRequest.getRoutingQueuesMe was successful\")\n dump(response)\n }\n}" - }, - "getroutingsettings": { - "operationId": "getroutingsettings", - "functionName": "getRoutingSettings", - "signature": "getRoutingSettings()", - "return": "RoutingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get an organization's routing settings\nGetRoutingSettingsRequest.getRoutingSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSettingsRequest.getRoutingSettings was successful\")\n dump(response)\n }\n}" - }, - "getroutingsettingscontactcenter": { - "operationId": "getroutingsettingscontactcenter", - "functionName": "getRoutingSettingsContactcenter", - "signature": "getRoutingSettingsContactcenter()", - "return": "ContactCenterSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Contact Center Settings\nGetRoutingSettingsContactcenterRequest.getRoutingSettingsContactcenter() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSettingsContactcenterRequest.getRoutingSettingsContactcenter was successful\")\n dump(response)\n }\n}" - }, - "getroutingsettingstranscription": { - "operationId": "getroutingsettingstranscription", - "functionName": "getRoutingSettingsTranscription", - "signature": "getRoutingSettingsTranscription()", - "return": "TranscriptionSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Transcription Settings\nGetRoutingSettingsTranscriptionRequest.getRoutingSettingsTranscription() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSettingsTranscriptionRequest.getRoutingSettingsTranscription was successful\")\n dump(response)\n }\n}" - }, - "getroutingskill": { - "operationId": "getroutingskill", - "functionName": "getRoutingSkill", - "signature": "getRoutingSkill(skillId)", - "parameters": [ - { - "name": "skillId", - "type": "String", - "required": "true" - } - ], - "return": "RoutingSkill", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillId: String = \"\" // Skill ID\n\n// Get Routing Skill\nGetRoutingSkillRequest.getRoutingSkill(skillId: skillId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillRequest.getRoutingSkill was successful\")\n dump(response)\n }\n}" - }, - "getroutingskillgroup": { - "operationId": "getroutingskillgroup", - "functionName": "getRoutingSkillgroup", - "signature": "getRoutingSkillgroup(skillGroupId)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - } - ], - "return": "SkillGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\n\n// Get skill group\nGetRoutingSkillgroupRequest.getRoutingSkillgroup(skillGroupId: skillGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillgroupRequest.getRoutingSkillgroup was successful\")\n dump(response)\n }\n}" - }, - "getroutingskillgroupmembers": { - "operationId": "getroutingskillgroupmembers", - "functionName": "getRoutingSkillgroupMembers", - "signature": "getRoutingSkillgroupMembers(skillGroupId, pageSize, after, before, expand)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "SkillGroupMemberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\nlet pageSize: Int = 0 // Page size\nlet after: String = \"\" // The cursor that points to the next item\nlet before: String = \"\" // The cursor that points to the previous item\nlet expand: GetRoutingSkillgroupMembersRequest.Expand_getRoutingSkillgroupMembers = GetRoutingSkillgroupMembersRequest.Expand_getRoutingSkillgroupMembers.enummember // Expand the name on each user\n\n// Get skill group members\nGetRoutingSkillgroupMembersRequest.getRoutingSkillgroupMembers(skillGroupId: skillGroupId, pageSize: pageSize, after: after, before: before, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillgroupMembersRequest.getRoutingSkillgroupMembers was successful\")\n dump(response)\n }\n}" - }, - "getroutingskillgroupmembersdivisions": { - "operationId": "getroutingskillgroupmembersdivisions", - "functionName": "getRoutingSkillgroupMembersDivisions", - "signature": "getRoutingSkillgroupMembersDivisions(skillGroupId, expand)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "SkillGroupMemberDivisionList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\nlet expand: GetRoutingSkillgroupMembersDivisionsRequest.Expand_getRoutingSkillgroupMembersDivisions = GetRoutingSkillgroupMembersDivisionsRequest.Expand_getRoutingSkillgroupMembersDivisions.enummember // Expand the name on each user\n\n// Get list of member divisions for this skill group.\nGetRoutingSkillgroupMembersDivisionsRequest.getRoutingSkillgroupMembersDivisions(skillGroupId: skillGroupId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillgroupMembersDivisionsRequest.getRoutingSkillgroupMembersDivisions was successful\")\n dump(response)\n }\n}" - }, - "getroutingskillgroups": { - "operationId": "getroutingskillgroups", - "functionName": "getRoutingSkillgroups", - "signature": "getRoutingSkillgroups(pageSize, name, after, before)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - } - ], - "return": "SkillGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet name: String = \"\" // Return only skill group names whose names start with this value (case-insensitive matching)\nlet after: String = \"\" // The cursor that points to the next item\nlet before: String = \"\" // The cursor that points to the previous item\n\n// Get skill group listing\nGetRoutingSkillgroupsRequest.getRoutingSkillgroups(pageSize: pageSize, name: name, after: after, before: before) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillgroupsRequest.getRoutingSkillgroups was successful\")\n dump(response)\n }\n}" - }, - "getroutingskills": { - "operationId": "getroutingskills", - "functionName": "getRoutingSkills", - "signature": "getRoutingSkills(pageSize, pageNumber, name, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "SkillEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Filter for results that start with this value\nlet _id: [String] = [\"\"] // id\n\n// Get the list of routing skills.\nGetRoutingSkillsRequest.getRoutingSkills(pageSize: pageSize, pageNumber: pageNumber, name: name, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSkillsRequest.getRoutingSkills was successful\")\n dump(response)\n }\n}" - }, - "getroutingsmsaddress": { - "operationId": "getroutingsmsaddress", - "functionName": "getRoutingSmsAddress", - "signature": "getRoutingSmsAddress(addressId)", - "parameters": [ - { - "name": "addressId", - "type": "String", - "required": "true" - } - ], - "return": "SmsAddress", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet addressId: String = \"\" // Address ID\n\n// Get an Address by Id for SMS\nGetRoutingSmsAddressRequest.getRoutingSmsAddress(addressId: addressId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSmsAddressRequest.getRoutingSmsAddress was successful\")\n dump(response)\n }\n}" - }, - "getroutingsmsaddresses": { - "operationId": "getroutingsmsaddresses", - "functionName": "getRoutingSmsAddresses", - "signature": "getRoutingSmsAddresses(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "SmsAddressEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of Addresses for SMS\nGetRoutingSmsAddressesRequest.getRoutingSmsAddresses(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSmsAddressesRequest.getRoutingSmsAddresses was successful\")\n dump(response)\n }\n}" - }, - "getroutingsmsavailablephonenumbers": { - "operationId": "getroutingsmsavailablephonenumbers", - "functionName": "getRoutingSmsAvailablephonenumbers", - "signature": "getRoutingSmsAvailablephonenumbers(countryCode, phoneNumberType, region, city, areaCode, pattern, addressRequirement)", - "parameters": [ - { - "name": "countryCode", - "type": "String", - "required": "true" - }, - { - "name": "phoneNumberType", - "type": "String", - "required": "true" - }, - { - "name": "region", - "type": "String", - "required": "false" - }, - { - "name": "city", - "type": "String", - "required": "false" - }, - { - "name": "areaCode", - "type": "String", - "required": "false" - }, - { - "name": "pattern", - "type": "String", - "required": "false" - }, - { - "name": "addressRequirement", - "type": "String", - "required": "false" - } - ], - "return": "SMSAvailablePhoneNumberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet countryCode: String = \"\" // The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned\nlet phoneNumberType: GetRoutingSmsAvailablephonenumbersRequest.PhoneNumberType_getRoutingSmsAvailablephonenumbers = GetRoutingSmsAvailablephonenumbersRequest.PhoneNumberType_getRoutingSmsAvailablephonenumbers.enummember // Type of available phone numbers searched\nlet region: String = \"\" // Region/province/state that can be used to restrict the numbers returned\nlet city: String = \"\" // City that can be used to restrict the numbers returned\nlet areaCode: String = \"\" // Area code that can be used to restrict the numbers returned\nlet pattern: String = \"\" // A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.\nlet addressRequirement: GetRoutingSmsAvailablephonenumbersRequest.AddressRequirement_getRoutingSmsAvailablephonenumbers = GetRoutingSmsAvailablephonenumbersRequest.AddressRequirement_getRoutingSmsAvailablephonenumbers.enummember // This indicates whether the phone number requires to have an Address registered.\n\n// Get a list of available phone numbers for SMS provisioning.\nGetRoutingSmsAvailablephonenumbersRequest.getRoutingSmsAvailablephonenumbers(countryCode: countryCode, phoneNumberType: phoneNumberType, region: region, city: city, areaCode: areaCode, pattern: pattern, addressRequirement: addressRequirement) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSmsAvailablephonenumbersRequest.getRoutingSmsAvailablephonenumbers was successful\")\n dump(response)\n }\n}" - }, - "getroutingsmsphonenumber": { - "operationId": "getroutingsmsphonenumber", - "functionName": "getRoutingSmsPhonenumber", - "signature": "getRoutingSmsPhonenumber(addressId, expand)", - "parameters": [ - { - "name": "addressId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "SmsPhoneNumber", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet addressId: String = \"\" // Address ID\nlet expand: GetRoutingSmsPhonenumberRequest.Expand_getRoutingSmsPhonenumber = GetRoutingSmsPhonenumberRequest.Expand_getRoutingSmsPhonenumber.enummember // Expand response with additional information\n\n// Get a phone number provisioned for SMS.\nGetRoutingSmsPhonenumberRequest.getRoutingSmsPhonenumber(addressId: addressId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSmsPhonenumberRequest.getRoutingSmsPhonenumber was successful\")\n dump(response)\n }\n}" - }, - "getroutingsmsphonenumbers": { - "operationId": "getroutingsmsphonenumbers", - "functionName": "getRoutingSmsPhonenumbers", - "signature": "getRoutingSmsPhonenumbers(phoneNumber, phoneNumberType, phoneNumberStatus, countryCode, pageSize, pageNumber, sortBy, sortOrder, language, integrationId)", - "parameters": [ - { - "name": "phoneNumber", - "type": "String", - "required": "false" - }, - { - "name": "phoneNumberType", - "type": "[String]", - "required": "false" - }, - { - "name": "phoneNumberStatus", - "type": "[String]", - "required": "false" - }, - { - "name": "countryCode", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "language", - "type": "String", - "required": "false" - }, - { - "name": "integrationId", - "type": "String", - "required": "false" - } - ], - "return": "SmsPhoneNumberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneNumber: String = \"\" // 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.\nlet phoneNumberType: [String] = [\"\"] // Filter on phone number type\nlet phoneNumberStatus: [String] = [\"\"] // Filter on phone number status\nlet countryCode: [String] = [\"\"] // Filter on country code\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: GetRoutingSmsPhonenumbersRequest.SortBy_getRoutingSmsPhonenumbers = GetRoutingSmsPhonenumbersRequest.SortBy_getRoutingSmsPhonenumbers.enummember // Optional field to sort results\nlet sortOrder: GetRoutingSmsPhonenumbersRequest.SortOrder_getRoutingSmsPhonenumbers = GetRoutingSmsPhonenumbersRequest.SortOrder_getRoutingSmsPhonenumbers.enummember // Sort order\nlet language: String = en-US // A language tag (which is sometimes referred to as a \\\"locale identifier\\\") to use to localize country field and sort operations\nlet integrationId: String = \"\" // Filter on the Genesys Cloud integration id to which the phone number belongs to\n\n// Get a list of provisioned phone numbers.\nGetRoutingSmsPhonenumbersRequest.getRoutingSmsPhonenumbers(phoneNumber: phoneNumber, phoneNumberType: phoneNumberType, phoneNumberStatus: phoneNumberStatus, countryCode: countryCode, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, language: language, integrationId: integrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingSmsPhonenumbersRequest.getRoutingSmsPhonenumbers was successful\")\n dump(response)\n }\n}" - }, - "getroutinguserutilization": { - "operationId": "getroutinguserutilization", - "functionName": "getRoutingUserUtilization", - "signature": "getRoutingUserUtilization(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "AgentMaxUtilization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get the user's max utilization settings. If not configured, the organization-wide default is returned.\nGetRoutingUserUtilizationRequest.getRoutingUserUtilization(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingUserUtilizationRequest.getRoutingUserUtilization was successful\")\n dump(response)\n }\n}" - }, - "getroutingutilization": { - "operationId": "getroutingutilization", - "functionName": "getRoutingUtilization", - "signature": "getRoutingUtilization()", - "return": "Utilization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the organization-wide max utilization settings.\nGetRoutingUtilizationRequest.getRoutingUtilization() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingUtilizationRequest.getRoutingUtilization was successful\")\n dump(response)\n }\n}" - }, - "getroutingwrapupcode": { - "operationId": "getroutingwrapupcode", - "functionName": "getRoutingWrapupcode", - "signature": "getRoutingWrapupcode(codeId)", - "parameters": [ - { - "name": "codeId", - "type": "String", - "required": "true" - } - ], - "return": "WrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet codeId: String = \"\" // Wrapup Code ID\n\n// Get details about this wrap-up code.\nGetRoutingWrapupcodeRequest.getRoutingWrapupcode(codeId: codeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingWrapupcodeRequest.getRoutingWrapupcode was successful\")\n dump(response)\n }\n}" - }, - "getroutingwrapupcodes": { - "operationId": "getroutingwrapupcodes", - "functionName": "getRoutingWrapupcodes", - "signature": "getRoutingWrapupcodes(pageSize, pageNumber, sortBy, sortOrder, name, _id, divisionId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "WrapupCodeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: GetRoutingWrapupcodesRequest.SortBy_getRoutingWrapupcodes = GetRoutingWrapupcodesRequest.SortBy_getRoutingWrapupcodes.enummember // Sort by\nlet sortOrder: GetRoutingWrapupcodesRequest.SortOrder_getRoutingWrapupcodes = GetRoutingWrapupcodesRequest.SortOrder_getRoutingWrapupcodes.enummember // Sort order\nlet name: String = \"\" // Wrapup code's name ('Sort by' param is ignored unless this field is provided)\nlet _id: [String] = [\"\"] // Filter by wrapup code ID(s)\nlet divisionId: [String] = [\"\"] // Filter by division ID(s)\n\n// Get list of wrapup codes.\nGetRoutingWrapupcodesRequest.getRoutingWrapupcodes(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetRoutingWrapupcodesRequest.getRoutingWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "getuserqueues": { - "operationId": "getuserqueues", - "functionName": "getUserQueues", - "signature": "getUserQueues(userId, pageSize, pageNumber, joined, divisionId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "joined", - "type": "Bool", - "required": "false" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "UserQueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet joined: Bool = true // Is joined to the queue\nlet divisionId: [String] = [\"\"] // Division ID(s)\n\n// Get queues for user\nGetUserQueuesRequest.getUserQueues(userId: userId, pageSize: pageSize, pageNumber: pageNumber, joined: joined, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserQueuesRequest.getUserQueues was successful\")\n dump(response)\n }\n}" - }, - "getuserroutinglanguages": { - "operationId": "getuserroutinglanguages", - "functionName": "getUserRoutinglanguages", - "signature": "getUserRoutinglanguages(userId, pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "UserLanguageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetUserRoutinglanguagesRequest.SortOrder_getUserRoutinglanguages = GetUserRoutinglanguagesRequest.SortOrder_getUserRoutinglanguages.enummember // Ascending or descending sort order\n\n// List routing language for user\nGetUserRoutinglanguagesRequest.getUserRoutinglanguages(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserRoutinglanguagesRequest.getUserRoutinglanguages was successful\")\n dump(response)\n }\n}" - }, - "getuserroutingskills": { - "operationId": "getuserroutingskills", - "functionName": "getUserRoutingskills", - "signature": "getUserRoutingskills(userId, pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "UserSkillEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetUserRoutingskillsRequest.SortOrder_getUserRoutingskills = GetUserRoutingskillsRequest.SortOrder_getUserRoutingskills.enummember // Ascending or descending sort order\n\n// List routing skills for user\nGetUserRoutingskillsRequest.getUserRoutingskills(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserRoutingskillsRequest.getUserRoutingskills was successful\")\n dump(response)\n }\n}" - }, - "getuserskillgroups": { - "operationId": "getuserskillgroups", - "functionName": "getUserSkillgroups", - "signature": "getUserSkillgroups(userId, pageSize, after, before)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - } - ], - "return": "UserSkillGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet after: String = \"\" // The cursor that points to the next page\nlet before: String = \"\" // The cursor that points to the previous page\n\n// Get skill groups for a user\nGetUserSkillgroupsRequest.getUserSkillgroups(userId: userId, pageSize: pageSize, after: after, before: before) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserSkillgroupsRequest.getUserSkillgroups was successful\")\n dump(response)\n }\n}" - }, - "patchroutingconversation": { - "operationId": "patchroutingconversation", - "functionName": "patchRoutingConversation", - "signature": "patchRoutingConversation(conversationId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoutingConversationAttributesRequest", - "required": "true" - } - ], - "return": "RoutingConversationAttributesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet body: RoutingConversationAttributesRequest = new RoutingConversationAttributesRequest(...) // Conversation Attributes\n\n// Update attributes of an in-queue conversation\nPatchRoutingConversationRequest.patchRoutingConversation(conversationId: conversationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingConversationRequest.patchRoutingConversation was successful\")\n dump(response)\n }\n}" - }, - "patchroutingemaildomain": { - "operationId": "patchroutingemaildomain", - "functionName": "patchRoutingEmailDomain", - "signature": "patchRoutingEmailDomain(domainId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InboundDomainPatchRequest", - "required": "true" - } - ], - "return": "InboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\nlet body: InboundDomainPatchRequest = new InboundDomainPatchRequest(...) // Domain settings\n\n// Update domain settings\nPatchRoutingEmailDomainRequest.patchRoutingEmailDomain(domainId: domainId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingEmailDomainRequest.patchRoutingEmailDomain was successful\")\n dump(response)\n }\n}" - }, - "patchroutingemaildomainvalidate": { - "operationId": "patchroutingemaildomainvalidate", - "functionName": "patchRoutingEmailDomainValidate", - "signature": "patchRoutingEmailDomainValidate(domainId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InboundDomainPatchRequest", - "required": "true" - } - ], - "return": "InboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\nlet body: InboundDomainPatchRequest = new InboundDomainPatchRequest(...) // Domain settings\n\n// Validate domain settings\nPatchRoutingEmailDomainValidateRequest.patchRoutingEmailDomainValidate(domainId: domainId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingEmailDomainValidateRequest.patchRoutingEmailDomainValidate was successful\")\n dump(response)\n }\n}" - }, - "patchroutingpredictor": { - "operationId": "patchroutingpredictor", - "functionName": "patchRoutingPredictor", - "signature": "patchRoutingPredictor(predictorId, body)", - "parameters": [ - { - "name": "predictorId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchPredictorRequest", - "required": "false" - } - ], - "return": "Predictor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet predictorId: String = \"\" // Predictor ID\nlet body: PatchPredictorRequest = new PatchPredictorRequest(...) // \n\n// Update single predictor.\nPatchRoutingPredictorRequest.patchRoutingPredictor(predictorId: predictorId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingPredictorRequest.patchRoutingPredictor was successful\")\n dump(response)\n }\n}" - }, - "patchroutingqueuemember": { - "operationId": "patchroutingqueuemember", - "functionName": "patchRoutingQueueMember", - "signature": "patchRoutingQueueMember(queueId, memberId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueueMember", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet memberId: String = \"\" // Member ID\nlet body: QueueMember = new QueueMember(...) // Queue Member\n\n// Update the ring number OR joined status for a queue member.\nPatchRoutingQueueMemberRequest.patchRoutingQueueMember(queueId: queueId, memberId: memberId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchRoutingQueueMemberRequest.patchRoutingQueueMember was successful\")\n }\n}" - }, - "patchroutingqueuemembers": { - "operationId": "patchroutingqueuemembers", - "functionName": "patchRoutingQueueMembers", - "signature": "patchRoutingQueueMembers(queueId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[QueueMember]", - "required": "true" - } - ], - "return": "QueueMemberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: [QueueMember] = [new QueueMember(...)] // Queue Members\n\n// Join or unjoin a set of users for a queue\nPatchRoutingQueueMembersRequest.patchRoutingQueueMembers(queueId: queueId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingQueueMembersRequest.patchRoutingQueueMembers was successful\")\n dump(response)\n }\n}" - }, - "patchroutingqueueuser": { - "operationId": "patchroutingqueueuser", - "functionName": "patchRoutingQueueUser", - "signature": "patchRoutingQueueUser(queueId, memberId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueueMember", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet memberId: String = \"\" // Member ID\nlet body: QueueMember = new QueueMember(...) // Queue Member\n\n// DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.\nPatchRoutingQueueUserRequest.patchRoutingQueueUser(queueId: queueId, memberId: memberId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchRoutingQueueUserRequest.patchRoutingQueueUser was successful\")\n }\n}" - }, - "patchroutingqueueusers": { - "operationId": "patchroutingqueueusers", - "functionName": "patchRoutingQueueUsers", - "signature": "patchRoutingQueueUsers(queueId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[QueueMember]", - "required": "true" - } - ], - "return": "QueueMemberEntityListingV1", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: [QueueMember] = [new QueueMember(...)] // Queue Members\n\n// DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.\nPatchRoutingQueueUsersRequest.patchRoutingQueueUsers(queueId: queueId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingQueueUsersRequest.patchRoutingQueueUsers was successful\")\n dump(response)\n }\n}" - }, - "patchroutingsettingscontactcenter": { - "operationId": "patchroutingsettingscontactcenter", - "functionName": "patchRoutingSettingsContactcenter", - "signature": "patchRoutingSettingsContactcenter(body)", - "parameters": [ - { - "name": "body", - "type": "ContactCenterSettings", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactCenterSettings = new ContactCenterSettings(...) // Contact Center Settings\n\n// Update Contact Center Settings\nPatchRoutingSettingsContactcenterRequest.patchRoutingSettingsContactcenter(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchRoutingSettingsContactcenterRequest.patchRoutingSettingsContactcenter was successful\")\n }\n}" - }, - "patchroutingskillgroup": { - "operationId": "patchroutingskillgroup", - "functionName": "patchRoutingSkillgroup", - "signature": "patchRoutingSkillgroup(skillGroupId, body)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SkillGroup", - "required": "true" - } - ], - "return": "SkillGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\nlet body: SkillGroup = new SkillGroup(...) // Update skill groups\n\n// Update skill group definition\nPatchRoutingSkillgroupRequest.patchRoutingSkillgroup(skillGroupId: skillGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchRoutingSkillgroupRequest.patchRoutingSkillgroup was successful\")\n dump(response)\n }\n}" - }, - "patchuserqueue": { - "operationId": "patchuserqueue", - "functionName": "patchUserQueue", - "signature": "patchUserQueue(queueId, userId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserQueue", - "required": "true" - } - ], - "return": "UserQueue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet userId: String = \"\" // User ID\nlet body: UserQueue = new UserQueue(...) // Queue Member\n\n// Join or unjoin a queue for a user\nPatchUserQueueRequest.patchUserQueue(queueId: queueId, userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserQueueRequest.patchUserQueue was successful\")\n dump(response)\n }\n}" - }, - "patchuserqueues": { - "operationId": "patchuserqueues", - "functionName": "patchUserQueues", - "signature": "patchUserQueues(userId, body, divisionId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[UserQueue]", - "required": "true" - }, - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "UserQueueEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: [UserQueue] = [new UserQueue(...)] // User Queues\nlet divisionId: [String] = [\"\"] // Division ID(s)\n\n// Join or unjoin a set of queues for a user\nPatchUserQueuesRequest.patchUserQueues(userId: userId, body: body, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserQueuesRequest.patchUserQueues was successful\")\n dump(response)\n }\n}" - }, - "patchuserroutinglanguage": { - "operationId": "patchuserroutinglanguage", - "functionName": "patchUserRoutinglanguage", - "signature": "patchUserRoutinglanguage(userId, languageId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "languageId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserRoutingLanguage", - "required": "true" - } - ], - "return": "UserRoutingLanguage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet languageId: String = \"\" // languageId\nlet body: UserRoutingLanguage = new UserRoutingLanguage(...) // Language\n\n// Update routing language proficiency or state.\nPatchUserRoutinglanguageRequest.patchUserRoutinglanguage(userId: userId, languageId: languageId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserRoutinglanguageRequest.patchUserRoutinglanguage was successful\")\n dump(response)\n }\n}" - }, - "patchuserroutinglanguagesbulk": { - "operationId": "patchuserroutinglanguagesbulk", - "functionName": "patchUserRoutinglanguagesBulk", - "signature": "patchUserRoutinglanguagesBulk(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[UserRoutingLanguagePost]", - "required": "true" - } - ], - "return": "UserLanguageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: [UserRoutingLanguagePost] = [new UserRoutingLanguagePost(...)] // Language\n\n// Add bulk routing language to user. Max limit 50 languages\nPatchUserRoutinglanguagesBulkRequest.patchUserRoutinglanguagesBulk(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserRoutinglanguagesBulkRequest.patchUserRoutinglanguagesBulk was successful\")\n dump(response)\n }\n}" - }, - "patchuserroutingskillsbulk": { - "operationId": "patchuserroutingskillsbulk", - "functionName": "patchUserRoutingskillsBulk", - "signature": "patchUserRoutingskillsBulk(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[UserRoutingSkillPost]", - "required": "true" - } - ], - "return": "UserSkillEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: [UserRoutingSkillPost] = [new UserRoutingSkillPost(...)] // Skill\n\n// Bulk add routing skills to user\nPatchUserRoutingskillsBulkRequest.patchUserRoutingskillsBulk(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserRoutingskillsBulkRequest.patchUserRoutingskillsBulk was successful\")\n dump(response)\n }\n}" - }, - "postroutingassessments": { - "operationId": "postroutingassessments", - "functionName": "postRoutingAssessments", - "signature": "postRoutingAssessments(body)", - "parameters": [ - { - "name": "body", - "type": "CreateBenefitAssessmentRequest", - "required": "false" - } - ], - "return": "BenefitAssessment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateBenefitAssessmentRequest = new CreateBenefitAssessmentRequest(...) // \n\n// Create a benefit assessment.\nPostRoutingAssessmentsRequest.postRoutingAssessments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingAssessmentsRequest.postRoutingAssessments was successful\")\n dump(response)\n }\n}" - }, - "postroutingassessmentsjobs": { - "operationId": "postroutingassessmentsjobs", - "functionName": "postRoutingAssessmentsJobs", - "signature": "postRoutingAssessmentsJobs(body)", - "parameters": [ - { - "name": "body", - "type": "CreateBenefitAssessmentJobRequest", - "required": "false" - } - ], - "return": "BenefitAssessmentJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateBenefitAssessmentJobRequest = new CreateBenefitAssessmentJobRequest(...) // \n\n// Create a benefit assessment job.\nPostRoutingAssessmentsJobsRequest.postRoutingAssessmentsJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingAssessmentsJobsRequest.postRoutingAssessmentsJobs was successful\")\n dump(response)\n }\n}" - }, - "postroutingemaildomainroutes": { - "operationId": "postroutingemaildomainroutes", - "functionName": "postRoutingEmailDomainRoutes", - "signature": "postRoutingEmailDomainRoutes(domainName, body)", - "parameters": [ - { - "name": "domainName", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InboundRoute", - "required": "true" - } - ], - "return": "InboundRoute", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainName: String = \"\" // email domain\nlet body: InboundRoute = new InboundRoute(...) // Route\n\n// Create a route\nPostRoutingEmailDomainRoutesRequest.postRoutingEmailDomainRoutes(domainName: domainName, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingEmailDomainRoutesRequest.postRoutingEmailDomainRoutes was successful\")\n dump(response)\n }\n}" - }, - "postroutingemaildomaintestconnection": { - "operationId": "postroutingemaildomaintestconnection", - "functionName": "postRoutingEmailDomainTestconnection", - "signature": "postRoutingEmailDomainTestconnection(domainId, body)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TestMessage", - "required": "false" - } - ], - "return": "TestMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\nlet body: TestMessage = new TestMessage(...) // TestMessage\n\n// Tests the custom SMTP server integration connection set on this domain\nPostRoutingEmailDomainTestconnectionRequest.postRoutingEmailDomainTestconnection(domainId: domainId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingEmailDomainTestconnectionRequest.postRoutingEmailDomainTestconnection was successful\")\n dump(response)\n }\n}" - }, - "postroutingemaildomains": { - "operationId": "postroutingemaildomains", - "functionName": "postRoutingEmailDomains", - "signature": "postRoutingEmailDomains(body)", - "parameters": [ - { - "name": "body", - "type": "InboundDomain", - "required": "true" - } - ], - "return": "InboundDomain", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: InboundDomain = new InboundDomain(...) // Domain\n\n// Create a domain\nPostRoutingEmailDomainsRequest.postRoutingEmailDomains(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingEmailDomainsRequest.postRoutingEmailDomains was successful\")\n dump(response)\n }\n}" - }, - "postroutingemailoutbounddomains": { - "operationId": "postroutingemailoutbounddomains", - "functionName": "postRoutingEmailOutboundDomains", - "signature": "postRoutingEmailOutboundDomains(body)", - "parameters": [ - { - "name": "body", - "type": "OutboundDomain", - "required": "true" - } - ], - "return": "EmailOutboundDomainResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OutboundDomain = new OutboundDomain(...) // Domain\n\n// Create a domain\nPostRoutingEmailOutboundDomainsRequest.postRoutingEmailOutboundDomains(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingEmailOutboundDomainsRequest.postRoutingEmailOutboundDomains was successful\")\n dump(response)\n }\n}" - }, - "postroutingemailoutbounddomainssimulated": { - "operationId": "postroutingemailoutbounddomainssimulated", - "functionName": "postRoutingEmailOutboundDomainsSimulated", - "signature": "postRoutingEmailOutboundDomainsSimulated(body)", - "parameters": [ - { - "name": "body", - "type": "OutboundDomain", - "required": "true" - } - ], - "return": "EmailOutboundDomainResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: OutboundDomain = new OutboundDomain(...) // Domain\n\n// Create a simulated domain\nPostRoutingEmailOutboundDomainsSimulatedRequest.postRoutingEmailOutboundDomainsSimulated(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingEmailOutboundDomainsSimulatedRequest.postRoutingEmailOutboundDomainsSimulated was successful\")\n dump(response)\n }\n}" - }, - "postroutinglanguages": { - "operationId": "postroutinglanguages", - "functionName": "postRoutingLanguages", - "signature": "postRoutingLanguages(body)", - "parameters": [ - { - "name": "body", - "type": "Language", - "required": "true" - } - ], - "return": "Language", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Language = new Language(...) // Language\n\n// Create Language\nPostRoutingLanguagesRequest.postRoutingLanguages(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingLanguagesRequest.postRoutingLanguages was successful\")\n dump(response)\n }\n}" - }, - "postroutingpredictors": { - "operationId": "postroutingpredictors", - "functionName": "postRoutingPredictors", - "signature": "postRoutingPredictors(body)", - "parameters": [ - { - "name": "body", - "type": "CreatePredictorRequest", - "required": "false" - } - ], - "return": "Predictor", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreatePredictorRequest = new CreatePredictorRequest(...) // \n\n// Create a predictor.\nPostRoutingPredictorsRequest.postRoutingPredictors(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingPredictorsRequest.postRoutingPredictors was successful\")\n dump(response)\n }\n}" - }, - "postroutingqueuemembers": { - "operationId": "postroutingqueuemembers", - "functionName": "postRoutingQueueMembers", - "signature": "postRoutingQueueMembers(queueId, body, delete)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[WritableEntity]", - "required": "true" - }, - { - "name": "delete", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: [WritableEntity] = [new WritableEntity(...)] // Queue Members\nlet delete: Bool = true // True to delete queue members\n\n// Bulk add or delete up to 100 queue members\nPostRoutingQueueMembersRequest.postRoutingQueueMembers(queueId: queueId, body: body, delete: delete) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostRoutingQueueMembersRequest.postRoutingQueueMembers was successful\")\n }\n}" - }, - "postroutingqueueusers": { - "operationId": "postroutingqueueusers", - "functionName": "postRoutingQueueUsers", - "signature": "postRoutingQueueUsers(queueId, body, delete)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[WritableEntity]", - "required": "true" - }, - { - "name": "delete", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: [WritableEntity] = [new WritableEntity(...)] // Queue Members\nlet delete: Bool = true // True to delete queue members\n\n// DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.\nPostRoutingQueueUsersRequest.postRoutingQueueUsers(queueId: queueId, body: body, delete: delete) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostRoutingQueueUsersRequest.postRoutingQueueUsers was successful\")\n }\n}" - }, - "postroutingqueuewrapupcodes": { - "operationId": "postroutingqueuewrapupcodes", - "functionName": "postRoutingQueueWrapupcodes", - "signature": "postRoutingQueueWrapupcodes(queueId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[WrapUpCodeReference]", - "required": "true" - } - ], - "return": "[WrapupCode]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: [WrapUpCodeReference] = [new WrapUpCodeReference(...)] // List of wrapup codes\n\n// Add up to 100 wrap-up codes to a queue\nPostRoutingQueueWrapupcodesRequest.postRoutingQueueWrapupcodes(queueId: queueId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingQueueWrapupcodesRequest.postRoutingQueueWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "postroutingqueues": { - "operationId": "postroutingqueues", - "functionName": "postRoutingQueues", - "signature": "postRoutingQueues(body)", - "parameters": [ - { - "name": "body", - "type": "CreateQueueRequest", - "required": "true" - } - ], - "return": "Queue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateQueueRequest = new CreateQueueRequest(...) // Queue\n\n// Create a queue\nPostRoutingQueuesRequest.postRoutingQueues(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingQueuesRequest.postRoutingQueues was successful\")\n dump(response)\n }\n}" - }, - "postroutingskillgroupmembersdivisions": { - "operationId": "postroutingskillgroupmembersdivisions", - "functionName": "postRoutingSkillgroupMembersDivisions", - "signature": "postRoutingSkillgroupMembersDivisions(skillGroupId, body)", - "parameters": [ - { - "name": "skillGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SkillGroupMemberDivisions", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet skillGroupId: String = \"\" // Skill Group ID\nlet body: SkillGroupMemberDivisions = new SkillGroupMemberDivisions(...) // \n\n// Add or remove member divisions for this skill group.\nPostRoutingSkillgroupMembersDivisionsRequest.postRoutingSkillgroupMembersDivisions(skillGroupId: skillGroupId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostRoutingSkillgroupMembersDivisionsRequest.postRoutingSkillgroupMembersDivisions was successful\")\n }\n}" - }, - "postroutingskillgroups": { - "operationId": "postroutingskillgroups", - "functionName": "postRoutingSkillgroups", - "signature": "postRoutingSkillgroups(body)", - "parameters": [ - { - "name": "body", - "type": "SkillGroupWithMemberDivisions", - "required": "true" - } - ], - "return": "SkillGroupWithMemberDivisions", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SkillGroupWithMemberDivisions = new SkillGroupWithMemberDivisions(...) // Create skill group\n\n// Create a skill group\nPostRoutingSkillgroupsRequest.postRoutingSkillgroups(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingSkillgroupsRequest.postRoutingSkillgroups was successful\")\n dump(response)\n }\n}" - }, - "postroutingskills": { - "operationId": "postroutingskills", - "functionName": "postRoutingSkills", - "signature": "postRoutingSkills(body)", - "parameters": [ - { - "name": "body", - "type": "RoutingSkill", - "required": "true" - } - ], - "return": "RoutingSkill", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RoutingSkill = new RoutingSkill(...) // Skill\n\n// Create Skill\nPostRoutingSkillsRequest.postRoutingSkills(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingSkillsRequest.postRoutingSkills was successful\")\n dump(response)\n }\n}" - }, - "postroutingsmsaddresses": { - "operationId": "postroutingsmsaddresses", - "functionName": "postRoutingSmsAddresses", - "signature": "postRoutingSmsAddresses(body)", - "parameters": [ - { - "name": "body", - "type": "SmsAddressProvision", - "required": "true" - } - ], - "return": "SmsAddress", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SmsAddressProvision = new SmsAddressProvision(...) // SmsAddress\n\n// Provision an Address for SMS\nPostRoutingSmsAddressesRequest.postRoutingSmsAddresses(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingSmsAddressesRequest.postRoutingSmsAddresses was successful\")\n dump(response)\n }\n}" - }, - "postroutingsmsphonenumbers": { - "operationId": "postroutingsmsphonenumbers", - "functionName": "postRoutingSmsPhonenumbers", - "signature": "postRoutingSmsPhonenumbers(body)", - "parameters": [ - { - "name": "body", - "type": "SmsPhoneNumberProvision", - "required": "true" - } - ], - "return": "SmsPhoneNumber", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SmsPhoneNumberProvision = new SmsPhoneNumberProvision(...) // SmsPhoneNumber\n\n// Provision a phone number for SMS\nPostRoutingSmsPhonenumbersRequest.postRoutingSmsPhonenumbers(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingSmsPhonenumbersRequest.postRoutingSmsPhonenumbers was successful\")\n dump(response)\n }\n}" - }, - "postroutingwrapupcodes": { - "operationId": "postroutingwrapupcodes", - "functionName": "postRoutingWrapupcodes", - "signature": "postRoutingWrapupcodes(body)", - "parameters": [ - { - "name": "body", - "type": "WrapupCodeRequest", - "required": "true" - } - ], - "return": "WrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WrapupCodeRequest = new WrapupCodeRequest(...) // WrapupCode\n\n// Create a wrap-up code\nPostRoutingWrapupcodesRequest.postRoutingWrapupcodes(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostRoutingWrapupcodesRequest.postRoutingWrapupcodes was successful\")\n dump(response)\n }\n}" - }, - "postuserroutinglanguages": { - "operationId": "postuserroutinglanguages", - "functionName": "postUserRoutinglanguages", - "signature": "postUserRoutinglanguages(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserRoutingLanguagePost", - "required": "true" - } - ], - "return": "UserRoutingLanguage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: UserRoutingLanguagePost = new UserRoutingLanguagePost(...) // Language\n\n// Add routing language to user\nPostUserRoutinglanguagesRequest.postUserRoutinglanguages(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUserRoutinglanguagesRequest.postUserRoutinglanguages was successful\")\n dump(response)\n }\n}" - }, - "postuserroutingskills": { - "operationId": "postuserroutingskills", - "functionName": "postUserRoutingskills", - "signature": "postUserRoutingskills(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserRoutingSkillPost", - "required": "true" - } - ], - "return": "UserRoutingSkill", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: UserRoutingSkillPost = new UserRoutingSkillPost(...) // Skill\n\n// Add routing skill to user\nPostUserRoutingskillsRequest.postUserRoutingskills(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUserRoutingskillsRequest.postUserRoutingskills was successful\")\n dump(response)\n }\n}" - }, - "putroutingemaildomainroute": { - "operationId": "putroutingemaildomainroute", - "functionName": "putRoutingEmailDomainRoute", - "signature": "putRoutingEmailDomainRoute(domainName, routeId, body)", - "parameters": [ - { - "name": "domainName", - "type": "String", - "required": "true" - }, - { - "name": "routeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "InboundRoute", - "required": "true" - } - ], - "return": "InboundRoute", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainName: String = \"\" // email domain\nlet routeId: String = \"\" // route ID\nlet body: InboundRoute = new InboundRoute(...) // Route\n\n// Update a route\nPutRoutingEmailDomainRouteRequest.putRoutingEmailDomainRoute(domainName: domainName, routeId: routeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingEmailDomainRouteRequest.putRoutingEmailDomainRoute was successful\")\n dump(response)\n }\n}" - }, - "putroutingemailoutbounddomainactivation": { - "operationId": "putroutingemailoutbounddomainactivation", - "functionName": "putRoutingEmailOutboundDomainActivation", - "signature": "putRoutingEmailOutboundDomainActivation(domainId)", - "parameters": [ - { - "name": "domainId", - "type": "String", - "required": "true" - } - ], - "return": "EmailOutboundDomainResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet domainId: String = \"\" // domain ID\n\n// Request an activation status (cname + dkim) update of an outbound domain\nPutRoutingEmailOutboundDomainActivationRequest.putRoutingEmailOutboundDomainActivation(domainId: domainId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingEmailOutboundDomainActivationRequest.putRoutingEmailOutboundDomainActivation was successful\")\n dump(response)\n }\n}" - }, - "putroutingmessagerecipient": { - "operationId": "putroutingmessagerecipient", - "functionName": "putRoutingMessageRecipient", - "signature": "putRoutingMessageRecipient(recipientId, body)", - "parameters": [ - { - "name": "recipientId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RecipientRequest", - "required": "true" - } - ], - "return": "Recipient", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recipientId: String = \"\" // Recipient ID\nlet body: RecipientRequest = new RecipientRequest(...) // Recipient\n\n// Update a recipient\nPutRoutingMessageRecipientRequest.putRoutingMessageRecipient(recipientId: recipientId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingMessageRecipientRequest.putRoutingMessageRecipient was successful\")\n dump(response)\n }\n}" - }, - "putroutingqueue": { - "operationId": "putroutingqueue", - "functionName": "putRoutingQueue", - "signature": "putRoutingQueue(queueId, body)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueueRequest", - "required": "true" - } - ], - "return": "Queue", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet body: QueueRequest = new QueueRequest(...) // Queue\n\n// Update a queue\nPutRoutingQueueRequest.putRoutingQueue(queueId: queueId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingQueueRequest.putRoutingQueue was successful\")\n dump(response)\n }\n}" - }, - "putroutingsettings": { - "operationId": "putroutingsettings", - "functionName": "putRoutingSettings", - "signature": "putRoutingSettings(body)", - "parameters": [ - { - "name": "body", - "type": "RoutingSettings", - "required": "true" - } - ], - "return": "RoutingSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: RoutingSettings = new RoutingSettings(...) // Organization Settings\n\n// Update an organization's routing settings\nPutRoutingSettingsRequest.putRoutingSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingSettingsRequest.putRoutingSettings was successful\")\n dump(response)\n }\n}" - }, - "putroutingsettingstranscription": { - "operationId": "putroutingsettingstranscription", - "functionName": "putRoutingSettingsTranscription", - "signature": "putRoutingSettingsTranscription(body)", - "parameters": [ - { - "name": "body", - "type": "TranscriptionSettings", - "required": "true" - } - ], - "return": "TranscriptionSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TranscriptionSettings = new TranscriptionSettings(...) // Organization Settings\n\n// Update Transcription Settings\nPutRoutingSettingsTranscriptionRequest.putRoutingSettingsTranscription(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingSettingsTranscriptionRequest.putRoutingSettingsTranscription was successful\")\n dump(response)\n }\n}" - }, - "putroutingsmsphonenumber": { - "operationId": "putroutingsmsphonenumber", - "functionName": "putRoutingSmsPhonenumber", - "signature": "putRoutingSmsPhonenumber(addressId, body)", - "parameters": [ - { - "name": "addressId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SmsPhoneNumber", - "required": "true" - } - ], - "return": "SmsPhoneNumber", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet addressId: String = \"\" // Address ID\nlet body: SmsPhoneNumber = new SmsPhoneNumber(...) // SmsPhoneNumber\n\n// Update a phone number provisioned for SMS.\nPutRoutingSmsPhonenumberRequest.putRoutingSmsPhonenumber(addressId: addressId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingSmsPhonenumberRequest.putRoutingSmsPhonenumber was successful\")\n dump(response)\n }\n}" - }, - "putroutinguserutilization": { - "operationId": "putroutinguserutilization", - "functionName": "putRoutingUserUtilization", - "signature": "putRoutingUserUtilization(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Utilization", - "required": "true" - } - ], - "return": "AgentMaxUtilization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: Utilization = new Utilization(...) // utilization\n\n// Update the user's max utilization settings. Include only those media types requiring custom configuration.\nPutRoutingUserUtilizationRequest.putRoutingUserUtilization(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingUserUtilizationRequest.putRoutingUserUtilization was successful\")\n dump(response)\n }\n}" - }, - "putroutingutilization": { - "operationId": "putroutingutilization", - "functionName": "putRoutingUtilization", - "signature": "putRoutingUtilization(body)", - "parameters": [ - { - "name": "body", - "type": "Utilization", - "required": "true" - } - ], - "return": "Utilization", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Utilization = new Utilization(...) // utilization\n\n// Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.\nPutRoutingUtilizationRequest.putRoutingUtilization(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingUtilizationRequest.putRoutingUtilization was successful\")\n dump(response)\n }\n}" - }, - "putroutingwrapupcode": { - "operationId": "putroutingwrapupcode", - "functionName": "putRoutingWrapupcode", - "signature": "putRoutingWrapupcode(codeId, body)", - "parameters": [ - { - "name": "codeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WrapupCodeRequest", - "required": "true" - } - ], - "return": "WrapupCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet codeId: String = \"\" // Wrapup Code ID\nlet body: WrapupCodeRequest = new WrapupCodeRequest(...) // WrapupCode\n\n// Update wrap-up code\nPutRoutingWrapupcodeRequest.putRoutingWrapupcode(codeId: codeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutRoutingWrapupcodeRequest.putRoutingWrapupcode was successful\")\n dump(response)\n }\n}" - }, - "putuserroutingskill": { - "operationId": "putuserroutingskill", - "functionName": "putUserRoutingskill", - "signature": "putUserRoutingskill(userId, skillId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "skillId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserRoutingSkill", - "required": "true" - } - ], - "return": "UserRoutingSkill", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet skillId: String = \"\" // skillId\nlet body: UserRoutingSkill = new UserRoutingSkill(...) // Skill\n\n// Update routing skill proficiency or state.\nPutUserRoutingskillRequest.putUserRoutingskill(userId: userId, skillId: skillId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserRoutingskillRequest.putUserRoutingskill was successful\")\n dump(response)\n }\n}" - }, - "putuserroutingskillsbulk": { - "operationId": "putuserroutingskillsbulk", - "functionName": "putUserRoutingskillsBulk", - "signature": "putUserRoutingskillsBulk(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[UserRoutingSkillPost]", - "required": "true" - } - ], - "return": "UserSkillEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: [UserRoutingSkillPost] = [new UserRoutingSkillPost(...)] // Skill\n\n// Replace all routing skills assigned to a user\nPutUserRoutingskillsBulkRequest.putUserRoutingskillsBulk(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserRoutingskillsBulkRequest.putUserRoutingskillsBulk was successful\")\n dump(response)\n }\n}" - }, - "deletescimuser": { - "operationId": "deletescimuser", - "functionName": "deleteScimUser", - "signature": "deleteScimUser(userId, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/users.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Delete a user\nDeleteScimUserRequest.deleteScimUser(userId: userId, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteScimUserRequest.deleteScimUser was successful\")\n dump(response)\n }\n}" - }, - "deletescimv2user": { - "operationId": "deletescimv2user", - "functionName": "deleteScimV2User", - "signature": "deleteScimV2User(userId, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/v2/users.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Delete a user\nDeleteScimV2UserRequest.deleteScimV2User(userId: userId, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteScimV2UserRequest.deleteScimV2User was successful\")\n dump(response)\n }\n}" - }, - "getscimgroup": { - "operationId": "getscimgroup", - "functionName": "getScimGroup", - "signature": "getScimGroup(groupId, attributes, excludedAttributes, ifNoneMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/groups.\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet ifNoneMatch: String = \"\" // 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.\n\n// Get a group\nGetScimGroupRequest.getScimGroup(groupId: groupId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimGroupRequest.getScimGroup was successful\")\n dump(response)\n }\n}" - }, - "getscimgroups": { - "operationId": "getscimgroups", - "functionName": "getScimGroups", - "signature": "getScimGroups(startIndex, count, attributes, excludedAttributes, filter)", - "parameters": [ - { - "name": "startIndex", - "type": "Int", - "required": "false" - }, - { - "name": "count", - "type": "Int", - "required": "false" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "ScimGroupListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startIndex: Int = 0 // The 1-based index of the first query result.\nlet count: Int = 0 // 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\\\".\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet filter: String = displayName eq groupName // Filters results. If nothing is specified, returns all groups. Examples of valid values: \\\"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\\\", \\\"displayname eq Sales\\\".\n\n// Get a list of groups\nGetScimGroupsRequest.getScimGroups(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimGroupsRequest.getScimGroups was successful\")\n dump(response)\n }\n}" - }, - "getscimresourcetype": { - "operationId": "getscimresourcetype", - "functionName": "getScimResourcetype", - "signature": "getScimResourcetype(resourceType)", - "parameters": [ - { - "name": "resourceType", - "type": "String", - "required": "true" - } - ], - "return": "ScimConfigResourceType", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet resourceType: GetScimResourcetypeRequest.ResourceType_getScimResourcetype = GetScimResourcetypeRequest.ResourceType_getScimResourcetype.enummember // The type of resource. Returned with GET /api/v2/scim/resourcetypes.\n\n// Get a resource type\nGetScimResourcetypeRequest.getScimResourcetype(resourceType: resourceType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimResourcetypeRequest.getScimResourcetype was successful\")\n dump(response)\n }\n}" - }, - "getscimresourcetypes": { - "operationId": "getscimresourcetypes", - "functionName": "getScimResourcetypes", - "signature": "getScimResourcetypes()", - "return": "ScimConfigResourceTypesListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of resource types\nGetScimResourcetypesRequest.getScimResourcetypes() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimResourcetypesRequest.getScimResourcetypes was successful\")\n dump(response)\n }\n}" - }, - "getscimschema": { - "operationId": "getscimschema", - "functionName": "getScimSchema", - "signature": "getScimSchema(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "ScimV2SchemaDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: GetScimSchemaRequest.SchemaId_getScimSchema = GetScimSchemaRequest.SchemaId_getScimSchema.enummember // The ID of a schema. Returned with GET /api/v2/scim/schemas.\n\n// Get a SCIM schema\nGetScimSchemaRequest.getScimSchema(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimSchemaRequest.getScimSchema was successful\")\n dump(response)\n }\n}" - }, - "getscimschemas": { - "operationId": "getscimschemas", - "functionName": "getScimSchemas", - "signature": "getScimSchemas(filter)", - "parameters": [ - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2SchemaListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filter: String = displayName eq groupName // Filtered results are invalid and return 403 Unauthorized.\n\n// Get a list of SCIM schemas\nGetScimSchemasRequest.getScimSchemas(filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimSchemasRequest.getScimSchemas was successful\")\n dump(response)\n }\n}" - }, - "getscimserviceproviderconfig": { - "operationId": "getscimserviceproviderconfig", - "functionName": "getScimServiceproviderconfig", - "signature": "getScimServiceproviderconfig(ifNoneMatch)", - "parameters": [ - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimServiceProviderConfig", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ifNoneMatch: String = \"\" // 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. \n\n// Get a service provider's configuration\nGetScimServiceproviderconfigRequest.getScimServiceproviderconfig(ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimServiceproviderconfigRequest.getScimServiceproviderconfig was successful\")\n dump(response)\n }\n}" - }, - "getscimuser": { - "operationId": "getscimuser", - "functionName": "getScimUser", - "signature": "getScimUser(userId, attributes, excludedAttributes, ifNoneMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/users.\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet ifNoneMatch: String = \"\" // 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.\n\n// Get a user\nGetScimUserRequest.getScimUser(userId: userId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimUserRequest.getScimUser was successful\")\n dump(response)\n }\n}" - }, - "getscimusers": { - "operationId": "getscimusers", - "functionName": "getScimUsers", - "signature": "getScimUsers(startIndex, count, attributes, excludedAttributes, filter)", - "parameters": [ - { - "name": "startIndex", - "type": "Int", - "required": "false" - }, - { - "name": "count", - "type": "Int", - "required": "false" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "ScimUserListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startIndex: Int = 0 // The 1-based index of the first query result.\nlet count: Int = 0 // 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\\\".\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet filter: String = \"\" // 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\\\".\n\n// Get a list of users\nGetScimUsersRequest.getScimUsers(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimUsersRequest.getScimUsers was successful\")\n dump(response)\n }\n}" - }, - "getscimv2group": { - "operationId": "getscimv2group", - "functionName": "getScimV2Group", - "signature": "getScimV2Group(groupId, attributes, excludedAttributes, ifNoneMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/v2/groups.\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet ifNoneMatch: String = \"\" // 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.\n\n// Get a group\nGetScimV2GroupRequest.getScimV2Group(groupId: groupId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2GroupRequest.getScimV2Group was successful\")\n dump(response)\n }\n}" - }, - "getscimv2groups": { - "operationId": "getscimv2groups", - "functionName": "getScimV2Groups", - "signature": "getScimV2Groups(filter, startIndex, count, attributes, excludedAttributes)", - "parameters": [ - { - "name": "filter", - "type": "String", - "required": "true" - }, - { - "name": "startIndex", - "type": "Int", - "required": "false" - }, - { - "name": "count", - "type": "Int", - "required": "false" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - } - ], - "return": "ScimGroupListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filter: String = displayName eq groupName // Filters results. If nothing is specified, returns all groups. Examples of valid values: \\\"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\\\", \\\"displayname eq Sales\\\".\nlet startIndex: Int = 0 // The 1-based index of the first query result.\nlet count: Int = 0 // 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\\\".\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\n\n// Get a list of groups\nGetScimV2GroupsRequest.getScimV2Groups(filter: filter, startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2GroupsRequest.getScimV2Groups was successful\")\n dump(response)\n }\n}" - }, - "getscimv2resourcetype": { - "operationId": "getscimv2resourcetype", - "functionName": "getScimV2Resourcetype", - "signature": "getScimV2Resourcetype(resourceType)", - "parameters": [ - { - "name": "resourceType", - "type": "String", - "required": "true" - } - ], - "return": "ScimConfigResourceType", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet resourceType: GetScimV2ResourcetypeRequest.ResourceType_getScimV2Resourcetype = GetScimV2ResourcetypeRequest.ResourceType_getScimV2Resourcetype.enummember // The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.\n\n// Get a resource type\nGetScimV2ResourcetypeRequest.getScimV2Resourcetype(resourceType: resourceType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2ResourcetypeRequest.getScimV2Resourcetype was successful\")\n dump(response)\n }\n}" - }, - "getscimv2resourcetypes": { - "operationId": "getscimv2resourcetypes", - "functionName": "getScimV2Resourcetypes", - "signature": "getScimV2Resourcetypes()", - "return": "ScimConfigResourceTypesListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of resource types\nGetScimV2ResourcetypesRequest.getScimV2Resourcetypes() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2ResourcetypesRequest.getScimV2Resourcetypes was successful\")\n dump(response)\n }\n}" - }, - "getscimv2schema": { - "operationId": "getscimv2schema", - "functionName": "getScimV2Schema", - "signature": "getScimV2Schema(schemaId)", - "parameters": [ - { - "name": "schemaId", - "type": "String", - "required": "true" - } - ], - "return": "ScimV2SchemaDefinition", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet schemaId: GetScimV2SchemaRequest.SchemaId_getScimV2Schema = GetScimV2SchemaRequest.SchemaId_getScimV2Schema.enummember // The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.\n\n// Get a SCIM schema\nGetScimV2SchemaRequest.getScimV2Schema(schemaId: schemaId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2SchemaRequest.getScimV2Schema was successful\")\n dump(response)\n }\n}" - }, - "getscimv2schemas": { - "operationId": "getscimv2schemas", - "functionName": "getScimV2Schemas", - "signature": "getScimV2Schemas(filter)", - "parameters": [ - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2SchemaListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet filter: String = displayName eq groupName // Filtered results are invalid and return 403 Unauthorized.\n\n// Get a list of SCIM schemas\nGetScimV2SchemasRequest.getScimV2Schemas(filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2SchemasRequest.getScimV2Schemas was successful\")\n dump(response)\n }\n}" - }, - "getscimv2serviceproviderconfig": { - "operationId": "getscimv2serviceproviderconfig", - "functionName": "getScimV2Serviceproviderconfig", - "signature": "getScimV2Serviceproviderconfig(ifNoneMatch)", - "parameters": [ - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimServiceProviderConfig", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ifNoneMatch: String = \"\" // 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. \n\n// Get a service provider's configuration\nGetScimV2ServiceproviderconfigRequest.getScimV2Serviceproviderconfig(ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2ServiceproviderconfigRequest.getScimV2Serviceproviderconfig was successful\")\n dump(response)\n }\n}" - }, - "getscimv2user": { - "operationId": "getscimv2user", - "functionName": "getScimV2User", - "signature": "getScimV2User(userId, attributes, excludedAttributes, ifNoneMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "ifNoneMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/v2/users.\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet ifNoneMatch: String = \"\" // 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.\n\n// Get a user\nGetScimV2UserRequest.getScimV2User(userId: userId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2UserRequest.getScimV2User was successful\")\n dump(response)\n }\n}" - }, - "getscimv2users": { - "operationId": "getscimv2users", - "functionName": "getScimV2Users", - "signature": "getScimV2Users(startIndex, count, attributes, excludedAttributes, filter)", - "parameters": [ - { - "name": "startIndex", - "type": "Int", - "required": "false" - }, - { - "name": "count", - "type": "Int", - "required": "false" - }, - { - "name": "attributes", - "type": "[String]", - "required": "false" - }, - { - "name": "excludedAttributes", - "type": "[String]", - "required": "false" - }, - { - "name": "filter", - "type": "String", - "required": "false" - } - ], - "return": "ScimUserListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet startIndex: Int = 0 // The 1-based index of the first query result.\nlet count: Int = 0 // 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\\\".\nlet attributes: [String] = [\"\"] // 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.\nlet excludedAttributes: [String] = [\"\"] // 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.\nlet filter: String = \"\" // 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\\\".\n\n// Get a list of users\nGetScimV2UsersRequest.getScimV2Users(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScimV2UsersRequest.getScimV2Users was successful\")\n dump(response)\n }\n}" - }, - "patchscimgroup": { - "operationId": "patchscimgroup", - "functionName": "patchScimGroup", - "signature": "patchScimGroup(groupId, body, ifMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2PatchRequest", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/groups.\nlet body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a group.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Modify a group\nPatchScimGroupRequest.patchScimGroup(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchScimGroupRequest.patchScimGroup was successful\")\n dump(response)\n }\n}" - }, - "patchscimuser": { - "operationId": "patchscimuser", - "functionName": "patchScimUser", - "signature": "patchScimUser(userId, body, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2PatchRequest", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/users.\nlet body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a user.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Modify a user\nPatchScimUserRequest.patchScimUser(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchScimUserRequest.patchScimUser was successful\")\n dump(response)\n }\n}" - }, - "patchscimv2group": { - "operationId": "patchscimv2group", - "functionName": "patchScimV2Group", - "signature": "patchScimV2Group(groupId, body, ifMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2PatchRequest", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/v2/groups.\nlet body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a group.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Modify a group\nPatchScimV2GroupRequest.patchScimV2Group(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchScimV2GroupRequest.patchScimV2Group was successful\")\n dump(response)\n }\n}" - }, - "patchscimv2user": { - "operationId": "patchscimv2user", - "functionName": "patchScimV2User", - "signature": "patchScimV2User(userId, body, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2PatchRequest", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/v2/users.\nlet body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a user.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Modify a user\nPatchScimV2UserRequest.patchScimV2User(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchScimV2UserRequest.patchScimV2User was successful\")\n dump(response)\n }\n}" - }, - "postscimusers": { - "operationId": "postscimusers", - "functionName": "postScimUsers", - "signature": "postScimUsers(body)", - "parameters": [ - { - "name": "body", - "type": "ScimV2CreateUser", - "required": "true" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ScimV2CreateUser = new ScimV2CreateUser(...) // The information used to create a user.\n\n// Create a user\nPostScimUsersRequest.postScimUsers(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostScimUsersRequest.postScimUsers was successful\")\n dump(response)\n }\n}" - }, - "postscimv2users": { - "operationId": "postscimv2users", - "functionName": "postScimV2Users", - "signature": "postScimV2Users(body)", - "parameters": [ - { - "name": "body", - "type": "ScimV2CreateUser", - "required": "true" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ScimV2CreateUser = new ScimV2CreateUser(...) // The information used to create a user.\n\n// Create a user\nPostScimV2UsersRequest.postScimV2Users(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostScimV2UsersRequest.postScimV2Users was successful\")\n dump(response)\n }\n}" - }, - "putscimgroup": { - "operationId": "putscimgroup", - "functionName": "putScimGroup", - "signature": "putScimGroup(groupId, body, ifMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2Group", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/groups.\nlet body: ScimV2Group = new ScimV2Group(...) // The information used to replace a group.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Replace a group\nPutScimGroupRequest.putScimGroup(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutScimGroupRequest.putScimGroup was successful\")\n dump(response)\n }\n}" - }, - "putscimuser": { - "operationId": "putscimuser", - "functionName": "putScimUser", - "signature": "putScimUser(userId, body, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2User", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/users.\nlet body: ScimV2User = new ScimV2User(...) // The information used to replace a user.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Replace a user\nPutScimUserRequest.putScimUser(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutScimUserRequest.putScimUser was successful\")\n dump(response)\n }\n}" - }, - "putscimv2group": { - "operationId": "putscimv2group", - "functionName": "putScimV2Group", - "signature": "putScimV2Group(groupId, body, ifMatch)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2Group", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2Group", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // The ID of a group. Returned with GET /api/v2/scim/v2/groups.\nlet body: ScimV2Group = new ScimV2Group(...) // The information used to replace a group.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Replace a group\nPutScimV2GroupRequest.putScimV2Group(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutScimV2GroupRequest.putScimV2Group was successful\")\n dump(response)\n }\n}" - }, - "putscimv2user": { - "operationId": "putscimv2user", - "functionName": "putScimV2User", - "signature": "putScimV2User(userId, body, ifMatch)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ScimV2User", - "required": "true" - }, - { - "name": "ifMatch", - "type": "String", - "required": "false" - } - ], - "return": "ScimV2User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // The ID of a user. Returned with GET /api/v2/scim/v2/users.\nlet body: ScimV2User = new ScimV2User(...) // The information used to replace a user.\nlet ifMatch: String = \"\" // 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\\\".\n\n// Replace a user\nPutScimV2UserRequest.putScimV2User(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutScimV2UserRequest.putScimV2User was successful\")\n dump(response)\n }\n}" - }, - "getscript": { - "operationId": "getscript", - "functionName": "getScript", - "signature": "getScript(scriptId)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - } - ], - "return": "Script", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\n\n// Get a script\nGetScriptRequest.getScript(scriptId: scriptId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptRequest.getScript was successful\")\n dump(response)\n }\n}" - }, - "getscriptpage": { - "operationId": "getscriptpage", - "functionName": "getScriptPage", - "signature": "getScriptPage(scriptId, pageId, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "pageId", - "type": "String", - "required": "true" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "Page", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet pageId: String = \"\" // Page ID\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get a page\nGetScriptPageRequest.getScriptPage(scriptId: scriptId, pageId: pageId, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptPageRequest.getScriptPage was successful\")\n dump(response)\n }\n}" - }, - "getscriptpages": { - "operationId": "getscriptpages", - "functionName": "getScriptPages", - "signature": "getScriptPages(scriptId, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "[Page]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get the list of pages\nGetScriptPagesRequest.getScriptPages(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptPagesRequest.getScriptPages was successful\")\n dump(response)\n }\n}" - }, - "getscripts": { - "operationId": "getscripts", - "functionName": "getScripts", - "signature": "getScripts(pageSize, pageNumber, expand, name, feature, flowId, sortBy, sortOrder, scriptDataVersion, divisionIds)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "flowId", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - }, - { - "name": "divisionIds", - "type": "String", - "required": "false" - } - ], - "return": "ScriptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: String = \"\" // Expand\nlet name: String = \"\" // Name filter\nlet feature: String = \"\" // Feature filter\nlet flowId: String = \"\" // Secure flow id filter\nlet sortBy: GetScriptsRequest.SortBy_getScripts = GetScriptsRequest.SortBy_getScripts.enummember // SortBy\nlet sortOrder: GetScriptsRequest.SortOrder_getScripts = GetScriptsRequest.SortOrder_getScripts.enummember // SortOrder\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\nlet divisionIds: String = \"\" // Filters scripts to requested divisionIds\n\n// Get the list of scripts\nGetScriptsRequest.getScripts(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, sortBy: sortBy, sortOrder: sortOrder, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsRequest.getScripts was successful\")\n dump(response)\n }\n}" - }, - "getscriptsdivisionviews": { - "operationId": "getscriptsdivisionviews", - "functionName": "getScriptsDivisionviews", - "signature": "getScriptsDivisionviews(pageSize, pageNumber, expand, name, feature, flowId, sortBy, sortOrder, scriptDataVersion, divisionIds)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "flowId", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - }, - { - "name": "divisionIds", - "type": "String", - "required": "false" - } - ], - "return": "ScriptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: String = \"\" // Expand\nlet name: String = \"\" // Name filter\nlet feature: String = \"\" // Feature filter\nlet flowId: String = \"\" // Secure flow id filter\nlet sortBy: GetScriptsDivisionviewsRequest.SortBy_getScriptsDivisionviews = GetScriptsDivisionviewsRequest.SortBy_getScriptsDivisionviews.enummember // SortBy\nlet sortOrder: GetScriptsDivisionviewsRequest.SortOrder_getScriptsDivisionviews = GetScriptsDivisionviewsRequest.SortOrder_getScriptsDivisionviews.enummember // SortOrder\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\nlet divisionIds: String = \"\" // Filters scripts to requested divisionIds\n\n// Get the metadata for a list of scripts\nGetScriptsDivisionviewsRequest.getScriptsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, sortBy: sortBy, sortOrder: sortOrder, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsDivisionviewsRequest.getScriptsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublished": { - "operationId": "getscriptspublished", - "functionName": "getScriptsPublished", - "signature": "getScriptsPublished(pageSize, pageNumber, expand, name, feature, flowId, scriptDataVersion, divisionIds)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "flowId", - "type": "String", - "required": "false" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - }, - { - "name": "divisionIds", - "type": "String", - "required": "false" - } - ], - "return": "ScriptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: String = \"\" // Expand\nlet name: String = \"\" // Name filter\nlet feature: String = \"\" // Feature filter\nlet flowId: String = \"\" // Secure flow id filter\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\nlet divisionIds: String = \"\" // Filters scripts to requested divisionIds\n\n// Get the published scripts.\nGetScriptsPublishedRequest.getScriptsPublished(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedRequest.getScriptsPublished was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublisheddivisionviews": { - "operationId": "getscriptspublisheddivisionviews", - "functionName": "getScriptsPublishedDivisionviews", - "signature": "getScriptsPublishedDivisionviews(pageSize, pageNumber, expand, name, feature, flowId, scriptDataVersion, divisionIds)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "flowId", - "type": "String", - "required": "false" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - }, - { - "name": "divisionIds", - "type": "String", - "required": "false" - } - ], - "return": "ScriptEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: String = \"\" // Expand\nlet name: String = \"\" // Name filter\nlet feature: String = \"\" // Feature filter\nlet flowId: String = \"\" // Secure flow id filter\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\nlet divisionIds: String = \"\" // Filters scripts to requested divisionIds\n\n// Get the published scripts metadata.\nGetScriptsPublishedDivisionviewsRequest.getScriptsPublishedDivisionviews(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedDivisionviewsRequest.getScriptsPublishedDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublishedscriptid": { - "operationId": "getscriptspublishedscriptid", - "functionName": "getScriptsPublishedScriptId", - "signature": "getScriptsPublishedScriptId(scriptId, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "Script", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get the published script.\nGetScriptsPublishedScriptIdRequest.getScriptsPublishedScriptId(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedScriptIdRequest.getScriptsPublishedScriptId was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublishedscriptidpage": { - "operationId": "getscriptspublishedscriptidpage", - "functionName": "getScriptsPublishedScriptIdPage", - "signature": "getScriptsPublishedScriptIdPage(scriptId, pageId, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "pageId", - "type": "String", - "required": "true" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "Page", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet pageId: String = \"\" // Page ID\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get the published page.\nGetScriptsPublishedScriptIdPageRequest.getScriptsPublishedScriptIdPage(scriptId: scriptId, pageId: pageId, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedScriptIdPageRequest.getScriptsPublishedScriptIdPage was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublishedscriptidpages": { - "operationId": "getscriptspublishedscriptidpages", - "functionName": "getScriptsPublishedScriptIdPages", - "signature": "getScriptsPublishedScriptIdPages(scriptId, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "[Page]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get the list of published pages\nGetScriptsPublishedScriptIdPagesRequest.getScriptsPublishedScriptIdPages(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedScriptIdPagesRequest.getScriptsPublishedScriptIdPages was successful\")\n dump(response)\n }\n}" - }, - "getscriptspublishedscriptidvariables": { - "operationId": "getscriptspublishedscriptidvariables", - "functionName": "getScriptsPublishedScriptIdVariables", - "signature": "getScriptsPublishedScriptIdVariables(scriptId, input, output, type, scriptDataVersion)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "input", - "type": "String", - "required": "false" - }, - { - "name": "output", - "type": "String", - "required": "false" - }, - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet input: GetScriptsPublishedScriptIdVariablesRequest.Input_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.Input_getScriptsPublishedScriptIdVariables.enummember // input\nlet output: GetScriptsPublishedScriptIdVariablesRequest.Output_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.Output_getScriptsPublishedScriptIdVariables.enummember // output\nlet type: GetScriptsPublishedScriptIdVariablesRequest.ModelType_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.ModelType_getScriptsPublishedScriptIdVariables.enummember // type\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\n\n// Get the published variables\nGetScriptsPublishedScriptIdVariablesRequest.getScriptsPublishedScriptIdVariables(scriptId: scriptId, input: input, output: output, type: type, scriptDataVersion: scriptDataVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsPublishedScriptIdVariablesRequest.getScriptsPublishedScriptIdVariables was successful\")\n dump(response)\n }\n}" - }, - "getscriptsuploadstatus": { - "operationId": "getscriptsuploadstatus", - "functionName": "getScriptsUploadStatus", - "signature": "getScriptsUploadStatus(uploadId, longPoll)", - "parameters": [ - { - "name": "uploadId", - "type": "String", - "required": "true" - }, - { - "name": "longPoll", - "type": "Bool", - "required": "false" - } - ], - "return": "ImportScriptStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet uploadId: String = \"\" // Upload ID\nlet longPoll: Bool = true // Enable longPolling endpoint\n\n// Get the upload status of an imported script\nGetScriptsUploadStatusRequest.getScriptsUploadStatus(uploadId: uploadId, longPoll: longPoll) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetScriptsUploadStatusRequest.getScriptsUploadStatus was successful\")\n dump(response)\n }\n}" - }, - "postscriptexport": { - "operationId": "postscriptexport", - "functionName": "postScriptExport", - "signature": "postScriptExport(scriptId, body)", - "parameters": [ - { - "name": "scriptId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExportScriptRequest", - "required": "false" - } - ], - "return": "ExportScriptResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptId: String = \"\" // Script ID\nlet body: ExportScriptRequest = new ExportScriptRequest(...) // \n\n// Export a script via download service.\nPostScriptExportRequest.postScriptExport(scriptId: scriptId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostScriptExportRequest.postScriptExport was successful\")\n dump(response)\n }\n}" - }, - "postscriptspublished": { - "operationId": "postscriptspublished", - "functionName": "postScriptsPublished", - "signature": "postScriptsPublished(scriptDataVersion, body)", - "parameters": [ - { - "name": "scriptDataVersion", - "type": "String", - "required": "false" - }, - { - "name": "body", - "type": "PublishScriptRequestData", - "required": "false" - } - ], - "return": "Script", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet scriptDataVersion: String = \"\" // Advanced usage - controls the data version of the script\nlet body: PublishScriptRequestData = new PublishScriptRequestData(...) // body\n\n// Publish a script.\nPostScriptsPublishedRequest.postScriptsPublished(scriptDataVersion: scriptDataVersion, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostScriptsPublishedRequest.postScriptsPublished was successful\")\n dump(response)\n }\n}" - }, - "getdocumentationgknsearch": { - "operationId": "getdocumentationgknsearch", - "functionName": "getDocumentationGknSearch", - "signature": "getDocumentationGknSearch(q64)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - } - ], - "return": "GKNDocumentationSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\n\n// Search gkn documentation using the q64 value returned from a previous search\nGetDocumentationGknSearchRequest.getDocumentationGknSearch(q64: q64) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDocumentationGknSearchRequest.getDocumentationGknSearch was successful\")\n dump(response)\n }\n}" - }, - "getdocumentationsearch": { - "operationId": "getdocumentationsearch", - "functionName": "getDocumentationSearch", - "signature": "getDocumentationSearch(q64)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - } - ], - "return": "DocumentationSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\n\n// Search documentation using the q64 value returned from a previous search\nGetDocumentationSearchRequest.getDocumentationSearch(q64: q64) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDocumentationSearchRequest.getDocumentationSearch was successful\")\n dump(response)\n }\n}" - }, - "getsearch": { - "operationId": "getsearch", - "functionName": "getSearch", - "signature": "getSearch(q64, expand, profile)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "profile", - "type": "Bool", - "required": "false" - } - ], - "return": "JsonNodeSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet profile: Bool = true // profile\n\n// Search using the q64 value returned from a previous search.\nGetSearchRequest.getSearch(q64: q64, expand: expand, profile: profile) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSearchRequest.getSearch was successful\")\n dump(response)\n }\n}" - }, - "getsearchsuggest": { - "operationId": "getsearchsuggest", - "functionName": "getSearchSuggest", - "signature": "getSearchSuggest(q64, expand, profile)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "profile", - "type": "Bool", - "required": "false" - } - ], - "return": "JsonNodeSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet profile: Bool = true // profile\n\n// Suggest resources using the q64 value returned from a previous suggest query.\nGetSearchSuggestRequest.getSearchSuggest(q64: q64, expand: expand, profile: profile) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSearchSuggestRequest.getSearchSuggest was successful\")\n dump(response)\n }\n}" - }, - "getuserssearch": { - "operationId": "getuserssearch", - "functionName": "getUsersSearch", - "signature": "getUsersSearch(q64, expand, integrationPresenceSource)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - } - ], - "return": "UsersSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // expand\nlet integrationPresenceSource: GetUsersSearchRequest.IntegrationPresenceSource_getUsersSearch = GetUsersSearchRequest.IntegrationPresenceSource_getUsersSearch.enummember // integrationPresenceSource\n\n// Search users using the q64 value returned from a previous search\nGetUsersSearchRequest.getUsersSearch(q64: q64, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersSearchRequest.getUsersSearch was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailsearch": { - "operationId": "getvoicemailsearch", - "functionName": "getVoicemailSearch", - "signature": "getVoicemailSearch(q64, expand)", - "parameters": [ - { - "name": "q64", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "VoicemailsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet q64: String = \"\" // q64\nlet expand: [String] = [\"\"] // expand\n\n// Search voicemails using the q64 value returned from a previous search\nGetVoicemailSearchRequest.getVoicemailSearch(q64: q64, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailSearchRequest.getVoicemailSearch was successful\")\n dump(response)\n }\n}" - }, - "postdocumentationgknsearch": { - "operationId": "postdocumentationgknsearch", - "functionName": "postDocumentationGknSearch", - "signature": "postDocumentationGknSearch(body)", - "parameters": [ - { - "name": "body", - "type": "GKNDocumentationSearchRequest", - "required": "true" - } - ], - "return": "GKNDocumentationSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GKNDocumentationSearchRequest = new GKNDocumentationSearchRequest(...) // Search request options\n\n// Search gkn documentation\nPostDocumentationGknSearchRequest.postDocumentationGknSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostDocumentationGknSearchRequest.postDocumentationGknSearch was successful\")\n dump(response)\n }\n}" - }, - "postdocumentationsearch": { - "operationId": "postdocumentationsearch", - "functionName": "postDocumentationSearch", - "signature": "postDocumentationSearch(body)", - "parameters": [ - { - "name": "body", - "type": "DocumentationSearchRequest", - "required": "true" - } - ], - "return": "DocumentationSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DocumentationSearchRequest = new DocumentationSearchRequest(...) // Search request options\n\n// Search documentation\nPostDocumentationSearchRequest.postDocumentationSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostDocumentationSearchRequest.postDocumentationSearch was successful\")\n dump(response)\n }\n}" - }, - "postsearch": { - "operationId": "postsearch", - "functionName": "postSearch", - "signature": "postSearch(body, profile)", - "parameters": [ - { - "name": "body", - "type": "SearchRequest", - "required": "true" - }, - { - "name": "profile", - "type": "Bool", - "required": "false" - } - ], - "return": "JsonNodeSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SearchRequest = new SearchRequest(...) // Search request options\nlet profile: Bool = true // profile\n\n// Search resources.\nPostSearchRequest.postSearch(body: body, profile: profile) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSearchRequest.postSearch was successful\")\n dump(response)\n }\n}" - }, - "postsearchsuggest": { - "operationId": "postsearchsuggest", - "functionName": "postSearchSuggest", - "signature": "postSearchSuggest(body, profile)", - "parameters": [ - { - "name": "body", - "type": "SuggestSearchRequest", - "required": "true" - }, - { - "name": "profile", - "type": "Bool", - "required": "false" - } - ], - "return": "JsonNodeSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SuggestSearchRequest = new SuggestSearchRequest(...) // Search request options\nlet profile: Bool = true // profile\n\n// Suggest resources.\nPostSearchSuggestRequest.postSearchSuggest(body: body, profile: profile) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSearchSuggestRequest.postSearchSuggest was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticstranscriptssearch": { - "operationId": "postspeechandtextanalyticstranscriptssearch", - "functionName": "postSpeechandtextanalyticsTranscriptsSearch", - "signature": "postSpeechandtextanalyticsTranscriptsSearch(body)", - "parameters": [ - { - "name": "body", - "type": "TranscriptSearchRequest", - "required": "true" - } - ], - "return": "JsonSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TranscriptSearchRequest = new TranscriptSearchRequest(...) // Search request options\n\n// Search resources.\nPostSpeechandtextanalyticsTranscriptsSearchRequest.postSpeechandtextanalyticsTranscriptsSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsTranscriptsSearchRequest.postSpeechandtextanalyticsTranscriptsSearch was successful\")\n dump(response)\n }\n}" - }, - "postteamssearch": { - "operationId": "postteamssearch", - "functionName": "postTeamsSearch", - "signature": "postTeamsSearch(body)", - "parameters": [ - { - "name": "body", - "type": "TeamSearchRequest", - "required": "true" - } - ], - "return": "TeamsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TeamSearchRequest = new TeamSearchRequest(...) // Search request options\n\n// Search resources.\nPostTeamsSearchRequest.postTeamsSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTeamsSearchRequest.postTeamsSearch was successful\")\n dump(response)\n }\n}" - }, - "postuserssearch": { - "operationId": "postuserssearch", - "functionName": "postUsersSearch", - "signature": "postUsersSearch(body)", - "parameters": [ - { - "name": "body", - "type": "UserSearchRequest", - "required": "true" - } - ], - "return": "UsersSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserSearchRequest = new UserSearchRequest(...) // Search request options\n\n// Search users\nPostUsersSearchRequest.postUsersSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsersSearchRequest.postUsersSearch was successful\")\n dump(response)\n }\n}" - }, - "postuserssearchteamsassign": { - "operationId": "postuserssearchteamsassign", - "functionName": "postUsersSearchTeamsAssign", - "signature": "postUsersSearchTeamsAssign(body)", - "parameters": [ - { - "name": "body", - "type": "UserSearchRequest", - "required": "true" - } - ], - "return": "UsersSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UserSearchRequest = new UserSearchRequest(...) // Search request options\n\n// Search users assigned to teams\nPostUsersSearchTeamsAssignRequest.postUsersSearchTeamsAssign(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsersSearchTeamsAssignRequest.postUsersSearchTeamsAssign was successful\")\n dump(response)\n }\n}" - }, - "postvoicemailsearch": { - "operationId": "postvoicemailsearch", - "functionName": "postVoicemailSearch", - "signature": "postVoicemailSearch(body)", - "parameters": [ - { - "name": "body", - "type": "VoicemailSearchRequest", - "required": "true" - } - ], - "return": "VoicemailsSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: VoicemailSearchRequest = new VoicemailSearchRequest(...) // Search request options\n\n// Search voicemails\nPostVoicemailSearchRequest.postVoicemailSearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostVoicemailSearchRequest.postVoicemailSearch was successful\")\n dump(response)\n }\n}" - }, - "deletespeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid": { - "operationId": "deletespeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", - "functionName": "deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", - "signature": "deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId)", - "parameters": [ - { - "name": "dictionaryFeedbackId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dictionaryFeedbackId: String = \"\" // The Id of the Dictionary Feedback\n\n// Delete a Speech & Text Analytics DictionaryFeedback by Id\nDeleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful\")\n }\n}" - }, - "deletespeechandtextanalyticsprogram": { - "operationId": "deletespeechandtextanalyticsprogram", - "functionName": "deleteSpeechandtextanalyticsProgram", - "signature": "deleteSpeechandtextanalyticsProgram(programId, forceDelete)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - }, - { - "name": "forceDelete", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\nlet forceDelete: Bool = true // Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.\n\n// Delete a Speech & Text Analytics program by id\nDeleteSpeechandtextanalyticsProgramRequest.deleteSpeechandtextanalyticsProgram(programId: programId, forceDelete: forceDelete) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteSpeechandtextanalyticsProgramRequest.deleteSpeechandtextanalyticsProgram was successful\")\n }\n}" - }, - "deletespeechandtextanalyticssentimentfeedback": { - "operationId": "deletespeechandtextanalyticssentimentfeedback", - "functionName": "deleteSpeechandtextanalyticsSentimentfeedback", - "signature": "deleteSpeechandtextanalyticsSentimentfeedback()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete All Speech & Text Analytics SentimentFeedback\nDeleteSpeechandtextanalyticsSentimentfeedbackRequest.deleteSpeechandtextanalyticsSentimentfeedback() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteSpeechandtextanalyticsSentimentfeedbackRequest.deleteSpeechandtextanalyticsSentimentfeedback was successful\")\n }\n}" - }, - "deletespeechandtextanalyticssentimentfeedbacksentimentfeedbackid": { - "operationId": "deletespeechandtextanalyticssentimentfeedbacksentimentfeedbackid", - "functionName": "deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId", - "signature": "deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId)", - "parameters": [ - { - "name": "sentimentFeedbackId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sentimentFeedbackId: String = \"\" // The Id of the SentimentFeedback\n\n// Delete a Speech & Text Analytics SentimentFeedback by Id\nDeleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackIdRequest.deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId: sentimentFeedbackId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackIdRequest.deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId was successful\")\n }\n}" - }, - "deletespeechandtextanalyticstopic": { - "operationId": "deletespeechandtextanalyticstopic", - "functionName": "deleteSpeechandtextanalyticsTopic", - "signature": "deleteSpeechandtextanalyticsTopic(topicId)", - "parameters": [ - { - "name": "topicId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet topicId: String = \"\" // The id of the topic\n\n// Delete a Speech & Text Analytics topic by id\nDeleteSpeechandtextanalyticsTopicRequest.deleteSpeechandtextanalyticsTopic(topicId: topicId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteSpeechandtextanalyticsTopicRequest.deleteSpeechandtextanalyticsTopic was successful\")\n }\n}" - }, - "getspeechandtextanalyticsconversation": { - "operationId": "getspeechandtextanalyticsconversation", - "functionName": "getSpeechandtextanalyticsConversation", - "signature": "getSpeechandtextanalyticsConversation(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "ConversationMetrics", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation Id\n\n// Get Speech and Text Analytics for a specific conversation\nGetSpeechandtextanalyticsConversationRequest.getSpeechandtextanalyticsConversation(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsConversationRequest.getSpeechandtextanalyticsConversation was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsconversationcommunicationtranscripturl": { - "operationId": "getspeechandtextanalyticsconversationcommunicationtranscripturl", - "functionName": "getSpeechandtextanalyticsConversationCommunicationTranscripturl", - "signature": "getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId, communicationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - } - ], - "return": "TranscriptUrl", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet communicationId: String = \"\" // Communication ID\n\n// Get the pre-signed S3 URL for the transcript of a specific communication of a conversation\nGetSpeechandtextanalyticsConversationCommunicationTranscripturlRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId: conversationId, communicationId: communicationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsConversationCommunicationTranscripturlRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturl was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsconversationcommunicationtranscripturls": { - "operationId": "getspeechandtextanalyticsconversationcommunicationtranscripturls", - "functionName": "getSpeechandtextanalyticsConversationCommunicationTranscripturls", - "signature": "getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "communicationId", - "type": "String", - "required": "true" - } - ], - "return": "TranscriptUrls", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // Conversation ID\nlet communicationId: String = \"\" // Communication ID\n\n// Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation\nGetSpeechandtextanalyticsConversationCommunicationTranscripturlsRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId: conversationId, communicationId: communicationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsConversationCommunicationTranscripturlsRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturls was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsdictionaryfeedback": { - "operationId": "getspeechandtextanalyticsdictionaryfeedback", - "functionName": "getSpeechandtextanalyticsDictionaryfeedback", - "signature": "getSpeechandtextanalyticsDictionaryfeedback(dialect, nextPage, pageSize)", - "parameters": [ - { - "name": "dialect", - "type": "String", - "required": "false" - }, - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "DictionaryFeedbackEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dialect: String = en-US // The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard\nlet nextPage: String = \"\" // The key for listing the next page\nlet pageSize: Int = 0 // The page size for the listing\n\n// Get the list of Speech & Text Analytics dictionary feedbacks\nGetSpeechandtextanalyticsDictionaryfeedbackRequest.getSpeechandtextanalyticsDictionaryfeedback(dialect: dialect, nextPage: nextPage, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsDictionaryfeedbackRequest.getSpeechandtextanalyticsDictionaryfeedback was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid": { - "operationId": "getspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", - "functionName": "getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", - "signature": "getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId)", - "parameters": [ - { - "name": "dictionaryFeedbackId", - "type": "String", - "required": "true" - } - ], - "return": "DictionaryFeedback", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dictionaryFeedbackId: String = \"\" // The Id of the Dictionary Feedback\n\n// Get a Speech & Text Analytics dictionary feedback by id\nGetSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogram": { - "operationId": "getspeechandtextanalyticsprogram", - "functionName": "getSpeechandtextanalyticsProgram", - "signature": "getSpeechandtextanalyticsProgram(programId)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - } - ], - "return": "Program", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\n\n// Get a Speech & Text Analytics program by id\nGetSpeechandtextanalyticsProgramRequest.getSpeechandtextanalyticsProgram(programId: programId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramRequest.getSpeechandtextanalyticsProgram was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogrammappings": { - "operationId": "getspeechandtextanalyticsprogrammappings", - "functionName": "getSpeechandtextanalyticsProgramMappings", - "signature": "getSpeechandtextanalyticsProgramMappings(programId)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - } - ], - "return": "ProgramMappings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\n\n// Get Speech & Text Analytics program mappings to queues and flows by id\nGetSpeechandtextanalyticsProgramMappingsRequest.getSpeechandtextanalyticsProgramMappings(programId: programId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramMappingsRequest.getSpeechandtextanalyticsProgramMappings was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramtranscriptionengines": { - "operationId": "getspeechandtextanalyticsprogramtranscriptionengines", - "functionName": "getSpeechandtextanalyticsProgramTranscriptionengines", - "signature": "getSpeechandtextanalyticsProgramTranscriptionengines(programId)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - } - ], - "return": "ProgramTranscriptionEngines", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\n\n// Get transcription engine settings of a program\nGetSpeechandtextanalyticsProgramTranscriptionenginesRequest.getSpeechandtextanalyticsProgramTranscriptionengines(programId: programId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramTranscriptionenginesRequest.getSpeechandtextanalyticsProgramTranscriptionengines was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprograms": { - "operationId": "getspeechandtextanalyticsprograms", - "functionName": "getSpeechandtextanalyticsPrograms", - "signature": "getSpeechandtextanalyticsPrograms(nextPage, pageSize, state)", - "parameters": [ - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - } - ], - "return": "ProgramsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet nextPage: String = \"\" // The key for listing the next page\nlet pageSize: Int = 0 // The page size for the listing\nlet state: GetSpeechandtextanalyticsProgramsRequest.State_getSpeechandtextanalyticsPrograms = GetSpeechandtextanalyticsProgramsRequest.State_getSpeechandtextanalyticsPrograms.enummember // Program state. Defaults to Latest\n\n// Get the list of Speech & Text Analytics programs\nGetSpeechandtextanalyticsProgramsRequest.getSpeechandtextanalyticsPrograms(nextPage: nextPage, pageSize: pageSize, state: state) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsRequest.getSpeechandtextanalyticsPrograms was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramsgeneraljob": { - "operationId": "getspeechandtextanalyticsprogramsgeneraljob", - "functionName": "getSpeechandtextanalyticsProgramsGeneralJob", - "signature": "getSpeechandtextanalyticsProgramsGeneralJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "GeneralProgramJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The id of the publish programs job\n\n// Get a Speech & Text Analytics general program job by id\nGetSpeechandtextanalyticsProgramsGeneralJobRequest.getSpeechandtextanalyticsProgramsGeneralJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsGeneralJobRequest.getSpeechandtextanalyticsProgramsGeneralJob was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramsmappings": { - "operationId": "getspeechandtextanalyticsprogramsmappings", - "functionName": "getSpeechandtextanalyticsProgramsMappings", - "signature": "getSpeechandtextanalyticsProgramsMappings(nextPage, pageSize)", - "parameters": [ - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "ProgramsMappingsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet nextPage: String = \"\" // The key for listing the next page\nlet pageSize: Int = 0 // The page size for the listing\n\n// Get the list of Speech & Text Analytics programs mappings to queues and flows\nGetSpeechandtextanalyticsProgramsMappingsRequest.getSpeechandtextanalyticsProgramsMappings(nextPage: nextPage, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsMappingsRequest.getSpeechandtextanalyticsProgramsMappings was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramspublishjob": { - "operationId": "getspeechandtextanalyticsprogramspublishjob", - "functionName": "getSpeechandtextanalyticsProgramsPublishjob", - "signature": "getSpeechandtextanalyticsProgramsPublishjob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "ProgramJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The id of the publish programs job\n\n// Get a Speech & Text Analytics publish programs job by id\nGetSpeechandtextanalyticsProgramsPublishjobRequest.getSpeechandtextanalyticsProgramsPublishjob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsPublishjobRequest.getSpeechandtextanalyticsProgramsPublishjob was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramstranscriptionenginesdialects": { - "operationId": "getspeechandtextanalyticsprogramstranscriptionenginesdialects", - "functionName": "getSpeechandtextanalyticsProgramsTranscriptionenginesDialects", - "signature": "getSpeechandtextanalyticsProgramsTranscriptionenginesDialects()", - "return": "SupportedDialectsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get supported dialects for each transcription engine\nGetSpeechandtextanalyticsProgramsTranscriptionenginesDialectsRequest.getSpeechandtextanalyticsProgramsTranscriptionenginesDialects() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsTranscriptionenginesDialectsRequest.getSpeechandtextanalyticsProgramsTranscriptionenginesDialects was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticsprogramsunpublished": { - "operationId": "getspeechandtextanalyticsprogramsunpublished", - "functionName": "getSpeechandtextanalyticsProgramsUnpublished", - "signature": "getSpeechandtextanalyticsProgramsUnpublished(nextPage, pageSize)", - "parameters": [ - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "UnpublishedProgramsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet nextPage: String = \"\" // The key for listing the next page\nlet pageSize: Int = 0 // The page size for the listing\n\n// Get the list of Speech & Text Analytics unpublished programs\nGetSpeechandtextanalyticsProgramsUnpublishedRequest.getSpeechandtextanalyticsProgramsUnpublished(nextPage: nextPage, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsProgramsUnpublishedRequest.getSpeechandtextanalyticsProgramsUnpublished was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticssentimentdialects": { - "operationId": "getspeechandtextanalyticssentimentdialects", - "functionName": "getSpeechandtextanalyticsSentimentDialects", - "signature": "getSpeechandtextanalyticsSentimentDialects()", - "return": "EntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of Speech & Text Analytics sentiment supported dialects\nGetSpeechandtextanalyticsSentimentDialectsRequest.getSpeechandtextanalyticsSentimentDialects() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsSentimentDialectsRequest.getSpeechandtextanalyticsSentimentDialects was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticssentimentfeedback": { - "operationId": "getspeechandtextanalyticssentimentfeedback", - "functionName": "getSpeechandtextanalyticsSentimentfeedback", - "signature": "getSpeechandtextanalyticsSentimentfeedback(dialect)", - "parameters": [ - { - "name": "dialect", - "type": "String", - "required": "false" - } - ], - "return": "SentimentFeedbackEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dialect: String = en-US // The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard\n\n// Get the list of Speech & Text Analytics SentimentFeedback\nGetSpeechandtextanalyticsSentimentfeedbackRequest.getSpeechandtextanalyticsSentimentfeedback(dialect: dialect) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsSentimentfeedbackRequest.getSpeechandtextanalyticsSentimentfeedback was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticssettings": { - "operationId": "getspeechandtextanalyticssettings", - "functionName": "getSpeechandtextanalyticsSettings", - "signature": "getSpeechandtextanalyticsSettings()", - "return": "SpeechTextAnalyticsSettingsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get Speech And Text Analytics Settings\nGetSpeechandtextanalyticsSettingsRequest.getSpeechandtextanalyticsSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsSettingsRequest.getSpeechandtextanalyticsSettings was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopic": { - "operationId": "getspeechandtextanalyticstopic", - "functionName": "getSpeechandtextanalyticsTopic", - "signature": "getSpeechandtextanalyticsTopic(topicId)", - "parameters": [ - { - "name": "topicId", - "type": "String", - "required": "true" - } - ], - "return": "Topic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet topicId: String = \"\" // The id of the topic\n\n// Get a Speech & Text Analytics topic by id\nGetSpeechandtextanalyticsTopicRequest.getSpeechandtextanalyticsTopic(topicId: topicId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicRequest.getSpeechandtextanalyticsTopic was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopics": { - "operationId": "getspeechandtextanalyticstopics", - "functionName": "getSpeechandtextanalyticsTopics", - "signature": "getSpeechandtextanalyticsTopics(nextPage, pageSize, state, name, ids, sortBy, sortOrder)", - "parameters": [ - { - "name": "nextPage", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "ids", - "type": "[String]", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "TopicsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet nextPage: String = \"\" // The key for listing the next page\nlet pageSize: Int = 0 // The page size for the listing\nlet state: GetSpeechandtextanalyticsTopicsRequest.State_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.State_getSpeechandtextanalyticsTopics.enummember // Topic state. Defaults to latest\nlet name: String = \"\" // Case insensitive partial name to filter by\nlet ids: [String] = [\"\"] // Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.\nlet sortBy: GetSpeechandtextanalyticsTopicsRequest.SortBy_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.SortBy_getSpeechandtextanalyticsTopics.enummember // Sort results by. Defaults to name\nlet sortOrder: GetSpeechandtextanalyticsTopicsRequest.SortOrder_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.SortOrder_getSpeechandtextanalyticsTopics.enummember // Sort order. Defaults to asc\n\n// Get the list of Speech & Text Analytics topics\nGetSpeechandtextanalyticsTopicsRequest.getSpeechandtextanalyticsTopics(nextPage: nextPage, pageSize: pageSize, state: state, name: name, ids: ids, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicsRequest.getSpeechandtextanalyticsTopics was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopicsdialects": { - "operationId": "getspeechandtextanalyticstopicsdialects", - "functionName": "getSpeechandtextanalyticsTopicsDialects", - "signature": "getSpeechandtextanalyticsTopicsDialects()", - "return": "EntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get list of supported Speech & Text Analytics topics dialects\nGetSpeechandtextanalyticsTopicsDialectsRequest.getSpeechandtextanalyticsTopicsDialects() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicsDialectsRequest.getSpeechandtextanalyticsTopicsDialects was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopicsgeneral": { - "operationId": "getspeechandtextanalyticstopicsgeneral", - "functionName": "getSpeechandtextanalyticsTopicsGeneral", - "signature": "getSpeechandtextanalyticsTopicsGeneral(dialect)", - "parameters": [ - { - "name": "dialect", - "type": "String", - "required": "false" - } - ], - "return": "GeneralTopicsEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dialect: GetSpeechandtextanalyticsTopicsGeneralRequest.Dialect_getSpeechandtextanalyticsTopicsGeneral = GetSpeechandtextanalyticsTopicsGeneralRequest.Dialect_getSpeechandtextanalyticsTopicsGeneral.enummember // 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\n\n// Get the Speech & Text Analytics general topics for a given dialect\nGetSpeechandtextanalyticsTopicsGeneralRequest.getSpeechandtextanalyticsTopicsGeneral(dialect: dialect) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicsGeneralRequest.getSpeechandtextanalyticsTopicsGeneral was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopicsgeneralstatus": { - "operationId": "getspeechandtextanalyticstopicsgeneralstatus", - "functionName": "getSpeechandtextanalyticsTopicsGeneralStatus", - "signature": "getSpeechandtextanalyticsTopicsGeneralStatus(dialect)", - "parameters": [ - { - "name": "dialect", - "type": "String", - "required": "false" - } - ], - "return": "UnifiedGeneralTopicEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dialect: GetSpeechandtextanalyticsTopicsGeneralStatusRequest.Dialect_getSpeechandtextanalyticsTopicsGeneralStatus = GetSpeechandtextanalyticsTopicsGeneralStatusRequest.Dialect_getSpeechandtextanalyticsTopicsGeneralStatus.enummember // 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\n\n// Get the list of general topics from the org and the system with their current status\nGetSpeechandtextanalyticsTopicsGeneralStatusRequest.getSpeechandtextanalyticsTopicsGeneralStatus(dialect: dialect) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicsGeneralStatusRequest.getSpeechandtextanalyticsTopicsGeneralStatus was successful\")\n dump(response)\n }\n}" - }, - "getspeechandtextanalyticstopicspublishjob": { - "operationId": "getspeechandtextanalyticstopicspublishjob", - "functionName": "getSpeechandtextanalyticsTopicsPublishjob", - "signature": "getSpeechandtextanalyticsTopicsPublishjob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "TopicJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The id of the publish topics job\n\n// Get a Speech & Text Analytics publish topics job by id\nGetSpeechandtextanalyticsTopicsPublishjobRequest.getSpeechandtextanalyticsTopicsPublishjob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetSpeechandtextanalyticsTopicsPublishjobRequest.getSpeechandtextanalyticsTopicsPublishjob was successful\")\n dump(response)\n }\n}" - }, - "patchspeechandtextanalyticssettings": { - "operationId": "patchspeechandtextanalyticssettings", - "functionName": "patchSpeechandtextanalyticsSettings", - "signature": "patchSpeechandtextanalyticsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "SpeechTextAnalyticsSettingsRequest", - "required": "true" - } - ], - "return": "SpeechTextAnalyticsSettingsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SpeechTextAnalyticsSettingsRequest = new SpeechTextAnalyticsSettingsRequest(...) // Speech And Text Analytics Settings\n\n// Patch Speech And Text Analytics Settings\nPatchSpeechandtextanalyticsSettingsRequest.patchSpeechandtextanalyticsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchSpeechandtextanalyticsSettingsRequest.patchSpeechandtextanalyticsSettings was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticsdictionaryfeedback": { - "operationId": "postspeechandtextanalyticsdictionaryfeedback", - "functionName": "postSpeechandtextanalyticsDictionaryfeedback", - "signature": "postSpeechandtextanalyticsDictionaryfeedback(body)", - "parameters": [ - { - "name": "body", - "type": "DictionaryFeedback", - "required": "true" - } - ], - "return": "DictionaryFeedback", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DictionaryFeedback = new DictionaryFeedback(...) // The DictionaryFeedback to create\n\n// Create a Speech & Text Analytics DictionaryFeedback\nPostSpeechandtextanalyticsDictionaryfeedbackRequest.postSpeechandtextanalyticsDictionaryfeedback(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsDictionaryfeedbackRequest.postSpeechandtextanalyticsDictionaryfeedback was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticsprograms": { - "operationId": "postspeechandtextanalyticsprograms", - "functionName": "postSpeechandtextanalyticsPrograms", - "signature": "postSpeechandtextanalyticsPrograms(body)", - "parameters": [ - { - "name": "body", - "type": "ProgramRequest", - "required": "true" - } - ], - "return": "Program", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ProgramRequest = new ProgramRequest(...) // The program to create\n\n// Create new Speech & Text Analytics program\nPostSpeechandtextanalyticsProgramsRequest.postSpeechandtextanalyticsPrograms(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsProgramsRequest.postSpeechandtextanalyticsPrograms was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticsprogramsgeneraljobs": { - "operationId": "postspeechandtextanalyticsprogramsgeneraljobs", - "functionName": "postSpeechandtextanalyticsProgramsGeneralJobs", - "signature": "postSpeechandtextanalyticsProgramsGeneralJobs(body)", - "parameters": [ - { - "name": "body", - "type": "GeneralProgramJobRequest", - "required": "true" - } - ], - "return": "GeneralProgramJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: GeneralProgramJobRequest = new GeneralProgramJobRequest(...) // The general programs job to create\n\n// Create new Speech & Text Analytics general program job\nPostSpeechandtextanalyticsProgramsGeneralJobsRequest.postSpeechandtextanalyticsProgramsGeneralJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsProgramsGeneralJobsRequest.postSpeechandtextanalyticsProgramsGeneralJobs was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticsprogramspublishjobs": { - "operationId": "postspeechandtextanalyticsprogramspublishjobs", - "functionName": "postSpeechandtextanalyticsProgramsPublishjobs", - "signature": "postSpeechandtextanalyticsProgramsPublishjobs(body)", - "parameters": [ - { - "name": "body", - "type": "ProgramJobRequest", - "required": "true" - } - ], - "return": "ProgramJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ProgramJobRequest = new ProgramJobRequest(...) // The publish programs job to create\n\n// Create new Speech & Text Analytics publish programs job\nPostSpeechandtextanalyticsProgramsPublishjobsRequest.postSpeechandtextanalyticsProgramsPublishjobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsProgramsPublishjobsRequest.postSpeechandtextanalyticsProgramsPublishjobs was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticssentimentfeedback": { - "operationId": "postspeechandtextanalyticssentimentfeedback", - "functionName": "postSpeechandtextanalyticsSentimentfeedback", - "signature": "postSpeechandtextanalyticsSentimentfeedback(body)", - "parameters": [ - { - "name": "body", - "type": "SentimentFeedback", - "required": "true" - } - ], - "return": "SentimentFeedback", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SentimentFeedback = new SentimentFeedback(...) // The SentimentFeedback to create\n\n// Create a Speech & Text Analytics SentimentFeedback\nPostSpeechandtextanalyticsSentimentfeedbackRequest.postSpeechandtextanalyticsSentimentfeedback(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsSentimentfeedbackRequest.postSpeechandtextanalyticsSentimentfeedback was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticstopics": { - "operationId": "postspeechandtextanalyticstopics", - "functionName": "postSpeechandtextanalyticsTopics", - "signature": "postSpeechandtextanalyticsTopics(body)", - "parameters": [ - { - "name": "body", - "type": "TopicRequest", - "required": "true" - } - ], - "return": "Topic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TopicRequest = new TopicRequest(...) // The topic to create\n\n// Create new Speech & Text Analytics topic\nPostSpeechandtextanalyticsTopicsRequest.postSpeechandtextanalyticsTopics(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsTopicsRequest.postSpeechandtextanalyticsTopics was successful\")\n dump(response)\n }\n}" - }, - "postspeechandtextanalyticstopicspublishjobs": { - "operationId": "postspeechandtextanalyticstopicspublishjobs", - "functionName": "postSpeechandtextanalyticsTopicsPublishjobs", - "signature": "postSpeechandtextanalyticsTopicsPublishjobs(body)", - "parameters": [ - { - "name": "body", - "type": "TopicJobRequest", - "required": "true" - } - ], - "return": "TopicJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TopicJobRequest = new TopicJobRequest(...) // The publish topics job to create\n\n// Create new Speech & Text Analytics publish topics job\nPostSpeechandtextanalyticsTopicsPublishjobsRequest.postSpeechandtextanalyticsTopicsPublishjobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostSpeechandtextanalyticsTopicsPublishjobsRequest.postSpeechandtextanalyticsTopicsPublishjobs was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid": { - "operationId": "putspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", - "functionName": "putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", - "signature": "putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId, body)", - "parameters": [ - { - "name": "dictionaryFeedbackId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DictionaryFeedback", - "required": "false" - } - ], - "return": "DictionaryFeedback", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dictionaryFeedbackId: String = \"\" // The Id of the Dictionary Feedback\nlet body: DictionaryFeedback = new DictionaryFeedback(...) // \n\n// Update existing Speech & Text Analytics dictionary feedback by id\nPutSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticsprogram": { - "operationId": "putspeechandtextanalyticsprogram", - "functionName": "putSpeechandtextanalyticsProgram", - "signature": "putSpeechandtextanalyticsProgram(programId, body)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ProgramRequest", - "required": "true" - } - ], - "return": "Program", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\nlet body: ProgramRequest = new ProgramRequest(...) // The program to update\n\n// Update existing Speech & Text Analytics program\nPutSpeechandtextanalyticsProgramRequest.putSpeechandtextanalyticsProgram(programId: programId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsProgramRequest.putSpeechandtextanalyticsProgram was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticsprogrammappings": { - "operationId": "putspeechandtextanalyticsprogrammappings", - "functionName": "putSpeechandtextanalyticsProgramMappings", - "signature": "putSpeechandtextanalyticsProgramMappings(programId, body)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ProgramMappingsRequest", - "required": "true" - } - ], - "return": "ProgramMappings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\nlet body: ProgramMappingsRequest = new ProgramMappingsRequest(...) // The program to set mappings for\n\n// Set Speech & Text Analytics program mappings to queues and flows\nPutSpeechandtextanalyticsProgramMappingsRequest.putSpeechandtextanalyticsProgramMappings(programId: programId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsProgramMappingsRequest.putSpeechandtextanalyticsProgramMappings was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticsprogramtranscriptionengines": { - "operationId": "putspeechandtextanalyticsprogramtranscriptionengines", - "functionName": "putSpeechandtextanalyticsProgramTranscriptionengines", - "signature": "putSpeechandtextanalyticsProgramTranscriptionengines(programId, body)", - "parameters": [ - { - "name": "programId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TranscriptionEnginesRequest", - "required": "true" - } - ], - "return": "ProgramTranscriptionEngines", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet programId: String = \"\" // The id of the program\nlet body: TranscriptionEnginesRequest = new TranscriptionEnginesRequest(...) // Program transcription engine setting\n\n// Update transcription engine settings of a program\nPutSpeechandtextanalyticsProgramTranscriptionenginesRequest.putSpeechandtextanalyticsProgramTranscriptionengines(programId: programId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsProgramTranscriptionenginesRequest.putSpeechandtextanalyticsProgramTranscriptionengines was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticssettings": { - "operationId": "putspeechandtextanalyticssettings", - "functionName": "putSpeechandtextanalyticsSettings", - "signature": "putSpeechandtextanalyticsSettings(body)", - "parameters": [ - { - "name": "body", - "type": "SpeechTextAnalyticsSettingsRequest", - "required": "true" - } - ], - "return": "SpeechTextAnalyticsSettingsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: SpeechTextAnalyticsSettingsRequest = new SpeechTextAnalyticsSettingsRequest(...) // Speech And Text Analytics Settings\n\n// Update Speech And Text Analytics Settings\nPutSpeechandtextanalyticsSettingsRequest.putSpeechandtextanalyticsSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsSettingsRequest.putSpeechandtextanalyticsSettings was successful\")\n dump(response)\n }\n}" - }, - "putspeechandtextanalyticstopic": { - "operationId": "putspeechandtextanalyticstopic", - "functionName": "putSpeechandtextanalyticsTopic", - "signature": "putSpeechandtextanalyticsTopic(topicId, body)", - "parameters": [ - { - "name": "topicId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TopicRequest", - "required": "true" - } - ], - "return": "Topic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet topicId: String = \"\" // The id of the topic\nlet body: TopicRequest = new TopicRequest(...) // The topic to update\n\n// Update existing Speech & Text Analytics topic\nPutSpeechandtextanalyticsTopicRequest.putSpeechandtextanalyticsTopic(topicId: topicId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutSpeechandtextanalyticsTopicRequest.putSpeechandtextanalyticsTopic was successful\")\n dump(response)\n }\n}" - }, - "deletestationassociateduser": { - "operationId": "deletestationassociateduser", - "functionName": "deleteStationAssociateduser", - "signature": "deleteStationAssociateduser(stationId)", - "parameters": [ - { - "name": "stationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet stationId: String = \"\" // Station ID\n\n// Unassigns the user assigned to this station\nDeleteStationAssociateduserRequest.deleteStationAssociateduser(stationId: stationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteStationAssociateduserRequest.deleteStationAssociateduser was successful\")\n }\n}" - }, - "getstation": { - "operationId": "getstation", - "functionName": "getStation", - "signature": "getStation(stationId)", - "parameters": [ - { - "name": "stationId", - "type": "String", - "required": "true" - } - ], - "return": "Station", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet stationId: String = \"\" // Station ID\n\n// Get station.\nGetStationRequest.getStation(stationId: stationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetStationRequest.getStation was successful\")\n dump(response)\n }\n}" - }, - "getstations": { - "operationId": "getstations", - "functionName": "getStations", - "signature": "getStations(pageSize, pageNumber, sortBy, name, userSelectable, webRtcUserId, _id, lineAppearanceId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "userSelectable", - "type": "String", - "required": "false" - }, - { - "name": "webRtcUserId", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "String", - "required": "false" - }, - { - "name": "lineAppearanceId", - "type": "String", - "required": "false" - } - ], - "return": "StationEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet name: String = \"\" // Name\nlet userSelectable: String = \"\" // True for stations that the user can select otherwise false\nlet webRtcUserId: String = \"\" // Filter for the webRtc station of the webRtcUserId\nlet _id: String = \"\" // Comma separated list of stationIds\nlet lineAppearanceId: String = \"\" // lineAppearanceId\n\n// Get the list of available stations.\nGetStationsRequest.getStations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, name: name, userSelectable: userSelectable, webRtcUserId: webRtcUserId, _id: _id, lineAppearanceId: lineAppearanceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetStationsRequest.getStations was successful\")\n dump(response)\n }\n}" - }, - "deleteteam": { - "operationId": "deleteteam", - "functionName": "deleteTeam", - "signature": "deleteTeam(teamId)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\n\n// Delete team\nDeleteTeamRequest.deleteTeam(teamId: teamId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTeamRequest.deleteTeam was successful\")\n }\n}" - }, - "deleteteammembers": { - "operationId": "deleteteammembers", - "functionName": "deleteTeamMembers", - "signature": "deleteTeamMembers(teamId, _id)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "_id", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\nlet _id: String = \"\" // Comma separated list of member ids to remove\n\n// Delete team members\nDeleteTeamMembersRequest.deleteTeamMembers(teamId: teamId, _id: _id) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTeamMembersRequest.deleteTeamMembers was successful\")\n }\n}" - }, - "getteam": { - "operationId": "getteam", - "functionName": "getTeam", - "signature": "getTeam(teamId)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - } - ], - "return": "Team", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\n\n// Get team\nGetTeamRequest.getTeam(teamId: teamId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTeamRequest.getTeam was successful\")\n dump(response)\n }\n}" - }, - "getteammembers": { - "operationId": "getteammembers", - "functionName": "getTeamMembers", - "signature": "getTeamMembers(teamId, pageSize, before, after, expand)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "TeamMemberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\nlet pageSize: Int = 0 // Page size\nlet before: String = \"\" // The cursor that points to the previous item in the complete list of teams\nlet after: String = \"\" // The cursor that points to the next item in the complete list of teams\nlet expand: GetTeamMembersRequest.Expand_getTeamMembers = GetTeamMembersRequest.Expand_getTeamMembers.enummember // Expand the name on each user\n\n// Get team membership\nGetTeamMembersRequest.getTeamMembers(teamId: teamId, pageSize: pageSize, before: before, after: after, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTeamMembersRequest.getTeamMembers was successful\")\n dump(response)\n }\n}" - }, - "getteams": { - "operationId": "getteams", - "functionName": "getTeams", - "signature": "getTeams(pageSize, name, after, before, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "TeamEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet name: String = \"\" // Return only teams whose names start with this value (case-insensitive matching)\nlet after: String = \"\" // The cursor that points to the next item in the complete list of teams\nlet before: String = \"\" // The cursor that points to the previous item in the complete list of teams\nlet expand: GetTeamsRequest.Expand_getTeams = GetTeamsRequest.Expand_getTeams.enummember // Expand the name on each user\n\n// Get Team listing\nGetTeamsRequest.getTeams(pageSize: pageSize, name: name, after: after, before: before, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTeamsRequest.getTeams was successful\")\n dump(response)\n }\n}" - }, - "patchteam": { - "operationId": "patchteam", - "functionName": "patchTeam", - "signature": "patchTeam(teamId, body)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Team", - "required": "true" - } - ], - "return": "Team", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\nlet body: Team = new Team(...) // Team\n\n// Update team\nPatchTeamRequest.patchTeam(teamId: teamId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchTeamRequest.patchTeam was successful\")\n dump(response)\n }\n}" - }, - "postteammembers": { - "operationId": "postteammembers", - "functionName": "postTeamMembers", - "signature": "postTeamMembers(teamId, body)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TeamMembers", - "required": "true" - } - ], - "return": "TeamMemberAddListingResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // Team ID\nlet body: TeamMembers = new TeamMembers(...) // TeamMembers\n\n// Add team members\nPostTeamMembersRequest.postTeamMembers(teamId: teamId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTeamMembersRequest.postTeamMembers was successful\")\n dump(response)\n }\n}" - }, - "postteams": { - "operationId": "postteams", - "functionName": "postTeams", - "signature": "postTeams(body)", - "parameters": [ - { - "name": "body", - "type": "Team", - "required": "true" - } - ], - "return": "Team", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Team = new Team(...) // Team\n\n// Create a team\nPostTeamsRequest.postTeams(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTeamsRequest.postTeams was successful\")\n dump(response)\n }\n}" - }, - "gettelephonymediaregions": { - "operationId": "gettelephonymediaregions", - "functionName": "getTelephonyMediaregions", - "signature": "getTelephonyMediaregions()", - "return": "MediaRegions", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieve the list of AWS regions media can stream through.\nGetTelephonyMediaregionsRequest.getTelephonyMediaregions() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyMediaregionsRequest.getTelephonyMediaregions was successful\")\n dump(response)\n }\n}" - }, - "gettelephonysiptraces": { - "operationId": "gettelephonysiptraces", - "functionName": "getTelephonySiptraces", - "signature": "getTelephonySiptraces(dateStart, dateEnd, callId, toUser, fromUser, conversationId)", - "parameters": [ - { - "name": "dateStart", - "type": "Date", - "required": "true" - }, - { - "name": "dateEnd", - "type": "Date", - "required": "true" - }, - { - "name": "callId", - "type": "String", - "required": "false" - }, - { - "name": "toUser", - "type": "String", - "required": "false" - }, - { - "name": "fromUser", - "type": "String", - "required": "false" - }, - { - "name": "conversationId", - "type": "String", - "required": "false" - } - ], - "return": "SipSearchResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet dateStart: Date = new Date(...) // Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet dateEnd: Date = new Date(...) // End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\nlet callId: String = \"\" // unique identification of the placed call\nlet toUser: String = \"\" // User to who the call was placed\nlet fromUser: String = \"\" // user who placed the call\nlet conversationId: String = \"\" // Unique identification of the conversation\n\n// Fetch SIP metadata\nGetTelephonySiptracesRequest.getTelephonySiptraces(dateStart: dateStart, dateEnd: dateEnd, callId: callId, toUser: toUser, fromUser: fromUser, conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonySiptracesRequest.getTelephonySiptraces was successful\")\n dump(response)\n }\n}" - }, - "gettelephonysiptracesdownloaddownloadid": { - "operationId": "gettelephonysiptracesdownloaddownloadid", - "functionName": "getTelephonySiptracesDownloadDownloadId", - "signature": "getTelephonySiptracesDownloadDownloadId(downloadId)", - "parameters": [ - { - "name": "downloadId", - "type": "String", - "required": "true" - } - ], - "return": "SignedUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet downloadId: String = \"\" // unique id for the downloaded file in S3\n\n// Get signed S3 URL for a pcap download\nGetTelephonySiptracesDownloadDownloadIdRequest.getTelephonySiptracesDownloadDownloadId(downloadId: downloadId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonySiptracesDownloadDownloadIdRequest.getTelephonySiptracesDownloadDownloadId was successful\")\n dump(response)\n }\n}" - }, - "posttelephonysiptracesdownload": { - "operationId": "posttelephonysiptracesdownload", - "functionName": "postTelephonySiptracesDownload", - "signature": "postTelephonySiptracesDownload(sIPSearchPublicRequest)", - "parameters": [ - { - "name": "sIPSearchPublicRequest", - "type": "SIPSearchPublicRequest", - "required": "true" - } - ], - "return": "SipDownloadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sIPSearchPublicRequest: SIPSearchPublicRequest = new SIPSearchPublicRequest(...) // \n\n// Request a download of a pcap file to S3\nPostTelephonySiptracesDownloadRequest.postTelephonySiptracesDownload(sIPSearchPublicRequest: sIPSearchPublicRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonySiptracesDownloadRequest.postTelephonySiptracesDownload was successful\")\n dump(response)\n }\n}" - }, - "deletetelephonyprovidersedge": { - "operationId": "deletetelephonyprovidersedge", - "functionName": "deleteTelephonyProvidersEdge", - "signature": "deleteTelephonyProvidersEdge(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Delete a edge.\nDeleteTelephonyProvidersEdgeRequest.deleteTelephonyProvidersEdge(edgeId: edgeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgeRequest.deleteTelephonyProvidersEdge was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgelogicalinterface": { - "operationId": "deletetelephonyprovidersedgelogicalinterface", - "functionName": "deleteTelephonyProvidersEdgeLogicalinterface", - "signature": "deleteTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "interfaceId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet interfaceId: String = \"\" // Interface ID\n\n// Delete an edge logical interface\nDeleteTelephonyProvidersEdgeLogicalinterfaceRequest.deleteTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgeLogicalinterfaceRequest.deleteTelephonyProvidersEdgeLogicalinterface was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesoftwareupdate": { - "operationId": "deletetelephonyprovidersedgesoftwareupdate", - "functionName": "deleteTelephonyProvidersEdgeSoftwareupdate", - "signature": "deleteTelephonyProvidersEdgeSoftwareupdate(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Cancels any in-progress update for this edge.\nDeleteTelephonyProvidersEdgeSoftwareupdateRequest.deleteTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgeSoftwareupdateRequest.deleteTelephonyProvidersEdgeSoftwareupdate was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgescertificateauthority": { - "operationId": "deletetelephonyprovidersedgescertificateauthority", - "functionName": "deleteTelephonyProvidersEdgesCertificateauthority", - "signature": "deleteTelephonyProvidersEdgesCertificateauthority(certificateId)", - "parameters": [ - { - "name": "certificateId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet certificateId: String = \"\" // Certificate ID\n\n// Delete a certificate authority.\nDeleteTelephonyProvidersEdgesCertificateauthorityRequest.deleteTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesCertificateauthorityRequest.deleteTelephonyProvidersEdgesCertificateauthority was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesdidpool": { - "operationId": "deletetelephonyprovidersedgesdidpool", - "functionName": "deleteTelephonyProvidersEdgesDidpool", - "signature": "deleteTelephonyProvidersEdgesDidpool(didPoolId)", - "parameters": [ - { - "name": "didPoolId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet didPoolId: String = \"\" // DID pool ID\n\n// Delete a DID Pool by ID.\nDeleteTelephonyProvidersEdgesDidpoolRequest.deleteTelephonyProvidersEdgesDidpool(didPoolId: didPoolId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesDidpoolRequest.deleteTelephonyProvidersEdgesDidpool was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesedgegroup": { - "operationId": "deletetelephonyprovidersedgesedgegroup", - "functionName": "deleteTelephonyProvidersEdgesEdgegroup", - "signature": "deleteTelephonyProvidersEdgesEdgegroup(edgeGroupId)", - "parameters": [ - { - "name": "edgeGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeGroupId: String = \"\" // Edge group ID\n\n// Delete an edge group.\nDeleteTelephonyProvidersEdgesEdgegroupRequest.deleteTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesEdgegroupRequest.deleteTelephonyProvidersEdgesEdgegroup was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesextensionpool": { - "operationId": "deletetelephonyprovidersedgesextensionpool", - "functionName": "deleteTelephonyProvidersEdgesExtensionpool", - "signature": "deleteTelephonyProvidersEdgesExtensionpool(extensionPoolId)", - "parameters": [ - { - "name": "extensionPoolId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet extensionPoolId: String = \"\" // Extension pool ID\n\n// Delete an extension pool by ID\nDeleteTelephonyProvidersEdgesExtensionpoolRequest.deleteTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesExtensionpoolRequest.deleteTelephonyProvidersEdgesExtensionpool was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesphone": { - "operationId": "deletetelephonyprovidersedgesphone", - "functionName": "deleteTelephonyProvidersEdgesPhone", - "signature": "deleteTelephonyProvidersEdgesPhone(phoneId)", - "parameters": [ - { - "name": "phoneId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneId: String = \"\" // Phone ID\n\n// Delete a Phone by ID\nDeleteTelephonyProvidersEdgesPhoneRequest.deleteTelephonyProvidersEdgesPhone(phoneId: phoneId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesPhoneRequest.deleteTelephonyProvidersEdgesPhone was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgesphonebasesetting": { - "operationId": "deletetelephonyprovidersedgesphonebasesetting", - "functionName": "deleteTelephonyProvidersEdgesPhonebasesetting", - "signature": "deleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId)", - "parameters": [ - { - "name": "phoneBaseId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneBaseId: String = \"\" // Phone base ID\n\n// Delete a Phone Base Settings by ID\nDeleteTelephonyProvidersEdgesPhonebasesettingRequest.deleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesPhonebasesettingRequest.deleteTelephonyProvidersEdgesPhonebasesetting was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgessite": { - "operationId": "deletetelephonyprovidersedgessite", - "functionName": "deleteTelephonyProvidersEdgesSite", - "signature": "deleteTelephonyProvidersEdgesSite(siteId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\n\n// Delete a Site by ID\nDeleteTelephonyProvidersEdgesSiteRequest.deleteTelephonyProvidersEdgesSite(siteId: siteId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesSiteRequest.deleteTelephonyProvidersEdgesSite was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgessiteoutboundroute": { - "operationId": "deletetelephonyprovidersedgessiteoutboundroute", - "functionName": "deleteTelephonyProvidersEdgesSiteOutboundroute", - "signature": "deleteTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "outboundRouteId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet outboundRouteId: String = \"\" // Outbound route ID\n\n// Delete Outbound Route\nDeleteTelephonyProvidersEdgesSiteOutboundrouteRequest.deleteTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesSiteOutboundrouteRequest.deleteTelephonyProvidersEdgesSiteOutboundroute was successful\")\n }\n}" - }, - "deletetelephonyprovidersedgestrunkbasesetting": { - "operationId": "deletetelephonyprovidersedgestrunkbasesetting", - "functionName": "deleteTelephonyProvidersEdgesTrunkbasesetting", - "signature": "deleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId)", - "parameters": [ - { - "name": "trunkBaseSettingsId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkBaseSettingsId: String = \"\" // Trunk Base ID\n\n// Delete a Trunk Base Settings object by ID\nDeleteTelephonyProvidersEdgesTrunkbasesettingRequest.deleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTelephonyProvidersEdgesTrunkbasesettingRequest.deleteTelephonyProvidersEdgesTrunkbasesetting was successful\")\n }\n}" - }, - "gettelephonyprovidersedge": { - "operationId": "gettelephonyprovidersedge", - "functionName": "getTelephonyProvidersEdge", - "signature": "getTelephonyProvidersEdge(edgeId, expand)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Edge", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated\n\n// Get edge.\nGetTelephonyProvidersEdgeRequest.getTelephonyProvidersEdge(edgeId: edgeId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeRequest.getTelephonyProvidersEdge was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgediagnosticnslookup": { - "operationId": "gettelephonyprovidersedgediagnosticnslookup", - "functionName": "getTelephonyProvidersEdgeDiagnosticNslookup", - "signature": "getTelephonyProvidersEdgeDiagnosticNslookup(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnosticResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Get networking-related information from an Edge for a target IP or host.\nGetTelephonyProvidersEdgeDiagnosticNslookupRequest.getTelephonyProvidersEdgeDiagnosticNslookup(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeDiagnosticNslookupRequest.getTelephonyProvidersEdgeDiagnosticNslookup was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgediagnosticping": { - "operationId": "gettelephonyprovidersedgediagnosticping", - "functionName": "getTelephonyProvidersEdgeDiagnosticPing", - "signature": "getTelephonyProvidersEdgeDiagnosticPing(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnosticResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Get networking-related information from an Edge for a target IP or host.\nGetTelephonyProvidersEdgeDiagnosticPingRequest.getTelephonyProvidersEdgeDiagnosticPing(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeDiagnosticPingRequest.getTelephonyProvidersEdgeDiagnosticPing was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgediagnosticroute": { - "operationId": "gettelephonyprovidersedgediagnosticroute", - "functionName": "getTelephonyProvidersEdgeDiagnosticRoute", - "signature": "getTelephonyProvidersEdgeDiagnosticRoute(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnosticResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Get networking-related information from an Edge for a target IP or host.\nGetTelephonyProvidersEdgeDiagnosticRouteRequest.getTelephonyProvidersEdgeDiagnosticRoute(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeDiagnosticRouteRequest.getTelephonyProvidersEdgeDiagnosticRoute was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgediagnostictracepath": { - "operationId": "gettelephonyprovidersedgediagnostictracepath", - "functionName": "getTelephonyProvidersEdgeDiagnosticTracepath", - "signature": "getTelephonyProvidersEdgeDiagnosticTracepath(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnosticResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Get networking-related information from an Edge for a target IP or host.\nGetTelephonyProvidersEdgeDiagnosticTracepathRequest.getTelephonyProvidersEdgeDiagnosticTracepath(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeDiagnosticTracepathRequest.getTelephonyProvidersEdgeDiagnosticTracepath was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgelogicalinterface": { - "operationId": "gettelephonyprovidersedgelogicalinterface", - "functionName": "getTelephonyProvidersEdgeLogicalinterface", - "signature": "getTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId, expand)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "interfaceId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "DomainLogicalInterface", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet interfaceId: String = \"\" // Interface ID\nlet expand: [String] = [\"\"] // Field to expand in the response\n\n// Get an edge logical interface\nGetTelephonyProvidersEdgeLogicalinterfaceRequest.getTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeLogicalinterfaceRequest.getTelephonyProvidersEdgeLogicalinterface was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgelogicalinterfaces": { - "operationId": "gettelephonyprovidersedgelogicalinterfaces", - "functionName": "getTelephonyProvidersEdgeLogicalinterfaces", - "signature": "getTelephonyProvidersEdgeLogicalinterfaces(edgeId, expand)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LogicalInterfaceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet expand: [String] = [\"\"] // Field to expand in the response\n\n// Get edge logical interfaces.\nGetTelephonyProvidersEdgeLogicalinterfacesRequest.getTelephonyProvidersEdgeLogicalinterfaces(edgeId: edgeId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeLogicalinterfacesRequest.getTelephonyProvidersEdgeLogicalinterfaces was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgelogsjob": { - "operationId": "gettelephonyprovidersedgelogsjob", - "functionName": "getTelephonyProvidersEdgeLogsJob", - "signature": "getTelephonyProvidersEdgeLogsJob(edgeId, jobId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeLogsJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet jobId: String = \"\" // Job ID\n\n// Get an Edge logs job.\nGetTelephonyProvidersEdgeLogsJobRequest.getTelephonyProvidersEdgeLogsJob(edgeId: edgeId, jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeLogsJobRequest.getTelephonyProvidersEdgeLogsJob was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgemetrics": { - "operationId": "gettelephonyprovidersedgemetrics", - "functionName": "getTelephonyProvidersEdgeMetrics", - "signature": "getTelephonyProvidersEdgeMetrics(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeMetrics", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Get the edge metrics.\nGetTelephonyProvidersEdgeMetricsRequest.getTelephonyProvidersEdgeMetrics(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeMetricsRequest.getTelephonyProvidersEdgeMetrics was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgephysicalinterface": { - "operationId": "gettelephonyprovidersedgephysicalinterface", - "functionName": "getTelephonyProvidersEdgePhysicalinterface", - "signature": "getTelephonyProvidersEdgePhysicalinterface(edgeId, interfaceId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "interfaceId", - "type": "String", - "required": "true" - } - ], - "return": "DomainPhysicalInterface", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet interfaceId: String = \"\" // Interface ID\n\n// Get edge physical interface.\nGetTelephonyProvidersEdgePhysicalinterfaceRequest.getTelephonyProvidersEdgePhysicalinterface(edgeId: edgeId, interfaceId: interfaceId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgePhysicalinterfaceRequest.getTelephonyProvidersEdgePhysicalinterface was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgephysicalinterfaces": { - "operationId": "gettelephonyprovidersedgephysicalinterfaces", - "functionName": "getTelephonyProvidersEdgePhysicalinterfaces", - "signature": "getTelephonyProvidersEdgePhysicalinterfaces(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "PhysicalInterfaceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Retrieve a list of all configured physical interfaces from a specific edge.\nGetTelephonyProvidersEdgePhysicalinterfacesRequest.getTelephonyProvidersEdgePhysicalinterfaces(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgePhysicalinterfacesRequest.getTelephonyProvidersEdgePhysicalinterfaces was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesetuppackage": { - "operationId": "gettelephonyprovidersedgesetuppackage", - "functionName": "getTelephonyProvidersEdgeSetuppackage", - "signature": "getTelephonyProvidersEdgeSetuppackage(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "VmPairingInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.\nGetTelephonyProvidersEdgeSetuppackageRequest.getTelephonyProvidersEdgeSetuppackage(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeSetuppackageRequest.getTelephonyProvidersEdgeSetuppackage was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesoftwareupdate": { - "operationId": "gettelephonyprovidersedgesoftwareupdate", - "functionName": "getTelephonyProvidersEdgeSoftwareupdate", - "signature": "getTelephonyProvidersEdgeSoftwareupdate(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "DomainEdgeSoftwareUpdateDto", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Gets software update status information about any edge.\nGetTelephonyProvidersEdgeSoftwareupdateRequest.getTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeSoftwareupdateRequest.getTelephonyProvidersEdgeSoftwareupdate was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesoftwareversions": { - "operationId": "gettelephonyprovidersedgesoftwareversions", - "functionName": "getTelephonyProvidersEdgeSoftwareversions", - "signature": "getTelephonyProvidersEdgeSoftwareversions(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "DomainEdgeSoftwareVersionDtoEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\n\n// Gets all the available software versions for this edge.\nGetTelephonyProvidersEdgeSoftwareversionsRequest.getTelephonyProvidersEdgeSoftwareversions(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeSoftwareversionsRequest.getTelephonyProvidersEdgeSoftwareversions was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgetrunks": { - "operationId": "gettelephonyprovidersedgetrunks", - "functionName": "getTelephonyProvidersEdgeTrunks", - "signature": "getTelephonyProvidersEdgeTrunks(edgeId, pageNumber, pageSize, sortBy, sortOrder, trunkBaseId, trunkType)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "trunkBaseId", - "type": "String", - "required": "false" - }, - { - "name": "trunkType", - "type": "String", - "required": "false" - } - ], - "return": "TrunkEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Value by which to sort\nlet sortOrder: String = \"\" // Sort order\nlet trunkBaseId: String = \"\" // Filter by Trunk Base Ids\nlet trunkType: GetTelephonyProvidersEdgeTrunksRequest.TrunkType_getTelephonyProvidersEdgeTrunks = GetTelephonyProvidersEdgeTrunksRequest.TrunkType_getTelephonyProvidersEdgeTrunks.enummember // Filter by a Trunk type\n\n// Get the list of available trunks for the given Edge.\nGetTelephonyProvidersEdgeTrunksRequest.getTelephonyProvidersEdgeTrunks(edgeId: edgeId, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, trunkBaseId: trunkBaseId, trunkType: trunkType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgeTrunksRequest.getTelephonyProvidersEdgeTrunks was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedges": { - "operationId": "gettelephonyprovidersedges", - "functionName": "getTelephonyProvidersEdges", - "signature": "getTelephonyProvidersEdges(pageSize, pageNumber, name, siteId, edgeGroupId, sortBy, managed, showCloudMedia)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "siteId", - "type": "String", - "required": "false" - }, - { - "name": "edgeGroupId", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "managed", - "type": "Bool", - "required": "false" - }, - { - "name": "showCloudMedia", - "type": "Bool", - "required": "false" - } - ], - "return": "EdgeEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet siteId: String = \"\" // Filter by site.id\nlet edgeGroupId: String = \"\" // Filter by edgeGroup.id\nlet sortBy: String = \"\" // Sort by\nlet managed: Bool = true // Filter by managed\nlet showCloudMedia: Bool = true // True to show the cloud media devices in the result.\n\n// Get the list of edges.\nGetTelephonyProvidersEdgesRequest.getTelephonyProvidersEdges(pageSize: pageSize, pageNumber: pageNumber, name: name, siteId: siteId, edgeGroupId: edgeGroupId, sortBy: sortBy, managed: managed, showCloudMedia: showCloudMedia) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesRequest.getTelephonyProvidersEdges was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesavailablelanguages": { - "operationId": "gettelephonyprovidersedgesavailablelanguages", - "functionName": "getTelephonyProvidersEdgesAvailablelanguages", - "signature": "getTelephonyProvidersEdgesAvailablelanguages()", - "return": "AvailableLanguageList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of available languages.\nGetTelephonyProvidersEdgesAvailablelanguagesRequest.getTelephonyProvidersEdgesAvailablelanguages() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesAvailablelanguagesRequest.getTelephonyProvidersEdgesAvailablelanguages was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgescertificateauthorities": { - "operationId": "gettelephonyprovidersedgescertificateauthorities", - "functionName": "getTelephonyProvidersEdgesCertificateauthorities", - "signature": "getTelephonyProvidersEdgesCertificateauthorities()", - "return": "CertificateAuthorityEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the list of certificate authorities.\nGetTelephonyProvidersEdgesCertificateauthoritiesRequest.getTelephonyProvidersEdgesCertificateauthorities() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesCertificateauthoritiesRequest.getTelephonyProvidersEdgesCertificateauthorities was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgescertificateauthority": { - "operationId": "gettelephonyprovidersedgescertificateauthority", - "functionName": "getTelephonyProvidersEdgesCertificateauthority", - "signature": "getTelephonyProvidersEdgesCertificateauthority(certificateId)", - "parameters": [ - { - "name": "certificateId", - "type": "String", - "required": "true" - } - ], - "return": "DomainCertificateAuthority", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet certificateId: String = \"\" // Certificate ID\n\n// Get a certificate authority.\nGetTelephonyProvidersEdgesCertificateauthorityRequest.getTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesCertificateauthorityRequest.getTelephonyProvidersEdgesCertificateauthority was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesdid": { - "operationId": "gettelephonyprovidersedgesdid", - "functionName": "getTelephonyProvidersEdgesDid", - "signature": "getTelephonyProvidersEdgesDid(didId)", - "parameters": [ - { - "name": "didId", - "type": "String", - "required": "true" - } - ], - "return": "DID", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet didId: String = \"\" // DID ID\n\n// Get a DID by ID.\nGetTelephonyProvidersEdgesDidRequest.getTelephonyProvidersEdgesDid(didId: didId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesDidRequest.getTelephonyProvidersEdgesDid was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesdidpool": { - "operationId": "gettelephonyprovidersedgesdidpool", - "functionName": "getTelephonyProvidersEdgesDidpool", - "signature": "getTelephonyProvidersEdgesDidpool(didPoolId)", - "parameters": [ - { - "name": "didPoolId", - "type": "String", - "required": "true" - } - ], - "return": "DIDPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet didPoolId: String = \"\" // DID pool ID\n\n// Get a DID Pool by ID.\nGetTelephonyProvidersEdgesDidpoolRequest.getTelephonyProvidersEdgesDidpool(didPoolId: didPoolId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesDidpoolRequest.getTelephonyProvidersEdgesDidpool was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesdidpools": { - "operationId": "gettelephonyprovidersedgesdidpools", - "functionName": "getTelephonyProvidersEdgesDidpools", - "signature": "getTelephonyProvidersEdgesDidpools(pageSize, pageNumber, sortBy, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "DIDPoolEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet _id: [String] = [\"\"] // Filter by a specific list of ID's\n\n// Get a listing of DID Pools\nGetTelephonyProvidersEdgesDidpoolsRequest.getTelephonyProvidersEdgesDidpools(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesDidpoolsRequest.getTelephonyProvidersEdgesDidpools was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesdidpoolsdids": { - "operationId": "gettelephonyprovidersedgesdidpoolsdids", - "functionName": "getTelephonyProvidersEdgesDidpoolsDids", - "signature": "getTelephonyProvidersEdgesDidpoolsDids(type, _id, numberMatch, pageSize, pageNumber, sortOrder)", - "parameters": [ - { - "name": "type", - "type": "String", - "required": "true" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "numberMatch", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - } - ], - "return": "DIDNumberEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet type: GetTelephonyProvidersEdgesDidpoolsDidsRequest.ModelType_getTelephonyProvidersEdgesDidpoolsDids = GetTelephonyProvidersEdgesDidpoolsDidsRequest.ModelType_getTelephonyProvidersEdgesDidpoolsDids.enummember // The type of numbers to return.\nlet _id: [String] = [\"\"] // Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.\nlet numberMatch: String = \"\" // A number to filter the results by.\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: String = \"\" // Sort order\n\n// Get a listing of unassigned and/or assigned numbers in a set of DID Pools.\nGetTelephonyProvidersEdgesDidpoolsDidsRequest.getTelephonyProvidersEdgesDidpoolsDids(type: type, _id: _id, numberMatch: numberMatch, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesDidpoolsDidsRequest.getTelephonyProvidersEdgesDidpoolsDids was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesdids": { - "operationId": "gettelephonyprovidersedgesdids", - "functionName": "getTelephonyProvidersEdgesDids", - "signature": "getTelephonyProvidersEdgesDids(pageSize, pageNumber, sortBy, sortOrder, phoneNumber, ownerId, didPoolId, _id)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "phoneNumber", - "type": "String", - "required": "false" - }, - { - "name": "ownerId", - "type": "String", - "required": "false" - }, - { - "name": "didPoolId", - "type": "String", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - } - ], - "return": "DIDEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet phoneNumber: String = \"\" // Filter by phoneNumber\nlet ownerId: String = \"\" // Filter by the owner of a phone number\nlet didPoolId: String = \"\" // Filter by the DID Pool assignment\nlet _id: [String] = [\"\"] // Filter by a specific list of ID's\n\n// Get a listing of DIDs\nGetTelephonyProvidersEdgesDidsRequest.getTelephonyProvidersEdgesDids(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, phoneNumber: phoneNumber, ownerId: ownerId, didPoolId: didPoolId, _id: _id) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesDidsRequest.getTelephonyProvidersEdgesDids was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesedgegroup": { - "operationId": "gettelephonyprovidersedgesedgegroup", - "functionName": "getTelephonyProvidersEdgesEdgegroup", - "signature": "getTelephonyProvidersEdgesEdgegroup(edgeGroupId, expand)", - "parameters": [ - { - "name": "edgeGroupId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "EdgeGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeGroupId: String = \"\" // Edge group ID\nlet expand: [String] = [\"\"] // Fields to expand in the response\n\n// Get edge group.\nGetTelephonyProvidersEdgesEdgegroupRequest.getTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesEdgegroupRequest.getTelephonyProvidersEdgesEdgegroup was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesedgegroupedgetrunkbase": { - "operationId": "gettelephonyprovidersedgesedgegroupedgetrunkbase", - "functionName": "getTelephonyProvidersEdgesEdgegroupEdgetrunkbase", - "signature": "getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId, edgetrunkbaseId)", - "parameters": [ - { - "name": "edgegroupId", - "type": "String", - "required": "true" - }, - { - "name": "edgetrunkbaseId", - "type": "String", - "required": "true" - } - ], - "return": "EdgeTrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgegroupId: String = \"\" // Edge Group ID\nlet edgetrunkbaseId: String = \"\" // Edge Trunk Base ID\n\n// Gets the edge trunk base associated with the edge group\nGetTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId: edgegroupId, edgetrunkbaseId: edgetrunkbaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.getTelephonyProvidersEdgesEdgegroupEdgetrunkbase was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesedgegroups": { - "operationId": "gettelephonyprovidersedgesedgegroups", - "functionName": "getTelephonyProvidersEdgesEdgegroups", - "signature": "getTelephonyProvidersEdgesEdgegroups(pageSize, pageNumber, name, sortBy, managed)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "managed", - "type": "Bool", - "required": "false" - } - ], - "return": "EdgeGroupEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Sort by\nlet managed: Bool = true // Filter by managed\n\n// Get the list of edge groups.\nGetTelephonyProvidersEdgesEdgegroupsRequest.getTelephonyProvidersEdgesEdgegroups(pageSize: pageSize, pageNumber: pageNumber, name: name, sortBy: sortBy, managed: managed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesEdgegroupsRequest.getTelephonyProvidersEdgesEdgegroups was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesedgeversionreport": { - "operationId": "gettelephonyprovidersedgesedgeversionreport", - "functionName": "getTelephonyProvidersEdgesEdgeversionreport", - "signature": "getTelephonyProvidersEdgesEdgeversionreport()", - "return": "EdgeVersionReport", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the edge version report.\nGetTelephonyProvidersEdgesEdgeversionreportRequest.getTelephonyProvidersEdgesEdgeversionreport() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesEdgeversionreportRequest.getTelephonyProvidersEdgesEdgeversionreport was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesexpired": { - "operationId": "gettelephonyprovidersedgesexpired", - "functionName": "getTelephonyProvidersEdgesExpired", - "signature": "getTelephonyProvidersEdgesExpired()", - "return": "ExpiredEdgeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// List of edges more than 4 edge versions behind the latest software.\nGetTelephonyProvidersEdgesExpiredRequest.getTelephonyProvidersEdgesExpired() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesExpiredRequest.getTelephonyProvidersEdgesExpired was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesextension": { - "operationId": "gettelephonyprovidersedgesextension", - "functionName": "getTelephonyProvidersEdgesExtension", - "signature": "getTelephonyProvidersEdgesExtension(extensionId)", - "parameters": [ - { - "name": "extensionId", - "type": "String", - "required": "true" - } - ], - "return": "Extension", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet extensionId: String = \"\" // Extension ID\n\n// Get an extension by ID.\nGetTelephonyProvidersEdgesExtensionRequest.getTelephonyProvidersEdgesExtension(extensionId: extensionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesExtensionRequest.getTelephonyProvidersEdgesExtension was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesextensionpool": { - "operationId": "gettelephonyprovidersedgesextensionpool", - "functionName": "getTelephonyProvidersEdgesExtensionpool", - "signature": "getTelephonyProvidersEdgesExtensionpool(extensionPoolId)", - "parameters": [ - { - "name": "extensionPoolId", - "type": "String", - "required": "true" - } - ], - "return": "ExtensionPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet extensionPoolId: String = \"\" // Extension pool ID\n\n// Get an extension pool by ID\nGetTelephonyProvidersEdgesExtensionpoolRequest.getTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesExtensionpoolRequest.getTelephonyProvidersEdgesExtensionpool was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesextensionpools": { - "operationId": "gettelephonyprovidersedgesextensionpools", - "functionName": "getTelephonyProvidersEdgesExtensionpools", - "signature": "getTelephonyProvidersEdgesExtensionpools(pageSize, pageNumber, sortBy, number)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "number", - "type": "String", - "required": "false" - } - ], - "return": "ExtensionPoolEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet number: String = \"\" // Deprecated, filtering by number not supported\n\n// Get a listing of extension pools\nGetTelephonyProvidersEdgesExtensionpoolsRequest.getTelephonyProvidersEdgesExtensionpools(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, number: number) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesExtensionpoolsRequest.getTelephonyProvidersEdgesExtensionpools was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesextensions": { - "operationId": "gettelephonyprovidersedgesextensions", - "functionName": "getTelephonyProvidersEdgesExtensions", - "signature": "getTelephonyProvidersEdgesExtensions(pageSize, pageNumber, sortBy, sortOrder, number)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "number", - "type": "String", - "required": "false" - } - ], - "return": "ExtensionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet number: String = \"\" // Filter by number\n\n// Get a listing of extensions\nGetTelephonyProvidersEdgesExtensionsRequest.getTelephonyProvidersEdgesExtensions(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, number: number) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesExtensionsRequest.getTelephonyProvidersEdgesExtensions was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesline": { - "operationId": "gettelephonyprovidersedgesline", - "functionName": "getTelephonyProvidersEdgesLine", - "signature": "getTelephonyProvidersEdgesLine(lineId)", - "parameters": [ - { - "name": "lineId", - "type": "String", - "required": "true" - } - ], - "return": "Line", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet lineId: String = \"\" // Line ID\n\n// Get a Line by ID\nGetTelephonyProvidersEdgesLineRequest.getTelephonyProvidersEdgesLine(lineId: lineId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLineRequest.getTelephonyProvidersEdgesLine was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgeslinebasesetting": { - "operationId": "gettelephonyprovidersedgeslinebasesetting", - "functionName": "getTelephonyProvidersEdgesLinebasesetting", - "signature": "getTelephonyProvidersEdgesLinebasesetting(lineBaseId)", - "parameters": [ - { - "name": "lineBaseId", - "type": "String", - "required": "true" - } - ], - "return": "LineBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet lineBaseId: String = \"\" // Line base ID\n\n// Get a line base settings object by ID\nGetTelephonyProvidersEdgesLinebasesettingRequest.getTelephonyProvidersEdgesLinebasesetting(lineBaseId: lineBaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLinebasesettingRequest.getTelephonyProvidersEdgesLinebasesetting was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgeslinebasesettings": { - "operationId": "gettelephonyprovidersedgeslinebasesettings", - "functionName": "getTelephonyProvidersEdgesLinebasesettings", - "signature": "getTelephonyProvidersEdgesLinebasesettings(pageNumber, pageSize, sortBy, sortOrder, expand)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LineBaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Value by which to sort\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated\n\n// Get a listing of line base settings objects\nGetTelephonyProvidersEdgesLinebasesettingsRequest.getTelephonyProvidersEdgesLinebasesettings(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLinebasesettingsRequest.getTelephonyProvidersEdgesLinebasesettings was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgeslines": { - "operationId": "gettelephonyprovidersedgeslines", - "functionName": "getTelephonyProvidersEdgesLines", - "signature": "getTelephonyProvidersEdgesLines(pageSize, pageNumber, name, sortBy, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LineEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet sortBy: String = \"\" // Value by which to sort\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated. The edgeGroup value is deprecated.\n\n// Get a list of Lines\nGetTelephonyProvidersEdgesLinesRequest.getTelephonyProvidersEdgesLines(pageSize: pageSize, pageNumber: pageNumber, name: name, sortBy: sortBy, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLinesRequest.getTelephonyProvidersEdgesLines was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgeslinestemplate": { - "operationId": "gettelephonyprovidersedgeslinestemplate", - "functionName": "getTelephonyProvidersEdgesLinesTemplate", - "signature": "getTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId)", - "parameters": [ - { - "name": "lineBaseSettingsId", - "type": "String", - "required": "true" - } - ], - "return": "Line", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet lineBaseSettingsId: String = \"\" // The id of a Line Base Settings object upon which to base this Line\n\n// 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\nGetTelephonyProvidersEdgesLinesTemplateRequest.getTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId: lineBaseSettingsId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLinesTemplateRequest.getTelephonyProvidersEdgesLinesTemplate was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgeslogicalinterfaces": { - "operationId": "gettelephonyprovidersedgeslogicalinterfaces", - "functionName": "getTelephonyProvidersEdgesLogicalinterfaces", - "signature": "getTelephonyProvidersEdgesLogicalinterfaces(edgeIds, expand)", - "parameters": [ - { - "name": "edgeIds", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "LogicalInterfaceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeIds: String = \"\" // Comma separated list of Edge Id's\nlet expand: [String] = [\"\"] // Field to expand in the response\n\n// Get edge logical interfaces.\nGetTelephonyProvidersEdgesLogicalinterfacesRequest.getTelephonyProvidersEdgesLogicalinterfaces(edgeIds: edgeIds, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesLogicalinterfacesRequest.getTelephonyProvidersEdgesLogicalinterfaces was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesmetrics": { - "operationId": "gettelephonyprovidersedgesmetrics", - "functionName": "getTelephonyProvidersEdgesMetrics", - "signature": "getTelephonyProvidersEdgesMetrics(edgeIds)", - "parameters": [ - { - "name": "edgeIds", - "type": "String", - "required": "true" - } - ], - "return": "[EdgeMetrics]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeIds: String = \"\" // Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.\n\n// Get the metrics for a list of edges.\nGetTelephonyProvidersEdgesMetricsRequest.getTelephonyProvidersEdgesMetrics(edgeIds: edgeIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesMetricsRequest.getTelephonyProvidersEdgesMetrics was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesoutboundroute": { - "operationId": "gettelephonyprovidersedgesoutboundroute", - "functionName": "getTelephonyProvidersEdgesOutboundroute", - "signature": "getTelephonyProvidersEdgesOutboundroute(outboundRouteId)", - "parameters": [ - { - "name": "outboundRouteId", - "type": "String", - "required": "true" - } - ], - "return": "OutboundRoute", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet outboundRouteId: String = \"\" // Outbound route ID\n\n// Get outbound route\nGetTelephonyProvidersEdgesOutboundrouteRequest.getTelephonyProvidersEdgesOutboundroute(outboundRouteId: outboundRouteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesOutboundrouteRequest.getTelephonyProvidersEdgesOutboundroute was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesoutboundroutes": { - "operationId": "gettelephonyprovidersedgesoutboundroutes", - "functionName": "getTelephonyProvidersEdgesOutboundroutes", - "signature": "getTelephonyProvidersEdgesOutboundroutes(pageSize, pageNumber, name, siteId, externalTrunkBasesIds, sortBy)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "siteId", - "type": "String", - "required": "false" - }, - { - "name": "externalTrunkBasesIds", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - } - ], - "return": "OutboundRouteEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet siteId: String = \"\" // Filter by site.id\nlet externalTrunkBasesIds: String = \"\" // Filter by externalTrunkBases.ids\nlet sortBy: String = \"\" // Sort by\n\n// Get outbound routes\nGetTelephonyProvidersEdgesOutboundroutesRequest.getTelephonyProvidersEdgesOutboundroutes(pageSize: pageSize, pageNumber: pageNumber, name: name, siteId: siteId, externalTrunkBasesIds: externalTrunkBasesIds, sortBy: sortBy) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesOutboundroutesRequest.getTelephonyProvidersEdgesOutboundroutes was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphone": { - "operationId": "gettelephonyprovidersedgesphone", - "functionName": "getTelephonyProvidersEdgesPhone", - "signature": "getTelephonyProvidersEdgesPhone(phoneId)", - "parameters": [ - { - "name": "phoneId", - "type": "String", - "required": "true" - } - ], - "return": "Phone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneId: String = \"\" // Phone ID\n\n// Get a Phone by ID\nGetTelephonyProvidersEdgesPhoneRequest.getTelephonyProvidersEdgesPhone(phoneId: phoneId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhoneRequest.getTelephonyProvidersEdgesPhone was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphonebasesetting": { - "operationId": "gettelephonyprovidersedgesphonebasesetting", - "functionName": "getTelephonyProvidersEdgesPhonebasesetting", - "signature": "getTelephonyProvidersEdgesPhonebasesetting(phoneBaseId)", - "parameters": [ - { - "name": "phoneBaseId", - "type": "String", - "required": "true" - } - ], - "return": "PhoneBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneBaseId: String = \"\" // Phone base ID\n\n// Get a Phone Base Settings object by ID\nGetTelephonyProvidersEdgesPhonebasesettingRequest.getTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonebasesettingRequest.getTelephonyProvidersEdgesPhonebasesetting was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphonebasesettings": { - "operationId": "gettelephonyprovidersedgesphonebasesettings", - "functionName": "getTelephonyProvidersEdgesPhonebasesettings", - "signature": "getTelephonyProvidersEdgesPhonebasesettings(pageSize, pageNumber, sortBy, sortOrder, expand, name)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "PhoneBaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Value by which to sort\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated\nlet name: String = \"\" // Name\n\n// Get a list of Phone Base Settings objects\nGetTelephonyProvidersEdgesPhonebasesettingsRequest.getTelephonyProvidersEdgesPhonebasesettings(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, expand: expand, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonebasesettingsRequest.getTelephonyProvidersEdgesPhonebasesettings was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphonebasesettingsavailablemetabases": { - "operationId": "gettelephonyprovidersedgesphonebasesettingsavailablemetabases", - "functionName": "getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases", - "signature": "getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "PhoneMetaBaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of available makes and models to create a new Phone Base Settings\nGetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphonebasesettingstemplate": { - "operationId": "gettelephonyprovidersedgesphonebasesettingstemplate", - "functionName": "getTelephonyProvidersEdgesPhonebasesettingsTemplate", - "signature": "getTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId)", - "parameters": [ - { - "name": "phoneMetabaseId", - "type": "String", - "required": "true" - } - ], - "return": "PhoneBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneMetabaseId: String = \"\" // The id of a metabase object upon which to base this Phone Base Settings\n\n// 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\nGetTelephonyProvidersEdgesPhonebasesettingsTemplateRequest.getTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId: phoneMetabaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonebasesettingsTemplateRequest.getTelephonyProvidersEdgesPhonebasesettingsTemplate was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphones": { - "operationId": "gettelephonyprovidersedgesphones", - "functionName": "getTelephonyProvidersEdgesPhones", - "signature": "getTelephonyProvidersEdgesPhones(pageNumber, pageSize, sortBy, sortOrder, siteId, webRtcUserId, phoneBaseSettingsId, linesLoggedInUserId, linesDefaultForUserId, phoneHardwareId, linesId, linesName, name, statusOperationalStatus, secondaryStatusOperationalStatus, expand, fields)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "siteId", - "type": "String", - "required": "false" - }, - { - "name": "webRtcUserId", - "type": "String", - "required": "false" - }, - { - "name": "phoneBaseSettingsId", - "type": "String", - "required": "false" - }, - { - "name": "linesLoggedInUserId", - "type": "String", - "required": "false" - }, - { - "name": "linesDefaultForUserId", - "type": "String", - "required": "false" - }, - { - "name": "phoneHardwareId", - "type": "String", - "required": "false" - }, - { - "name": "linesId", - "type": "String", - "required": "false" - }, - { - "name": "linesName", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "statusOperationalStatus", - "type": "String", - "required": "false" - }, - { - "name": "secondaryStatusOperationalStatus", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "fields", - "type": "[String]", - "required": "false" - } - ], - "return": "PhoneEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: GetTelephonyProvidersEdgesPhonesRequest.SortBy_getTelephonyProvidersEdgesPhones = GetTelephonyProvidersEdgesPhonesRequest.SortBy_getTelephonyProvidersEdgesPhones.enummember // The field to sort by\nlet sortOrder: String = \"\" // Sort order\nlet siteId: String = \"\" // Filter by site.id\nlet webRtcUserId: String = \"\" // Filter by webRtcUser.id\nlet phoneBaseSettingsId: String = \"\" // Filter by phoneBaseSettings.id\nlet linesLoggedInUserId: String = \"\" // Filter by lines.loggedInUser.id\nlet linesDefaultForUserId: String = \"\" // Filter by lines.defaultForUser.id\nlet phoneHardwareId: String = \"\" // Filter by phone_hardwareId\nlet linesId: String = \"\" // Filter by lines.id\nlet linesName: String = \"\" // Filter by lines.name\nlet name: String = \"\" // Name of the Phone to filter by, comma-separated\nlet statusOperationalStatus: String = \"\" // The primary status to filter by\nlet secondaryStatusOperationalStatus: String = \"\" // The secondary status to filter by\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated\nlet fields: [String] = [\"\"] // Fields and properties to get, comma-separated\n\n// Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.\nGetTelephonyProvidersEdgesPhonesRequest.getTelephonyProvidersEdgesPhones(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, siteId: siteId, webRtcUserId: webRtcUserId, phoneBaseSettingsId: phoneBaseSettingsId, linesLoggedInUserId: linesLoggedInUserId, linesDefaultForUserId: linesDefaultForUserId, phoneHardwareId: phoneHardwareId, linesId: linesId, linesName: linesName, name: name, statusOperationalStatus: statusOperationalStatus, secondaryStatusOperationalStatus: secondaryStatusOperationalStatus, expand: expand, fields: fields) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonesRequest.getTelephonyProvidersEdgesPhones was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphonestemplate": { - "operationId": "gettelephonyprovidersedgesphonestemplate", - "functionName": "getTelephonyProvidersEdgesPhonesTemplate", - "signature": "getTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId)", - "parameters": [ - { - "name": "phoneBaseSettingsId", - "type": "String", - "required": "true" - } - ], - "return": "Phone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneBaseSettingsId: String = \"\" // The id of a Phone Base Settings object upon which to base this Phone\n\n// 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\nGetTelephonyProvidersEdgesPhonesTemplateRequest.getTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId: phoneBaseSettingsId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhonesTemplateRequest.getTelephonyProvidersEdgesPhonesTemplate was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgesphysicalinterfaces": { - "operationId": "gettelephonyprovidersedgesphysicalinterfaces", - "functionName": "getTelephonyProvidersEdgesPhysicalinterfaces", - "signature": "getTelephonyProvidersEdgesPhysicalinterfaces(edgeIds)", - "parameters": [ - { - "name": "edgeIds", - "type": "String", - "required": "true" - } - ], - "return": "PhysicalInterfaceEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeIds: String = \"\" // Comma separated list of Edge Id's\n\n// Get physical interfaces for edges.\nGetTelephonyProvidersEdgesPhysicalinterfacesRequest.getTelephonyProvidersEdgesPhysicalinterfaces(edgeIds: edgeIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesPhysicalinterfacesRequest.getTelephonyProvidersEdgesPhysicalinterfaces was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessite": { - "operationId": "gettelephonyprovidersedgessite", - "functionName": "getTelephonyProvidersEdgesSite", - "signature": "getTelephonyProvidersEdgesSite(siteId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - } - ], - "return": "Site", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\n\n// Get a Site by ID.\nGetTelephonyProvidersEdgesSiteRequest.getTelephonyProvidersEdgesSite(siteId: siteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteRequest.getTelephonyProvidersEdgesSite was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessitenumberplan": { - "operationId": "gettelephonyprovidersedgessitenumberplan", - "functionName": "getTelephonyProvidersEdgesSiteNumberplan", - "signature": "getTelephonyProvidersEdgesSiteNumberplan(siteId, numberPlanId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "numberPlanId", - "type": "String", - "required": "true" - } - ], - "return": "NumberPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet numberPlanId: String = \"\" // Number Plan ID\n\n// Get a Number Plan by ID.\nGetTelephonyProvidersEdgesSiteNumberplanRequest.getTelephonyProvidersEdgesSiteNumberplan(siteId: siteId, numberPlanId: numberPlanId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteNumberplanRequest.getTelephonyProvidersEdgesSiteNumberplan was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessitenumberplans": { - "operationId": "gettelephonyprovidersedgessitenumberplans", - "functionName": "getTelephonyProvidersEdgesSiteNumberplans", - "signature": "getTelephonyProvidersEdgesSiteNumberplans(siteId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - } - ], - "return": "[NumberPlan]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\n\n// Get the list of Number Plans for this Site. Only fetches the first 200 records.\nGetTelephonyProvidersEdgesSiteNumberplansRequest.getTelephonyProvidersEdgesSiteNumberplans(siteId: siteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteNumberplansRequest.getTelephonyProvidersEdgesSiteNumberplans was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessitenumberplansclassifications": { - "operationId": "gettelephonyprovidersedgessitenumberplansclassifications", - "functionName": "getTelephonyProvidersEdgesSiteNumberplansClassifications", - "signature": "getTelephonyProvidersEdgesSiteNumberplansClassifications(siteId, classification)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "classification", - "type": "String", - "required": "false" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet classification: String = \"\" // Classification\n\n// Get a list of Classifications for this Site\nGetTelephonyProvidersEdgesSiteNumberplansClassificationsRequest.getTelephonyProvidersEdgesSiteNumberplansClassifications(siteId: siteId, classification: classification) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteNumberplansClassificationsRequest.getTelephonyProvidersEdgesSiteNumberplansClassifications was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessiteoutboundroute": { - "operationId": "gettelephonyprovidersedgessiteoutboundroute", - "functionName": "getTelephonyProvidersEdgesSiteOutboundroute", - "signature": "getTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "outboundRouteId", - "type": "String", - "required": "true" - } - ], - "return": "OutboundRouteBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet outboundRouteId: String = \"\" // Outbound route ID\n\n// Get an outbound route\nGetTelephonyProvidersEdgesSiteOutboundrouteRequest.getTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteOutboundrouteRequest.getTelephonyProvidersEdgesSiteOutboundroute was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessiteoutboundroutes": { - "operationId": "gettelephonyprovidersedgessiteoutboundroutes", - "functionName": "getTelephonyProvidersEdgesSiteOutboundroutes", - "signature": "getTelephonyProvidersEdgesSiteOutboundroutes(siteId, pageSize, pageNumber, name, externalTrunkBasesIds, sortBy)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "externalTrunkBasesIds", - "type": "String", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - } - ], - "return": "OutboundRouteBaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet name: String = \"\" // Name\nlet externalTrunkBasesIds: String = \"\" // externalTrunkBases.ids\nlet sortBy: String = \"\" // Sort by\n\n// Get outbound routes\nGetTelephonyProvidersEdgesSiteOutboundroutesRequest.getTelephonyProvidersEdgesSiteOutboundroutes(siteId: siteId, pageSize: pageSize, pageNumber: pageNumber, name: name, externalTrunkBasesIds: externalTrunkBasesIds, sortBy: sortBy) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSiteOutboundroutesRequest.getTelephonyProvidersEdgesSiteOutboundroutes was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgessites": { - "operationId": "gettelephonyprovidersedgessites", - "functionName": "getTelephonyProvidersEdgesSites", - "signature": "getTelephonyProvidersEdgesSites(pageSize, pageNumber, sortBy, sortOrder, name, locationId, managed)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - }, - { - "name": "locationId", - "type": "String", - "required": "false" - }, - { - "name": "managed", - "type": "Bool", - "required": "false" - } - ], - "return": "SiteEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortBy: String = \"\" // Sort by\nlet sortOrder: String = \"\" // Sort order\nlet name: String = \"\" // Name\nlet locationId: String = \"\" // Location Id\nlet managed: Bool = true // Filter by managed\n\n// Get the list of Sites.\nGetTelephonyProvidersEdgesSitesRequest.getTelephonyProvidersEdgesSites(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, locationId: locationId, managed: managed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesSitesRequest.getTelephonyProvidersEdgesSites was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestimezones": { - "operationId": "gettelephonyprovidersedgestimezones", - "functionName": "getTelephonyProvidersEdgesTimezones", - "signature": "getTelephonyProvidersEdgesTimezones(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TimeZoneEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get a list of Edge-compatible time zones\nGetTelephonyProvidersEdgesTimezonesRequest.getTelephonyProvidersEdgesTimezones(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTimezonesRequest.getTelephonyProvidersEdgesTimezones was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunk": { - "operationId": "gettelephonyprovidersedgestrunk", - "functionName": "getTelephonyProvidersEdgesTrunk", - "signature": "getTelephonyProvidersEdgesTrunk(trunkId)", - "parameters": [ - { - "name": "trunkId", - "type": "String", - "required": "true" - } - ], - "return": "Trunk", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkId: String = \"\" // Trunk ID\n\n// Get a Trunk by ID\nGetTelephonyProvidersEdgesTrunkRequest.getTelephonyProvidersEdgesTrunk(trunkId: trunkId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkRequest.getTelephonyProvidersEdgesTrunk was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkmetrics": { - "operationId": "gettelephonyprovidersedgestrunkmetrics", - "functionName": "getTelephonyProvidersEdgesTrunkMetrics", - "signature": "getTelephonyProvidersEdgesTrunkMetrics(trunkId)", - "parameters": [ - { - "name": "trunkId", - "type": "String", - "required": "true" - } - ], - "return": "TrunkMetrics", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkId: String = \"\" // Trunk Id\n\n// Get the trunk metrics.\nGetTelephonyProvidersEdgesTrunkMetricsRequest.getTelephonyProvidersEdgesTrunkMetrics(trunkId: trunkId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkMetricsRequest.getTelephonyProvidersEdgesTrunkMetrics was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkbasesetting": { - "operationId": "gettelephonyprovidersedgestrunkbasesetting", - "functionName": "getTelephonyProvidersEdgesTrunkbasesetting", - "signature": "getTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId, ignoreHidden)", - "parameters": [ - { - "name": "trunkBaseSettingsId", - "type": "String", - "required": "true" - }, - { - "name": "ignoreHidden", - "type": "Bool", - "required": "false" - } - ], - "return": "TrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkBaseSettingsId: String = \"\" // Trunk Base ID\nlet ignoreHidden: Bool = true // Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.\n\n// Get a Trunk Base Settings object by ID\nGetTelephonyProvidersEdgesTrunkbasesettingRequest.getTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId, ignoreHidden: ignoreHidden) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkbasesettingRequest.getTelephonyProvidersEdgesTrunkbasesetting was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkbasesettings": { - "operationId": "gettelephonyprovidersedgestrunkbasesettings", - "functionName": "getTelephonyProvidersEdgesTrunkbasesettings", - "signature": "getTelephonyProvidersEdgesTrunkbasesettings(pageNumber, pageSize, sortBy, sortOrder, recordingEnabled, ignoreHidden, managed, expand, name)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "recordingEnabled", - "type": "Bool", - "required": "false" - }, - { - "name": "ignoreHidden", - "type": "Bool", - "required": "false" - }, - { - "name": "managed", - "type": "Bool", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "name", - "type": "String", - "required": "false" - } - ], - "return": "TrunkBaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Value by which to sort\nlet sortOrder: String = \"\" // Sort order\nlet recordingEnabled: Bool = true // Filter trunks by recording enabled\nlet ignoreHidden: Bool = true // Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.\nlet managed: Bool = true // Filter by managed\nlet expand: [String] = [\"\"] // Fields to expand in the response, comma-separated\nlet name: String = \"\" // Name of the TrunkBase to filter by\n\n// Get Trunk Base Settings listing\nGetTelephonyProvidersEdgesTrunkbasesettingsRequest.getTelephonyProvidersEdgesTrunkbasesettings(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, recordingEnabled: recordingEnabled, ignoreHidden: ignoreHidden, managed: managed, expand: expand, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkbasesettingsRequest.getTelephonyProvidersEdgesTrunkbasesettings was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkbasesettingsavailablemetabases": { - "operationId": "gettelephonyprovidersedgestrunkbasesettingsavailablemetabases", - "functionName": "getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases", - "signature": "getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(type, pageSize, pageNumber)", - "parameters": [ - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrunkMetabaseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet type: GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.ModelType_getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases = GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.ModelType_getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases.enummember // \nlet pageSize: Int = 0 // \nlet pageNumber: Int = 0 // \n\n// Get a list of available makes and models to create a new Trunk Base Settings\nGetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(type: type, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkbasesettingstemplate": { - "operationId": "gettelephonyprovidersedgestrunkbasesettingstemplate", - "functionName": "getTelephonyProvidersEdgesTrunkbasesettingsTemplate", - "signature": "getTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId)", - "parameters": [ - { - "name": "trunkMetabaseId", - "type": "String", - "required": "true" - } - ], - "return": "TrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkMetabaseId: String = \"\" // The id of a metabase object upon which to base this Trunk Base Settings\n\n// 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\nGetTelephonyProvidersEdgesTrunkbasesettingsTemplateRequest.getTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId: trunkMetabaseId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkbasesettingsTemplateRequest.getTelephonyProvidersEdgesTrunkbasesettingsTemplate was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunks": { - "operationId": "gettelephonyprovidersedgestrunks", - "functionName": "getTelephonyProvidersEdgesTrunks", - "signature": "getTelephonyProvidersEdgesTrunks(pageNumber, pageSize, sortBy, sortOrder, edgeId, trunkBaseId, trunkType)", - "parameters": [ - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "sortBy", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "edgeId", - "type": "String", - "required": "false" - }, - { - "name": "trunkBaseId", - "type": "String", - "required": "false" - }, - { - "name": "trunkType", - "type": "String", - "required": "false" - } - ], - "return": "TrunkEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageNumber: Int = 0 // Page number\nlet pageSize: Int = 0 // Page size\nlet sortBy: String = \"\" // Value by which to sort\nlet sortOrder: String = \"\" // Sort order\nlet edgeId: String = \"\" // Filter by Edge Ids\nlet trunkBaseId: String = \"\" // Filter by Trunk Base Ids\nlet trunkType: GetTelephonyProvidersEdgesTrunksRequest.TrunkType_getTelephonyProvidersEdgesTrunks = GetTelephonyProvidersEdgesTrunksRequest.TrunkType_getTelephonyProvidersEdgesTrunks.enummember // Filter by a Trunk type\n\n// Get the list of available trunks.\nGetTelephonyProvidersEdgesTrunksRequest.getTelephonyProvidersEdgesTrunks(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, edgeId: edgeId, trunkBaseId: trunkBaseId, trunkType: trunkType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunksRequest.getTelephonyProvidersEdgesTrunks was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunksmetrics": { - "operationId": "gettelephonyprovidersedgestrunksmetrics", - "functionName": "getTelephonyProvidersEdgesTrunksMetrics", - "signature": "getTelephonyProvidersEdgesTrunksMetrics(trunkIds)", - "parameters": [ - { - "name": "trunkIds", - "type": "String", - "required": "true" - } - ], - "return": "[TrunkMetrics]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkIds: String = \"\" // Comma separated list of Trunk Id's\n\n// Get the metrics for a list of trunks.\nGetTelephonyProvidersEdgesTrunksMetricsRequest.getTelephonyProvidersEdgesTrunksMetrics(trunkIds: trunkIds) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunksMetricsRequest.getTelephonyProvidersEdgesTrunksMetrics was successful\")\n dump(response)\n }\n}" - }, - "gettelephonyprovidersedgestrunkswithrecording": { - "operationId": "gettelephonyprovidersedgestrunkswithrecording", - "functionName": "getTelephonyProvidersEdgesTrunkswithrecording", - "signature": "getTelephonyProvidersEdgesTrunkswithrecording(trunkType)", - "parameters": [ - { - "name": "trunkType", - "type": "String", - "required": "false" - } - ], - "return": "TrunkRecordingEnabledCount", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkType: GetTelephonyProvidersEdgesTrunkswithrecordingRequest.TrunkType_getTelephonyProvidersEdgesTrunkswithrecording = GetTelephonyProvidersEdgesTrunkswithrecordingRequest.TrunkType_getTelephonyProvidersEdgesTrunkswithrecording.enummember // The type of this trunk base.\n\n// Get Counts of trunks that have recording disabled or enabled\nGetTelephonyProvidersEdgesTrunkswithrecordingRequest.getTelephonyProvidersEdgesTrunkswithrecording(trunkType: trunkType) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTelephonyProvidersEdgesTrunkswithrecordingRequest.getTelephonyProvidersEdgesTrunkswithrecording was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgediagnosticnslookup": { - "operationId": "posttelephonyprovidersedgediagnosticnslookup", - "functionName": "postTelephonyProvidersEdgeDiagnosticNslookup", - "signature": "postTelephonyProvidersEdgeDiagnosticNslookup(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeNetworkDiagnosticRequest", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnostic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\nlet body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic\n\n// Nslookup request command to collect networking-related information from an Edge for a target IP or host.\nPostTelephonyProvidersEdgeDiagnosticNslookupRequest.postTelephonyProvidersEdgeDiagnosticNslookup(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeDiagnosticNslookupRequest.postTelephonyProvidersEdgeDiagnosticNslookup was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgediagnosticping": { - "operationId": "posttelephonyprovidersedgediagnosticping", - "functionName": "postTelephonyProvidersEdgeDiagnosticPing", - "signature": "postTelephonyProvidersEdgeDiagnosticPing(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeNetworkDiagnosticRequest", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnostic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\nlet body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic\n\n// Ping Request command to collect networking-related information from an Edge for a target IP or host.\nPostTelephonyProvidersEdgeDiagnosticPingRequest.postTelephonyProvidersEdgeDiagnosticPing(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeDiagnosticPingRequest.postTelephonyProvidersEdgeDiagnosticPing was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgediagnosticroute": { - "operationId": "posttelephonyprovidersedgediagnosticroute", - "functionName": "postTelephonyProvidersEdgeDiagnosticRoute", - "signature": "postTelephonyProvidersEdgeDiagnosticRoute(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeNetworkDiagnosticRequest", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnostic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\nlet body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic\n\n// Route request command to collect networking-related information from an Edge for a target IP or host.\nPostTelephonyProvidersEdgeDiagnosticRouteRequest.postTelephonyProvidersEdgeDiagnosticRoute(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeDiagnosticRouteRequest.postTelephonyProvidersEdgeDiagnosticRoute was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgediagnostictracepath": { - "operationId": "posttelephonyprovidersedgediagnostictracepath", - "functionName": "postTelephonyProvidersEdgeDiagnosticTracepath", - "signature": "postTelephonyProvidersEdgeDiagnosticTracepath(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeNetworkDiagnosticRequest", - "required": "true" - } - ], - "return": "EdgeNetworkDiagnostic", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\nlet body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic\n\n// Tracepath request command to collect networking-related information from an Edge for a target IP or host.\nPostTelephonyProvidersEdgeDiagnosticTracepathRequest.postTelephonyProvidersEdgeDiagnosticTracepath(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeDiagnosticTracepathRequest.postTelephonyProvidersEdgeDiagnosticTracepath was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgelogicalinterfaces": { - "operationId": "posttelephonyprovidersedgelogicalinterfaces", - "functionName": "postTelephonyProvidersEdgeLogicalinterfaces", - "signature": "postTelephonyProvidersEdgeLogicalinterfaces(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainLogicalInterface", - "required": "true" - } - ], - "return": "DomainLogicalInterface", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: DomainLogicalInterface = new DomainLogicalInterface(...) // Logical interface\n\n// Create an edge logical interface.\nPostTelephonyProvidersEdgeLogicalinterfacesRequest.postTelephonyProvidersEdgeLogicalinterfaces(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeLogicalinterfacesRequest.postTelephonyProvidersEdgeLogicalinterfaces was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgelogsjobupload": { - "operationId": "posttelephonyprovidersedgelogsjobupload", - "functionName": "postTelephonyProvidersEdgeLogsJobUpload", - "signature": "postTelephonyProvidersEdgeLogsJobUpload(edgeId, jobId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "jobId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeLogsJobUploadRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet jobId: String = \"\" // Job ID\nlet body: EdgeLogsJobUploadRequest = new EdgeLogsJobUploadRequest(...) // Log upload request\n\n// Request that the specified fileIds be uploaded from the Edge.\nPostTelephonyProvidersEdgeLogsJobUploadRequest.postTelephonyProvidersEdgeLogsJobUpload(edgeId: edgeId, jobId: jobId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostTelephonyProvidersEdgeLogsJobUploadRequest.postTelephonyProvidersEdgeLogsJobUpload was successful\")\n }\n}" - }, - "posttelephonyprovidersedgelogsjobs": { - "operationId": "posttelephonyprovidersedgelogsjobs", - "functionName": "postTelephonyProvidersEdgeLogsJobs", - "signature": "postTelephonyProvidersEdgeLogsJobs(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeLogsJobRequest", - "required": "true" - } - ], - "return": "EdgeLogsJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: EdgeLogsJobRequest = new EdgeLogsJobRequest(...) // EdgeLogsJobRequest\n\n// Create a job to upload a list of Edge logs.\nPostTelephonyProvidersEdgeLogsJobsRequest.postTelephonyProvidersEdgeLogsJobs(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeLogsJobsRequest.postTelephonyProvidersEdgeLogsJobs was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgereboot": { - "operationId": "posttelephonyprovidersedgereboot", - "functionName": "postTelephonyProvidersEdgeReboot", - "signature": "postTelephonyProvidersEdgeReboot(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeRebootParameters", - "required": "false" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: EdgeRebootParameters = new EdgeRebootParameters(...) // Parameters for the edge reboot\n\n// Reboot an Edge\nPostTelephonyProvidersEdgeRebootRequest.postTelephonyProvidersEdgeReboot(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeRebootRequest.postTelephonyProvidersEdgeReboot was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesoftwareupdate": { - "operationId": "posttelephonyprovidersedgesoftwareupdate", - "functionName": "postTelephonyProvidersEdgeSoftwareupdate", - "signature": "postTelephonyProvidersEdgeSoftwareupdate(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainEdgeSoftwareUpdateDto", - "required": "true" - } - ], - "return": "DomainEdgeSoftwareUpdateDto", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: DomainEdgeSoftwareUpdateDto = new DomainEdgeSoftwareUpdateDto(...) // Software update request\n\n// Starts a software update for this edge.\nPostTelephonyProvidersEdgeSoftwareupdateRequest.postTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeSoftwareupdateRequest.postTelephonyProvidersEdgeSoftwareupdate was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgestatuscode": { - "operationId": "posttelephonyprovidersedgestatuscode", - "functionName": "postTelephonyProvidersEdgeStatuscode", - "signature": "postTelephonyProvidersEdgeStatuscode(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeServiceStateRequest", - "required": "false" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: EdgeServiceStateRequest = new EdgeServiceStateRequest(...) // Edge Service State\n\n// Take an Edge in or out of service\nPostTelephonyProvidersEdgeStatuscodeRequest.postTelephonyProvidersEdgeStatuscode(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeStatuscodeRequest.postTelephonyProvidersEdgeStatuscode was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgeunpair": { - "operationId": "posttelephonyprovidersedgeunpair", - "functionName": "postTelephonyProvidersEdgeUnpair", - "signature": "postTelephonyProvidersEdgeUnpair(edgeId)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge Id\n\n// Unpair an Edge\nPostTelephonyProvidersEdgeUnpairRequest.postTelephonyProvidersEdgeUnpair(edgeId: edgeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgeUnpairRequest.postTelephonyProvidersEdgeUnpair was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedges": { - "operationId": "posttelephonyprovidersedges", - "functionName": "postTelephonyProvidersEdges", - "signature": "postTelephonyProvidersEdges(body)", - "parameters": [ - { - "name": "body", - "type": "Edge", - "required": "true" - } - ], - "return": "Edge", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Edge = new Edge(...) // Edge\n\n// Create an edge.\nPostTelephonyProvidersEdgesRequest.postTelephonyProvidersEdges(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesRequest.postTelephonyProvidersEdges was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesaddressvalidation": { - "operationId": "posttelephonyprovidersedgesaddressvalidation", - "functionName": "postTelephonyProvidersEdgesAddressvalidation", - "signature": "postTelephonyProvidersEdgesAddressvalidation(body)", - "parameters": [ - { - "name": "body", - "type": "ValidateAddressRequest", - "required": "true" - } - ], - "return": "ValidateAddressResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ValidateAddressRequest = new ValidateAddressRequest(...) // Address\n\n// Validates a street address\nPostTelephonyProvidersEdgesAddressvalidationRequest.postTelephonyProvidersEdgesAddressvalidation(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesAddressvalidationRequest.postTelephonyProvidersEdgesAddressvalidation was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgescertificateauthorities": { - "operationId": "posttelephonyprovidersedgescertificateauthorities", - "functionName": "postTelephonyProvidersEdgesCertificateauthorities", - "signature": "postTelephonyProvidersEdgesCertificateauthorities(body)", - "parameters": [ - { - "name": "body", - "type": "DomainCertificateAuthority", - "required": "true" - } - ], - "return": "DomainCertificateAuthority", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DomainCertificateAuthority = new DomainCertificateAuthority(...) // CertificateAuthority\n\n// Create a certificate authority.\nPostTelephonyProvidersEdgesCertificateauthoritiesRequest.postTelephonyProvidersEdgesCertificateauthorities(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesCertificateauthoritiesRequest.postTelephonyProvidersEdgesCertificateauthorities was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesdidpools": { - "operationId": "posttelephonyprovidersedgesdidpools", - "functionName": "postTelephonyProvidersEdgesDidpools", - "signature": "postTelephonyProvidersEdgesDidpools(body)", - "parameters": [ - { - "name": "body", - "type": "DIDPool", - "required": "true" - } - ], - "return": "DIDPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DIDPool = new DIDPool(...) // DID pool\n\n// Create a new DID pool\nPostTelephonyProvidersEdgesDidpoolsRequest.postTelephonyProvidersEdgesDidpools(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesDidpoolsRequest.postTelephonyProvidersEdgesDidpools was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesedgegroups": { - "operationId": "posttelephonyprovidersedgesedgegroups", - "functionName": "postTelephonyProvidersEdgesEdgegroups", - "signature": "postTelephonyProvidersEdgesEdgegroups(body)", - "parameters": [ - { - "name": "body", - "type": "EdgeGroup", - "required": "true" - } - ], - "return": "EdgeGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EdgeGroup = new EdgeGroup(...) // EdgeGroup\n\n// Create an edge group.\nPostTelephonyProvidersEdgesEdgegroupsRequest.postTelephonyProvidersEdgesEdgegroups(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesEdgegroupsRequest.postTelephonyProvidersEdgesEdgegroups was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesextensionpools": { - "operationId": "posttelephonyprovidersedgesextensionpools", - "functionName": "postTelephonyProvidersEdgesExtensionpools", - "signature": "postTelephonyProvidersEdgesExtensionpools(body)", - "parameters": [ - { - "name": "body", - "type": "ExtensionPool", - "required": "true" - } - ], - "return": "ExtensionPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ExtensionPool = new ExtensionPool(...) // ExtensionPool\n\n// Create a new extension pool\nPostTelephonyProvidersEdgesExtensionpoolsRequest.postTelephonyProvidersEdgesExtensionpools(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesExtensionpoolsRequest.postTelephonyProvidersEdgesExtensionpools was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesphonereboot": { - "operationId": "posttelephonyprovidersedgesphonereboot", - "functionName": "postTelephonyProvidersEdgesPhoneReboot", - "signature": "postTelephonyProvidersEdgesPhoneReboot(phoneId)", - "parameters": [ - { - "name": "phoneId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneId: String = \"\" // Phone Id\n\n// Reboot a Phone\nPostTelephonyProvidersEdgesPhoneRebootRequest.postTelephonyProvidersEdgesPhoneReboot(phoneId: phoneId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostTelephonyProvidersEdgesPhoneRebootRequest.postTelephonyProvidersEdgesPhoneReboot was successful\")\n }\n}" - }, - "posttelephonyprovidersedgesphonebasesettings": { - "operationId": "posttelephonyprovidersedgesphonebasesettings", - "functionName": "postTelephonyProvidersEdgesPhonebasesettings", - "signature": "postTelephonyProvidersEdgesPhonebasesettings(body)", - "parameters": [ - { - "name": "body", - "type": "PhoneBase", - "required": "true" - } - ], - "return": "PhoneBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PhoneBase = new PhoneBase(...) // Phone base settings\n\n// Create a new Phone Base Settings object\nPostTelephonyProvidersEdgesPhonebasesettingsRequest.postTelephonyProvidersEdgesPhonebasesettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesPhonebasesettingsRequest.postTelephonyProvidersEdgesPhonebasesettings was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesphones": { - "operationId": "posttelephonyprovidersedgesphones", - "functionName": "postTelephonyProvidersEdgesPhones", - "signature": "postTelephonyProvidersEdgesPhones(body)", - "parameters": [ - { - "name": "body", - "type": "Phone", - "required": "true" - } - ], - "return": "Phone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Phone = new Phone(...) // Phone\n\n// Create a new Phone\nPostTelephonyProvidersEdgesPhonesRequest.postTelephonyProvidersEdgesPhones(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesPhonesRequest.postTelephonyProvidersEdgesPhones was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgesphonesreboot": { - "operationId": "posttelephonyprovidersedgesphonesreboot", - "functionName": "postTelephonyProvidersEdgesPhonesReboot", - "signature": "postTelephonyProvidersEdgesPhonesReboot(body)", - "parameters": [ - { - "name": "body", - "type": "PhonesReboot", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: PhonesReboot = new PhonesReboot(...) // Phones\n\n// Reboot Multiple Phones\nPostTelephonyProvidersEdgesPhonesRebootRequest.postTelephonyProvidersEdgesPhonesReboot(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostTelephonyProvidersEdgesPhonesRebootRequest.postTelephonyProvidersEdgesPhonesReboot was successful\")\n }\n}" - }, - "posttelephonyprovidersedgessiteoutboundroutes": { - "operationId": "posttelephonyprovidersedgessiteoutboundroutes", - "functionName": "postTelephonyProvidersEdgesSiteOutboundroutes", - "signature": "postTelephonyProvidersEdgesSiteOutboundroutes(siteId, body)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OutboundRouteBase", - "required": "true" - } - ], - "return": "OutboundRouteBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet body: OutboundRouteBase = new OutboundRouteBase(...) // OutboundRoute\n\n// Create outbound route\nPostTelephonyProvidersEdgesSiteOutboundroutesRequest.postTelephonyProvidersEdgesSiteOutboundroutes(siteId: siteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesSiteOutboundroutesRequest.postTelephonyProvidersEdgesSiteOutboundroutes was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgessites": { - "operationId": "posttelephonyprovidersedgessites", - "functionName": "postTelephonyProvidersEdgesSites", - "signature": "postTelephonyProvidersEdgesSites(body)", - "parameters": [ - { - "name": "body", - "type": "Site", - "required": "true" - } - ], - "return": "Site", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Site = new Site(...) // Site\n\n// Create a Site.\nPostTelephonyProvidersEdgesSitesRequest.postTelephonyProvidersEdgesSites(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesSitesRequest.postTelephonyProvidersEdgesSites was successful\")\n dump(response)\n }\n}" - }, - "posttelephonyprovidersedgestrunkbasesettings": { - "operationId": "posttelephonyprovidersedgestrunkbasesettings", - "functionName": "postTelephonyProvidersEdgesTrunkbasesettings", - "signature": "postTelephonyProvidersEdgesTrunkbasesettings(body)", - "parameters": [ - { - "name": "body", - "type": "TrunkBase", - "required": "true" - } - ], - "return": "TrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TrunkBase = new TrunkBase(...) // Trunk base settings\n\n// Create a Trunk Base Settings object\nPostTelephonyProvidersEdgesTrunkbasesettingsRequest.postTelephonyProvidersEdgesTrunkbasesettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTelephonyProvidersEdgesTrunkbasesettingsRequest.postTelephonyProvidersEdgesTrunkbasesettings was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedge": { - "operationId": "puttelephonyprovidersedge", - "functionName": "putTelephonyProvidersEdge", - "signature": "putTelephonyProvidersEdge(edgeId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Edge", - "required": "true" - } - ], - "return": "Edge", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet body: Edge = new Edge(...) // Edge\n\n// Update a edge.\nPutTelephonyProvidersEdgeRequest.putTelephonyProvidersEdge(edgeId: edgeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgeRequest.putTelephonyProvidersEdge was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgelogicalinterface": { - "operationId": "puttelephonyprovidersedgelogicalinterface", - "functionName": "putTelephonyProvidersEdgeLogicalinterface", - "signature": "putTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId, body)", - "parameters": [ - { - "name": "edgeId", - "type": "String", - "required": "true" - }, - { - "name": "interfaceId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainLogicalInterface", - "required": "true" - } - ], - "return": "DomainLogicalInterface", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeId: String = \"\" // Edge ID\nlet interfaceId: String = \"\" // Interface ID\nlet body: DomainLogicalInterface = new DomainLogicalInterface(...) // Logical interface\n\n// Update an edge logical interface.\nPutTelephonyProvidersEdgeLogicalinterfaceRequest.putTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgeLogicalinterfaceRequest.putTelephonyProvidersEdgeLogicalinterface was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgescertificateauthority": { - "operationId": "puttelephonyprovidersedgescertificateauthority", - "functionName": "putTelephonyProvidersEdgesCertificateauthority", - "signature": "putTelephonyProvidersEdgesCertificateauthority(certificateId, body)", - "parameters": [ - { - "name": "certificateId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DomainCertificateAuthority", - "required": "true" - } - ], - "return": "DomainCertificateAuthority", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet certificateId: String = \"\" // Certificate ID\nlet body: DomainCertificateAuthority = new DomainCertificateAuthority(...) // Certificate authority\n\n// Update a certificate authority.\nPutTelephonyProvidersEdgesCertificateauthorityRequest.putTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesCertificateauthorityRequest.putTelephonyProvidersEdgesCertificateauthority was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesdidpool": { - "operationId": "puttelephonyprovidersedgesdidpool", - "functionName": "putTelephonyProvidersEdgesDidpool", - "signature": "putTelephonyProvidersEdgesDidpool(didPoolId, body)", - "parameters": [ - { - "name": "didPoolId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "DIDPool", - "required": "true" - } - ], - "return": "DIDPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet didPoolId: String = \"\" // DID pool ID\nlet body: DIDPool = new DIDPool(...) // DID pool\n\n// Update a DID Pool by ID.\nPutTelephonyProvidersEdgesDidpoolRequest.putTelephonyProvidersEdgesDidpool(didPoolId: didPoolId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesDidpoolRequest.putTelephonyProvidersEdgesDidpool was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesedgegroup": { - "operationId": "puttelephonyprovidersedgesedgegroup", - "functionName": "putTelephonyProvidersEdgesEdgegroup", - "signature": "putTelephonyProvidersEdgesEdgegroup(edgeGroupId, body)", - "parameters": [ - { - "name": "edgeGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeGroup", - "required": "true" - } - ], - "return": "EdgeGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgeGroupId: String = \"\" // Edge group ID\nlet body: EdgeGroup = new EdgeGroup(...) // EdgeGroup\n\n// Update an edge group.\nPutTelephonyProvidersEdgesEdgegroupRequest.putTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesEdgegroupRequest.putTelephonyProvidersEdgesEdgegroup was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesedgegroupedgetrunkbase": { - "operationId": "puttelephonyprovidersedgesedgegroupedgetrunkbase", - "functionName": "putTelephonyProvidersEdgesEdgegroupEdgetrunkbase", - "signature": "putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId, edgetrunkbaseId, body)", - "parameters": [ - { - "name": "edgegroupId", - "type": "String", - "required": "true" - }, - { - "name": "edgetrunkbaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EdgeTrunkBase", - "required": "true" - } - ], - "return": "EdgeTrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet edgegroupId: String = \"\" // Edge Group ID\nlet edgetrunkbaseId: String = \"\" // Edge Trunk Base ID\nlet body: EdgeTrunkBase = new EdgeTrunkBase(...) // EdgeTrunkBase\n\n// Update the edge trunk base associated with the edge group\nPutTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId: edgegroupId, edgetrunkbaseId: edgetrunkbaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.putTelephonyProvidersEdgesEdgegroupEdgetrunkbase was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesextensionpool": { - "operationId": "puttelephonyprovidersedgesextensionpool", - "functionName": "putTelephonyProvidersEdgesExtensionpool", - "signature": "putTelephonyProvidersEdgesExtensionpool(extensionPoolId, body)", - "parameters": [ - { - "name": "extensionPoolId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ExtensionPool", - "required": "true" - } - ], - "return": "ExtensionPool", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet extensionPoolId: String = \"\" // Extension pool ID\nlet body: ExtensionPool = new ExtensionPool(...) // ExtensionPool\n\n// Update an extension pool by ID\nPutTelephonyProvidersEdgesExtensionpoolRequest.putTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesExtensionpoolRequest.putTelephonyProvidersEdgesExtensionpool was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesphone": { - "operationId": "puttelephonyprovidersedgesphone", - "functionName": "putTelephonyProvidersEdgesPhone", - "signature": "putTelephonyProvidersEdgesPhone(phoneId, body)", - "parameters": [ - { - "name": "phoneId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Phone", - "required": "true" - } - ], - "return": "Phone", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneId: String = \"\" // Phone ID\nlet body: Phone = new Phone(...) // Phone\n\n// Update a Phone by ID\nPutTelephonyProvidersEdgesPhoneRequest.putTelephonyProvidersEdgesPhone(phoneId: phoneId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesPhoneRequest.putTelephonyProvidersEdgesPhone was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgesphonebasesetting": { - "operationId": "puttelephonyprovidersedgesphonebasesetting", - "functionName": "putTelephonyProvidersEdgesPhonebasesetting", - "signature": "putTelephonyProvidersEdgesPhonebasesetting(phoneBaseId, body)", - "parameters": [ - { - "name": "phoneBaseId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PhoneBase", - "required": "true" - } - ], - "return": "PhoneBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet phoneBaseId: String = \"\" // Phone base ID\nlet body: PhoneBase = new PhoneBase(...) // Phone base settings\n\n// Update a Phone Base Settings by ID\nPutTelephonyProvidersEdgesPhonebasesettingRequest.putTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesPhonebasesettingRequest.putTelephonyProvidersEdgesPhonebasesetting was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgessite": { - "operationId": "puttelephonyprovidersedgessite", - "functionName": "putTelephonyProvidersEdgesSite", - "signature": "putTelephonyProvidersEdgesSite(siteId, body)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "Site", - "required": "true" - } - ], - "return": "Site", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet body: Site = new Site(...) // Site\n\n// Update a Site by ID.\nPutTelephonyProvidersEdgesSiteRequest.putTelephonyProvidersEdgesSite(siteId: siteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesSiteRequest.putTelephonyProvidersEdgesSite was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgessitenumberplans": { - "operationId": "puttelephonyprovidersedgessitenumberplans", - "functionName": "putTelephonyProvidersEdgesSiteNumberplans", - "signature": "putTelephonyProvidersEdgesSiteNumberplans(siteId, body)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[NumberPlan]", - "required": "true" - } - ], - "return": "[NumberPlan]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet body: [NumberPlan] = [new NumberPlan(...)] // List of number plans\n\n// Update the list of Number Plans. A user can update maximum 200 number plans at a time.\nPutTelephonyProvidersEdgesSiteNumberplansRequest.putTelephonyProvidersEdgesSiteNumberplans(siteId: siteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesSiteNumberplansRequest.putTelephonyProvidersEdgesSiteNumberplans was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgessiteoutboundroute": { - "operationId": "puttelephonyprovidersedgessiteoutboundroute", - "functionName": "putTelephonyProvidersEdgesSiteOutboundroute", - "signature": "putTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId, body)", - "parameters": [ - { - "name": "siteId", - "type": "String", - "required": "true" - }, - { - "name": "outboundRouteId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OutboundRouteBase", - "required": "true" - } - ], - "return": "OutboundRouteBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet siteId: String = \"\" // Site ID\nlet outboundRouteId: String = \"\" // Outbound route ID\nlet body: OutboundRouteBase = new OutboundRouteBase(...) // OutboundRoute\n\n// Update outbound route\nPutTelephonyProvidersEdgesSiteOutboundrouteRequest.putTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesSiteOutboundrouteRequest.putTelephonyProvidersEdgesSiteOutboundroute was successful\")\n dump(response)\n }\n}" - }, - "puttelephonyprovidersedgestrunkbasesetting": { - "operationId": "puttelephonyprovidersedgestrunkbasesetting", - "functionName": "putTelephonyProvidersEdgesTrunkbasesetting", - "signature": "putTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId, body)", - "parameters": [ - { - "name": "trunkBaseSettingsId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TrunkBase", - "required": "true" - } - ], - "return": "TrunkBase", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet trunkBaseSettingsId: String = \"\" // Trunk Base ID\nlet body: TrunkBase = new TrunkBase(...) // Trunk base settings\n\n// Update a Trunk Base Settings object by ID\nPutTelephonyProvidersEdgesTrunkbasesettingRequest.putTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutTelephonyProvidersEdgesTrunkbasesettingRequest.putTelephonyProvidersEdgesTrunkbasesetting was successful\")\n dump(response)\n }\n}" - }, - "gettextbotsbotssearch": { - "operationId": "gettextbotsbotssearch", - "functionName": "getTextbotsBotsSearch", - "signature": "getTextbotsBotsSearch(botType, botName, botId, pageSize)", - "parameters": [ - { - "name": "botType", - "type": "[String]", - "required": "false" - }, - { - "name": "botName", - "type": "String", - "required": "false" - }, - { - "name": "botId", - "type": "[String]", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - } - ], - "return": "BotSearchResponseEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet botType: [String] = [\"\"] // Bot types\nlet botName: String = \"\" // Bot name\nlet botId: [String] = [\"\"] // Bot IDs\nlet pageSize: Int = 0 // The maximum results to return\n\n// Find bots using the currently configured friendly name or ID.\nGetTextbotsBotsSearchRequest.getTextbotsBotsSearch(botType: botType, botName: botName, botId: botId, pageSize: pageSize) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTextbotsBotsSearchRequest.getTextbotsBotsSearch was successful\")\n dump(response)\n }\n}" - }, - "posttextbotsbotflowssessionturns": { - "operationId": "posttextbotsbotflowssessionturns", - "functionName": "postTextbotsBotflowsSessionTurns", - "signature": "postTextbotsBotflowsSessionTurns(sessionId, turnRequest)", - "parameters": [ - { - "name": "sessionId", - "type": "String", - "required": "true" - }, - { - "name": "turnRequest", - "type": "TextBotFlowTurnRequest", - "required": "true" - } - ], - "return": "TextBotFlowTurnResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet sessionId: String = \"\" // The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'\nlet turnRequest: TextBotFlowTurnRequest = new TextBotFlowTurnRequest(...) // \n\n// Issue a bot flow turn event\nPostTextbotsBotflowsSessionTurnsRequest.postTextbotsBotflowsSessionTurns(sessionId: sessionId, turnRequest: turnRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTextbotsBotflowsSessionTurnsRequest.postTextbotsBotflowsSessionTurns was successful\")\n dump(response)\n }\n}" - }, - "posttextbotsbotflowssessions": { - "operationId": "posttextbotsbotflowssessions", - "functionName": "postTextbotsBotflowsSessions", - "signature": "postTextbotsBotflowsSessions(launchRequest)", - "parameters": [ - { - "name": "launchRequest", - "type": "TextBotFlowLaunchRequest", - "required": "true" - } - ], - "return": "TextBotFlowLaunchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet launchRequest: TextBotFlowLaunchRequest = new TextBotFlowLaunchRequest(...) // \n\n// Create an execution instance of a bot flow definition.\nPostTextbotsBotflowsSessionsRequest.postTextbotsBotflowsSessions(launchRequest: launchRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTextbotsBotflowsSessionsRequest.postTextbotsBotflowsSessions was successful\")\n dump(response)\n }\n}" - }, - "posttextbotsbotsexecute": { - "operationId": "posttextbotsbotsexecute", - "functionName": "postTextbotsBotsExecute", - "signature": "postTextbotsBotsExecute(postTextRequest)", - "parameters": [ - { - "name": "postTextRequest", - "type": "PostTextRequest", - "required": "true" - } - ], - "return": "PostTextResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet postTextRequest: PostTextRequest = new PostTextRequest(...) // \n\n// Send an intent to a bot to start a dialog/interact with it via text\nPostTextbotsBotsExecuteRequest.postTextbotsBotsExecute(postTextRequest: postTextRequest) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostTextbotsBotsExecuteRequest.postTextbotsBotsExecute was successful\")\n dump(response)\n }\n}" - }, - "deletetoken": { - "operationId": "deletetoken", - "functionName": "deleteToken", - "signature": "deleteToken(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Delete all auth tokens for the specified user.\nDeleteTokenRequest.deleteToken(userId: userId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTokenRequest.deleteToken was successful\")\n }\n}" - }, - "deletetokensme": { - "operationId": "deletetokensme", - "functionName": "deleteTokensMe", - "signature": "deleteTokensMe()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete auth token used to make the request.\nDeleteTokensMeRequest.deleteTokensMe() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteTokensMeRequest.deleteTokensMe was successful\")\n }\n}" - }, - "gettokensme": { - "operationId": "gettokensme", - "functionName": "getTokensMe", - "signature": "getTokensMe(preserveIdleTTL)", - "parameters": [ - { - "name": "preserveIdleTTL", - "type": "Bool", - "required": "false" - } - ], - "return": "TokenInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet preserveIdleTTL: Bool = true // preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.\n\n// Fetch information about the current token\nGetTokensMeRequest.getTokensMe(preserveIdleTTL: preserveIdleTTL) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTokensMeRequest.getTokensMe was successful\")\n dump(response)\n }\n}" - }, - "headtokensme": { - "operationId": "headtokensme", - "functionName": "headTokensMe", - "signature": "headTokensMe()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Verify user token\nHeadTokensMeRequest.headTokensMe() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"HeadTokensMeRequest.headTokensMe was successful\")\n }\n}" - }, - "postlanguageunderstandingmineruploads": { - "operationId": "postlanguageunderstandingmineruploads", - "functionName": "postLanguageunderstandingMinerUploads", - "signature": "postLanguageunderstandingMinerUploads(minerId, body)", - "parameters": [ - { - "name": "minerId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "JSON", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet minerId: String = \"\" // Miner ID\nlet body: JSON = new JSON(...) // query\n\n// Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner\nPostLanguageunderstandingMinerUploadsRequest.postLanguageunderstandingMinerUploads(minerId: minerId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostLanguageunderstandingMinerUploadsRequest.postLanguageunderstandingMinerUploads was successful\")\n dump(response)\n }\n}" - }, - "postuploadslearningcoverart": { - "operationId": "postuploadslearningcoverart", - "functionName": "postUploadsLearningCoverart", - "signature": "postUploadsLearningCoverart(body)", - "parameters": [ - { - "name": "body", - "type": "LearningCoverArtUploadUrlRequest", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: LearningCoverArtUploadUrlRequest = new LearningCoverArtUploadUrlRequest(...) // query\n\n// Generates pre-signed URL to upload cover art for learning modules\nPostUploadsLearningCoverartRequest.postUploadsLearningCoverart(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUploadsLearningCoverartRequest.postUploadsLearningCoverart was successful\")\n dump(response)\n }\n}" - }, - "postuploadspublicassetsimages": { - "operationId": "postuploadspublicassetsimages", - "functionName": "postUploadsPublicassetsImages", - "signature": "postUploadsPublicassetsImages(body)", - "parameters": [ - { - "name": "body", - "type": "UploadUrlRequest", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UploadUrlRequest = new UploadUrlRequest(...) // query\n\n// Creates presigned url for uploading a public asset image\nPostUploadsPublicassetsImagesRequest.postUploadsPublicassetsImages(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUploadsPublicassetsImagesRequest.postUploadsPublicassetsImages was successful\")\n dump(response)\n }\n}" - }, - "postuploadsrecordings": { - "operationId": "postuploadsrecordings", - "functionName": "postUploadsRecordings", - "signature": "postUploadsRecordings(body)", - "parameters": [ - { - "name": "body", - "type": "UploadUrlRequest", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UploadUrlRequest = new UploadUrlRequest(...) // query\n\n// Creates presigned url for uploading a recording file\nPostUploadsRecordingsRequest.postUploadsRecordings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUploadsRecordingsRequest.postUploadsRecordings was successful\")\n dump(response)\n }\n}" - }, - "postuploadsworkforcemanagementhistoricaldatacsv": { - "operationId": "postuploadsworkforcemanagementhistoricaldatacsv", - "functionName": "postUploadsWorkforcemanagementHistoricaldataCsv", - "signature": "postUploadsWorkforcemanagementHistoricaldataCsv(body)", - "parameters": [ - { - "name": "body", - "type": "UploadUrlRequest", - "required": "true" - } - ], - "return": "UploadUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UploadUrlRequest = new UploadUrlRequest(...) // query\n\n// Creates presigned url for uploading WFM historical data file. Requires data in csv format.\nPostUploadsWorkforcemanagementHistoricaldataCsvRequest.postUploadsWorkforcemanagementHistoricaldataCsv(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUploadsWorkforcemanagementHistoricaldataCsvRequest.postUploadsWorkforcemanagementHistoricaldataCsv was successful\")\n dump(response)\n }\n}" - }, - "getusagequeryexecutionidresults": { - "operationId": "getusagequeryexecutionidresults", - "functionName": "getUsageQueryExecutionIdResults", - "signature": "getUsageQueryExecutionIdResults(executionId)", - "parameters": [ - { - "name": "executionId", - "type": "String", - "required": "true" - } - ], - "return": "ApiUsageQueryResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet executionId: String = \"\" // ID of the query execution\n\n// Get the results of a usage query\nGetUsageQueryExecutionIdResultsRequest.getUsageQueryExecutionIdResults(executionId: executionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsageQueryExecutionIdResultsRequest.getUsageQueryExecutionIdResults was successful\")\n dump(response)\n }\n}" - }, - "getusagesimplesearchexecutionidresults": { - "operationId": "getusagesimplesearchexecutionidresults", - "functionName": "getUsageSimplesearchExecutionIdResults", - "signature": "getUsageSimplesearchExecutionIdResults(executionId)", - "parameters": [ - { - "name": "executionId", - "type": "String", - "required": "true" - } - ], - "return": "ApiUsageQueryResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet executionId: String = \"\" // ID of the search execution\n\n// Get the results of a usage search\nGetUsageSimplesearchExecutionIdResultsRequest.getUsageSimplesearchExecutionIdResults(executionId: executionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsageSimplesearchExecutionIdResultsRequest.getUsageSimplesearchExecutionIdResults was successful\")\n dump(response)\n }\n}" - }, - "postusagequery": { - "operationId": "postusagequery", - "functionName": "postUsageQuery", - "signature": "postUsageQuery(body)", - "parameters": [ - { - "name": "body", - "type": "ApiUsageOrganizationQuery", - "required": "true" - } - ], - "return": "UsageExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ApiUsageOrganizationQuery = new ApiUsageOrganizationQuery(...) // Query\n\n// Query organization API Usage - \nPostUsageQueryRequest.postUsageQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsageQueryRequest.postUsageQuery was successful\")\n dump(response)\n }\n}" - }, - "postusagesimplesearch": { - "operationId": "postusagesimplesearch", - "functionName": "postUsageSimplesearch", - "signature": "postUsageSimplesearch(body)", - "parameters": [ - { - "name": "body", - "type": "ApiUsageSimpleSearch", - "required": "true" - } - ], - "return": "UsageExecutionResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ApiUsageSimpleSearch = new ApiUsageSimpleSearch(...) // SimpleSearch\n\n// Search organization API Usage - \nPostUsageSimplesearchRequest.postUsageSimplesearch(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsageSimplesearchRequest.postUsageSimplesearch was successful\")\n dump(response)\n }\n}" - }, - "deleteuserrecording": { - "operationId": "deleteuserrecording", - "functionName": "deleteUserrecording", - "signature": "deleteUserrecording(recordingId)", - "parameters": [ - { - "name": "recordingId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recordingId: String = \"\" // User Recording ID\n\n// Delete a user recording.\nDeleteUserrecordingRequest.deleteUserrecording(recordingId: recordingId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteUserrecordingRequest.deleteUserrecording was successful\")\n }\n}" - }, - "getuserrecording": { - "operationId": "getuserrecording", - "functionName": "getUserrecording", - "signature": "getUserrecording(recordingId, expand)", - "parameters": [ - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UserRecording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recordingId: String = \"\" // User Recording ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a user recording.\nGetUserrecordingRequest.getUserrecording(recordingId: recordingId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserrecordingRequest.getUserrecording was successful\")\n dump(response)\n }\n}" - }, - "getuserrecordingmedia": { - "operationId": "getuserrecordingmedia", - "functionName": "getUserrecordingMedia", - "signature": "getUserrecordingMedia(recordingId, formatId, async)", - "parameters": [ - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - }, - { - "name": "async", - "type": "Bool", - "required": "false" - } - ], - "return": "DownloadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recordingId: String = \"\" // User Recording ID\nlet formatId: GetUserrecordingMediaRequest.FormatId_getUserrecordingMedia = GetUserrecordingMediaRequest.FormatId_getUserrecordingMedia.enummember // The desired media format.\nlet async: Bool = true // When set to true, api will return 202 response until the recording is ready for download\n\n// Download a user recording.\nGetUserrecordingMediaRequest.getUserrecordingMedia(recordingId: recordingId, formatId: formatId, async: async) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserrecordingMediaRequest.getUserrecordingMedia was successful\")\n dump(response)\n }\n}" - }, - "getuserrecordings": { - "operationId": "getuserrecordings", - "functionName": "getUserrecordings", - "signature": "getUserrecordings(pageSize, pageNumber, expand)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UserRecordingEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Get a list of user recordings.\nGetUserrecordingsRequest.getUserrecordings(pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserrecordingsRequest.getUserrecordings was successful\")\n dump(response)\n }\n}" - }, - "getuserrecordingssummary": { - "operationId": "getuserrecordingssummary", - "functionName": "getUserrecordingsSummary", - "signature": "getUserrecordingsSummary()", - "return": "FaxSummary", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get user recording summary\nGetUserrecordingsSummaryRequest.getUserrecordingsSummary() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserrecordingsSummaryRequest.getUserrecordingsSummary was successful\")\n dump(response)\n }\n}" - }, - "putuserrecording": { - "operationId": "putuserrecording", - "functionName": "putUserrecording", - "signature": "putUserrecording(recordingId, body, expand)", - "parameters": [ - { - "name": "recordingId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserRecording", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UserRecording", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recordingId: String = \"\" // User Recording ID\nlet body: UserRecording = new UserRecording(...) // UserRecording\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\n\n// Update a user recording.\nPutUserrecordingRequest.putUserrecording(recordingId: recordingId, body: body, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserrecordingRequest.putUserrecording was successful\")\n dump(response)\n }\n}" - }, - "deleteuser": { - "operationId": "deleteuser", - "functionName": "deleteUser", - "signature": "deleteUser(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Delete user\nDeleteUserRequest.deleteUser(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteUserRequest.deleteUser was successful\")\n dump(response)\n }\n}" - }, - "deleteuserstationassociatedstation": { - "operationId": "deleteuserstationassociatedstation", - "functionName": "deleteUserStationAssociatedstation", - "signature": "deleteUserStationAssociatedstation(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Clear associated station\nDeleteUserStationAssociatedstationRequest.deleteUserStationAssociatedstation(userId: userId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteUserStationAssociatedstationRequest.deleteUserStationAssociatedstation was successful\")\n }\n}" - }, - "deleteuserstationdefaultstation": { - "operationId": "deleteuserstationdefaultstation", - "functionName": "deleteUserStationDefaultstation", - "signature": "deleteUserStationDefaultstation(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Clear default station\nDeleteUserStationDefaultstationRequest.deleteUserStationDefaultstation(userId: userId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteUserStationDefaultstationRequest.deleteUserStationDefaultstation was successful\")\n }\n}" - }, - "getprofilesusers": { - "operationId": "getprofilesusers", - "functionName": "getProfilesUsers", - "signature": "getProfilesUsers(pageSize, pageNumber, _id, jid, sortOrder, expand, integrationPresenceSource)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "jid", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - } - ], - "return": "UserProfileEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // id\nlet jid: [String] = [\"\"] // jid\nlet sortOrder: GetProfilesUsersRequest.SortOrder_getProfilesUsers = GetProfilesUsersRequest.SortOrder_getProfilesUsers.enummember // Ascending or descending sort order\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet integrationPresenceSource: GetProfilesUsersRequest.IntegrationPresenceSource_getProfilesUsers = GetProfilesUsersRequest.IntegrationPresenceSource_getProfilesUsers.enummember // Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \\\"expand\\\".\n\n// Get a user profile listing\nGetProfilesUsersRequest.getProfilesUsers(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jid: jid, sortOrder: sortOrder, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetProfilesUsersRequest.getProfilesUsers was successful\")\n dump(response)\n }\n}" - }, - "getuser": { - "operationId": "getuser", - "functionName": "getUser", - "signature": "getUser(userId, expand, integrationPresenceSource, state)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - } - ], - "return": "User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet integrationPresenceSource: GetUserRequest.IntegrationPresenceSource_getUser = GetUserRequest.IntegrationPresenceSource_getUser.enummember // Gets an integration presence for a user instead of their default.\nlet state: GetUserRequest.State_getUser = GetUserRequest.State_getUser.enummember // Search for a user with this state\n\n// Get user.\nGetUserRequest.getUser(userId: userId, expand: expand, integrationPresenceSource: integrationPresenceSource, state: state) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserRequest.getUser was successful\")\n dump(response)\n }\n}" - }, - "getuseradjacents": { - "operationId": "getuseradjacents", - "functionName": "getUserAdjacents", - "signature": "getUserAdjacents(userId, expand)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "Adjacents", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get adjacents\nGetUserAdjacentsRequest.getUserAdjacents(userId: userId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserAdjacentsRequest.getUserAdjacents was successful\")\n dump(response)\n }\n}" - }, - "getusercallforwarding": { - "operationId": "getusercallforwarding", - "functionName": "getUserCallforwarding", - "signature": "getUserCallforwarding(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "CallForwarding", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get a user's CallForwarding\nGetUserCallforwardingRequest.getUserCallforwarding(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserCallforwardingRequest.getUserCallforwarding was successful\")\n dump(response)\n }\n}" - }, - "getuserdirectreports": { - "operationId": "getuserdirectreports", - "functionName": "getUserDirectreports", - "signature": "getUserDirectreports(userId, expand)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "[User]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get direct reports\nGetUserDirectreportsRequest.getUserDirectreports(userId: userId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserDirectreportsRequest.getUserDirectreports was successful\")\n dump(response)\n }\n}" - }, - "getuserfavorites": { - "operationId": "getuserfavorites", - "functionName": "getUserFavorites", - "signature": "getUserFavorites(userId, pageSize, pageNumber, sortOrder, expand)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: String = \"\" // Sort order\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Deprecated; will be revived with new contract\nGetUserFavoritesRequest.getUserFavorites(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserFavoritesRequest.getUserFavorites was successful\")\n dump(response)\n }\n}" - }, - "getuseroutofoffice": { - "operationId": "getuseroutofoffice", - "functionName": "getUserOutofoffice", - "signature": "getUserOutofoffice(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "OutOfOffice", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get a OutOfOffice\nGetUserOutofofficeRequest.getUserOutofoffice(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserOutofofficeRequest.getUserOutofoffice was successful\")\n dump(response)\n }\n}" - }, - "getuserprofile": { - "operationId": "getuserprofile", - "functionName": "getUserProfile", - "signature": "getUserProfile(userId, expand, integrationPresenceSource)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - } - ], - "return": "UserProfile", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // userId\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet integrationPresenceSource: GetUserProfileRequest.IntegrationPresenceSource_getUserProfile = GetUserProfileRequest.IntegrationPresenceSource_getUserProfile.enummember // Gets an integration presence for a user instead of their default.\n\n// Get user profile\nGetUserProfileRequest.getUserProfile(userId: userId, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserProfileRequest.getUserProfile was successful\")\n dump(response)\n }\n}" - }, - "getuserprofileskills": { - "operationId": "getuserprofileskills", - "functionName": "getUserProfileskills", - "signature": "getUserProfileskills(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// List profile skills for a user\nGetUserProfileskillsRequest.getUserProfileskills(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserProfileskillsRequest.getUserProfileskills was successful\")\n dump(response)\n }\n}" - }, - "getuserroutingstatus": { - "operationId": "getuserroutingstatus", - "functionName": "getUserRoutingstatus", - "signature": "getUserRoutingstatus(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "RoutingStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Fetch the routing status of a user\nGetUserRoutingstatusRequest.getUserRoutingstatus(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserRoutingstatusRequest.getUserRoutingstatus was successful\")\n dump(response)\n }\n}" - }, - "getuserstate": { - "operationId": "getuserstate", - "functionName": "getUserState", - "signature": "getUserState(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "UserState", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get user state information.\nGetUserStateRequest.getUserState(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserStateRequest.getUserState was successful\")\n dump(response)\n }\n}" - }, - "getuserstation": { - "operationId": "getuserstation", - "functionName": "getUserStation", - "signature": "getUserStation(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "UserStations", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get station information for user\nGetUserStationRequest.getUserStation(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserStationRequest.getUserStation was successful\")\n dump(response)\n }\n}" - }, - "getusersuperiors": { - "operationId": "getusersuperiors", - "functionName": "getUserSuperiors", - "signature": "getUserSuperiors(userId, expand)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "[User]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\n\n// Get superiors\nGetUserSuperiorsRequest.getUserSuperiors(userId: userId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserSuperiorsRequest.getUserSuperiors was successful\")\n dump(response)\n }\n}" - }, - "getusertrustors": { - "operationId": "getusertrustors", - "functionName": "getUserTrustors", - "signature": "getUserTrustors(userId, pageSize, pageNumber)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TrustorEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// List the organizations that have authorized/trusted the user.\nGetUserTrustorsRequest.getUserTrustors(userId: userId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUserTrustorsRequest.getUserTrustors was successful\")\n dump(response)\n }\n}" - }, - "getusers": { - "operationId": "getusers", - "functionName": "getUsers", - "signature": "getUsers(pageSize, pageNumber, _id, jabberId, sortOrder, expand, integrationPresenceSource, state)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "_id", - "type": "[String]", - "required": "false" - }, - { - "name": "jabberId", - "type": "[String]", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - }, - { - "name": "state", - "type": "String", - "required": "false" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet _id: [String] = [\"\"] // A list of user IDs to fetch by bulk\nlet jabberId: [String] = [\"\"] // A list of jabberIds to fetch by bulk (cannot be used with the \\\"id\\\" parameter)\nlet sortOrder: GetUsersRequest.SortOrder_getUsers = GetUsersRequest.SortOrder_getUsers.enummember // Ascending or descending sort order\nlet expand: [String] = [\"\"] // Which fields, if any, to expand\nlet integrationPresenceSource: GetUsersRequest.IntegrationPresenceSource_getUsers = GetUsersRequest.IntegrationPresenceSource_getUsers.enummember // 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 100.\nlet state: GetUsersRequest.State_getUsers = GetUsersRequest.State_getUsers.enummember // Only list users of this state\n\n// Get the list of available users.\nGetUsersRequest.getUsers(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder, expand: expand, integrationPresenceSource: integrationPresenceSource, state: state) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersRequest.getUsers was successful\")\n dump(response)\n }\n}" - }, - "getusersdevelopmentactivities": { - "operationId": "getusersdevelopmentactivities", - "functionName": "getUsersDevelopmentActivities", - "signature": "getUsersDevelopmentActivities(userId, moduleId, interval, completionInterval, overdue, pass, pageSize, pageNumber, sortOrder, types, statuses, relationship)", - "parameters": [ - { - "name": "userId", - "type": "[String]", - "required": "false" - }, - { - "name": "moduleId", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "pass", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "types", - "type": "[String]", - "required": "false" - }, - { - "name": "statuses", - "type": "[String]", - "required": "false" - }, - { - "name": "relationship", - "type": "[String]", - "required": "false" - } - ], - "return": "DevelopmentActivityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: [String] = [\"\"] // Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.\nlet moduleId: String = \"\" // Specifies the ID of the learning module.\nlet interval: String = \"\" // 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\nlet completionInterval: String = \"\" // 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\nlet overdue: GetUsersDevelopmentActivitiesRequest.Overdue_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.Overdue_getUsersDevelopmentActivities.enummember // Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned\nlet pass: GetUsersDevelopmentActivitiesRequest.Pass_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.Pass_getUsersDevelopmentActivities.enummember // Specifies if only the failed (pass is \\\"False\\\") or passed (pass is \\\"True\\\") activities are returned. If pass is \\\"Any\\\" or if the pass parameter is not supplied, all activities are returned\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetUsersDevelopmentActivitiesRequest.SortOrder_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.SortOrder_getUsersDevelopmentActivities.enummember // Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)\nlet types: [String] = [\"\"] // Specifies the activity types.\nlet statuses: [String] = [\"\"] // Specifies the activity statuses to filter by\nlet relationship: [String] = [\"\"] // 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.\n\n// Get list of Development Activities\nGetUsersDevelopmentActivitiesRequest.getUsersDevelopmentActivities(userId: userId, moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pass: pass, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, types: types, statuses: statuses, relationship: relationship) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersDevelopmentActivitiesRequest.getUsersDevelopmentActivities was successful\")\n dump(response)\n }\n}" - }, - "getusersdevelopmentactivitiesme": { - "operationId": "getusersdevelopmentactivitiesme", - "functionName": "getUsersDevelopmentActivitiesMe", - "signature": "getUsersDevelopmentActivitiesMe(moduleId, interval, completionInterval, overdue, pass, pageSize, pageNumber, sortOrder, types, statuses, relationship)", - "parameters": [ - { - "name": "moduleId", - "type": "String", - "required": "false" - }, - { - "name": "interval", - "type": "String", - "required": "false" - }, - { - "name": "completionInterval", - "type": "String", - "required": "false" - }, - { - "name": "overdue", - "type": "String", - "required": "false" - }, - { - "name": "pass", - "type": "String", - "required": "false" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "types", - "type": "[String]", - "required": "false" - }, - { - "name": "statuses", - "type": "[String]", - "required": "false" - }, - { - "name": "relationship", - "type": "[String]", - "required": "false" - } - ], - "return": "DevelopmentActivityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet moduleId: String = \"\" // Specifies the ID of the learning module.\nlet interval: String = \"\" // 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\nlet completionInterval: String = \"\" // 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\nlet overdue: GetUsersDevelopmentActivitiesMeRequest.Overdue_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.Overdue_getUsersDevelopmentActivitiesMe.enummember // Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned\nlet pass: GetUsersDevelopmentActivitiesMeRequest.Pass_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.Pass_getUsersDevelopmentActivitiesMe.enummember // Specifies if only the failed (pass is \\\"False\\\") or passed (pass is \\\"True\\\") activities are returned. If pass is \\\"Any\\\" or if the pass parameter is not supplied, all activities are returned\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\nlet sortOrder: GetUsersDevelopmentActivitiesMeRequest.SortOrder_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.SortOrder_getUsersDevelopmentActivitiesMe.enummember // Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)\nlet types: [String] = [\"\"] // Specifies the activity types.\nlet statuses: [String] = [\"\"] // Specifies the activity statuses to filter by\nlet relationship: [String] = [\"\"] // 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.\n\n// Get list of Development Activities for current user\nGetUsersDevelopmentActivitiesMeRequest.getUsersDevelopmentActivitiesMe(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pass: pass, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, types: types, statuses: statuses, relationship: relationship) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersDevelopmentActivitiesMeRequest.getUsersDevelopmentActivitiesMe was successful\")\n dump(response)\n }\n}" - }, - "getusersdevelopmentactivity": { - "operationId": "getusersdevelopmentactivity", - "functionName": "getUsersDevelopmentActivity", - "signature": "getUsersDevelopmentActivity(activityId, type)", - "parameters": [ - { - "name": "activityId", - "type": "String", - "required": "true" - }, - { - "name": "type", - "type": "String", - "required": "true" - } - ], - "return": "DevelopmentActivity", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet activityId: String = \"\" // Specifies the activity ID, maps to either assignment or appointment ID\nlet type: GetUsersDevelopmentActivityRequest.ModelType_getUsersDevelopmentActivity = GetUsersDevelopmentActivityRequest.ModelType_getUsersDevelopmentActivity.enummember // Specifies the activity type.\n\n// Get a Development Activity\nGetUsersDevelopmentActivityRequest.getUsersDevelopmentActivity(activityId: activityId, type: type) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersDevelopmentActivityRequest.getUsersDevelopmentActivity was successful\")\n dump(response)\n }\n}" - }, - "getusersme": { - "operationId": "getusersme", - "functionName": "getUsersMe", - "signature": "getUsersMe(expand, integrationPresenceSource)", - "parameters": [ - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "integrationPresenceSource", - "type": "String", - "required": "false" - } - ], - "return": "UserMe", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: [String] = [\"\"] // Which fields, if any, to expand.\nlet integrationPresenceSource: GetUsersMeRequest.IntegrationPresenceSource_getUsersMe = GetUsersMeRequest.IntegrationPresenceSource_getUsersMe.enummember // Get your presence for a given integration. This parameter will only be used when presence is provided as an \\\"expand\\\".\n\n// Get current user details.\nGetUsersMeRequest.getUsersMe(expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetUsersMeRequest.getUsersMe was successful\")\n dump(response)\n }\n}" - }, - "patchuser": { - "operationId": "patchuser", - "functionName": "patchUser", - "signature": "patchUser(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateUser", - "required": "true" - } - ], - "return": "User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: UpdateUser = new UpdateUser(...) // User\n\n// Update user\nPatchUserRequest.patchUser(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserRequest.patchUser was successful\")\n dump(response)\n }\n}" - }, - "patchusercallforwarding": { - "operationId": "patchusercallforwarding", - "functionName": "patchUserCallforwarding", - "signature": "patchUserCallforwarding(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CallForwarding", - "required": "true" - } - ], - "return": "CallForwarding", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: CallForwarding = new CallForwarding(...) // Call forwarding\n\n// Patch a user's CallForwarding\nPatchUserCallforwardingRequest.patchUserCallforwarding(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUserCallforwardingRequest.patchUserCallforwarding was successful\")\n dump(response)\n }\n}" - }, - "patchusersbulk": { - "operationId": "patchusersbulk", - "functionName": "patchUsersBulk", - "signature": "patchUsersBulk(body)", - "parameters": [ - { - "name": "body", - "type": "[PatchUser]", - "required": "true" - } - ], - "return": "UserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: [PatchUser] = [new PatchUser(...)] // Users\n\n// Update bulk acd autoanswer on users\nPatchUsersBulkRequest.patchUsersBulk(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchUsersBulkRequest.patchUsersBulk was successful\")\n dump(response)\n }\n}" - }, - "postuserexternalid": { - "operationId": "postuserexternalid", - "functionName": "postUserExternalid", - "signature": "postUserExternalid(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserExternalIdentifier", - "required": "true" - } - ], - "return": "[UserExternalIdentifier]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: UserExternalIdentifier = new UserExternalIdentifier(...) // \n\n// Create mapping between external identifier and user. Limit 100 per entity.\nPostUserExternalidRequest.postUserExternalid(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUserExternalidRequest.postUserExternalid was successful\")\n dump(response)\n }\n}" - }, - "postuserinvite": { - "operationId": "postuserinvite", - "functionName": "postUserInvite", - "signature": "postUserInvite(userId, force)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "force", - "type": "Bool", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet force: Bool = true // Resend the invitation even if one is already outstanding\n\n// Send an activation email to the user\nPostUserInviteRequest.postUserInvite(userId: userId, force: force) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostUserInviteRequest.postUserInvite was successful\")\n }\n}" - }, - "postuserpassword": { - "operationId": "postuserpassword", - "functionName": "postUserPassword", - "signature": "postUserPassword(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ChangePasswordRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: ChangePasswordRequest = new ChangePasswordRequest(...) // Password\n\n// Change a users password\nPostUserPasswordRequest.postUserPassword(userId: userId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostUserPasswordRequest.postUserPassword was successful\")\n }\n}" - }, - "postusers": { - "operationId": "postusers", - "functionName": "postUsers", - "signature": "postUsers(body)", - "parameters": [ - { - "name": "body", - "type": "CreateUser", - "required": "true" - } - ], - "return": "User", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateUser = new CreateUser(...) // User\n\n// Create user\nPostUsersRequest.postUsers(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsersRequest.postUsers was successful\")\n dump(response)\n }\n}" - }, - "postusersdevelopmentactivitiesaggregatesquery": { - "operationId": "postusersdevelopmentactivitiesaggregatesquery", - "functionName": "postUsersDevelopmentActivitiesAggregatesQuery", - "signature": "postUsersDevelopmentActivitiesAggregatesQuery(body)", - "parameters": [ - { - "name": "body", - "type": "DevelopmentActivityAggregateParam", - "required": "true" - } - ], - "return": "DevelopmentActivityAggregateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: DevelopmentActivityAggregateParam = new DevelopmentActivityAggregateParam(...) // Aggregate Request\n\n// Retrieve aggregated development activity data\nPostUsersDevelopmentActivitiesAggregatesQueryRequest.postUsersDevelopmentActivitiesAggregatesQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostUsersDevelopmentActivitiesAggregatesQueryRequest.postUsersDevelopmentActivitiesAggregatesQuery was successful\")\n dump(response)\n }\n}" - }, - "postusersmepassword": { - "operationId": "postusersmepassword", - "functionName": "postUsersMePassword", - "signature": "postUsersMePassword(body)", - "parameters": [ - { - "name": "body", - "type": "ChangeMyPasswordRequest", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ChangeMyPasswordRequest = new ChangeMyPasswordRequest(...) // Password\n\n// Change your password\nPostUsersMePasswordRequest.postUsersMePassword(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostUsersMePasswordRequest.postUsersMePassword was successful\")\n }\n}" - }, - "putusercallforwarding": { - "operationId": "putusercallforwarding", - "functionName": "putUserCallforwarding", - "signature": "putUserCallforwarding(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CallForwarding", - "required": "true" - } - ], - "return": "CallForwarding", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: CallForwarding = new CallForwarding(...) // Call forwarding\n\n// Update a user's CallForwarding\nPutUserCallforwardingRequest.putUserCallforwarding(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserCallforwardingRequest.putUserCallforwarding was successful\")\n dump(response)\n }\n}" - }, - "putuseroutofoffice": { - "operationId": "putuseroutofoffice", - "functionName": "putUserOutofoffice", - "signature": "putUserOutofoffice(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "OutOfOffice", - "required": "true" - } - ], - "return": "OutOfOffice", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: OutOfOffice = new OutOfOffice(...) // The updated OutOffOffice\n\n// Update an OutOfOffice\nPutUserOutofofficeRequest.putUserOutofoffice(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserOutofofficeRequest.putUserOutofoffice was successful\")\n dump(response)\n }\n}" - }, - "putuserprofileskills": { - "operationId": "putuserprofileskills", - "functionName": "putUserProfileskills", - "signature": "putUserProfileskills(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "[String]", - "required": "true" - } - ], - "return": "[String]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: [String] = [\"\"] // Skills\n\n// Update profile skills for a user\nPutUserProfileskillsRequest.putUserProfileskills(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserProfileskillsRequest.putUserProfileskills was successful\")\n dump(response)\n }\n}" - }, - "putuserroutingstatus": { - "operationId": "putuserroutingstatus", - "functionName": "putUserRoutingstatus", - "signature": "putUserRoutingstatus(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "RoutingStatus", - "required": "true" - } - ], - "return": "RoutingStatus", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: RoutingStatus = new RoutingStatus(...) // Routing Status\n\n// Update the routing status of a user\nPutUserRoutingstatusRequest.putUserRoutingstatus(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserRoutingstatusRequest.putUserRoutingstatus was successful\")\n dump(response)\n }\n}" - }, - "putuserstate": { - "operationId": "putuserstate", - "functionName": "putUserState", - "signature": "putUserState(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserState", - "required": "true" - } - ], - "return": "UserState", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: UserState = new UserState(...) // User\n\n// Update user state information.\nPutUserStateRequest.putUserState(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutUserStateRequest.putUserState was successful\")\n dump(response)\n }\n}" - }, - "putuserstationassociatedstationstationid": { - "operationId": "putuserstationassociatedstationstationid", - "functionName": "putUserStationAssociatedstationStationId", - "signature": "putUserStationAssociatedstationStationId(userId, stationId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "stationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet stationId: String = \"\" // stationId\n\n// Set associated station\nPutUserStationAssociatedstationStationIdRequest.putUserStationAssociatedstationStationId(userId: userId, stationId: stationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutUserStationAssociatedstationStationIdRequest.putUserStationAssociatedstationStationId was successful\")\n }\n}" - }, - "putuserstationdefaultstationstationid": { - "operationId": "putuserstationdefaultstationstationid", - "functionName": "putUserStationDefaultstationStationId", - "signature": "putUserStationDefaultstationStationId(userId, stationId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "stationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet stationId: String = \"\" // stationId\n\n// Set default station\nPutUserStationDefaultstationStationIdRequest.putUserStationDefaultstationStationId(userId: userId, stationId: stationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PutUserStationDefaultstationStationIdRequest.putUserStationDefaultstationStationId was successful\")\n }\n}" - }, - "getdate": { - "operationId": "getdate", - "functionName": "getDate", - "signature": "getDate()", - "return": "ServerDate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the current system date/time\nGetDateRequest.getDate() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDateRequest.getDate was successful\")\n dump(response)\n }\n}" - }, - "getipranges": { - "operationId": "getipranges", - "functionName": "getIpranges", - "signature": "getIpranges()", - "return": "IpAddressRangeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get public ip address ranges for Genesys Cloud\nGetIprangesRequest.getIpranges() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetIprangesRequest.getIpranges was successful\")\n dump(response)\n }\n}" - }, - "gettimezones": { - "operationId": "gettimezones", - "functionName": "getTimezones", - "signature": "getTimezones(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "TimeZoneEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get time zones list\nGetTimezonesRequest.getTimezones(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetTimezonesRequest.getTimezones was successful\")\n dump(response)\n }\n}" - }, - "postcertificatedetails": { - "operationId": "postcertificatedetails", - "functionName": "postCertificateDetails", - "signature": "postCertificateDetails(body)", - "parameters": [ - { - "name": "body", - "type": "Certificate", - "required": "true" - } - ], - "return": "ParsedCertificate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: Certificate = new Certificate(...) // Certificate\n\n// Returns the information about an X509 PEM encoded certificate or certificate chain.\nPostCertificateDetailsRequest.postCertificateDetails(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostCertificateDetailsRequest.postCertificateDetails was successful\")\n dump(response)\n }\n}" - }, - "deletevoicemailmessage": { - "operationId": "deletevoicemailmessage", - "functionName": "deleteVoicemailMessage", - "signature": "deleteVoicemailMessage(messageId)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // Message ID\n\n// Delete a voicemail message.\nDeleteVoicemailMessageRequest.deleteVoicemailMessage(messageId: messageId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteVoicemailMessageRequest.deleteVoicemailMessage was successful\")\n }\n}" - }, - "deletevoicemailmessages": { - "operationId": "deletevoicemailmessages", - "functionName": "deleteVoicemailMessages", - "signature": "deleteVoicemailMessages()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete all voicemail messages\nDeleteVoicemailMessagesRequest.deleteVoicemailMessages() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteVoicemailMessagesRequest.deleteVoicemailMessages was successful\")\n }\n}" - }, - "getvoicemailgroupmailbox": { - "operationId": "getvoicemailgroupmailbox", - "functionName": "getVoicemailGroupMailbox", - "signature": "getVoicemailGroupMailbox(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "return": "VoicemailMailboxInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // groupId\n\n// Get the group's mailbox information\nGetVoicemailGroupMailboxRequest.getVoicemailGroupMailbox(groupId: groupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailGroupMailboxRequest.getVoicemailGroupMailbox was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailgroupmessages": { - "operationId": "getvoicemailgroupmessages", - "functionName": "getVoicemailGroupMessages", - "signature": "getVoicemailGroupMessages(groupId, pageSize, pageNumber)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "VoicemailMessageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// List voicemail messages\nGetVoicemailGroupMessagesRequest.getVoicemailGroupMessages(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailGroupMessagesRequest.getVoicemailGroupMessages was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailgrouppolicy": { - "operationId": "getvoicemailgrouppolicy", - "functionName": "getVoicemailGroupPolicy", - "signature": "getVoicemailGroupPolicy(groupId)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - } - ], - "return": "VoicemailGroupPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\n\n// Get a group's voicemail policy\nGetVoicemailGroupPolicyRequest.getVoicemailGroupPolicy(groupId: groupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailGroupPolicyRequest.getVoicemailGroupPolicy was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmailbox": { - "operationId": "getvoicemailmailbox", - "functionName": "getVoicemailMailbox", - "signature": "getVoicemailMailbox()", - "return": "VoicemailMailboxInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the current user's mailbox information\nGetVoicemailMailboxRequest.getVoicemailMailbox() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMailboxRequest.getVoicemailMailbox was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmemailbox": { - "operationId": "getvoicemailmemailbox", - "functionName": "getVoicemailMeMailbox", - "signature": "getVoicemailMeMailbox()", - "return": "VoicemailMailboxInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the current user's mailbox information\nGetVoicemailMeMailboxRequest.getVoicemailMeMailbox() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMeMailboxRequest.getVoicemailMeMailbox was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmemessages": { - "operationId": "getvoicemailmemessages", - "functionName": "getVoicemailMeMessages", - "signature": "getVoicemailMeMessages(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "VoicemailMessageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// List voicemail messages\nGetVoicemailMeMessagesRequest.getVoicemailMeMessages(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMeMessagesRequest.getVoicemailMeMessages was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmepolicy": { - "operationId": "getvoicemailmepolicy", - "functionName": "getVoicemailMePolicy", - "signature": "getVoicemailMePolicy()", - "return": "VoicemailUserPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the current user's voicemail policy\nGetVoicemailMePolicyRequest.getVoicemailMePolicy() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMePolicyRequest.getVoicemailMePolicy was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmessage": { - "operationId": "getvoicemailmessage", - "functionName": "getVoicemailMessage", - "signature": "getVoicemailMessage(messageId, expand)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "VoicemailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // Message ID\nlet expand: [String] = [\"\"] // If the caller is a known user, which fields, if any, to expand\n\n// Get a voicemail message\nGetVoicemailMessageRequest.getVoicemailMessage(messageId: messageId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMessageRequest.getVoicemailMessage was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmessagemedia": { - "operationId": "getvoicemailmessagemedia", - "functionName": "getVoicemailMessageMedia", - "signature": "getVoicemailMessageMedia(messageId, formatId)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "formatId", - "type": "String", - "required": "false" - } - ], - "return": "VoicemailMediaInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // Message ID\nlet formatId: GetVoicemailMessageMediaRequest.FormatId_getVoicemailMessageMedia = GetVoicemailMessageMediaRequest.FormatId_getVoicemailMessageMedia.enummember // The desired media format.\n\n// Get media playback URI for this voicemail message\nGetVoicemailMessageMediaRequest.getVoicemailMessageMedia(messageId: messageId, formatId: formatId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMessageMediaRequest.getVoicemailMessageMedia was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailmessages": { - "operationId": "getvoicemailmessages", - "functionName": "getVoicemailMessages", - "signature": "getVoicemailMessages(ids, expand)", - "parameters": [ - { - "name": "ids", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "VoicemailMessageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ids: String = \"\" // An optional comma separated list of VoicemailMessage ids\nlet expand: [String] = [\"\"] // If the caller is a known user, which fields, if any, to expand\n\n// List voicemail messages\nGetVoicemailMessagesRequest.getVoicemailMessages(ids: ids, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailMessagesRequest.getVoicemailMessages was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailpolicy": { - "operationId": "getvoicemailpolicy", - "functionName": "getVoicemailPolicy", - "signature": "getVoicemailPolicy()", - "return": "VoicemailOrganizationPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a policy\nGetVoicemailPolicyRequest.getVoicemailPolicy() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailPolicyRequest.getVoicemailPolicy was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailqueuemessages": { - "operationId": "getvoicemailqueuemessages", - "functionName": "getVoicemailQueueMessages", - "signature": "getVoicemailQueueMessages(queueId, pageSize, pageNumber)", - "parameters": [ - { - "name": "queueId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "VoicemailMessageEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet queueId: String = \"\" // Queue ID\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// List voicemail messages\nGetVoicemailQueueMessagesRequest.getVoicemailQueueMessages(queueId: queueId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailQueueMessagesRequest.getVoicemailQueueMessages was successful\")\n dump(response)\n }\n}" - }, - "getvoicemailuserpolicy": { - "operationId": "getvoicemailuserpolicy", - "functionName": "getVoicemailUserpolicy", - "signature": "getVoicemailUserpolicy(userId)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - } - ], - "return": "VoicemailUserPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\n\n// Get a user's voicemail policy\nGetVoicemailUserpolicyRequest.getVoicemailUserpolicy(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetVoicemailUserpolicyRequest.getVoicemailUserpolicy was successful\")\n dump(response)\n }\n}" - }, - "patchvoicemailgrouppolicy": { - "operationId": "patchvoicemailgrouppolicy", - "functionName": "patchVoicemailGroupPolicy", - "signature": "patchVoicemailGroupPolicy(groupId, body)", - "parameters": [ - { - "name": "groupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "VoicemailGroupPolicy", - "required": "true" - } - ], - "return": "VoicemailGroupPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet groupId: String = \"\" // Group ID\nlet body: VoicemailGroupPolicy = new VoicemailGroupPolicy(...) // The group's voicemail policy\n\n// Update a group's voicemail policy\nPatchVoicemailGroupPolicyRequest.patchVoicemailGroupPolicy(groupId: groupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchVoicemailGroupPolicyRequest.patchVoicemailGroupPolicy was successful\")\n dump(response)\n }\n}" - }, - "patchvoicemailmepolicy": { - "operationId": "patchvoicemailmepolicy", - "functionName": "patchVoicemailMePolicy", - "signature": "patchVoicemailMePolicy(body)", - "parameters": [ - { - "name": "body", - "type": "VoicemailUserPolicy", - "required": "true" - } - ], - "return": "VoicemailUserPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy\n\n// Update the current user's voicemail policy\nPatchVoicemailMePolicyRequest.patchVoicemailMePolicy(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchVoicemailMePolicyRequest.patchVoicemailMePolicy was successful\")\n dump(response)\n }\n}" - }, - "patchvoicemailmessage": { - "operationId": "patchvoicemailmessage", - "functionName": "patchVoicemailMessage", - "signature": "patchVoicemailMessage(messageId, body)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "VoicemailMessage", - "required": "true" - } - ], - "return": "VoicemailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // Message ID\nlet body: VoicemailMessage = new VoicemailMessage(...) // VoicemailMessage\n\n// Update a voicemail message\nPatchVoicemailMessageRequest.patchVoicemailMessage(messageId: messageId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchVoicemailMessageRequest.patchVoicemailMessage was successful\")\n dump(response)\n }\n}" - }, - "patchvoicemailuserpolicy": { - "operationId": "patchvoicemailuserpolicy", - "functionName": "patchVoicemailUserpolicy", - "signature": "patchVoicemailUserpolicy(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "VoicemailUserPolicy", - "required": "true" - } - ], - "return": "VoicemailUserPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy\n\n// Update a user's voicemail policy\nPatchVoicemailUserpolicyRequest.patchVoicemailUserpolicy(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchVoicemailUserpolicyRequest.patchVoicemailUserpolicy was successful\")\n dump(response)\n }\n}" - }, - "postvoicemailmessages": { - "operationId": "postvoicemailmessages", - "functionName": "postVoicemailMessages", - "signature": "postVoicemailMessages(body)", - "parameters": [ - { - "name": "body", - "type": "CopyVoicemailMessage", - "required": "false" - } - ], - "return": "VoicemailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CopyVoicemailMessage = new CopyVoicemailMessage(...) // \n\n// Copy a voicemail message to a user or group\nPostVoicemailMessagesRequest.postVoicemailMessages(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostVoicemailMessagesRequest.postVoicemailMessages was successful\")\n dump(response)\n }\n}" - }, - "putvoicemailmessage": { - "operationId": "putvoicemailmessage", - "functionName": "putVoicemailMessage", - "signature": "putVoicemailMessage(messageId, body)", - "parameters": [ - { - "name": "messageId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "VoicemailMessage", - "required": "true" - } - ], - "return": "VoicemailMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet messageId: String = \"\" // Message ID\nlet body: VoicemailMessage = new VoicemailMessage(...) // VoicemailMessage\n\n// Update a voicemail message\nPutVoicemailMessageRequest.putVoicemailMessage(messageId: messageId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutVoicemailMessageRequest.putVoicemailMessage was successful\")\n dump(response)\n }\n}" - }, - "putvoicemailpolicy": { - "operationId": "putvoicemailpolicy", - "functionName": "putVoicemailPolicy", - "signature": "putVoicemailPolicy(body)", - "parameters": [ - { - "name": "body", - "type": "VoicemailOrganizationPolicy", - "required": "true" - } - ], - "return": "VoicemailOrganizationPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: VoicemailOrganizationPolicy = new VoicemailOrganizationPolicy(...) // Policy\n\n// Update a policy\nPutVoicemailPolicyRequest.putVoicemailPolicy(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutVoicemailPolicyRequest.putVoicemailPolicy was successful\")\n dump(response)\n }\n}" - }, - "putvoicemailuserpolicy": { - "operationId": "putvoicemailuserpolicy", - "functionName": "putVoicemailUserpolicy", - "signature": "putVoicemailUserpolicy(userId, body)", - "parameters": [ - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "VoicemailUserPolicy", - "required": "true" - } - ], - "return": "VoicemailUserPolicy", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: String = \"\" // User ID\nlet body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy\n\n// Update a user's voicemail policy\nPutVoicemailUserpolicyRequest.putVoicemailUserpolicy(userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutVoicemailUserpolicyRequest.putVoicemailUserpolicy was successful\")\n dump(response)\n }\n}" - }, - "deletewebchatdeployment": { - "operationId": "deletewebchatdeployment", - "functionName": "deleteWebchatDeployment", - "signature": "deleteWebchatDeployment(deploymentId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Deployment Id\n\n// Delete a WebChat deployment\nDeleteWebchatDeploymentRequest.deleteWebchatDeployment(deploymentId: deploymentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebchatDeploymentRequest.deleteWebchatDeployment was successful\")\n }\n}" - }, - "deletewebchatguestconversationmember": { - "operationId": "deletewebchatguestconversationmember", - "functionName": "deleteWebchatGuestConversationMember", - "signature": "deleteWebchatGuestConversationMember(conversationId, memberId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet memberId: String = \"\" // memberId\n\n// Remove a member from a chat conversation\nDeleteWebchatGuestConversationMemberRequest.deleteWebchatGuestConversationMember(conversationId: conversationId, memberId: memberId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebchatGuestConversationMemberRequest.deleteWebchatGuestConversationMember was successful\")\n }\n}" - }, - "deletewebchatsettings": { - "operationId": "deletewebchatsettings", - "functionName": "deleteWebchatSettings", - "signature": "deleteWebchatSettings()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Remove WebChat deployment settings\nDeleteWebchatSettingsRequest.deleteWebchatSettings() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebchatSettingsRequest.deleteWebchatSettings was successful\")\n }\n}" - }, - "getwebchatdeployment": { - "operationId": "getwebchatdeployment", - "functionName": "getWebchatDeployment", - "signature": "getWebchatDeployment(deploymentId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Deployment Id\n\n// Get a WebChat deployment\nGetWebchatDeploymentRequest.getWebchatDeployment(deploymentId: deploymentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatDeploymentRequest.getWebchatDeployment was successful\")\n dump(response)\n }\n}" - }, - "getwebchatdeployments": { - "operationId": "getwebchatdeployments", - "functionName": "getWebchatDeployments", - "signature": "getWebchatDeployments()", - "return": "WebChatDeploymentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// List WebChat deployments\nGetWebchatDeploymentsRequest.getWebchatDeployments() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatDeploymentsRequest.getWebchatDeployments was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmediarequest": { - "operationId": "getwebchatguestconversationmediarequest", - "functionName": "getWebchatGuestConversationMediarequest", - "signature": "getWebchatGuestConversationMediarequest(conversationId, mediaRequestId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "mediaRequestId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatGuestMediaRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet mediaRequestId: String = \"\" // mediaRequestId\n\n// Get a media request in the conversation\nGetWebchatGuestConversationMediarequestRequest.getWebchatGuestConversationMediarequest(conversationId: conversationId, mediaRequestId: mediaRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMediarequestRequest.getWebchatGuestConversationMediarequest was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmediarequests": { - "operationId": "getwebchatguestconversationmediarequests", - "functionName": "getWebchatGuestConversationMediarequests", - "signature": "getWebchatGuestConversationMediarequests(conversationId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatGuestMediaRequestEntityList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\n\n// Get all media requests to the guest in the conversation\nGetWebchatGuestConversationMediarequestsRequest.getWebchatGuestConversationMediarequests(conversationId: conversationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMediarequestsRequest.getWebchatGuestConversationMediarequests was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmember": { - "operationId": "getwebchatguestconversationmember", - "functionName": "getWebchatGuestConversationMember", - "signature": "getWebchatGuestConversationMember(conversationId, memberId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatMemberInfo", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet memberId: String = \"\" // memberId\n\n// Get a web chat conversation member\nGetWebchatGuestConversationMemberRequest.getWebchatGuestConversationMember(conversationId: conversationId, memberId: memberId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMemberRequest.getWebchatGuestConversationMember was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmembers": { - "operationId": "getwebchatguestconversationmembers", - "functionName": "getWebchatGuestConversationMembers", - "signature": "getWebchatGuestConversationMembers(conversationId, pageSize, pageNumber, excludeDisconnectedMembers)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "excludeDisconnectedMembers", - "type": "Bool", - "required": "false" - } - ], - "return": "WebChatMemberInfoEntityList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet pageSize: Int = 0 // The number of entries to return per page, or omitted for the default.\nlet pageNumber: Int = 0 // The page number to return, or omitted for the first page.\nlet excludeDisconnectedMembers: Bool = true // If true, the results will not contain members who have a DISCONNECTED state.\n\n// Get the members of a chat conversation.\nGetWebchatGuestConversationMembersRequest.getWebchatGuestConversationMembers(conversationId: conversationId, pageSize: pageSize, pageNumber: pageNumber, excludeDisconnectedMembers: excludeDisconnectedMembers) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMembersRequest.getWebchatGuestConversationMembers was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmessage": { - "operationId": "getwebchatguestconversationmessage", - "functionName": "getWebchatGuestConversationMessage", - "signature": "getWebchatGuestConversationMessage(conversationId, messageId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "messageId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet messageId: String = \"\" // messageId\n\n// Get a web chat conversation message\nGetWebchatGuestConversationMessageRequest.getWebchatGuestConversationMessage(conversationId: conversationId, messageId: messageId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMessageRequest.getWebchatGuestConversationMessage was successful\")\n dump(response)\n }\n}" - }, - "getwebchatguestconversationmessages": { - "operationId": "getwebchatguestconversationmessages", - "functionName": "getWebchatGuestConversationMessages", - "signature": "getWebchatGuestConversationMessages(conversationId, after, before, sortOrder, maxResults)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "after", - "type": "String", - "required": "false" - }, - { - "name": "before", - "type": "String", - "required": "false" - }, - { - "name": "sortOrder", - "type": "String", - "required": "false" - }, - { - "name": "maxResults", - "type": "Int", - "required": "false" - } - ], - "return": "WebChatMessageEntityList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet after: String = \"\" // If available, get the messages chronologically after the id of this message\nlet before: String = \"\" // If available, get the messages chronologically before the id of this message\nlet sortOrder: GetWebchatGuestConversationMessagesRequest.SortOrder_getWebchatGuestConversationMessages = GetWebchatGuestConversationMessagesRequest.SortOrder_getWebchatGuestConversationMessages.enummember // Sort order\nlet maxResults: Int = 0 // Limit the returned number of messages, up to a maximum of 100\n\n// Get the messages of a chat conversation.\nGetWebchatGuestConversationMessagesRequest.getWebchatGuestConversationMessages(conversationId: conversationId, after: after, before: before, sortOrder: sortOrder, maxResults: maxResults) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatGuestConversationMessagesRequest.getWebchatGuestConversationMessages was successful\")\n dump(response)\n }\n}" - }, - "getwebchatsettings": { - "operationId": "getwebchatsettings", - "functionName": "getWebchatSettings", - "signature": "getWebchatSettings()", - "return": "WebChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get WebChat deployment settings\nGetWebchatSettingsRequest.getWebchatSettings() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebchatSettingsRequest.getWebchatSettings was successful\")\n dump(response)\n }\n}" - }, - "patchwebchatguestconversationmediarequest": { - "operationId": "patchwebchatguestconversationmediarequest", - "functionName": "patchWebchatGuestConversationMediarequest", - "signature": "patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "mediaRequestId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WebChatGuestMediaRequest", - "required": "true" - } - ], - "return": "WebChatGuestMediaRequest", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet mediaRequestId: String = \"\" // mediaRequestId\nlet body: WebChatGuestMediaRequest = new WebChatGuestMediaRequest(...) // Request\n\n// Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED\nPatchWebchatGuestConversationMediarequestRequest.patchWebchatGuestConversationMediarequest(conversationId: conversationId, mediaRequestId: mediaRequestId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWebchatGuestConversationMediarequestRequest.patchWebchatGuestConversationMediarequest was successful\")\n dump(response)\n }\n}" - }, - "postwebchatdeployments": { - "operationId": "postwebchatdeployments", - "functionName": "postWebchatDeployments", - "signature": "postWebchatDeployments(body)", - "parameters": [ - { - "name": "body", - "type": "WebChatDeployment", - "required": "true" - } - ], - "return": "WebChatDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WebChatDeployment = new WebChatDeployment(...) // Deployment\n\n// Create WebChat deployment\nPostWebchatDeploymentsRequest.postWebchatDeployments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebchatDeploymentsRequest.postWebchatDeployments was successful\")\n dump(response)\n }\n}" - }, - "postwebchatguestconversationmembermessages": { - "operationId": "postwebchatguestconversationmembermessages", - "functionName": "postWebchatGuestConversationMemberMessages", - "signature": "postWebchatGuestConversationMemberMessages(conversationId, memberId, body)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateWebChatMessageRequest", - "required": "true" - } - ], - "return": "WebChatMessage", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet memberId: String = \"\" // memberId\nlet body: CreateWebChatMessageRequest = new CreateWebChatMessageRequest(...) // Message\n\n// Send a message in a chat conversation.\nPostWebchatGuestConversationMemberMessagesRequest.postWebchatGuestConversationMemberMessages(conversationId: conversationId, memberId: memberId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebchatGuestConversationMemberMessagesRequest.postWebchatGuestConversationMemberMessages was successful\")\n dump(response)\n }\n}" - }, - "postwebchatguestconversationmembertyping": { - "operationId": "postwebchatguestconversationmembertyping", - "functionName": "postWebchatGuestConversationMemberTyping", - "signature": "postWebchatGuestConversationMemberTyping(conversationId, memberId)", - "parameters": [ - { - "name": "conversationId", - "type": "String", - "required": "true" - }, - { - "name": "memberId", - "type": "String", - "required": "true" - } - ], - "return": "WebChatTyping", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet conversationId: String = \"\" // conversationId\nlet memberId: String = \"\" // memberId\n\n// Send a typing-indicator in a chat conversation.\nPostWebchatGuestConversationMemberTypingRequest.postWebchatGuestConversationMemberTyping(conversationId: conversationId, memberId: memberId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebchatGuestConversationMemberTypingRequest.postWebchatGuestConversationMemberTyping was successful\")\n dump(response)\n }\n}" - }, - "postwebchatguestconversations": { - "operationId": "postwebchatguestconversations", - "functionName": "postWebchatGuestConversations", - "signature": "postWebchatGuestConversations(body)", - "parameters": [ - { - "name": "body", - "type": "CreateWebChatConversationRequest", - "required": "true" - } - ], - "return": "CreateWebChatConversationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateWebChatConversationRequest = new CreateWebChatConversationRequest(...) // CreateConversationRequest\n\n// Create an ACD chat conversation from an external customer.\nPostWebchatGuestConversationsRequest.postWebchatGuestConversations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebchatGuestConversationsRequest.postWebchatGuestConversations was successful\")\n dump(response)\n }\n}" - }, - "putwebchatdeployment": { - "operationId": "putwebchatdeployment", - "functionName": "putWebchatDeployment", - "signature": "putWebchatDeployment(deploymentId, body)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WebChatDeployment", - "required": "true" - } - ], - "return": "WebChatDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Deployment Id\nlet body: WebChatDeployment = new WebChatDeployment(...) // Deployment\n\n// Update a WebChat deployment\nPutWebchatDeploymentRequest.putWebchatDeployment(deploymentId: deploymentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWebchatDeploymentRequest.putWebchatDeployment was successful\")\n dump(response)\n }\n}" - }, - "putwebchatsettings": { - "operationId": "putwebchatsettings", - "functionName": "putWebchatSettings", - "signature": "putWebchatSettings(body)", - "parameters": [ - { - "name": "body", - "type": "WebChatSettings", - "required": "true" - } - ], - "return": "WebChatSettings", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WebChatSettings = new WebChatSettings(...) // webChatSettings\n\n// Update WebChat deployment settings\nPutWebchatSettingsRequest.putWebchatSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWebchatSettingsRequest.putWebchatSettings was successful\")\n dump(response)\n }\n}" - }, - "deletewebdeploymentsconfiguration": { - "operationId": "deletewebdeploymentsconfiguration", - "functionName": "deleteWebdeploymentsConfiguration", - "signature": "deleteWebdeploymentsConfiguration(configurationId)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\n\n// Delete all versions of a configuration\nDeleteWebdeploymentsConfigurationRequest.deleteWebdeploymentsConfiguration(configurationId: configurationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebdeploymentsConfigurationRequest.deleteWebdeploymentsConfiguration was successful\")\n }\n}" - }, - "deletewebdeploymentsdeployment": { - "operationId": "deletewebdeploymentsdeployment", - "functionName": "deleteWebdeploymentsDeployment", - "signature": "deleteWebdeploymentsDeployment(deploymentId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // The deployment ID\n\n// Delete a deployment\nDeleteWebdeploymentsDeploymentRequest.deleteWebdeploymentsDeployment(deploymentId: deploymentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebdeploymentsDeploymentRequest.deleteWebdeploymentsDeployment was successful\")\n }\n}" - }, - "deletewebdeploymentsdeploymentcobrowsesessionid": { - "operationId": "deletewebdeploymentsdeploymentcobrowsesessionid", - "functionName": "deleteWebdeploymentsDeploymentCobrowseSessionId", - "signature": "deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "sessionId", - "type": "String", - "required": "true" - } - ], - "return": "JSON", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // WebMessaging deployment ID\nlet sessionId: String = \"\" // Cobrowse session id or join code\n\n// Deletes a cobrowse session\nDeleteWebdeploymentsDeploymentCobrowseSessionIdRequest.deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId: deploymentId, sessionId: sessionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteWebdeploymentsDeploymentCobrowseSessionIdRequest.deleteWebdeploymentsDeploymentCobrowseSessionId was successful\")\n dump(response)\n }\n}" - }, - "deletewebdeploymentstokenrevoke": { - "operationId": "deletewebdeploymentstokenrevoke", - "functionName": "deleteWebdeploymentsTokenRevoke", - "signature": "deleteWebdeploymentsTokenRevoke(xJourneySessionId, xJourneySessionType)", - "parameters": [ - { - "name": "xJourneySessionId", - "type": "String", - "required": "false" - }, - { - "name": "xJourneySessionType", - "type": "String", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet xJourneySessionId: String = \"\" // The Customer's journey sessionId.\nlet xJourneySessionType: String = \"\" // The Customer's journey session type.\n\n// Invalidate JWT\nDeleteWebdeploymentsTokenRevokeRequest.deleteWebdeploymentsTokenRevoke(xJourneySessionId: xJourneySessionId, xJourneySessionType: xJourneySessionType) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWebdeploymentsTokenRevokeRequest.deleteWebdeploymentsTokenRevoke was successful\")\n }\n}" - }, - "getwebdeploymentsconfigurationversion": { - "operationId": "getwebdeploymentsconfigurationversion", - "functionName": "getWebdeploymentsConfigurationVersion", - "signature": "getWebdeploymentsConfigurationVersion(configurationId, versionId)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - }, - { - "name": "versionId", - "type": "String", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\nlet versionId: String = \"\" // The version of the configuration to get\n\n// Get a configuration version\nGetWebdeploymentsConfigurationVersionRequest.getWebdeploymentsConfigurationVersion(configurationId: configurationId, versionId: versionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsConfigurationVersionRequest.getWebdeploymentsConfigurationVersion was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsconfigurationversions": { - "operationId": "getwebdeploymentsconfigurationversions", - "functionName": "getWebdeploymentsConfigurationVersions", - "signature": "getWebdeploymentsConfigurationVersions(configurationId)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\n\n// Get the versions of a configuration\nGetWebdeploymentsConfigurationVersionsRequest.getWebdeploymentsConfigurationVersions(configurationId: configurationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsConfigurationVersionsRequest.getWebdeploymentsConfigurationVersions was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsconfigurationversionsdraft": { - "operationId": "getwebdeploymentsconfigurationversionsdraft", - "functionName": "getWebdeploymentsConfigurationVersionsDraft", - "signature": "getWebdeploymentsConfigurationVersionsDraft(configurationId)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\n\n// Get the configuration draft\nGetWebdeploymentsConfigurationVersionsDraftRequest.getWebdeploymentsConfigurationVersionsDraft(configurationId: configurationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsConfigurationVersionsDraftRequest.getWebdeploymentsConfigurationVersionsDraft was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsconfigurations": { - "operationId": "getwebdeploymentsconfigurations", - "functionName": "getWebdeploymentsConfigurations", - "signature": "getWebdeploymentsConfigurations(showOnlyPublished)", - "parameters": [ - { - "name": "showOnlyPublished", - "type": "Bool", - "required": "false" - } - ], - "return": "WebDeploymentConfigurationVersionEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet showOnlyPublished: Bool = true // Get only configuration drafts with published versions\n\n// View configuration drafts\nGetWebdeploymentsConfigurationsRequest.getWebdeploymentsConfigurations(showOnlyPublished: showOnlyPublished) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsConfigurationsRequest.getWebdeploymentsConfigurations was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsdeployment": { - "operationId": "getwebdeploymentsdeployment", - "functionName": "getWebdeploymentsDeployment", - "signature": "getWebdeploymentsDeployment(deploymentId, expand)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WebDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // The deployment ID\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected. \n\n// Get a deployment\nGetWebdeploymentsDeploymentRequest.getWebdeploymentsDeployment(deploymentId: deploymentId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsDeploymentRequest.getWebdeploymentsDeployment was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsdeploymentcobrowsesessionid": { - "operationId": "getwebdeploymentsdeploymentcobrowsesessionid", - "functionName": "getWebdeploymentsDeploymentCobrowseSessionId", - "signature": "getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "sessionId", - "type": "String", - "required": "true" - } - ], - "return": "CobrowseWebMessagingSession", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // WebMessaging deployment ID\nlet sessionId: String = \"\" // Cobrowse session id or join code\n\n// Retrieves a cobrowse session\nGetWebdeploymentsDeploymentCobrowseSessionIdRequest.getWebdeploymentsDeploymentCobrowseSessionId(deploymentId: deploymentId, sessionId: sessionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsDeploymentCobrowseSessionIdRequest.getWebdeploymentsDeploymentCobrowseSessionId was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsdeploymentconfigurations": { - "operationId": "getwebdeploymentsdeploymentconfigurations", - "functionName": "getWebdeploymentsDeploymentConfigurations", - "signature": "getWebdeploymentsDeploymentConfigurations(deploymentId, type, expand)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "type", - "type": "String", - "required": "false" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WebDeploymentActiveConfigurationOnDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // The deployment ID\nlet type: String = \"\" // Get active configuration on a deployment\nlet expand: [String] = [\"\"] // Expand instructions for the return value\n\n// Get active configuration for a given deployment\nGetWebdeploymentsDeploymentConfigurationsRequest.getWebdeploymentsDeploymentConfigurations(deploymentId: deploymentId, type: type, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsDeploymentConfigurationsRequest.getWebdeploymentsDeploymentConfigurations was successful\")\n dump(response)\n }\n}" - }, - "getwebdeploymentsdeployments": { - "operationId": "getwebdeploymentsdeployments", - "functionName": "getWebdeploymentsDeployments", - "signature": "getWebdeploymentsDeployments(expand)", - "parameters": [ - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ExpandableWebDeploymentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet expand: [String] = [\"\"] // The specified entity attributes will be filled. Comma separated values expected.\n\n// Get deployments\nGetWebdeploymentsDeploymentsRequest.getWebdeploymentsDeployments(expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebdeploymentsDeploymentsRequest.getWebdeploymentsDeployments was successful\")\n dump(response)\n }\n}" - }, - "postwebdeploymentsconfigurationversionsdraftpublish": { - "operationId": "postwebdeploymentsconfigurationversionsdraftpublish", - "functionName": "postWebdeploymentsConfigurationVersionsDraftPublish", - "signature": "postWebdeploymentsConfigurationVersionsDraftPublish(configurationId)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\n\n// Publish the configuration draft and create a new version\nPostWebdeploymentsConfigurationVersionsDraftPublishRequest.postWebdeploymentsConfigurationVersionsDraftPublish(configurationId: configurationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebdeploymentsConfigurationVersionsDraftPublishRequest.postWebdeploymentsConfigurationVersionsDraftPublish was successful\")\n dump(response)\n }\n}" - }, - "postwebdeploymentsconfigurations": { - "operationId": "postwebdeploymentsconfigurations", - "functionName": "postWebdeploymentsConfigurations", - "signature": "postWebdeploymentsConfigurations(configurationVersion)", - "parameters": [ - { - "name": "configurationVersion", - "type": "WebDeploymentConfigurationVersion", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationVersion: WebDeploymentConfigurationVersion = new WebDeploymentConfigurationVersion(...) // \n\n// Create a configuration draft\nPostWebdeploymentsConfigurationsRequest.postWebdeploymentsConfigurations(configurationVersion: configurationVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebdeploymentsConfigurationsRequest.postWebdeploymentsConfigurations was successful\")\n dump(response)\n }\n}" - }, - "postwebdeploymentsdeployments": { - "operationId": "postwebdeploymentsdeployments", - "functionName": "postWebdeploymentsDeployments", - "signature": "postWebdeploymentsDeployments(deployment)", - "parameters": [ - { - "name": "deployment", - "type": "WebDeployment", - "required": "true" - } - ], - "return": "WebDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deployment: WebDeployment = new WebDeployment(...) // \n\n// Create a deployment\nPostWebdeploymentsDeploymentsRequest.postWebdeploymentsDeployments(deployment: deployment) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebdeploymentsDeploymentsRequest.postWebdeploymentsDeployments was successful\")\n dump(response)\n }\n}" - }, - "postwebdeploymentstokenoauthcodegrantjwtexchange": { - "operationId": "postwebdeploymentstokenoauthcodegrantjwtexchange", - "functionName": "postWebdeploymentsTokenOauthcodegrantjwtexchange", - "signature": "postWebdeploymentsTokenOauthcodegrantjwtexchange(body)", - "parameters": [ - { - "name": "body", - "type": "WebDeploymentsOAuthExchangeRequest", - "required": "true" - } - ], - "return": "WebDeploymentsAuthorizationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WebDeploymentsOAuthExchangeRequest = new WebDeploymentsOAuthExchangeRequest(...) // webDeploymentsOAuthExchangeRequest\n\n// Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.\nPostWebdeploymentsTokenOauthcodegrantjwtexchangeRequest.postWebdeploymentsTokenOauthcodegrantjwtexchange(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebdeploymentsTokenOauthcodegrantjwtexchangeRequest.postWebdeploymentsTokenOauthcodegrantjwtexchange was successful\")\n dump(response)\n }\n}" - }, - "postwebdeploymentstokenrefresh": { - "operationId": "postwebdeploymentstokenrefresh", - "functionName": "postWebdeploymentsTokenRefresh", - "signature": "postWebdeploymentsTokenRefresh(body)", - "parameters": [ - { - "name": "body", - "type": "WebDeploymentsRefreshJWTRequest", - "required": "false" - } - ], - "return": "SignedData", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WebDeploymentsRefreshJWTRequest = new WebDeploymentsRefreshJWTRequest(...) // \n\n// Refresh a JWT.\nPostWebdeploymentsTokenRefreshRequest.postWebdeploymentsTokenRefresh(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWebdeploymentsTokenRefreshRequest.postWebdeploymentsTokenRefresh was successful\")\n dump(response)\n }\n}" - }, - "putwebdeploymentsconfigurationversionsdraft": { - "operationId": "putwebdeploymentsconfigurationversionsdraft", - "functionName": "putWebdeploymentsConfigurationVersionsDraft", - "signature": "putWebdeploymentsConfigurationVersionsDraft(configurationId, configurationVersion)", - "parameters": [ - { - "name": "configurationId", - "type": "String", - "required": "true" - }, - { - "name": "configurationVersion", - "type": "WebDeploymentConfigurationVersion", - "required": "true" - } - ], - "return": "WebDeploymentConfigurationVersion", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet configurationId: String = \"\" // The configuration version ID\nlet configurationVersion: WebDeploymentConfigurationVersion = new WebDeploymentConfigurationVersion(...) // \n\n// Update the configuration draft\nPutWebdeploymentsConfigurationVersionsDraftRequest.putWebdeploymentsConfigurationVersionsDraft(configurationId: configurationId, configurationVersion: configurationVersion) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWebdeploymentsConfigurationVersionsDraftRequest.putWebdeploymentsConfigurationVersionsDraft was successful\")\n dump(response)\n }\n}" - }, - "putwebdeploymentsdeployment": { - "operationId": "putwebdeploymentsdeployment", - "functionName": "putWebdeploymentsDeployment", - "signature": "putWebdeploymentsDeployment(deploymentId, deployment)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "deployment", - "type": "WebDeployment", - "required": "true" - } - ], - "return": "WebDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // The deployment ID\nlet deployment: WebDeployment = new WebDeployment(...) // \n\n// Update a deployment\nPutWebdeploymentsDeploymentRequest.putWebdeploymentsDeployment(deploymentId: deploymentId, deployment: deployment) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWebdeploymentsDeploymentRequest.putWebdeploymentsDeployment was successful\")\n dump(response)\n }\n}" - }, - "getwebmessagingmessages": { - "operationId": "getwebmessagingmessages", - "functionName": "getWebmessagingMessages", - "signature": "getWebmessagingMessages(pageSize, pageNumber)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - } - ], - "return": "WebMessagingMessageEntityList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Page size\nlet pageNumber: Int = 0 // Page number\n\n// Get the messages for a web messaging session.\nGetWebmessagingMessagesRequest.getWebmessagingMessages(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWebmessagingMessagesRequest.getWebmessagingMessages was successful\")\n dump(response)\n }\n}" - }, - "deletewidgetsdeployment": { - "operationId": "deletewidgetsdeployment", - "functionName": "deleteWidgetsDeployment", - "signature": "deleteWidgetsDeployment(deploymentId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Widget Config Id\n\n// Delete a Widget deployment\nDeleteWidgetsDeploymentRequest.deleteWidgetsDeployment(deploymentId: deploymentId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWidgetsDeploymentRequest.deleteWidgetsDeployment was successful\")\n }\n}" - }, - "getwidgetsdeployment": { - "operationId": "getwidgetsdeployment", - "functionName": "getWidgetsDeployment", - "signature": "getWidgetsDeployment(deploymentId)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - } - ], - "return": "WidgetDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Widget Config Id\n\n// Get a Widget deployment\nGetWidgetsDeploymentRequest.getWidgetsDeployment(deploymentId: deploymentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWidgetsDeploymentRequest.getWidgetsDeployment was successful\")\n dump(response)\n }\n}" - }, - "getwidgetsdeployments": { - "operationId": "getwidgetsdeployments", - "functionName": "getWidgetsDeployments", - "signature": "getWidgetsDeployments()", - "return": "WidgetDeploymentEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// List Widget deployments\nGetWidgetsDeploymentsRequest.getWidgetsDeployments() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWidgetsDeploymentsRequest.getWidgetsDeployments was successful\")\n dump(response)\n }\n}" - }, - "postwidgetsdeployments": { - "operationId": "postwidgetsdeployments", - "functionName": "postWidgetsDeployments", - "signature": "postWidgetsDeployments(body)", - "parameters": [ - { - "name": "body", - "type": "WidgetDeployment", - "required": "true" - } - ], - "return": "WidgetDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WidgetDeployment = new WidgetDeployment(...) // Deployment\n\n// Create Widget deployment\nPostWidgetsDeploymentsRequest.postWidgetsDeployments(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWidgetsDeploymentsRequest.postWidgetsDeployments was successful\")\n dump(response)\n }\n}" - }, - "putwidgetsdeployment": { - "operationId": "putwidgetsdeployment", - "functionName": "putWidgetsDeployment", - "signature": "putWidgetsDeployment(deploymentId, body)", - "parameters": [ - { - "name": "deploymentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WidgetDeployment", - "required": "true" - } - ], - "return": "WidgetDeployment", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet deploymentId: String = \"\" // Widget Config Id\nlet body: WidgetDeployment = new WidgetDeployment(...) // Deployment\n\n// Update a Widget deployment\nPutWidgetsDeploymentRequest.putWidgetsDeployment(deploymentId: deploymentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWidgetsDeploymentRequest.putWidgetsDeployment was successful\")\n dump(response)\n }\n}" - }, - "deleteworkforcemanagementbusinessunit": { - "operationId": "deleteworkforcemanagementbusinessunit", - "functionName": "deleteWorkforcemanagementBusinessunit", - "signature": "deleteWorkforcemanagementBusinessunit(businessUnitId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\n\n// Delete business unit\nDeleteWorkforcemanagementBusinessunitRequest.deleteWorkforcemanagementBusinessunit(businessUnitId: businessUnitId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitRequest.deleteWorkforcemanagementBusinessunit was successful\")\n }\n}" - }, - "deleteworkforcemanagementbusinessunitactivitycode": { - "operationId": "deleteworkforcemanagementbusinessunitactivitycode", - "functionName": "deleteWorkforcemanagementBusinessunitActivitycode", - "signature": "deleteWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "activityCodeId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet activityCodeId: String = \"\" // The ID of the activity code to delete\n\n// Deletes an activity code\nDeleteWorkforcemanagementBusinessunitActivitycodeRequest.deleteWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitActivitycodeRequest.deleteWorkforcemanagementBusinessunitActivitycode was successful\")\n }\n}" - }, - "deleteworkforcemanagementbusinessunitplanninggroup": { - "operationId": "deleteworkforcemanagementbusinessunitplanninggroup", - "functionName": "deleteWorkforcemanagementBusinessunitPlanninggroup", - "signature": "deleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "planningGroupId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet planningGroupId: String = \"\" // The ID of a planning group to delete\n\n// Deletes the planning group\nDeleteWorkforcemanagementBusinessunitPlanninggroupRequest.deleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitPlanninggroupRequest.deleteWorkforcemanagementBusinessunitPlanninggroup was successful\")\n }\n}" - }, - "deleteworkforcemanagementbusinessunitschedulingrun": { - "operationId": "deleteworkforcemanagementbusinessunitschedulingrun", - "functionName": "deleteWorkforcemanagementBusinessunitSchedulingRun", - "signature": "deleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "runId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet runId: String = \"\" // The ID of the schedule run\n\n// Cancel a scheduling run\nDeleteWorkforcemanagementBusinessunitSchedulingRunRequest.deleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitSchedulingRunRequest.deleteWorkforcemanagementBusinessunitSchedulingRun was successful\")\n }\n}" - }, - "deleteworkforcemanagementbusinessunitservicegoaltemplate": { - "operationId": "deleteworkforcemanagementbusinessunitservicegoaltemplate", - "functionName": "deleteWorkforcemanagementBusinessunitServicegoaltemplate", - "signature": "deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "serviceGoalTemplateId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet serviceGoalTemplateId: String = \"\" // The ID of the service goal template to delete\n\n// Delete a service goal template\nDeleteWorkforcemanagementBusinessunitServicegoaltemplateRequest.deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitServicegoaltemplateRequest.deleteWorkforcemanagementBusinessunitServicegoaltemplate was successful\")\n }\n}" - }, - "deleteworkforcemanagementbusinessunitweekschedule": { - "operationId": "deleteworkforcemanagementbusinessunitweekschedule", - "functionName": "deleteWorkforcemanagementBusinessunitWeekSchedule", - "signature": "deleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId, weekId, scheduleId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "BuAsyncScheduleResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\n\n// Delete a schedule\nDeleteWorkforcemanagementBusinessunitWeekScheduleRequest.deleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"DeleteWorkforcemanagementBusinessunitWeekScheduleRequest.deleteWorkforcemanagementBusinessunitWeekSchedule was successful\")\n dump(response)\n }\n}" - }, - "deleteworkforcemanagementbusinessunitweekshorttermforecast": { - "operationId": "deleteworkforcemanagementbusinessunitweekshorttermforecast", - "functionName": "deleteWorkforcemanagementBusinessunitWeekShorttermforecast", - "signature": "deleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\n\n// Delete a short term forecast\nDeleteWorkforcemanagementBusinessunitWeekShorttermforecastRequest.deleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementBusinessunitWeekShorttermforecastRequest.deleteWorkforcemanagementBusinessunitWeekShorttermforecast was successful\")\n }\n}" - }, - "deleteworkforcemanagementcalendarurlics": { - "operationId": "deleteworkforcemanagementcalendarurlics", - "functionName": "deleteWorkforcemanagementCalendarUrlIcs", - "signature": "deleteWorkforcemanagementCalendarUrlIcs()", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Disable generated calendar link for the current user\nDeleteWorkforcemanagementCalendarUrlIcsRequest.deleteWorkforcemanagementCalendarUrlIcs() { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementCalendarUrlIcsRequest.deleteWorkforcemanagementCalendarUrlIcs was successful\")\n }\n}" - }, - "deleteworkforcemanagementmanagementunit": { - "operationId": "deleteworkforcemanagementmanagementunit", - "functionName": "deleteWorkforcemanagementManagementunit", - "signature": "deleteWorkforcemanagementManagementunit(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\n\n// Delete management unit\nDeleteWorkforcemanagementManagementunitRequest.deleteWorkforcemanagementManagementunit(managementUnitId: managementUnitId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementManagementunitRequest.deleteWorkforcemanagementManagementunit was successful\")\n }\n}" - }, - "deleteworkforcemanagementmanagementunittimeofflimit": { - "operationId": "deleteworkforcemanagementmanagementunittimeofflimit", - "functionName": "deleteWorkforcemanagementManagementunitTimeofflimit", - "signature": "deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffLimitId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet timeOffLimitId: String = \"\" // The ID of the time off limit object to delete\n\n// Deletes a time off limit object\nDeleteWorkforcemanagementManagementunitTimeofflimitRequest.deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementManagementunitTimeofflimitRequest.deleteWorkforcemanagementManagementunitTimeofflimit was successful\")\n }\n}" - }, - "deleteworkforcemanagementmanagementunittimeoffplan": { - "operationId": "deleteworkforcemanagementmanagementunittimeoffplan", - "functionName": "deleteWorkforcemanagementManagementunitTimeoffplan", - "signature": "deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffPlanId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet timeOffPlanId: String = \"\" // The ID of the time off plan to delete\n\n// Deletes a time off plan\nDeleteWorkforcemanagementManagementunitTimeoffplanRequest.deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementManagementunitTimeoffplanRequest.deleteWorkforcemanagementManagementunitTimeoffplan was successful\")\n }\n}" - }, - "deleteworkforcemanagementmanagementunitworkplan": { - "operationId": "deleteworkforcemanagementmanagementunitworkplan", - "functionName": "deleteWorkforcemanagementManagementunitWorkplan", - "signature": "deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanId: String = \"\" // The ID of the work plan to delete\n\n// Delete a work plan\nDeleteWorkforcemanagementManagementunitWorkplanRequest.deleteWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementManagementunitWorkplanRequest.deleteWorkforcemanagementManagementunitWorkplan was successful\")\n }\n}" - }, - "deleteworkforcemanagementmanagementunitworkplanrotation": { - "operationId": "deleteworkforcemanagementmanagementunitworkplanrotation", - "functionName": "deleteWorkforcemanagementManagementunitWorkplanrotation", - "signature": "deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanRotationId", - "type": "String", - "required": "true" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanRotationId: String = \"\" // The ID of the work plan rotation to be deleted\n\n// Delete a work plan rotation\nDeleteWorkforcemanagementManagementunitWorkplanrotationRequest.deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteWorkforcemanagementManagementunitWorkplanrotationRequest.deleteWorkforcemanagementManagementunitWorkplanrotation was successful\")\n }\n}" - }, - "getworkforcemanagementadherence": { - "operationId": "getworkforcemanagementadherence", - "functionName": "getWorkforcemanagementAdherence", - "signature": "getWorkforcemanagementAdherence(userId)", - "parameters": [ - { - "name": "userId", - "type": "[String]", - "required": "true" - } - ], - "return": "[UserScheduleAdherence]", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet userId: [String] = [\"\"] // User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request\n\n// Get a list of UserScheduleAdherence records for the requested users\nGetWorkforcemanagementAdherenceRequest.getWorkforcemanagementAdherence(userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdherenceRequest.getWorkforcemanagementAdherence was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementadherenceexplanation": { - "operationId": "getworkforcemanagementadherenceexplanation", - "functionName": "getWorkforcemanagementAdherenceExplanation", - "signature": "getWorkforcemanagementAdherenceExplanation(explanationId)", - "parameters": [ - { - "name": "explanationId", - "type": "String", - "required": "true" - } - ], - "return": "AdherenceExplanationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet explanationId: String = \"\" // The ID of the explanation to update\n\n// Get an adherence explanation for the current user\nGetWorkforcemanagementAdherenceExplanationRequest.getWorkforcemanagementAdherenceExplanation(explanationId: explanationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdherenceExplanationRequest.getWorkforcemanagementAdherenceExplanation was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementadherenceexplanationsjob": { - "operationId": "getworkforcemanagementadherenceexplanationsjob", - "functionName": "getWorkforcemanagementAdherenceExplanationsJob", - "signature": "getWorkforcemanagementAdherenceExplanationsJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "AdherenceExplanationJob", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The ID of the job\n\n// Query the status of an adherence explanation operation. Only the user who started the operation can query the status\nGetWorkforcemanagementAdherenceExplanationsJobRequest.getWorkforcemanagementAdherenceExplanationsJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdherenceExplanationsJobRequest.getWorkforcemanagementAdherenceExplanationsJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementadherencehistoricalbulkjob": { - "operationId": "getworkforcemanagementadherencehistoricalbulkjob", - "functionName": "getWorkforcemanagementAdherenceHistoricalBulkJob", - "signature": "getWorkforcemanagementAdherenceHistoricalBulkJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "WfmHistoricalAdherenceBulkResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // ID of the job to get\n\n// Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status\nGetWorkforcemanagementAdherenceHistoricalBulkJobRequest.getWorkforcemanagementAdherenceHistoricalBulkJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdherenceHistoricalBulkJobRequest.getWorkforcemanagementAdherenceHistoricalBulkJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementadherencehistoricaljob": { - "operationId": "getworkforcemanagementadherencehistoricaljob", - "functionName": "getWorkforcemanagementAdherenceHistoricalJob", - "signature": "getWorkforcemanagementAdherenceHistoricalJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "WfmHistoricalAdherenceResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Query the status of a historical adherence request operation. Only the user who started the operation can query the status\nGetWorkforcemanagementAdherenceHistoricalJobRequest.getWorkforcemanagementAdherenceHistoricalJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdherenceHistoricalJobRequest.getWorkforcemanagementAdherenceHistoricalJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementadhocmodelingjob": { - "operationId": "getworkforcemanagementadhocmodelingjob", - "functionName": "getWorkforcemanagementAdhocmodelingjob", - "signature": "getWorkforcemanagementAdhocmodelingjob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "ModelingStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The id of the modeling job\n\n// Get status of the modeling job\nGetWorkforcemanagementAdhocmodelingjobRequest.getWorkforcemanagementAdhocmodelingjob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAdhocmodelingjobRequest.getWorkforcemanagementAdhocmodelingjob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementagentadherenceexplanation": { - "operationId": "getworkforcemanagementagentadherenceexplanation", - "functionName": "getWorkforcemanagementAgentAdherenceExplanation", - "signature": "getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "explanationId", - "type": "String", - "required": "true" - } - ], - "return": "AdherenceExplanationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent to query\nlet explanationId: String = \"\" // The ID of the explanation to update\n\n// Get an adherence explanation\nGetWorkforcemanagementAgentAdherenceExplanationRequest.getWorkforcemanagementAgentAdherenceExplanation(agentId: agentId, explanationId: explanationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAgentAdherenceExplanationRequest.getWorkforcemanagementAgentAdherenceExplanation was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementagentmanagementunit": { - "operationId": "getworkforcemanagementagentmanagementunit", - "functionName": "getWorkforcemanagementAgentManagementunit", - "signature": "getWorkforcemanagementAgentManagementunit(agentId)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - } - ], - "return": "AgentManagementUnitReference", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent to look up\n\n// Get the management unit to which the agent belongs\nGetWorkforcemanagementAgentManagementunitRequest.getWorkforcemanagementAgentManagementunit(agentId: agentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAgentManagementunitRequest.getWorkforcemanagementAgentManagementunit was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementagentsmemanagementunit": { - "operationId": "getworkforcemanagementagentsmemanagementunit", - "functionName": "getWorkforcemanagementAgentsMeManagementunit", - "signature": "getWorkforcemanagementAgentsMeManagementunit()", - "return": "AgentManagementUnitReference", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get the management unit to which the currently logged in agent belongs\nGetWorkforcemanagementAgentsMeManagementunitRequest.getWorkforcemanagementAgentsMeManagementunit() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementAgentsMeManagementunitRequest.getWorkforcemanagementAgentsMeManagementunit was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunit": { - "operationId": "getworkforcemanagementbusinessunit", - "functionName": "getWorkforcemanagementBusinessunit", - "signature": "getWorkforcemanagementBusinessunit(businessUnitId, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "BusinessUnitResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet expand: [String] = [\"\"] // Include to access additional data on the business unit\n\n// Get business unit\nGetWorkforcemanagementBusinessunitRequest.getWorkforcemanagementBusinessunit(businessUnitId: businessUnitId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitRequest.getWorkforcemanagementBusinessunit was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitactivitycode": { - "operationId": "getworkforcemanagementbusinessunitactivitycode", - "functionName": "getWorkforcemanagementBusinessunitActivitycode", - "signature": "getWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "activityCodeId", - "type": "String", - "required": "true" - } - ], - "return": "BusinessUnitActivityCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet activityCodeId: String = \"\" // The ID of the activity code to fetch\n\n// Get an activity code\nGetWorkforcemanagementBusinessunitActivitycodeRequest.getWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitActivitycodeRequest.getWorkforcemanagementBusinessunitActivitycode was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitactivitycodes": { - "operationId": "getworkforcemanagementbusinessunitactivitycodes", - "functionName": "getWorkforcemanagementBusinessunitActivitycodes", - "signature": "getWorkforcemanagementBusinessunitActivitycodes(businessUnitId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - } - ], - "return": "BusinessUnitActivityCodeListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\n\n// Get activity codes\nGetWorkforcemanagementBusinessunitActivitycodesRequest.getWorkforcemanagementBusinessunitActivitycodes(businessUnitId: businessUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitActivitycodesRequest.getWorkforcemanagementBusinessunitActivitycodes was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitintradayplanninggroups": { - "operationId": "getworkforcemanagementbusinessunitintradayplanninggroups", - "functionName": "getWorkforcemanagementBusinessunitIntradayPlanninggroups", - "signature": "getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, date)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "date", - "type": "Date", - "required": "true" - } - ], - "return": "WfmIntradayPlanningGroupListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet date: Date = new Date(...) // 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\n\n// Get intraday planning groups for the given date\nGetWorkforcemanagementBusinessunitIntradayPlanninggroupsRequest.getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId: businessUnitId, date: date) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitIntradayPlanninggroupsRequest.getWorkforcemanagementBusinessunitIntradayPlanninggroups was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitmanagementunits": { - "operationId": "getworkforcemanagementbusinessunitmanagementunits", - "functionName": "getWorkforcemanagementBusinessunitManagementunits", - "signature": "getWorkforcemanagementBusinessunitManagementunits(businessUnitId, feature, divisionId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "String", - "required": "false" - } - ], - "return": "ManagementUnitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet feature: GetWorkforcemanagementBusinessunitManagementunitsRequest.Feature_getWorkforcemanagementBusinessunitManagementunits = GetWorkforcemanagementBusinessunitManagementunitsRequest.Feature_getWorkforcemanagementBusinessunitManagementunits.enummember // If specified, the list of management units for which the user is authorized to use the requested feature will be returned\nlet divisionId: String = \"\" // If specified, the list of management units belonging to the specified division will be returned\n\n// Get all authorized management units in the business unit\nGetWorkforcemanagementBusinessunitManagementunitsRequest.getWorkforcemanagementBusinessunitManagementunits(businessUnitId: businessUnitId, feature: feature, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitManagementunitsRequest.getWorkforcemanagementBusinessunitManagementunits was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitplanninggroup": { - "operationId": "getworkforcemanagementbusinessunitplanninggroup", - "functionName": "getWorkforcemanagementBusinessunitPlanninggroup", - "signature": "getWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "planningGroupId", - "type": "String", - "required": "true" - } - ], - "return": "PlanningGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet planningGroupId: String = \"\" // The ID of a planning group to fetch\n\n// Get a planning group\nGetWorkforcemanagementBusinessunitPlanninggroupRequest.getWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitPlanninggroupRequest.getWorkforcemanagementBusinessunitPlanninggroup was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitplanninggroups": { - "operationId": "getworkforcemanagementbusinessunitplanninggroups", - "functionName": "getWorkforcemanagementBusinessunitPlanninggroups", - "signature": "getWorkforcemanagementBusinessunitPlanninggroups(businessUnitId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - } - ], - "return": "PlanningGroupList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\n\n// Gets list of planning groups\nGetWorkforcemanagementBusinessunitPlanninggroupsRequest.getWorkforcemanagementBusinessunitPlanninggroups(businessUnitId: businessUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitPlanninggroupsRequest.getWorkforcemanagementBusinessunitPlanninggroups was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitschedulingrun": { - "operationId": "getworkforcemanagementbusinessunitschedulingrun", - "functionName": "getWorkforcemanagementBusinessunitSchedulingRun", - "signature": "getWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "runId", - "type": "String", - "required": "true" - } - ], - "return": "BuScheduleRun", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet runId: String = \"\" // The ID of the schedule run\n\n// Get a scheduling run\nGetWorkforcemanagementBusinessunitSchedulingRunRequest.getWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitSchedulingRunRequest.getWorkforcemanagementBusinessunitSchedulingRun was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitschedulingrunresult": { - "operationId": "getworkforcemanagementbusinessunitschedulingrunresult", - "functionName": "getWorkforcemanagementBusinessunitSchedulingRunResult", - "signature": "getWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId, runId, managementUnitIds, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "runId", - "type": "String", - "required": "true" - }, - { - "name": "managementUnitIds", - "type": "[String]", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "true" - } - ], - "return": "BuRescheduleResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet runId: String = \"\" // The ID of the schedule run\nlet managementUnitIds: [String] = [\"\"] // The IDs of the management units for which to fetch the reschedule results\nlet expand: [String] = [\"\"] // The fields to expand. Omitting will return an empty response\n\n// Get the result of a rescheduling operation\nGetWorkforcemanagementBusinessunitSchedulingRunResultRequest.getWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId: businessUnitId, runId: runId, managementUnitIds: managementUnitIds, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitSchedulingRunResultRequest.getWorkforcemanagementBusinessunitSchedulingRunResult was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitschedulingruns": { - "operationId": "getworkforcemanagementbusinessunitschedulingruns", - "functionName": "getWorkforcemanagementBusinessunitSchedulingRuns", - "signature": "getWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - } - ], - "return": "BuScheduleRunListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\n\n// Get the list of scheduling runs\nGetWorkforcemanagementBusinessunitSchedulingRunsRequest.getWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId: businessUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitSchedulingRunsRequest.getWorkforcemanagementBusinessunitSchedulingRuns was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitservicegoaltemplate": { - "operationId": "getworkforcemanagementbusinessunitservicegoaltemplate", - "functionName": "getWorkforcemanagementBusinessunitServicegoaltemplate", - "signature": "getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "serviceGoalTemplateId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ServiceGoalTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet serviceGoalTemplateId: String = \"\" // The ID of a service goal template to fetch\nlet expand: [String] = [\"\"] // Include to access additional data on the service goal template\n\n// Get a service goal template\nGetWorkforcemanagementBusinessunitServicegoaltemplateRequest.getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitServicegoaltemplateRequest.getWorkforcemanagementBusinessunitServicegoaltemplate was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitservicegoaltemplates": { - "operationId": "getworkforcemanagementbusinessunitservicegoaltemplates", - "functionName": "getWorkforcemanagementBusinessunitServicegoaltemplates", - "signature": "getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ServiceGoalTemplateList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet expand: [String] = [\"\"] // Include to access additional data on the service goal template\n\n// Gets list of service goal templates\nGetWorkforcemanagementBusinessunitServicegoaltemplatesRequest.getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId: businessUnitId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitServicegoaltemplatesRequest.getWorkforcemanagementBusinessunitServicegoaltemplates was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekschedule": { - "operationId": "getworkforcemanagementbusinessunitweekschedule", - "functionName": "getWorkforcemanagementBusinessunitWeekSchedule", - "signature": "getWorkforcemanagementBusinessunitWeekSchedule(businessUnitId, weekId, scheduleId, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "BuScheduleMetadata", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet expand: GetWorkforcemanagementBusinessunitWeekScheduleRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedule = GetWorkforcemanagementBusinessunitWeekScheduleRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedule.enummember // expand\n\n// 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\nGetWorkforcemanagementBusinessunitWeekScheduleRequest.getWorkforcemanagementBusinessunitWeekSchedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekScheduleRequest.getWorkforcemanagementBusinessunitWeekSchedule was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekschedulegenerationresults": { - "operationId": "getworkforcemanagementbusinessunitweekschedulegenerationresults", - "functionName": "getWorkforcemanagementBusinessunitWeekScheduleGenerationresults", - "signature": "getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId, weekId, scheduleId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - } - ], - "return": "ScheduleGenerationResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\n\n// Get the generation results for a generated schedule\nGetWorkforcemanagementBusinessunitWeekScheduleGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekScheduleGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekScheduleGenerationresults was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekscheduleheadcountforecast": { - "operationId": "getworkforcemanagementbusinessunitweekscheduleheadcountforecast", - "functionName": "getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast", - "signature": "getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId, weekId, scheduleId, forceDownload)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "forceDownload", - "type": "Bool", - "required": "false" - } - ], - "return": "BuHeadcountForecastResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet forceDownload: Bool = true // Whether to force the result to come via download url. For testing purposes only\n\n// Get the headcount forecast by planning group for the schedule\nGetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastRequest.getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, forceDownload: forceDownload) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastRequest.getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekschedulehistoryagent": { - "operationId": "getworkforcemanagementbusinessunitweekschedulehistoryagent", - "functionName": "getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent", - "signature": "getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId, weekId, scheduleId, agentId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "agentId", - "type": "String", - "required": "true" - } - ], - "return": "BuAgentScheduleHistoryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet agentId: String = \"\" // THe ID of the agent\n\n// Loads agent's schedule history.\nGetWorkforcemanagementBusinessunitWeekScheduleHistoryAgentRequest.getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, agentId: agentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgentRequest.getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekschedules": { - "operationId": "getworkforcemanagementbusinessunitweekschedules", - "functionName": "getWorkforcemanagementBusinessunitWeekSchedules", - "signature": "getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId, weekId, includeOnlyPublished, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "String", - "required": "true" - }, - { - "name": "includeOnlyPublished", - "type": "Bool", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - } - ], - "return": "BuScheduleListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: String = \"\" // First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules\nlet includeOnlyPublished: Bool = true // includeOnlyPublished\nlet expand: GetWorkforcemanagementBusinessunitWeekSchedulesRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedules = GetWorkforcemanagementBusinessunitWeekSchedulesRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedules.enummember // expand\n\n// Get the list of week schedules for the specified week\nGetWorkforcemanagementBusinessunitWeekSchedulesRequest.getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId: businessUnitId, weekId: weekId, includeOnlyPublished: includeOnlyPublished, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekSchedulesRequest.getWorkforcemanagementBusinessunitWeekSchedules was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecast": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecast", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecast", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, expand)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "BuShortTermForecast", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\nlet expand: [String] = [\"\"] // Include to access additional data on the forecast\n\n// Get a short term forecast\nGetWorkforcemanagementBusinessunitWeekShorttermforecastRequest.getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastRequest.getWorkforcemanagementBusinessunitWeekShorttermforecast was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecastdata": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastdata", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastData", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId, weekDateId, forecastId, weekNumber, forceDownloadService)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - }, - { - "name": "weekNumber", - "type": "Int", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "BuForecastResultResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\nlet weekNumber: Int = 0 // The week number to fetch (for multi-week forecasts)\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Get the result of a short term forecast calculation\nGetWorkforcemanagementBusinessunitWeekShorttermforecastDataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, weekNumber: weekNumber, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastDataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastData was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecastgenerationresults": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastgenerationresults", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId, weekDateId, forecastId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - } - ], - "return": "BuForecastGenerationResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\n\n// Gets the forecast generation results\nGetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecastlongtermforecastdata": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastlongtermforecastdata", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(businessUnitId, weekDateId, forecastId, forceDownloadService)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "LongTermForecastResultResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Get the result of a long term forecast calculation\nGetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecastplanninggroups": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastplanninggroups", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId, weekDateId, forecastId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - } - ], - "return": "ForecastPlanningGroupsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast\n\n// Gets the forecast planning group snapshot\nGetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitweekshorttermforecasts": { - "operationId": "getworkforcemanagementbusinessunitweekshorttermforecasts", - "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecasts", - "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "String", - "required": "true" - } - ], - "return": "BuShortTermForecastListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: String = \"\" // The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts\n\n// Get short term forecasts\nGetWorkforcemanagementBusinessunitWeekShorttermforecastsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId: businessUnitId, weekDateId: weekDateId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitWeekShorttermforecastsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecasts was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunits": { - "operationId": "getworkforcemanagementbusinessunits", - "functionName": "getWorkforcemanagementBusinessunits", - "signature": "getWorkforcemanagementBusinessunits(feature, divisionId)", - "parameters": [ - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "String", - "required": "false" - } - ], - "return": "BusinessUnitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet feature: GetWorkforcemanagementBusinessunitsRequest.Feature_getWorkforcemanagementBusinessunits = GetWorkforcemanagementBusinessunitsRequest.Feature_getWorkforcemanagementBusinessunits.enummember // If specified, the list of business units for which the user is authorized to use the requested feature will be returned\nlet divisionId: String = \"\" // If specified, the list of business units belonging to the specified division will be returned\n\n// Get business units\nGetWorkforcemanagementBusinessunitsRequest.getWorkforcemanagementBusinessunits(feature: feature, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitsRequest.getWorkforcemanagementBusinessunits was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementbusinessunitsdivisionviews": { - "operationId": "getworkforcemanagementbusinessunitsdivisionviews", - "functionName": "getWorkforcemanagementBusinessunitsDivisionviews", - "signature": "getWorkforcemanagementBusinessunitsDivisionviews(divisionId)", - "parameters": [ - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "BusinessUnitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: [String] = [\"\"] // The divisionIds to filter by. If omitted, will return business units in all divisions\n\n// Get business units across divisions\nGetWorkforcemanagementBusinessunitsDivisionviewsRequest.getWorkforcemanagementBusinessunitsDivisionviews(divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementBusinessunitsDivisionviewsRequest.getWorkforcemanagementBusinessunitsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementcalendardataics": { - "operationId": "getworkforcemanagementcalendardataics", - "functionName": "getWorkforcemanagementCalendarDataIcs", - "signature": "getWorkforcemanagementCalendarDataIcs(calendarId)", - "parameters": [ - { - "name": "calendarId", - "type": "String", - "required": "true" - } - ], - "return": "String", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet calendarId: String = \"\" // The id of the ics-formatted calendar\n\n// Get ics formatted calendar based on shareable link\nGetWorkforcemanagementCalendarDataIcsRequest.getWorkforcemanagementCalendarDataIcs(calendarId: calendarId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementCalendarDataIcsRequest.getWorkforcemanagementCalendarDataIcs was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementcalendarurlics": { - "operationId": "getworkforcemanagementcalendarurlics", - "functionName": "getWorkforcemanagementCalendarUrlIcs", - "signature": "getWorkforcemanagementCalendarUrlIcs()", - "return": "CalendarUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get existing calendar link for the current user\nGetWorkforcemanagementCalendarUrlIcsRequest.getWorkforcemanagementCalendarUrlIcs() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementCalendarUrlIcsRequest.getWorkforcemanagementCalendarUrlIcs was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementhistoricaldatadeletejob": { - "operationId": "getworkforcemanagementhistoricaldatadeletejob", - "functionName": "getWorkforcemanagementHistoricaldataDeletejob", - "signature": "getWorkforcemanagementHistoricaldataDeletejob()", - "return": "HistoricalImportDeleteJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieves delete job status for historical data imports of the organization\nGetWorkforcemanagementHistoricaldataDeletejobRequest.getWorkforcemanagementHistoricaldataDeletejob() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementHistoricaldataDeletejobRequest.getWorkforcemanagementHistoricaldataDeletejob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementhistoricaldataimportstatus": { - "operationId": "getworkforcemanagementhistoricaldataimportstatus", - "functionName": "getWorkforcemanagementHistoricaldataImportstatus", - "signature": "getWorkforcemanagementHistoricaldataImportstatus()", - "return": "HistoricalImportStatusListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieves status of the historical data imports of the organization\nGetWorkforcemanagementHistoricaldataImportstatusRequest.getWorkforcemanagementHistoricaldataImportstatus() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementHistoricaldataImportstatusRequest.getWorkforcemanagementHistoricaldataImportstatus was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementintegrationshris": { - "operationId": "getworkforcemanagementintegrationshris", - "functionName": "getWorkforcemanagementIntegrationsHris", - "signature": "getWorkforcemanagementIntegrationsHris()", - "return": "WfmIntegrationListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get integrations\nGetWorkforcemanagementIntegrationsHrisRequest.getWorkforcemanagementIntegrationsHris() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementIntegrationsHrisRequest.getWorkforcemanagementIntegrationsHris was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementintegrationshristimeofftypesjob": { - "operationId": "getworkforcemanagementintegrationshristimeofftypesjob", - "functionName": "getWorkforcemanagementIntegrationsHrisTimeofftypesJob", - "signature": "getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "HrisTimeOffTypesJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The ID of the job.\n\n// Query the results of time off types job\nGetWorkforcemanagementIntegrationsHrisTimeofftypesJobRequest.getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementIntegrationsHrisTimeofftypesJobRequest.getWorkforcemanagementIntegrationsHrisTimeofftypesJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunit": { - "operationId": "getworkforcemanagementmanagementunit", - "functionName": "getWorkforcemanagementManagementunit", - "signature": "getWorkforcemanagementManagementunit(managementUnitId, expand)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "ManagementUnit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet expand: [String] = [\"\"] // \n\n// Get management unit\nGetWorkforcemanagementManagementunitRequest.getWorkforcemanagementManagementunit(managementUnitId: managementUnitId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitRequest.getWorkforcemanagementManagementunit was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitactivitycodes": { - "operationId": "getworkforcemanagementmanagementunitactivitycodes", - "functionName": "getWorkforcemanagementManagementunitActivitycodes", - "signature": "getWorkforcemanagementManagementunitActivitycodes(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "ActivityCodeContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\n\n// Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes\nGetWorkforcemanagementManagementunitActivitycodesRequest.getWorkforcemanagementManagementunitActivitycodes(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitActivitycodesRequest.getWorkforcemanagementManagementunitActivitycodes was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitadherence": { - "operationId": "getworkforcemanagementmanagementunitadherence", - "functionName": "getWorkforcemanagementManagementunitAdherence", - "signature": "getWorkforcemanagementManagementunitAdherence(managementUnitId, forceDownloadService)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "UserScheduleAdherenceListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Get a list of user schedule adherence records for the requested management unit\nGetWorkforcemanagementManagementunitAdherenceRequest.getWorkforcemanagementManagementunitAdherence(managementUnitId: managementUnitId, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitAdherenceRequest.getWorkforcemanagementManagementunitAdherence was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitagent": { - "operationId": "getworkforcemanagementmanagementunitagent", - "functionName": "getWorkforcemanagementManagementunitAgent", - "signature": "getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, excludeCapabilities)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "excludeCapabilities", - "type": "Bool", - "required": "false" - } - ], - "return": "WfmAgent", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet agentId: String = \"\" // The agent id\nlet excludeCapabilities: Bool = true // Excludes all capabilities of the agent such as queues, languages, and skills\n\n// Get data for agent in the management unit\nGetWorkforcemanagementManagementunitAgentRequest.getWorkforcemanagementManagementunitAgent(managementUnitId: managementUnitId, agentId: agentId, excludeCapabilities: excludeCapabilities) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitAgentRequest.getWorkforcemanagementManagementunitAgent was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitagentshifttrades": { - "operationId": "getworkforcemanagementmanagementunitagentshifttrades", - "functionName": "getWorkforcemanagementManagementunitAgentShifttrades", - "signature": "getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "agentId", - "type": "String", - "required": "true" - } - ], - "return": "ShiftTradeListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet agentId: String = \"\" // The agent id\n\n// Gets all the shift trades for a given agent\nGetWorkforcemanagementManagementunitAgentShifttradesRequest.getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId: managementUnitId, agentId: agentId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitAgentShifttradesRequest.getWorkforcemanagementManagementunitAgentShifttrades was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitshifttradesmatched": { - "operationId": "getworkforcemanagementmanagementunitshifttradesmatched", - "functionName": "getWorkforcemanagementManagementunitShifttradesMatched", - "signature": "getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "ShiftTradeMatchesSummaryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\n\n// Gets a summary of all shift trades in the matched state\nGetWorkforcemanagementManagementunitShifttradesMatchedRequest.getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitShifttradesMatchedRequest.getWorkforcemanagementManagementunitShifttradesMatched was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitshifttradesusers": { - "operationId": "getworkforcemanagementmanagementunitshifttradesusers", - "functionName": "getWorkforcemanagementManagementunitShifttradesUsers", - "signature": "getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "WfmUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\n\n// Gets list of users available for whom you can send direct shift trade requests\nGetWorkforcemanagementManagementunitShifttradesUsersRequest.getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitShifttradesUsersRequest.getWorkforcemanagementManagementunitShifttradesUsers was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunittimeofflimit": { - "operationId": "getworkforcemanagementmanagementunittimeofflimit", - "functionName": "getWorkforcemanagementManagementunitTimeofflimit", - "signature": "getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffLimitId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffLimit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet timeOffLimitId: String = \"\" // The ID of the time off limit to fetch\n\n// Gets a time off limit object\nGetWorkforcemanagementManagementunitTimeofflimitRequest.getWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitTimeofflimitRequest.getWorkforcemanagementManagementunitTimeofflimit was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunittimeofflimits": { - "operationId": "getworkforcemanagementmanagementunittimeofflimits", - "functionName": "getWorkforcemanagementManagementunitTimeofflimits", - "signature": "getWorkforcemanagementManagementunitTimeofflimits(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffLimitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\n\n// Gets a list of time off limit objects under management unit.\nGetWorkforcemanagementManagementunitTimeofflimitsRequest.getWorkforcemanagementManagementunitTimeofflimits(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitTimeofflimitsRequest.getWorkforcemanagementManagementunitTimeofflimits was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunittimeoffplan": { - "operationId": "getworkforcemanagementmanagementunittimeoffplan", - "functionName": "getWorkforcemanagementManagementunitTimeoffplan", - "signature": "getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffPlanId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet timeOffPlanId: String = \"\" // The ID of the time off plan to fetch\n\n// Gets a time off plan\nGetWorkforcemanagementManagementunitTimeoffplanRequest.getWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitTimeoffplanRequest.getWorkforcemanagementManagementunitTimeoffplan was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunittimeoffplans": { - "operationId": "getworkforcemanagementmanagementunittimeoffplans", - "functionName": "getWorkforcemanagementManagementunitTimeoffplans", - "signature": "getWorkforcemanagementManagementunitTimeoffplans(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffPlanListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\n\n// Gets a list of time off plans\nGetWorkforcemanagementManagementunitTimeoffplansRequest.getWorkforcemanagementManagementunitTimeoffplans(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitTimeoffplansRequest.getWorkforcemanagementManagementunitTimeoffplans was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitusertimeoffrequest": { - "operationId": "getworkforcemanagementmanagementunitusertimeoffrequest", - "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequest", - "signature": "getWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffRequestResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet userId: String = \"\" // The userId to whom the Time Off Request applies.\nlet timeOffRequestId: String = \"\" // Time Off Request Id\n\n// Get a time off request\nGetWorkforcemanagementManagementunitUserTimeoffrequestRequest.getWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUserTimeoffrequestRequest.getWorkforcemanagementManagementunitUserTimeoffrequest was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitusertimeoffrequesttimeofflimits": { - "operationId": "getworkforcemanagementmanagementunitusertimeoffrequesttimeofflimits", - "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits", - "signature": "getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - } - ], - "return": "QueryTimeOffLimitValuesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet userId: String = \"\" // The userId to whom the time off request applies.\nlet timeOffRequestId: String = \"\" // The ID of the time off request, which dates and activityCodeId determine limit values to retrieve\n\n// Retrieves time off limit, allocated and waitlisted values according to specific time off request\nGetWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsRequest.getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsRequest.getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitusertimeoffrequests": { - "operationId": "getworkforcemanagementmanagementunitusertimeoffrequests", - "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequests", - "signature": "getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId, recentlyReviewed)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "recentlyReviewed", - "type": "Bool", - "required": "false" - } - ], - "return": "TimeOffRequestList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet userId: String = \"\" // The userId to whom the Time Off Request applies.\nlet recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days\n\n// Get a list of time off requests for a given user\nGetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId, recentlyReviewed: recentlyReviewed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitusers": { - "operationId": "getworkforcemanagementmanagementunitusers", - "functionName": "getWorkforcemanagementManagementunitUsers", - "signature": "getWorkforcemanagementManagementunitUsers(managementUnitId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - } - ], - "return": "WfmUserEntityListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\n\n// Get users in the management unit\nGetWorkforcemanagementManagementunitUsersRequest.getWorkforcemanagementManagementunitUsers(managementUnitId: managementUnitId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUsersRequest.getWorkforcemanagementManagementunitUsers was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitweekschedule": { - "operationId": "getworkforcemanagementmanagementunitweekschedule", - "functionName": "getWorkforcemanagementManagementunitWeekSchedule", - "signature": "getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, expand, forceDownloadService)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "String", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "WeekScheduleResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekId: String = \"\" // First day of schedule week in yyyy-MM-dd format.\nlet scheduleId: String = \"\" // The ID of the schedule to fetch\nlet expand: GetWorkforcemanagementManagementunitWeekScheduleRequest.Expand_getWorkforcemanagementManagementunitWeekSchedule = GetWorkforcemanagementManagementunitWeekScheduleRequest.Expand_getWorkforcemanagementManagementunitWeekSchedule.enummember // Which fields, if any, to expand\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Deprecated. Use the equivalent business unit resource instead. Get a week schedule\nGetWorkforcemanagementManagementunitWeekScheduleRequest.getWorkforcemanagementManagementunitWeekSchedule(managementUnitId: managementUnitId, weekId: weekId, scheduleId: scheduleId, expand: expand, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWeekScheduleRequest.getWorkforcemanagementManagementunitWeekSchedule was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitweekschedules": { - "operationId": "getworkforcemanagementmanagementunitweekschedules", - "functionName": "getWorkforcemanagementManagementunitWeekSchedules", - "signature": "getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, includeOnlyPublished, earliestWeekDate, latestWeekDate)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "String", - "required": "true" - }, - { - "name": "includeOnlyPublished", - "type": "Bool", - "required": "false" - }, - { - "name": "earliestWeekDate", - "type": "String", - "required": "false" - }, - { - "name": "latestWeekDate", - "type": "String", - "required": "false" - } - ], - "return": "WeekScheduleListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekId: String = \"\" // First day of schedule week in yyyy-MM-dd format.\nlet includeOnlyPublished: Bool = true // Return only published schedules\nlet earliestWeekDate: String = \"\" // The start date of the earliest week to query in yyyy-MM-dd format\nlet latestWeekDate: String = \"\" // The start date of the latest week to query in yyyy-MM-dd format\n\n// Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit\nGetWorkforcemanagementManagementunitWeekSchedulesRequest.getWorkforcemanagementManagementunitWeekSchedules(managementUnitId: managementUnitId, weekId: weekId, includeOnlyPublished: includeOnlyPublished, earliestWeekDate: earliestWeekDate, latestWeekDate: latestWeekDate) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWeekSchedulesRequest.getWorkforcemanagementManagementunitWeekSchedules was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitweekshifttrades": { - "operationId": "getworkforcemanagementmanagementunitweekshifttrades", - "functionName": "getWorkforcemanagementManagementunitWeekShifttrades", - "signature": "getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, evaluateMatches)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "evaluateMatches", - "type": "Bool", - "required": "false" - } - ], - "return": "WeekShiftTradeListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet evaluateMatches: Bool = true // Whether to evaluate the matches for violations\n\n// Gets all the shift trades for a given week\nGetWorkforcemanagementManagementunitWeekShifttradesRequest.getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId: managementUnitId, weekDateId: weekDateId, evaluateMatches: evaluateMatches) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWeekShifttradesRequest.getWorkforcemanagementManagementunitWeekShifttrades was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitworkplan": { - "operationId": "getworkforcemanagementmanagementunitworkplan", - "functionName": "getWorkforcemanagementManagementunitWorkplan", - "signature": "getWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, includeOnly)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanId", - "type": "String", - "required": "true" - }, - { - "name": "includeOnly", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanId: String = \"\" // The ID of the work plan to fetch\nlet includeOnly: [String] = [\"\"] // limit response to the specified fields\n\n// Get a work plan\nGetWorkforcemanagementManagementunitWorkplanRequest.getWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId, includeOnly: includeOnly) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWorkplanRequest.getWorkforcemanagementManagementunitWorkplan was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitworkplanrotation": { - "operationId": "getworkforcemanagementmanagementunitworkplanrotation", - "functionName": "getWorkforcemanagementManagementunitWorkplanrotation", - "signature": "getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanRotationId", - "type": "String", - "required": "true" - } - ], - "return": "WorkPlanRotationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanRotationId: String = \"\" // The ID of the work plan rotation to fetch\n\n// Get a work plan rotation\nGetWorkforcemanagementManagementunitWorkplanrotationRequest.getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWorkplanrotationRequest.getWorkforcemanagementManagementunitWorkplanrotation was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitworkplanrotations": { - "operationId": "getworkforcemanagementmanagementunitworkplanrotations", - "functionName": "getWorkforcemanagementManagementunitWorkplanrotations", - "signature": "getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, expand)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkPlanRotationListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet expand: [String] = [\"\"] // \n\n// Get work plan rotations\nGetWorkforcemanagementManagementunitWorkplanrotationsRequest.getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId: managementUnitId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWorkplanrotationsRequest.getWorkforcemanagementManagementunitWorkplanrotations was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitworkplans": { - "operationId": "getworkforcemanagementmanagementunitworkplans", - "functionName": "getWorkforcemanagementManagementunitWorkplans", - "signature": "getWorkforcemanagementManagementunitWorkplans(managementUnitId, expand)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - } - ], - "return": "WorkPlanListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet expand: [String] = [\"\"] // Include to access additional data on the work plans\n\n// Get work plans\nGetWorkforcemanagementManagementunitWorkplansRequest.getWorkforcemanagementManagementunitWorkplans(managementUnitId: managementUnitId, expand: expand) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitWorkplansRequest.getWorkforcemanagementManagementunitWorkplans was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunits": { - "operationId": "getworkforcemanagementmanagementunits", - "functionName": "getWorkforcemanagementManagementunits", - "signature": "getWorkforcemanagementManagementunits(pageSize, pageNumber, expand, feature, divisionId)", - "parameters": [ - { - "name": "pageSize", - "type": "Int", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Int", - "required": "false" - }, - { - "name": "expand", - "type": "String", - "required": "false" - }, - { - "name": "feature", - "type": "String", - "required": "false" - }, - { - "name": "divisionId", - "type": "String", - "required": "false" - } - ], - "return": "ManagementUnitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet pageSize: Int = 0 // Deprecated, paging is not supported\nlet pageNumber: Int = 0 // Deprecated, paging is not supported\nlet expand: GetWorkforcemanagementManagementunitsRequest.Expand_getWorkforcemanagementManagementunits = GetWorkforcemanagementManagementunitsRequest.Expand_getWorkforcemanagementManagementunits.enummember // Deprecated, expand settings on the single MU route\nlet feature: GetWorkforcemanagementManagementunitsRequest.Feature_getWorkforcemanagementManagementunits = GetWorkforcemanagementManagementunitsRequest.Feature_getWorkforcemanagementManagementunits.enummember // If specified, the list of management units for which the user is authorized to use the requested feature will be returned\nlet divisionId: String = \"\" // If specified, the list of management units belonging to the specified division will be returned\n\n// Get management units\nGetWorkforcemanagementManagementunitsRequest.getWorkforcemanagementManagementunits(pageSize: pageSize, pageNumber: pageNumber, expand: expand, feature: feature, divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitsRequest.getWorkforcemanagementManagementunits was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementmanagementunitsdivisionviews": { - "operationId": "getworkforcemanagementmanagementunitsdivisionviews", - "functionName": "getWorkforcemanagementManagementunitsDivisionviews", - "signature": "getWorkforcemanagementManagementunitsDivisionviews(divisionId)", - "parameters": [ - { - "name": "divisionId", - "type": "[String]", - "required": "false" - } - ], - "return": "ManagementUnitListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet divisionId: [String] = [\"\"] // The divisionIds to filter by. If omitted, will return all divisions\n\n// Get management units across divisions\nGetWorkforcemanagementManagementunitsDivisionviewsRequest.getWorkforcemanagementManagementunitsDivisionviews(divisionId: divisionId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitsDivisionviewsRequest.getWorkforcemanagementManagementunitsDivisionviews was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementnotifications": { - "operationId": "getworkforcemanagementnotifications", - "functionName": "getWorkforcemanagementNotifications", - "signature": "getWorkforcemanagementNotifications()", - "return": "NotificationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of notifications for the current user\nGetWorkforcemanagementNotificationsRequest.getWorkforcemanagementNotifications() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementNotificationsRequest.getWorkforcemanagementNotifications was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementschedulingjob": { - "operationId": "getworkforcemanagementschedulingjob", - "functionName": "getWorkforcemanagementSchedulingjob", - "signature": "getWorkforcemanagementSchedulingjob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "SchedulingStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The id of the scheduling job\n\n// Get status of the scheduling job\nGetWorkforcemanagementSchedulingjobRequest.getWorkforcemanagementSchedulingjob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementSchedulingjobRequest.getWorkforcemanagementSchedulingjob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementshifttrades": { - "operationId": "getworkforcemanagementshifttrades", - "functionName": "getWorkforcemanagementShifttrades", - "signature": "getWorkforcemanagementShifttrades()", - "return": "ShiftTradeListResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Gets all of my shift trades\nGetWorkforcemanagementShifttradesRequest.getWorkforcemanagementShifttrades() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementShifttradesRequest.getWorkforcemanagementShifttrades was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementshrinkagejob": { - "operationId": "getworkforcemanagementshrinkagejob", - "functionName": "getWorkforcemanagementShrinkageJob", - "signature": "getWorkforcemanagementShrinkageJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "WfmHistoricalShrinkageResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // jobId\n\n// Request to fetch the status of the historical shrinkage query\nGetWorkforcemanagementShrinkageJobRequest.getWorkforcemanagementShrinkageJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementShrinkageJobRequest.getWorkforcemanagementShrinkageJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementtimeoffbalancejob": { - "operationId": "getworkforcemanagementtimeoffbalancejob", - "functionName": "getWorkforcemanagementTimeoffbalanceJob", - "signature": "getWorkforcemanagementTimeoffbalanceJob(jobId)", - "parameters": [ - { - "name": "jobId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffBalanceJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // The ID of the job.\n\n// Query the results of time off types job\nGetWorkforcemanagementTimeoffbalanceJobRequest.getWorkforcemanagementTimeoffbalanceJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffbalanceJobRequest.getWorkforcemanagementTimeoffbalanceJob was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementtimeoffrequest": { - "operationId": "getworkforcemanagementtimeoffrequest", - "functionName": "getWorkforcemanagementTimeoffrequest", - "signature": "getWorkforcemanagementTimeoffrequest(timeOffRequestId)", - "parameters": [ - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffRequestResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet timeOffRequestId: String = \"\" // The ID of the time off request\n\n// Get a time off request for the current user\nGetWorkforcemanagementTimeoffrequestRequest.getWorkforcemanagementTimeoffrequest(timeOffRequestId: timeOffRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffrequestRequest.getWorkforcemanagementTimeoffrequest was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementtimeoffrequestwaitlistpositions": { - "operationId": "getworkforcemanagementtimeoffrequestwaitlistpositions", - "functionName": "getWorkforcemanagementTimeoffrequestWaitlistpositions", - "signature": "getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId)", - "parameters": [ - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - } - ], - "return": "WaitlistPositionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet timeOffRequestId: String = \"\" // The ID of the time off request\n\n// Get the daily waitlist positions of a time off request for the current user\nGetWorkforcemanagementTimeoffrequestWaitlistpositionsRequest.getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId: timeOffRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffrequestWaitlistpositionsRequest.getWorkforcemanagementTimeoffrequestWaitlistpositions was successful\")\n dump(response)\n }\n}" - }, - "getworkforcemanagementtimeoffrequests": { - "operationId": "getworkforcemanagementtimeoffrequests", - "functionName": "getWorkforcemanagementTimeoffrequests", - "signature": "getWorkforcemanagementTimeoffrequests(recentlyReviewed)", - "parameters": [ - { - "name": "recentlyReviewed", - "type": "Bool", - "required": "false" - } - ], - "return": "TimeOffRequestList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days\n\n// Get a list of time off requests for the current user\nGetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests(recentlyReviewed: recentlyReviewed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementagentadherenceexplanation": { - "operationId": "patchworkforcemanagementagentadherenceexplanation", - "functionName": "patchWorkforcemanagementAgentAdherenceExplanation", - "signature": "patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "explanationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateAdherenceExplanationStatusRequest", - "required": "true" - } - ], - "return": "AdherenceExplanationAsyncResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent to query\nlet explanationId: String = \"\" // The ID of the explanation to update\nlet body: UpdateAdherenceExplanationStatusRequest = new UpdateAdherenceExplanationStatusRequest(...) // The request body\n\n// Update an adherence explanation\nPatchWorkforcemanagementAgentAdherenceExplanationRequest.patchWorkforcemanagementAgentAdherenceExplanation(agentId: agentId, explanationId: explanationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementAgentAdherenceExplanationRequest.patchWorkforcemanagementAgentAdherenceExplanation was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementbusinessunit": { - "operationId": "patchworkforcemanagementbusinessunit", - "functionName": "patchWorkforcemanagementBusinessunit", - "signature": "patchWorkforcemanagementBusinessunit(businessUnitId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateBusinessUnitRequest", - "required": "false" - } - ], - "return": "BusinessUnitResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet body: UpdateBusinessUnitRequest = new UpdateBusinessUnitRequest(...) // body\n\n// Update business unit\nPatchWorkforcemanagementBusinessunitRequest.patchWorkforcemanagementBusinessunit(businessUnitId: businessUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementBusinessunitRequest.patchWorkforcemanagementBusinessunit was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementbusinessunitactivitycode": { - "operationId": "patchworkforcemanagementbusinessunitactivitycode", - "functionName": "patchWorkforcemanagementBusinessunitActivitycode", - "signature": "patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "activityCodeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateActivityCodeRequest", - "required": "false" - } - ], - "return": "BusinessUnitActivityCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet activityCodeId: String = \"\" // The ID of the activity code to update\nlet body: UpdateActivityCodeRequest = new UpdateActivityCodeRequest(...) // body\n\n// Update an activity code\nPatchWorkforcemanagementBusinessunitActivitycodeRequest.patchWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementBusinessunitActivitycodeRequest.patchWorkforcemanagementBusinessunitActivitycode was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementbusinessunitplanninggroup": { - "operationId": "patchworkforcemanagementbusinessunitplanninggroup", - "functionName": "patchWorkforcemanagementBusinessunitPlanninggroup", - "signature": "patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "planningGroupId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdatePlanningGroupRequest", - "required": "false" - } - ], - "return": "PlanningGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet planningGroupId: String = \"\" // The ID of a planning group to update\nlet body: UpdatePlanningGroupRequest = new UpdatePlanningGroupRequest(...) // body\n\n// Updates the planning group\nPatchWorkforcemanagementBusinessunitPlanninggroupRequest.patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementBusinessunitPlanninggroupRequest.patchWorkforcemanagementBusinessunitPlanninggroup was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementbusinessunitschedulingrun": { - "operationId": "patchworkforcemanagementbusinessunitschedulingrun", - "functionName": "patchWorkforcemanagementBusinessunitSchedulingRun", - "signature": "patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "runId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchBuScheduleRunRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet runId: String = \"\" // The ID of the schedule run\nlet body: PatchBuScheduleRunRequest = new PatchBuScheduleRunRequest(...) // body\n\n// Mark a schedule run as applied\nPatchWorkforcemanagementBusinessunitSchedulingRunRequest.patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId, body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PatchWorkforcemanagementBusinessunitSchedulingRunRequest.patchWorkforcemanagementBusinessunitSchedulingRun was successful\")\n }\n}" - }, - "patchworkforcemanagementbusinessunitservicegoaltemplate": { - "operationId": "patchworkforcemanagementbusinessunitservicegoaltemplate", - "functionName": "patchWorkforcemanagementBusinessunitServicegoaltemplate", - "signature": "patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "serviceGoalTemplateId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateServiceGoalTemplate", - "required": "false" - } - ], - "return": "ServiceGoalTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet serviceGoalTemplateId: String = \"\" // The ID of a service goal template to update\nlet body: UpdateServiceGoalTemplate = new UpdateServiceGoalTemplate(...) // body\n\n// Updates a service goal template\nPatchWorkforcemanagementBusinessunitServicegoaltemplateRequest.patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementBusinessunitServicegoaltemplateRequest.patchWorkforcemanagementBusinessunitServicegoaltemplate was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunit": { - "operationId": "patchworkforcemanagementmanagementunit", - "functionName": "patchWorkforcemanagementManagementunit", - "signature": "patchWorkforcemanagementManagementunit(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateManagementUnitRequest", - "required": "false" - } - ], - "return": "ManagementUnit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: UpdateManagementUnitRequest = new UpdateManagementUnitRequest(...) // body\n\n// Update the requested management unit\nPatchWorkforcemanagementManagementunitRequest.patchWorkforcemanagementManagementunit(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitRequest.patchWorkforcemanagementManagementunit was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunittimeofflimit": { - "operationId": "patchworkforcemanagementmanagementunittimeofflimit", - "functionName": "patchWorkforcemanagementManagementunitTimeofflimit", - "signature": "patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffLimitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateTimeOffLimitRequest", - "required": "false" - } - ], - "return": "TimeOffLimit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet timeOffLimitId: String = \"\" // The id of time off limit object to update\nlet body: UpdateTimeOffLimitRequest = new UpdateTimeOffLimitRequest(...) // body\n\n// Updates a time off limit object.\nPatchWorkforcemanagementManagementunitTimeofflimitRequest.patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitTimeofflimitRequest.patchWorkforcemanagementManagementunitTimeofflimit was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunittimeoffplan": { - "operationId": "patchworkforcemanagementmanagementunittimeoffplan", - "functionName": "patchWorkforcemanagementManagementunitTimeoffplan", - "signature": "patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffPlanId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateTimeOffPlanRequest", - "required": "false" - } - ], - "return": "TimeOffPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet timeOffPlanId: String = \"\" // The ID of the time off plan to update\nlet body: UpdateTimeOffPlanRequest = new UpdateTimeOffPlanRequest(...) // body\n\n// Updates a time off plan\nPatchWorkforcemanagementManagementunitTimeoffplanRequest.patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitTimeoffplanRequest.patchWorkforcemanagementManagementunitTimeoffplan was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunittimeoffrequestuserintegrationstatus": { - "operationId": "patchworkforcemanagementmanagementunittimeoffrequestuserintegrationstatus", - "functionName": "patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus", - "signature": "patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetTimeOffIntegrationStatusRequest", - "required": "false" - } - ], - "return": "UserTimeOffIntegrationStatusResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet timeOffRequestId: String = \"\" // The ID of the time off request.\nlet userId: String = \"\" // The ID of user to whom the time off request belongs.\nlet body: SetTimeOffIntegrationStatusRequest = new SetTimeOffIntegrationStatusRequest(...) // body\n\n// Set integration status for a time off request.\nPatchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusRequest.patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId: managementUnitId, timeOffRequestId: timeOffRequestId, userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusRequest.patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunitusertimeoffrequest": { - "operationId": "patchworkforcemanagementmanagementunitusertimeoffrequest", - "functionName": "patchWorkforcemanagementManagementunitUserTimeoffrequest", - "signature": "patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AdminTimeOffRequestPatch", - "required": "false" - } - ], - "return": "TimeOffRequestResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet userId: String = \"\" // The id of the user the requested time off request belongs to\nlet timeOffRequestId: String = \"\" // The id of the time off request to update\nlet body: AdminTimeOffRequestPatch = new AdminTimeOffRequestPatch(...) // body\n\n// Update a time off request\nPatchWorkforcemanagementManagementunitUserTimeoffrequestRequest.patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitUserTimeoffrequestRequest.patchWorkforcemanagementManagementunitUserTimeoffrequest was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunitweekshifttrade": { - "operationId": "patchworkforcemanagementmanagementunitweekshifttrade", - "functionName": "patchWorkforcemanagementManagementunitWeekShifttrade", - "signature": "patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "tradeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "PatchShiftTradeRequest", - "required": "true" - } - ], - "return": "ShiftTradeResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet tradeId: String = \"\" // The ID of the shift trade to update\nlet body: PatchShiftTradeRequest = new PatchShiftTradeRequest(...) // body\n\n// Updates a shift trade. This route can only be called by the initiating agent\nPatchWorkforcemanagementManagementunitWeekShifttradeRequest.patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId: managementUnitId, weekDateId: weekDateId, tradeId: tradeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitWeekShifttradeRequest.patchWorkforcemanagementManagementunitWeekShifttrade was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunitworkplan": { - "operationId": "patchworkforcemanagementmanagementunitworkplan", - "functionName": "patchWorkforcemanagementManagementunitWorkplan", - "signature": "patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, validationMode, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanId", - "type": "String", - "required": "true" - }, - { - "name": "validationMode", - "type": "String", - "required": "false" - }, - { - "name": "body", - "type": "WorkPlan", - "required": "false" - } - ], - "return": "WorkPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanId: String = \"\" // The ID of the work plan to update\nlet validationMode: PatchWorkforcemanagementManagementunitWorkplanRequest.ValidationMode_patchWorkforcemanagementManagementunitWorkplan = PatchWorkforcemanagementManagementunitWorkplanRequest.ValidationMode_patchWorkforcemanagementManagementunitWorkplan.enummember // Allows to update work plan even if validation result is invalid\nlet body: WorkPlan = new WorkPlan(...) // body\n\n// Update a work plan\nPatchWorkforcemanagementManagementunitWorkplanRequest.patchWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId, validationMode: validationMode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitWorkplanRequest.patchWorkforcemanagementManagementunitWorkplan was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementmanagementunitworkplanrotation": { - "operationId": "patchworkforcemanagementmanagementunitworkplanrotation", - "functionName": "patchWorkforcemanagementManagementunitWorkplanrotation", - "signature": "patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanRotationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UpdateWorkPlanRotationRequest", - "required": "false" - } - ], - "return": "WorkPlanRotationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanRotationId: String = \"\" // The ID of the work plan rotation to update\nlet body: UpdateWorkPlanRotationRequest = new UpdateWorkPlanRotationRequest(...) // body\n\n// Update a work plan rotation\nPatchWorkforcemanagementManagementunitWorkplanrotationRequest.patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementManagementunitWorkplanrotationRequest.patchWorkforcemanagementManagementunitWorkplanrotation was successful\")\n dump(response)\n }\n}" - }, - "patchworkforcemanagementtimeoffrequest": { - "operationId": "patchworkforcemanagementtimeoffrequest", - "functionName": "patchWorkforcemanagementTimeoffrequest", - "signature": "patchWorkforcemanagementTimeoffrequest(timeOffRequestId, body)", - "parameters": [ - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AgentTimeOffRequestPatch", - "required": "false" - } - ], - "return": "TimeOffRequestResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet timeOffRequestId: String = \"\" // The ID of the time off request\nlet body: AgentTimeOffRequestPatch = new AgentTimeOffRequestPatch(...) // body\n\n// Update a time off request for the current user\nPatchWorkforcemanagementTimeoffrequestRequest.patchWorkforcemanagementTimeoffrequest(timeOffRequestId: timeOffRequestId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchWorkforcemanagementTimeoffrequestRequest.patchWorkforcemanagementTimeoffrequest was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementadherenceexplanations": { - "operationId": "postworkforcemanagementadherenceexplanations", - "functionName": "postWorkforcemanagementAdherenceExplanations", - "signature": "postWorkforcemanagementAdherenceExplanations(body)", - "parameters": [ - { - "name": "body", - "type": "AddAdherenceExplanationAgentRequest", - "required": "true" - } - ], - "return": "AdherenceExplanationAsyncResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AddAdherenceExplanationAgentRequest = new AddAdherenceExplanationAgentRequest(...) // The request body\n\n// Submit an adherence explanation for the current user\nPostWorkforcemanagementAdherenceExplanationsRequest.postWorkforcemanagementAdherenceExplanations(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAdherenceExplanationsRequest.postWorkforcemanagementAdherenceExplanations was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementadherenceexplanationsquery": { - "operationId": "postworkforcemanagementadherenceexplanationsquery", - "functionName": "postWorkforcemanagementAdherenceExplanationsQuery", - "signature": "postWorkforcemanagementAdherenceExplanationsQuery(body, forceAsync, forceDownloadService)", - "parameters": [ - { - "name": "body", - "type": "AgentQueryAdherenceExplanationsRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "QueryAdherenceExplanationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AgentQueryAdherenceExplanationsRequest = new AgentQueryAdherenceExplanationsRequest(...) // The request body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Query adherence explanations for the current user\nPostWorkforcemanagementAdherenceExplanationsQueryRequest.postWorkforcemanagementAdherenceExplanationsQuery(body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAdherenceExplanationsQueryRequest.postWorkforcemanagementAdherenceExplanationsQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementadherencehistorical": { - "operationId": "postworkforcemanagementadherencehistorical", - "functionName": "postWorkforcemanagementAdherenceHistorical", - "signature": "postWorkforcemanagementAdherenceHistorical(body)", - "parameters": [ - { - "name": "body", - "type": "WfmHistoricalAdherenceQueryForUsers", - "required": "false" - } - ], - "return": "WfmHistoricalAdherenceResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WfmHistoricalAdherenceQueryForUsers = new WfmHistoricalAdherenceQueryForUsers(...) // body\n\n// Deprecated. Use bulk routes instead (/adherence/historical/bulk)\nPostWorkforcemanagementAdherenceHistoricalRequest.postWorkforcemanagementAdherenceHistorical(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAdherenceHistoricalRequest.postWorkforcemanagementAdherenceHistorical was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementadherencehistoricalbulk": { - "operationId": "postworkforcemanagementadherencehistoricalbulk", - "functionName": "postWorkforcemanagementAdherenceHistoricalBulk", - "signature": "postWorkforcemanagementAdherenceHistoricalBulk(body)", - "parameters": [ - { - "name": "body", - "type": "WfmHistoricalAdherenceBulkQuery", - "required": "false" - } - ], - "return": "WfmHistoricalAdherenceBulkResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: WfmHistoricalAdherenceBulkQuery = new WfmHistoricalAdherenceBulkQuery(...) // body\n\n// Request a historical adherence report in bulk\nPostWorkforcemanagementAdherenceHistoricalBulkRequest.postWorkforcemanagementAdherenceHistoricalBulk(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAdherenceHistoricalBulkRequest.postWorkforcemanagementAdherenceHistoricalBulk was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagentadherenceexplanations": { - "operationId": "postworkforcemanagementagentadherenceexplanations", - "functionName": "postWorkforcemanagementAgentAdherenceExplanations", - "signature": "postWorkforcemanagementAgentAdherenceExplanations(agentId, body)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AddAdherenceExplanationAdminRequest", - "required": "true" - } - ], - "return": "AdherenceExplanationAsyncResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent to query\nlet body: AddAdherenceExplanationAdminRequest = new AddAdherenceExplanationAdminRequest(...) // The request body\n\n// Add an adherence explanation for the requested user\nPostWorkforcemanagementAgentAdherenceExplanationsRequest.postWorkforcemanagementAgentAdherenceExplanations(agentId: agentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentAdherenceExplanationsRequest.postWorkforcemanagementAgentAdherenceExplanations was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagentadherenceexplanationsquery": { - "operationId": "postworkforcemanagementagentadherenceexplanationsquery", - "functionName": "postWorkforcemanagementAgentAdherenceExplanationsQuery", - "signature": "postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, forceAsync, forceDownloadService)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AgentQueryAdherenceExplanationsRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "AgentQueryAdherenceExplanationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent to query\nlet body: AgentQueryAdherenceExplanationsRequest = new AgentQueryAdherenceExplanationsRequest(...) // The request body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Query adherence explanations for the given agent across a specified range\nPostWorkforcemanagementAgentAdherenceExplanationsQueryRequest.postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId: agentId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentAdherenceExplanationsQueryRequest.postWorkforcemanagementAgentAdherenceExplanationsQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagents": { - "operationId": "postworkforcemanagementagents", - "functionName": "postWorkforcemanagementAgents", - "signature": "postWorkforcemanagementAgents(body)", - "parameters": [ - { - "name": "body", - "type": "MoveAgentsRequest", - "required": "false" - } - ], - "return": "MoveAgentsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MoveAgentsRequest = new MoveAgentsRequest(...) // body\n\n// Move agents in and out of management unit\nPostWorkforcemanagementAgentsRequest.postWorkforcemanagementAgents(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentsRequest.postWorkforcemanagementAgents was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagentsintegrationshrisquery": { - "operationId": "postworkforcemanagementagentsintegrationshrisquery", - "functionName": "postWorkforcemanagementAgentsIntegrationsHrisQuery", - "signature": "postWorkforcemanagementAgentsIntegrationsHrisQuery(body)", - "parameters": [ - { - "name": "body", - "type": "QueryAgentsIntegrationsRequest", - "required": "false" - } - ], - "return": "AgentsIntegrationsListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: QueryAgentsIntegrationsRequest = new QueryAgentsIntegrationsRequest(...) // body\n\n// Query integrations for agents\nPostWorkforcemanagementAgentsIntegrationsHrisQueryRequest.postWorkforcemanagementAgentsIntegrationsHrisQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentsIntegrationsHrisQueryRequest.postWorkforcemanagementAgentsIntegrationsHrisQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagentsmepossibleworkshifts": { - "operationId": "postworkforcemanagementagentsmepossibleworkshifts", - "functionName": "postWorkforcemanagementAgentsMePossibleworkshifts", - "signature": "postWorkforcemanagementAgentsMePossibleworkshifts(body)", - "parameters": [ - { - "name": "body", - "type": "AgentPossibleWorkShiftsRequest", - "required": "true" - } - ], - "return": "AgentPossibleWorkShiftsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AgentPossibleWorkShiftsRequest = new AgentPossibleWorkShiftsRequest(...) // body\n\n// Get agent possible work shifts for requested time frame\nPostWorkforcemanagementAgentsMePossibleworkshiftsRequest.postWorkforcemanagementAgentsMePossibleworkshifts(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentsMePossibleworkshiftsRequest.postWorkforcemanagementAgentsMePossibleworkshifts was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementagentschedulesmine": { - "operationId": "postworkforcemanagementagentschedulesmine", - "functionName": "postWorkforcemanagementAgentschedulesMine", - "signature": "postWorkforcemanagementAgentschedulesMine(body)", - "parameters": [ - { - "name": "body", - "type": "BuGetCurrentAgentScheduleRequest", - "required": "false" - } - ], - "return": "BuCurrentAgentScheduleSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: BuGetCurrentAgentScheduleRequest = new BuGetCurrentAgentScheduleRequest(...) // body\n\n// Get published schedule for the current user\nPostWorkforcemanagementAgentschedulesMineRequest.postWorkforcemanagementAgentschedulesMine(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementAgentschedulesMineRequest.postWorkforcemanagementAgentschedulesMine was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitactivitycodes": { - "operationId": "postworkforcemanagementbusinessunitactivitycodes", - "functionName": "postWorkforcemanagementBusinessunitActivitycodes", - "signature": "postWorkforcemanagementBusinessunitActivitycodes(businessUnitId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateActivityCodeRequest", - "required": "false" - } - ], - "return": "BusinessUnitActivityCode", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit, or 'mine' for the business unit of the logged-in user.\nlet body: CreateActivityCodeRequest = new CreateActivityCodeRequest(...) // body\n\n// Create a new activity code\nPostWorkforcemanagementBusinessunitActivitycodesRequest.postWorkforcemanagementBusinessunitActivitycodes(businessUnitId: businessUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitActivitycodesRequest.postWorkforcemanagementBusinessunitActivitycodes was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitadherenceexplanationsquery": { - "operationId": "postworkforcemanagementbusinessunitadherenceexplanationsquery", - "functionName": "postWorkforcemanagementBusinessunitAdherenceExplanationsQuery", - "signature": "postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, forceAsync, forceDownloadService)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "BuQueryAdherenceExplanationsRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "BuQueryAdherenceExplanationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet body: BuQueryAdherenceExplanationsRequest = new BuQueryAdherenceExplanationsRequest(...) // The request body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Query adherence explanations across an entire business unit for the requested period\nPostWorkforcemanagementBusinessunitAdherenceExplanationsQueryRequest.postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId: businessUnitId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitAdherenceExplanationsQueryRequest.postWorkforcemanagementBusinessunitAdherenceExplanationsQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitagentschedulessearch": { - "operationId": "postworkforcemanagementbusinessunitagentschedulessearch", - "functionName": "postWorkforcemanagementBusinessunitAgentschedulesSearch", - "signature": "postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, forceAsync, forceDownloadService, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "BuSearchAgentSchedulesRequest", - "required": "false" - } - ], - "return": "BuAsyncAgentSchedulesSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\nlet body: BuSearchAgentSchedulesRequest = new BuSearchAgentSchedulesRequest(...) // body\n\n// Search published schedules\nPostWorkforcemanagementBusinessunitAgentschedulesSearchRequest.postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId: businessUnitId, forceAsync: forceAsync, forceDownloadService: forceDownloadService, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitAgentschedulesSearchRequest.postWorkforcemanagementBusinessunitAgentschedulesSearch was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitintraday": { - "operationId": "postworkforcemanagementbusinessunitintraday", - "functionName": "postWorkforcemanagementBusinessunitIntraday", - "signature": "postWorkforcemanagementBusinessunitIntraday(businessUnitId, forceAsync, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "IntradayPlanningGroupRequest", - "required": "false" - } - ], - "return": "AsyncIntradayResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet body: IntradayPlanningGroupRequest = new IntradayPlanningGroupRequest(...) // body\n\n// Get intraday data for the given date for the requested planningGroupIds\nPostWorkforcemanagementBusinessunitIntradayRequest.postWorkforcemanagementBusinessunitIntraday(businessUnitId: businessUnitId, forceAsync: forceAsync, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitIntradayRequest.postWorkforcemanagementBusinessunitIntraday was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitplanninggroups": { - "operationId": "postworkforcemanagementbusinessunitplanninggroups", - "functionName": "postWorkforcemanagementBusinessunitPlanninggroups", - "signature": "postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreatePlanningGroupRequest", - "required": "false" - } - ], - "return": "PlanningGroup", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet body: CreatePlanningGroupRequest = new CreatePlanningGroupRequest(...) // body\n\n// Adds a new planning group\nPostWorkforcemanagementBusinessunitPlanninggroupsRequest.postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId: businessUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitPlanninggroupsRequest.postWorkforcemanagementBusinessunitPlanninggroups was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitservicegoaltemplates": { - "operationId": "postworkforcemanagementbusinessunitservicegoaltemplates", - "functionName": "postWorkforcemanagementBusinessunitServicegoaltemplates", - "signature": "postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateServiceGoalTemplate", - "required": "false" - } - ], - "return": "ServiceGoalTemplate", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit.\nlet body: CreateServiceGoalTemplate = new CreateServiceGoalTemplate(...) // body\n\n// Adds a new service goal template\nPostWorkforcemanagementBusinessunitServicegoaltemplatesRequest.postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId: businessUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitServicegoaltemplatesRequest.postWorkforcemanagementBusinessunitServicegoaltemplates was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekscheduleagentschedulesquery": { - "operationId": "postworkforcemanagementbusinessunitweekscheduleagentschedulesquery", - "functionName": "postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery", - "signature": "postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId, weekId, scheduleId, body, forceAsync, forceDownloadService)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "BuQueryAgentSchedulesRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - } - ], - "return": "BuAsyncAgentSchedulesQueryResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet body: BuQueryAgentSchedulesRequest = new BuQueryAgentSchedulesRequest(...) // body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\n\n// Loads agent schedule data from the schedule. Used in combination with the metadata route\nPostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryRequest.postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryRequest.postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedulecopy": { - "operationId": "postworkforcemanagementbusinessunitweekschedulecopy", - "functionName": "postWorkforcemanagementBusinessunitWeekScheduleCopy", - "signature": "postWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId, weekId, scheduleId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "BuCopyScheduleRequest", - "required": "true" - } - ], - "return": "BuAsyncScheduleResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule to copy\nlet body: BuCopyScheduleRequest = new BuCopyScheduleRequest(...) // body\n\n// Copy a schedule\nPostWorkforcemanagementBusinessunitWeekScheduleCopyRequest.postWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekScheduleCopyRequest.postWorkforcemanagementBusinessunitWeekScheduleCopy was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedulereschedule": { - "operationId": "postworkforcemanagementbusinessunitweekschedulereschedule", - "functionName": "postWorkforcemanagementBusinessunitWeekScheduleReschedule", - "signature": "postWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId, weekId, scheduleId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "BuRescheduleRequest", - "required": "true" - } - ], - "return": "BuAsyncScheduleRunResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet body: BuRescheduleRequest = new BuRescheduleRequest(...) // body\n\n// Start a rescheduling run\nPostWorkforcemanagementBusinessunitWeekScheduleRescheduleRequest.postWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekScheduleRescheduleRequest.postWorkforcemanagementBusinessunitWeekScheduleReschedule was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekscheduleupdate": { - "operationId": "postworkforcemanagementbusinessunitweekscheduleupdate", - "functionName": "postWorkforcemanagementBusinessunitWeekScheduleUpdate", - "signature": "postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId, weekId, scheduleId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "ProcessScheduleUpdateUploadRequest", - "required": "true" - } - ], - "return": "BuAsyncScheduleResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet body: ProcessScheduleUpdateUploadRequest = new ProcessScheduleUpdateUploadRequest(...) // body\n\n// Starts processing a schedule update\nPostWorkforcemanagementBusinessunitWeekScheduleUpdateRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekScheduleUpdateRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekscheduleupdateuploadurl": { - "operationId": "postworkforcemanagementbusinessunitweekscheduleupdateuploadurl", - "functionName": "postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl", - "signature": "postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId, weekId, scheduleId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "scheduleId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UploadUrlRequestBody", - "required": "true" - } - ], - "return": "UpdateScheduleUploadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet scheduleId: String = \"\" // The ID of the schedule\nlet body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body\n\n// Creates a signed upload URL for updating a schedule\nPostWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedules": { - "operationId": "postworkforcemanagementbusinessunitweekschedules", - "functionName": "postWorkforcemanagementBusinessunitWeekSchedules", - "signature": "postWorkforcemanagementBusinessunitWeekSchedules(businessUnitId, weekId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "BuCreateBlankScheduleRequest", - "required": "true" - } - ], - "return": "BuScheduleMetadata", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: BuCreateBlankScheduleRequest = new BuCreateBlankScheduleRequest(...) // body\n\n// Create a blank schedule\nPostWorkforcemanagementBusinessunitWeekSchedulesRequest.postWorkforcemanagementBusinessunitWeekSchedules(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekSchedulesRequest.postWorkforcemanagementBusinessunitWeekSchedules was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedulesgenerate": { - "operationId": "postworkforcemanagementbusinessunitweekschedulesgenerate", - "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesGenerate", - "signature": "postWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId, weekId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "BuGenerateScheduleRequest", - "required": "true" - } - ], - "return": "BuAsyncScheduleRunResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: BuGenerateScheduleRequest = new BuGenerateScheduleRequest(...) // body\n\n// Generate a schedule\nPostWorkforcemanagementBusinessunitWeekSchedulesGenerateRequest.postWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekSchedulesGenerateRequest.postWorkforcemanagementBusinessunitWeekSchedulesGenerate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedulesimport": { - "operationId": "postworkforcemanagementbusinessunitweekschedulesimport", - "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesImport", - "signature": "postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId, weekId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "WfmProcessUploadRequest", - "required": "true" - } - ], - "return": "ScheduleUploadProcessingResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: WfmProcessUploadRequest = new WfmProcessUploadRequest(...) // \n\n// Starts processing a schedule import\nPostWorkforcemanagementBusinessunitWeekSchedulesImportRequest.postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekSchedulesImportRequest.postWorkforcemanagementBusinessunitWeekSchedulesImport was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekschedulesimportuploadurl": { - "operationId": "postworkforcemanagementbusinessunitweekschedulesimportuploadurl", - "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl", - "signature": "postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId, weekId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "UploadUrlRequestBody", - "required": "true" - } - ], - "return": "ImportScheduleUploadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit\nlet weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body\n\n// Creates a signed upload URL for importing a schedule\nPostWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekshorttermforecastcopy": { - "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastcopy", - "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastCopy", - "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId, weekDateId, forecastId, body, forceAsync)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "forecastId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CopyBuForecastRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - } - ], - "return": "AsyncForecastOperationResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet forecastId: String = \"\" // The ID of the forecast to copy\nlet body: CopyBuForecastRequest = new CopyBuForecastRequest(...) // body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\n\n// Copy a short term forecast\nPostWorkforcemanagementBusinessunitWeekShorttermforecastCopyRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, body: body, forceAsync: forceAsync) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekShorttermforecastCopyRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastCopy was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekshorttermforecastsgenerate": { - "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsgenerate", - "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate", - "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId, weekDateId, body, forceAsync)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "GenerateBuForecastRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - } - ], - "return": "AsyncForecastOperationResult", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // 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\nlet body: GenerateBuForecastRequest = new GenerateBuForecastRequest(...) // body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\n\n// Generate a short term forecast\nPostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body, forceAsync: forceAsync) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekshorttermforecastsimport": { - "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsimport", - "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImport", - "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "WfmProcessUploadRequest", - "required": "true" - } - ], - "return": "ImportForecastResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: WfmProcessUploadRequest = new WfmProcessUploadRequest(...) // body\n\n// Starts importing the uploaded short term forecast\nPostWorkforcemanagementBusinessunitWeekShorttermforecastsImportRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImport was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunitweekshorttermforecastsimportuploadurl": { - "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsimportuploadurl", - "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl", - "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId, weekDateId, body)", - "parameters": [ - { - "name": "businessUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "UploadUrlRequestBody", - "required": "true" - } - ], - "return": "ImportForecastUploadResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet businessUnitId: String = \"\" // The ID of the business unit to which the forecast belongs\nlet weekDateId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd\nlet body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body\n\n// Creates a signed upload URL for importing a short term forecast\nPostWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementbusinessunits": { - "operationId": "postworkforcemanagementbusinessunits", - "functionName": "postWorkforcemanagementBusinessunits", - "signature": "postWorkforcemanagementBusinessunits(body)", - "parameters": [ - { - "name": "body", - "type": "CreateBusinessUnitRequest", - "required": "false" - } - ], - "return": "BusinessUnitResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateBusinessUnitRequest = new CreateBusinessUnitRequest(...) // body\n\n// Add a new business unit\nPostWorkforcemanagementBusinessunitsRequest.postWorkforcemanagementBusinessunits(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementBusinessunitsRequest.postWorkforcemanagementBusinessunits was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementcalendarurlics": { - "operationId": "postworkforcemanagementcalendarurlics", - "functionName": "postWorkforcemanagementCalendarUrlIcs", - "signature": "postWorkforcemanagementCalendarUrlIcs(language)", - "parameters": [ - { - "name": "language", - "type": "String", - "required": "false" - } - ], - "return": "CalendarUrlResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet language: String = en-US // A language tag (which is sometimes referred to as a \\\"locale identifier\\\") to use to localize default activity code names in the ics-formatted calendar\n\n// Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned\nPostWorkforcemanagementCalendarUrlIcsRequest.postWorkforcemanagementCalendarUrlIcs(language: language) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementCalendarUrlIcsRequest.postWorkforcemanagementCalendarUrlIcs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementhistoricaldatadeletejob": { - "operationId": "postworkforcemanagementhistoricaldatadeletejob", - "functionName": "postWorkforcemanagementHistoricaldataDeletejob", - "signature": "postWorkforcemanagementHistoricaldataDeletejob()", - "return": "HistoricalImportDeleteJobResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Delete the entries of the historical data imports in the organization\nPostWorkforcemanagementHistoricaldataDeletejobRequest.postWorkforcemanagementHistoricaldataDeletejob() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementHistoricaldataDeletejobRequest.postWorkforcemanagementHistoricaldataDeletejob was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementhistoricaldatavalidate": { - "operationId": "postworkforcemanagementhistoricaldatavalidate", - "functionName": "postWorkforcemanagementHistoricaldataValidate", - "signature": "postWorkforcemanagementHistoricaldataValidate(body)", - "parameters": [ - { - "name": "body", - "type": "ValidationServiceRequest", - "required": "false" - } - ], - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ValidationServiceRequest = new ValidationServiceRequest(...) // body\n\n// Trigger validation process for historical import\nPostWorkforcemanagementHistoricaldataValidateRequest.postWorkforcemanagementHistoricaldataValidate(body: body) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"PostWorkforcemanagementHistoricaldataValidateRequest.postWorkforcemanagementHistoricaldataValidate was successful\")\n }\n}" - }, - "postworkforcemanagementintegrationshritimeofftypesjobs": { - "operationId": "postworkforcemanagementintegrationshritimeofftypesjobs", - "functionName": "postWorkforcemanagementIntegrationsHriTimeofftypesJobs", - "signature": "postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId)", - "parameters": [ - { - "name": "hrisIntegrationId", - "type": "String", - "required": "true" - } - ], - "return": "HrisTimeOffTypesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet hrisIntegrationId: String = \"\" // The ID of the HRIS integration for which time off types are queried.\n\n// Get list of time off types configured in integration\nPostWorkforcemanagementIntegrationsHriTimeofftypesJobsRequest.postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId: hrisIntegrationId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementIntegrationsHriTimeofftypesJobsRequest.postWorkforcemanagementIntegrationsHriTimeofftypesJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitagentschedulessearch": { - "operationId": "postworkforcemanagementmanagementunitagentschedulessearch", - "functionName": "postWorkforcemanagementManagementunitAgentschedulesSearch", - "signature": "postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, forceAsync, forceDownloadService, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - }, - { - "name": "forceDownloadService", - "type": "Bool", - "required": "false" - }, - { - "name": "body", - "type": "BuSearchAgentSchedulesRequest", - "required": "false" - } - ], - "return": "BuAsyncAgentSchedulesSearchResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\nlet forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes\nlet body: BuSearchAgentSchedulesRequest = new BuSearchAgentSchedulesRequest(...) // body\n\n// Query published schedules for given given time range for set of users\nPostWorkforcemanagementManagementunitAgentschedulesSearchRequest.postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId: managementUnitId, forceAsync: forceAsync, forceDownloadService: forceDownloadService, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitAgentschedulesSearchRequest.postWorkforcemanagementManagementunitAgentschedulesSearch was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunithistoricaladherencequery": { - "operationId": "postworkforcemanagementmanagementunithistoricaladherencequery", - "functionName": "postWorkforcemanagementManagementunitHistoricaladherencequery", - "signature": "postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WfmHistoricalAdherenceQuery", - "required": "false" - } - ], - "return": "WfmHistoricalAdherenceResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet body: WfmHistoricalAdherenceQuery = new WfmHistoricalAdherenceQuery(...) // body\n\n// Request a historical adherence report\nPostWorkforcemanagementManagementunitHistoricaladherencequeryRequest.postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitHistoricaladherencequeryRequest.postWorkforcemanagementManagementunitHistoricaladherencequery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitmove": { - "operationId": "postworkforcemanagementmanagementunitmove", - "functionName": "postWorkforcemanagementManagementunitMove", - "signature": "postWorkforcemanagementManagementunitMove(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MoveManagementUnitRequest", - "required": "false" - } - ], - "return": "MoveManagementUnitResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: MoveManagementUnitRequest = new MoveManagementUnitRequest(...) // body\n\n// Move the requested management unit to a new business unit\nPostWorkforcemanagementManagementunitMoveRequest.postWorkforcemanagementManagementunitMove(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitMoveRequest.postWorkforcemanagementManagementunitMove was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitschedulessearch": { - "operationId": "postworkforcemanagementmanagementunitschedulessearch", - "functionName": "postWorkforcemanagementManagementunitSchedulesSearch", - "signature": "postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "UserListScheduleRequestBody", - "required": "false" - } - ], - "return": "UserScheduleContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: UserListScheduleRequestBody = new UserListScheduleRequestBody(...) // body\n\n// Query published schedules for given given time range for set of users\nPostWorkforcemanagementManagementunitSchedulesSearchRequest.postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitSchedulesSearchRequest.postWorkforcemanagementManagementunitSchedulesSearch was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitshrinkagejobs": { - "operationId": "postworkforcemanagementmanagementunitshrinkagejobs", - "functionName": "postWorkforcemanagementManagementunitShrinkageJobs", - "signature": "postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WfmHistoricalShrinkageRequest", - "required": "false" - } - ], - "return": "WfmHistoricalShrinkageResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet body: WfmHistoricalShrinkageRequest = new WfmHistoricalShrinkageRequest(...) // body\n\n// Request a historical shrinkage report\nPostWorkforcemanagementManagementunitShrinkageJobsRequest.postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitShrinkageJobsRequest.postWorkforcemanagementManagementunitShrinkageJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeofflimits": { - "operationId": "postworkforcemanagementmanagementunittimeofflimits", - "functionName": "postWorkforcemanagementManagementunitTimeofflimits", - "signature": "postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateTimeOffLimitRequest", - "required": "false" - } - ], - "return": "TimeOffLimit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet body: CreateTimeOffLimitRequest = new CreateTimeOffLimitRequest(...) // body\n\n// Creates a new time off limit object under management unit.\nPostWorkforcemanagementManagementunitTimeofflimitsRequest.postWorkforcemanagementManagementunitTimeofflimits(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeofflimitsRequest.postWorkforcemanagementManagementunitTimeofflimits was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeofflimitsvaluesquery": { - "operationId": "postworkforcemanagementmanagementunittimeofflimitsvaluesquery", - "functionName": "postWorkforcemanagementManagementunitTimeofflimitsValuesQuery", - "signature": "postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueryTimeOffLimitValuesRequest", - "required": "false" - } - ], - "return": "QueryTimeOffLimitValuesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet body: QueryTimeOffLimitValuesRequest = new QueryTimeOffLimitValuesRequest(...) // body\n\n// Retrieves time off limit related values based on a given set of filters.\nPostWorkforcemanagementManagementunitTimeofflimitsValuesQueryRequest.postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeofflimitsValuesQueryRequest.postWorkforcemanagementManagementunitTimeofflimitsValuesQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeoffplans": { - "operationId": "postworkforcemanagementmanagementunittimeoffplans", - "functionName": "postWorkforcemanagementManagementunitTimeoffplans", - "signature": "postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateTimeOffPlanRequest", - "required": "false" - } - ], - "return": "TimeOffPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet body: CreateTimeOffPlanRequest = new CreateTimeOffPlanRequest(...) // body\n\n// Creates a new time off plan\nPostWorkforcemanagementManagementunitTimeoffplansRequest.postWorkforcemanagementManagementunitTimeoffplans(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeoffplansRequest.postWorkforcemanagementManagementunitTimeoffplans was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeoffrequests": { - "operationId": "postworkforcemanagementmanagementunittimeoffrequests", - "functionName": "postWorkforcemanagementManagementunitTimeoffrequests", - "signature": "postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CreateAdminTimeOffRequest", - "required": "false" - } - ], - "return": "TimeOffRequestList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: CreateAdminTimeOffRequest = new CreateAdminTimeOffRequest(...) // body\n\n// Create a new time off request\nPostWorkforcemanagementManagementunitTimeoffrequestsRequest.postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeoffrequestsRequest.postWorkforcemanagementManagementunitTimeoffrequests was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeoffrequestsintegrationstatusquery": { - "operationId": "postworkforcemanagementmanagementunittimeoffrequestsintegrationstatusquery", - "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery", - "signature": "postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueryTimeOffIntegrationStatusRequest", - "required": "false" - } - ], - "return": "UserTimeOffIntegrationStatusResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet body: QueryTimeOffIntegrationStatusRequest = new QueryTimeOffIntegrationStatusRequest(...) // body\n\n// Retrieves integration statuses for a list of time off requests\nPostWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeoffrequestsquery": { - "operationId": "postworkforcemanagementmanagementunittimeoffrequestsquery", - "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsQuery", - "signature": "postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TimeOffRequestQueryBody", - "required": "false" - } - ], - "return": "TimeOffRequestListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: TimeOffRequestQueryBody = new TimeOffRequestQueryBody(...) // body\n\n// Fetches time off requests matching the conditions specified in the request body\nPostWorkforcemanagementManagementunitTimeoffrequestsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeoffrequestsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunittimeoffrequestswaitlistpositionsquery": { - "operationId": "postworkforcemanagementmanagementunittimeoffrequestswaitlistpositionsquery", - "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery", - "signature": "postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "QueryWaitlistPositionsRequest", - "required": "false" - } - ], - "return": "WaitlistPositionListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet body: QueryWaitlistPositionsRequest = new QueryWaitlistPositionsRequest(...) // body\n\n// Retrieves daily waitlist position for a list of time off requests\nPostWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitusertimeoffbalancejobs": { - "operationId": "postworkforcemanagementmanagementunitusertimeoffbalancejobs", - "functionName": "postWorkforcemanagementManagementunitUserTimeoffbalanceJobs", - "signature": "postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "TimeOffBalanceRequest", - "required": "true" - } - ], - "return": "TimeOffBalancesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet userId: String = \"\" // The ID of the user\nlet body: TimeOffBalanceRequest = new TimeOffBalanceRequest(...) // The request body\n\n// Query time off balances for a given user for specified activity code and dates\nPostWorkforcemanagementManagementunitUserTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId: managementUnitId, userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitUserTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffbalanceJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitusertimeoffrequesttimeoffbalancejobs": { - "operationId": "postworkforcemanagementmanagementunitusertimeoffrequesttimeoffbalancejobs", - "functionName": "postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs", - "signature": "postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffRequestId", - "type": "String", - "required": "true" - } - ], - "return": "TimeOffBalancesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet userId: String = \"\" // The userId to whom the time off request applies.\nlet timeOffRequestId: String = \"\" // The time off request id.\n\n// Query time off balances for dates spanned by a given time off request\nPostWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitusertimeoffrequestsestimate": { - "operationId": "postworkforcemanagementmanagementunitusertimeoffrequestsestimate", - "functionName": "postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate", - "signature": "postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "userId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "EstimateAvailableTimeOffRequest", - "required": "false" - } - ], - "return": "EstimateAvailableTimeOffResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit\nlet userId: String = \"\" // The id of the user for whom the time off request estimate is requested\nlet body: EstimateAvailableTimeOffRequest = new EstimateAvailableTimeOffRequest(...) // body\n\n// Estimates available time off for an agent\nPostWorkforcemanagementManagementunitUserTimeoffrequestsEstimateRequest.postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId: managementUnitId, userId: userId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitUserTimeoffrequestsEstimateRequest.postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitweekshifttradematch": { - "operationId": "postworkforcemanagementmanagementunitweekshifttradematch", - "functionName": "postWorkforcemanagementManagementunitWeekShifttradeMatch", - "signature": "postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "tradeId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "MatchShiftTradeRequest", - "required": "true" - } - ], - "return": "MatchShiftTradeResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet tradeId: String = \"\" // The ID of the shift trade to update\nlet body: MatchShiftTradeRequest = new MatchShiftTradeRequest(...) // body\n\n// Matches a shift trade. This route can only be called by the receiving agent\nPostWorkforcemanagementManagementunitWeekShifttradeMatchRequest.postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId: managementUnitId, weekDateId: weekDateId, tradeId: tradeId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWeekShifttradeMatchRequest.postWorkforcemanagementManagementunitWeekShifttradeMatch was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitweekshifttrades": { - "operationId": "postworkforcemanagementmanagementunitweekshifttrades", - "functionName": "postWorkforcemanagementManagementunitWeekShifttrades", - "signature": "postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "AddShiftTradeRequest", - "required": "true" - } - ], - "return": "ShiftTradeResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet body: AddShiftTradeRequest = new AddShiftTradeRequest(...) // body\n\n// Adds a shift trade\nPostWorkforcemanagementManagementunitWeekShifttradesRequest.postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWeekShifttradesRequest.postWorkforcemanagementManagementunitWeekShifttrades was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitweekshifttradessearch": { - "operationId": "postworkforcemanagementmanagementunitweekshifttradessearch", - "functionName": "postWorkforcemanagementManagementunitWeekShifttradesSearch", - "signature": "postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "SearchShiftTradesRequest", - "required": "true" - } - ], - "return": "SearchShiftTradesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet body: SearchShiftTradesRequest = new SearchShiftTradesRequest(...) // body\n\n// Searches for potential shift trade matches for the current agent\nPostWorkforcemanagementManagementunitWeekShifttradesSearchRequest.postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWeekShifttradesSearchRequest.postWorkforcemanagementManagementunitWeekShifttradesSearch was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitweekshifttradesstatebulk": { - "operationId": "postworkforcemanagementmanagementunitweekshifttradesstatebulk", - "functionName": "postWorkforcemanagementManagementunitWeekShifttradesStateBulk", - "signature": "postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, forceAsync)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "weekDateId", - "type": "Date", - "required": "true" - }, - { - "name": "body", - "type": "BulkShiftTradeStateUpdateRequest", - "required": "true" - }, - { - "name": "forceAsync", - "type": "Bool", - "required": "false" - } - ], - "return": "BulkUpdateShiftTradeStateResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet weekDateId: Date = new Date(...) // 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\nlet body: BulkShiftTradeStateUpdateRequest = new BulkShiftTradeStateUpdateRequest(...) // body\nlet forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes\n\n// Updates the state of a batch of shift trades\nPostWorkforcemanagementManagementunitWeekShifttradesStateBulkRequest.postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body, forceAsync: forceAsync) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWeekShifttradesStateBulkRequest.postWorkforcemanagementManagementunitWeekShifttradesStateBulk was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitworkplancopy": { - "operationId": "postworkforcemanagementmanagementunitworkplancopy", - "functionName": "postWorkforcemanagementManagementunitWorkplanCopy", - "signature": "postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CopyWorkPlan", - "required": "false" - } - ], - "return": "WorkPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanId: String = \"\" // The ID of the work plan to create a copy\nlet body: CopyWorkPlan = new CopyWorkPlan(...) // body\n\n// Create a copy of work plan\nPostWorkforcemanagementManagementunitWorkplanCopyRequest.postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId: managementUnitId, workPlanId: workPlanId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWorkplanCopyRequest.postWorkforcemanagementManagementunitWorkplanCopy was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitworkplanvalidate": { - "operationId": "postworkforcemanagementmanagementunitworkplanvalidate", - "functionName": "postWorkforcemanagementManagementunitWorkplanValidate", - "signature": "postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, expand, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanId", - "type": "String", - "required": "true" - }, - { - "name": "expand", - "type": "[String]", - "required": "false" - }, - { - "name": "body", - "type": "WorkPlanValidationRequest", - "required": "false" - } - ], - "return": "ValidateWorkPlanResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanId: String = \"\" // The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.\nlet expand: [String] = [\"\"] // \nlet body: WorkPlanValidationRequest = new WorkPlanValidationRequest(...) // body\n\n// Validate Work Plan\nPostWorkforcemanagementManagementunitWorkplanValidateRequest.postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId: managementUnitId, workPlanId: workPlanId, expand: expand, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWorkplanValidateRequest.postWorkforcemanagementManagementunitWorkplanValidate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitworkplanrotationcopy": { - "operationId": "postworkforcemanagementmanagementunitworkplanrotationcopy", - "functionName": "postWorkforcemanagementManagementunitWorkplanrotationCopy", - "signature": "postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "workPlanRotationId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "CopyWorkPlanRotationRequest", - "required": "false" - } - ], - "return": "WorkPlanRotationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet workPlanRotationId: String = \"\" // The ID of the work plan rotation to create a copy\nlet body: CopyWorkPlanRotationRequest = new CopyWorkPlanRotationRequest(...) // body\n\n// Create a copy of work plan rotation\nPostWorkforcemanagementManagementunitWorkplanrotationCopyRequest.postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWorkplanrotationCopyRequest.postWorkforcemanagementManagementunitWorkplanrotationCopy was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitworkplanrotations": { - "operationId": "postworkforcemanagementmanagementunitworkplanrotations", - "functionName": "postWorkforcemanagementManagementunitWorkplanrotations", - "signature": "postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AddWorkPlanRotationRequest", - "required": "false" - } - ], - "return": "WorkPlanRotationResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet body: AddWorkPlanRotationRequest = new AddWorkPlanRotationRequest(...) // body\n\n// Create a new work plan rotation\nPostWorkforcemanagementManagementunitWorkplanrotationsRequest.postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId: managementUnitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWorkplanrotationsRequest.postWorkforcemanagementManagementunitWorkplanrotations was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunitworkplans": { - "operationId": "postworkforcemanagementmanagementunitworkplans", - "functionName": "postWorkforcemanagementManagementunitWorkplans", - "signature": "postWorkforcemanagementManagementunitWorkplans(managementUnitId, validationMode, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "validationMode", - "type": "String", - "required": "false" - }, - { - "name": "body", - "type": "CreateWorkPlan", - "required": "false" - } - ], - "return": "WorkPlan", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet validationMode: PostWorkforcemanagementManagementunitWorkplansRequest.ValidationMode_postWorkforcemanagementManagementunitWorkplans = PostWorkforcemanagementManagementunitWorkplansRequest.ValidationMode_postWorkforcemanagementManagementunitWorkplans.enummember // Allows to create work plan even if the validation result is invalid\nlet body: CreateWorkPlan = new CreateWorkPlan(...) // body\n\n// Create a new work plan\nPostWorkforcemanagementManagementunitWorkplansRequest.postWorkforcemanagementManagementunitWorkplans(managementUnitId: managementUnitId, validationMode: validationMode, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitWorkplansRequest.postWorkforcemanagementManagementunitWorkplans was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementmanagementunits": { - "operationId": "postworkforcemanagementmanagementunits", - "functionName": "postWorkforcemanagementManagementunits", - "signature": "postWorkforcemanagementManagementunits(body)", - "parameters": [ - { - "name": "body", - "type": "CreateManagementUnitApiRequest", - "required": "false" - } - ], - "return": "ManagementUnit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateManagementUnitApiRequest = new CreateManagementUnitApiRequest(...) // body\n\n// Add a management unit\nPostWorkforcemanagementManagementunitsRequest.postWorkforcemanagementManagementunits(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementManagementunitsRequest.postWorkforcemanagementManagementunits was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementnotificationsupdate": { - "operationId": "postworkforcemanagementnotificationsupdate", - "functionName": "postWorkforcemanagementNotificationsUpdate", - "signature": "postWorkforcemanagementNotificationsUpdate(body)", - "parameters": [ - { - "name": "body", - "type": "UpdateNotificationsRequest", - "required": "false" - } - ], - "return": "UpdateNotificationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: UpdateNotificationsRequest = new UpdateNotificationsRequest(...) // body\n\n// Mark a list of notifications as read or unread\nPostWorkforcemanagementNotificationsUpdateRequest.postWorkforcemanagementNotificationsUpdate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementNotificationsUpdateRequest.postWorkforcemanagementNotificationsUpdate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementschedules": { - "operationId": "postworkforcemanagementschedules", - "functionName": "postWorkforcemanagementSchedules", - "signature": "postWorkforcemanagementSchedules(body)", - "parameters": [ - { - "name": "body", - "type": "CurrentUserScheduleRequestBody", - "required": "false" - } - ], - "return": "UserScheduleContainer", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CurrentUserScheduleRequestBody = new CurrentUserScheduleRequestBody(...) // body\n\n// Get published schedule for the current user\nPostWorkforcemanagementSchedulesRequest.postWorkforcemanagementSchedules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementSchedulesRequest.postWorkforcemanagementSchedules was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementteamadherencehistorical": { - "operationId": "postworkforcemanagementteamadherencehistorical", - "functionName": "postWorkforcemanagementTeamAdherenceHistorical", - "signature": "postWorkforcemanagementTeamAdherenceHistorical(teamId, body)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WfmHistoricalAdherenceQueryForTeams", - "required": "false" - } - ], - "return": "WfmHistoricalAdherenceResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // The ID of the team\nlet body: WfmHistoricalAdherenceQueryForTeams = new WfmHistoricalAdherenceQueryForTeams(...) // body\n\n// Request a teams historical adherence report\nPostWorkforcemanagementTeamAdherenceHistoricalRequest.postWorkforcemanagementTeamAdherenceHistorical(teamId: teamId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTeamAdherenceHistoricalRequest.postWorkforcemanagementTeamAdherenceHistorical was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementteamshrinkagejobs": { - "operationId": "postworkforcemanagementteamshrinkagejobs", - "functionName": "postWorkforcemanagementTeamShrinkageJobs", - "signature": "postWorkforcemanagementTeamShrinkageJobs(teamId, body)", - "parameters": [ - { - "name": "teamId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "WfmHistoricalShrinkageTeamsRequest", - "required": "false" - } - ], - "return": "WfmHistoricalShrinkageResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet teamId: String = \"\" // The ID of the team\nlet body: WfmHistoricalShrinkageTeamsRequest = new WfmHistoricalShrinkageTeamsRequest(...) // body\n\n// Request a historical shrinkage report\nPostWorkforcemanagementTeamShrinkageJobsRequest.postWorkforcemanagementTeamShrinkageJobs(teamId: teamId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTeamShrinkageJobsRequest.postWorkforcemanagementTeamShrinkageJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementtimeoffbalancejobs": { - "operationId": "postworkforcemanagementtimeoffbalancejobs", - "functionName": "postWorkforcemanagementTimeoffbalanceJobs", - "signature": "postWorkforcemanagementTimeoffbalanceJobs(body)", - "parameters": [ - { - "name": "body", - "type": "TimeOffBalanceRequest", - "required": "true" - } - ], - "return": "TimeOffBalancesResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: TimeOffBalanceRequest = new TimeOffBalanceRequest(...) // The request body\n\n// Query time off balances for the current user for specified activity code and dates\nPostWorkforcemanagementTimeoffbalanceJobsRequest.postWorkforcemanagementTimeoffbalanceJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTimeoffbalanceJobsRequest.postWorkforcemanagementTimeoffbalanceJobs was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementtimeofflimitsavailablequery": { - "operationId": "postworkforcemanagementtimeofflimitsavailablequery", - "functionName": "postWorkforcemanagementTimeofflimitsAvailableQuery", - "signature": "postWorkforcemanagementTimeofflimitsAvailableQuery(body)", - "parameters": [ - { - "name": "body", - "type": "AvailableTimeOffRequest", - "required": "false" - } - ], - "return": "AvailableTimeOffResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: AvailableTimeOffRequest = new AvailableTimeOffRequest(...) // body\n\n// Queries available time off for the current user\nPostWorkforcemanagementTimeofflimitsAvailableQueryRequest.postWorkforcemanagementTimeofflimitsAvailableQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTimeofflimitsAvailableQueryRequest.postWorkforcemanagementTimeofflimitsAvailableQuery was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementtimeoffrequests": { - "operationId": "postworkforcemanagementtimeoffrequests", - "functionName": "postWorkforcemanagementTimeoffrequests", - "signature": "postWorkforcemanagementTimeoffrequests(body)", - "parameters": [ - { - "name": "body", - "type": "CreateAgentTimeOffRequest", - "required": "false" - } - ], - "return": "TimeOffRequestResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CreateAgentTimeOffRequest = new CreateAgentTimeOffRequest(...) // body\n\n// Create a time off request for the current user\nPostWorkforcemanagementTimeoffrequestsRequest.postWorkforcemanagementTimeoffrequests(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTimeoffrequestsRequest.postWorkforcemanagementTimeoffrequests was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementtimeoffrequestsestimate": { - "operationId": "postworkforcemanagementtimeoffrequestsestimate", - "functionName": "postWorkforcemanagementTimeoffrequestsEstimate", - "signature": "postWorkforcemanagementTimeoffrequestsEstimate(body)", - "parameters": [ - { - "name": "body", - "type": "EstimateAvailableTimeOffRequest", - "required": "false" - } - ], - "return": "EstimateAvailableTimeOffResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: EstimateAvailableTimeOffRequest = new EstimateAvailableTimeOffRequest(...) // body\n\n// Estimates available time off for current user\nPostWorkforcemanagementTimeoffrequestsEstimateRequest.postWorkforcemanagementTimeoffrequestsEstimate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTimeoffrequestsEstimateRequest.postWorkforcemanagementTimeoffrequestsEstimate was successful\")\n dump(response)\n }\n}" - }, - "postworkforcemanagementtimeoffrequestsintegrationstatusquery": { - "operationId": "postworkforcemanagementtimeoffrequestsintegrationstatusquery", - "functionName": "postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery", - "signature": "postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body)", - "parameters": [ - { - "name": "body", - "type": "CurrentUserTimeOffIntegrationStatusRequest", - "required": "false" - } - ], - "return": "TimeOffIntegrationStatusResponseListing", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CurrentUserTimeOffIntegrationStatusRequest = new CurrentUserTimeOffIntegrationStatusRequest(...) // body\n\n// Retrieves integration statuses for a list of current user time off requests\nPostWorkforcemanagementTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostWorkforcemanagementTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery was successful\")\n dump(response)\n }\n}" - }, - "putworkforcemanagementagentintegrationshris": { - "operationId": "putworkforcemanagementagentintegrationshris", - "functionName": "putWorkforcemanagementAgentIntegrationsHris", - "signature": "putWorkforcemanagementAgentIntegrationsHris(agentId, body)", - "parameters": [ - { - "name": "agentId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "AgentIntegrationsRequest", - "required": "true" - } - ], - "return": "AgentIntegrationsResponse", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet agentId: String = \"\" // The ID of the agent\nlet body: AgentIntegrationsRequest = new AgentIntegrationsRequest(...) // body\n\n// Update integrations for agent\nPutWorkforcemanagementAgentIntegrationsHrisRequest.putWorkforcemanagementAgentIntegrationsHris(agentId: agentId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWorkforcemanagementAgentIntegrationsHrisRequest.putWorkforcemanagementAgentIntegrationsHris was successful\")\n dump(response)\n }\n}" - }, - "putworkforcemanagementmanagementunittimeofflimitvalues": { - "operationId": "putworkforcemanagementmanagementunittimeofflimitvalues", - "functionName": "putWorkforcemanagementManagementunitTimeofflimitValues", - "signature": "putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, body)", - "parameters": [ - { - "name": "managementUnitId", - "type": "String", - "required": "true" - }, - { - "name": "timeOffLimitId", - "type": "String", - "required": "true" - }, - { - "name": "body", - "type": "SetTimeOffLimitValuesRequest", - "required": "false" - } - ], - "return": "TimeOffLimit", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit.\nlet timeOffLimitId: String = \"\" // The ID of the time off limit object to set values for\nlet body: SetTimeOffLimitValuesRequest = new SetTimeOffLimitValuesRequest(...) // body\n\n// Sets daily values for a date range of time off limit object\nPutWorkforcemanagementManagementunitTimeofflimitValuesRequest.putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutWorkforcemanagementManagementunitTimeofflimitValuesRequest.putWorkforcemanagementManagementunitTimeofflimitValues was successful\")\n dump(response)\n }\n}" - } -} \ No newline at end of file diff --git a/build/PureCloudPlatformClientV2.podspec b/build/PureCloudPlatformClientV2.podspec index e822833c2..b160f3920 100644 --- a/build/PureCloudPlatformClientV2.podspec +++ b/build/PureCloudPlatformClientV2.podspec @@ -4,8 +4,8 @@ Pod::Spec.new do |s| s.ios.deployment_target = '10.0' s.osx.deployment_target = '10.11' s.swift_version = '5.0' - s.version = '127.0.0' - s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.0.0' } + s.version = '127.1.0' + s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.1.0' } s.authors = 'Genesys Developer Evangelists' s.social_media_url = 'https://twitter.com/PureCloud_Dev' #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/' diff --git a/build/README.md b/build/README.md index b5e6a4f94..97f6bd4c1 100644 --- a/build/README.md +++ b/build/README.md @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.1.0' ``` Then install your project's dependencies: diff --git a/build/docs/AlertingAPI.json b/build/docs/AlertingAPI.json new file mode 100644 index 000000000..c58dc6d0a --- /dev/null +++ b/build/docs/AlertingAPI.json @@ -0,0 +1,349 @@ +{ + "DELETE /api/v2/alerting/alerts/{alertId}": { + "operationId": "deletealertingalert", + "functionName": "deleteAlertingAlert", + "signature": "deleteAlertingAlert(alertId)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/alerting/interactionstats/alerts/{alertId}": { + "operationId": "deletealertinginteractionstatsalert", + "functionName": "deleteAlertingInteractionstatsAlert", + "signature": "deleteAlertingInteractionstatsAlert(alertId)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/alerting/interactionstats/rules/{ruleId}": { + "operationId": "deletealertinginteractionstatsrule", + "functionName": "deleteAlertingInteractionstatsRule", + "signature": "deleteAlertingInteractionstatsRule(ruleId)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/alerting/rules/{ruleId}": { + "operationId": "deletealertingrule", + "functionName": "deleteAlertingRule", + "signature": "deleteAlertingRule(ruleId)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/alerting/alerts/{alertId}": { + "operationId": "getalertingalert", + "functionName": "getAlertingAlert", + "signature": "getAlertingAlert(alertId)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + } + ], + "return": "CommonAlert" + }, + "GET /api/v2/alerting/alerts/active": { + "operationId": "getalertingalertsactive", + "functionName": "getAlertingAlertsActive", + "signature": "getAlertingAlertsActive()", + + "return": "ActiveAlertCount" + }, + "GET /api/v2/alerting/interactionstats/alerts/{alertId}": { + "operationId": "getalertinginteractionstatsalert", + "functionName": "getAlertingInteractionstatsAlert", + "signature": "getAlertingInteractionstatsAlert(alertId, expand)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsAlert" + }, + "GET /api/v2/alerting/interactionstats/alerts": { + "operationId": "getalertinginteractionstatsalerts", + "functionName": "getAlertingInteractionstatsAlerts", + "signature": "getAlertingInteractionstatsAlerts(expand)", + "parameters": [ + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsAlertContainer" + }, + "GET /api/v2/alerting/interactionstats/alerts/unread": { + "operationId": "getalertinginteractionstatsalertsunread", + "functionName": "getAlertingInteractionstatsAlertsUnread", + "signature": "getAlertingInteractionstatsAlertsUnread()", + + "return": "UnreadMetric" + }, + "GET /api/v2/alerting/interactionstats/rules/{ruleId}": { + "operationId": "getalertinginteractionstatsrule", + "functionName": "getAlertingInteractionstatsRule", + "signature": "getAlertingInteractionstatsRule(ruleId, expand)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsRule" + }, + "GET /api/v2/alerting/interactionstats/rules": { + "operationId": "getalertinginteractionstatsrules", + "functionName": "getAlertingInteractionstatsRules", + "signature": "getAlertingInteractionstatsRules(expand)", + "parameters": [ + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsRuleContainer" + }, + "GET /api/v2/alerting/rules/{ruleId}": { + "operationId": "getalertingrule", + "functionName": "getAlertingRule", + "signature": "getAlertingRule(ruleId)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + } + ], + "return": "CommonRule" + }, + "PATCH /api/v2/alerting/alerts/{alertId}": { + "operationId": "patchalertingalert", + "functionName": "patchAlertingAlert", + "signature": "patchAlertingAlert(alertId, body)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AlertRequest", + "required": "false" + } + ], + "return": "CommonAlert" + }, + "PATCH /api/v2/alerting/alerts/bulk": { + "operationId": "patchalertingalertsbulk", + "functionName": "patchAlertingAlertsBulk", + "signature": "patchAlertingAlertsBulk(body)", + "parameters": [ + { + "name": "body", + "type": "CommonAlertBulkUpdateRequest", + "required": "true" + } + ], + "return": "BulkResponse" + }, + "PATCH /api/v2/alerting/rules/bulk": { + "operationId": "patchalertingrulesbulk", + "functionName": "patchAlertingRulesBulk", + "signature": "patchAlertingRulesBulk(body)", + "parameters": [ + { + "name": "body", + "type": "CommonRuleBulkUpdateNotificationsRequest", + "required": "true" + } + ], + "return": "BulkResponse" + }, + "POST /api/v2/alerting/alerts/query": { + "operationId": "postalertingalertsquery", + "functionName": "postAlertingAlertsQuery", + "signature": "postAlertingAlertsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "GetAlertQuery", + "required": "false" + } + ], + "return": "AlertListing" + }, + "POST /api/v2/alerting/interactionstats/rules": { + "operationId": "postalertinginteractionstatsrules", + "functionName": "postAlertingInteractionstatsRules", + "signature": "postAlertingInteractionstatsRules(body, expand)", + "parameters": [ + { + "name": "body", + "type": "InteractionStatsRule", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsRule" + }, + "POST /api/v2/alerting/rules": { + "operationId": "postalertingrules", + "functionName": "postAlertingRules", + "signature": "postAlertingRules(body)", + "parameters": [ + { + "name": "body", + "type": "CommonRule", + "required": "true" + } + ], + "return": "CommonRule" + }, + "POST /api/v2/alerting/rules/bulk/remove": { + "operationId": "postalertingrulesbulkremove", + "functionName": "postAlertingRulesBulkRemove", + "signature": "postAlertingRulesBulkRemove(body)", + "parameters": [ + { + "name": "body", + "type": "CommonRuleBulkDeleteRequest", + "required": "true" + } + ], + "return": "BulkResponse" + }, + "POST /api/v2/alerting/rules/query": { + "operationId": "postalertingrulesquery", + "functionName": "postAlertingRulesQuery", + "signature": "postAlertingRulesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "GetRulesQuery", + "required": "false" + } + ], + "return": "CommonRuleContainer" + }, + "PUT /api/v2/alerting/alerts/{alertId}": { + "operationId": "putalertingalert", + "functionName": "putAlertingAlert", + "signature": "putAlertingAlert(alertId, body)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AlertingUnreadStatus", + "required": "false" + } + ], + "return": "UnreadStatus" + }, + "PUT /api/v2/alerting/interactionstats/alerts/{alertId}": { + "operationId": "putalertinginteractionstatsalert", + "functionName": "putAlertingInteractionstatsAlert", + "signature": "putAlertingInteractionstatsAlert(alertId, body, expand)", + "parameters": [ + { + "name": "alertId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UnreadStatus", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UnreadStatus" + }, + "PUT /api/v2/alerting/interactionstats/rules/{ruleId}": { + "operationId": "putalertinginteractionstatsrule", + "functionName": "putAlertingInteractionstatsRule", + "signature": "putAlertingInteractionstatsRule(ruleId, body, expand)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InteractionStatsRule", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "InteractionStatsRule" + }, + "PUT /api/v2/alerting/rules/{ruleId}": { + "operationId": "putalertingrule", + "functionName": "putAlertingRule", + "signature": "putAlertingRule(ruleId, body)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ModifiableRuleProperties", + "required": "true" + } + ], + "return": "CommonRule" + } + +} \ No newline at end of file diff --git a/build/docs/AnalyticsAPI.json b/build/docs/AnalyticsAPI.json new file mode 100644 index 000000000..ba24b9e37 --- /dev/null +++ b/build/docs/AnalyticsAPI.json @@ -0,0 +1,700 @@ +{ + "DELETE /api/v2/analytics/conversations/details/jobs/{jobId}": { + "operationId": "deleteanalyticsconversationsdetailsjob", + "functionName": "deleteAnalyticsConversationsDetailsJob", + "signature": "deleteAnalyticsConversationsDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/analytics/reporting/schedules/{scheduleId}": { + "operationId": "deleteanalyticsreportingschedule", + "functionName": "deleteAnalyticsReportingSchedule", + "signature": "deleteAnalyticsReportingSchedule(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/analytics/users/details/jobs/{jobId}": { + "operationId": "deleteanalyticsusersdetailsjob", + "functionName": "deleteAnalyticsUsersDetailsJob", + "signature": "deleteAnalyticsUsersDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/analytics/botflows/{botFlowId}/reportingturns": { + "operationId": "getanalyticsbotflowreportingturns", + "functionName": "getAnalyticsBotflowReportingturns", + "signature": "getAnalyticsBotflowReportingturns(botFlowId, after, pageSize, interval, actionId, sessionId, language, askActionResults)", + "parameters": [ + { + "name": "botFlowId", + "type": "String", + "required": "true" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "actionId", + "type": "String", + "required": "false" + }, + { + "name": "sessionId", + "type": "String", + "required": "false" + }, + { + "name": "language", + "type": "String", + "required": "false" + }, + { + "name": "askActionResults", + "type": "String", + "required": "false" + } + ], + "return": "ReportingTurnsResponse" + }, + "GET /api/v2/analytics/conversations/{conversationId}/details": { + "operationId": "getanalyticsconversationdetails", + "functionName": "getAnalyticsConversationDetails", + "signature": "getAnalyticsConversationDetails(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "AnalyticsConversationWithoutAttributes" + }, + "GET /api/v2/analytics/conversations/details": { + "operationId": "getanalyticsconversationsdetails", + "functionName": "getAnalyticsConversationsDetails", + "signature": "getAnalyticsConversationsDetails(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "AnalyticsConversationWithoutAttributesMultiGetResponse" + }, + "GET /api/v2/analytics/conversations/details/jobs/{jobId}": { + "operationId": "getanalyticsconversationsdetailsjob", + "functionName": "getAnalyticsConversationsDetailsJob", + "signature": "getAnalyticsConversationsDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AsyncQueryStatus" + }, + "GET /api/v2/analytics/conversations/details/jobs/{jobId}/results": { + "operationId": "getanalyticsconversationsdetailsjobresults", + "functionName": "getAnalyticsConversationsDetailsJobResults", + "signature": "getAnalyticsConversationsDetailsJobResults(jobId, cursor, pageSize)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "AnalyticsConversationAsyncQueryResponse" + }, + "GET /api/v2/analytics/conversations/details/jobs/availability": { + "operationId": "getanalyticsconversationsdetailsjobsavailability", + "functionName": "getAnalyticsConversationsDetailsJobsAvailability", + "signature": "getAnalyticsConversationsDetailsJobsAvailability()", + + "return": "DataAvailabilityResponse" + }, + "GET /api/v2/analytics/dataretention/settings": { + "operationId": "getanalyticsdataretentionsettings", + "functionName": "getAnalyticsDataretentionSettings", + "signature": "getAnalyticsDataretentionSettings()", + + "return": "AnalyticsDataRetentionResponse" + }, + "GET /api/v2/analytics/reporting/exports": { + "operationId": "getanalyticsreportingexports", + "functionName": "getAnalyticsReportingExports", + "signature": "getAnalyticsReportingExports(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ReportingExportJobListing" + }, + "GET /api/v2/analytics/reporting/exports/metadata": { + "operationId": "getanalyticsreportingexportsmetadata", + "functionName": "getAnalyticsReportingExportsMetadata", + "signature": "getAnalyticsReportingExportsMetadata()", + + "return": "ReportingExportMetadataJobListing" + }, + "GET /api/v2/analytics/reporting/metadata": { + "operationId": "getanalyticsreportingmetadata", + "functionName": "getAnalyticsReportingMetadata", + "signature": "getAnalyticsReportingMetadata(pageNumber, pageSize, locale)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "locale", + "type": "String", + "required": "false" + } + ], + "return": "ReportMetaDataEntityListing" + }, + "GET /api/v2/analytics/reporting/{reportId}/metadata": { + "operationId": "getanalyticsreportingreportidmetadata", + "functionName": "getAnalyticsReportingReportIdMetadata", + "signature": "getAnalyticsReportingReportIdMetadata(reportId, locale)", + "parameters": [ + { + "name": "reportId", + "type": "String", + "required": "true" + }, + { + "name": "locale", + "type": "String", + "required": "false" + } + ], + "return": "ReportMetaData" + }, + "GET /api/v2/analytics/reporting/reportformats": { + "operationId": "getanalyticsreportingreportformats", + "functionName": "getAnalyticsReportingReportformats", + "signature": "getAnalyticsReportingReportformats()", + + "return": "[String]" + }, + "GET /api/v2/analytics/reporting/schedules/{scheduleId}": { + "operationId": "getanalyticsreportingschedule", + "functionName": "getAnalyticsReportingSchedule", + "signature": "getAnalyticsReportingSchedule(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "ReportSchedule" + }, + "GET /api/v2/analytics/reporting/schedules/{scheduleId}/history": { + "operationId": "getanalyticsreportingschedulehistory", + "functionName": "getAnalyticsReportingScheduleHistory", + "signature": "getAnalyticsReportingScheduleHistory(scheduleId, pageNumber, pageSize)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ReportRunEntryEntityDomainListing" + }, + "GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest": { + "operationId": "getanalyticsreportingschedulehistorylatest", + "functionName": "getAnalyticsReportingScheduleHistoryLatest", + "signature": "getAnalyticsReportingScheduleHistoryLatest(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "ReportRunEntry" + }, + "GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}": { + "operationId": "getanalyticsreportingschedulehistoryrunid", + "functionName": "getAnalyticsReportingScheduleHistoryRunId", + "signature": "getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId)", + "parameters": [ + { + "name": "runId", + "type": "String", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "ReportRunEntry" + }, + "GET /api/v2/analytics/reporting/schedules": { + "operationId": "getanalyticsreportingschedules", + "functionName": "getAnalyticsReportingSchedules", + "signature": "getAnalyticsReportingSchedules(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ReportScheduleEntityListing" + }, + "GET /api/v2/analytics/reporting/settings": { + "operationId": "getanalyticsreportingsettings", + "functionName": "getAnalyticsReportingSettings", + "signature": "getAnalyticsReportingSettings()", + + "return": "AnalyticsReportingSettings" + }, + "GET /api/v2/analytics/reporting/timeperiods": { + "operationId": "getanalyticsreportingtimeperiods", + "functionName": "getAnalyticsReportingTimeperiods", + "signature": "getAnalyticsReportingTimeperiods()", + + "return": "[String]" + }, + "GET /api/v2/analytics/users/details/jobs/{jobId}": { + "operationId": "getanalyticsusersdetailsjob", + "functionName": "getAnalyticsUsersDetailsJob", + "signature": "getAnalyticsUsersDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AsyncQueryStatus" + }, + "GET /api/v2/analytics/users/details/jobs/{jobId}/results": { + "operationId": "getanalyticsusersdetailsjobresults", + "functionName": "getAnalyticsUsersDetailsJobResults", + "signature": "getAnalyticsUsersDetailsJobResults(jobId, cursor, pageSize)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "AnalyticsUserDetailsAsyncQueryResponse" + }, + "GET /api/v2/analytics/users/details/jobs/availability": { + "operationId": "getanalyticsusersdetailsjobsavailability", + "functionName": "getAnalyticsUsersDetailsJobsAvailability", + "signature": "getAnalyticsUsersDetailsJobsAvailability()", + + "return": "DataAvailabilityResponse" + }, + "PATCH /api/v2/analytics/reporting/settings": { + "operationId": "patchanalyticsreportingsettings", + "functionName": "patchAnalyticsReportingSettings", + "signature": "patchAnalyticsReportingSettings(body)", + "parameters": [ + { + "name": "body", + "type": "AnalyticsReportingSettings", + "required": "true" + } + ], + "return": "AnalyticsReportingSettings" + }, + "POST /api/v2/analytics/actions/aggregates/query": { + "operationId": "postanalyticsactionsaggregatesquery", + "functionName": "postAnalyticsActionsAggregatesQuery", + "signature": "postAnalyticsActionsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ActionAggregationQuery", + "required": "true" + } + ], + "return": "ActionAggregateQueryResponse" + }, + "POST /api/v2/analytics/bots/aggregates/query": { + "operationId": "postanalyticsbotsaggregatesquery", + "functionName": "postAnalyticsBotsAggregatesQuery", + "signature": "postAnalyticsBotsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "BotAggregationQuery", + "required": "true" + } + ], + "return": "BotAggregateQueryResponse" + }, + "POST /api/v2/analytics/conversations/{conversationId}/details/properties": { + "operationId": "postanalyticsconversationdetailsproperties", + "functionName": "postAnalyticsConversationDetailsProperties", + "signature": "postAnalyticsConversationDetailsProperties(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PropertyIndexRequest", + "required": "true" + } + ], + "return": "PropertyIndexRequest" + }, + "POST /api/v2/analytics/conversations/aggregates/query": { + "operationId": "postanalyticsconversationsaggregatesquery", + "functionName": "postAnalyticsConversationsAggregatesQuery", + "signature": "postAnalyticsConversationsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationAggregationQuery", + "required": "true" + } + ], + "return": "ConversationAggregateQueryResponse" + }, + "POST /api/v2/analytics/conversations/details/jobs": { + "operationId": "postanalyticsconversationsdetailsjobs", + "functionName": "postAnalyticsConversationsDetailsJobs", + "signature": "postAnalyticsConversationsDetailsJobs(body)", + "parameters": [ + { + "name": "body", + "type": "AsyncConversationQuery", + "required": "true" + } + ], + "return": "AsyncQueryResponse" + }, + "POST /api/v2/analytics/conversations/details/query": { + "operationId": "postanalyticsconversationsdetailsquery", + "functionName": "postAnalyticsConversationsDetailsQuery", + "signature": "postAnalyticsConversationsDetailsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationQuery", + "required": "true" + } + ], + "return": "AnalyticsConversationQueryResponse" + }, + "POST /api/v2/analytics/conversations/transcripts/query": { + "operationId": "postanalyticsconversationstranscriptsquery", + "functionName": "postAnalyticsConversationsTranscriptsQuery", + "signature": "postAnalyticsConversationsTranscriptsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptConversationDetailSearchRequest", + "required": "true" + } + ], + "return": "AnalyticsConversationWithoutAttributesMultiGetResponse" + }, + "POST /api/v2/analytics/evaluations/aggregates/query": { + "operationId": "postanalyticsevaluationsaggregatesquery", + "functionName": "postAnalyticsEvaluationsAggregatesQuery", + "signature": "postAnalyticsEvaluationsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationAggregationQuery", + "required": "true" + } + ], + "return": "EvaluationAggregateQueryResponse" + }, + "POST /api/v2/analytics/flows/aggregates/query": { + "operationId": "postanalyticsflowsaggregatesquery", + "functionName": "postAnalyticsFlowsAggregatesQuery", + "signature": "postAnalyticsFlowsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "FlowAggregationQuery", + "required": "true" + } + ], + "return": "FlowAggregateQueryResponse" + }, + "POST /api/v2/analytics/flows/observations/query": { + "operationId": "postanalyticsflowsobservationsquery", + "functionName": "postAnalyticsFlowsObservationsQuery", + "signature": "postAnalyticsFlowsObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "FlowObservationQuery", + "required": "true" + } + ], + "return": "FlowObservationQueryResponse" + }, + "POST /api/v2/analytics/journeys/aggregates/query": { + "operationId": "postanalyticsjourneysaggregatesquery", + "functionName": "postAnalyticsJourneysAggregatesQuery", + "signature": "postAnalyticsJourneysAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "JourneyAggregationQuery", + "required": "true" + } + ], + "return": "JourneyAggregateQueryResponse" + }, + "POST /api/v2/analytics/queues/observations/query": { + "operationId": "postanalyticsqueuesobservationsquery", + "functionName": "postAnalyticsQueuesObservationsQuery", + "signature": "postAnalyticsQueuesObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "QueueObservationQuery", + "required": "true" + } + ], + "return": "QueueObservationQueryResponse" + }, + "POST /api/v2/analytics/reporting/exports": { + "operationId": "postanalyticsreportingexports", + "functionName": "postAnalyticsReportingExports", + "signature": "postAnalyticsReportingExports(body)", + "parameters": [ + { + "name": "body", + "type": "ReportingExportJobRequest", + "required": "true" + } + ], + "return": "ReportingExportJobResponse" + }, + "POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport": { + "operationId": "postanalyticsreportingschedulerunreport", + "functionName": "postAnalyticsReportingScheduleRunreport", + "signature": "postAnalyticsReportingScheduleRunreport(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "RunNowResponse" + }, + "POST /api/v2/analytics/reporting/schedules": { + "operationId": "postanalyticsreportingschedules", + "functionName": "postAnalyticsReportingSchedules", + "signature": "postAnalyticsReportingSchedules(body)", + "parameters": [ + { + "name": "body", + "type": "ReportSchedule", + "required": "true" + } + ], + "return": "ReportSchedule" + }, + "POST /api/v2/analytics/surveys/aggregates/query": { + "operationId": "postanalyticssurveysaggregatesquery", + "functionName": "postAnalyticsSurveysAggregatesQuery", + "signature": "postAnalyticsSurveysAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "SurveyAggregationQuery", + "required": "true" + } + ], + "return": "SurveyAggregateQueryResponse" + }, + "POST /api/v2/analytics/transcripts/aggregates/query": { + "operationId": "postanalyticstranscriptsaggregatesquery", + "functionName": "postAnalyticsTranscriptsAggregatesQuery", + "signature": "postAnalyticsTranscriptsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptAggregationQuery", + "required": "true" + } + ], + "return": "TranscriptAggregateQueryResponse" + }, + "POST /api/v2/analytics/users/aggregates/query": { + "operationId": "postanalyticsusersaggregatesquery", + "functionName": "postAnalyticsUsersAggregatesQuery", + "signature": "postAnalyticsUsersAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserAggregationQuery", + "required": "true" + } + ], + "return": "UserAggregateQueryResponse" + }, + "POST /api/v2/analytics/users/details/jobs": { + "operationId": "postanalyticsusersdetailsjobs", + "functionName": "postAnalyticsUsersDetailsJobs", + "signature": "postAnalyticsUsersDetailsJobs(body)", + "parameters": [ + { + "name": "body", + "type": "AsyncUserDetailsQuery", + "required": "true" + } + ], + "return": "AsyncQueryResponse" + }, + "POST /api/v2/analytics/users/details/query": { + "operationId": "postanalyticsusersdetailsquery", + "functionName": "postAnalyticsUsersDetailsQuery", + "signature": "postAnalyticsUsersDetailsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserDetailsQuery", + "required": "true" + } + ], + "return": "AnalyticsUserDetailsQueryResponse" + }, + "POST /api/v2/analytics/users/observations/query": { + "operationId": "postanalyticsusersobservationsquery", + "functionName": "postAnalyticsUsersObservationsQuery", + "signature": "postAnalyticsUsersObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserObservationQuery", + "required": "true" + } + ], + "return": "UserObservationQueryResponse" + }, + "PUT /api/v2/analytics/dataretention/settings": { + "operationId": "putanalyticsdataretentionsettings", + "functionName": "putAnalyticsDataretentionSettings", + "signature": "putAnalyticsDataretentionSettings(body)", + "parameters": [ + { + "name": "body", + "type": "UpdateAnalyticsDataRetentionRequest", + "required": "true" + } + ], + "return": "AnalyticsDataRetentionResponse" + }, + "PUT /api/v2/analytics/reporting/schedules/{scheduleId}": { + "operationId": "putanalyticsreportingschedule", + "functionName": "putAnalyticsReportingSchedule", + "signature": "putAnalyticsReportingSchedule(scheduleId, body)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ReportSchedule", + "required": "true" + } + ], + "return": "ReportSchedule" + } + +} \ No newline at end of file diff --git a/build/docs/ArchitectAPI.json b/build/docs/ArchitectAPI.json new file mode 100644 index 000000000..eb72702f2 --- /dev/null +++ b/build/docs/ArchitectAPI.json @@ -0,0 +1,2674 @@ +{ + "DELETE /api/v2/architect/emergencygroups/{emergencyGroupId}": { + "operationId": "deletearchitectemergencygroup", + "functionName": "deleteArchitectEmergencygroup", + "signature": "deleteArchitectEmergencygroup(emergencyGroupId)", + "parameters": [ + { + "name": "emergencyGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/ivrs/{ivrId}": { + "operationId": "deletearchitectivr", + "functionName": "deleteArchitectIvr", + "signature": "deleteArchitectIvr(ivrId)", + "parameters": [ + { + "name": "ivrId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/prompts/{promptId}": { + "operationId": "deletearchitectprompt", + "functionName": "deleteArchitectPrompt", + "signature": "deleteArchitectPrompt(promptId, allResources)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "allResources", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}": { + "operationId": "deletearchitectpromptresource", + "functionName": "deleteArchitectPromptResource", + "signature": "deleteArchitectPromptResource(promptId, languageCode)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio": { + "operationId": "deletearchitectpromptresourceaudio", + "functionName": "deleteArchitectPromptResourceAudio", + "signature": "deleteArchitectPromptResourceAudio(promptId, languageCode)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/prompts": { + "operationId": "deletearchitectprompts", + "functionName": "deleteArchitectPrompts", + "signature": "deleteArchitectPrompts(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "true" + } + ], + "return": "Operation" + }, + "DELETE /api/v2/architect/schedules/{scheduleId}": { + "operationId": "deletearchitectschedule", + "functionName": "deleteArchitectSchedule", + "signature": "deleteArchitectSchedule(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/schedulegroups/{scheduleGroupId}": { + "operationId": "deletearchitectschedulegroup", + "functionName": "deleteArchitectSchedulegroup", + "signature": "deleteArchitectSchedulegroup(scheduleGroupId)", + "parameters": [ + { + "name": "scheduleGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}": { + "operationId": "deletearchitectsystempromptresource", + "functionName": "deleteArchitectSystempromptResource", + "signature": "deleteArchitectSystempromptResource(promptId, languageCode)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/flows/{flowId}": { + "operationId": "deleteflow", + "functionName": "deleteFlow", + "signature": "deleteFlow(flowId)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/flows": { + "operationId": "deleteflows", + "functionName": "deleteFlows", + "signature": "deleteFlows(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "true" + } + ], + "return": "Operation" + }, + "DELETE /api/v2/flows/datatables/{datatableId}": { + "operationId": "deleteflowsdatatable", + "functionName": "deleteFlowsDatatable", + "signature": "deleteFlowsDatatable(datatableId, force)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "force", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId}": { + "operationId": "deleteflowsdatatablerow", + "functionName": "deleteFlowsDatatableRow", + "signature": "deleteFlowsDatatableRow(datatableId, rowId)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "rowId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/flows/milestones/{milestoneId}": { + "operationId": "deleteflowsmilestone", + "functionName": "deleteFlowsMilestone", + "signature": "deleteFlowsMilestone(milestoneId)", + "parameters": [ + { + "name": "milestoneId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "GET /api/v2/architect/dependencytracking": { + "operationId": "getarchitectdependencytracking", + "functionName": "getArchitectDependencytracking", + "signature": "getArchitectDependencytracking(name, pageNumber, pageSize, objectType, consumedResources, consumingResources, consumedResourceType, consumingResourceType)", + "parameters": [ + { + "name": "name", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "objectType", + "type": "[String]", + "required": "false" + }, + { + "name": "consumedResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumingResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumedResourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "consumingResourceType", + "type": "[String]", + "required": "false" + } + ], + "return": "DependencyObjectEntityListing" + }, + "GET /api/v2/architect/dependencytracking/build": { + "operationId": "getarchitectdependencytrackingbuild", + "functionName": "getArchitectDependencytrackingBuild", + "signature": "getArchitectDependencytrackingBuild()", + + "return": "DependencyStatus" + }, + "GET /api/v2/architect/dependencytracking/consumedresources": { + "operationId": "getarchitectdependencytrackingconsumedresources", + "functionName": "getArchitectDependencytrackingConsumedresources", + "signature": "getArchitectDependencytrackingConsumedresources(_id, version, objectType, resourceType, pageNumber, pageSize)", + "parameters": [ + { + "name": "_id", + "type": "String", + "required": "true" + }, + { + "name": "version", + "type": "String", + "required": "true" + }, + { + "name": "objectType", + "type": "String", + "required": "true" + }, + { + "name": "resourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ConsumedResourcesEntityListing" + }, + "GET /api/v2/architect/dependencytracking/consumingresources": { + "operationId": "getarchitectdependencytrackingconsumingresources", + "functionName": "getArchitectDependencytrackingConsumingresources", + "signature": "getArchitectDependencytrackingConsumingresources(_id, objectType, resourceType, version, pageNumber, pageSize, flowFilter)", + "parameters": [ + { + "name": "_id", + "type": "String", + "required": "true" + }, + { + "name": "objectType", + "type": "String", + "required": "true" + }, + { + "name": "resourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "version", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "flowFilter", + "type": "String", + "required": "false" + } + ], + "return": "ConsumingResourcesEntityListing" + }, + "GET /api/v2/architect/dependencytracking/deletedresourceconsumers": { + "operationId": "getarchitectdependencytrackingdeletedresourceconsumers", + "functionName": "getArchitectDependencytrackingDeletedresourceconsumers", + "signature": "getArchitectDependencytrackingDeletedresourceconsumers(name, objectType, flowFilter, consumedResources, consumedResourceType, pageNumber, pageSize)", + "parameters": [ + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "objectType", + "type": "[String]", + "required": "false" + }, + { + "name": "flowFilter", + "type": "String", + "required": "false" + }, + { + "name": "consumedResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumedResourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DependencyObjectEntityListing" + }, + "GET /api/v2/architect/dependencytracking/object": { + "operationId": "getarchitectdependencytrackingobject", + "functionName": "getArchitectDependencytrackingObject", + "signature": "getArchitectDependencytrackingObject(_id, version, objectType, consumedResources, consumingResources, consumedResourceType, consumingResourceType, consumedResourceRequest)", + "parameters": [ + { + "name": "_id", + "type": "String", + "required": "true" + }, + { + "name": "version", + "type": "String", + "required": "false" + }, + { + "name": "objectType", + "type": "String", + "required": "false" + }, + { + "name": "consumedResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumingResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumedResourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "consumingResourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "consumedResourceRequest", + "type": "Bool", + "required": "false" + } + ], + "return": "DependencyObject" + }, + "GET /api/v2/architect/dependencytracking/types/{typeId}": { + "operationId": "getarchitectdependencytrackingtype", + "functionName": "getArchitectDependencytrackingType", + "signature": "getArchitectDependencytrackingType(typeId)", + "parameters": [ + { + "name": "typeId", + "type": "String", + "required": "true" + } + ], + "return": "DependencyType" + }, + "GET /api/v2/architect/dependencytracking/types": { + "operationId": "getarchitectdependencytrackingtypes", + "functionName": "getArchitectDependencytrackingTypes", + "signature": "getArchitectDependencytrackingTypes(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DependencyTypeEntityListing" + }, + "GET /api/v2/architect/dependencytracking/updatedresourceconsumers": { + "operationId": "getarchitectdependencytrackingupdatedresourceconsumers", + "functionName": "getArchitectDependencytrackingUpdatedresourceconsumers", + "signature": "getArchitectDependencytrackingUpdatedresourceconsumers(name, objectType, consumedResources, consumedResourceType, pageNumber, pageSize)", + "parameters": [ + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "objectType", + "type": "[String]", + "required": "false" + }, + { + "name": "consumedResources", + "type": "Bool", + "required": "false" + }, + { + "name": "consumedResourceType", + "type": "[String]", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DependencyObjectEntityListing" + }, + "GET /api/v2/architect/emergencygroups/{emergencyGroupId}": { + "operationId": "getarchitectemergencygroup", + "functionName": "getArchitectEmergencygroup", + "signature": "getArchitectEmergencygroup(emergencyGroupId)", + "parameters": [ + { + "name": "emergencyGroupId", + "type": "String", + "required": "true" + } + ], + "return": "EmergencyGroup" + }, + "GET /api/v2/architect/emergencygroups": { + "operationId": "getarchitectemergencygroups", + "functionName": "getArchitectEmergencygroups", + "signature": "getArchitectEmergencygroups(pageNumber, pageSize, sortBy, sortOrder, name)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "EmergencyGroupListing" + }, + "GET /api/v2/architect/emergencygroups/divisionviews": { + "operationId": "getarchitectemergencygroupsdivisionviews", + "functionName": "getArchitectEmergencygroupsDivisionviews", + "signature": "getArchitectEmergencygroupsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "EmergencyGroupDivisionViewEntityListing" + }, + "GET /api/v2/architect/ivrs/{ivrId}": { + "operationId": "getarchitectivr", + "functionName": "getArchitectIvr", + "signature": "getArchitectIvr(ivrId)", + "parameters": [ + { + "name": "ivrId", + "type": "String", + "required": "true" + } + ], + "return": "IVR" + }, + "GET /api/v2/architect/ivrs": { + "operationId": "getarchitectivrs", + "functionName": "getArchitectIvrs", + "signature": "getArchitectIvrs(pageNumber, pageSize, sortBy, sortOrder, name, dnis, scheduleGroup)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "dnis", + "type": "String", + "required": "false" + }, + { + "name": "scheduleGroup", + "type": "String", + "required": "false" + } + ], + "return": "IVREntityListing" + }, + "GET /api/v2/architect/ivrs/divisionviews": { + "operationId": "getarchitectivrsdivisionviews", + "functionName": "getArchitectIvrsDivisionviews", + "signature": "getArchitectIvrsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "IVRDivisionViewEntityListing" + }, + "GET /api/v2/architect/prompts/{promptId}": { + "operationId": "getarchitectprompt", + "functionName": "getArchitectPrompt", + "signature": "getArchitectPrompt(promptId)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + } + ], + "return": "Prompt" + }, + "GET /api/v2/architect/prompts/{promptId}/history/{historyId}": { + "operationId": "getarchitectprompthistoryhistoryid", + "functionName": "getArchitectPromptHistoryHistoryId", + "signature": "getArchitectPromptHistoryHistoryId(promptId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "historyId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "action", + "type": "[String]", + "required": "false" + } + ], + "return": "HistoryListing" + }, + "GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}": { + "operationId": "getarchitectpromptresource", + "functionName": "getArchitectPromptResource", + "signature": "getArchitectPromptResource(promptId, languageCode)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "PromptAsset" + }, + "GET /api/v2/architect/prompts/{promptId}/resources": { + "operationId": "getarchitectpromptresources", + "functionName": "getArchitectPromptResources", + "signature": "getArchitectPromptResources(promptId, pageNumber, pageSize)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "PromptAssetEntityListing" + }, + "GET /api/v2/architect/prompts": { + "operationId": "getarchitectprompts", + "functionName": "getArchitectPrompts", + "signature": "getArchitectPrompts(pageNumber, pageSize, name, _description, nameOrDescription, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "[String]", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "nameOrDescription", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "PromptEntityListing" + }, + "GET /api/v2/architect/schedules/{scheduleId}": { + "operationId": "getarchitectschedule", + "functionName": "getArchitectSchedule", + "signature": "getArchitectSchedule(scheduleId)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "Schedule" + }, + "GET /api/v2/architect/schedulegroups/{scheduleGroupId}": { + "operationId": "getarchitectschedulegroup", + "functionName": "getArchitectSchedulegroup", + "signature": "getArchitectSchedulegroup(scheduleGroupId)", + "parameters": [ + { + "name": "scheduleGroupId", + "type": "String", + "required": "true" + } + ], + "return": "ScheduleGroup" + }, + "GET /api/v2/architect/schedulegroups": { + "operationId": "getarchitectschedulegroups", + "functionName": "getArchitectSchedulegroups", + "signature": "getArchitectSchedulegroups(pageNumber, pageSize, sortBy, sortOrder, name, scheduleIds, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "scheduleIds", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "ScheduleGroupEntityListing" + }, + "GET /api/v2/architect/schedulegroups/divisionviews": { + "operationId": "getarchitectschedulegroupsdivisionviews", + "functionName": "getArchitectSchedulegroupsDivisionviews", + "signature": "getArchitectSchedulegroupsDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "ScheduleGroupDivisionViewEntityListing" + }, + "GET /api/v2/architect/schedules": { + "operationId": "getarchitectschedules", + "functionName": "getArchitectSchedules", + "signature": "getArchitectSchedules(pageNumber, pageSize, sortBy, sortOrder, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "ScheduleEntityListing" + }, + "GET /api/v2/architect/schedules/divisionviews": { + "operationId": "getarchitectschedulesdivisionviews", + "functionName": "getArchitectSchedulesDivisionviews", + "signature": "getArchitectSchedulesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "ScheduleDivisionViewEntityListing" + }, + "GET /api/v2/architect/systemprompts/{promptId}": { + "operationId": "getarchitectsystemprompt", + "functionName": "getArchitectSystemprompt", + "signature": "getArchitectSystemprompt(promptId)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + } + ], + "return": "SystemPrompt" + }, + "GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}": { + "operationId": "getarchitectsystemprompthistoryhistoryid", + "functionName": "getArchitectSystempromptHistoryHistoryId", + "signature": "getArchitectSystempromptHistoryHistoryId(promptId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "historyId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "action", + "type": "[String]", + "required": "false" + } + ], + "return": "HistoryListing" + }, + "GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}": { + "operationId": "getarchitectsystempromptresource", + "functionName": "getArchitectSystempromptResource", + "signature": "getArchitectSystempromptResource(promptId, languageCode)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "SystemPromptAsset" + }, + "GET /api/v2/architect/systemprompts/{promptId}/resources": { + "operationId": "getarchitectsystempromptresources", + "functionName": "getArchitectSystempromptResources", + "signature": "getArchitectSystempromptResources(promptId, pageNumber, pageSize, sortBy, sortOrder)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "SystemPromptAssetEntityListing" + }, + "GET /api/v2/architect/systemprompts": { + "operationId": "getarchitectsystemprompts", + "functionName": "getArchitectSystemprompts", + "signature": "getArchitectSystemprompts(pageNumber, pageSize, sortBy, sortOrder, name, _description, nameOrDescription)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "nameOrDescription", + "type": "String", + "required": "false" + } + ], + "return": "SystemPromptEntityListing" + }, + "GET /api/v2/flows/{flowId}": { + "operationId": "getflow", + "functionName": "getFlow", + "signature": "getFlow(flowId, deleted)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "deleted", + "type": "Bool", + "required": "false" + } + ], + "return": "Flow" + }, + "GET /api/v2/flows/{flowId}/history/{historyId}": { + "operationId": "getflowhistoryhistoryid", + "functionName": "getFlowHistoryHistoryId", + "signature": "getFlowHistoryHistoryId(flowId, historyId, pageNumber, pageSize, sortOrder, sortBy, action)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "historyId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "action", + "type": "[String]", + "required": "false" + } + ], + "return": "HistoryListing" + }, + "GET /api/v2/flows/{flowId}/latestconfiguration": { + "operationId": "getflowlatestconfiguration", + "functionName": "getFlowLatestconfiguration", + "signature": "getFlowLatestconfiguration(flowId, deleted)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "deleted", + "type": "Bool", + "required": "false" + } + ], + "return": "JSON" + }, + "GET /api/v2/flows/{flowId}/versions/{versionId}": { + "operationId": "getflowversion", + "functionName": "getFlowVersion", + "signature": "getFlowVersion(flowId, versionId, deleted)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "deleted", + "type": "String", + "required": "false" + } + ], + "return": "FlowVersion" + }, + "GET /api/v2/flows/{flowId}/versions/{versionId}/configuration": { + "operationId": "getflowversionconfiguration", + "functionName": "getFlowVersionConfiguration", + "signature": "getFlowVersionConfiguration(flowId, versionId, deleted)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "deleted", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "GET /api/v2/flows/{flowId}/versions/{versionId}/health": { + "operationId": "getflowversionhealth", + "functionName": "getFlowVersionHealth", + "signature": "getFlowVersionHealth(flowId, versionId, language)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "language", + "type": "String", + "required": "false" + } + ], + "return": "FlowHealth" + }, + "GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health": { + "operationId": "getflowversionintenthealth", + "functionName": "getFlowVersionIntentHealth", + "signature": "getFlowVersionIntentHealth(flowId, versionId, intentId, language)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "intentId", + "type": "String", + "required": "true" + }, + { + "name": "language", + "type": "String", + "required": "true" + } + ], + "return": "FlowHealthIntent" + }, + "GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health": { + "operationId": "getflowversionintentutterancehealth", + "functionName": "getFlowVersionIntentUtteranceHealth", + "signature": "getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "intentId", + "type": "String", + "required": "true" + }, + { + "name": "utteranceId", + "type": "String", + "required": "true" + }, + { + "name": "language", + "type": "String", + "required": "true" + } + ], + "return": "FlowHealthUtterance" + }, + "GET /api/v2/flows/{flowId}/versions": { + "operationId": "getflowversions", + "functionName": "getFlowVersions", + "signature": "getFlowVersions(flowId, pageNumber, pageSize, deleted)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "deleted", + "type": "Bool", + "required": "false" + } + ], + "return": "FlowVersionEntityListing" + }, + "GET /api/v2/flows": { + "operationId": "getflows", + "functionName": "getFlows", + "signature": "getFlows(type, pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, publishVersionId, editableBy, lockedBy, lockedByClientId, secure, deleted, includeSchemas, publishedAfter, publishedBefore, divisionId)", + "parameters": [ + { + "name": "type", + "type": "[String]", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "nameOrDescription", + "type": "String", + "required": "false" + }, + { + "name": "publishVersionId", + "type": "String", + "required": "false" + }, + { + "name": "editableBy", + "type": "String", + "required": "false" + }, + { + "name": "lockedBy", + "type": "String", + "required": "false" + }, + { + "name": "lockedByClientId", + "type": "String", + "required": "false" + }, + { + "name": "secure", + "type": "String", + "required": "false" + }, + { + "name": "deleted", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSchemas", + "type": "Bool", + "required": "false" + }, + { + "name": "publishedAfter", + "type": "String", + "required": "false" + }, + { + "name": "publishedBefore", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "FlowEntityListing" + }, + "GET /api/v2/flows/datatables/{datatableId}": { + "operationId": "getflowsdatatable", + "functionName": "getFlowsDatatable", + "signature": "getFlowsDatatable(datatableId, expand)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "DataTable" + }, + "GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}": { + "operationId": "getflowsdatatableexportjob", + "functionName": "getFlowsDatatableExportJob", + "signature": "getFlowsDatatableExportJob(datatableId, exportJobId)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "exportJobId", + "type": "String", + "required": "true" + } + ], + "return": "DataTableExportJob" + }, + "GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}": { + "operationId": "getflowsdatatableimportjob", + "functionName": "getFlowsDatatableImportJob", + "signature": "getFlowsDatatableImportJob(datatableId, importJobId)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "importJobId", + "type": "String", + "required": "true" + } + ], + "return": "DataTableImportJob" + }, + "GET /api/v2/flows/datatables/{datatableId}/import/jobs": { + "operationId": "getflowsdatatableimportjobs", + "functionName": "getFlowsDatatableImportJobs", + "signature": "getFlowsDatatableImportJobs(datatableId, pageNumber, pageSize)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DataTableImportEntityListing" + }, + "GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}": { + "operationId": "getflowsdatatablerow", + "functionName": "getFlowsDatatableRow", + "signature": "getFlowsDatatableRow(datatableId, rowId, showbrief)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "rowId", + "type": "String", + "required": "true" + }, + { + "name": "showbrief", + "type": "Bool", + "required": "false" + } + ], + "return": "[String:JSON]" + }, + "GET /api/v2/flows/datatables/{datatableId}/rows": { + "operationId": "getflowsdatatablerows", + "functionName": "getFlowsDatatableRows", + "signature": "getFlowsDatatableRows(datatableId, pageNumber, pageSize, showbrief, sortOrder)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "showbrief", + "type": "Bool", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DataTableRowEntityListing" + }, + "GET /api/v2/flows/datatables": { + "operationId": "getflowsdatatables", + "functionName": "getFlowsDatatables", + "signature": "getFlowsDatatables(expand, pageNumber, pageSize, sortBy, sortOrder, divisionId, name)", + "parameters": [ + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "DataTablesDomainEntityListing" + }, + "GET /api/v2/flows/datatables/divisionviews/{datatableId}": { + "operationId": "getflowsdatatablesdivisionview", + "functionName": "getFlowsDatatablesDivisionview", + "signature": "getFlowsDatatablesDivisionview(datatableId, expand)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "DataTable" + }, + "GET /api/v2/flows/datatables/divisionviews": { + "operationId": "getflowsdatatablesdivisionviews", + "functionName": "getFlowsDatatablesDivisionviews", + "signature": "getFlowsDatatablesDivisionviews(expand, pageNumber, pageSize, sortBy, sortOrder, divisionId, name)", + "parameters": [ + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "DataTablesDomainEntityListing" + }, + "GET /api/v2/flows/divisionviews": { + "operationId": "getflowsdivisionviews", + "functionName": "getFlowsDivisionviews", + "signature": "getFlowsDivisionviews(type, pageNumber, pageSize, sortBy, sortOrder, _id, name, publishVersionId, publishedAfter, publishedBefore, divisionId, includeSchemas)", + "parameters": [ + { + "name": "type", + "type": "[String]", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "publishVersionId", + "type": "String", + "required": "false" + }, + { + "name": "publishedAfter", + "type": "String", + "required": "false" + }, + { + "name": "publishedBefore", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "includeSchemas", + "type": "Bool", + "required": "false" + } + ], + "return": "FlowDivisionViewEntityListing" + }, + "GET /api/v2/flows/executions/{flowExecutionId}": { + "operationId": "getflowsexecution", + "functionName": "getFlowsExecution", + "signature": "getFlowsExecution(flowExecutionId)", + "parameters": [ + { + "name": "flowExecutionId", + "type": "String", + "required": "true" + } + ], + "return": "FlowRuntimeExecution" + }, + "GET /api/v2/flows/jobs/{jobId}": { + "operationId": "getflowsjob", + "functionName": "getFlowsJob", + "signature": "getFlowsJob(jobId, expand)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ArchitectJobStateResponse" + }, + "GET /api/v2/flows/milestones/{milestoneId}": { + "operationId": "getflowsmilestone", + "functionName": "getFlowsMilestone", + "signature": "getFlowsMilestone(milestoneId)", + "parameters": [ + { + "name": "milestoneId", + "type": "String", + "required": "true" + } + ], + "return": "FlowMilestone" + }, + "GET /api/v2/flows/milestones": { + "operationId": "getflowsmilestones", + "functionName": "getFlowsMilestones", + "signature": "getFlowsMilestones(pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "nameOrDescription", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "FlowMilestoneListing" + }, + "GET /api/v2/flows/milestones/divisionviews": { + "operationId": "getflowsmilestonesdivisionviews", + "functionName": "getFlowsMilestonesDivisionviews", + "signature": "getFlowsMilestonesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "FlowMilestoneDivisionViewEntityListing" + }, + "GET /api/v2/flows/outcomes/{flowOutcomeId}": { + "operationId": "getflowsoutcome", + "functionName": "getFlowsOutcome", + "signature": "getFlowsOutcome(flowOutcomeId)", + "parameters": [ + { + "name": "flowOutcomeId", + "type": "String", + "required": "true" + } + ], + "return": "FlowOutcome" + }, + "GET /api/v2/flows/outcomes": { + "operationId": "getflowsoutcomes", + "functionName": "getFlowsOutcomes", + "signature": "getFlowsOutcomes(pageNumber, pageSize, sortBy, sortOrder, _id, name, _description, nameOrDescription, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "nameOrDescription", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "FlowOutcomeListing" + }, + "GET /api/v2/flows/outcomes/divisionviews": { + "operationId": "getflowsoutcomesdivisionviews", + "functionName": "getFlowsOutcomesDivisionviews", + "signature": "getFlowsOutcomesDivisionviews(pageNumber, pageSize, sortBy, sortOrder, _id, name, divisionId)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "FlowOutcomeDivisionViewEntityListing" + }, + "POST /api/v2/architect/dependencytracking/build": { + "operationId": "postarchitectdependencytrackingbuild", + "functionName": "postArchitectDependencytrackingBuild", + "signature": "postArchitectDependencytrackingBuild()" + + }, + "POST /api/v2/architect/emergencygroups": { + "operationId": "postarchitectemergencygroups", + "functionName": "postArchitectEmergencygroups", + "signature": "postArchitectEmergencygroups(body)", + "parameters": [ + { + "name": "body", + "type": "EmergencyGroup", + "required": "true" + } + ], + "return": "EmergencyGroup" + }, + "POST /api/v2/architect/ivrs": { + "operationId": "postarchitectivrs", + "functionName": "postArchitectIvrs", + "signature": "postArchitectIvrs(body)", + "parameters": [ + { + "name": "body", + "type": "IVR", + "required": "true" + } + ], + "return": "IVR" + }, + "POST /api/v2/architect/prompts/{promptId}/history": { + "operationId": "postarchitectprompthistory", + "functionName": "postArchitectPromptHistory", + "signature": "postArchitectPromptHistory(promptId)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + } + ], + "return": "Operation" + }, + "POST /api/v2/architect/prompts/{promptId}/resources": { + "operationId": "postarchitectpromptresources", + "functionName": "postArchitectPromptResources", + "signature": "postArchitectPromptResources(promptId, body)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PromptAssetCreate", + "required": "true" + } + ], + "return": "PromptAsset" + }, + "POST /api/v2/architect/prompts": { + "operationId": "postarchitectprompts", + "functionName": "postArchitectPrompts", + "signature": "postArchitectPrompts(body)", + "parameters": [ + { + "name": "body", + "type": "Prompt", + "required": "true" + } + ], + "return": "Prompt" + }, + "POST /api/v2/architect/schedulegroups": { + "operationId": "postarchitectschedulegroups", + "functionName": "postArchitectSchedulegroups", + "signature": "postArchitectSchedulegroups(body)", + "parameters": [ + { + "name": "body", + "type": "ScheduleGroup", + "required": "true" + } + ], + "return": "ScheduleGroup" + }, + "POST /api/v2/architect/schedules": { + "operationId": "postarchitectschedules", + "functionName": "postArchitectSchedules", + "signature": "postArchitectSchedules(body)", + "parameters": [ + { + "name": "body", + "type": "Schedule", + "required": "true" + } + ], + "return": "Schedule" + }, + "POST /api/v2/architect/systemprompts/{promptId}/history": { + "operationId": "postarchitectsystemprompthistory", + "functionName": "postArchitectSystempromptHistory", + "signature": "postArchitectSystempromptHistory(promptId)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + } + ], + "return": "Operation" + }, + "POST /api/v2/architect/systemprompts/{promptId}/resources": { + "operationId": "postarchitectsystempromptresources", + "functionName": "postArchitectSystempromptResources", + "signature": "postArchitectSystempromptResources(promptId, body)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SystemPromptAsset", + "required": "true" + } + ], + "return": "SystemPromptAsset" + }, + "POST /api/v2/flows/{flowId}/history": { + "operationId": "postflowhistory", + "functionName": "postFlowHistory", + "signature": "postFlowHistory(flowId)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + } + ], + "return": "Operation" + }, + "POST /api/v2/flows/{flowId}/versions": { + "operationId": "postflowversions", + "functionName": "postFlowVersions", + "signature": "postFlowVersions(flowId, body)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String:JSON]", + "required": "true" + } + ], + "return": "FlowVersion" + }, + "POST /api/v2/flows": { + "operationId": "postflows", + "functionName": "postFlows", + "signature": "postFlows(body, language)", + "parameters": [ + { + "name": "body", + "type": "Flow", + "required": "true" + }, + { + "name": "language", + "type": "String", + "required": "false" + } + ], + "return": "Flow" + }, + "POST /api/v2/flows/actions/checkin": { + "operationId": "postflowsactionscheckin", + "functionName": "postFlowsActionsCheckin", + "signature": "postFlowsActionsCheckin(flow)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + } + ], + "return": "Operation" + }, + "POST /api/v2/flows/actions/checkout": { + "operationId": "postflowsactionscheckout", + "functionName": "postFlowsActionsCheckout", + "signature": "postFlowsActionsCheckout(flow)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + } + ], + "return": "Flow" + }, + "POST /api/v2/flows/actions/deactivate": { + "operationId": "postflowsactionsdeactivate", + "functionName": "postFlowsActionsDeactivate", + "signature": "postFlowsActionsDeactivate(flow)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + } + ], + "return": "Flow" + }, + "POST /api/v2/flows/actions/publish": { + "operationId": "postflowsactionspublish", + "functionName": "postFlowsActionsPublish", + "signature": "postFlowsActionsPublish(flow, version)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + }, + { + "name": "version", + "type": "String", + "required": "false" + } + ], + "return": "Operation" + }, + "POST /api/v2/flows/actions/revert": { + "operationId": "postflowsactionsrevert", + "functionName": "postFlowsActionsRevert", + "signature": "postFlowsActionsRevert(flow)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + } + ], + "return": "Flow" + }, + "POST /api/v2/flows/actions/unlock": { + "operationId": "postflowsactionsunlock", + "functionName": "postFlowsActionsUnlock", + "signature": "postFlowsActionsUnlock(flow)", + "parameters": [ + { + "name": "flow", + "type": "String", + "required": "true" + } + ], + "return": "Flow" + }, + "POST /api/v2/flows/datatables/{datatableId}/export/jobs": { + "operationId": "postflowsdatatableexportjobs", + "functionName": "postFlowsDatatableExportJobs", + "signature": "postFlowsDatatableExportJobs(datatableId)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + } + ], + "return": "DataTableExportJob" + }, + "POST /api/v2/flows/datatables/{datatableId}/import/jobs": { + "operationId": "postflowsdatatableimportjobs", + "functionName": "postFlowsDatatableImportJobs", + "signature": "postFlowsDatatableImportJobs(datatableId, body)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DataTableImportJob", + "required": "true" + } + ], + "return": "DataTableImportJob" + }, + "POST /api/v2/flows/datatables/{datatableId}/rows": { + "operationId": "postflowsdatatablerows", + "functionName": "postFlowsDatatableRows", + "signature": "postFlowsDatatableRows(datatableId, dataTableRow)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "dataTableRow", + "type": "[String:JSON]", + "required": "true" + } + ], + "return": "[String:JSON]" + }, + "POST /api/v2/flows/datatables": { + "operationId": "postflowsdatatables", + "functionName": "postFlowsDatatables", + "signature": "postFlowsDatatables(body)", + "parameters": [ + { + "name": "body", + "type": "DataTable", + "required": "true" + } + ], + "return": "DataTable" + }, + "POST /api/v2/flows/executions": { + "operationId": "postflowsexecutions", + "functionName": "postFlowsExecutions", + "signature": "postFlowsExecutions(flowLaunchRequest)", + "parameters": [ + { + "name": "flowLaunchRequest", + "type": "FlowExecutionLaunchRequest", + "required": "true" + } + ], + "return": "FlowExecutionLaunchResponse" + }, + "POST /api/v2/flows/jobs": { + "operationId": "postflowsjobs", + "functionName": "postFlowsJobs", + "signature": "postFlowsJobs()", + + "return": "RegisterArchitectJobResponse" + }, + "POST /api/v2/flows/milestones": { + "operationId": "postflowsmilestones", + "functionName": "postFlowsMilestones", + "signature": "postFlowsMilestones(body)", + "parameters": [ + { + "name": "body", + "type": "FlowMilestone", + "required": "false" + } + ], + "return": "FlowMilestone" + }, + "POST /api/v2/flows/outcomes": { + "operationId": "postflowsoutcomes", + "functionName": "postFlowsOutcomes", + "signature": "postFlowsOutcomes(body)", + "parameters": [ + { + "name": "body", + "type": "FlowOutcome", + "required": "false" + } + ], + "return": "FlowOutcome" + }, + "PUT /api/v2/architect/emergencygroups/{emergencyGroupId}": { + "operationId": "putarchitectemergencygroup", + "functionName": "putArchitectEmergencygroup", + "signature": "putArchitectEmergencygroup(emergencyGroupId, body)", + "parameters": [ + { + "name": "emergencyGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EmergencyGroup", + "required": "true" + } + ], + "return": "EmergencyGroup" + }, + "PUT /api/v2/architect/ivrs/{ivrId}": { + "operationId": "putarchitectivr", + "functionName": "putArchitectIvr", + "signature": "putArchitectIvr(ivrId, body)", + "parameters": [ + { + "name": "ivrId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "IVR", + "required": "true" + } + ], + "return": "IVR" + }, + "PUT /api/v2/architect/prompts/{promptId}": { + "operationId": "putarchitectprompt", + "functionName": "putArchitectPrompt", + "signature": "putArchitectPrompt(promptId, body)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Prompt", + "required": "true" + } + ], + "return": "Prompt" + }, + "PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}": { + "operationId": "putarchitectpromptresource", + "functionName": "putArchitectPromptResource", + "signature": "putArchitectPromptResource(promptId, languageCode, body)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PromptAsset", + "required": "true" + } + ], + "return": "PromptAsset" + }, + "PUT /api/v2/architect/schedules/{scheduleId}": { + "operationId": "putarchitectschedule", + "functionName": "putArchitectSchedule", + "signature": "putArchitectSchedule(scheduleId, body)", + "parameters": [ + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Schedule", + "required": "true" + } + ], + "return": "Schedule" + }, + "PUT /api/v2/architect/schedulegroups/{scheduleGroupId}": { + "operationId": "putarchitectschedulegroup", + "functionName": "putArchitectSchedulegroup", + "signature": "putArchitectSchedulegroup(scheduleGroupId, body)", + "parameters": [ + { + "name": "scheduleGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScheduleGroup", + "required": "true" + } + ], + "return": "ScheduleGroup" + }, + "PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}": { + "operationId": "putarchitectsystempromptresource", + "functionName": "putArchitectSystempromptResource", + "signature": "putArchitectSystempromptResource(promptId, languageCode, body)", + "parameters": [ + { + "name": "promptId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SystemPromptAsset", + "required": "true" + } + ], + "return": "SystemPromptAsset" + }, + "PUT /api/v2/flows/{flowId}": { + "operationId": "putflow", + "functionName": "putFlow", + "signature": "putFlow(flowId, body)", + "parameters": [ + { + "name": "flowId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Flow", + "required": "true" + } + ], + "return": "Flow" + }, + "PUT /api/v2/flows/datatables/{datatableId}": { + "operationId": "putflowsdatatable", + "functionName": "putFlowsDatatable", + "signature": "putFlowsDatatable(datatableId, body, expand)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DataTable", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "DataTable" + }, + "PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}": { + "operationId": "putflowsdatatablerow", + "functionName": "putFlowsDatatableRow", + "signature": "putFlowsDatatableRow(datatableId, rowId, body)", + "parameters": [ + { + "name": "datatableId", + "type": "String", + "required": "true" + }, + { + "name": "rowId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String:JSON]", + "required": "false" + } + ], + "return": "[String:JSON]" + }, + "PUT /api/v2/flows/milestones/{milestoneId}": { + "operationId": "putflowsmilestone", + "functionName": "putFlowsMilestone", + "signature": "putFlowsMilestone(milestoneId, body)", + "parameters": [ + { + "name": "milestoneId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "FlowMilestone", + "required": "false" + } + ], + "return": "FlowMilestone" + }, + "PUT /api/v2/flows/outcomes/{flowOutcomeId}": { + "operationId": "putflowsoutcome", + "functionName": "putFlowsOutcome", + "signature": "putFlowsOutcome(flowOutcomeId, body)", + "parameters": [ + { + "name": "flowOutcomeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "FlowOutcome", + "required": "false" + } + ], + "return": "Operation" + } + +} \ No newline at end of file diff --git a/build/docs/AuditAPI.json b/build/docs/AuditAPI.json new file mode 100644 index 000000000..26118436b --- /dev/null +++ b/build/docs/AuditAPI.json @@ -0,0 +1,89 @@ +{ + "GET /api/v2/audits/query/realtime/servicemapping": { + "operationId": "getauditsqueryrealtimeservicemapping", + "functionName": "getAuditsQueryRealtimeServicemapping", + "signature": "getAuditsQueryRealtimeServicemapping()", + + "return": "AuditQueryServiceMapping" + }, + "GET /api/v2/audits/query/servicemapping": { + "operationId": "getauditsqueryservicemapping", + "functionName": "getAuditsQueryServicemapping", + "signature": "getAuditsQueryServicemapping()", + + "return": "AuditQueryServiceMapping" + }, + "GET /api/v2/audits/query/{transactionId}": { + "operationId": "getauditsquerytransactionid", + "functionName": "getAuditsQueryTransactionId", + "signature": "getAuditsQueryTransactionId(transactionId)", + "parameters": [ + { + "name": "transactionId", + "type": "String", + "required": "true" + } + ], + "return": "AuditQueryExecutionStatusResponse" + }, + "GET /api/v2/audits/query/{transactionId}/results": { + "operationId": "getauditsquerytransactionidresults", + "functionName": "getAuditsQueryTransactionIdResults", + "signature": "getAuditsQueryTransactionIdResults(transactionId, cursor, pageSize, expand)", + "parameters": [ + { + "name": "transactionId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "AuditQueryExecutionResultsResponse" + }, + "POST /api/v2/audits/query": { + "operationId": "postauditsquery", + "functionName": "postAuditsQuery", + "signature": "postAuditsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "AuditQueryRequest", + "required": "true" + } + ], + "return": "AuditQueryExecutionStatusResponse" + }, + "POST /api/v2/audits/query/realtime": { + "operationId": "postauditsqueryrealtime", + "functionName": "postAuditsQueryRealtime", + "signature": "postAuditsQueryRealtime(body, expand)", + "parameters": [ + { + "name": "body", + "type": "AuditRealtimeQueryRequest", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "AuditRealtimeQueryResultsResponse" + } + +} \ No newline at end of file diff --git a/build/docs/AuthorizationAPI.json b/build/docs/AuthorizationAPI.json new file mode 100644 index 000000000..e223d14fc --- /dev/null +++ b/build/docs/AuthorizationAPI.json @@ -0,0 +1,835 @@ +{ + "DELETE /api/v2/authorization/divisions/{divisionId}": { + "operationId": "deleteauthorizationdivision", + "functionName": "deleteAuthorizationDivision", + "signature": "deleteAuthorizationDivision(divisionId, force)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "force", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/authorization/roles/{roleId}": { + "operationId": "deleteauthorizationrole", + "functionName": "deleteAuthorizationRole", + "signature": "deleteAuthorizationRole(roleId)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}": { + "operationId": "deleteauthorizationsubjectdivisionrole", + "functionName": "deleteAuthorizationSubjectDivisionRole", + "signature": "deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "roleId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/authorization/divisions/{divisionId}": { + "operationId": "getauthorizationdivision", + "functionName": "getAuthorizationDivision", + "signature": "getAuthorizationDivision(divisionId, objectCount)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "objectCount", + "type": "Bool", + "required": "false" + } + ], + "return": "AuthzDivision" + }, + "GET /api/v2/authorization/divisions/{divisionId}/grants": { + "operationId": "getauthorizationdivisiongrants", + "functionName": "getAuthorizationDivisionGrants", + "signature": "getAuthorizationDivisionGrants(divisionId, pageNumber, pageSize)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "AuthzDivisionGrantEntityListing" + }, + "GET /api/v2/authorization/divisions": { + "operationId": "getauthorizationdivisions", + "functionName": "getAuthorizationDivisions", + "signature": "getAuthorizationDivisions(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, objectCount, _id, name)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "objectCount", + "type": "Bool", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "AuthzDivisionEntityListing" + }, + "GET /api/v2/authorization/divisions/home": { + "operationId": "getauthorizationdivisionshome", + "functionName": "getAuthorizationDivisionsHome", + "signature": "getAuthorizationDivisionsHome()", + + "return": "AuthzDivision" + }, + "GET /api/v2/authorization/divisions/limit": { + "operationId": "getauthorizationdivisionslimit", + "functionName": "getAuthorizationDivisionsLimit", + "signature": "getAuthorizationDivisionsLimit()", + + "return": "Int" + }, + "GET /api/v2/authorization/divisionspermitted/me": { + "operationId": "getauthorizationdivisionspermittedme", + "functionName": "getAuthorizationDivisionspermittedMe", + "signature": "getAuthorizationDivisionspermittedMe(permission, name)", + "parameters": [ + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "[AuthzDivision]" + }, + "GET /api/v2/authorization/divisionspermitted/paged/me": { + "operationId": "getauthorizationdivisionspermittedpagedme", + "functionName": "getAuthorizationDivisionspermittedPagedMe", + "signature": "getAuthorizationDivisionspermittedPagedMe(permission, pageNumber, pageSize)", + "parameters": [ + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DivsPermittedEntityListing" + }, + "GET /api/v2/authorization/divisionspermitted/paged/{subjectId}": { + "operationId": "getauthorizationdivisionspermittedpagedsubjectid", + "functionName": "getAuthorizationDivisionspermittedPagedSubjectId", + "signature": "getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, pageNumber, pageSize)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DivsPermittedEntityListing" + }, + "GET /api/v2/authorization/permissions": { + "operationId": "getauthorizationpermissions", + "functionName": "getAuthorizationPermissions", + "signature": "getAuthorizationPermissions(pageSize, pageNumber, queryType, query)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "queryType", + "type": "String", + "required": "false" + }, + { + "name": "query", + "type": "String", + "required": "false" + } + ], + "return": "PermissionCollectionEntityListing" + }, + "GET /api/v2/authorization/products": { + "operationId": "getauthorizationproducts", + "functionName": "getAuthorizationProducts", + "signature": "getAuthorizationProducts()", + + "return": "OrganizationProductEntityListing" + }, + "GET /api/v2/authorization/roles/{roleId}": { + "operationId": "getauthorizationrole", + "functionName": "getAuthorizationRole", + "signature": "getAuthorizationRole(roleId, userCount, expand)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "userCount", + "type": "Bool", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "DomainOrganizationRole" + }, + "GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}": { + "operationId": "getauthorizationrolecomparedefaultrightroleid", + "functionName": "getAuthorizationRoleComparedefaultRightRoleId", + "signature": "getAuthorizationRoleComparedefaultRightRoleId(leftRoleId, rightRoleId)", + "parameters": [ + { + "name": "leftRoleId", + "type": "String", + "required": "true" + }, + { + "name": "rightRoleId", + "type": "String", + "required": "true" + } + ], + "return": "DomainOrgRoleDifference" + }, + "GET /api/v2/authorization/roles/{roleId}/subjectgrants": { + "operationId": "getauthorizationrolesubjectgrants", + "functionName": "getAuthorizationRoleSubjectgrants", + "signature": "getAuthorizationRoleSubjectgrants(roleId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "SubjectDivisionGrantsEntityListing" + }, + "GET /api/v2/authorization/roles/{roleId}/users": { + "operationId": "getauthorizationroleusers", + "functionName": "getAuthorizationRoleUsers", + "signature": "getAuthorizationRoleUsers(roleId, pageSize, pageNumber)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "UserEntityListing" + }, + "GET /api/v2/authorization/roles": { + "operationId": "getauthorizationroles", + "functionName": "getAuthorizationRoles", + "signature": "getAuthorizationRoles(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, permission, defaultRoleId, userCount, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "permission", + "type": "[String]", + "required": "false" + }, + { + "name": "defaultRoleId", + "type": "[String]", + "required": "false" + }, + { + "name": "userCount", + "type": "Bool", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "OrganizationRoleEntityListing" + }, + "GET /api/v2/authorization/settings": { + "operationId": "getauthorizationsettings", + "functionName": "getAuthorizationSettings", + "signature": "getAuthorizationSettings()", + + "return": "AuthorizationSettings" + }, + "GET /api/v2/authorization/subjects/{subjectId}": { + "operationId": "getauthorizationsubject", + "functionName": "getAuthorizationSubject", + "signature": "getAuthorizationSubject(subjectId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + } + ], + "return": "AuthzSubject" + }, + "GET /api/v2/authorization/subjects/me": { + "operationId": "getauthorizationsubjectsme", + "functionName": "getAuthorizationSubjectsMe", + "signature": "getAuthorizationSubjectsMe()", + + "return": "AuthzSubject" + }, + "GET /api/v2/authorization/subjects/rolecounts": { + "operationId": "getauthorizationsubjectsrolecounts", + "functionName": "getAuthorizationSubjectsRolecounts", + "signature": "getAuthorizationSubjectsRolecounts(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "[String:JSON]" + }, + "GET /api/v2/users/{subjectId}/roles": { + "operationId": "getuserroles", + "functionName": "getUserRoles", + "signature": "getUserRoles(subjectId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PATCH /api/v2/authorization/roles/{roleId}": { + "operationId": "patchauthorizationrole", + "functionName": "patchAuthorizationRole", + "signature": "patchAuthorizationRole(roleId, body)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainOrganizationRole", + "required": "true" + } + ], + "return": "DomainOrganizationRole" + }, + "PATCH /api/v2/authorization/settings": { + "operationId": "patchauthorizationsettings", + "functionName": "patchAuthorizationSettings", + "signature": "patchAuthorizationSettings(body)", + "parameters": [ + { + "name": "body", + "type": "AuthorizationSettings", + "required": "true" + } + ], + "return": "AuthorizationSettings" + }, + "POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}": { + "operationId": "postauthorizationdivisionobject", + "functionName": "postAuthorizationDivisionObject", + "signature": "postAuthorizationDivisionObject(divisionId, objectType, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "objectType", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ] + }, + "POST /api/v2/authorization/divisions/{divisionId}/restore": { + "operationId": "postauthorizationdivisionrestore", + "functionName": "postAuthorizationDivisionRestore", + "signature": "postAuthorizationDivisionRestore(divisionId, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + }, + "POST /api/v2/authorization/divisions": { + "operationId": "postauthorizationdivisions", + "functionName": "postAuthorizationDivisions", + "signature": "postAuthorizationDivisions(body)", + "parameters": [ + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + }, + "POST /api/v2/authorization/roles/{roleId}": { + "operationId": "postauthorizationrole", + "functionName": "postAuthorizationRole", + "signature": "postAuthorizationRole(roleId, body, subjectType)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SubjectDivisions", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}": { + "operationId": "postauthorizationrolecomparedefaultrightroleid", + "functionName": "postAuthorizationRoleComparedefaultRightRoleId", + "signature": "postAuthorizationRoleComparedefaultRightRoleId(leftRoleId, rightRoleId, body)", + "parameters": [ + { + "name": "leftRoleId", + "type": "String", + "required": "true" + }, + { + "name": "rightRoleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainOrganizationRole", + "required": "true" + } + ], + "return": "DomainOrgRoleDifference" + }, + "POST /api/v2/authorization/roles": { + "operationId": "postauthorizationroles", + "functionName": "postAuthorizationRoles", + "signature": "postAuthorizationRoles(body)", + "parameters": [ + { + "name": "body", + "type": "DomainOrganizationRoleCreate", + "required": "true" + } + ], + "return": "DomainOrganizationRole" + }, + "POST /api/v2/authorization/roles/default": { + "operationId": "postauthorizationrolesdefault", + "functionName": "postAuthorizationRolesDefault", + "signature": "postAuthorizationRolesDefault(force)", + "parameters": [ + { + "name": "force", + "type": "Bool", + "required": "false" + } + ], + "return": "OrganizationRoleEntityListing" + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkadd": { + "operationId": "postauthorizationsubjectbulkadd", + "functionName": "postAuthorizationSubjectBulkadd", + "signature": "postAuthorizationSubjectBulkadd(subjectId, body, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkremove": { + "operationId": "postauthorizationsubjectbulkremove", + "functionName": "postAuthorizationSubjectBulkremove", + "signature": "postAuthorizationSubjectBulkremove(subjectId, body)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkreplace": { + "operationId": "postauthorizationsubjectbulkreplace", + "functionName": "postAuthorizationSubjectBulkreplace", + "signature": "postAuthorizationSubjectBulkreplace(subjectId, body, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}": { + "operationId": "postauthorizationsubjectdivisionrole", + "functionName": "postAuthorizationSubjectDivisionRole", + "signature": "postAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "PUT /api/v2/authorization/divisions/{divisionId}": { + "operationId": "putauthorizationdivision", + "functionName": "putAuthorizationDivision", + "signature": "putAuthorizationDivision(divisionId, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + }, + "PUT /api/v2/authorization/roles/{roleId}": { + "operationId": "putauthorizationrole", + "functionName": "putAuthorizationRole", + "signature": "putAuthorizationRole(roleId, body)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainOrganizationRoleUpdate", + "required": "true" + } + ], + "return": "DomainOrganizationRole" + }, + "PUT /api/v2/authorization/roles/{roleId}/users/add": { + "operationId": "putauthorizationroleusersadd", + "functionName": "putAuthorizationRoleUsersAdd", + "signature": "putAuthorizationRoleUsersAdd(roleId, body)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[String]" + }, + "PUT /api/v2/authorization/roles/{roleId}/users/remove": { + "operationId": "putauthorizationroleusersremove", + "functionName": "putAuthorizationRoleUsersRemove", + "signature": "putAuthorizationRoleUsersRemove(roleId, body)", + "parameters": [ + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[String]" + }, + "PUT /api/v2/authorization/roles/default": { + "operationId": "putauthorizationrolesdefault", + "functionName": "putAuthorizationRolesDefault", + "signature": "putAuthorizationRolesDefault(body)", + "parameters": [ + { + "name": "body", + "type": "[DomainOrganizationRole]", + "required": "true" + } + ], + "return": "OrganizationRoleEntityListing" + }, + "PUT /api/v2/users/{subjectId}/roles": { + "operationId": "putuserroles", + "functionName": "putUserRoles", + "signature": "putUserRoles(subjectId, body)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "UserAuthorization" + } + +} \ No newline at end of file diff --git a/build/docs/BillingAPI.json b/build/docs/BillingAPI.json new file mode 100644 index 000000000..4db215848 --- /dev/null +++ b/build/docs/BillingAPI.json @@ -0,0 +1,39 @@ +{ + "GET /api/v2/billing/reports/billableusage": { + "operationId": "getbillingreportsbillableusage", + "functionName": "getBillingReportsBillableusage", + "signature": "getBillingReportsBillableusage(startDate, endDate)", + "parameters": [ + { + "name": "startDate", + "type": "Date", + "required": "true" + }, + { + "name": "endDate", + "type": "Date", + "required": "true" + } + ], + "return": "BillingUsageReport" + }, + "GET /api/v2/billing/trusteebillingoverview/{trustorOrgId}": { + "operationId": "getbillingtrusteebillingoverviewtrustororgid", + "functionName": "getBillingTrusteebillingoverviewTrustorOrgId", + "signature": "getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId, billingPeriodIndex)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "billingPeriodIndex", + "type": "Int", + "required": "false" + } + ], + "return": "TrusteeBillingOverview" + } + +} \ No newline at end of file diff --git a/build/docs/CarrierServicesAPI.json b/build/docs/CarrierServicesAPI.json new file mode 100644 index 000000000..87ee5ef3f --- /dev/null +++ b/build/docs/CarrierServicesAPI.json @@ -0,0 +1,29 @@ +{ + "GET /api/v2/carrierservices/integrations/emergencylocations/me": { + "operationId": "getcarrierservicesintegrationsemergencylocationsme", + "functionName": "getCarrierservicesIntegrationsEmergencylocationsMe", + "signature": "getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber)", + "parameters": [ + { + "name": "phoneNumber", + "type": "String", + "required": "true" + } + ], + "return": "EmergencyLocation" + }, + "POST /api/v2/carrierservices/integrations/emergencylocations/me": { + "operationId": "postcarrierservicesintegrationsemergencylocationsme", + "functionName": "postCarrierservicesIntegrationsEmergencylocationsMe", + "signature": "postCarrierservicesIntegrationsEmergencylocationsMe(body)", + "parameters": [ + { + "name": "body", + "type": "EmergencyLocation", + "required": "false" + } + ], + "return": "EmergencyLocation" + } + +} \ No newline at end of file diff --git a/build/docs/ChatAPI.json b/build/docs/ChatAPI.json new file mode 100644 index 000000000..6c77978ad --- /dev/null +++ b/build/docs/ChatAPI.json @@ -0,0 +1,69 @@ +{ + "GET /api/v2/chat/settings": { + "operationId": "getchatsettings", + "functionName": "getChatSettings", + "signature": "getChatSettings()", + + "return": "ChatSettings" + }, + "GET /api/v2/chats/settings": { + "operationId": "getchatssettings", + "functionName": "getChatsSettings", + "signature": "getChatsSettings()", + + "return": "ChatSettings" + }, + "PATCH /api/v2/chat/settings": { + "operationId": "patchchatsettings", + "functionName": "patchChatSettings", + "signature": "patchChatSettings(body)", + "parameters": [ + { + "name": "body", + "type": "ChatSettings", + "required": "true" + } + ], + "return": "ChatSettings" + }, + "PATCH /api/v2/chats/settings": { + "operationId": "patchchatssettings", + "functionName": "patchChatsSettings", + "signature": "patchChatsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "ChatSettings", + "required": "true" + } + ], + "return": "ChatSettings" + }, + "PUT /api/v2/chat/settings": { + "operationId": "putchatsettings", + "functionName": "putChatSettings", + "signature": "putChatSettings(body)", + "parameters": [ + { + "name": "body", + "type": "ChatSettings", + "required": "true" + } + ], + "return": "ChatSettings" + }, + "PUT /api/v2/chats/settings": { + "operationId": "putchatssettings", + "functionName": "putChatsSettings", + "signature": "putChatsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "ChatSettings", + "required": "true" + } + ], + "return": "ChatSettings" + } + +} \ No newline at end of file diff --git a/build/docs/CoachingAPI.json b/build/docs/CoachingAPI.json new file mode 100644 index 000000000..db0b57902 --- /dev/null +++ b/build/docs/CoachingAPI.json @@ -0,0 +1,424 @@ +{ + "DELETE /api/v2/coaching/appointments/{appointmentId}": { + "operationId": "deletecoachingappointment", + "functionName": "deleteCoachingAppointment", + "signature": "deleteCoachingAppointment(appointmentId)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + } + ], + "return": "CoachingAppointmentReference" + }, + "DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}": { + "operationId": "deletecoachingappointmentannotation", + "functionName": "deleteCoachingAppointmentAnnotation", + "signature": "deleteCoachingAppointmentAnnotation(appointmentId, annotationId)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/coaching/appointments/{appointmentId}": { + "operationId": "getcoachingappointment", + "functionName": "getCoachingAppointment", + "signature": "getCoachingAppointment(appointmentId)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + } + ], + "return": "CoachingAppointmentResponse" + }, + "GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}": { + "operationId": "getcoachingappointmentannotation", + "functionName": "getCoachingAppointmentAnnotation", + "signature": "getCoachingAppointmentAnnotation(appointmentId, annotationId)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + } + ], + "return": "CoachingAnnotation" + }, + "GET /api/v2/coaching/appointments/{appointmentId}/annotations": { + "operationId": "getcoachingappointmentannotations", + "functionName": "getCoachingAppointmentAnnotations", + "signature": "getCoachingAppointmentAnnotations(appointmentId, pageNumber, pageSize)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "CoachingAnnotationList" + }, + "GET /api/v2/coaching/appointments/{appointmentId}/statuses": { + "operationId": "getcoachingappointmentstatuses", + "functionName": "getCoachingAppointmentStatuses", + "signature": "getCoachingAppointmentStatuses(appointmentId, pageNumber, pageSize)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "CoachingAppointmentStatusResponseList" + }, + "GET /api/v2/coaching/appointments": { + "operationId": "getcoachingappointments", + "functionName": "getCoachingAppointments", + "signature": "getCoachingAppointments(userIds, interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue, intervalCondition)", + "parameters": [ + { + "name": "userIds", + "type": "[String]", + "required": "true" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "statuses", + "type": "[String]", + "required": "false" + }, + { + "name": "facilitatorIds", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "relationships", + "type": "[String]", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "intervalCondition", + "type": "String", + "required": "false" + } + ], + "return": "CoachingAppointmentResponseList" + }, + "GET /api/v2/coaching/appointments/me": { + "operationId": "getcoachingappointmentsme", + "functionName": "getCoachingAppointmentsMe", + "signature": "getCoachingAppointmentsMe(interval, pageNumber, pageSize, statuses, facilitatorIds, sortOrder, relationships, completionInterval, overdue, intervalCondition)", + "parameters": [ + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "statuses", + "type": "[String]", + "required": "false" + }, + { + "name": "facilitatorIds", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "relationships", + "type": "[String]", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "intervalCondition", + "type": "String", + "required": "false" + } + ], + "return": "CoachingAppointmentResponseList" + }, + "GET /api/v2/coaching/notifications/{notificationId}": { + "operationId": "getcoachingnotification", + "functionName": "getCoachingNotification", + "signature": "getCoachingNotification(notificationId, expand)", + "parameters": [ + { + "name": "notificationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "CoachingNotification" + }, + "GET /api/v2/coaching/notifications": { + "operationId": "getcoachingnotifications", + "functionName": "getCoachingNotifications", + "signature": "getCoachingNotifications(pageNumber, pageSize, expand)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "CoachingNotificationList" + }, + "PATCH /api/v2/coaching/appointments/{appointmentId}": { + "operationId": "patchcoachingappointment", + "functionName": "patchCoachingAppointment", + "signature": "patchCoachingAppointment(appointmentId, body)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateCoachingAppointmentRequest", + "required": "true" + } + ], + "return": "CoachingAppointmentResponse" + }, + "PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}": { + "operationId": "patchcoachingappointmentannotation", + "functionName": "patchCoachingAppointmentAnnotation", + "signature": "patchCoachingAppointmentAnnotation(appointmentId, annotationId, body)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CoachingAnnotation", + "required": "true" + } + ], + "return": "CoachingAnnotation" + }, + "PATCH /api/v2/coaching/appointments/{appointmentId}/status": { + "operationId": "patchcoachingappointmentstatus", + "functionName": "patchCoachingAppointmentStatus", + "signature": "patchCoachingAppointmentStatus(appointmentId, body)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CoachingAppointmentStatusRequest", + "required": "true" + } + ], + "return": "CoachingAppointmentStatusResponse" + }, + "PATCH /api/v2/coaching/notifications/{notificationId}": { + "operationId": "patchcoachingnotification", + "functionName": "patchCoachingNotification", + "signature": "patchCoachingNotification(notificationId, body)", + "parameters": [ + { + "name": "notificationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CoachingNotification", + "required": "true" + } + ], + "return": "CoachingNotification" + }, + "POST /api/v2/coaching/appointments/{appointmentId}/annotations": { + "operationId": "postcoachingappointmentannotations", + "functionName": "postCoachingAppointmentAnnotations", + "signature": "postCoachingAppointmentAnnotations(appointmentId, body)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CoachingAnnotationCreateRequest", + "required": "true" + } + ], + "return": "CoachingAnnotation" + }, + "POST /api/v2/coaching/appointments/{appointmentId}/conversations": { + "operationId": "postcoachingappointmentconversations", + "functionName": "postCoachingAppointmentConversations", + "signature": "postCoachingAppointmentConversations(appointmentId, body)", + "parameters": [ + { + "name": "appointmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AddConversationRequest", + "required": "true" + } + ], + "return": "AddConversationResponse" + }, + "POST /api/v2/coaching/appointments": { + "operationId": "postcoachingappointments", + "functionName": "postCoachingAppointments", + "signature": "postCoachingAppointments(body)", + "parameters": [ + { + "name": "body", + "type": "CreateCoachingAppointmentRequest", + "required": "true" + } + ], + "return": "CoachingAppointmentResponse" + }, + "POST /api/v2/coaching/appointments/aggregates/query": { + "operationId": "postcoachingappointmentsaggregatesquery", + "functionName": "postCoachingAppointmentsAggregatesQuery", + "signature": "postCoachingAppointmentsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "CoachingAppointmentAggregateRequest", + "required": "true" + } + ], + "return": "CoachingAppointmentAggregateResponse" + }, + "POST /api/v2/coaching/scheduleslots/query": { + "operationId": "postcoachingscheduleslotsquery", + "functionName": "postCoachingScheduleslotsQuery", + "signature": "postCoachingScheduleslotsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "CoachingSlotsRequest", + "required": "true" + } + ], + "return": "CoachingSlotsResponse" + } + +} \ No newline at end of file diff --git a/build/docs/ContentManagementAPI.json b/build/docs/ContentManagementAPI.json new file mode 100644 index 000000000..7e46d0e37 --- /dev/null +++ b/build/docs/ContentManagementAPI.json @@ -0,0 +1,829 @@ +{ + "DELETE /api/v2/contentmanagement/documents/{documentId}": { + "operationId": "deletecontentmanagementdocument", + "functionName": "deleteContentmanagementDocument", + "signature": "deleteContentmanagementDocument(documentId, _override)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "_override", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/contentmanagement/shares/{shareId}": { + "operationId": "deletecontentmanagementshare", + "functionName": "deleteContentmanagementShare", + "signature": "deleteContentmanagementShare(shareId)", + "parameters": [ + { + "name": "shareId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/contentmanagement/status/{statusId}": { + "operationId": "deletecontentmanagementstatusstatusid", + "functionName": "deleteContentmanagementStatusStatusId", + "signature": "deleteContentmanagementStatusStatusId(statusId)", + "parameters": [ + { + "name": "statusId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/contentmanagement/workspaces/{workspaceId}": { + "operationId": "deletecontentmanagementworkspace", + "functionName": "deleteContentmanagementWorkspace", + "signature": "deleteContentmanagementWorkspace(workspaceId, moveChildrenToWorkspaceId)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "moveChildrenToWorkspaceId", + "type": "String", + "required": "false" + } + ] + }, + "DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}": { + "operationId": "deletecontentmanagementworkspacemember", + "functionName": "deleteContentmanagementWorkspaceMember", + "signature": "deleteContentmanagementWorkspaceMember(workspaceId, memberId)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}": { + "operationId": "deletecontentmanagementworkspacetagvalue", + "functionName": "deleteContentmanagementWorkspaceTagvalue", + "signature": "deleteContentmanagementWorkspaceTagvalue(workspaceId, tagId)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "tagId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/contentmanagement/documents/{documentId}": { + "operationId": "getcontentmanagementdocument", + "functionName": "getContentmanagementDocument", + "signature": "getContentmanagementDocument(documentId, expand)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Document" + }, + "GET /api/v2/contentmanagement/documents/{documentId}/audits": { + "operationId": "getcontentmanagementdocumentaudits", + "functionName": "getContentmanagementDocumentAudits", + "signature": "getContentmanagementDocumentAudits(documentId, pageSize, pageNumber, transactionFilter, level, sortBy, sortOrder)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "transactionFilter", + "type": "String", + "required": "false" + }, + { + "name": "level", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DocumentAuditEntityListing" + }, + "GET /api/v2/contentmanagement/documents/{documentId}/content": { + "operationId": "getcontentmanagementdocumentcontent", + "functionName": "getContentmanagementDocumentContent", + "signature": "getContentmanagementDocumentContent(documentId, disposition, contentType)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "disposition", + "type": "String", + "required": "false" + }, + { + "name": "contentType", + "type": "String", + "required": "false" + } + ], + "return": "DownloadResponse" + }, + "GET /api/v2/contentmanagement/documents": { + "operationId": "getcontentmanagementdocuments", + "functionName": "getContentmanagementDocuments", + "signature": "getContentmanagementDocuments(workspaceId, name, expand, pageSize, pageNumber, sortBy, sortOrder)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DocumentEntityListing" + }, + "GET /api/v2/contentmanagement/query": { + "operationId": "getcontentmanagementquery", + "functionName": "getContentmanagementQuery", + "signature": "getContentmanagementQuery(queryPhrase, pageSize, pageNumber, sortBy, sortOrder, expand)", + "parameters": [ + { + "name": "queryPhrase", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "QueryResults" + }, + "GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}": { + "operationId": "getcontentmanagementsecurityprofile", + "functionName": "getContentmanagementSecurityprofile", + "signature": "getContentmanagementSecurityprofile(securityProfileId)", + "parameters": [ + { + "name": "securityProfileId", + "type": "String", + "required": "true" + } + ], + "return": "SecurityProfile" + }, + "GET /api/v2/contentmanagement/securityprofiles": { + "operationId": "getcontentmanagementsecurityprofiles", + "functionName": "getContentmanagementSecurityprofiles", + "signature": "getContentmanagementSecurityprofiles()", + + "return": "SecurityProfileEntityListing" + }, + "GET /api/v2/contentmanagement/shares/{shareId}": { + "operationId": "getcontentmanagementshare", + "functionName": "getContentmanagementShare", + "signature": "getContentmanagementShare(shareId, expand)", + "parameters": [ + { + "name": "shareId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Share" + }, + "GET /api/v2/contentmanagement/shared/{sharedId}": { + "operationId": "getcontentmanagementsharedsharedid", + "functionName": "getContentmanagementSharedSharedId", + "signature": "getContentmanagementSharedSharedId(sharedId, redirect, disposition, contentType, expand)", + "parameters": [ + { + "name": "sharedId", + "type": "String", + "required": "true" + }, + { + "name": "redirect", + "type": "Bool", + "required": "false" + }, + { + "name": "disposition", + "type": "String", + "required": "false" + }, + { + "name": "contentType", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "SharedResponse" + }, + "GET /api/v2/contentmanagement/shares": { + "operationId": "getcontentmanagementshares", + "functionName": "getContentmanagementShares", + "signature": "getContentmanagementShares(entityId, expand, pageSize, pageNumber)", + "parameters": [ + { + "name": "entityId", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "ShareEntityListing" + }, + "GET /api/v2/contentmanagement/status": { + "operationId": "getcontentmanagementstatus", + "functionName": "getContentmanagementStatus", + "signature": "getContentmanagementStatus(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "CommandStatusEntityListing" + }, + "GET /api/v2/contentmanagement/status/{statusId}": { + "operationId": "getcontentmanagementstatusstatusid", + "functionName": "getContentmanagementStatusStatusId", + "signature": "getContentmanagementStatusStatusId(statusId)", + "parameters": [ + { + "name": "statusId", + "type": "String", + "required": "true" + } + ], + "return": "CommandStatus" + }, + "GET /api/v2/contentmanagement/usage": { + "operationId": "getcontentmanagementusage", + "functionName": "getContentmanagementUsage", + "signature": "getContentmanagementUsage()", + + "return": "Usage" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}": { + "operationId": "getcontentmanagementworkspace", + "functionName": "getContentmanagementWorkspace", + "signature": "getContentmanagementWorkspace(workspaceId, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Workspace" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents": { + "operationId": "getcontentmanagementworkspacedocuments", + "functionName": "getContentmanagementWorkspaceDocuments", + "signature": "getContentmanagementWorkspaceDocuments(workspaceId, expand, pageSize, pageNumber, sortBy, sortOrder)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DocumentEntityListing" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}": { + "operationId": "getcontentmanagementworkspacemember", + "functionName": "getContentmanagementWorkspaceMember", + "signature": "getContentmanagementWorkspaceMember(workspaceId, memberId, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkspaceMember" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}/members": { + "operationId": "getcontentmanagementworkspacemembers", + "functionName": "getContentmanagementWorkspaceMembers", + "signature": "getContentmanagementWorkspaceMembers(workspaceId, pageSize, pageNumber, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkspaceMemberEntityListing" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}": { + "operationId": "getcontentmanagementworkspacetagvalue", + "functionName": "getContentmanagementWorkspaceTagvalue", + "signature": "getContentmanagementWorkspaceTagvalue(workspaceId, tagId, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "tagId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "TagValue" + }, + "GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues": { + "operationId": "getcontentmanagementworkspacetagvalues", + "functionName": "getContentmanagementWorkspaceTagvalues", + "signature": "getContentmanagementWorkspaceTagvalues(workspaceId, value, pageSize, pageNumber, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "value", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "TagValueEntityListing" + }, + "GET /api/v2/contentmanagement/workspaces": { + "operationId": "getcontentmanagementworkspaces", + "functionName": "getContentmanagementWorkspaces", + "signature": "getContentmanagementWorkspaces(pageSize, pageNumber, access, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "access", + "type": "[String]", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkspaceEntityListing" + }, + "POST /api/v2/contentmanagement/auditquery": { + "operationId": "postcontentmanagementauditquery", + "functionName": "postContentmanagementAuditquery", + "signature": "postContentmanagementAuditquery(body)", + "parameters": [ + { + "name": "body", + "type": "ContentQueryRequest", + "required": "true" + } + ], + "return": "QueryResults" + }, + "POST /api/v2/contentmanagement/documents/{documentId}": { + "operationId": "postcontentmanagementdocument", + "functionName": "postContentmanagementDocument", + "signature": "postContentmanagementDocument(documentId, body, expand, _override)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DocumentUpdate", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "_override", + "type": "Bool", + "required": "false" + } + ], + "return": "Document" + }, + "POST /api/v2/contentmanagement/documents/{documentId}/content": { + "operationId": "postcontentmanagementdocumentcontent", + "functionName": "postContentmanagementDocumentContent", + "signature": "postContentmanagementDocumentContent(documentId, body, _override)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ReplaceRequest", + "required": "true" + }, + { + "name": "_override", + "type": "Bool", + "required": "false" + } + ], + "return": "ReplaceResponse" + }, + "POST /api/v2/contentmanagement/documents": { + "operationId": "postcontentmanagementdocuments", + "functionName": "postContentmanagementDocuments", + "signature": "postContentmanagementDocuments(body, copySource, moveSource, _override)", + "parameters": [ + { + "name": "body", + "type": "DocumentUpload", + "required": "true" + }, + { + "name": "copySource", + "type": "String", + "required": "false" + }, + { + "name": "moveSource", + "type": "String", + "required": "false" + }, + { + "name": "_override", + "type": "Bool", + "required": "false" + } + ], + "return": "Document" + }, + "POST /api/v2/contentmanagement/query": { + "operationId": "postcontentmanagementquery", + "functionName": "postContentmanagementQuery", + "signature": "postContentmanagementQuery(body, expand)", + "parameters": [ + { + "name": "body", + "type": "QueryRequest", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "QueryResults" + }, + "POST /api/v2/contentmanagement/shares": { + "operationId": "postcontentmanagementshares", + "functionName": "postContentmanagementShares", + "signature": "postContentmanagementShares(body)", + "parameters": [ + { + "name": "body", + "type": "CreateShareRequest", + "required": "true" + } + ], + "return": "CreateShareResponse" + }, + "POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues": { + "operationId": "postcontentmanagementworkspacetagvalues", + "functionName": "postContentmanagementWorkspaceTagvalues", + "signature": "postContentmanagementWorkspaceTagvalues(workspaceId, body)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TagValue", + "required": "true" + } + ], + "return": "TagValue" + }, + "POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query": { + "operationId": "postcontentmanagementworkspacetagvaluesquery", + "functionName": "postContentmanagementWorkspaceTagvaluesQuery", + "signature": "postContentmanagementWorkspaceTagvaluesQuery(workspaceId, body, expand)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TagQueryRequest", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "TagValueEntityListing" + }, + "POST /api/v2/contentmanagement/workspaces": { + "operationId": "postcontentmanagementworkspaces", + "functionName": "postContentmanagementWorkspaces", + "signature": "postContentmanagementWorkspaces(body)", + "parameters": [ + { + "name": "body", + "type": "WorkspaceCreate", + "required": "true" + } + ], + "return": "Workspace" + }, + "PUT /api/v2/contentmanagement/workspaces/{workspaceId}": { + "operationId": "putcontentmanagementworkspace", + "functionName": "putContentmanagementWorkspace", + "signature": "putContentmanagementWorkspace(workspaceId, body)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Workspace", + "required": "true" + } + ], + "return": "Workspace" + }, + "PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}": { + "operationId": "putcontentmanagementworkspacemember", + "functionName": "putContentmanagementWorkspaceMember", + "signature": "putContentmanagementWorkspaceMember(workspaceId, memberId, body)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WorkspaceMember", + "required": "true" + } + ], + "return": "WorkspaceMember" + }, + "PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}": { + "operationId": "putcontentmanagementworkspacetagvalue", + "functionName": "putContentmanagementWorkspaceTagvalue", + "signature": "putContentmanagementWorkspaceTagvalue(workspaceId, tagId, body)", + "parameters": [ + { + "name": "workspaceId", + "type": "String", + "required": "true" + }, + { + "name": "tagId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TagValue", + "required": "true" + } + ], + "return": "TagValue" + } + +} \ No newline at end of file diff --git a/build/docs/ConversationsAPI.json b/build/docs/ConversationsAPI.json new file mode 100644 index 000000000..8a42f47ac --- /dev/null +++ b/build/docs/ConversationsAPI.json @@ -0,0 +1,4090 @@ +{ + "DELETE /api/v2/analytics/conversations/details/jobs/{jobId}": { + "operationId": "deleteanalyticsconversationsdetailsjob", + "functionName": "deleteAnalyticsConversationsDetailsJob", + "signature": "deleteAnalyticsConversationsDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}": { + "operationId": "deleteconversationparticipantcode", + "functionName": "deleteConversationParticipantCode", + "signature": "deleteConversationParticipantCode(conversationId, participantId, addCommunicationCode)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "addCommunicationCode", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason": { + "operationId": "deleteconversationparticipantflaggedreason", + "functionName": "deleteConversationParticipantFlaggedreason", + "signature": "deleteConversationParticipantFlaggedreason(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult": { + "operationId": "deleteconversationscallparticipantconsult", + "functionName": "deleteConversationsCallParticipantConsult", + "signature": "deleteConversationsCallParticipantConsult(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}": { + "operationId": "deleteconversationsemailmessagesdraftattachment", + "functionName": "deleteConversationsEmailMessagesDraftAttachment", + "signature": "deleteConversationsEmailMessagesDraftAttachment(conversationId, attachmentId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "attachmentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}": { + "operationId": "deleteconversationsmessagescachedmediacachedmediaitemid", + "functionName": "deleteConversationsMessagesCachedmediaCachedMediaItemId", + "signature": "deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId)", + "parameters": [ + { + "name": "cachedMediaItemId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationsfacebookintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsFacebookIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/instagram/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationsinstagramintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsInstagramIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationslineintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsLineIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/open/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationsopenintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsOpenIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationstwitterintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsTwitterIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}": { + "operationId": "deleteconversationsmessagingintegrationswhatsappintegrationid", + "functionName": "deleteConversationsMessagingIntegrationsWhatsappIntegrationId", + "signature": "deleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ], + "return": "WhatsAppIntegration" + }, + "DELETE /api/v2/conversations/messaging/settings/{messageSettingId}": { + "operationId": "deleteconversationsmessagingsetting", + "functionName": "deleteConversationsMessagingSetting", + "signature": "deleteConversationsMessagingSetting(messageSettingId)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/conversations/messaging/settings/default": { + "operationId": "deleteconversationsmessagingsettingsdefault", + "functionName": "deleteConversationsMessagingSettingsDefault", + "signature": "deleteConversationsMessagingSettingsDefault()" + + }, + "DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId}": { + "operationId": "deleteconversationsmessagingsupportedcontentsupportedcontentid", + "functionName": "deleteConversationsMessagingSupportedcontentSupportedContentId", + "signature": "deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/analytics/conversations/{conversationId}/details": { + "operationId": "getanalyticsconversationdetails", + "functionName": "getAnalyticsConversationDetails", + "signature": "getAnalyticsConversationDetails(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "AnalyticsConversationWithoutAttributes" + }, + "GET /api/v2/analytics/conversations/details": { + "operationId": "getanalyticsconversationsdetails", + "functionName": "getAnalyticsConversationsDetails", + "signature": "getAnalyticsConversationsDetails(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "AnalyticsConversationWithoutAttributesMultiGetResponse" + }, + "GET /api/v2/analytics/conversations/details/jobs/{jobId}": { + "operationId": "getanalyticsconversationsdetailsjob", + "functionName": "getAnalyticsConversationsDetailsJob", + "signature": "getAnalyticsConversationsDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AsyncQueryStatus" + }, + "GET /api/v2/analytics/conversations/details/jobs/{jobId}/results": { + "operationId": "getanalyticsconversationsdetailsjobresults", + "functionName": "getAnalyticsConversationsDetailsJobResults", + "signature": "getAnalyticsConversationsDetailsJobResults(jobId, cursor, pageSize)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "AnalyticsConversationAsyncQueryResponse" + }, + "GET /api/v2/analytics/conversations/details/jobs/availability": { + "operationId": "getanalyticsconversationsdetailsjobsavailability", + "functionName": "getAnalyticsConversationsDetailsJobsAvailability", + "signature": "getAnalyticsConversationsDetailsJobsAvailability()", + + "return": "DataAvailabilityResponse" + }, + "GET /api/v2/conversations/{conversationId}": { + "operationId": "getconversation", + "functionName": "getConversation", + "signature": "getConversation(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "Conversation" + }, + "GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}": { + "operationId": "getconversationparticipantsecureivrsession", + "functionName": "getConversationParticipantSecureivrsession", + "signature": "getConversationParticipantSecureivrsession(conversationId, participantId, secureSessionId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "secureSessionId", + "type": "String", + "required": "true" + } + ], + "return": "SecureSession" + }, + "GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions": { + "operationId": "getconversationparticipantsecureivrsessions", + "functionName": "getConversationParticipantSecureivrsessions", + "signature": "getConversationParticipantSecureivrsessions(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "SecureSessionEntityListing" + }, + "GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationparticipantwrapup", + "functionName": "getConversationParticipantWrapup", + "signature": "getConversationParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationparticipantwrapupcodes", + "functionName": "getConversationParticipantWrapupcodes", + "signature": "getConversationParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/{conversationId}/secureattributes": { + "operationId": "getconversationsecureattributes", + "functionName": "getConversationSecureattributes", + "signature": "getConversationSecureattributes(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "ConversationSecureAttributes" + }, + "GET /api/v2/conversations": { + "operationId": "getconversations", + "functionName": "getConversations", + "signature": "getConversations(communicationType)", + "parameters": [ + { + "name": "communicationType", + "type": "String", + "required": "false" + } + ], + "return": "ConversationEntityListing" + }, + "GET /api/v2/conversations/calls/{conversationId}": { + "operationId": "getconversationscall", + "functionName": "getConversationsCall", + "signature": "getConversationsCall(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "CallConversation" + }, + "GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationscallparticipantcommunicationwrapup", + "functionName": "getConversationsCallParticipantCommunicationWrapup", + "signature": "getConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationscallparticipantwrapup", + "functionName": "getConversationsCallParticipantWrapup", + "signature": "getConversationsCallParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationscallparticipantwrapupcodes", + "functionName": "getConversationsCallParticipantWrapupcodes", + "signature": "getConversationsCallParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/callbacks/{conversationId}": { + "operationId": "getconversationscallback", + "functionName": "getConversationsCallback", + "signature": "getConversationsCallback(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "CallbackConversation" + }, + "GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationscallbackparticipantcommunicationwrapup", + "functionName": "getConversationsCallbackParticipantCommunicationWrapup", + "signature": "getConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationscallbackparticipantwrapup", + "functionName": "getConversationsCallbackParticipantWrapup", + "signature": "getConversationsCallbackParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationscallbackparticipantwrapupcodes", + "functionName": "getConversationsCallbackParticipantWrapupcodes", + "signature": "getConversationsCallbackParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/callbacks": { + "operationId": "getconversationscallbacks", + "functionName": "getConversationsCallbacks", + "signature": "getConversationsCallbacks()", + + "return": "CallbackConversationEntityListing" + }, + "GET /api/v2/conversations/calls": { + "operationId": "getconversationscalls", + "functionName": "getConversationsCalls", + "signature": "getConversationsCalls()", + + "return": "CallConversationEntityListing" + }, + "GET /api/v2/conversations/calls/history": { + "operationId": "getconversationscallshistory", + "functionName": "getConversationsCallsHistory", + "signature": "getConversationsCallsHistory(pageSize, pageNumber, interval, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "CallHistoryConversationEntityListing" + }, + "GET /api/v2/conversations/calls/maximumconferenceparties": { + "operationId": "getconversationscallsmaximumconferenceparties", + "functionName": "getConversationsCallsMaximumconferenceparties", + "signature": "getConversationsCallsMaximumconferenceparties()", + + "return": "MaxParticipants" + }, + "GET /api/v2/conversations/chats/{conversationId}": { + "operationId": "getconversationschat", + "functionName": "getConversationsChat", + "signature": "getConversationsChat(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "ChatConversation" + }, + "GET /api/v2/conversations/chats/{conversationId}/messages/{messageId}": { + "operationId": "getconversationschatmessage", + "functionName": "getConversationsChatMessage", + "signature": "getConversationsChatMessage(conversationId, messageId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "messageId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatMessage" + }, + "GET /api/v2/conversations/chats/{conversationId}/messages": { + "operationId": "getconversationschatmessages", + "functionName": "getConversationsChatMessages", + "signature": "getConversationsChatMessages(conversationId, after, before, sortOrder, maxResults)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "maxResults", + "type": "Int", + "required": "false" + } + ], + "return": "WebChatMessageEntityList" + }, + "GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationschatparticipantcommunicationwrapup", + "functionName": "getConversationsChatParticipantCommunicationWrapup", + "signature": "getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationschatparticipantwrapup", + "functionName": "getConversationsChatParticipantWrapup", + "signature": "getConversationsChatParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationschatparticipantwrapupcodes", + "functionName": "getConversationsChatParticipantWrapupcodes", + "signature": "getConversationsChatParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/chats": { + "operationId": "getconversationschats", + "functionName": "getConversationsChats", + "signature": "getConversationsChats()", + + "return": "ChatConversationEntityListing" + }, + "GET /api/v2/conversations/cobrowsesessions/{conversationId}": { + "operationId": "getconversationscobrowsesession", + "functionName": "getConversationsCobrowsesession", + "signature": "getConversationsCobrowsesession(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "CobrowseConversation" + }, + "GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationscobrowsesessionparticipantcommunicationwrapup", + "functionName": "getConversationsCobrowsesessionParticipantCommunicationWrapup", + "signature": "getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationscobrowsesessionparticipantwrapup", + "functionName": "getConversationsCobrowsesessionParticipantWrapup", + "signature": "getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationscobrowsesessionparticipantwrapupcodes", + "functionName": "getConversationsCobrowsesessionParticipantWrapupcodes", + "signature": "getConversationsCobrowsesessionParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/cobrowsesessions": { + "operationId": "getconversationscobrowsesessions", + "functionName": "getConversationsCobrowsesessions", + "signature": "getConversationsCobrowsesessions()", + + "return": "CobrowseConversationEntityListing" + }, + "GET /api/v2/conversations/emails/{conversationId}": { + "operationId": "getconversationsemail", + "functionName": "getConversationsEmail", + "signature": "getConversationsEmail(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "EmailConversation" + }, + "GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}": { + "operationId": "getconversationsemailmessage", + "functionName": "getConversationsEmailMessage", + "signature": "getConversationsEmailMessage(conversationId, messageId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "messageId", + "type": "String", + "required": "true" + } + ], + "return": "EmailMessage" + }, + "GET /api/v2/conversations/emails/{conversationId}/messages": { + "operationId": "getconversationsemailmessages", + "functionName": "getConversationsEmailMessages", + "signature": "getConversationsEmailMessages(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "EmailMessagePreviewListing" + }, + "GET /api/v2/conversations/emails/{conversationId}/messages/draft": { + "operationId": "getconversationsemailmessagesdraft", + "functionName": "getConversationsEmailMessagesDraft", + "signature": "getConversationsEmailMessagesDraft(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "EmailMessage" + }, + "GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationsemailparticipantcommunicationwrapup", + "functionName": "getConversationsEmailParticipantCommunicationWrapup", + "signature": "getConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationsemailparticipantwrapup", + "functionName": "getConversationsEmailParticipantWrapup", + "signature": "getConversationsEmailParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationsemailparticipantwrapupcodes", + "functionName": "getConversationsEmailParticipantWrapupcodes", + "signature": "getConversationsEmailParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/emails/{conversationId}/settings": { + "operationId": "getconversationsemailsettings", + "functionName": "getConversationsEmailSettings", + "signature": "getConversationsEmailSettings(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "EmailsSettings" + }, + "GET /api/v2/conversations/emails": { + "operationId": "getconversationsemails", + "functionName": "getConversationsEmails", + "signature": "getConversationsEmails()", + + "return": "EmailConversationEntityListing" + }, + "GET /api/v2/conversations/keyconfigurations/{keyconfigurationsId}": { + "operationId": "getconversationskeyconfiguration", + "functionName": "getConversationsKeyconfiguration", + "signature": "getConversationsKeyconfiguration(keyconfigurationsId)", + "parameters": [ + { + "name": "keyconfigurationsId", + "type": "String", + "required": "true" + } + ], + "return": "ConversationEncryptionConfiguration" + }, + "GET /api/v2/conversations/keyconfigurations": { + "operationId": "getconversationskeyconfigurations", + "functionName": "getConversationsKeyconfigurations", + "signature": "getConversationsKeyconfigurations()", + + "return": "ConversationEncryptionConfigurationListing" + }, + "GET /api/v2/conversations/messages/{conversationId}": { + "operationId": "getconversationsmessage", + "functionName": "getConversationsMessage", + "signature": "getConversationsMessage(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "MessageConversation" + }, + "GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}": { + "operationId": "getconversationsmessagecommunicationmessagesmediamediaid", + "functionName": "getConversationsMessageCommunicationMessagesMediaMediaId", + "signature": "getConversationsMessageCommunicationMessagesMediaMediaId(conversationId, communicationId, mediaId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "mediaId", + "type": "String", + "required": "true" + } + ], + "return": "MessageMediaData" + }, + "GET /api/v2/conversations/messages/{messageId}/details": { + "operationId": "getconversationsmessagedetails", + "functionName": "getConversationsMessageDetails", + "signature": "getConversationsMessageDetails(messageId, useNormalizedMessage)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "useNormalizedMessage", + "type": "Bool", + "required": "false" + } + ], + "return": "MessageData" + }, + "GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}": { + "operationId": "getconversationsmessagemessage", + "functionName": "getConversationsMessageMessage", + "signature": "getConversationsMessageMessage(conversationId, messageId, useNormalizedMessage)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "useNormalizedMessage", + "type": "Bool", + "required": "false" + } + ], + "return": "MessageData" + }, + "GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationsmessageparticipantcommunicationwrapup", + "functionName": "getConversationsMessageParticipantCommunicationWrapup", + "signature": "getConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup": { + "operationId": "getconversationsmessageparticipantwrapup", + "functionName": "getConversationsMessageParticipantWrapup", + "signature": "getConversationsMessageParticipantWrapup(conversationId, participantId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes": { + "operationId": "getconversationsmessageparticipantwrapupcodes", + "functionName": "getConversationsMessageParticipantWrapupcodes", + "signature": "getConversationsMessageParticipantWrapupcodes(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "GET /api/v2/conversations/messages": { + "operationId": "getconversationsmessages", + "functionName": "getConversationsMessages", + "signature": "getConversationsMessages()", + + "return": "MessageConversationEntityListing" + }, + "GET /api/v2/conversations/messages/cachedmedia": { + "operationId": "getconversationsmessagescachedmedia", + "functionName": "getConversationsMessagesCachedmedia", + "signature": "getConversationsMessagesCachedmedia(pageSize, pageNumber, url)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "url", + "type": "String", + "required": "false" + } + ], + "return": "CachedMediaItemEntityListing" + }, + "GET /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}": { + "operationId": "getconversationsmessagescachedmediacachedmediaitemid", + "functionName": "getConversationsMessagesCachedmediaCachedMediaItemId", + "signature": "getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId)", + "parameters": [ + { + "name": "cachedMediaItemId", + "type": "String", + "required": "true" + } + ], + "return": "CachedMediaItem" + }, + "GET /api/v2/conversations/messaging/facebook/app": { + "operationId": "getconversationsmessagingfacebookapp", + "functionName": "getConversationsMessagingFacebookApp", + "signature": "getConversationsMessagingFacebookApp()", + + "return": "FacebookAppCredentials" + }, + "GET /api/v2/conversations/messaging/integrations": { + "operationId": "getconversationsmessagingintegrations", + "functionName": "getConversationsMessagingIntegrations", + "signature": "getConversationsMessagingIntegrations(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "MessagingIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/facebook": { + "operationId": "getconversationsmessagingintegrationsfacebook", + "functionName": "getConversationsMessagingIntegrationsFacebook", + "signature": "getConversationsMessagingIntegrationsFacebook(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "FacebookIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}": { + "operationId": "getconversationsmessagingintegrationsfacebookintegrationid", + "functionName": "getConversationsMessagingIntegrationsFacebookIntegrationId", + "signature": "getConversationsMessagingIntegrationsFacebookIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "FacebookIntegration" + }, + "GET /api/v2/conversations/messaging/integrations/instagram": { + "operationId": "getconversationsmessagingintegrationsinstagram", + "functionName": "getConversationsMessagingIntegrationsInstagram", + "signature": "getConversationsMessagingIntegrationsInstagram(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "InstagramIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/instagram/{integrationId}": { + "operationId": "getconversationsmessagingintegrationsinstagramintegrationid", + "functionName": "getConversationsMessagingIntegrationsInstagramIntegrationId", + "signature": "getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "InstagramIntegration" + }, + "GET /api/v2/conversations/messaging/integrations/line": { + "operationId": "getconversationsmessagingintegrationsline", + "functionName": "getConversationsMessagingIntegrationsLine", + "signature": "getConversationsMessagingIntegrationsLine(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "LineIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/line/{integrationId}": { + "operationId": "getconversationsmessagingintegrationslineintegrationid", + "functionName": "getConversationsMessagingIntegrationsLineIntegrationId", + "signature": "getConversationsMessagingIntegrationsLineIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "LineIntegration" + }, + "GET /api/v2/conversations/messaging/integrations/open": { + "operationId": "getconversationsmessagingintegrationsopen", + "functionName": "getConversationsMessagingIntegrationsOpen", + "signature": "getConversationsMessagingIntegrationsOpen(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "OpenIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/open/{integrationId}": { + "operationId": "getconversationsmessagingintegrationsopenintegrationid", + "functionName": "getConversationsMessagingIntegrationsOpenIntegrationId", + "signature": "getConversationsMessagingIntegrationsOpenIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "OpenIntegration" + }, + "GET /api/v2/conversations/messaging/integrations/twitter": { + "operationId": "getconversationsmessagingintegrationstwitter", + "functionName": "getConversationsMessagingIntegrationsTwitter", + "signature": "getConversationsMessagingIntegrationsTwitter(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "TwitterIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}": { + "operationId": "getconversationsmessagingintegrationstwitterintegrationid", + "functionName": "getConversationsMessagingIntegrationsTwitterIntegrationId", + "signature": "getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "TwitterIntegration" + }, + "GET /api/v2/conversations/messaging/integrations/whatsapp": { + "operationId": "getconversationsmessagingintegrationswhatsapp", + "functionName": "getConversationsMessagingIntegrationsWhatsapp", + "signature": "getConversationsMessagingIntegrationsWhatsapp(pageSize, pageNumber, expand, supportedContentId, messagingSettingId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "supportedContentId", + "type": "String", + "required": "false" + }, + { + "name": "messagingSettingId", + "type": "String", + "required": "false" + } + ], + "return": "WhatsAppIntegrationEntityListing" + }, + "GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}": { + "operationId": "getconversationsmessagingintegrationswhatsappintegrationid", + "functionName": "getConversationsMessagingIntegrationsWhatsappIntegrationId", + "signature": "getConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId, expand)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "WhatsAppIntegration" + }, + "GET /api/v2/conversations/messaging/settings/{messageSettingId}": { + "operationId": "getconversationsmessagingsetting", + "functionName": "getConversationsMessagingSetting", + "signature": "getConversationsMessagingSetting(messageSettingId)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "GET /api/v2/conversations/messaging/settings": { + "operationId": "getconversationsmessagingsettings", + "functionName": "getConversationsMessagingSettings", + "signature": "getConversationsMessagingSettings(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "MessagingConfigListing" + }, + "GET /api/v2/conversations/messaging/settings/default": { + "operationId": "getconversationsmessagingsettingsdefault", + "functionName": "getConversationsMessagingSettingsDefault", + "signature": "getConversationsMessagingSettingsDefault()", + + "return": "MessagingSetting" + }, + "GET /api/v2/conversations/messaging/stickers/{messengerType}": { + "operationId": "getconversationsmessagingsticker", + "functionName": "getConversationsMessagingSticker", + "signature": "getConversationsMessagingSticker(messengerType, pageSize, pageNumber)", + "parameters": [ + { + "name": "messengerType", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "MessagingStickerEntityListing" + }, + "GET /api/v2/conversations/messaging/supportedcontent": { + "operationId": "getconversationsmessagingsupportedcontent", + "functionName": "getConversationsMessagingSupportedcontent", + "signature": "getConversationsMessagingSupportedcontent(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "SupportedContentListing" + }, + "GET /api/v2/conversations/messaging/supportedcontent/default": { + "operationId": "getconversationsmessagingsupportedcontentdefault", + "functionName": "getConversationsMessagingSupportedcontentDefault", + "signature": "getConversationsMessagingSupportedcontentDefault()", + + "return": "SupportedContent" + }, + "GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId}": { + "operationId": "getconversationsmessagingsupportedcontentsupportedcontentid", + "functionName": "getConversationsMessagingSupportedcontentSupportedContentId", + "signature": "getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "GET /api/v2/conversations/messaging/threadingtimeline": { + "operationId": "getconversationsmessagingthreadingtimeline", + "functionName": "getConversationsMessagingThreadingtimeline", + "signature": "getConversationsMessagingThreadingtimeline()", + + "return": "ConversationThreadingWindow" + }, + "GET /api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationsscreenshareparticipantcommunicationwrapup", + "functionName": "getConversationsScreenshareParticipantCommunicationWrapup", + "signature": "getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/settings": { + "operationId": "getconversationssettings", + "functionName": "getConversationsSettings", + "signature": "getConversationsSettings()", + + "return": "Settings" + }, + "GET /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationssocialparticipantcommunicationwrapup", + "functionName": "getConversationsSocialParticipantCommunicationWrapup", + "signature": "getConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "GET /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "getconversationsvideoparticipantcommunicationwrapup", + "functionName": "getConversationsVideoParticipantCommunicationWrapup", + "signature": "getConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, provisional)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "provisional", + "type": "Bool", + "required": "false" + } + ], + "return": "AssignedWrapupCode" + }, + "PATCH /api/v2/conversations/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationparticipant", + "functionName": "patchConversationParticipant", + "signature": "patchConversationParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationparticipantattributes", + "functionName": "patchConversationParticipantAttributes", + "signature": "patchConversationParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/{conversationId}/secureattributes": { + "operationId": "patchconversationsecureattributes", + "functionName": "patchConversationSecureattributes", + "signature": "patchConversationSecureattributes(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationSecureAttributes", + "required": "true" + } + ], + "return": "String" + }, + "PATCH /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationsaftercallworkconversationidparticipantcommunication", + "functionName": "patchConversationsAftercallworkConversationIdParticipantCommunication", + "signature": "patchConversationsAftercallworkConversationIdParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AfterCallWorkUpdate", + "required": "true" + } + ], + "return": "AfterCallWorkUpdate" + }, + "PATCH /api/v2/conversations/calls/{conversationId}": { + "operationId": "patchconversationscall", + "functionName": "patchConversationsCall", + "signature": "patchConversationsCall(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationscallparticipant", + "functionName": "patchConversationsCallParticipant", + "signature": "patchConversationsCallParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationscallparticipantattributes", + "functionName": "patchConversationsCallParticipantAttributes", + "signature": "patchConversationsCallParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "true" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationscallparticipantcommunication", + "functionName": "patchConversationsCallParticipantCommunication", + "signature": "patchConversationsCallParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult": { + "operationId": "patchconversationscallparticipantconsult", + "functionName": "patchConversationsCallParticipantConsult", + "signature": "patchConversationsCallParticipantConsult(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConsultTransferUpdate", + "required": "true" + } + ], + "return": "ConsultTransferResponse" + }, + "PATCH /api/v2/conversations/callbacks/{conversationId}": { + "operationId": "patchconversationscallback", + "functionName": "patchConversationsCallback", + "signature": "patchConversationsCallback(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationscallbackparticipant", + "functionName": "patchConversationsCallbackParticipant", + "signature": "patchConversationsCallbackParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationscallbackparticipantattributes", + "functionName": "patchConversationsCallbackParticipantAttributes", + "signature": "patchConversationsCallbackParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "true" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationscallbackparticipantcommunication", + "functionName": "patchConversationsCallbackParticipantCommunication", + "signature": "patchConversationsCallbackParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/callbacks": { + "operationId": "patchconversationscallbacks", + "functionName": "patchConversationsCallbacks", + "signature": "patchConversationsCallbacks(body)", + "parameters": [ + { + "name": "body", + "type": "PatchCallbackRequest", + "required": "true" + } + ], + "return": "PatchCallbackResponse" + }, + "PATCH /api/v2/conversations/chats/{conversationId}": { + "operationId": "patchconversationschat", + "functionName": "patchConversationsChat", + "signature": "patchConversationsChat(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationschatparticipant", + "functionName": "patchConversationsChatParticipant", + "signature": "patchConversationsChatParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationschatparticipantattributes", + "functionName": "patchConversationsChatParticipantAttributes", + "signature": "patchConversationsChatParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "true" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationschatparticipantcommunication", + "functionName": "patchConversationsChatParticipantCommunication", + "signature": "patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/cobrowsesessions/{conversationId}": { + "operationId": "patchconversationscobrowsesession", + "functionName": "patchConversationsCobrowsesession", + "signature": "patchConversationsCobrowsesession(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationscobrowsesessionparticipant", + "functionName": "patchConversationsCobrowsesessionParticipant", + "signature": "patchConversationsCobrowsesessionParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "false" + } + ] + }, + "PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationscobrowsesessionparticipantattributes", + "functionName": "patchConversationsCobrowsesessionParticipantAttributes", + "signature": "patchConversationsCobrowsesessionParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "false" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationscobrowsesessionparticipantcommunication", + "functionName": "patchConversationsCobrowsesessionParticipantCommunication", + "signature": "patchConversationsCobrowsesessionParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/emails/{conversationId}": { + "operationId": "patchconversationsemail", + "functionName": "patchConversationsEmail", + "signature": "patchConversationsEmail(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/emails/{conversationId}/messages/draft": { + "operationId": "patchconversationsemailmessagesdraft", + "functionName": "patchConversationsEmailMessagesDraft", + "signature": "patchConversationsEmailMessagesDraft(conversationId, autoFill, discard, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "autoFill", + "type": "Bool", + "required": "false" + }, + { + "name": "discard", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "DraftManipulationRequest", + "required": "false" + } + ], + "return": "EmailMessage" + }, + "PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationsemailparticipant", + "functionName": "patchConversationsEmailParticipant", + "signature": "patchConversationsEmailParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationsemailparticipantattributes", + "functionName": "patchConversationsEmailParticipantAttributes", + "signature": "patchConversationsEmailParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "true" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationsemailparticipantcommunication", + "functionName": "patchConversationsEmailParticipantCommunication", + "signature": "patchConversationsEmailParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/messages/{conversationId}": { + "operationId": "patchconversationsmessage", + "functionName": "patchConversationsMessage", + "signature": "patchConversationsMessage(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}": { + "operationId": "patchconversationsmessageparticipant", + "functionName": "patchConversationsMessageParticipant", + "signature": "patchConversationsMessageParticipant(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "false" + } + ] + }, + "PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes": { + "operationId": "patchconversationsmessageparticipantattributes", + "functionName": "patchConversationsMessageParticipantAttributes", + "signature": "patchConversationsMessageParticipantAttributes(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ParticipantAttributes", + "required": "false" + } + ], + "return": "ParticipantAttributes" + }, + "PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}": { + "operationId": "patchconversationsmessageparticipantcommunication", + "functionName": "patchConversationsMessageParticipantCommunication", + "signature": "patchConversationsMessageParticipantCommunication(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MediaParticipantRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId}": { + "operationId": "patchconversationsmessagingintegrationsfacebookintegrationid", + "functionName": "patchConversationsMessagingIntegrationsFacebookIntegrationId", + "signature": "patchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "FacebookIntegrationUpdateRequest", + "required": "true" + } + ], + "return": "FacebookIntegration" + }, + "PATCH /api/v2/conversations/messaging/integrations/instagram/{integrationId}": { + "operationId": "patchconversationsmessagingintegrationsinstagramintegrationid", + "functionName": "patchConversationsMessagingIntegrationsInstagramIntegrationId", + "signature": "patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InstagramIntegrationUpdateRequest", + "required": "true" + } + ], + "return": "InstagramIntegration" + }, + "PATCH /api/v2/conversations/messaging/integrations/open/{integrationId}": { + "operationId": "patchconversationsmessagingintegrationsopenintegrationid", + "functionName": "patchConversationsMessagingIntegrationsOpenIntegrationId", + "signature": "patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OpenIntegrationUpdateRequest", + "required": "true" + } + ], + "return": "OpenIntegration" + }, + "PATCH /api/v2/conversations/messaging/integrations/twitter/{integrationId}": { + "operationId": "patchconversationsmessagingintegrationstwitterintegrationid", + "functionName": "patchConversationsMessagingIntegrationsTwitterIntegrationId", + "signature": "patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TwitterIntegrationRequest", + "required": "true" + } + ], + "return": "TwitterIntegration" + }, + "PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}": { + "operationId": "patchconversationsmessagingintegrationswhatsappintegrationid", + "functionName": "patchConversationsMessagingIntegrationsWhatsappIntegrationId", + "signature": "patchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WhatsAppIntegrationUpdateRequest", + "required": "true" + } + ], + "return": "WhatsAppIntegration" + }, + "PATCH /api/v2/conversations/messaging/settings/{messageSettingId}": { + "operationId": "patchconversationsmessagingsetting", + "functionName": "patchConversationsMessagingSetting", + "signature": "patchConversationsMessagingSetting(messageSettingId, body)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MessagingSettingPatchRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId}": { + "operationId": "patchconversationsmessagingsupportedcontentsupportedcontentid", + "functionName": "patchConversationsMessagingSupportedcontentSupportedContentId", + "signature": "patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SupportedContent", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "PATCH /api/v2/conversations/settings": { + "operationId": "patchconversationssettings", + "functionName": "patchConversationsSettings", + "signature": "patchConversationsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "Settings", + "required": "true" + } + ] + }, + "POST /api/v2/analytics/conversations/{conversationId}/details/properties": { + "operationId": "postanalyticsconversationdetailsproperties", + "functionName": "postAnalyticsConversationDetailsProperties", + "signature": "postAnalyticsConversationDetailsProperties(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PropertyIndexRequest", + "required": "true" + } + ], + "return": "PropertyIndexRequest" + }, + "POST /api/v2/analytics/conversations/aggregates/query": { + "operationId": "postanalyticsconversationsaggregatesquery", + "functionName": "postAnalyticsConversationsAggregatesQuery", + "signature": "postAnalyticsConversationsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationAggregationQuery", + "required": "true" + } + ], + "return": "ConversationAggregateQueryResponse" + }, + "POST /api/v2/analytics/conversations/details/jobs": { + "operationId": "postanalyticsconversationsdetailsjobs", + "functionName": "postAnalyticsConversationsDetailsJobs", + "signature": "postAnalyticsConversationsDetailsJobs(body)", + "parameters": [ + { + "name": "body", + "type": "AsyncConversationQuery", + "required": "true" + } + ], + "return": "AsyncQueryResponse" + }, + "POST /api/v2/analytics/conversations/details/query": { + "operationId": "postanalyticsconversationsdetailsquery", + "functionName": "postAnalyticsConversationsDetailsQuery", + "signature": "postAnalyticsConversationsDetailsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationQuery", + "required": "true" + } + ], + "return": "AnalyticsConversationQueryResponse" + }, + "POST /api/v2/conversations/{conversationId}/assign": { + "operationId": "postconversationassign", + "functionName": "postConversationAssign", + "signature": "postConversationAssign(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationUser", + "required": "true" + } + ], + "return": "String" + }, + "POST /api/v2/conversations/{conversationId}/cobrowse": { + "operationId": "postconversationcobrowse", + "functionName": "postConversationCobrowse", + "signature": "postConversationCobrowse(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "CobrowseWebMessagingSession" + }, + "POST /api/v2/conversations/{conversationId}/disconnect": { + "operationId": "postconversationdisconnect", + "functionName": "postConversationDisconnect", + "signature": "postConversationDisconnect(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks": { + "operationId": "postconversationparticipantcallbacks", + "functionName": "postConversationParticipantCallbacks", + "signature": "postConversationParticipantCallbacks(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateCallbackOnConversationCommand", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits": { + "operationId": "postconversationparticipantdigits", + "functionName": "postConversationParticipantDigits", + "signature": "postConversationParticipantDigits(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Digits", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationparticipantreplace", + "functionName": "postConversationParticipantReplace", + "signature": "postConversationParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions": { + "operationId": "postconversationparticipantsecureivrsessions", + "functionName": "postConversationParticipantSecureivrsessions", + "signature": "postConversationParticipantSecureivrsessions(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateSecureSession", + "required": "false" + } + ], + "return": "SecureSession" + }, + "POST /api/v2/conversations/calls/{conversationId}": { + "operationId": "postconversationscall", + "functionName": "postConversationsCall", + "signature": "postConversationsCall(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CallCommand", + "required": "true" + } + ], + "return": "Conversation" + }, + "POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach": { + "operationId": "postconversationscallparticipantcoach", + "functionName": "postConversationsCallParticipantCoach", + "signature": "postConversationsCallParticipantCoach(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationscallparticipantcommunicationwrapup", + "functionName": "postConversationsCallParticipantCommunicationWrapup", + "signature": "postConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult": { + "operationId": "postconversationscallparticipantconsult", + "functionName": "postConversationsCallParticipantConsult", + "signature": "postConversationsCallParticipantConsult(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConsultTransfer", + "required": "true" + } + ], + "return": "ConsultTransferResponse" + }, + "POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor": { + "operationId": "postconversationscallparticipantmonitor", + "functionName": "postConversationsCallParticipantMonitor", + "signature": "postConversationsCallParticipantMonitor(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationscallparticipantreplace", + "functionName": "postConversationsCallParticipantReplace", + "signature": "postConversationsCallParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/calls/{conversationId}/participants": { + "operationId": "postconversationscallparticipants", + "functionName": "postConversationsCallParticipants", + "signature": "postConversationsCallParticipants(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Conversation", + "required": "true" + } + ], + "return": "Conversation" + }, + "POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationscallbackparticipantcommunicationwrapup", + "functionName": "postConversationsCallbackParticipantCommunicationWrapup", + "signature": "postConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationscallbackparticipantreplace", + "functionName": "postConversationsCallbackParticipantReplace", + "signature": "postConversationsCallbackParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/callbacks": { + "operationId": "postconversationscallbacks", + "functionName": "postConversationsCallbacks", + "signature": "postConversationsCallbacks(body)", + "parameters": [ + { + "name": "body", + "type": "CreateCallbackCommand", + "required": "true" + } + ], + "return": "CreateCallbackResponse" + }, + "POST /api/v2/conversations/callbacks/bulk/disconnect": { + "operationId": "postconversationscallbacksbulkdisconnect", + "functionName": "postConversationsCallbacksBulkDisconnect", + "signature": "postConversationsCallbacksBulkDisconnect(body)", + "parameters": [ + { + "name": "body", + "type": "BulkCallbackDisconnectRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/callbacks/bulk/update": { + "operationId": "postconversationscallbacksbulkupdate", + "functionName": "postConversationsCallbacksBulkUpdate", + "signature": "postConversationsCallbacksBulkUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "BulkCallbackPatchRequest", + "required": "true" + } + ], + "return": "BulkCallbackPatchResponse" + }, + "POST /api/v2/conversations/calls": { + "operationId": "postconversationscalls", + "functionName": "postConversationsCalls", + "signature": "postConversationsCalls(body)", + "parameters": [ + { + "name": "body", + "type": "CreateCallRequest", + "required": "true" + } + ], + "return": "CreateCallResponse" + }, + "POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages": { + "operationId": "postconversationschatcommunicationmessages", + "functionName": "postConversationsChatCommunicationMessages", + "signature": "postConversationsChatCommunicationMessages(conversationId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateWebChatMessageRequest", + "required": "true" + } + ], + "return": "WebChatMessage" + }, + "POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing": { + "operationId": "postconversationschatcommunicationtyping", + "functionName": "postConversationsChatCommunicationTyping", + "signature": "postConversationsChatCommunicationTyping(conversationId, communicationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatTyping" + }, + "POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationschatparticipantcommunicationwrapup", + "functionName": "postConversationsChatParticipantCommunicationWrapup", + "signature": "postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationschatparticipantreplace", + "functionName": "postConversationsChatParticipantReplace", + "signature": "postConversationsChatParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/chats": { + "operationId": "postconversationschats", + "functionName": "postConversationsChats", + "signature": "postConversationsChats(body)", + "parameters": [ + { + "name": "body", + "type": "CreateWebChatRequest", + "required": "true" + } + ], + "return": "ChatConversation" + }, + "POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationscobrowsesessionparticipantcommunicationwrapup", + "functionName": "postConversationsCobrowsesessionParticipantCommunicationWrapup", + "signature": "postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationscobrowsesessionparticipantreplace", + "functionName": "postConversationsCobrowsesessionParticipantReplace", + "signature": "postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/emails/{conversationId}/inboundmessages": { + "operationId": "postconversationsemailinboundmessages", + "functionName": "postConversationsEmailInboundmessages", + "signature": "postConversationsEmailInboundmessages(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InboundMessageRequest", + "required": "true" + } + ], + "return": "EmailConversation" + }, + "POST /api/v2/conversations/emails/{conversationId}/messages": { + "operationId": "postconversationsemailmessages", + "functionName": "postConversationsEmailMessages", + "signature": "postConversationsEmailMessages(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EmailMessage", + "required": "true" + } + ], + "return": "EmailMessageReply" + }, + "POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy": { + "operationId": "postconversationsemailmessagesdraftattachmentscopy", + "functionName": "postConversationsEmailMessagesDraftAttachmentsCopy", + "signature": "postConversationsEmailMessagesDraftAttachmentsCopy(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CopyAttachmentsRequest", + "required": "true" + } + ], + "return": "EmailMessage" + }, + "POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationsemailparticipantcommunicationwrapup", + "functionName": "postConversationsEmailParticipantCommunicationWrapup", + "signature": "postConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationsemailparticipantreplace", + "functionName": "postConversationsEmailParticipantReplace", + "signature": "postConversationsEmailParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/emails": { + "operationId": "postconversationsemails", + "functionName": "postConversationsEmails", + "signature": "postConversationsEmails(body)", + "parameters": [ + { + "name": "body", + "type": "CreateEmailRequest", + "required": "true" + } + ], + "return": "EmailConversation" + }, + "POST /api/v2/conversations/emails/agentless": { + "operationId": "postconversationsemailsagentless", + "functionName": "postConversationsEmailsAgentless", + "signature": "postConversationsEmailsAgentless(body)", + "parameters": [ + { + "name": "body", + "type": "AgentlessEmailSendRequestDto", + "required": "true" + } + ], + "return": "AgentlessEmailSendResponseDto" + }, + "POST /api/v2/conversations/faxes": { + "operationId": "postconversationsfaxes", + "functionName": "postConversationsFaxes", + "signature": "postConversationsFaxes(body)", + "parameters": [ + { + "name": "body", + "type": "FaxSendRequest", + "required": "true" + } + ], + "return": "FaxSendResponse" + }, + "POST /api/v2/conversations/keyconfigurations": { + "operationId": "postconversationskeyconfigurations", + "functionName": "postConversationsKeyconfigurations", + "signature": "postConversationsKeyconfigurations(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationEncryptionConfiguration", + "required": "true" + } + ], + "return": "ConversationEncryptionConfiguration" + }, + "POST /api/v2/conversations/keyconfigurations/validate": { + "operationId": "postconversationskeyconfigurationsvalidate", + "functionName": "postConversationsKeyconfigurationsValidate", + "signature": "postConversationsKeyconfigurationsValidate(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationEncryptionConfiguration", + "required": "true" + } + ], + "return": "ConversationEncryptionConfiguration" + }, + "POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages": { + "operationId": "postconversationsmessagecommunicationmessages", + "functionName": "postConversationsMessageCommunicationMessages", + "signature": "postConversationsMessageCommunicationMessages(conversationId, communicationId, body, useNormalizedMessage)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AdditionalMessage", + "required": "true" + }, + { + "name": "useNormalizedMessage", + "type": "Bool", + "required": "false" + } + ], + "return": "MessageData" + }, + "POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media": { + "operationId": "postconversationsmessagecommunicationmessagesmedia", + "functionName": "postConversationsMessageCommunicationMessagesMedia", + "signature": "postConversationsMessageCommunicationMessagesMedia(conversationId, communicationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + } + ], + "return": "MessageMediaData" + }, + "POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing": { + "operationId": "postconversationsmessagecommunicationtyping", + "functionName": "postConversationsMessageCommunicationTyping", + "signature": "postConversationsMessageCommunicationTyping(conversationId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MessageTypingEventRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/messages/{integrationId}/inbound/open/event": { + "operationId": "postconversationsmessageinboundopenevent", + "functionName": "postConversationsMessageInboundOpenEvent", + "signature": "postConversationsMessageInboundOpenEvent(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OpenInboundNormalizedEvent", + "required": "true" + } + ], + "return": "OpenEventNormalizedMessage" + }, + "POST /api/v2/conversations/messages/{integrationId}/inbound/open/message": { + "operationId": "postconversationsmessageinboundopenmessage", + "functionName": "postConversationsMessageInboundOpenMessage", + "signature": "postConversationsMessageInboundOpenMessage(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OpenInboundNormalizedMessage", + "required": "true" + } + ], + "return": "OpenMessageNormalizedMessage" + }, + "POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt": { + "operationId": "postconversationsmessageinboundopenreceipt", + "functionName": "postConversationsMessageInboundOpenReceipt", + "signature": "postConversationsMessageInboundOpenReceipt(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OpenInboundNormalizedReceipt", + "required": "true" + } + ], + "return": "OpenReceiptNormalizedMessage" + }, + "POST /api/v2/conversations/messages/{conversationId}/messages/bulk": { + "operationId": "postconversationsmessagemessagesbulk", + "functionName": "postConversationsMessageMessagesBulk", + "signature": "postConversationsMessageMessagesBulk(conversationId, useNormalizedMessage, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "useNormalizedMessage", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "[String]", + "required": "false" + } + ], + "return": "TextMessageListing" + }, + "POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationsmessageparticipantcommunicationwrapup", + "functionName": "postConversationsMessageParticipantCommunicationWrapup", + "signature": "postConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace": { + "operationId": "postconversationsmessageparticipantreplace", + "functionName": "postConversationsMessageParticipantReplace", + "signature": "postConversationsMessageParticipantReplace(conversationId, participantId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TransferRequest", + "required": "true" + } + ] + }, + "POST /api/v2/conversations/messages": { + "operationId": "postconversationsmessages", + "functionName": "postConversationsMessages", + "signature": "postConversationsMessages(body)", + "parameters": [ + { + "name": "body", + "type": "CreateOutboundMessagingConversationRequest", + "required": "true" + } + ], + "return": "MessageConversation" + }, + "POST /api/v2/conversations/messages/agentless": { + "operationId": "postconversationsmessagesagentless", + "functionName": "postConversationsMessagesAgentless", + "signature": "postConversationsMessagesAgentless(body)", + "parameters": [ + { + "name": "body", + "type": "SendAgentlessOutboundMessageRequest", + "required": "true" + } + ], + "return": "SendAgentlessOutboundMessageResponse" + }, + "POST /api/v2/conversations/messages/inbound/open": { + "operationId": "postconversationsmessagesinboundopen", + "functionName": "postConversationsMessagesInboundOpen", + "signature": "postConversationsMessagesInboundOpen(body)", + "parameters": [ + { + "name": "body", + "type": "OpenNormalizedMessage", + "required": "true" + } + ], + "return": "OpenNormalizedMessage" + }, + "POST /api/v2/conversations/messaging/integrations/facebook": { + "operationId": "postconversationsmessagingintegrationsfacebook", + "functionName": "postConversationsMessagingIntegrationsFacebook", + "signature": "postConversationsMessagingIntegrationsFacebook(body)", + "parameters": [ + { + "name": "body", + "type": "FacebookIntegrationRequest", + "required": "true" + } + ], + "return": "FacebookIntegration" + }, + "POST /api/v2/conversations/messaging/integrations/instagram": { + "operationId": "postconversationsmessagingintegrationsinstagram", + "functionName": "postConversationsMessagingIntegrationsInstagram", + "signature": "postConversationsMessagingIntegrationsInstagram(body)", + "parameters": [ + { + "name": "body", + "type": "InstagramIntegrationRequest", + "required": "true" + } + ], + "return": "InstagramIntegration" + }, + "POST /api/v2/conversations/messaging/integrations/line": { + "operationId": "postconversationsmessagingintegrationsline", + "functionName": "postConversationsMessagingIntegrationsLine", + "signature": "postConversationsMessagingIntegrationsLine(body)", + "parameters": [ + { + "name": "body", + "type": "LineIntegrationRequest", + "required": "true" + } + ], + "return": "LineIntegration" + }, + "POST /api/v2/conversations/messaging/integrations/open": { + "operationId": "postconversationsmessagingintegrationsopen", + "functionName": "postConversationsMessagingIntegrationsOpen", + "signature": "postConversationsMessagingIntegrationsOpen(body)", + "parameters": [ + { + "name": "body", + "type": "OpenIntegrationRequest", + "required": "true" + } + ], + "return": "OpenIntegration" + }, + "POST /api/v2/conversations/messaging/integrations/twitter": { + "operationId": "postconversationsmessagingintegrationstwitter", + "functionName": "postConversationsMessagingIntegrationsTwitter", + "signature": "postConversationsMessagingIntegrationsTwitter(body)", + "parameters": [ + { + "name": "body", + "type": "TwitterIntegrationRequest", + "required": "true" + } + ], + "return": "TwitterIntegration" + }, + "POST /api/v2/conversations/messaging/integrations/whatsapp": { + "operationId": "postconversationsmessagingintegrationswhatsapp", + "functionName": "postConversationsMessagingIntegrationsWhatsapp", + "signature": "postConversationsMessagingIntegrationsWhatsapp(body)", + "parameters": [ + { + "name": "body", + "type": "WhatsAppIntegrationRequest", + "required": "true" + } + ], + "return": "WhatsAppIntegration" + }, + "POST /api/v2/conversations/messaging/settings": { + "operationId": "postconversationsmessagingsettings", + "functionName": "postConversationsMessagingSettings", + "signature": "postConversationsMessagingSettings(body)", + "parameters": [ + { + "name": "body", + "type": "MessagingSettingRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "POST /api/v2/conversations/messaging/supportedcontent": { + "operationId": "postconversationsmessagingsupportedcontent", + "functionName": "postConversationsMessagingSupportedcontent", + "signature": "postConversationsMessagingSupportedcontent(body)", + "parameters": [ + { + "name": "body", + "type": "SupportedContent", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "POST /api/v2/conversations/participants/attributes/search": { + "operationId": "postconversationsparticipantsattributessearch", + "functionName": "postConversationsParticipantsAttributesSearch", + "signature": "postConversationsParticipantsAttributesSearch(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationParticipantSearchRequest", + "required": "true" + } + ], + "return": "JsonCursorSearchResponse" + }, + "POST /api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationsscreenshareparticipantcommunicationwrapup", + "functionName": "postConversationsScreenshareParticipantCommunicationWrapup", + "signature": "postConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationssocialparticipantcommunicationwrapup", + "functionName": "postConversationsSocialParticipantCommunicationWrapup", + "signature": "postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup": { + "operationId": "postconversationsvideoparticipantcommunicationwrapup", + "functionName": "postConversationsVideoParticipantCommunicationWrapup", + "signature": "postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupInput", + "required": "false" + } + ] + }, + "PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason": { + "operationId": "putconversationparticipantflaggedreason", + "functionName": "putConversationParticipantFlaggedreason", + "signature": "putConversationParticipantFlaggedreason(conversationId, participantId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + } + ] + }, + "PUT /api/v2/conversations/{conversationId}/secureattributes": { + "operationId": "putconversationsecureattributes", + "functionName": "putConversationSecureattributes", + "signature": "putConversationSecureattributes(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationSecureAttributes", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/{conversationId}/tags": { + "operationId": "putconversationtags", + "functionName": "putConversationTags", + "signature": "putConversationTags(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationTagsUpdate", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata": { + "operationId": "putconversationscallparticipantcommunicationuuidata", + "functionName": "putConversationsCallParticipantCommunicationUuidata", + "signature": "putConversationsCallParticipantCommunicationUuidata(conversationId, participantId, communicationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "participantId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetUuiDataRequest", + "required": "true" + } + ], + "return": "JSON" + }, + "PUT /api/v2/conversations/calls/{conversationId}/recordingstate": { + "operationId": "putconversationscallrecordingstate", + "functionName": "putConversationsCallRecordingstate", + "signature": "putConversationsCallRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate": { + "operationId": "putconversationscallbackrecordingstate", + "functionName": "putConversationsCallbackRecordingstate", + "signature": "putConversationsCallbackRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/chats/{conversationId}/recordingstate": { + "operationId": "putconversationschatrecordingstate", + "functionName": "putConversationsChatRecordingstate", + "signature": "putConversationsChatRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate": { + "operationId": "putconversationscobrowsesessionrecordingstate", + "functionName": "putConversationsCobrowsesessionRecordingstate", + "signature": "putConversationsCobrowsesessionRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/emails/{conversationId}/messages/draft": { + "operationId": "putconversationsemailmessagesdraft", + "functionName": "putConversationsEmailMessagesDraft", + "signature": "putConversationsEmailMessagesDraft(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EmailMessage", + "required": "true" + } + ], + "return": "EmailMessage" + }, + "PUT /api/v2/conversations/emails/{conversationId}/recordingstate": { + "operationId": "putconversationsemailrecordingstate", + "functionName": "putConversationsEmailRecordingstate", + "signature": "putConversationsEmailRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/keyconfigurations/{keyconfigurationsId}": { + "operationId": "putconversationskeyconfiguration", + "functionName": "putConversationsKeyconfiguration", + "signature": "putConversationsKeyconfiguration(keyconfigurationsId, body)", + "parameters": [ + { + "name": "keyconfigurationsId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationEncryptionConfiguration", + "required": "true" + } + ], + "return": "ConversationEncryptionConfiguration" + }, + "PUT /api/v2/conversations/messages/{conversationId}/recordingstate": { + "operationId": "putconversationsmessagerecordingstate", + "functionName": "putConversationsMessageRecordingstate", + "signature": "putConversationsMessageRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/messaging/integrations/line/{integrationId}": { + "operationId": "putconversationsmessagingintegrationslineintegrationid", + "functionName": "putConversationsMessagingIntegrationsLineIntegrationId", + "signature": "putConversationsMessagingIntegrationsLineIntegrationId(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LineIntegrationRequest", + "required": "true" + } + ], + "return": "LineIntegration" + }, + "PUT /api/v2/conversations/messaging/settings/default": { + "operationId": "putconversationsmessagingsettingsdefault", + "functionName": "putConversationsMessagingSettingsDefault", + "signature": "putConversationsMessagingSettingsDefault(body)", + "parameters": [ + { + "name": "body", + "type": "MessagingSettingDefaultRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "PUT /api/v2/conversations/messaging/supportedcontent/default": { + "operationId": "putconversationsmessagingsupportedcontentdefault", + "functionName": "putConversationsMessagingSupportedcontentDefault", + "signature": "putConversationsMessagingSupportedcontentDefault(body)", + "parameters": [ + { + "name": "body", + "type": "SupportedContentReference", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "PUT /api/v2/conversations/messaging/threadingtimeline": { + "operationId": "putconversationsmessagingthreadingtimeline", + "functionName": "putConversationsMessagingThreadingtimeline", + "signature": "putConversationsMessagingThreadingtimeline(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationThreadingWindow", + "required": "true" + } + ], + "return": "ConversationThreadingWindow" + }, + "PUT /api/v2/conversations/screenshares/{conversationId}/recordingstate": { + "operationId": "putconversationsscreensharerecordingstate", + "functionName": "putConversationsScreenshareRecordingstate", + "signature": "putConversationsScreenshareRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/socials/{conversationId}/recordingstate": { + "operationId": "putconversationssocialrecordingstate", + "functionName": "putConversationsSocialRecordingstate", + "signature": "putConversationsSocialRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/conversations/videos/{conversationId}/recordingstate": { + "operationId": "putconversationsvideorecordingstate", + "functionName": "putConversationsVideoRecordingstate", + "signature": "putConversationsVideoRecordingstate(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetRecordingState", + "required": "true" + } + ], + "return": "String" + } + +} \ No newline at end of file diff --git a/build/docs/DataExtensionsAPI.json b/build/docs/DataExtensionsAPI.json new file mode 100644 index 000000000..bca0e8c06 --- /dev/null +++ b/build/docs/DataExtensionsAPI.json @@ -0,0 +1,30 @@ +{ + "GET /api/v2/dataextensions/coretypes/{coretypeName}": { + "operationId": "getdataextensionscoretype", + "functionName": "getDataextensionsCoretype", + "signature": "getDataextensionsCoretype(coretypeName)", + "parameters": [ + { + "name": "coretypeName", + "type": "String", + "required": "true" + } + ], + "return": "Coretype" + }, + "GET /api/v2/dataextensions/coretypes": { + "operationId": "getdataextensionscoretypes", + "functionName": "getDataextensionsCoretypes", + "signature": "getDataextensionsCoretypes()", + + "return": "CoretypeListing" + }, + "GET /api/v2/dataextensions/limits": { + "operationId": "getdataextensionslimits", + "functionName": "getDataextensionsLimits", + "signature": "getDataextensionsLimits()", + + "return": "SchemaQuantityLimits" + } + +} \ No newline at end of file diff --git a/build/docs/DownloadsAPI.json b/build/docs/DownloadsAPI.json new file mode 100644 index 000000000..abcbdbec7 --- /dev/null +++ b/build/docs/DownloadsAPI.json @@ -0,0 +1,31 @@ +{ + "GET /api/v2/downloads/{downloadId}": { + "operationId": "getdownload", + "functionName": "getDownload", + "signature": "getDownload(downloadId, contentDisposition, issueRedirect, redirectToAuth)", + "parameters": [ + { + "name": "downloadId", + "type": "String", + "required": "true" + }, + { + "name": "contentDisposition", + "type": "String", + "required": "false" + }, + { + "name": "issueRedirect", + "type": "Bool", + "required": "false" + }, + { + "name": "redirectToAuth", + "type": "Bool", + "required": "false" + } + ], + "return": "UrlResponse" + } + +} \ No newline at end of file diff --git a/build/docs/EmailsAPI.json b/build/docs/EmailsAPI.json new file mode 100644 index 000000000..a441d90ef --- /dev/null +++ b/build/docs/EmailsAPI.json @@ -0,0 +1,23 @@ +{ + "GET /api/v2/emails/settings": { + "operationId": "getemailssettings", + "functionName": "getEmailsSettings", + "signature": "getEmailsSettings()", + + "return": "EmailSettings" + }, + "PATCH /api/v2/emails/settings": { + "operationId": "patchemailssettings", + "functionName": "patchEmailsSettings", + "signature": "patchEmailsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "EmailSettings", + "required": "false" + } + ], + "return": "EmailSettings" + } + +} \ No newline at end of file diff --git a/build/docs/EventsAPI.json b/build/docs/EventsAPI.json new file mode 100644 index 000000000..df533b7e1 --- /dev/null +++ b/build/docs/EventsAPI.json @@ -0,0 +1,42 @@ +{ + "POST /api/v2/events/conversations": { + "operationId": "posteventsconversations", + "functionName": "postEventsConversations", + "signature": "postEventsConversations(body)", + "parameters": [ + { + "name": "body", + "type": "BatchConversationEventRequest", + "required": "true" + } + ], + "return": "BatchEventResponse" + }, + "POST /api/v2/events/users/presence": { + "operationId": "posteventsuserspresence", + "functionName": "postEventsUsersPresence", + "signature": "postEventsUsersPresence(body)", + "parameters": [ + { + "name": "body", + "type": "BatchUserPresenceEventRequest", + "required": "true" + } + ], + "return": "BatchEventResponse" + }, + "POST /api/v2/events/users/routingstatus": { + "operationId": "posteventsusersroutingstatus", + "functionName": "postEventsUsersRoutingstatus", + "signature": "postEventsUsersRoutingstatus(body)", + "parameters": [ + { + "name": "body", + "type": "BatchUserRoutingStatusEventRequest", + "required": "true" + } + ], + "return": "BatchEventResponse" + } + +} \ No newline at end of file diff --git a/build/docs/ExternalContactsAPI.json b/build/docs/ExternalContactsAPI.json new file mode 100644 index 000000000..940d11913 --- /dev/null +++ b/build/docs/ExternalContactsAPI.json @@ -0,0 +1,1221 @@ +{ + "DELETE /api/v2/externalcontacts/contacts/{contactId}": { + "operationId": "deleteexternalcontactscontact", + "functionName": "deleteExternalcontactsContact", + "signature": "deleteExternalcontactsContact(contactId)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}": { + "operationId": "deleteexternalcontactscontactnote", + "functionName": "deleteExternalcontactsContactNote", + "signature": "deleteExternalcontactsContactNote(contactId, noteId)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId}": { + "operationId": "deleteexternalcontactscontactsschema", + "functionName": "deleteExternalcontactsContactsSchema", + "signature": "deleteExternalcontactsContactsSchema(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}": { + "operationId": "deleteexternalcontactsorganization", + "functionName": "deleteExternalcontactsOrganization", + "signature": "deleteExternalcontactsOrganization(externalOrganizationId)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}": { + "operationId": "deleteexternalcontactsorganizationnote", + "functionName": "deleteExternalcontactsOrganizationNote", + "signature": "deleteExternalcontactsOrganizationNote(externalOrganizationId, noteId)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor": { + "operationId": "deleteexternalcontactsorganizationtrustor", + "functionName": "deleteExternalcontactsOrganizationTrustor", + "signature": "deleteExternalcontactsOrganizationTrustor(externalOrganizationId)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/externalcontacts/relationships/{relationshipId}": { + "operationId": "deleteexternalcontactsrelationship", + "functionName": "deleteExternalcontactsRelationship", + "signature": "deleteExternalcontactsRelationship(relationshipId)", + "parameters": [ + { + "name": "relationshipId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}": { + "operationId": "getexternalcontactscontact", + "functionName": "getExternalcontactsContact", + "signature": "getExternalcontactsContact(contactId, expand)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ExternalContact" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/identifiers": { + "operationId": "getexternalcontactscontactidentifiers", + "functionName": "getExternalcontactsContactIdentifiers", + "signature": "getExternalcontactsContactIdentifiers(contactId)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + } + ], + "return": "EntityListing" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions": { + "operationId": "getexternalcontactscontactjourneysessions", + "functionName": "getExternalcontactsContactJourneySessions", + "signature": "getExternalcontactsContactJourneySessions(contactId, pageSize, after, includeMerged)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "includeMerged", + "type": "Bool", + "required": "false" + } + ], + "return": "SessionListing" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}": { + "operationId": "getexternalcontactscontactnote", + "functionName": "getExternalcontactsContactNote", + "signature": "getExternalcontactsContactNote(contactId, noteId, expand)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Note" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/notes": { + "operationId": "getexternalcontactscontactnotes", + "functionName": "getExternalcontactsContactNotes", + "signature": "getExternalcontactsContactNotes(contactId, pageSize, pageNumber, sortOrder, expand)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "NoteListing" + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/unresolved": { + "operationId": "getexternalcontactscontactunresolved", + "functionName": "getExternalcontactsContactUnresolved", + "signature": "getExternalcontactsContactUnresolved(contactId, expand)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ExternalContact" + }, + "GET /api/v2/externalcontacts/contacts": { + "operationId": "getexternalcontactscontacts", + "functionName": "getExternalcontactsContacts", + "signature": "getExternalcontactsContacts(pageSize, pageNumber, q, sortOrder, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "q", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ContactListing" + }, + "GET /api/v2/externalcontacts/contacts/schemas/{schemaId}": { + "operationId": "getexternalcontactscontactsschema", + "functionName": "getExternalcontactsContactsSchema", + "signature": "getExternalcontactsContactsSchema(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}": { + "operationId": "getexternalcontactscontactsschemaversion", + "functionName": "getExternalcontactsContactsSchemaVersion", + "signature": "getExternalcontactsContactsSchemaVersion(schemaId, versionId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions": { + "operationId": "getexternalcontactscontactsschemaversions", + "functionName": "getExternalcontactsContactsSchemaVersions", + "signature": "getExternalcontactsContactsSchemaVersions(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/contacts/schemas": { + "operationId": "getexternalcontactscontactsschemas", + "functionName": "getExternalcontactsContactsSchemas", + "signature": "getExternalcontactsContactsSchemas()", + + "return": "DataSchemaListing" + }, + "GET /api/v2/externalcontacts/organizations/{externalOrganizationId}": { + "operationId": "getexternalcontactsorganization", + "functionName": "getExternalcontactsOrganization", + "signature": "getExternalcontactsOrganization(externalOrganizationId, expand, includeTrustors)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "includeTrustors", + "type": "Bool", + "required": "false" + } + ], + "return": "ExternalOrganization" + }, + "GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts": { + "operationId": "getexternalcontactsorganizationcontacts", + "functionName": "getExternalcontactsOrganizationContacts", + "signature": "getExternalcontactsOrganizationContacts(externalOrganizationId, pageSize, pageNumber, q, sortOrder, expand)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "q", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ContactListing" + }, + "GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}": { + "operationId": "getexternalcontactsorganizationnote", + "functionName": "getExternalcontactsOrganizationNote", + "signature": "getExternalcontactsOrganizationNote(externalOrganizationId, noteId, expand)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Note" + }, + "GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes": { + "operationId": "getexternalcontactsorganizationnotes", + "functionName": "getExternalcontactsOrganizationNotes", + "signature": "getExternalcontactsOrganizationNotes(externalOrganizationId, pageSize, pageNumber, sortOrder, expand)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "NoteListing" + }, + "GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships": { + "operationId": "getexternalcontactsorganizationrelationships", + "functionName": "getExternalcontactsOrganizationRelationships", + "signature": "getExternalcontactsOrganizationRelationships(externalOrganizationId, pageSize, pageNumber, expand, sortOrder)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "RelationshipListing" + }, + "GET /api/v2/externalcontacts/organizations": { + "operationId": "getexternalcontactsorganizations", + "functionName": "getExternalcontactsOrganizations", + "signature": "getExternalcontactsOrganizations(pageSize, pageNumber, q, trustorId, sortOrder, expand, includeTrustors)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "q", + "type": "String", + "required": "false" + }, + { + "name": "trustorId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "includeTrustors", + "type": "Bool", + "required": "false" + } + ], + "return": "ExternalOrganizationListing" + }, + "GET /api/v2/externalcontacts/organizations/schemas/{schemaId}": { + "operationId": "getexternalcontactsorganizationsschema", + "functionName": "getExternalcontactsOrganizationsSchema", + "signature": "getExternalcontactsOrganizationsSchema(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}": { + "operationId": "getexternalcontactsorganizationsschemaversion", + "functionName": "getExternalcontactsOrganizationsSchemaVersion", + "signature": "getExternalcontactsOrganizationsSchemaVersion(schemaId, versionId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions": { + "operationId": "getexternalcontactsorganizationsschemaversions", + "functionName": "getExternalcontactsOrganizationsSchemaVersions", + "signature": "getExternalcontactsOrganizationsSchemaVersions(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "DataSchema" + }, + "GET /api/v2/externalcontacts/organizations/schemas": { + "operationId": "getexternalcontactsorganizationsschemas", + "functionName": "getExternalcontactsOrganizationsSchemas", + "signature": "getExternalcontactsOrganizationsSchemas()", + + "return": "DataSchemaListing" + }, + "GET /api/v2/externalcontacts/relationships/{relationshipId}": { + "operationId": "getexternalcontactsrelationship", + "functionName": "getExternalcontactsRelationship", + "signature": "getExternalcontactsRelationship(relationshipId, expand)", + "parameters": [ + { + "name": "relationshipId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "Relationship" + }, + "GET /api/v2/externalcontacts/reversewhitepageslookup": { + "operationId": "getexternalcontactsreversewhitepageslookup", + "functionName": "getExternalcontactsReversewhitepageslookup", + "signature": "getExternalcontactsReversewhitepageslookup(lookupVal, expand)", + "parameters": [ + { + "name": "lookupVal", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ReverseWhitepagesLookupResult" + }, + "GET /api/v2/externalcontacts/scan/contacts": { + "operationId": "getexternalcontactsscancontacts", + "functionName": "getExternalcontactsScanContacts", + "signature": "getExternalcontactsScanContacts(limit, cursor)", + "parameters": [ + { + "name": "limit", + "type": "Int", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "CursorContactListing" + }, + "GET /api/v2/externalcontacts/scan/notes": { + "operationId": "getexternalcontactsscannotes", + "functionName": "getExternalcontactsScanNotes", + "signature": "getExternalcontactsScanNotes(limit, cursor)", + "parameters": [ + { + "name": "limit", + "type": "Int", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "CursorNoteListing" + }, + "GET /api/v2/externalcontacts/scan/organizations": { + "operationId": "getexternalcontactsscanorganizations", + "functionName": "getExternalcontactsScanOrganizations", + "signature": "getExternalcontactsScanOrganizations(limit, cursor)", + "parameters": [ + { + "name": "limit", + "type": "Int", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "CursorOrganizationListing" + }, + "GET /api/v2/externalcontacts/scan/relationships": { + "operationId": "getexternalcontactsscanrelationships", + "functionName": "getExternalcontactsScanRelationships", + "signature": "getExternalcontactsScanRelationships(limit, cursor)", + "parameters": [ + { + "name": "limit", + "type": "Int", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "CursorRelationshipListing" + }, + "PATCH /api/v2/externalcontacts/contacts/{contactId}/identifiers": { + "operationId": "patchexternalcontactscontactidentifiers", + "functionName": "patchExternalcontactsContactIdentifiers", + "signature": "patchExternalcontactsContactIdentifiers(contactId, body)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "IdentifierClaimRequest", + "required": "true" + } + ], + "return": "ContactIdentifier" + }, + "POST /api/v2/externalcontacts/bulk/contacts": { + "operationId": "postexternalcontactsbulkcontacts", + "functionName": "postExternalcontactsBulkContacts", + "signature": "postExternalcontactsBulkContacts(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkFetchContactsResponse" + }, + "POST /api/v2/externalcontacts/bulk/contacts/add": { + "operationId": "postexternalcontactsbulkcontactsadd", + "functionName": "postExternalcontactsBulkContactsAdd", + "signature": "postExternalcontactsBulkContactsAdd(body)", + "parameters": [ + { + "name": "body", + "type": "BulkContactsRequest", + "required": "true" + } + ], + "return": "BulkContactsResponse" + }, + "POST /api/v2/externalcontacts/bulk/contacts/remove": { + "operationId": "postexternalcontactsbulkcontactsremove", + "functionName": "postExternalcontactsBulkContactsRemove", + "signature": "postExternalcontactsBulkContactsRemove(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkDeleteResponse" + }, + "POST /api/v2/externalcontacts/bulk/contacts/unresolved": { + "operationId": "postexternalcontactsbulkcontactsunresolved", + "functionName": "postExternalcontactsBulkContactsUnresolved", + "signature": "postExternalcontactsBulkContactsUnresolved(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkFetchContactsResponse" + }, + "POST /api/v2/externalcontacts/bulk/contacts/update": { + "operationId": "postexternalcontactsbulkcontactsupdate", + "functionName": "postExternalcontactsBulkContactsUpdate", + "signature": "postExternalcontactsBulkContactsUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "BulkContactsRequest", + "required": "true" + } + ], + "return": "BulkContactsResponse" + }, + "POST /api/v2/externalcontacts/bulk/notes": { + "operationId": "postexternalcontactsbulknotes", + "functionName": "postExternalcontactsBulkNotes", + "signature": "postExternalcontactsBulkNotes(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkFetchNotesResponse" + }, + "POST /api/v2/externalcontacts/bulk/notes/add": { + "operationId": "postexternalcontactsbulknotesadd", + "functionName": "postExternalcontactsBulkNotesAdd", + "signature": "postExternalcontactsBulkNotesAdd(body)", + "parameters": [ + { + "name": "body", + "type": "BulkNotesRequest", + "required": "true" + } + ], + "return": "BulkNotesResponse" + }, + "POST /api/v2/externalcontacts/bulk/notes/remove": { + "operationId": "postexternalcontactsbulknotesremove", + "functionName": "postExternalcontactsBulkNotesRemove", + "signature": "postExternalcontactsBulkNotesRemove(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkDeleteResponse" + }, + "POST /api/v2/externalcontacts/bulk/notes/update": { + "operationId": "postexternalcontactsbulknotesupdate", + "functionName": "postExternalcontactsBulkNotesUpdate", + "signature": "postExternalcontactsBulkNotesUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "BulkNotesRequest", + "required": "true" + } + ], + "return": "BulkNotesResponse" + }, + "POST /api/v2/externalcontacts/bulk/organizations": { + "operationId": "postexternalcontactsbulkorganizations", + "functionName": "postExternalcontactsBulkOrganizations", + "signature": "postExternalcontactsBulkOrganizations(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkFetchOrganizationsResponse" + }, + "POST /api/v2/externalcontacts/bulk/organizations/add": { + "operationId": "postexternalcontactsbulkorganizationsadd", + "functionName": "postExternalcontactsBulkOrganizationsAdd", + "signature": "postExternalcontactsBulkOrganizationsAdd(body)", + "parameters": [ + { + "name": "body", + "type": "BulkOrganizationsRequest", + "required": "true" + } + ], + "return": "BulkOrganizationsResponse" + }, + "POST /api/v2/externalcontacts/bulk/organizations/remove": { + "operationId": "postexternalcontactsbulkorganizationsremove", + "functionName": "postExternalcontactsBulkOrganizationsRemove", + "signature": "postExternalcontactsBulkOrganizationsRemove(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkDeleteResponse" + }, + "POST /api/v2/externalcontacts/bulk/organizations/update": { + "operationId": "postexternalcontactsbulkorganizationsupdate", + "functionName": "postExternalcontactsBulkOrganizationsUpdate", + "signature": "postExternalcontactsBulkOrganizationsUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "BulkOrganizationsRequest", + "required": "true" + } + ], + "return": "BulkOrganizationsResponse" + }, + "POST /api/v2/externalcontacts/bulk/relationships": { + "operationId": "postexternalcontactsbulkrelationships", + "functionName": "postExternalcontactsBulkRelationships", + "signature": "postExternalcontactsBulkRelationships(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkFetchRelationshipsResponse" + }, + "POST /api/v2/externalcontacts/bulk/relationships/add": { + "operationId": "postexternalcontactsbulkrelationshipsadd", + "functionName": "postExternalcontactsBulkRelationshipsAdd", + "signature": "postExternalcontactsBulkRelationshipsAdd(body)", + "parameters": [ + { + "name": "body", + "type": "BulkRelationshipsRequest", + "required": "true" + } + ], + "return": "BulkRelationshipsResponse" + }, + "POST /api/v2/externalcontacts/bulk/relationships/remove": { + "operationId": "postexternalcontactsbulkrelationshipsremove", + "functionName": "postExternalcontactsBulkRelationshipsRemove", + "signature": "postExternalcontactsBulkRelationshipsRemove(body)", + "parameters": [ + { + "name": "body", + "type": "BulkIdsRequest", + "required": "true" + } + ], + "return": "BulkDeleteResponse" + }, + "POST /api/v2/externalcontacts/bulk/relationships/update": { + "operationId": "postexternalcontactsbulkrelationshipsupdate", + "functionName": "postExternalcontactsBulkRelationshipsUpdate", + "signature": "postExternalcontactsBulkRelationshipsUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "BulkRelationshipsRequest", + "required": "true" + } + ], + "return": "BulkRelationshipsResponse" + }, + "POST /api/v2/externalcontacts/contacts/{contactId}/notes": { + "operationId": "postexternalcontactscontactnotes", + "functionName": "postExternalcontactsContactNotes", + "signature": "postExternalcontactsContactNotes(contactId, body)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Note", + "required": "true" + } + ], + "return": "Note" + }, + "POST /api/v2/externalcontacts/contacts/{contactId}/promotion": { + "operationId": "postexternalcontactscontactpromotion", + "functionName": "postExternalcontactsContactPromotion", + "signature": "postExternalcontactsContactPromotion(contactId)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + } + ], + "return": "ExternalContact" + }, + "POST /api/v2/externalcontacts/contacts": { + "operationId": "postexternalcontactscontacts", + "functionName": "postExternalcontactsContacts", + "signature": "postExternalcontactsContacts(body)", + "parameters": [ + { + "name": "body", + "type": "ExternalContact", + "required": "true" + } + ], + "return": "ExternalContact" + }, + "POST /api/v2/externalcontacts/contacts/schemas": { + "operationId": "postexternalcontactscontactsschemas", + "functionName": "postExternalcontactsContactsSchemas", + "signature": "postExternalcontactsContactsSchemas(body)", + "parameters": [ + { + "name": "body", + "type": "DataSchema", + "required": "true" + } + ], + "return": "DataSchema" + }, + "POST /api/v2/externalcontacts/identifierlookup": { + "operationId": "postexternalcontactsidentifierlookup", + "functionName": "postExternalcontactsIdentifierlookup", + "signature": "postExternalcontactsIdentifierlookup(identifier)", + "parameters": [ + { + "name": "identifier", + "type": "ContactIdentifier", + "required": "true" + } + ], + "return": "ExternalContact" + }, + "POST /api/v2/externalcontacts/merge/contacts": { + "operationId": "postexternalcontactsmergecontacts", + "functionName": "postExternalcontactsMergeContacts", + "signature": "postExternalcontactsMergeContacts(body)", + "parameters": [ + { + "name": "body", + "type": "MergeRequest", + "required": "true" + } + ], + "return": "ExternalContact" + }, + "POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes": { + "operationId": "postexternalcontactsorganizationnotes", + "functionName": "postExternalcontactsOrganizationNotes", + "signature": "postExternalcontactsOrganizationNotes(externalOrganizationId, body)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Note", + "required": "true" + } + ], + "return": "Note" + }, + "POST /api/v2/externalcontacts/organizations": { + "operationId": "postexternalcontactsorganizations", + "functionName": "postExternalcontactsOrganizations", + "signature": "postExternalcontactsOrganizations(body)", + "parameters": [ + { + "name": "body", + "type": "ExternalOrganization", + "required": "true" + } + ], + "return": "ExternalOrganization" + }, + "POST /api/v2/externalcontacts/organizations/schemas": { + "operationId": "postexternalcontactsorganizationsschemas", + "functionName": "postExternalcontactsOrganizationsSchemas", + "signature": "postExternalcontactsOrganizationsSchemas(body)", + "parameters": [ + { + "name": "body", + "type": "DataSchema", + "required": "true" + } + ], + "return": "DataSchema" + }, + "POST /api/v2/externalcontacts/relationships": { + "operationId": "postexternalcontactsrelationships", + "functionName": "postExternalcontactsRelationships", + "signature": "postExternalcontactsRelationships(body)", + "parameters": [ + { + "name": "body", + "type": "Relationship", + "required": "true" + } + ], + "return": "Relationship" + }, + "PUT /api/v2/externalcontacts/contacts/{contactId}": { + "operationId": "putexternalcontactscontact", + "functionName": "putExternalcontactsContact", + "signature": "putExternalcontactsContact(contactId, body)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExternalContact", + "required": "true" + } + ], + "return": "ExternalContact" + }, + "PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}": { + "operationId": "putexternalcontactscontactnote", + "functionName": "putExternalcontactsContactNote", + "signature": "putExternalcontactsContactNote(contactId, noteId, body)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Note", + "required": "true" + } + ], + "return": "Note" + }, + "PUT /api/v2/externalcontacts/contacts/schemas/{schemaId}": { + "operationId": "putexternalcontactscontactsschema", + "functionName": "putExternalcontactsContactsSchema", + "signature": "putExternalcontactsContactsSchema(schemaId, body)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DataSchema", + "required": "true" + } + ], + "return": "DataSchema" + }, + "PUT /api/v2/externalcontacts/conversations/{conversationId}": { + "operationId": "putexternalcontactsconversation", + "functionName": "putExternalcontactsConversation", + "signature": "putExternalcontactsConversation(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ConversationAssociation", + "required": "true" + } + ] + }, + "PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}": { + "operationId": "putexternalcontactsorganization", + "functionName": "putExternalcontactsOrganization", + "signature": "putExternalcontactsOrganization(externalOrganizationId, body)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExternalOrganization", + "required": "true" + } + ], + "return": "ExternalOrganization" + }, + "PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}": { + "operationId": "putexternalcontactsorganizationnote", + "functionName": "putExternalcontactsOrganizationNote", + "signature": "putExternalcontactsOrganizationNote(externalOrganizationId, noteId, body)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "noteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Note", + "required": "true" + } + ], + "return": "Note" + }, + "PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}": { + "operationId": "putexternalcontactsorganizationtrustortrustorid", + "functionName": "putExternalcontactsOrganizationTrustorTrustorId", + "signature": "putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId, trustorId)", + "parameters": [ + { + "name": "externalOrganizationId", + "type": "String", + "required": "true" + }, + { + "name": "trustorId", + "type": "String", + "required": "true" + } + ], + "return": "ExternalOrganizationTrustorLink" + }, + "PUT /api/v2/externalcontacts/organizations/schemas/{schemaId}": { + "operationId": "putexternalcontactsorganizationsschema", + "functionName": "putExternalcontactsOrganizationsSchema", + "signature": "putExternalcontactsOrganizationsSchema(schemaId, body)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DataSchema", + "required": "true" + } + ], + "return": "DataSchema" + }, + "PUT /api/v2/externalcontacts/relationships/{relationshipId}": { + "operationId": "putexternalcontactsrelationship", + "functionName": "putExternalcontactsRelationship", + "signature": "putExternalcontactsRelationship(relationshipId, body)", + "parameters": [ + { + "name": "relationshipId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Relationship", + "required": "true" + } + ], + "return": "Relationship" + } + +} \ No newline at end of file diff --git a/build/docs/FaxAPI.json b/build/docs/FaxAPI.json new file mode 100644 index 000000000..9c9c62417 --- /dev/null +++ b/build/docs/FaxAPI.json @@ -0,0 +1,84 @@ +{ + "DELETE /api/v2/fax/documents/{documentId}": { + "operationId": "deletefaxdocument", + "functionName": "deleteFaxDocument", + "signature": "deleteFaxDocument(documentId)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/fax/documents/{documentId}": { + "operationId": "getfaxdocument", + "functionName": "getFaxDocument", + "signature": "getFaxDocument(documentId)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + } + ], + "return": "FaxDocument" + }, + "GET /api/v2/fax/documents/{documentId}/content": { + "operationId": "getfaxdocumentcontent", + "functionName": "getFaxDocumentContent", + "signature": "getFaxDocumentContent(documentId)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + } + ], + "return": "DownloadResponse" + }, + "GET /api/v2/fax/documents": { + "operationId": "getfaxdocuments", + "functionName": "getFaxDocuments", + "signature": "getFaxDocuments(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "FaxDocumentEntityListing" + }, + "GET /api/v2/fax/summary": { + "operationId": "getfaxsummary", + "functionName": "getFaxSummary", + "signature": "getFaxSummary()", + + "return": "FaxSummary" + }, + "PUT /api/v2/fax/documents/{documentId}": { + "operationId": "putfaxdocument", + "functionName": "putFaxDocument", + "signature": "putFaxDocument(documentId, body)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "FaxDocument", + "required": "true" + } + ], + "return": "FaxDocument" + } + +} \ No newline at end of file diff --git a/build/docs/FlowsAPI.json b/build/docs/FlowsAPI.json new file mode 100644 index 000000000..2fe0399e3 --- /dev/null +++ b/build/docs/FlowsAPI.json @@ -0,0 +1,29 @@ +{ + "POST /api/v2/analytics/flows/aggregates/query": { + "operationId": "postanalyticsflowsaggregatesquery", + "functionName": "postAnalyticsFlowsAggregatesQuery", + "signature": "postAnalyticsFlowsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "FlowAggregationQuery", + "required": "true" + } + ], + "return": "FlowAggregateQueryResponse" + }, + "POST /api/v2/analytics/flows/observations/query": { + "operationId": "postanalyticsflowsobservationsquery", + "functionName": "postAnalyticsFlowsObservationsQuery", + "signature": "postAnalyticsFlowsObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "FlowObservationQuery", + "required": "true" + } + ], + "return": "FlowObservationQueryResponse" + } + +} \ No newline at end of file diff --git a/build/docs/GamificationAPI.json b/build/docs/GamificationAPI.json new file mode 100644 index 000000000..2d4bdd61e --- /dev/null +++ b/build/docs/GamificationAPI.json @@ -0,0 +1,1390 @@ +{ + "DELETE /api/v2/employeeperformance/externalmetrics/definitions/{metricId}": { + "operationId": "deleteemployeeperformanceexternalmetricsdefinition", + "functionName": "deleteEmployeeperformanceExternalmetricsDefinition", + "signature": "deleteEmployeeperformanceExternalmetricsDefinition(metricId)", + "parameters": [ + { + "name": "metricId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/employeeperformance/externalmetrics/definitions/{metricId}": { + "operationId": "getemployeeperformanceexternalmetricsdefinition", + "functionName": "getEmployeeperformanceExternalmetricsDefinition", + "signature": "getEmployeeperformanceExternalmetricsDefinition(metricId)", + "parameters": [ + { + "name": "metricId", + "type": "String", + "required": "true" + } + ], + "return": "ExternalMetricDefinition" + }, + "GET /api/v2/employeeperformance/externalmetrics/definitions": { + "operationId": "getemployeeperformanceexternalmetricsdefinitions", + "functionName": "getEmployeeperformanceExternalmetricsDefinitions", + "signature": "getEmployeeperformanceExternalmetricsDefinitions(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "ExternalMetricDefinitionListing" + }, + "GET /api/v2/gamification/insights": { + "operationId": "getgamificationinsights", + "functionName": "getGamificationInsights", + "signature": "getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, pageSize, pageNumber, sortKey, sortMetricId, sortOrder, userIds)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortKey", + "type": "String", + "required": "false" + }, + { + "name": "sortMetricId", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "userIds", + "type": "String", + "required": "false" + } + ], + "return": "InsightsSummary" + }, + "GET /api/v2/gamification/insights/details": { + "operationId": "getgamificationinsightsdetails", + "functionName": "getGamificationInsightsDetails", + "signature": "getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "InsightsDetails" + }, + "GET /api/v2/gamification/insights/groups/trends": { + "operationId": "getgamificationinsightsgroupstrends", + "functionName": "getGamificationInsightsGroupsTrends", + "signature": "getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "comparativePeriodEndWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodEndWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "InsightsTrend" + }, + "GET /api/v2/gamification/insights/groups/trends/all": { + "operationId": "getgamificationinsightsgroupstrendsall", + "functionName": "getGamificationInsightsGroupsTrendsAll", + "signature": "getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "comparativePeriodEndWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodEndWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "InsightsTrend" + }, + "GET /api/v2/gamification/insights/members": { + "operationId": "getgamificationinsightsmembers", + "functionName": "getGamificationInsightsMembers", + "signature": "getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "InsightsAgents" + }, + "GET /api/v2/gamification/insights/trends": { + "operationId": "getgamificationinsightstrends", + "functionName": "getGamificationInsightsTrends", + "signature": "getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "comparativePeriodEndWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodEndWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "UserInsightsTrend" + }, + "GET /api/v2/gamification/insights/users/{userId}/details": { + "operationId": "getgamificationinsightsuserdetails", + "functionName": "getGamificationInsightsUserDetails", + "signature": "getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "InsightsDetails" + }, + "GET /api/v2/gamification/insights/users/{userId}/trends": { + "operationId": "getgamificationinsightsusertrends", + "functionName": "getGamificationInsightsUserTrends", + "signature": "getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "granularity", + "type": "String", + "required": "true" + }, + { + "name": "comparativePeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "comparativePeriodEndWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodStartWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "primaryPeriodEndWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "UserInsightsTrend" + }, + "GET /api/v2/gamification/leaderboard": { + "operationId": "getgamificationleaderboard", + "functionName": "getGamificationLeaderboard", + "signature": "getGamificationLeaderboard(startWorkday, endWorkday, metricId)", + "parameters": [ + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "false" + } + ], + "return": "Leaderboard" + }, + "GET /api/v2/gamification/leaderboard/all": { + "operationId": "getgamificationleaderboardall", + "functionName": "getGamificationLeaderboardAll", + "signature": "getGamificationLeaderboardAll(filterType, filterId, startWorkday, endWorkday, metricId)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "false" + } + ], + "return": "Leaderboard" + }, + "GET /api/v2/gamification/leaderboard/all/bestpoints": { + "operationId": "getgamificationleaderboardallbestpoints", + "functionName": "getGamificationLeaderboardAllBestpoints", + "signature": "getGamificationLeaderboardAllBestpoints(filterType, filterId)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + } + ], + "return": "OverallBestPoints" + }, + "GET /api/v2/gamification/leaderboard/bestpoints": { + "operationId": "getgamificationleaderboardbestpoints", + "functionName": "getGamificationLeaderboardBestpoints", + "signature": "getGamificationLeaderboardBestpoints()", + + "return": "OverallBestPoints" + }, + "GET /api/v2/gamification/metricdefinitions/{metricDefinitionId}": { + "operationId": "getgamificationmetricdefinition", + "functionName": "getGamificationMetricdefinition", + "signature": "getGamificationMetricdefinition(metricDefinitionId)", + "parameters": [ + { + "name": "metricDefinitionId", + "type": "String", + "required": "true" + } + ], + "return": "MetricDefinition" + }, + "GET /api/v2/gamification/metricdefinitions": { + "operationId": "getgamificationmetricdefinitions", + "functionName": "getGamificationMetricdefinitions", + "signature": "getGamificationMetricdefinitions()", + + "return": "GetMetricDefinitionsResponse" + }, + "GET /api/v2/gamification/profiles/{profileId}": { + "operationId": "getgamificationprofile", + "functionName": "getGamificationProfile", + "signature": "getGamificationProfile(profileId)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + } + ], + "return": "PerformanceProfile" + }, + "GET /api/v2/gamification/profiles/{profileId}/members": { + "operationId": "getgamificationprofilemembers", + "functionName": "getGamificationProfileMembers", + "signature": "getGamificationProfileMembers(profileId)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + } + ], + "return": "MemberListing" + }, + "GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId}": { + "operationId": "getgamificationprofilemetric", + "functionName": "getGamificationProfileMetric", + "signature": "getGamificationProfileMetric(profileId, metricId, workday)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "false" + } + ], + "return": "Metric" + }, + "GET /api/v2/gamification/profiles/{profileId}/metrics": { + "operationId": "getgamificationprofilemetrics", + "functionName": "getGamificationProfileMetrics", + "signature": "getGamificationProfileMetrics(profileId, expand, workday, metricIds)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "workday", + "type": "Date", + "required": "false" + }, + { + "name": "metricIds", + "type": "String", + "required": "false" + } + ], + "return": "GetMetricResponse" + }, + "GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails": { + "operationId": "getgamificationprofilemetricsobjectivedetails", + "functionName": "getGamificationProfileMetricsObjectivedetails", + "signature": "getGamificationProfileMetricsObjectivedetails(profileId, workday)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "false" + } + ], + "return": "GetMetricsResponse" + }, + "GET /api/v2/gamification/profiles": { + "operationId": "getgamificationprofiles", + "functionName": "getGamificationProfiles", + "signature": "getGamificationProfiles()", + + "return": "GetProfilesResponse" + }, + "GET /api/v2/gamification/profiles/users/{userId}": { + "operationId": "getgamificationprofilesuser", + "functionName": "getGamificationProfilesUser", + "signature": "getGamificationProfilesUser(userId, workday)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "false" + } + ], + "return": "PerformanceProfile" + }, + "GET /api/v2/gamification/profiles/users/me": { + "operationId": "getgamificationprofilesusersme", + "functionName": "getGamificationProfilesUsersMe", + "signature": "getGamificationProfilesUsersMe(workday)", + "parameters": [ + { + "name": "workday", + "type": "Date", + "required": "false" + } + ], + "return": "PerformanceProfile" + }, + "GET /api/v2/gamification/scorecards": { + "operationId": "getgamificationscorecards", + "functionName": "getGamificationScorecards", + "signature": "getGamificationScorecards(workday, expand)", + "parameters": [ + { + "name": "workday", + "type": "Date", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkdayMetricListing" + }, + "GET /api/v2/gamification/scorecards/attendance": { + "operationId": "getgamificationscorecardsattendance", + "functionName": "getGamificationScorecardsAttendance", + "signature": "getGamificationScorecardsAttendance(startWorkday, endWorkday)", + "parameters": [ + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "AttendanceStatusListing" + }, + "GET /api/v2/gamification/scorecards/bestpoints": { + "operationId": "getgamificationscorecardsbestpoints", + "functionName": "getGamificationScorecardsBestpoints", + "signature": "getGamificationScorecardsBestpoints()", + + "return": "UserBestPoints" + }, + "GET /api/v2/gamification/scorecards/points/alltime": { + "operationId": "getgamificationscorecardspointsalltime", + "functionName": "getGamificationScorecardsPointsAlltime", + "signature": "getGamificationScorecardsPointsAlltime(endWorkday)", + "parameters": [ + { + "name": "endWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "AllTimePoints" + }, + "GET /api/v2/gamification/scorecards/points/average": { + "operationId": "getgamificationscorecardspointsaverage", + "functionName": "getGamificationScorecardsPointsAverage", + "signature": "getGamificationScorecardsPointsAverage(workday)", + "parameters": [ + { + "name": "workday", + "type": "Date", + "required": "true" + } + ], + "return": "SingleWorkdayAveragePoints" + }, + "GET /api/v2/gamification/scorecards/points/trends": { + "operationId": "getgamificationscorecardspointstrends", + "functionName": "getGamificationScorecardsPointsTrends", + "signature": "getGamificationScorecardsPointsTrends(startWorkday, endWorkday, dayOfWeek)", + "parameters": [ + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "dayOfWeek", + "type": "String", + "required": "false" + } + ], + "return": "WorkdayPointsTrend" + }, + "GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends": { + "operationId": "getgamificationscorecardsprofilemetricuservaluestrends", + "functionName": "getGamificationScorecardsProfileMetricUserValuesTrends", + "signature": "getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, referenceWorkday, timeZone)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "referenceWorkday", + "type": "Date", + "required": "false" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "MetricValueTrendAverage" + }, + "GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends": { + "operationId": "getgamificationscorecardsprofilemetricusersvaluestrends", + "functionName": "getGamificationScorecardsProfileMetricUsersValuesTrends", + "signature": "getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, filterId, referenceWorkday, timeZone)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "false" + }, + { + "name": "referenceWorkday", + "type": "Date", + "required": "false" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "MetricValueTrendAverage" + }, + "GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends": { + "operationId": "getgamificationscorecardsprofilemetricvaluestrends", + "functionName": "getGamificationScorecardsProfileMetricValuesTrends", + "signature": "getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, filterType, referenceWorkday, timeZone)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "referenceWorkday", + "type": "Date", + "required": "false" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "MetricValueTrendAverage" + }, + "GET /api/v2/gamification/scorecards/users/{userId}": { + "operationId": "getgamificationscorecardsuser", + "functionName": "getGamificationScorecardsUser", + "signature": "getGamificationScorecardsUser(userId, workday, expand)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkdayMetricListing" + }, + "GET /api/v2/gamification/scorecards/users/{userId}/attendance": { + "operationId": "getgamificationscorecardsuserattendance", + "functionName": "getGamificationScorecardsUserAttendance", + "signature": "getGamificationScorecardsUserAttendance(userId, startWorkday, endWorkday)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "AttendanceStatusListing" + }, + "GET /api/v2/gamification/scorecards/users/{userId}/bestpoints": { + "operationId": "getgamificationscorecardsuserbestpoints", + "functionName": "getGamificationScorecardsUserBestpoints", + "signature": "getGamificationScorecardsUserBestpoints(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "UserBestPoints" + }, + "GET /api/v2/gamification/scorecards/users/{userId}/points/alltime": { + "operationId": "getgamificationscorecardsuserpointsalltime", + "functionName": "getGamificationScorecardsUserPointsAlltime", + "signature": "getGamificationScorecardsUserPointsAlltime(userId, endWorkday)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + } + ], + "return": "AllTimePoints" + }, + "GET /api/v2/gamification/scorecards/users/{userId}/points/trends": { + "operationId": "getgamificationscorecardsuserpointstrends", + "functionName": "getGamificationScorecardsUserPointsTrends", + "signature": "getGamificationScorecardsUserPointsTrends(userId, startWorkday, endWorkday, dayOfWeek)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "dayOfWeek", + "type": "String", + "required": "false" + } + ], + "return": "WorkdayPointsTrend" + }, + "GET /api/v2/gamification/scorecards/users/{userId}/values/trends": { + "operationId": "getgamificationscorecardsuservaluestrends", + "functionName": "getGamificationScorecardsUserValuesTrends", + "signature": "getGamificationScorecardsUserValuesTrends(userId, startWorkday, endWorkday, timeZone)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "WorkdayValuesTrend" + }, + "GET /api/v2/gamification/scorecards/users/points/average": { + "operationId": "getgamificationscorecardsuserspointsaverage", + "functionName": "getGamificationScorecardsUsersPointsAverage", + "signature": "getGamificationScorecardsUsersPointsAverage(filterType, filterId, workday)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "true" + } + ], + "return": "SingleWorkdayAveragePoints" + }, + "GET /api/v2/gamification/scorecards/users/values/average": { + "operationId": "getgamificationscorecardsusersvaluesaverage", + "functionName": "getGamificationScorecardsUsersValuesAverage", + "signature": "getGamificationScorecardsUsersValuesAverage(filterType, filterId, workday, timeZone)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "workday", + "type": "Date", + "required": "true" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "SingleWorkdayAverageValues" + }, + "GET /api/v2/gamification/scorecards/users/values/trends": { + "operationId": "getgamificationscorecardsusersvaluestrends", + "functionName": "getGamificationScorecardsUsersValuesTrends", + "signature": "getGamificationScorecardsUsersValuesTrends(filterType, filterId, startWorkday, endWorkday, timeZone)", + "parameters": [ + { + "name": "filterType", + "type": "String", + "required": "true" + }, + { + "name": "filterId", + "type": "String", + "required": "true" + }, + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "WorkdayValuesTrend" + }, + "GET /api/v2/gamification/scorecards/values/average": { + "operationId": "getgamificationscorecardsvaluesaverage", + "functionName": "getGamificationScorecardsValuesAverage", + "signature": "getGamificationScorecardsValuesAverage(workday, timeZone)", + "parameters": [ + { + "name": "workday", + "type": "Date", + "required": "true" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "SingleWorkdayAverageValues" + }, + "GET /api/v2/gamification/scorecards/values/trends": { + "operationId": "getgamificationscorecardsvaluestrends", + "functionName": "getGamificationScorecardsValuesTrends", + "signature": "getGamificationScorecardsValuesTrends(startWorkday, endWorkday, filterType, referenceWorkday, timeZone)", + "parameters": [ + { + "name": "startWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "endWorkday", + "type": "Date", + "required": "true" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "referenceWorkday", + "type": "Date", + "required": "false" + }, + { + "name": "timeZone", + "type": "String", + "required": "false" + } + ], + "return": "WorkdayValuesTrend" + }, + "GET /api/v2/gamification/status": { + "operationId": "getgamificationstatus", + "functionName": "getGamificationStatus", + "signature": "getGamificationStatus()", + + "return": "GamificationStatus" + }, + "GET /api/v2/gamification/templates/{templateId}": { + "operationId": "getgamificationtemplate", + "functionName": "getGamificationTemplate", + "signature": "getGamificationTemplate(templateId)", + "parameters": [ + { + "name": "templateId", + "type": "String", + "required": "true" + } + ], + "return": "ObjectiveTemplate" + }, + "GET /api/v2/gamification/templates": { + "operationId": "getgamificationtemplates", + "functionName": "getGamificationTemplates", + "signature": "getGamificationTemplates()", + + "return": "GetTemplatesResponse" + }, + "PATCH /api/v2/employeeperformance/externalmetrics/definitions/{metricId}": { + "operationId": "patchemployeeperformanceexternalmetricsdefinition", + "functionName": "patchEmployeeperformanceExternalmetricsDefinition", + "signature": "patchEmployeeperformanceExternalmetricsDefinition(metricId, body)", + "parameters": [ + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExternalMetricDefinitionUpdateRequest", + "required": "true" + } + ], + "return": "ExternalMetricDefinition" + }, + "POST /api/v2/employeeperformance/externalmetrics/data": { + "operationId": "postemployeeperformanceexternalmetricsdata", + "functionName": "postEmployeeperformanceExternalmetricsData", + "signature": "postEmployeeperformanceExternalmetricsData(body)", + "parameters": [ + { + "name": "body", + "type": "ExternalMetricDataWriteRequest", + "required": "false" + } + ], + "return": "ExternalMetricDataWriteResponse" + }, + "POST /api/v2/employeeperformance/externalmetrics/definitions": { + "operationId": "postemployeeperformanceexternalmetricsdefinitions", + "functionName": "postEmployeeperformanceExternalmetricsDefinitions", + "signature": "postEmployeeperformanceExternalmetricsDefinitions(body)", + "parameters": [ + { + "name": "body", + "type": "ExternalMetricDefinitionCreateRequest", + "required": "false" + } + ], + "return": "ExternalMetricDefinition" + }, + "POST /api/v2/gamification/profiles/{profileId}/activate": { + "operationId": "postgamificationprofileactivate", + "functionName": "postGamificationProfileActivate", + "signature": "postGamificationProfileActivate(profileId)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + } + ], + "return": "PerformanceProfile" + }, + "POST /api/v2/gamification/profiles/{profileId}/deactivate": { + "operationId": "postgamificationprofiledeactivate", + "functionName": "postGamificationProfileDeactivate", + "signature": "postGamificationProfileDeactivate(profileId)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + } + ], + "return": "PerformanceProfile" + }, + "POST /api/v2/gamification/profiles/{profileId}/members": { + "operationId": "postgamificationprofilemembers", + "functionName": "postGamificationProfileMembers", + "signature": "postGamificationProfileMembers(profileId, body)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AssignUsers", + "required": "true" + } + ], + "return": "Assignment" + }, + "POST /api/v2/gamification/profiles/{profileId}/members/validate": { + "operationId": "postgamificationprofilemembersvalidate", + "functionName": "postGamificationProfileMembersValidate", + "signature": "postGamificationProfileMembersValidate(profileId, body)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ValidateAssignUsers", + "required": "true" + } + ], + "return": "AssignmentValidation" + }, + "POST /api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link": { + "operationId": "postgamificationprofilemetriclink", + "functionName": "postGamificationProfileMetricLink", + "signature": "postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body)", + "parameters": [ + { + "name": "sourceProfileId", + "type": "String", + "required": "true" + }, + { + "name": "sourceMetricId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TargetPerformanceProfile", + "required": "true" + } + ], + "return": "Metric" + }, + "POST /api/v2/gamification/profiles/{profileId}/metrics": { + "operationId": "postgamificationprofilemetrics", + "functionName": "postGamificationProfileMetrics", + "signature": "postGamificationProfileMetrics(profileId, body)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateMetric", + "required": "true" + } + ], + "return": "Metric" + }, + "POST /api/v2/gamification/profiles": { + "operationId": "postgamificationprofiles", + "functionName": "postGamificationProfiles", + "signature": "postGamificationProfiles(body, copyMetrics)", + "parameters": [ + { + "name": "body", + "type": "CreatePerformanceProfile", + "required": "true" + }, + { + "name": "copyMetrics", + "type": "Bool", + "required": "false" + } + ], + "return": "PerformanceProfile" + }, + "POST /api/v2/gamification/profiles/users/{userId}/query": { + "operationId": "postgamificationprofilesuserquery", + "functionName": "postGamificationProfilesUserQuery", + "signature": "postGamificationProfilesUserQuery(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserProfilesInDateRangeRequest", + "required": "true" + } + ], + "return": "UserProfilesInDateRange" + }, + "POST /api/v2/gamification/profiles/users/me/query": { + "operationId": "postgamificationprofilesusersmequery", + "functionName": "postGamificationProfilesUsersMeQuery", + "signature": "postGamificationProfilesUsersMeQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserProfilesInDateRangeRequest", + "required": "true" + } + ], + "return": "UserProfilesInDateRange" + }, + "PUT /api/v2/gamification/profiles/{profileId}": { + "operationId": "putgamificationprofile", + "functionName": "putGamificationProfile", + "signature": "putGamificationProfile(profileId, body)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PerformanceProfile", + "required": "false" + } + ], + "return": "PerformanceProfile" + }, + "PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId}": { + "operationId": "putgamificationprofilemetric", + "functionName": "putGamificationProfileMetric", + "signature": "putGamificationProfileMetric(profileId, metricId, body)", + "parameters": [ + { + "name": "profileId", + "type": "String", + "required": "true" + }, + { + "name": "metricId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateMetric", + "required": "true" + } + ], + "return": "Metric" + }, + "PUT /api/v2/gamification/status": { + "operationId": "putgamificationstatus", + "functionName": "putGamificationStatus", + "signature": "putGamificationStatus(status)", + "parameters": [ + { + "name": "status", + "type": "GamificationStatus", + "required": "true" + } + ], + "return": "GamificationStatus" + } + +} \ No newline at end of file diff --git a/build/docs/GeneralDataProtectionRegulationAPI.json b/build/docs/GeneralDataProtectionRegulationAPI.json new file mode 100644 index 000000000..5e46fd4bc --- /dev/null +++ b/build/docs/GeneralDataProtectionRegulationAPI.json @@ -0,0 +1,70 @@ +{ + "GET /api/v2/gdpr/requests/{requestId}": { + "operationId": "getgdprrequest", + "functionName": "getGdprRequest", + "signature": "getGdprRequest(requestId)", + "parameters": [ + { + "name": "requestId", + "type": "String", + "required": "true" + } + ], + "return": "GDPRRequest" + }, + "GET /api/v2/gdpr/requests": { + "operationId": "getgdprrequests", + "functionName": "getGdprRequests", + "signature": "getGdprRequests(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "GDPRRequestEntityListing" + }, + "GET /api/v2/gdpr/subjects": { + "operationId": "getgdprsubjects", + "functionName": "getGdprSubjects", + "signature": "getGdprSubjects(searchType, searchValue)", + "parameters": [ + { + "name": "searchType", + "type": "String", + "required": "true" + }, + { + "name": "searchValue", + "type": "String", + "required": "true" + } + ], + "return": "GDPRSubjectEntityListing" + }, + "POST /api/v2/gdpr/requests": { + "operationId": "postgdprrequests", + "functionName": "postGdprRequests", + "signature": "postGdprRequests(body, deleteConfirmed)", + "parameters": [ + { + "name": "body", + "type": "GDPRRequest", + "required": "true" + }, + { + "name": "deleteConfirmed", + "type": "Bool", + "required": "false" + } + ], + "return": "GDPRRequest" + } + +} \ No newline at end of file diff --git a/build/docs/GeolocationAPI.json b/build/docs/GeolocationAPI.json new file mode 100644 index 000000000..9bef6337b --- /dev/null +++ b/build/docs/GeolocationAPI.json @@ -0,0 +1,64 @@ +{ + "GET /api/v2/geolocations/settings": { + "operationId": "getgeolocationssettings", + "functionName": "getGeolocationsSettings", + "signature": "getGeolocationsSettings()", + + "return": "GeolocationSettings" + }, + "GET /api/v2/users/{userId}/geolocations/{clientId}": { + "operationId": "getusergeolocation", + "functionName": "getUserGeolocation", + "signature": "getUserGeolocation(userId, clientId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "Geolocation" + }, + "PATCH /api/v2/geolocations/settings": { + "operationId": "patchgeolocationssettings", + "functionName": "patchGeolocationsSettings", + "signature": "patchGeolocationsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "GeolocationSettings", + "required": "true" + } + ], + "return": "GeolocationSettings" + }, + "PATCH /api/v2/users/{userId}/geolocations/{clientId}": { + "operationId": "patchusergeolocation", + "functionName": "patchUserGeolocation", + "signature": "patchUserGeolocation(userId, clientId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Geolocation", + "required": "true" + } + ], + "return": "Geolocation" + } + +} \ No newline at end of file diff --git a/build/docs/GreetingsAPI.json b/build/docs/GreetingsAPI.json new file mode 100644 index 000000000..5a2ebd498 --- /dev/null +++ b/build/docs/GreetingsAPI.json @@ -0,0 +1,259 @@ +{ + "DELETE /api/v2/greetings/{greetingId}": { + "operationId": "deletegreeting", + "functionName": "deleteGreeting", + "signature": "deleteGreeting(greetingId)", + "parameters": [ + { + "name": "greetingId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/greetings/{greetingId}": { + "operationId": "getgreeting", + "functionName": "getGreeting", + "signature": "getGreeting(greetingId)", + "parameters": [ + { + "name": "greetingId", + "type": "String", + "required": "true" + } + ], + "return": "Greeting" + }, + "GET /api/v2/greetings/{greetingId}/media": { + "operationId": "getgreetingmedia", + "functionName": "getGreetingMedia", + "signature": "getGreetingMedia(greetingId, formatId)", + "parameters": [ + { + "name": "greetingId", + "type": "String", + "required": "true" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + } + ], + "return": "GreetingMediaInfo" + }, + "GET /api/v2/greetings": { + "operationId": "getgreetings", + "functionName": "getGreetings", + "signature": "getGreetings(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "DomainEntityListing" + }, + "GET /api/v2/greetings/defaults": { + "operationId": "getgreetingsdefaults", + "functionName": "getGreetingsDefaults", + "signature": "getGreetingsDefaults()", + + "return": "DefaultGreetingList" + }, + "GET /api/v2/groups/{groupId}/greetings": { + "operationId": "getgroupgreetings", + "functionName": "getGroupGreetings", + "signature": "getGroupGreetings(groupId, pageSize, pageNumber)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "GreetingListing" + }, + "GET /api/v2/groups/{groupId}/greetings/defaults": { + "operationId": "getgroupgreetingsdefaults", + "functionName": "getGroupGreetingsDefaults", + "signature": "getGroupGreetingsDefaults(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ], + "return": "DefaultGreetingList" + }, + "GET /api/v2/users/{userId}/greetings": { + "operationId": "getusergreetings", + "functionName": "getUserGreetings", + "signature": "getUserGreetings(userId, pageSize, pageNumber)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "DomainEntityListing" + }, + "GET /api/v2/users/{userId}/greetings/defaults": { + "operationId": "getusergreetingsdefaults", + "functionName": "getUserGreetingsDefaults", + "signature": "getUserGreetingsDefaults(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "DefaultGreetingList" + }, + "POST /api/v2/greetings": { + "operationId": "postgreetings", + "functionName": "postGreetings", + "signature": "postGreetings(body)", + "parameters": [ + { + "name": "body", + "type": "Greeting", + "required": "true" + } + ], + "return": "Greeting" + }, + "POST /api/v2/groups/{groupId}/greetings": { + "operationId": "postgroupgreetings", + "functionName": "postGroupGreetings", + "signature": "postGroupGreetings(groupId, body)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Greeting", + "required": "true" + } + ], + "return": "Greeting" + }, + "POST /api/v2/users/{userId}/greetings": { + "operationId": "postusergreetings", + "functionName": "postUserGreetings", + "signature": "postUserGreetings(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Greeting", + "required": "true" + } + ], + "return": "Greeting" + }, + "PUT /api/v2/greetings/{greetingId}": { + "operationId": "putgreeting", + "functionName": "putGreeting", + "signature": "putGreeting(greetingId, body)", + "parameters": [ + { + "name": "greetingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Greeting", + "required": "true" + } + ], + "return": "Greeting" + }, + "PUT /api/v2/greetings/defaults": { + "operationId": "putgreetingsdefaults", + "functionName": "putGreetingsDefaults", + "signature": "putGreetingsDefaults(body)", + "parameters": [ + { + "name": "body", + "type": "DefaultGreetingList", + "required": "true" + } + ], + "return": "DefaultGreetingList" + }, + "PUT /api/v2/groups/{groupId}/greetings/defaults": { + "operationId": "putgroupgreetingsdefaults", + "functionName": "putGroupGreetingsDefaults", + "signature": "putGroupGreetingsDefaults(groupId, body)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DefaultGreetingList", + "required": "true" + } + ], + "return": "DefaultGreetingList" + }, + "PUT /api/v2/users/{userId}/greetings/defaults": { + "operationId": "putusergreetingsdefaults", + "functionName": "putUserGreetingsDefaults", + "signature": "putUserGreetingsDefaults(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DefaultGreetingList", + "required": "true" + } + ], + "return": "DefaultGreetingList" + } + +} \ No newline at end of file diff --git a/build/docs/GroupsAPI.json b/build/docs/GroupsAPI.json new file mode 100644 index 000000000..b00378f5b --- /dev/null +++ b/build/docs/GroupsAPI.json @@ -0,0 +1,269 @@ +{ + "DELETE /api/v2/groups/{groupId}": { + "operationId": "deletegroup", + "functionName": "deleteGroup", + "signature": "deleteGroup(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/groups/{groupId}/members": { + "operationId": "deletegroupmembers", + "functionName": "deleteGroupMembers", + "signature": "deleteGroupMembers(groupId, ids)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "ids", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "GET /api/v2/fieldconfig": { + "operationId": "getfieldconfig", + "functionName": "getFieldconfig", + "signature": "getFieldconfig(type)", + "parameters": [ + { + "name": "type", + "type": "String", + "required": "true" + } + ], + "return": "FieldConfig" + }, + "GET /api/v2/groups/{groupId}": { + "operationId": "getgroup", + "functionName": "getGroup", + "signature": "getGroup(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ], + "return": "Group" + }, + "GET /api/v2/groups/{groupId}/individuals": { + "operationId": "getgroupindividuals", + "functionName": "getGroupIndividuals", + "signature": "getGroupIndividuals(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ], + "return": "UserEntityListing" + }, + "GET /api/v2/groups/{groupId}/members": { + "operationId": "getgroupmembers", + "functionName": "getGroupMembers", + "signature": "getGroupMembers(groupId, pageSize, pageNumber, sortOrder, expand)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UserEntityListing" + }, + "GET /api/v2/groups/{groupId}/profile": { + "operationId": "getgroupprofile", + "functionName": "getGroupProfile", + "signature": "getGroupProfile(groupId, fields)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "fields", + "type": "String", + "required": "false" + } + ], + "return": "GroupProfile" + }, + "GET /api/v2/groups": { + "operationId": "getgroups", + "functionName": "getGroups", + "signature": "getGroups(pageSize, pageNumber, _id, jabberId, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "jabberId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "GroupEntityListing" + }, + "GET /api/v2/groups/search": { + "operationId": "getgroupssearch", + "functionName": "getGroupsSearch", + "signature": "getGroupsSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "GroupsSearchResponse" + }, + "GET /api/v2/profiles/groups": { + "operationId": "getprofilesgroups", + "functionName": "getProfilesGroups", + "signature": "getProfilesGroups(pageSize, pageNumber, _id, jabberId, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "jabberId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "GroupProfileEntityListing" + }, + "POST /api/v2/groups/{groupId}/members": { + "operationId": "postgroupmembers", + "functionName": "postGroupMembers", + "signature": "postGroupMembers(groupId, body)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "GroupMembersUpdate", + "required": "true" + } + ], + "return": "JSON" + }, + "POST /api/v2/groups": { + "operationId": "postgroups", + "functionName": "postGroups", + "signature": "postGroups(body)", + "parameters": [ + { + "name": "body", + "type": "GroupCreate", + "required": "true" + } + ], + "return": "Group" + }, + "POST /api/v2/groups/search": { + "operationId": "postgroupssearch", + "functionName": "postGroupsSearch", + "signature": "postGroupsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "GroupSearchRequest", + "required": "true" + } + ], + "return": "GroupsSearchResponse" + }, + "PUT /api/v2/groups/{groupId}": { + "operationId": "putgroup", + "functionName": "putGroup", + "signature": "putGroup(groupId, body)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "GroupUpdate", + "required": "false" + } + ], + "return": "Group" + } + +} \ No newline at end of file diff --git a/build/docs/IdentityProviderAPI.json b/build/docs/IdentityProviderAPI.json new file mode 100644 index 000000000..981d66dcd --- /dev/null +++ b/build/docs/IdentityProviderAPI.json @@ -0,0 +1,307 @@ +{ + "DELETE /api/v2/identityproviders/adfs": { + "operationId": "deleteidentityprovidersadfs", + "functionName": "deleteIdentityprovidersAdfs", + "signature": "deleteIdentityprovidersAdfs()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/cic": { + "operationId": "deleteidentityproviderscic", + "functionName": "deleteIdentityprovidersCic", + "signature": "deleteIdentityprovidersCic()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/generic": { + "operationId": "deleteidentityprovidersgeneric", + "functionName": "deleteIdentityprovidersGeneric", + "signature": "deleteIdentityprovidersGeneric()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/gsuite": { + "operationId": "deleteidentityprovidersgsuite", + "functionName": "deleteIdentityprovidersGsuite", + "signature": "deleteIdentityprovidersGsuite()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/identitynow": { + "operationId": "deleteidentityprovidersidentitynow", + "functionName": "deleteIdentityprovidersIdentitynow", + "signature": "deleteIdentityprovidersIdentitynow()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/okta": { + "operationId": "deleteidentityprovidersokta", + "functionName": "deleteIdentityprovidersOkta", + "signature": "deleteIdentityprovidersOkta()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/onelogin": { + "operationId": "deleteidentityprovidersonelogin", + "functionName": "deleteIdentityprovidersOnelogin", + "signature": "deleteIdentityprovidersOnelogin()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/ping": { + "operationId": "deleteidentityprovidersping", + "functionName": "deleteIdentityprovidersPing", + "signature": "deleteIdentityprovidersPing()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/purecloud": { + "operationId": "deleteidentityproviderspurecloud", + "functionName": "deleteIdentityprovidersPurecloud", + "signature": "deleteIdentityprovidersPurecloud()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/pureengage": { + "operationId": "deleteidentityproviderspureengage", + "functionName": "deleteIdentityprovidersPureengage", + "signature": "deleteIdentityprovidersPureengage()", + + "return": "JSON" + }, + "DELETE /api/v2/identityproviders/salesforce": { + "operationId": "deleteidentityproviderssalesforce", + "functionName": "deleteIdentityprovidersSalesforce", + "signature": "deleteIdentityprovidersSalesforce()", + + "return": "JSON" + }, + "GET /api/v2/identityproviders": { + "operationId": "getidentityproviders", + "functionName": "getIdentityproviders", + "signature": "getIdentityproviders()", + + "return": "OAuthProviderEntityListing" + }, + "GET /api/v2/identityproviders/adfs": { + "operationId": "getidentityprovidersadfs", + "functionName": "getIdentityprovidersAdfs", + "signature": "getIdentityprovidersAdfs()", + + "return": "ADFS" + }, + "GET /api/v2/identityproviders/cic": { + "operationId": "getidentityproviderscic", + "functionName": "getIdentityprovidersCic", + "signature": "getIdentityprovidersCic()", + + "return": "CustomerInteractionCenter" + }, + "GET /api/v2/identityproviders/generic": { + "operationId": "getidentityprovidersgeneric", + "functionName": "getIdentityprovidersGeneric", + "signature": "getIdentityprovidersGeneric()", + + "return": "GenericSAML" + }, + "GET /api/v2/identityproviders/gsuite": { + "operationId": "getidentityprovidersgsuite", + "functionName": "getIdentityprovidersGsuite", + "signature": "getIdentityprovidersGsuite()", + + "return": "GSuite" + }, + "GET /api/v2/identityproviders/identitynow": { + "operationId": "getidentityprovidersidentitynow", + "functionName": "getIdentityprovidersIdentitynow", + "signature": "getIdentityprovidersIdentitynow()", + + "return": "IdentityNow" + }, + "GET /api/v2/identityproviders/okta": { + "operationId": "getidentityprovidersokta", + "functionName": "getIdentityprovidersOkta", + "signature": "getIdentityprovidersOkta()", + + "return": "Okta" + }, + "GET /api/v2/identityproviders/onelogin": { + "operationId": "getidentityprovidersonelogin", + "functionName": "getIdentityprovidersOnelogin", + "signature": "getIdentityprovidersOnelogin()", + + "return": "OneLogin" + }, + "GET /api/v2/identityproviders/ping": { + "operationId": "getidentityprovidersping", + "functionName": "getIdentityprovidersPing", + "signature": "getIdentityprovidersPing()", + + "return": "PingIdentity" + }, + "GET /api/v2/identityproviders/purecloud": { + "operationId": "getidentityproviderspurecloud", + "functionName": "getIdentityprovidersPurecloud", + "signature": "getIdentityprovidersPurecloud()", + + "return": "PureCloud" + }, + "GET /api/v2/identityproviders/pureengage": { + "operationId": "getidentityproviderspureengage", + "functionName": "getIdentityprovidersPureengage", + "signature": "getIdentityprovidersPureengage()", + + "return": "PureEngage" + }, + "GET /api/v2/identityproviders/salesforce": { + "operationId": "getidentityproviderssalesforce", + "functionName": "getIdentityprovidersSalesforce", + "signature": "getIdentityprovidersSalesforce()", + + "return": "Salesforce" + }, + "PUT /api/v2/identityproviders/adfs": { + "operationId": "putidentityprovidersadfs", + "functionName": "putIdentityprovidersAdfs", + "signature": "putIdentityprovidersAdfs(body)", + "parameters": [ + { + "name": "body", + "type": "ADFS", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/cic": { + "operationId": "putidentityproviderscic", + "functionName": "putIdentityprovidersCic", + "signature": "putIdentityprovidersCic(body)", + "parameters": [ + { + "name": "body", + "type": "CustomerInteractionCenter", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/generic": { + "operationId": "putidentityprovidersgeneric", + "functionName": "putIdentityprovidersGeneric", + "signature": "putIdentityprovidersGeneric(body)", + "parameters": [ + { + "name": "body", + "type": "GenericSAML", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/gsuite": { + "operationId": "putidentityprovidersgsuite", + "functionName": "putIdentityprovidersGsuite", + "signature": "putIdentityprovidersGsuite(body)", + "parameters": [ + { + "name": "body", + "type": "GSuite", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/identitynow": { + "operationId": "putidentityprovidersidentitynow", + "functionName": "putIdentityprovidersIdentitynow", + "signature": "putIdentityprovidersIdentitynow(body)", + "parameters": [ + { + "name": "body", + "type": "IdentityNow", + "required": "true" + } + ], + "return": "IdentityNow" + }, + "PUT /api/v2/identityproviders/okta": { + "operationId": "putidentityprovidersokta", + "functionName": "putIdentityprovidersOkta", + "signature": "putIdentityprovidersOkta(body)", + "parameters": [ + { + "name": "body", + "type": "Okta", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/onelogin": { + "operationId": "putidentityprovidersonelogin", + "functionName": "putIdentityprovidersOnelogin", + "signature": "putIdentityprovidersOnelogin(body)", + "parameters": [ + { + "name": "body", + "type": "OneLogin", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/ping": { + "operationId": "putidentityprovidersping", + "functionName": "putIdentityprovidersPing", + "signature": "putIdentityprovidersPing(body)", + "parameters": [ + { + "name": "body", + "type": "PingIdentity", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/purecloud": { + "operationId": "putidentityproviderspurecloud", + "functionName": "putIdentityprovidersPurecloud", + "signature": "putIdentityprovidersPurecloud(body)", + "parameters": [ + { + "name": "body", + "type": "PureCloud", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/pureengage": { + "operationId": "putidentityproviderspureengage", + "functionName": "putIdentityprovidersPureengage", + "signature": "putIdentityprovidersPureengage(body)", + "parameters": [ + { + "name": "body", + "type": "PureEngage", + "required": "true" + } + ], + "return": "OAuthProvider" + }, + "PUT /api/v2/identityproviders/salesforce": { + "operationId": "putidentityproviderssalesforce", + "functionName": "putIdentityprovidersSalesforce", + "signature": "putIdentityprovidersSalesforce(body)", + "parameters": [ + { + "name": "body", + "type": "Salesforce", + "required": "true" + } + ], + "return": "OAuthProvider" + } + +} \ No newline at end of file diff --git a/build/docs/InfrastructureAsCodeAPI.json b/build/docs/InfrastructureAsCodeAPI.json new file mode 100644 index 000000000..a31d28746 --- /dev/null +++ b/build/docs/InfrastructureAsCodeAPI.json @@ -0,0 +1,153 @@ +{ + "GET /api/v2/infrastructureascode/accelerators/{acceleratorId}": { + "operationId": "getinfrastructureascodeaccelerator", + "functionName": "getInfrastructureascodeAccelerator", + "signature": "getInfrastructureascodeAccelerator(acceleratorId, preferredLanguage)", + "parameters": [ + { + "name": "acceleratorId", + "type": "String", + "required": "true" + }, + { + "name": "preferredLanguage", + "type": "String", + "required": "false" + } + ], + "return": "AcceleratorSpecification" + }, + "GET /api/v2/infrastructureascode/accelerators": { + "operationId": "getinfrastructureascodeaccelerators", + "functionName": "getInfrastructureascodeAccelerators", + "signature": "getInfrastructureascodeAccelerators(pageSize, pageNumber, sortBy, sortOrder, name, _description, origin, type, classification, tags)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_description", + "type": "String", + "required": "false" + }, + { + "name": "origin", + "type": "String", + "required": "false" + }, + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "classification", + "type": "String", + "required": "false" + }, + { + "name": "tags", + "type": "String", + "required": "false" + } + ], + "return": "AcceleratorList" + }, + "GET /api/v2/infrastructureascode/jobs/{jobId}": { + "operationId": "getinfrastructureascodejob", + "functionName": "getInfrastructureascodeJob", + "signature": "getInfrastructureascodeJob(jobId, details)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "details", + "type": "Bool", + "required": "false" + } + ], + "return": "InfrastructureascodeJob" + }, + "GET /api/v2/infrastructureascode/jobs": { + "operationId": "getinfrastructureascodejobs", + "functionName": "getInfrastructureascodeJobs", + "signature": "getInfrastructureascodeJobs(maxResults, includeErrors, sortBy, sortOrder, acceleratorId, submittedBy, status)", + "parameters": [ + { + "name": "maxResults", + "type": "Int", + "required": "false" + }, + { + "name": "includeErrors", + "type": "Bool", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "acceleratorId", + "type": "String", + "required": "false" + }, + { + "name": "submittedBy", + "type": "String", + "required": "false" + }, + { + "name": "status", + "type": "String", + "required": "false" + } + ], + "return": "InfrastructureascodeJob" + }, + "POST /api/v2/infrastructureascode/jobs": { + "operationId": "postinfrastructureascodejobs", + "functionName": "postInfrastructureascodeJobs", + "signature": "postInfrastructureascodeJobs(body)", + "parameters": [ + { + "name": "body", + "type": "AcceleratorInput", + "required": "true" + } + ], + "return": "InfrastructureascodeJob" + } + +} \ No newline at end of file diff --git a/build/docs/IntegrationsAPI.json b/build/docs/IntegrationsAPI.json new file mode 100644 index 000000000..2c8c4a987 --- /dev/null +++ b/build/docs/IntegrationsAPI.json @@ -0,0 +1,1268 @@ +{ + "DELETE /api/v2/integrations/{integrationId}": { + "operationId": "deleteintegration", + "functionName": "deleteIntegration", + "signature": "deleteIntegration(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ], + "return": "Integration" + }, + "DELETE /api/v2/integrations/actions/{actionId}": { + "operationId": "deleteintegrationsaction", + "functionName": "deleteIntegrationsAction", + "signature": "deleteIntegrationsAction(actionId)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/integrations/actions/{actionId}/draft": { + "operationId": "deleteintegrationsactiondraft", + "functionName": "deleteIntegrationsActionDraft", + "signature": "deleteIntegrationsActionDraft(actionId)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/integrations/credentials/{credentialId}": { + "operationId": "deleteintegrationscredential", + "functionName": "deleteIntegrationsCredential", + "signature": "deleteIntegrationsCredential(credentialId)", + "parameters": [ + { + "name": "credentialId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/integrations/{integrationId}": { + "operationId": "getintegration", + "functionName": "getIntegration", + "signature": "getIntegration(integrationId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "Integration" + }, + "GET /api/v2/integrations/{integrationId}/config/current": { + "operationId": "getintegrationconfigcurrent", + "functionName": "getIntegrationConfigCurrent", + "signature": "getIntegrationConfigCurrent(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ], + "return": "IntegrationConfiguration" + }, + "GET /api/v2/integrations": { + "operationId": "getintegrations", + "functionName": "getIntegrations", + "signature": "getIntegrations(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "IntegrationEntityListing" + }, + "GET /api/v2/integrations/actions/{actionId}": { + "operationId": "getintegrationsaction", + "functionName": "getIntegrationsAction", + "signature": "getIntegrationsAction(actionId, expand, includeConfig)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "includeConfig", + "type": "Bool", + "required": "false" + } + ], + "return": "Action" + }, + "GET /api/v2/integrations/actions/{actionId}/draft": { + "operationId": "getintegrationsactiondraft", + "functionName": "getIntegrationsActionDraft", + "signature": "getIntegrationsActionDraft(actionId, expand, includeConfig)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "includeConfig", + "type": "Bool", + "required": "false" + } + ], + "return": "Action" + }, + "GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}": { + "operationId": "getintegrationsactiondraftschema", + "functionName": "getIntegrationsActionDraftSchema", + "signature": "getIntegrationsActionDraftSchema(actionId, fileName)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "fileName", + "type": "String", + "required": "true" + } + ], + "return": "JsonSchemaDocument" + }, + "GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}": { + "operationId": "getintegrationsactiondrafttemplate", + "functionName": "getIntegrationsActionDraftTemplate", + "signature": "getIntegrationsActionDraftTemplate(actionId, fileName)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "fileName", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "GET /api/v2/integrations/actions/{actionId}/draft/validation": { + "operationId": "getintegrationsactiondraftvalidation", + "functionName": "getIntegrationsActionDraftValidation", + "signature": "getIntegrationsActionDraftValidation(actionId)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + } + ], + "return": "DraftValidationResult" + }, + "GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}": { + "operationId": "getintegrationsactionschema", + "functionName": "getIntegrationsActionSchema", + "signature": "getIntegrationsActionSchema(actionId, fileName)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "fileName", + "type": "String", + "required": "true" + } + ], + "return": "JsonSchemaDocument" + }, + "GET /api/v2/integrations/actions/{actionId}/templates/{fileName}": { + "operationId": "getintegrationsactiontemplate", + "functionName": "getIntegrationsActionTemplate", + "signature": "getIntegrationsActionTemplate(actionId, fileName)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "fileName", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "GET /api/v2/integrations/actions": { + "operationId": "getintegrationsactions", + "functionName": "getIntegrationsActions", + "signature": "getIntegrationsActions(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, category, name, ids, secure, includeAuthActions)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "category", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "ids", + "type": "String", + "required": "false" + }, + { + "name": "secure", + "type": "String", + "required": "false" + }, + { + "name": "includeAuthActions", + "type": "String", + "required": "false" + } + ], + "return": "ActionEntityListing" + }, + "GET /api/v2/integrations/actions/categories": { + "operationId": "getintegrationsactionscategories", + "functionName": "getIntegrationsActionsCategories", + "signature": "getIntegrationsActionsCategories(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, secure)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "secure", + "type": "String", + "required": "false" + } + ], + "return": "CategoryEntityListing" + }, + "GET /api/v2/integrations/actions/drafts": { + "operationId": "getintegrationsactionsdrafts", + "functionName": "getIntegrationsActionsDrafts", + "signature": "getIntegrationsActionsDrafts(pageSize, pageNumber, nextPage, previousPage, sortBy, sortOrder, category, name, ids, secure, includeAuthActions)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "category", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "ids", + "type": "String", + "required": "false" + }, + { + "name": "secure", + "type": "String", + "required": "false" + }, + { + "name": "includeAuthActions", + "type": "String", + "required": "false" + } + ], + "return": "ActionEntityListing" + }, + "GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId}": { + "operationId": "getintegrationsbotconnectorintegrationidbot", + "functionName": "getIntegrationsBotconnectorIntegrationIdBot", + "signature": "getIntegrationsBotconnectorIntegrationIdBot(integrationId, botId, version)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "botId", + "type": "String", + "required": "true" + }, + { + "name": "version", + "type": "String", + "required": "false" + } + ], + "return": "BotConnectorBot" + }, + "GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions": { + "operationId": "getintegrationsbotconnectorintegrationidbotversions", + "functionName": "getIntegrationsBotconnectorIntegrationIdBotVersions", + "signature": "getIntegrationsBotconnectorIntegrationIdBotVersions(integrationId, botId, pageNumber, pageSize)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "botId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "BotConnectorBotVersionSummaryEntityListing" + }, + "GET /api/v2/integrations/botconnector/{integrationId}/bots": { + "operationId": "getintegrationsbotconnectorintegrationidbots", + "functionName": "getIntegrationsBotconnectorIntegrationIdBots", + "signature": "getIntegrationsBotconnectorIntegrationIdBots(integrationId)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + } + ], + "return": "BotList" + }, + "GET /api/v2/integrations/botconnector/{integrationId}/bots/summaries": { + "operationId": "getintegrationsbotconnectorintegrationidbotssummaries", + "functionName": "getIntegrationsBotconnectorIntegrationIdBotsSummaries", + "signature": "getIntegrationsBotconnectorIntegrationIdBotsSummaries(integrationId, pageNumber, pageSize)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "BotConnectorBotSummaryEntityListing" + }, + "GET /api/v2/integrations/clientapps": { + "operationId": "getintegrationsclientapps", + "functionName": "getIntegrationsClientapps", + "signature": "getIntegrationsClientapps(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "ClientAppEntityListing" + }, + "GET /api/v2/integrations/clientapps/unifiedcommunications": { + "operationId": "getintegrationsclientappsunifiedcommunications", + "functionName": "getIntegrationsClientappsUnifiedcommunications", + "signature": "getIntegrationsClientappsUnifiedcommunications(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "UCIntegrationListing" + }, + "GET /api/v2/integrations/credentials/{credentialId}": { + "operationId": "getintegrationscredential", + "functionName": "getIntegrationsCredential", + "signature": "getIntegrationsCredential(credentialId)", + "parameters": [ + { + "name": "credentialId", + "type": "String", + "required": "true" + } + ], + "return": "Credential" + }, + "GET /api/v2/integrations/credentials": { + "operationId": "getintegrationscredentials", + "functionName": "getIntegrationsCredentials", + "signature": "getIntegrationsCredentials(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "CredentialInfoListing" + }, + "GET /api/v2/integrations/credentials/types": { + "operationId": "getintegrationscredentialstypes", + "functionName": "getIntegrationsCredentialsTypes", + "signature": "getIntegrationsCredentialsTypes()", + + "return": "CredentialTypeListing" + }, + "GET /api/v2/integrations/speech/dialogflow/agents/{agentId}": { + "operationId": "getintegrationsspeechdialogflowagent", + "functionName": "getIntegrationsSpeechDialogflowAgent", + "signature": "getIntegrationsSpeechDialogflowAgent(agentId)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + } + ], + "return": "DialogflowAgent" + }, + "GET /api/v2/integrations/speech/dialogflow/agents": { + "operationId": "getintegrationsspeechdialogflowagents", + "functionName": "getIntegrationsSpeechDialogflowAgents", + "signature": "getIntegrationsSpeechDialogflowAgents(pageNumber, pageSize, name)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "DialogflowAgentSummaryEntityListing" + }, + "GET /api/v2/integrations/speech/lex/bot/alias/{aliasId}": { + "operationId": "getintegrationsspeechlexbotalias", + "functionName": "getIntegrationsSpeechLexBotAlias", + "signature": "getIntegrationsSpeechLexBotAlias(aliasId)", + "parameters": [ + { + "name": "aliasId", + "type": "String", + "required": "true" + } + ], + "return": "LexBotAlias" + }, + "GET /api/v2/integrations/speech/lex/bot/{botId}/aliases": { + "operationId": "getintegrationsspeechlexbotbotidaliases", + "functionName": "getIntegrationsSpeechLexBotBotIdAliases", + "signature": "getIntegrationsSpeechLexBotBotIdAliases(botId, pageNumber, pageSize, status, name)", + "parameters": [ + { + "name": "botId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "status", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "LexBotAliasEntityListing" + }, + "GET /api/v2/integrations/speech/lex/bots": { + "operationId": "getintegrationsspeechlexbots", + "functionName": "getIntegrationsSpeechLexBots", + "signature": "getIntegrationsSpeechLexBots(pageNumber, pageSize, name)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "LexBotEntityListing" + }, + "GET /api/v2/integrations/speech/tts/engines/{engineId}": { + "operationId": "getintegrationsspeechttsengine", + "functionName": "getIntegrationsSpeechTtsEngine", + "signature": "getIntegrationsSpeechTtsEngine(engineId, includeVoices)", + "parameters": [ + { + "name": "engineId", + "type": "String", + "required": "true" + }, + { + "name": "includeVoices", + "type": "Bool", + "required": "false" + } + ], + "return": "TtsEngineEntity" + }, + "GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}": { + "operationId": "getintegrationsspeechttsenginevoice", + "functionName": "getIntegrationsSpeechTtsEngineVoice", + "signature": "getIntegrationsSpeechTtsEngineVoice(engineId, voiceId)", + "parameters": [ + { + "name": "engineId", + "type": "String", + "required": "true" + }, + { + "name": "voiceId", + "type": "String", + "required": "true" + } + ], + "return": "TtsVoiceEntity" + }, + "GET /api/v2/integrations/speech/tts/engines/{engineId}/voices": { + "operationId": "getintegrationsspeechttsenginevoices", + "functionName": "getIntegrationsSpeechTtsEngineVoices", + "signature": "getIntegrationsSpeechTtsEngineVoices(engineId, pageNumber, pageSize)", + "parameters": [ + { + "name": "engineId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "TtsVoiceEntityListing" + }, + "GET /api/v2/integrations/speech/tts/engines": { + "operationId": "getintegrationsspeechttsengines", + "functionName": "getIntegrationsSpeechTtsEngines", + "signature": "getIntegrationsSpeechTtsEngines(pageNumber, pageSize, includeVoices, name, language)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "includeVoices", + "type": "Bool", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "language", + "type": "String", + "required": "false" + } + ], + "return": "TtsEngineEntityListing" + }, + "GET /api/v2/integrations/speech/tts/settings": { + "operationId": "getintegrationsspeechttssettings", + "functionName": "getIntegrationsSpeechTtsSettings", + "signature": "getIntegrationsSpeechTtsSettings()", + + "return": "TtsSettings" + }, + "GET /api/v2/integrations/types/{typeId}": { + "operationId": "getintegrationstype", + "functionName": "getIntegrationsType", + "signature": "getIntegrationsType(typeId)", + "parameters": [ + { + "name": "typeId", + "type": "String", + "required": "true" + } + ], + "return": "IntegrationType" + }, + "GET /api/v2/integrations/types/{typeId}/configschemas/{configType}": { + "operationId": "getintegrationstypeconfigschema", + "functionName": "getIntegrationsTypeConfigschema", + "signature": "getIntegrationsTypeConfigschema(typeId, configType)", + "parameters": [ + { + "name": "typeId", + "type": "String", + "required": "true" + }, + { + "name": "configType", + "type": "String", + "required": "true" + } + ], + "return": "JsonSchemaDocument" + }, + "GET /api/v2/integrations/types": { + "operationId": "getintegrationstypes", + "functionName": "getIntegrationsTypes", + "signature": "getIntegrationsTypes(pageSize, pageNumber, sortBy, expand, nextPage, previousPage)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + } + ], + "return": "IntegrationTypeEntityListing" + }, + "GET /api/v2/integrations/userapps": { + "operationId": "getintegrationsuserapps", + "functionName": "getIntegrationsUserapps", + "signature": "getIntegrationsUserapps(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, appHost)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "appHost", + "type": "String", + "required": "false" + } + ], + "return": "UserAppEntityListing" + }, + "PATCH /api/v2/integrations/{integrationId}": { + "operationId": "patchintegration", + "functionName": "patchIntegration", + "signature": "patchIntegration(integrationId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "body", + "type": "Integration", + "required": "false" + } + ], + "return": "Integration" + }, + "PATCH /api/v2/integrations/actions/{actionId}": { + "operationId": "patchintegrationsaction", + "functionName": "patchIntegrationsAction", + "signature": "patchIntegrationsAction(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateActionInput", + "required": "true" + } + ], + "return": "Action" + }, + "PATCH /api/v2/integrations/actions/{actionId}/draft": { + "operationId": "patchintegrationsactiondraft", + "functionName": "patchIntegrationsActionDraft", + "signature": "patchIntegrationsActionDraft(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateDraftInput", + "required": "true" + } + ], + "return": "Action" + }, + "POST /api/v2/integrations": { + "operationId": "postintegrations", + "functionName": "postIntegrations", + "signature": "postIntegrations(body)", + "parameters": [ + { + "name": "body", + "type": "CreateIntegrationRequest", + "required": "false" + } + ], + "return": "Integration" + }, + "POST /api/v2/integrations/actions/{actionId}/draft": { + "operationId": "postintegrationsactiondraft", + "functionName": "postIntegrationsActionDraft", + "signature": "postIntegrationsActionDraft(actionId)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + } + ], + "return": "Action" + }, + "POST /api/v2/integrations/actions/{actionId}/draft/publish": { + "operationId": "postintegrationsactiondraftpublish", + "functionName": "postIntegrationsActionDraftPublish", + "signature": "postIntegrationsActionDraftPublish(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PublishDraftInput", + "required": "true" + } + ], + "return": "Action" + }, + "POST /api/v2/integrations/actions/{actionId}/draft/test": { + "operationId": "postintegrationsactiondrafttest", + "functionName": "postIntegrationsActionDraftTest", + "signature": "postIntegrationsActionDraftTest(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String:JSON]", + "required": "true" + } + ], + "return": "TestExecutionResult" + }, + "POST /api/v2/integrations/actions/{actionId}/execute": { + "operationId": "postintegrationsactionexecute", + "functionName": "postIntegrationsActionExecute", + "signature": "postIntegrationsActionExecute(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String:JSON]", + "required": "true" + } + ], + "return": "JSON" + }, + "POST /api/v2/integrations/actions/{actionId}/test": { + "operationId": "postintegrationsactiontest", + "functionName": "postIntegrationsActionTest", + "signature": "postIntegrationsActionTest(actionId, body)", + "parameters": [ + { + "name": "actionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String:JSON]", + "required": "true" + } + ], + "return": "TestExecutionResult" + }, + "POST /api/v2/integrations/actions": { + "operationId": "postintegrationsactions", + "functionName": "postIntegrationsActions", + "signature": "postIntegrationsActions(body)", + "parameters": [ + { + "name": "body", + "type": "PostActionInput", + "required": "true" + } + ], + "return": "Action" + }, + "POST /api/v2/integrations/actions/drafts": { + "operationId": "postintegrationsactionsdrafts", + "functionName": "postIntegrationsActionsDrafts", + "signature": "postIntegrationsActionsDrafts(body)", + "parameters": [ + { + "name": "body", + "type": "PostActionInput", + "required": "true" + } + ], + "return": "Action" + }, + "POST /api/v2/integrations/credentials": { + "operationId": "postintegrationscredentials", + "functionName": "postIntegrationsCredentials", + "signature": "postIntegrationsCredentials(body)", + "parameters": [ + { + "name": "body", + "type": "Credential", + "required": "false" + } + ], + "return": "CredentialInfo" + }, + "PUT /api/v2/integrations/{integrationId}/config/current": { + "operationId": "putintegrationconfigcurrent", + "functionName": "putIntegrationConfigCurrent", + "signature": "putIntegrationConfigCurrent(integrationId, body)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "IntegrationConfiguration", + "required": "false" + } + ], + "return": "IntegrationConfiguration" + }, + "PUT /api/v2/integrations/botconnector/{integrationId}/bots": { + "operationId": "putintegrationsbotconnectorintegrationidbots", + "functionName": "putIntegrationsBotconnectorIntegrationIdBots", + "signature": "putIntegrationsBotconnectorIntegrationIdBots(integrationId, botList)", + "parameters": [ + { + "name": "integrationId", + "type": "String", + "required": "true" + }, + { + "name": "botList", + "type": "BotList", + "required": "true" + } + ] + }, + "PUT /api/v2/integrations/credentials/{credentialId}": { + "operationId": "putintegrationscredential", + "functionName": "putIntegrationsCredential", + "signature": "putIntegrationsCredential(credentialId, body)", + "parameters": [ + { + "name": "credentialId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Credential", + "required": "false" + } + ], + "return": "CredentialInfo" + }, + "PUT /api/v2/integrations/speech/tts/settings": { + "operationId": "putintegrationsspeechttssettings", + "functionName": "putIntegrationsSpeechTtsSettings", + "signature": "putIntegrationsSpeechTtsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "TtsSettings", + "required": "true" + } + ], + "return": "TtsSettings" + }, + "PUT /api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences": { + "operationId": "putintegrationsunifiedcommunicationthirdpartypresences", + "functionName": "putIntegrationsUnifiedcommunicationThirdpartypresences", + "signature": "putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body)", + "parameters": [ + { + "name": "ucIntegrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UCThirdPartyPresence]", + "required": "true" + } + ], + "return": "String" + } + +} \ No newline at end of file diff --git a/build/docs/JourneyAPI.json b/build/docs/JourneyAPI.json new file mode 100644 index 000000000..838c38268 --- /dev/null +++ b/build/docs/JourneyAPI.json @@ -0,0 +1,604 @@ +{ + "DELETE /api/v2/journey/actionmaps/{actionMapId}": { + "operationId": "deletejourneyactionmap", + "functionName": "deleteJourneyActionmap", + "signature": "deleteJourneyActionmap(actionMapId)", + "parameters": [ + { + "name": "actionMapId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/journey/actiontemplates/{actionTemplateId}": { + "operationId": "deletejourneyactiontemplate", + "functionName": "deleteJourneyActiontemplate", + "signature": "deleteJourneyActiontemplate(actionTemplateId, hardDelete)", + "parameters": [ + { + "name": "actionTemplateId", + "type": "String", + "required": "true" + }, + { + "name": "hardDelete", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/journey/outcomes/{outcomeId}": { + "operationId": "deletejourneyoutcome", + "functionName": "deleteJourneyOutcome", + "signature": "deleteJourneyOutcome(outcomeId)", + "parameters": [ + { + "name": "outcomeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/journey/outcomes/predictors/{predictorId}": { + "operationId": "deletejourneyoutcomespredictor", + "functionName": "deleteJourneyOutcomesPredictor", + "signature": "deleteJourneyOutcomesPredictor(predictorId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/journey/segments/{segmentId}": { + "operationId": "deletejourneysegment", + "functionName": "deleteJourneySegment", + "signature": "deleteJourneySegment(segmentId)", + "parameters": [ + { + "name": "segmentId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions": { + "operationId": "getexternalcontactscontactjourneysessions", + "functionName": "getExternalcontactsContactJourneySessions", + "signature": "getExternalcontactsContactJourneySessions(contactId, pageSize, after, includeMerged)", + "parameters": [ + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "includeMerged", + "type": "Bool", + "required": "false" + } + ], + "return": "SessionListing" + }, + "GET /api/v2/journey/actionmaps/{actionMapId}": { + "operationId": "getjourneyactionmap", + "functionName": "getJourneyActionmap", + "signature": "getJourneyActionmap(actionMapId)", + "parameters": [ + { + "name": "actionMapId", + "type": "String", + "required": "true" + } + ], + "return": "ActionMap" + }, + "GET /api/v2/journey/actionmaps": { + "operationId": "getjourneyactionmaps", + "functionName": "getJourneyActionmaps", + "signature": "getJourneyActionmaps(pageNumber, pageSize, sortBy, filterField, filterValue, actionMapIds, queryFields, queryValue)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "filterField", + "type": "String", + "required": "false" + }, + { + "name": "filterValue", + "type": "String", + "required": "false" + }, + { + "name": "actionMapIds", + "type": "[String]", + "required": "false" + }, + { + "name": "queryFields", + "type": "[String]", + "required": "false" + }, + { + "name": "queryValue", + "type": "String", + "required": "false" + } + ], + "return": "ActionMapListing" + }, + "GET /api/v2/journey/actionmaps/estimates/jobs/{jobId}": { + "operationId": "getjourneyactionmapsestimatesjob", + "functionName": "getJourneyActionmapsEstimatesJob", + "signature": "getJourneyActionmapsEstimatesJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "GET /api/v2/journey/actionmaps/estimates/jobs/{jobId}/results": { + "operationId": "getjourneyactionmapsestimatesjobresults", + "functionName": "getJourneyActionmapsEstimatesJobResults", + "signature": "getJourneyActionmapsEstimatesJobResults(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "ActionMapEstimateResult" + }, + "GET /api/v2/journey/actiontargets/{actionTargetId}": { + "operationId": "getjourneyactiontarget", + "functionName": "getJourneyActiontarget", + "signature": "getJourneyActiontarget(actionTargetId)", + "parameters": [ + { + "name": "actionTargetId", + "type": "String", + "required": "true" + } + ], + "return": "ActionTarget" + }, + "GET /api/v2/journey/actiontargets": { + "operationId": "getjourneyactiontargets", + "functionName": "getJourneyActiontargets", + "signature": "getJourneyActiontargets(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ActionTargetListing" + }, + "GET /api/v2/journey/actiontemplates/{actionTemplateId}": { + "operationId": "getjourneyactiontemplate", + "functionName": "getJourneyActiontemplate", + "signature": "getJourneyActiontemplate(actionTemplateId)", + "parameters": [ + { + "name": "actionTemplateId", + "type": "String", + "required": "true" + } + ], + "return": "ActionTemplate" + }, + "GET /api/v2/journey/actiontemplates": { + "operationId": "getjourneyactiontemplates", + "functionName": "getJourneyActiontemplates", + "signature": "getJourneyActiontemplates(pageNumber, pageSize, sortBy, mediaType, state, queryFields, queryValue)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "mediaType", + "type": "String", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + }, + { + "name": "queryFields", + "type": "[String]", + "required": "false" + }, + { + "name": "queryValue", + "type": "String", + "required": "false" + } + ], + "return": "ActionTemplateListing" + }, + "GET /api/v2/journey/outcomes/{outcomeId}": { + "operationId": "getjourneyoutcome", + "functionName": "getJourneyOutcome", + "signature": "getJourneyOutcome(outcomeId)", + "parameters": [ + { + "name": "outcomeId", + "type": "String", + "required": "true" + } + ], + "return": "Outcome" + }, + "GET /api/v2/journey/outcomes": { + "operationId": "getjourneyoutcomes", + "functionName": "getJourneyOutcomes", + "signature": "getJourneyOutcomes(pageNumber, pageSize, sortBy, outcomeIds, queryFields, queryValue)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "outcomeIds", + "type": "[String]", + "required": "false" + }, + { + "name": "queryFields", + "type": "[String]", + "required": "false" + }, + { + "name": "queryValue", + "type": "String", + "required": "false" + } + ], + "return": "OutcomeListing" + }, + "GET /api/v2/journey/outcomes/predictors/{predictorId}": { + "operationId": "getjourneyoutcomespredictor", + "functionName": "getJourneyOutcomesPredictor", + "signature": "getJourneyOutcomesPredictor(predictorId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + } + ], + "return": "OutcomePredictor" + }, + "GET /api/v2/journey/outcomes/predictors": { + "operationId": "getjourneyoutcomespredictors", + "functionName": "getJourneyOutcomesPredictors", + "signature": "getJourneyOutcomesPredictors()", + + "return": "OutcomePredictorListing" + }, + "GET /api/v2/journey/segments/{segmentId}": { + "operationId": "getjourneysegment", + "functionName": "getJourneySegment", + "signature": "getJourneySegment(segmentId)", + "parameters": [ + { + "name": "segmentId", + "type": "String", + "required": "true" + } + ], + "return": "JourneySegment" + }, + "GET /api/v2/journey/segments": { + "operationId": "getjourneysegments", + "functionName": "getJourneySegments", + "signature": "getJourneySegments(sortBy, pageSize, pageNumber, isActive, segmentIds, queryFields, queryValue)", + "parameters": [ + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "isActive", + "type": "Bool", + "required": "false" + }, + { + "name": "segmentIds", + "type": "[String]", + "required": "false" + }, + { + "name": "queryFields", + "type": "[String]", + "required": "false" + }, + { + "name": "queryValue", + "type": "String", + "required": "false" + } + ], + "return": "SegmentListing" + }, + "GET /api/v2/journey/sessions/{sessionId}": { + "operationId": "getjourneysession", + "functionName": "getJourneySession", + "signature": "getJourneySession(sessionId)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + } + ], + "return": "Session" + }, + "GET /api/v2/journey/sessions/{sessionId}/outcomescores": { + "operationId": "getjourneysessionoutcomescores", + "functionName": "getJourneySessionOutcomescores", + "signature": "getJourneySessionOutcomescores(sessionId)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + } + ], + "return": "OutcomeScoresResult" + }, + "PATCH /api/v2/journey/actionmaps/{actionMapId}": { + "operationId": "patchjourneyactionmap", + "functionName": "patchJourneyActionmap", + "signature": "patchJourneyActionmap(actionMapId, body)", + "parameters": [ + { + "name": "actionMapId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchActionMap", + "required": "false" + } + ], + "return": "ActionMap" + }, + "PATCH /api/v2/journey/actiontargets/{actionTargetId}": { + "operationId": "patchjourneyactiontarget", + "functionName": "patchJourneyActiontarget", + "signature": "patchJourneyActiontarget(actionTargetId, body)", + "parameters": [ + { + "name": "actionTargetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchActionTarget", + "required": "false" + } + ], + "return": "ActionTarget" + }, + "PATCH /api/v2/journey/actiontemplates/{actionTemplateId}": { + "operationId": "patchjourneyactiontemplate", + "functionName": "patchJourneyActiontemplate", + "signature": "patchJourneyActiontemplate(actionTemplateId, body)", + "parameters": [ + { + "name": "actionTemplateId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchActionTemplate", + "required": "false" + } + ], + "return": "ActionTemplate" + }, + "PATCH /api/v2/journey/outcomes/{outcomeId}": { + "operationId": "patchjourneyoutcome", + "functionName": "patchJourneyOutcome", + "signature": "patchJourneyOutcome(outcomeId, body)", + "parameters": [ + { + "name": "outcomeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchOutcome", + "required": "false" + } + ], + "return": "Outcome" + }, + "PATCH /api/v2/journey/segments/{segmentId}": { + "operationId": "patchjourneysegment", + "functionName": "patchJourneySegment", + "signature": "patchJourneySegment(segmentId, body)", + "parameters": [ + { + "name": "segmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchSegment", + "required": "false" + } + ], + "return": "JourneySegment" + }, + "POST /api/v2/analytics/journeys/aggregates/query": { + "operationId": "postanalyticsjourneysaggregatesquery", + "functionName": "postAnalyticsJourneysAggregatesQuery", + "signature": "postAnalyticsJourneysAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "JourneyAggregationQuery", + "required": "true" + } + ], + "return": "JourneyAggregateQueryResponse" + }, + "POST /api/v2/journey/actionmaps": { + "operationId": "postjourneyactionmaps", + "functionName": "postJourneyActionmaps", + "signature": "postJourneyActionmaps(body)", + "parameters": [ + { + "name": "body", + "type": "ActionMap", + "required": "false" + } + ], + "return": "ActionMap" + }, + "POST /api/v2/journey/actionmaps/estimates/jobs": { + "operationId": "postjourneyactionmapsestimatesjobs", + "functionName": "postJourneyActionmapsEstimatesJobs", + "signature": "postJourneyActionmapsEstimatesJobs(body)", + "parameters": [ + { + "name": "body", + "type": "ActionMapEstimateRequest", + "required": "true" + } + ], + "return": "EstimateJobAsyncResponse" + }, + "POST /api/v2/journey/actiontemplates": { + "operationId": "postjourneyactiontemplates", + "functionName": "postJourneyActiontemplates", + "signature": "postJourneyActiontemplates(body)", + "parameters": [ + { + "name": "body", + "type": "ActionTemplate", + "required": "false" + } + ], + "return": "ActionTemplate" + }, + "POST /api/v2/journey/outcomes": { + "operationId": "postjourneyoutcomes", + "functionName": "postJourneyOutcomes", + "signature": "postJourneyOutcomes(body)", + "parameters": [ + { + "name": "body", + "type": "Outcome", + "required": "false" + } + ], + "return": "Outcome" + }, + "POST /api/v2/journey/outcomes/predictors": { + "operationId": "postjourneyoutcomespredictors", + "functionName": "postJourneyOutcomesPredictors", + "signature": "postJourneyOutcomesPredictors(body)", + "parameters": [ + { + "name": "body", + "type": "OutcomePredictorRequest", + "required": "false" + } + ], + "return": "OutcomePredictor" + }, + "POST /api/v2/journey/segments": { + "operationId": "postjourneysegments", + "functionName": "postJourneySegments", + "signature": "postJourneySegments(body)", + "parameters": [ + { + "name": "body", + "type": "JourneySegment", + "required": "false" + } + ], + "return": "JourneySegment" + } + +} \ No newline at end of file diff --git a/build/docs/KnowledgeAPI.json b/build/docs/KnowledgeAPI.json new file mode 100644 index 000000000..0bf5ead8f --- /dev/null +++ b/build/docs/KnowledgeAPI.json @@ -0,0 +1,2031 @@ +{ + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}": { + "operationId": "deleteknowledgeknowledgebase", + "functionName": "deleteKnowledgeKnowledgebase", + "signature": "deleteKnowledgeKnowledgebase(knowledgeBaseId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeBase" + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}": { + "operationId": "deleteknowledgeknowledgebasecategory", + "functionName": "deleteKnowledgeKnowledgebaseCategory", + "signature": "deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "categoryId", + "type": "String", + "required": "true" + } + ], + "return": "CategoryResponse" + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}": { + "operationId": "deleteknowledgeknowledgebasedocument", + "functionName": "deleteKnowledgeKnowledgebaseDocument", + "signature": "deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}": { + "operationId": "deleteknowledgeknowledgebasedocumentvariation", + "functionName": "deleteKnowledgeKnowledgebaseDocumentVariation", + "signature": "deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId)", + "parameters": [ + { + "name": "documentVariationId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}": { + "operationId": "deleteknowledgeknowledgebaseexportjob", + "functionName": "deleteKnowledgeKnowledgebaseExportJob", + "signature": "deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "exportJobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}": { + "operationId": "deleteknowledgeknowledgebaseimportjob", + "functionName": "deleteKnowledgeKnowledgebaseImportJob", + "signature": "deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "importJobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}": { + "operationId": "deleteknowledgeknowledgebaselabel", + "functionName": "deleteKnowledgeKnowledgebaseLabel", + "signature": "deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "labelId", + "type": "String", + "required": "true" + } + ], + "return": "LabelResponse" + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}": { + "operationId": "deleteknowledgeknowledgebaselanguagecategory", + "functionName": "deleteKnowledgeKnowledgebaseLanguageCategory", + "signature": "deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeCategory" + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}": { + "operationId": "deleteknowledgeknowledgebaselanguagedocument", + "functionName": "deleteKnowledgeKnowledgebaseLanguageDocument", + "signature": "deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeDocument" + }, + "DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}": { + "operationId": "deleteknowledgeknowledgebaselanguagedocumentsimport", + "functionName": "deleteKnowledgeKnowledgebaseLanguageDocumentsImport", + "signature": "deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "importId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/knowledge/guest/sessions/{sessionId}/categories": { + "operationId": "getknowledgeguestsessioncategories", + "functionName": "getKnowledgeGuestSessionCategories", + "signature": "getKnowledgeGuestSessionCategories(sessionId, before, after, pageSize, parentId, isRoot, name, sortBy, expand, includeDocumentCount)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "parentId", + "type": "String", + "required": "false" + }, + { + "name": "isRoot", + "type": "Bool", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "includeDocumentCount", + "type": "Bool", + "required": "false" + } + ], + "return": "GuestCategoryResponseListing" + }, + "GET /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}": { + "operationId": "getknowledgeguestsessiondocument", + "functionName": "getKnowledgeGuestSessionDocument", + "signature": "getKnowledgeGuestSessionDocument(sessionId, documentId)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeGuestDocument" + }, + "GET /api/v2/knowledge/guest/sessions/{sessionId}/documents": { + "operationId": "getknowledgeguestsessiondocuments", + "functionName": "getKnowledgeGuestSessionDocuments", + "signature": "getKnowledgeGuestSessionDocuments(sessionId, categoryId, pageSize)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "categoryId", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "KnowledgeGuestDocumentResponseListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}": { + "operationId": "getknowledgeknowledgebase", + "functionName": "getKnowledgeKnowledgebase", + "signature": "getKnowledgeKnowledgebase(knowledgeBaseId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeBase" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories": { + "operationId": "getknowledgeknowledgebasecategories", + "functionName": "getKnowledgeKnowledgebaseCategories", + "signature": "getKnowledgeKnowledgebaseCategories(knowledgeBaseId, before, after, pageSize, parentId, isRoot, name, sortBy, expand, includeDocumentCount)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "parentId", + "type": "String", + "required": "false" + }, + { + "name": "isRoot", + "type": "Bool", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "includeDocumentCount", + "type": "Bool", + "required": "false" + } + ], + "return": "CategoryResponseListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}": { + "operationId": "getknowledgeknowledgebasecategory", + "functionName": "getKnowledgeKnowledgebaseCategory", + "signature": "getKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "categoryId", + "type": "String", + "required": "true" + } + ], + "return": "CategoryResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}": { + "operationId": "getknowledgeknowledgebasedocument", + "functionName": "getKnowledgeKnowledgebaseDocument", + "signature": "getKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, expand, state)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + } + ], + "return": "KnowledgeDocumentResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback": { + "operationId": "getknowledgeknowledgebasedocumentfeedback", + "functionName": "getKnowledgeKnowledgebaseDocumentFeedback", + "signature": "getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, before, after, pageSize, onlyCommented, documentVersionId, documentVariationId, appType, queryType, userId, queueId, state)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "onlyCommented", + "type": "Bool", + "required": "false" + }, + { + "name": "documentVersionId", + "type": "String", + "required": "false" + }, + { + "name": "documentVariationId", + "type": "String", + "required": "false" + }, + { + "name": "appType", + "type": "String", + "required": "false" + }, + { + "name": "queryType", + "type": "String", + "required": "false" + }, + { + "name": "userId", + "type": "String", + "required": "false" + }, + { + "name": "queueId", + "type": "String", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + } + ], + "return": "KnowledgeDocumentFeedbackResponseListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}": { + "operationId": "getknowledgeknowledgebasedocumentfeedbackfeedbackid", + "functionName": "getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId", + "signature": "getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "feedbackId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeDocumentFeedbackResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}": { + "operationId": "getknowledgeknowledgebasedocumentvariation", + "functionName": "getKnowledgeKnowledgebaseDocumentVariation", + "signature": "getKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, documentState)", + "parameters": [ + { + "name": "documentVariationId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentState", + "type": "String", + "required": "false" + } + ], + "return": "DocumentVariation" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations": { + "operationId": "getknowledgeknowledgebasedocumentvariations", + "functionName": "getKnowledgeKnowledgebaseDocumentVariations", + "signature": "getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, before, after, pageSize, documentState)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "documentState", + "type": "String", + "required": "false" + } + ], + "return": "DocumentVariationListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}": { + "operationId": "getknowledgeknowledgebasedocumentversion", + "functionName": "getKnowledgeKnowledgebaseDocumentVersion", + "signature": "getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId, documentId, versionId, expand)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "KnowledgeDocumentVersion" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}": { + "operationId": "getknowledgeknowledgebasedocumentversionvariation", + "functionName": "getKnowledgeKnowledgebaseDocumentVersionVariation", + "signature": "getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId, documentId, versionId, variationId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "variationId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeDocumentVersionVariation" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations": { + "operationId": "getknowledgeknowledgebasedocumentversionvariations", + "functionName": "getKnowledgeKnowledgebaseDocumentVersionVariations", + "signature": "getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId, documentId, versionId, before, after, pageSize)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + } + ], + "return": "KnowledgeDocumentVersionVariationListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions": { + "operationId": "getknowledgeknowledgebasedocumentversions", + "functionName": "getKnowledgeKnowledgebaseDocumentVersions", + "signature": "getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, before, after, pageSize, expand)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "KnowledgeDocumentVersionListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents": { + "operationId": "getknowledgeknowledgebasedocuments", + "functionName": "getKnowledgeKnowledgebaseDocuments", + "signature": "getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, before, after, pageSize, interval, documentId, categoryId, includeSubcategories, includeDrafts, labelIds, expand, externalIds)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "documentId", + "type": "[String]", + "required": "false" + }, + { + "name": "categoryId", + "type": "[String]", + "required": "false" + }, + { + "name": "includeSubcategories", + "type": "Bool", + "required": "false" + }, + { + "name": "includeDrafts", + "type": "Bool", + "required": "false" + }, + { + "name": "labelIds", + "type": "[String]", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "externalIds", + "type": "[String]", + "required": "false" + } + ], + "return": "KnowledgeDocumentResponseListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}": { + "operationId": "getknowledgeknowledgebaseexportjob", + "functionName": "getKnowledgeKnowledgebaseExportJob", + "signature": "getKnowledgeKnowledgebaseExportJob(knowledgeBaseId, exportJobId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "exportJobId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeExportJobResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}": { + "operationId": "getknowledgeknowledgebaseimportjob", + "functionName": "getKnowledgeKnowledgebaseImportJob", + "signature": "getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, expand)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "importJobId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "KnowledgeImportJobResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}": { + "operationId": "getknowledgeknowledgebaselabel", + "functionName": "getKnowledgeKnowledgebaseLabel", + "signature": "getKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "labelId", + "type": "String", + "required": "true" + } + ], + "return": "LabelResponse" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels": { + "operationId": "getknowledgeknowledgebaselabels", + "functionName": "getKnowledgeKnowledgebaseLabels", + "signature": "getKnowledgeKnowledgebaseLabels(knowledgeBaseId, before, after, pageSize, name, includeDocumentCount)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "includeDocumentCount", + "type": "Bool", + "required": "false" + } + ], + "return": "LabelListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories": { + "operationId": "getknowledgeknowledgebaselanguagecategories", + "functionName": "getKnowledgeKnowledgebaseLanguageCategories", + "signature": "getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, before, after, limit, pageSize, name)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "CategoryListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}": { + "operationId": "getknowledgeknowledgebaselanguagecategory", + "functionName": "getKnowledgeKnowledgebaseLanguageCategory", + "signature": "getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeExtendedCategory" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}": { + "operationId": "getknowledgeknowledgebaselanguagedocument", + "functionName": "getKnowledgeKnowledgebaseLanguageDocument", + "signature": "getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeDocument" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents": { + "operationId": "getknowledgeknowledgebaselanguagedocuments", + "functionName": "getKnowledgeKnowledgebaseLanguageDocuments", + "signature": "getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, before, after, limit, pageSize, categories, title, sortBy, sortOrder, documentIds)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "categories", + "type": "String", + "required": "false" + }, + { + "name": "title", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "documentIds", + "type": "[String]", + "required": "false" + } + ], + "return": "DocumentListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}": { + "operationId": "getknowledgeknowledgebaselanguagedocumentsimport", + "functionName": "getKnowledgeKnowledgebaseLanguageDocumentsImport", + "signature": "getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "importId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeImport" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}": { + "operationId": "getknowledgeknowledgebaselanguagetraining", + "functionName": "getKnowledgeKnowledgebaseLanguageTraining", + "signature": "getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "trainingId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeTraining" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings": { + "operationId": "getknowledgeknowledgebaselanguagetrainings", + "functionName": "getKnowledgeKnowledgebaseLanguageTrainings", + "signature": "getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, before, after, limit, pageSize, knowledgeDocumentsState)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "knowledgeDocumentsState", + "type": "String", + "required": "false" + } + ], + "return": "TrainingListing" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}": { + "operationId": "getknowledgeknowledgebaseunansweredgroup", + "functionName": "getKnowledgeKnowledgebaseUnansweredGroup", + "signature": "getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, app, dateStart, dateEnd)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "app", + "type": "String", + "required": "false" + }, + { + "name": "dateStart", + "type": "Date", + "required": "false" + }, + { + "name": "dateEnd", + "type": "Date", + "required": "false" + } + ], + "return": "UnansweredGroup" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}": { + "operationId": "getknowledgeknowledgebaseunansweredgroupphrasegroup", + "functionName": "getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup", + "signature": "getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, app, dateStart, dateEnd)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "phraseGroupId", + "type": "String", + "required": "true" + }, + { + "name": "app", + "type": "String", + "required": "false" + }, + { + "name": "dateStart", + "type": "Date", + "required": "false" + }, + { + "name": "dateEnd", + "type": "Date", + "required": "false" + } + ], + "return": "UnansweredPhraseGroup" + }, + "GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups": { + "operationId": "getknowledgeknowledgebaseunansweredgroups", + "functionName": "getKnowledgeKnowledgebaseUnansweredGroups", + "signature": "getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, app, dateStart, dateEnd)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "app", + "type": "String", + "required": "false" + }, + { + "name": "dateStart", + "type": "Date", + "required": "false" + }, + { + "name": "dateEnd", + "type": "Date", + "required": "false" + } + ], + "return": "UnansweredGroups" + }, + "GET /api/v2/knowledge/knowledgebases": { + "operationId": "getknowledgeknowledgebases", + "functionName": "getKnowledgeKnowledgebases", + "signature": "getKnowledgeKnowledgebases(before, after, limit, pageSize, name, coreLanguage, published, sortBy, sortOrder)", + "parameters": [ + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "coreLanguage", + "type": "String", + "required": "false" + }, + { + "name": "published", + "type": "Bool", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "KnowledgeBaseListing" + }, + "PATCH /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}": { + "operationId": "patchknowledgeguestsessiondocumentssearchsearchid", + "functionName": "patchKnowledgeGuestSessionDocumentsSearchSearchId", + "signature": "patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId, searchId, body)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "searchId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SearchUpdateRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}": { + "operationId": "patchknowledgeknowledgebase", + "functionName": "patchKnowledgeKnowledgebase", + "signature": "patchKnowledgeKnowledgebase(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeBaseUpdateRequest", + "required": "true" + } + ], + "return": "KnowledgeBase" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}": { + "operationId": "patchknowledgeknowledgebasecategory", + "functionName": "patchKnowledgeKnowledgebaseCategory", + "signature": "patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "categoryId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CategoryUpdateRequest", + "required": "true" + } + ], + "return": "CategoryResponse" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}": { + "operationId": "patchknowledgeknowledgebasedocument", + "functionName": "patchKnowledgeKnowledgebaseDocument", + "signature": "patchKnowledgeKnowledgebaseDocument(knowledgeBaseId, documentId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentReq", + "required": "true" + } + ], + "return": "KnowledgeDocumentResponse" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}": { + "operationId": "patchknowledgeknowledgebasedocumentvariation", + "functionName": "patchKnowledgeKnowledgebaseDocumentVariation", + "signature": "patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId, documentId, knowledgeBaseId, body)", + "parameters": [ + { + "name": "documentVariationId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DocumentVariation", + "required": "true" + } + ], + "return": "DocumentVariation" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}": { + "operationId": "patchknowledgeknowledgebasedocumentssearchsearchid", + "functionName": "patchKnowledgeKnowledgebaseDocumentsSearchSearchId", + "signature": "patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId, searchId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "searchId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SearchUpdateRequest", + "required": "false" + } + ] + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}": { + "operationId": "patchknowledgeknowledgebaseimportjob", + "functionName": "patchKnowledgeKnowledgebaseImportJob", + "signature": "patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "importJobId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ImportStatusRequest", + "required": "true" + } + ], + "return": "KnowledgeImportJobResponse" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}": { + "operationId": "patchknowledgeknowledgebaselabel", + "functionName": "patchKnowledgeKnowledgebaseLabel", + "signature": "patchKnowledgeKnowledgebaseLabel(knowledgeBaseId, labelId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "labelId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LabelUpdateRequest", + "required": "true" + } + ], + "return": "LabelResponse" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}": { + "operationId": "patchknowledgeknowledgebaselanguagecategory", + "functionName": "patchKnowledgeKnowledgebaseLanguageCategory", + "signature": "patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeCategoryRequest", + "required": "true" + } + ], + "return": "KnowledgeExtendedCategory" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}": { + "operationId": "patchknowledgeknowledgebaselanguagedocument", + "functionName": "patchKnowledgeKnowledgebaseLanguageDocument", + "signature": "patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentRequest", + "required": "true" + } + ], + "return": "KnowledgeDocument" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents": { + "operationId": "patchknowledgeknowledgebaselanguagedocuments", + "functionName": "patchKnowledgeKnowledgebaseLanguageDocuments", + "signature": "patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[KnowledgeDocumentBulkRequest]", + "required": "true" + } + ], + "return": "DocumentListing" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}": { + "operationId": "patchknowledgeknowledgebaselanguagedocumentsimport", + "functionName": "patchKnowledgeKnowledgebaseLanguageDocumentsImport", + "signature": "patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "importId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ImportStatusRequest", + "required": "true" + } + ], + "return": "KnowledgeImport" + }, + "PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}": { + "operationId": "patchknowledgeknowledgebaseunansweredgroupphrasegroup", + "functionName": "patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup", + "signature": "patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "phraseGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UnansweredPhraseGroupPatchRequestBody", + "required": "true" + } + ], + "return": "UnansweredPhraseGroupUpdateResponse" + }, + "POST /api/v2/knowledge/documentuploads": { + "operationId": "postknowledgedocumentuploads", + "functionName": "postKnowledgeDocumentuploads", + "signature": "postKnowledgeDocumentuploads(body)", + "parameters": [ + { + "name": "body", + "type": "UploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback": { + "operationId": "postknowledgeguestsessiondocumentfeedback", + "functionName": "postKnowledgeGuestSessionDocumentFeedback", + "signature": "postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, body)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeGuestDocumentFeedback", + "required": "false" + } + ], + "return": "KnowledgeGuestDocumentFeedback" + }, + "POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search": { + "operationId": "postknowledgeguestsessiondocumentssearch", + "functionName": "postKnowledgeGuestSessionDocumentsSearch", + "signature": "postKnowledgeGuestSessionDocumentsSearch(sessionId, expand, body)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "body", + "type": "KnowledgeDocumentGuestSearchRequest", + "required": "false" + } + ], + "return": "KnowledgeDocumentGuestSearch" + }, + "POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions": { + "operationId": "postknowledgeguestsessiondocumentssearchsuggestions", + "functionName": "postKnowledgeGuestSessionDocumentsSearchSuggestions", + "signature": "postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId, body)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeGuestDocumentSuggestionRequest", + "required": "false" + } + ], + "return": "KnowledgeGuestDocumentSuggestion" + }, + "POST /api/v2/knowledge/guest/sessions": { + "operationId": "postknowledgeguestsessions", + "functionName": "postKnowledgeGuestSessions", + "signature": "postKnowledgeGuestSessions(body)", + "parameters": [ + { + "name": "body", + "type": "KnowledgeGuestSession", + "required": "true" + } + ], + "return": "KnowledgeGuestSession" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories": { + "operationId": "postknowledgeknowledgebasecategories", + "functionName": "postKnowledgeKnowledgebaseCategories", + "signature": "postKnowledgeKnowledgebaseCategories(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CategoryCreateRequest", + "required": "true" + } + ], + "return": "CategoryResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback": { + "operationId": "postknowledgeknowledgebasedocumentfeedback", + "functionName": "postKnowledgeKnowledgebaseDocumentFeedback", + "signature": "postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentFeedback", + "required": "false" + } + ], + "return": "KnowledgeDocumentFeedbackResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations": { + "operationId": "postknowledgeknowledgebasedocumentvariations", + "functionName": "postKnowledgeKnowledgebaseDocumentVariations", + "signature": "postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId, documentId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DocumentVariation", + "required": "true" + } + ], + "return": "DocumentVariation" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions": { + "operationId": "postknowledgeknowledgebasedocumentversions", + "functionName": "postKnowledgeKnowledgebaseDocumentVersions", + "signature": "postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId, documentId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentVersion", + "required": "true" + } + ], + "return": "KnowledgeDocumentVersion" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views": { + "operationId": "postknowledgeknowledgebasedocumentviews", + "functionName": "postKnowledgeKnowledgebaseDocumentViews", + "signature": "postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "documentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentView", + "required": "false" + } + ] + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents": { + "operationId": "postknowledgeknowledgebasedocuments", + "functionName": "postKnowledgeKnowledgebaseDocuments", + "signature": "postKnowledgeKnowledgebaseDocuments(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentReq", + "required": "true" + } + ], + "return": "KnowledgeDocumentResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search": { + "operationId": "postknowledgeknowledgebasedocumentssearch", + "functionName": "postKnowledgeKnowledgebaseDocumentsSearch", + "signature": "postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId, expand, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "body", + "type": "KnowledgeDocumentSearchRequest", + "required": "false" + } + ], + "return": "KnowledgeDocumentSearch" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions": { + "operationId": "postknowledgeknowledgebasedocumentssearchsuggestions", + "functionName": "postKnowledgeKnowledgebaseDocumentsSearchSuggestions", + "signature": "postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentSuggestionRequest", + "required": "false" + } + ], + "return": "KnowledgeDocumentSuggestion" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs": { + "operationId": "postknowledgeknowledgebaseexportjobs", + "functionName": "postKnowledgeKnowledgebaseExportJobs", + "signature": "postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeExportJobRequest", + "required": "true" + } + ], + "return": "KnowledgeExportJobResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs": { + "operationId": "postknowledgeknowledgebaseimportjobs", + "functionName": "postKnowledgeKnowledgebaseImportJobs", + "signature": "postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeImportJobRequest", + "required": "true" + } + ], + "return": "KnowledgeImportJobResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels": { + "operationId": "postknowledgeknowledgebaselabels", + "functionName": "postKnowledgeKnowledgebaseLabels", + "signature": "postKnowledgeKnowledgebaseLabels(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LabelCreateRequest", + "required": "true" + } + ], + "return": "LabelResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories": { + "operationId": "postknowledgeknowledgebaselanguagecategories", + "functionName": "postKnowledgeKnowledgebaseLanguageCategories", + "signature": "postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeCategoryRequest", + "required": "true" + } + ], + "return": "KnowledgeExtendedCategory" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents": { + "operationId": "postknowledgeknowledgebaselanguagedocuments", + "functionName": "postKnowledgeKnowledgebaseLanguageDocuments", + "signature": "postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeDocumentRequest", + "required": "true" + } + ], + "return": "KnowledgeDocument" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports": { + "operationId": "postknowledgeknowledgebaselanguagedocumentsimports", + "functionName": "postKnowledgeKnowledgebaseLanguageDocumentsImports", + "signature": "postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeImport", + "required": "true" + } + ], + "return": "KnowledgeImport" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote": { + "operationId": "postknowledgeknowledgebaselanguagetrainingpromote", + "functionName": "postKnowledgeKnowledgebaseLanguageTrainingPromote", + "signature": "postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + }, + { + "name": "trainingId", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeTraining" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings": { + "operationId": "postknowledgeknowledgebaselanguagetrainings", + "functionName": "postKnowledgeKnowledgebaseLanguageTrainings", + "signature": "postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "languageCode", + "type": "String", + "required": "true" + } + ], + "return": "KnowledgeTraining" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search": { + "operationId": "postknowledgeknowledgebasesearch", + "functionName": "postKnowledgeKnowledgebaseSearch", + "signature": "postKnowledgeKnowledgebaseSearch(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeSearchRequest", + "required": "false" + } + ], + "return": "KnowledgeSearchResponse" + }, + "POST /api/v2/knowledge/knowledgebases": { + "operationId": "postknowledgeknowledgebases", + "functionName": "postKnowledgeKnowledgebases", + "signature": "postKnowledgeKnowledgebases(body)", + "parameters": [ + { + "name": "body", + "type": "KnowledgeBaseCreateRequest", + "required": "true" + } + ], + "return": "KnowledgeBase" + } + +} \ No newline at end of file diff --git a/build/docs/LanguageUnderstandingAPI.json b/build/docs/LanguageUnderstandingAPI.json new file mode 100644 index 000000000..509235a51 --- /dev/null +++ b/build/docs/LanguageUnderstandingAPI.json @@ -0,0 +1,667 @@ +{ + "DELETE /api/v2/languageunderstanding/domains/{domainId}": { + "operationId": "deletelanguageunderstandingdomain", + "functionName": "deleteLanguageunderstandingDomain", + "signature": "deleteLanguageunderstandingDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}": { + "operationId": "deletelanguageunderstandingdomainfeedbackfeedbackid", + "functionName": "deleteLanguageunderstandingDomainFeedbackFeedbackId", + "signature": "deleteLanguageunderstandingDomainFeedbackFeedbackId(domainId, feedbackId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "feedbackId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}": { + "operationId": "deletelanguageunderstandingdomainversion", + "functionName": "deleteLanguageunderstandingDomainVersion", + "signature": "deleteLanguageunderstandingDomainVersion(domainId, domainVersionId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/languageunderstanding/miners/{minerId}": { + "operationId": "deletelanguageunderstandingminer", + "functionName": "deleteLanguageunderstandingMiner", + "signature": "deleteLanguageunderstandingMiner(minerId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}": { + "operationId": "deletelanguageunderstandingminerdraft", + "functionName": "deleteLanguageunderstandingMinerDraft", + "signature": "deleteLanguageunderstandingMinerDraft(minerId, draftId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "draftId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/languageunderstanding/domains/{domainId}": { + "operationId": "getlanguageunderstandingdomain", + "functionName": "getLanguageunderstandingDomain", + "signature": "getLanguageunderstandingDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "NluDomain" + }, + "GET /api/v2/languageunderstanding/domains/{domainId}/feedback": { + "operationId": "getlanguageunderstandingdomainfeedback", + "functionName": "getLanguageunderstandingDomainFeedback", + "signature": "getLanguageunderstandingDomainFeedback(domainId, intentName, assessment, dateStart, dateEnd, includeDeleted, language, pageNumber, pageSize, enableCursorPagination, includeTrainingUtterances, after, fields)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "intentName", + "type": "String", + "required": "false" + }, + { + "name": "assessment", + "type": "String", + "required": "false" + }, + { + "name": "dateStart", + "type": "Date", + "required": "false" + }, + { + "name": "dateEnd", + "type": "Date", + "required": "false" + }, + { + "name": "includeDeleted", + "type": "Bool", + "required": "false" + }, + { + "name": "language", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "enableCursorPagination", + "type": "Bool", + "required": "false" + }, + { + "name": "includeTrainingUtterances", + "type": "Bool", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "fields", + "type": "[String]", + "required": "false" + } + ], + "return": "NluFeedbackListing" + }, + "GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}": { + "operationId": "getlanguageunderstandingdomainfeedbackfeedbackid", + "functionName": "getLanguageunderstandingDomainFeedbackFeedbackId", + "signature": "getLanguageunderstandingDomainFeedbackFeedbackId(domainId, feedbackId, fields)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "feedbackId", + "type": "String", + "required": "true" + }, + { + "name": "fields", + "type": "[String]", + "required": "false" + } + ], + "return": "NluFeedbackResponse" + }, + "GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}": { + "operationId": "getlanguageunderstandingdomainversion", + "functionName": "getLanguageunderstandingDomainVersion", + "signature": "getLanguageunderstandingDomainVersion(domainId, domainVersionId, includeUtterances)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + }, + { + "name": "includeUtterances", + "type": "Bool", + "required": "false" + } + ], + "return": "NluDomainVersion" + }, + "GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report": { + "operationId": "getlanguageunderstandingdomainversionreport", + "functionName": "getLanguageunderstandingDomainVersionReport", + "signature": "getLanguageunderstandingDomainVersionReport(domainId, domainVersionId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + } + ], + "return": "NluDomainVersionQualityReport" + }, + "GET /api/v2/languageunderstanding/domains/{domainId}/versions": { + "operationId": "getlanguageunderstandingdomainversions", + "functionName": "getLanguageunderstandingDomainVersions", + "signature": "getLanguageunderstandingDomainVersions(domainId, includeUtterances, pageNumber, pageSize)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "includeUtterances", + "type": "Bool", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "NluDomainVersionListing" + }, + "GET /api/v2/languageunderstanding/domains": { + "operationId": "getlanguageunderstandingdomains", + "functionName": "getLanguageunderstandingDomains", + "signature": "getLanguageunderstandingDomains(pageNumber, pageSize)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "NluDomainListing" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}": { + "operationId": "getlanguageunderstandingminer", + "functionName": "getLanguageunderstandingMiner", + "signature": "getLanguageunderstandingMiner(minerId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + } + ], + "return": "Miner" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}": { + "operationId": "getlanguageunderstandingminerdraft", + "functionName": "getLanguageunderstandingMinerDraft", + "signature": "getLanguageunderstandingMinerDraft(minerId, draftId, draftIntentId, draftTopicId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "draftId", + "type": "String", + "required": "true" + }, + { + "name": "draftIntentId", + "type": "String", + "required": "false" + }, + { + "name": "draftTopicId", + "type": "String", + "required": "false" + } + ], + "return": "Draft" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/drafts": { + "operationId": "getlanguageunderstandingminerdrafts", + "functionName": "getLanguageunderstandingMinerDrafts", + "signature": "getLanguageunderstandingMinerDrafts(minerId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + } + ], + "return": "DraftListing" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}": { + "operationId": "getlanguageunderstandingminerintent", + "functionName": "getLanguageunderstandingMinerIntent", + "signature": "getLanguageunderstandingMinerIntent(minerId, intentId, expand)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "intentId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "MinerIntent" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/intents": { + "operationId": "getlanguageunderstandingminerintents", + "functionName": "getLanguageunderstandingMinerIntents", + "signature": "getLanguageunderstandingMinerIntents(minerId, expand)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "MinedIntentsListing" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}": { + "operationId": "getlanguageunderstandingminertopic", + "functionName": "getLanguageunderstandingMinerTopic", + "signature": "getLanguageunderstandingMinerTopic(minerId, topicId, expand)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "topicId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "MinerTopic" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}": { + "operationId": "getlanguageunderstandingminertopicphrase", + "functionName": "getLanguageunderstandingMinerTopicPhrase", + "signature": "getLanguageunderstandingMinerTopicPhrase(minerId, topicId, phraseId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "topicId", + "type": "String", + "required": "true" + }, + { + "name": "phraseId", + "type": "String", + "required": "true" + } + ], + "return": "MinerTopicPhrase" + }, + "GET /api/v2/languageunderstanding/miners/{minerId}/topics": { + "operationId": "getlanguageunderstandingminertopics", + "functionName": "getLanguageunderstandingMinerTopics", + "signature": "getLanguageunderstandingMinerTopics(minerId)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + } + ], + "return": "MinerTopicsListing" + }, + "GET /api/v2/languageunderstanding/miners": { + "operationId": "getlanguageunderstandingminers", + "functionName": "getLanguageunderstandingMiners", + "signature": "getLanguageunderstandingMiners(minerType)", + "parameters": [ + { + "name": "minerType", + "type": "String", + "required": "false" + } + ], + "return": "MinerListing" + }, + "PATCH /api/v2/languageunderstanding/domains/{domainId}": { + "operationId": "patchlanguageunderstandingdomain", + "functionName": "patchLanguageunderstandingDomain", + "signature": "patchLanguageunderstandingDomain(domainId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "NluDomain", + "required": "true" + } + ], + "return": "NluDomain" + }, + "PATCH /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}": { + "operationId": "patchlanguageunderstandingminerdraft", + "functionName": "patchLanguageunderstandingMinerDraft", + "signature": "patchLanguageunderstandingMinerDraft(minerId, draftId, body)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "draftId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DraftRequest", + "required": "false" + } + ], + "return": "Draft" + }, + "POST /api/v2/languageunderstanding/domains/{domainId}/feedback": { + "operationId": "postlanguageunderstandingdomainfeedback", + "functionName": "postLanguageunderstandingDomainFeedback", + "signature": "postLanguageunderstandingDomainFeedback(domainId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "NluFeedbackRequest", + "required": "true" + } + ], + "return": "NluFeedbackResponse" + }, + "POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect": { + "operationId": "postlanguageunderstandingdomainversiondetect", + "functionName": "postLanguageunderstandingDomainVersionDetect", + "signature": "postLanguageunderstandingDomainVersionDetect(domainId, domainVersionId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "NluDetectionRequest", + "required": "true" + } + ], + "return": "NluDetectionResponse" + }, + "POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish": { + "operationId": "postlanguageunderstandingdomainversionpublish", + "functionName": "postLanguageunderstandingDomainVersionPublish", + "signature": "postLanguageunderstandingDomainVersionPublish(domainId, domainVersionId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + } + ], + "return": "NluDomainVersion" + }, + "POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train": { + "operationId": "postlanguageunderstandingdomainversiontrain", + "functionName": "postLanguageunderstandingDomainVersionTrain", + "signature": "postLanguageunderstandingDomainVersionTrain(domainId, domainVersionId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + } + ], + "return": "NluDomainVersionTrainingResponse" + }, + "POST /api/v2/languageunderstanding/domains/{domainId}/versions": { + "operationId": "postlanguageunderstandingdomainversions", + "functionName": "postLanguageunderstandingDomainVersions", + "signature": "postLanguageunderstandingDomainVersions(domainId, body, includeUtterances)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "NluDomainVersion", + "required": "true" + }, + { + "name": "includeUtterances", + "type": "Bool", + "required": "false" + } + ], + "return": "NluDomainVersion" + }, + "POST /api/v2/languageunderstanding/domains": { + "operationId": "postlanguageunderstandingdomains", + "functionName": "postLanguageunderstandingDomains", + "signature": "postLanguageunderstandingDomains(body)", + "parameters": [ + { + "name": "body", + "type": "NluDomain", + "required": "true" + } + ], + "return": "NluDomain" + }, + "POST /api/v2/languageunderstanding/miners/{minerId}/drafts": { + "operationId": "postlanguageunderstandingminerdrafts", + "functionName": "postLanguageunderstandingMinerDrafts", + "signature": "postLanguageunderstandingMinerDrafts(minerId, body)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Draft", + "required": "true" + } + ], + "return": "Draft" + }, + "POST /api/v2/languageunderstanding/miners/{minerId}/execute": { + "operationId": "postlanguageunderstandingminerexecute", + "functionName": "postLanguageunderstandingMinerExecute", + "signature": "postLanguageunderstandingMinerExecute(minerId, body)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MinerExecuteRequest", + "required": "false" + } + ], + "return": "Miner" + }, + "POST /api/v2/languageunderstanding/miners": { + "operationId": "postlanguageunderstandingminers", + "functionName": "postLanguageunderstandingMiners", + "signature": "postLanguageunderstandingMiners(body)", + "parameters": [ + { + "name": "body", + "type": "Miner", + "required": "true" + } + ], + "return": "Miner" + }, + "PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}": { + "operationId": "putlanguageunderstandingdomainversion", + "functionName": "putLanguageunderstandingDomainVersion", + "signature": "putLanguageunderstandingDomainVersion(domainId, domainVersionId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "domainVersionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "NluDomainVersion", + "required": "true" + } + ], + "return": "NluDomainVersion" + } + +} \ No newline at end of file diff --git a/build/docs/LanguagesAPI.json b/build/docs/LanguagesAPI.json new file mode 100644 index 000000000..19f1492ee --- /dev/null +++ b/build/docs/LanguagesAPI.json @@ -0,0 +1,115 @@ +{ + "DELETE /api/v2/languages/{languageId}": { + "operationId": "deletelanguage", + "functionName": "deleteLanguage", + "signature": "deleteLanguage(languageId)", + "parameters": [ + { + "name": "languageId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/languages/{languageId}": { + "operationId": "getlanguage", + "functionName": "getLanguage", + "signature": "getLanguage(languageId)", + "parameters": [ + { + "name": "languageId", + "type": "String", + "required": "true" + } + ], + "return": "Language" + }, + "GET /api/v2/languages": { + "operationId": "getlanguages", + "functionName": "getLanguages", + "signature": "getLanguages(pageSize, pageNumber, sortOrder, name)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "LanguageEntityListing" + }, + "GET /api/v2/languages/translations": { + "operationId": "getlanguagestranslations", + "functionName": "getLanguagesTranslations", + "signature": "getLanguagesTranslations()", + + "return": "AvailableTranslations" + }, + "GET /api/v2/languages/translations/builtin": { + "operationId": "getlanguagestranslationsbuiltin", + "functionName": "getLanguagesTranslationsBuiltin", + "signature": "getLanguagesTranslationsBuiltin(language)", + "parameters": [ + { + "name": "language", + "type": "String", + "required": "true" + } + ], + "return": "[String:JSON]" + }, + "GET /api/v2/languages/translations/organization": { + "operationId": "getlanguagestranslationsorganization", + "functionName": "getLanguagesTranslationsOrganization", + "signature": "getLanguagesTranslationsOrganization(language)", + "parameters": [ + { + "name": "language", + "type": "String", + "required": "true" + } + ], + "return": "[String:JSON]" + }, + "GET /api/v2/languages/translations/users/{userId}": { + "operationId": "getlanguagestranslationsuser", + "functionName": "getLanguagesTranslationsUser", + "signature": "getLanguagesTranslationsUser(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "[String:JSON]" + }, + "POST /api/v2/languages": { + "operationId": "postlanguages", + "functionName": "postLanguages", + "signature": "postLanguages(body)", + "parameters": [ + { + "name": "body", + "type": "Language", + "required": "true" + } + ], + "return": "Language" + } + +} \ No newline at end of file diff --git a/build/docs/LearningAPI.json b/build/docs/LearningAPI.json new file mode 100644 index 000000000..3bded45cb --- /dev/null +++ b/build/docs/LearningAPI.json @@ -0,0 +1,640 @@ +{ + "DELETE /api/v2/learning/assignments/{assignmentId}": { + "operationId": "deletelearningassignment", + "functionName": "deleteLearningAssignment", + "signature": "deleteLearningAssignment(assignmentId)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/learning/modules/{moduleId}": { + "operationId": "deletelearningmodule", + "functionName": "deleteLearningModule", + "signature": "deleteLearningModule(moduleId)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/learning/assignments/{assignmentId}": { + "operationId": "getlearningassignment", + "functionName": "getLearningAssignment", + "signature": "getLearningAssignment(assignmentId, expand)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningAssignment" + }, + "GET /api/v2/learning/assignments": { + "operationId": "getlearningassignments", + "functionName": "getLearningAssignments", + "signature": "getLearningAssignments(moduleId, interval, completionInterval, overdue, pageSize, pageNumber, pass, minPercentageScore, maxPercentageScore, sortOrder, sortBy, userId, types, states, expand)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pass", + "type": "String", + "required": "false" + }, + { + "name": "minPercentageScore", + "type": "Float", + "required": "false" + }, + { + "name": "maxPercentageScore", + "type": "Float", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "userId", + "type": "[String]", + "required": "false" + }, + { + "name": "types", + "type": "[String]", + "required": "false" + }, + { + "name": "states", + "type": "[String]", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningAssignmentsDomainEntity" + }, + "GET /api/v2/learning/assignments/me": { + "operationId": "getlearningassignmentsme", + "functionName": "getLearningAssignmentsMe", + "signature": "getLearningAssignmentsMe(moduleId, interval, completionInterval, overdue, pageSize, pageNumber, pass, minPercentageScore, maxPercentageScore, sortOrder, sortBy, types, states, expand)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pass", + "type": "String", + "required": "false" + }, + { + "name": "minPercentageScore", + "type": "Float", + "required": "false" + }, + { + "name": "maxPercentageScore", + "type": "Float", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "types", + "type": "[String]", + "required": "false" + }, + { + "name": "states", + "type": "[String]", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningAssignmentsDomainEntity" + }, + "GET /api/v2/learning/modules/{moduleId}": { + "operationId": "getlearningmodule", + "functionName": "getLearningModule", + "signature": "getLearningModule(moduleId, expand)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningModule" + }, + "GET /api/v2/learning/modules/{moduleId}/jobs/{jobId}": { + "operationId": "getlearningmodulejob", + "functionName": "getLearningModuleJob", + "signature": "getLearningModuleJob(moduleId, jobId)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "LearningModuleJobResponse" + }, + "GET /api/v2/learning/modules/{moduleId}/rule": { + "operationId": "getlearningmodulerule", + "functionName": "getLearningModuleRule", + "signature": "getLearningModuleRule(moduleId)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + } + ], + "return": "LearningModuleRule" + }, + "GET /api/v2/learning/modules/{moduleId}/versions/{versionId}": { + "operationId": "getlearningmoduleversion", + "functionName": "getLearningModuleVersion", + "signature": "getLearningModuleVersion(moduleId, versionId, expand)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningModule" + }, + "GET /api/v2/learning/modules": { + "operationId": "getlearningmodules", + "functionName": "getLearningModules", + "signature": "getLearningModules(isArchived, types, pageSize, pageNumber, sortOrder, sortBy, searchTerm, expand, isPublished, statuses)", + "parameters": [ + { + "name": "isArchived", + "type": "Bool", + "required": "false" + }, + { + "name": "types", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "searchTerm", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "isPublished", + "type": "String", + "required": "false" + }, + { + "name": "statuses", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningModulesDomainEntityListing" + }, + "GET /api/v2/learning/modules/assignments": { + "operationId": "getlearningmodulesassignments", + "functionName": "getLearningModulesAssignments", + "signature": "getLearningModulesAssignments(userIds, pageSize, pageNumber, searchTerm, overdue, assignmentStates, expand)", + "parameters": [ + { + "name": "userIds", + "type": "[String]", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "searchTerm", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "assignmentStates", + "type": "[String]", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "AssignedLearningModuleDomainEntityListing" + }, + "GET /api/v2/learning/modules/coverart/{coverArtId}": { + "operationId": "getlearningmodulescoverartcoverartid", + "functionName": "getLearningModulesCoverartCoverArtId", + "signature": "getLearningModulesCoverartCoverArtId(coverArtId)", + "parameters": [ + { + "name": "coverArtId", + "type": "String", + "required": "true" + } + ], + "return": "LearningModuleCoverArtResponse" + }, + "PATCH /api/v2/learning/assignments/{assignmentId}": { + "operationId": "patchlearningassignment", + "functionName": "patchLearningAssignment", + "signature": "patchLearningAssignment(assignmentId, body)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningAssignmentUpdate", + "required": "false" + } + ], + "return": "LearningAssignment" + }, + "PATCH /api/v2/learning/assignments/{assignmentId}/reschedule": { + "operationId": "patchlearningassignmentreschedule", + "functionName": "patchLearningAssignmentReschedule", + "signature": "patchLearningAssignmentReschedule(assignmentId, body)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningAssignmentReschedule", + "required": "false" + } + ], + "return": "LearningAssignment" + }, + "POST /api/v2/learning/assessments/scoring": { + "operationId": "postlearningassessmentsscoring", + "functionName": "postLearningAssessmentsScoring", + "signature": "postLearningAssessmentsScoring(body)", + "parameters": [ + { + "name": "body", + "type": "LearningAssessmentScoringRequest", + "required": "true" + } + ], + "return": "AssessmentScoringSet" + }, + "POST /api/v2/learning/assignments/{assignmentId}/reassign": { + "operationId": "postlearningassignmentreassign", + "functionName": "postLearningAssignmentReassign", + "signature": "postLearningAssignmentReassign(assignmentId)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + } + ], + "return": "LearningAssignment" + }, + "POST /api/v2/learning/assignments/{assignmentId}/reset": { + "operationId": "postlearningassignmentreset", + "functionName": "postLearningAssignmentReset", + "signature": "postLearningAssignmentReset(assignmentId)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + } + ], + "return": "LearningAssignment" + }, + "POST /api/v2/learning/assignments": { + "operationId": "postlearningassignments", + "functionName": "postLearningAssignments", + "signature": "postLearningAssignments(body)", + "parameters": [ + { + "name": "body", + "type": "LearningAssignmentCreate", + "required": "false" + } + ], + "return": "LearningAssignment" + }, + "POST /api/v2/learning/assignments/aggregates/query": { + "operationId": "postlearningassignmentsaggregatesquery", + "functionName": "postLearningAssignmentsAggregatesQuery", + "signature": "postLearningAssignmentsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "LearningAssignmentAggregateParam", + "required": "true" + } + ], + "return": "LearningAssignmentAggregateResponse" + }, + "POST /api/v2/learning/assignments/bulkadd": { + "operationId": "postlearningassignmentsbulkadd", + "functionName": "postLearningAssignmentsBulkadd", + "signature": "postLearningAssignmentsBulkadd(body)", + "parameters": [ + { + "name": "body", + "type": "[LearningAssignmentItem]", + "required": "false" + } + ], + "return": "LearningAssignmentBulkAddResponse" + }, + "POST /api/v2/learning/assignments/bulkremove": { + "operationId": "postlearningassignmentsbulkremove", + "functionName": "postLearningAssignmentsBulkremove", + "signature": "postLearningAssignmentsBulkremove(body)", + "parameters": [ + { + "name": "body", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningAssignmentBulkRemoveResponse" + }, + "POST /api/v2/learning/modules/{moduleId}/jobs": { + "operationId": "postlearningmodulejobs", + "functionName": "postLearningModuleJobs", + "signature": "postLearningModuleJobs(moduleId, body)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningModuleJobRequest", + "required": "true" + } + ], + "return": "LearningModuleJobResponse" + }, + "POST /api/v2/learning/modules/{moduleId}/publish": { + "operationId": "postlearningmodulepublish", + "functionName": "postLearningModulePublish", + "signature": "postLearningModulePublish(moduleId, body)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningModulePublishRequest", + "required": "false" + } + ], + "return": "LearningModulePublishResponse" + }, + "POST /api/v2/learning/modules": { + "operationId": "postlearningmodules", + "functionName": "postLearningModules", + "signature": "postLearningModules(body)", + "parameters": [ + { + "name": "body", + "type": "LearningModuleRequest", + "required": "true" + } + ], + "return": "LearningModule" + }, + "POST /api/v2/learning/rules/query": { + "operationId": "postlearningrulesquery", + "functionName": "postLearningRulesQuery", + "signature": "postLearningRulesQuery(pageSize, pageNumber, body)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "true" + }, + { + "name": "body", + "type": "LearningAssignmentUserQuery", + "required": "true" + } + ], + "return": "LearningAssignmentUserListing" + }, + "POST /api/v2/learning/scheduleslots/query": { + "operationId": "postlearningscheduleslotsquery", + "functionName": "postLearningScheduleslotsQuery", + "signature": "postLearningScheduleslotsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "LearningScheduleSlotsQueryRequest", + "required": "true" + } + ], + "return": "LearningScheduleSlotsQueryResponse" + }, + "PUT /api/v2/learning/modules/{moduleId}": { + "operationId": "putlearningmodule", + "functionName": "putLearningModule", + "signature": "putLearningModule(moduleId, body)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningModuleRequest", + "required": "true" + } + ], + "return": "LearningModule" + }, + "PUT /api/v2/learning/modules/{moduleId}/rule": { + "operationId": "putlearningmodulerule", + "functionName": "putLearningModuleRule", + "signature": "putLearningModuleRule(moduleId, body)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LearningModuleRule", + "required": "true" + } + ], + "return": "LearningModuleRule" + } + +} \ No newline at end of file diff --git a/build/docs/LicenseAPI.json b/build/docs/LicenseAPI.json new file mode 100644 index 000000000..3015be314 --- /dev/null +++ b/build/docs/LicenseAPI.json @@ -0,0 +1,119 @@ +{ + "GET /api/v2/license/definitions/{licenseId}": { + "operationId": "getlicensedefinition", + "functionName": "getLicenseDefinition", + "signature": "getLicenseDefinition(licenseId)", + "parameters": [ + { + "name": "licenseId", + "type": "String", + "required": "true" + } + ], + "return": "LicenseDefinition" + }, + "GET /api/v2/license/definitions": { + "operationId": "getlicensedefinitions", + "functionName": "getLicenseDefinitions", + "signature": "getLicenseDefinitions()", + + "return": "[LicenseDefinition]" + }, + "GET /api/v2/license/toggles/{featureName}": { + "operationId": "getlicensetoggle", + "functionName": "getLicenseToggle", + "signature": "getLicenseToggle(featureName)", + "parameters": [ + { + "name": "featureName", + "type": "String", + "required": "true" + } + ], + "return": "LicenseOrgToggle" + }, + "GET /api/v2/license/users/{userId}": { + "operationId": "getlicenseuser", + "functionName": "getLicenseUser", + "signature": "getLicenseUser(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "LicenseUser" + }, + "GET /api/v2/license/users": { + "operationId": "getlicenseusers", + "functionName": "getLicenseUsers", + "signature": "getLicenseUsers(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "UserLicensesEntityListing" + }, + "POST /api/v2/license/infer": { + "operationId": "postlicenseinfer", + "functionName": "postLicenseInfer", + "signature": "postLicenseInfer(body)", + "parameters": [ + { + "name": "body", + "type": "[String]", + "required": "false" + } + ], + "return": "[String]" + }, + "POST /api/v2/license/organization": { + "operationId": "postlicenseorganization", + "functionName": "postLicenseOrganization", + "signature": "postLicenseOrganization(body)", + "parameters": [ + { + "name": "body", + "type": "LicenseBatchAssignmentRequest", + "required": "false" + } + ], + "return": "[LicenseUpdateStatus]" + }, + "POST /api/v2/license/toggles/{featureName}": { + "operationId": "postlicensetoggle", + "functionName": "postLicenseToggle", + "signature": "postLicenseToggle(featureName)", + "parameters": [ + { + "name": "featureName", + "type": "String", + "required": "true" + } + ], + "return": "LicenseOrgToggle" + }, + "POST /api/v2/license/users": { + "operationId": "postlicenseusers", + "functionName": "postLicenseUsers", + "signature": "postLicenseUsers(body)", + "parameters": [ + { + "name": "body", + "type": "[String]", + "required": "false" + } + ], + "return": "[String:JSON]" + } + +} \ No newline at end of file diff --git a/build/docs/LocationsAPI.json b/build/docs/LocationsAPI.json new file mode 100644 index 000000000..6cc684fdf --- /dev/null +++ b/build/docs/LocationsAPI.json @@ -0,0 +1,136 @@ +{ + "DELETE /api/v2/locations/{locationId}": { + "operationId": "deletelocation", + "functionName": "deleteLocation", + "signature": "deleteLocation(locationId)", + "parameters": [ + { + "name": "locationId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/locations/{locationId}": { + "operationId": "getlocation", + "functionName": "getLocation", + "signature": "getLocation(locationId, expand)", + "parameters": [ + { + "name": "locationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LocationDefinition" + }, + "GET /api/v2/locations/{locationId}/sublocations": { + "operationId": "getlocationsublocations", + "functionName": "getLocationSublocations", + "signature": "getLocationSublocations(locationId)", + "parameters": [ + { + "name": "locationId", + "type": "String", + "required": "true" + } + ], + "return": "LocationEntityListing" + }, + "GET /api/v2/locations": { + "operationId": "getlocations", + "functionName": "getLocations", + "signature": "getLocations(pageSize, pageNumber, _id, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "LocationEntityListing" + }, + "GET /api/v2/locations/search": { + "operationId": "getlocationssearch", + "functionName": "getLocationsSearch", + "signature": "getLocationsSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LocationsSearchResponse" + }, + "PATCH /api/v2/locations/{locationId}": { + "operationId": "patchlocation", + "functionName": "patchLocation", + "signature": "patchLocation(locationId, body)", + "parameters": [ + { + "name": "locationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "LocationUpdateDefinition", + "required": "true" + } + ], + "return": "LocationDefinition" + }, + "POST /api/v2/locations": { + "operationId": "postlocations", + "functionName": "postLocations", + "signature": "postLocations(body)", + "parameters": [ + { + "name": "body", + "type": "LocationCreateDefinition", + "required": "true" + } + ], + "return": "LocationDefinition" + }, + "POST /api/v2/locations/search": { + "operationId": "postlocationssearch", + "functionName": "postLocationsSearch", + "signature": "postLocationsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "LocationSearchRequest", + "required": "true" + } + ], + "return": "LocationsSearchResponse" + } + +} \ No newline at end of file diff --git a/build/docs/MessagingAPI.json b/build/docs/MessagingAPI.json new file mode 100644 index 000000000..7a43a2581 --- /dev/null +++ b/build/docs/MessagingAPI.json @@ -0,0 +1,177 @@ +{ + "DELETE /api/v2/messaging/settings/{messageSettingId}": { + "operationId": "deletemessagingsetting", + "functionName": "deleteMessagingSetting", + "signature": "deleteMessagingSetting(messageSettingId)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/messaging/settings/default": { + "operationId": "deletemessagingsettingsdefault", + "functionName": "deleteMessagingSettingsDefault", + "signature": "deleteMessagingSettingsDefault()" + + }, + "DELETE /api/v2/messaging/supportedcontent/{supportedContentId}": { + "operationId": "deletemessagingsupportedcontentsupportedcontentid", + "functionName": "deleteMessagingSupportedcontentSupportedContentId", + "signature": "deleteMessagingSupportedcontentSupportedContentId(supportedContentId)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/messaging/settings/{messageSettingId}": { + "operationId": "getmessagingsetting", + "functionName": "getMessagingSetting", + "signature": "getMessagingSetting(messageSettingId)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "GET /api/v2/messaging/settings": { + "operationId": "getmessagingsettings", + "functionName": "getMessagingSettings", + "signature": "getMessagingSettings(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "MessagingConfigListing" + }, + "GET /api/v2/messaging/settings/default": { + "operationId": "getmessagingsettingsdefault", + "functionName": "getMessagingSettingsDefault", + "signature": "getMessagingSettingsDefault()", + + "return": "MessagingSetting" + }, + "GET /api/v2/messaging/supportedcontent": { + "operationId": "getmessagingsupportedcontent", + "functionName": "getMessagingSupportedcontent", + "signature": "getMessagingSupportedcontent(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "SupportedContentListing" + }, + "GET /api/v2/messaging/supportedcontent/{supportedContentId}": { + "operationId": "getmessagingsupportedcontentsupportedcontentid", + "functionName": "getMessagingSupportedcontentSupportedContentId", + "signature": "getMessagingSupportedcontentSupportedContentId(supportedContentId)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "PATCH /api/v2/messaging/settings/{messageSettingId}": { + "operationId": "patchmessagingsetting", + "functionName": "patchMessagingSetting", + "signature": "patchMessagingSetting(messageSettingId, body)", + "parameters": [ + { + "name": "messageSettingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MessagingSettingRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "PATCH /api/v2/messaging/supportedcontent/{supportedContentId}": { + "operationId": "patchmessagingsupportedcontentsupportedcontentid", + "functionName": "patchMessagingSupportedcontentSupportedContentId", + "signature": "patchMessagingSupportedcontentSupportedContentId(supportedContentId, body)", + "parameters": [ + { + "name": "supportedContentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SupportedContent", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "POST /api/v2/messaging/settings": { + "operationId": "postmessagingsettings", + "functionName": "postMessagingSettings", + "signature": "postMessagingSettings(body)", + "parameters": [ + { + "name": "body", + "type": "MessagingSettingRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + }, + "POST /api/v2/messaging/supportedcontent": { + "operationId": "postmessagingsupportedcontent", + "functionName": "postMessagingSupportedcontent", + "signature": "postMessagingSupportedcontent(body)", + "parameters": [ + { + "name": "body", + "type": "SupportedContent", + "required": "true" + } + ], + "return": "SupportedContent" + }, + "PUT /api/v2/messaging/settings/default": { + "operationId": "putmessagingsettingsdefault", + "functionName": "putMessagingSettingsDefault", + "signature": "putMessagingSettingsDefault(body)", + "parameters": [ + { + "name": "body", + "type": "MessagingSettingDefaultRequest", + "required": "true" + } + ], + "return": "MessagingSetting" + } + +} \ No newline at end of file diff --git a/build/docs/MobileDevicesAPI.json b/build/docs/MobileDevicesAPI.json new file mode 100644 index 000000000..159e38291 --- /dev/null +++ b/build/docs/MobileDevicesAPI.json @@ -0,0 +1,82 @@ +{ + "DELETE /api/v2/mobiledevices/{deviceId}": { + "operationId": "deletemobiledevice", + "functionName": "deleteMobiledevice", + "signature": "deleteMobiledevice(deviceId)", + "parameters": [ + { + "name": "deviceId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/mobiledevices/{deviceId}": { + "operationId": "getmobiledevice", + "functionName": "getMobiledevice", + "signature": "getMobiledevice(deviceId)", + "parameters": [ + { + "name": "deviceId", + "type": "String", + "required": "true" + } + ], + "return": "UserDevice" + }, + "GET /api/v2/mobiledevices": { + "operationId": "getmobiledevices", + "functionName": "getMobiledevices", + "signature": "getMobiledevices(pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DirectoryUserDevicesListing" + }, + "POST /api/v2/mobiledevices": { + "operationId": "postmobiledevices", + "functionName": "postMobiledevices", + "signature": "postMobiledevices(body)", + "parameters": [ + { + "name": "body", + "type": "UserDevice", + "required": "true" + } + ], + "return": "UserDevice" + }, + "PUT /api/v2/mobiledevices/{deviceId}": { + "operationId": "putmobiledevice", + "functionName": "putMobiledevice", + "signature": "putMobiledevice(deviceId, body)", + "parameters": [ + { + "name": "deviceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserDevice", + "required": "false" + } + ], + "return": "UserDevice" + } + +} \ No newline at end of file diff --git a/build/docs/NotificationsAPI.json b/build/docs/NotificationsAPI.json new file mode 100644 index 000000000..ebce5e23a --- /dev/null +++ b/build/docs/NotificationsAPI.json @@ -0,0 +1,124 @@ +{ + "DELETE /api/v2/notifications/channels/{channelId}/subscriptions": { + "operationId": "deletenotificationschannelsubscriptions", + "functionName": "deleteNotificationsChannelSubscriptions", + "signature": "deleteNotificationsChannelSubscriptions(channelId)", + "parameters": [ + { + "name": "channelId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/notifications/availabletopics": { + "operationId": "getnotificationsavailabletopics", + "functionName": "getNotificationsAvailabletopics", + "signature": "getNotificationsAvailabletopics(expand, includePreview)", + "parameters": [ + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "includePreview", + "type": "Bool", + "required": "false" + } + ], + "return": "AvailableTopicEntityListing" + }, + "GET /api/v2/notifications/channels/{channelId}/subscriptions": { + "operationId": "getnotificationschannelsubscriptions", + "functionName": "getNotificationsChannelSubscriptions", + "signature": "getNotificationsChannelSubscriptions(channelId)", + "parameters": [ + { + "name": "channelId", + "type": "String", + "required": "true" + } + ], + "return": "ChannelTopicEntityListing" + }, + "GET /api/v2/notifications/channels": { + "operationId": "getnotificationschannels", + "functionName": "getNotificationsChannels", + "signature": "getNotificationsChannels(includechannels)", + "parameters": [ + { + "name": "includechannels", + "type": "String", + "required": "false" + } + ], + "return": "ChannelEntityListing" + }, + "HEAD /api/v2/notifications/channels/{channelId}": { + "operationId": "headnotificationschannel", + "functionName": "headNotificationsChannel", + "signature": "headNotificationsChannel(channelId)", + "parameters": [ + { + "name": "channelId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/notifications/channels/{channelId}/subscriptions": { + "operationId": "postnotificationschannelsubscriptions", + "functionName": "postNotificationsChannelSubscriptions", + "signature": "postNotificationsChannelSubscriptions(channelId, body, ignoreErrors)", + "parameters": [ + { + "name": "channelId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[ChannelTopic]", + "required": "true" + }, + { + "name": "ignoreErrors", + "type": "Bool", + "required": "false" + } + ], + "return": "ChannelTopicEntityListing" + }, + "POST /api/v2/notifications/channels": { + "operationId": "postnotificationschannels", + "functionName": "postNotificationsChannels", + "signature": "postNotificationsChannels()", + + "return": "Channel" + }, + "PUT /api/v2/notifications/channels/{channelId}/subscriptions": { + "operationId": "putnotificationschannelsubscriptions", + "functionName": "putNotificationsChannelSubscriptions", + "signature": "putNotificationsChannelSubscriptions(channelId, body, ignoreErrors)", + "parameters": [ + { + "name": "channelId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[ChannelTopic]", + "required": "true" + }, + { + "name": "ignoreErrors", + "type": "Bool", + "required": "false" + } + ], + "return": "ChannelTopicEntityListing" + } + +} \ No newline at end of file diff --git a/build/docs/OAuthAPI.json b/build/docs/OAuthAPI.json new file mode 100644 index 000000000..0f296684d --- /dev/null +++ b/build/docs/OAuthAPI.json @@ -0,0 +1,195 @@ +{ + "DELETE /api/v2/oauth/clients/{clientId}": { + "operationId": "deleteoauthclient", + "functionName": "deleteOauthClient", + "signature": "deleteOauthClient(clientId)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/oauth/authorizations/{clientId}": { + "operationId": "getoauthauthorization", + "functionName": "getOauthAuthorization", + "signature": "getOauthAuthorization(clientId, acceptLanguage)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "acceptLanguage", + "type": "String", + "required": "false" + } + ], + "return": "OAuthAuthorization" + }, + "GET /api/v2/oauth/authorizations": { + "operationId": "getoauthauthorizations", + "functionName": "getOauthAuthorizations", + "signature": "getOauthAuthorizations(acceptLanguage)", + "parameters": [ + { + "name": "acceptLanguage", + "type": "String", + "required": "false" + } + ], + "return": "OAuthAuthorizationListing" + }, + "GET /api/v2/oauth/clients/{clientId}": { + "operationId": "getoauthclient", + "functionName": "getOauthClient", + "signature": "getOauthClient(clientId)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "OAuthClient" + }, + "GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}": { + "operationId": "getoauthclientusagequeryresult", + "functionName": "getOauthClientUsageQueryResult", + "signature": "getOauthClientUsageQueryResult(executionId, clientId)", + "parameters": [ + { + "name": "executionId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "ApiUsageQueryResult" + }, + "GET /api/v2/oauth/clients/{clientId}/usage/summary": { + "operationId": "getoauthclientusagesummary", + "functionName": "getOauthClientUsageSummary", + "signature": "getOauthClientUsageSummary(clientId, days)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "days", + "type": "String", + "required": "false" + } + ], + "return": "UsageExecutionResult" + }, + "GET /api/v2/oauth/clients": { + "operationId": "getoauthclients", + "functionName": "getOauthClients", + "signature": "getOauthClients()", + + "return": "OAuthClientEntityListing" + }, + "GET /api/v2/oauth/scopes/{scopeId}": { + "operationId": "getoauthscope", + "functionName": "getOauthScope", + "signature": "getOauthScope(scopeId, acceptLanguage)", + "parameters": [ + { + "name": "scopeId", + "type": "String", + "required": "true" + }, + { + "name": "acceptLanguage", + "type": "String", + "required": "false" + } + ], + "return": "OAuthScope" + }, + "GET /api/v2/oauth/scopes": { + "operationId": "getoauthscopes", + "functionName": "getOauthScopes", + "signature": "getOauthScopes(acceptLanguage)", + "parameters": [ + { + "name": "acceptLanguage", + "type": "String", + "required": "false" + } + ], + "return": "OAuthScopeListing" + }, + "POST /api/v2/oauth/clients/{clientId}/secret": { + "operationId": "postoauthclientsecret", + "functionName": "postOauthClientSecret", + "signature": "postOauthClientSecret(clientId)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "OAuthClient" + }, + "POST /api/v2/oauth/clients/{clientId}/usage/query": { + "operationId": "postoauthclientusagequery", + "functionName": "postOauthClientUsageQuery", + "signature": "postOauthClientUsageQuery(clientId, body)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ApiUsageClientQuery", + "required": "true" + } + ], + "return": "UsageExecutionResult" + }, + "POST /api/v2/oauth/clients": { + "operationId": "postoauthclients", + "functionName": "postOauthClients", + "signature": "postOauthClients(body)", + "parameters": [ + { + "name": "body", + "type": "OAuthClientRequest", + "required": "true" + } + ], + "return": "OAuthClient" + }, + "PUT /api/v2/oauth/clients/{clientId}": { + "operationId": "putoauthclient", + "functionName": "putOauthClient", + "signature": "putOauthClient(clientId, body)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OAuthClientRequest", + "required": "true" + } + ], + "return": "OAuthClient" + } + +} \ No newline at end of file diff --git a/build/docs/ObjectsAPI.json b/build/docs/ObjectsAPI.json new file mode 100644 index 000000000..a7304d4ab --- /dev/null +++ b/build/docs/ObjectsAPI.json @@ -0,0 +1,176 @@ +{ + "DELETE /api/v2/authorization/divisions/{divisionId}": { + "operationId": "deleteauthorizationdivision", + "functionName": "deleteAuthorizationDivision", + "signature": "deleteAuthorizationDivision(divisionId, force)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "force", + "type": "Bool", + "required": "false" + } + ] + }, + "GET /api/v2/authorization/divisions/{divisionId}": { + "operationId": "getauthorizationdivision", + "functionName": "getAuthorizationDivision", + "signature": "getAuthorizationDivision(divisionId, objectCount)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "objectCount", + "type": "Bool", + "required": "false" + } + ], + "return": "AuthzDivision" + }, + "GET /api/v2/authorization/divisions": { + "operationId": "getauthorizationdivisions", + "functionName": "getAuthorizationDivisions", + "signature": "getAuthorizationDivisions(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, objectCount, _id, name)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "objectCount", + "type": "Bool", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "AuthzDivisionEntityListing" + }, + "GET /api/v2/authorization/divisions/home": { + "operationId": "getauthorizationdivisionshome", + "functionName": "getAuthorizationDivisionsHome", + "signature": "getAuthorizationDivisionsHome()", + + "return": "AuthzDivision" + }, + "GET /api/v2/authorization/divisions/limit": { + "operationId": "getauthorizationdivisionslimit", + "functionName": "getAuthorizationDivisionsLimit", + "signature": "getAuthorizationDivisionsLimit()", + + "return": "Int" + }, + "POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}": { + "operationId": "postauthorizationdivisionobject", + "functionName": "postAuthorizationDivisionObject", + "signature": "postAuthorizationDivisionObject(divisionId, objectType, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "objectType", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ] + }, + "POST /api/v2/authorization/divisions/{divisionId}/restore": { + "operationId": "postauthorizationdivisionrestore", + "functionName": "postAuthorizationDivisionRestore", + "signature": "postAuthorizationDivisionRestore(divisionId, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + }, + "POST /api/v2/authorization/divisions": { + "operationId": "postauthorizationdivisions", + "functionName": "postAuthorizationDivisions", + "signature": "postAuthorizationDivisions(body)", + "parameters": [ + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + }, + "PUT /api/v2/authorization/divisions/{divisionId}": { + "operationId": "putauthorizationdivision", + "functionName": "putAuthorizationDivision", + "signature": "putAuthorizationDivision(divisionId, body)", + "parameters": [ + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AuthzDivision", + "required": "true" + } + ], + "return": "AuthzDivision" + } + +} \ No newline at end of file diff --git a/build/docs/OrganizationAPI.json b/build/docs/OrganizationAPI.json new file mode 100644 index 000000000..7ba8272a7 --- /dev/null +++ b/build/docs/OrganizationAPI.json @@ -0,0 +1,231 @@ +{ + "GET /api/v2/fieldconfig": { + "operationId": "getfieldconfig", + "functionName": "getFieldconfig", + "signature": "getFieldconfig(type)", + "parameters": [ + { + "name": "type", + "type": "String", + "required": "true" + } + ], + "return": "FieldConfig" + }, + "GET /api/v2/organizations/authentication/settings": { + "operationId": "getorganizationsauthenticationsettings", + "functionName": "getOrganizationsAuthenticationSettings", + "signature": "getOrganizationsAuthenticationSettings()", + + "return": "OrgAuthSettings" + }, + "GET /api/v2/organizations/embeddedintegration": { + "operationId": "getorganizationsembeddedintegration", + "functionName": "getOrganizationsEmbeddedintegration", + "signature": "getOrganizationsEmbeddedintegration()", + + "return": "EmbeddedIntegration" + }, + "GET /api/v2/organizations/ipaddressauthentication": { + "operationId": "getorganizationsipaddressauthentication", + "functionName": "getOrganizationsIpaddressauthentication", + "signature": "getOrganizationsIpaddressauthentication()", + + "return": "IpAddressAuthentication" + }, + "GET /api/v2/organizations/limits/changerequests/{requestId}": { + "operationId": "getorganizationslimitschangerequest", + "functionName": "getOrganizationsLimitsChangerequest", + "signature": "getOrganizationsLimitsChangerequest(requestId)", + "parameters": [ + { + "name": "requestId", + "type": "String", + "required": "true" + } + ], + "return": "LimitChangeRequestDetails" + }, + "GET /api/v2/organizations/limits/changerequests": { + "operationId": "getorganizationslimitschangerequests", + "functionName": "getOrganizationsLimitsChangerequests", + "signature": "getOrganizationsLimitsChangerequests(after, before, status, pageSize, expand)", + "parameters": [ + { + "name": "after", + "type": "Int64", + "required": "false" + }, + { + "name": "before", + "type": "Int64", + "required": "false" + }, + { + "name": "status", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LimitChangeRequestsEntityListing" + }, + "GET /api/v2/organizations/limits/docs": { + "operationId": "getorganizationslimitsdocs", + "functionName": "getOrganizationsLimitsDocs", + "signature": "getOrganizationsLimitsDocs()", + + "return": "UrlResponse" + }, + "GET /api/v2/organizations/limits/namespaces/{namespaceName}": { + "operationId": "getorganizationslimitsnamespace", + "functionName": "getOrganizationsLimitsNamespace", + "signature": "getOrganizationsLimitsNamespace(namespaceName)", + "parameters": [ + { + "name": "namespaceName", + "type": "String", + "required": "true" + } + ], + "return": "LimitsEntityListing" + }, + "GET /api/v2/organizations/limits/namespaces/{namespaceName}/defaults": { + "operationId": "getorganizationslimitsnamespacedefaults", + "functionName": "getOrganizationsLimitsNamespaceDefaults", + "signature": "getOrganizationsLimitsNamespaceDefaults(namespaceName)", + "parameters": [ + { + "name": "namespaceName", + "type": "String", + "required": "true" + } + ], + "return": "LimitsEntityListing" + }, + "GET /api/v2/organizations/limits/namespaces": { + "operationId": "getorganizationslimitsnamespaces", + "functionName": "getOrganizationsLimitsNamespaces", + "signature": "getOrganizationsLimitsNamespaces(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "JSON" + }, + "GET /api/v2/organizations/me": { + "operationId": "getorganizationsme", + "functionName": "getOrganizationsMe", + "signature": "getOrganizationsMe()", + + "return": "Organization" + }, + "GET /api/v2/organizations/whitelist": { + "operationId": "getorganizationswhitelist", + "functionName": "getOrganizationsWhitelist", + "signature": "getOrganizationsWhitelist()", + + "return": "OrgWhitelistSettings" + }, + "PATCH /api/v2/organizations/authentication/settings": { + "operationId": "patchorganizationsauthenticationsettings", + "functionName": "patchOrganizationsAuthenticationSettings", + "signature": "patchOrganizationsAuthenticationSettings(body)", + "parameters": [ + { + "name": "body", + "type": "OrgAuthSettings", + "required": "true" + } + ], + "return": "OrgAuthSettings" + }, + "PATCH /api/v2/organizations/features/{featureName}": { + "operationId": "patchorganizationsfeature", + "functionName": "patchOrganizationsFeature", + "signature": "patchOrganizationsFeature(featureName, enabled)", + "parameters": [ + { + "name": "featureName", + "type": "String", + "required": "true" + }, + { + "name": "enabled", + "type": "FeatureState", + "required": "true" + } + ], + "return": "OrganizationFeatures" + }, + "PUT /api/v2/organizations/embeddedintegration": { + "operationId": "putorganizationsembeddedintegration", + "functionName": "putOrganizationsEmbeddedintegration", + "signature": "putOrganizationsEmbeddedintegration(body)", + "parameters": [ + { + "name": "body", + "type": "EmbeddedIntegration", + "required": "true" + } + ], + "return": "EmbeddedIntegration" + }, + "PUT /api/v2/organizations/ipaddressauthentication": { + "operationId": "putorganizationsipaddressauthentication", + "functionName": "putOrganizationsIpaddressauthentication", + "signature": "putOrganizationsIpaddressauthentication(body)", + "parameters": [ + { + "name": "body", + "type": "IpAddressAuthentication", + "required": "true" + } + ], + "return": "IpAddressAuthentication" + }, + "PUT /api/v2/organizations/me": { + "operationId": "putorganizationsme", + "functionName": "putOrganizationsMe", + "signature": "putOrganizationsMe(body)", + "parameters": [ + { + "name": "body", + "type": "Organization", + "required": "false" + } + ], + "return": "Organization" + }, + "PUT /api/v2/organizations/whitelist": { + "operationId": "putorganizationswhitelist", + "functionName": "putOrganizationsWhitelist", + "signature": "putOrganizationsWhitelist(body)", + "parameters": [ + { + "name": "body", + "type": "OrgWhitelistSettings", + "required": "true" + } + ], + "return": "OrgWhitelistSettings" + } + +} \ No newline at end of file diff --git a/build/docs/OrganizationAuthorizationAPI.json b/build/docs/OrganizationAuthorizationAPI.json new file mode 100644 index 000000000..d34196ff3 --- /dev/null +++ b/build/docs/OrganizationAuthorizationAPI.json @@ -0,0 +1,799 @@ +{ + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}": { + "operationId": "deleteorgauthorizationtrustee", + "functionName": "deleteOrgauthorizationTrustee", + "signature": "deleteOrgauthorizationTrustee(trusteeOrgId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}": { + "operationId": "deleteorgauthorizationtrusteecloneduser", + "functionName": "deleteOrgauthorizationTrusteeCloneduser", + "signature": "deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}": { + "operationId": "deleteorgauthorizationtrusteegroup", + "functionName": "deleteOrgauthorizationTrusteeGroup", + "signature": "deleteOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles": { + "operationId": "deleteorgauthorizationtrusteegrouproles", + "functionName": "deleteOrgauthorizationTrusteeGroupRoles", + "signature": "deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}": { + "operationId": "deleteorgauthorizationtrusteeuser", + "functionName": "deleteOrgauthorizationTrusteeUser", + "signature": "deleteOrgauthorizationTrusteeUser(trusteeOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles": { + "operationId": "deleteorgauthorizationtrusteeuserroles", + "functionName": "deleteOrgauthorizationTrusteeUserRoles", + "signature": "deleteOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}": { + "operationId": "deleteorgauthorizationtrustor", + "functionName": "deleteOrgauthorizationTrustor", + "signature": "deleteOrgauthorizationTrustor(trustorOrgId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}": { + "operationId": "deleteorgauthorizationtrustorcloneduser", + "functionName": "deleteOrgauthorizationTrustorCloneduser", + "signature": "deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}": { + "operationId": "deleteorgauthorizationtrustorgroup", + "functionName": "deleteOrgauthorizationTrustorGroup", + "signature": "deleteOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trustorGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}": { + "operationId": "deleteorgauthorizationtrustoruser", + "functionName": "deleteOrgauthorizationTrustorUser", + "signature": "deleteOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/orgauthorization/pairings/{pairingId}": { + "operationId": "getorgauthorizationpairing", + "functionName": "getOrgauthorizationPairing", + "signature": "getOrgauthorizationPairing(pairingId)", + "parameters": [ + { + "name": "pairingId", + "type": "String", + "required": "true" + } + ], + "return": "TrustRequest" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}": { + "operationId": "getorgauthorizationtrustee", + "functionName": "getOrgauthorizationTrustee", + "signature": "getOrgauthorizationTrustee(trusteeOrgId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + } + ], + "return": "Trustee" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers": { + "operationId": "getorgauthorizationtrusteeclonedusers", + "functionName": "getOrgauthorizationTrusteeClonedusers", + "signature": "getOrgauthorizationTrusteeClonedusers(trusteeOrgId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + } + ], + "return": "ClonedUserEntityListing" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}": { + "operationId": "getorgauthorizationtrusteegroup", + "functionName": "getOrgauthorizationTrusteeGroup", + "signature": "getOrgauthorizationTrusteeGroup(trusteeOrgId, trusteeGroupId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + } + ], + "return": "TrustGroup" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles": { + "operationId": "getorgauthorizationtrusteegrouproles", + "functionName": "getOrgauthorizationTrusteeGroupRoles", + "signature": "getOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups": { + "operationId": "getorgauthorizationtrusteegroups", + "functionName": "getOrgauthorizationTrusteeGroups", + "signature": "getOrgauthorizationTrusteeGroups(trusteeOrgId, pageSize, pageNumber)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustGroupEntityListing" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}": { + "operationId": "getorgauthorizationtrusteeuser", + "functionName": "getOrgauthorizationTrusteeUser", + "signature": "getOrgauthorizationTrusteeUser(trusteeOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "TrustUser" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles": { + "operationId": "getorgauthorizationtrusteeuserroles", + "functionName": "getOrgauthorizationTrusteeUserRoles", + "signature": "getOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users": { + "operationId": "getorgauthorizationtrusteeusers", + "functionName": "getOrgauthorizationTrusteeUsers", + "signature": "getOrgauthorizationTrusteeUsers(trusteeOrgId, pageSize, pageNumber)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustUserEntityListing" + }, + "GET /api/v2/orgauthorization/trustees": { + "operationId": "getorgauthorizationtrustees", + "functionName": "getOrgauthorizationTrustees", + "signature": "getOrgauthorizationTrustees(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustEntityListing" + }, + "GET /api/v2/orgauthorization/trustees/default": { + "operationId": "getorgauthorizationtrusteesdefault", + "functionName": "getOrgauthorizationTrusteesDefault", + "signature": "getOrgauthorizationTrusteesDefault()", + + "return": "Trustee" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}": { + "operationId": "getorgauthorizationtrustor", + "functionName": "getOrgauthorizationTrustor", + "signature": "getOrgauthorizationTrustor(trustorOrgId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + } + ], + "return": "Trustor" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}": { + "operationId": "getorgauthorizationtrustorcloneduser", + "functionName": "getOrgauthorizationTrustorCloneduser", + "signature": "getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "ClonedUser" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers": { + "operationId": "getorgauthorizationtrustorclonedusers", + "functionName": "getOrgauthorizationTrustorClonedusers", + "signature": "getOrgauthorizationTrustorClonedusers(trustorOrgId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + } + ], + "return": "ClonedUserEntityListing" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}": { + "operationId": "getorgauthorizationtrustorgroup", + "functionName": "getOrgauthorizationTrustorGroup", + "signature": "getOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trustorGroupId", + "type": "String", + "required": "true" + } + ], + "return": "TrustGroup" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups": { + "operationId": "getorgauthorizationtrustorgroups", + "functionName": "getOrgauthorizationTrustorGroups", + "signature": "getOrgauthorizationTrustorGroups(trustorOrgId, pageSize, pageNumber)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustGroupEntityListing" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}": { + "operationId": "getorgauthorizationtrustoruser", + "functionName": "getOrgauthorizationTrustorUser", + "signature": "getOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "TrustUser" + }, + "GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users": { + "operationId": "getorgauthorizationtrustorusers", + "functionName": "getOrgauthorizationTrustorUsers", + "signature": "getOrgauthorizationTrustorUsers(trustorOrgId, pageSize, pageNumber)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustUserEntityListing" + }, + "GET /api/v2/orgauthorization/trustors": { + "operationId": "getorgauthorizationtrustors", + "functionName": "getOrgauthorizationTrustors", + "signature": "getOrgauthorizationTrustors(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustorEntityListing" + }, + "POST /api/v2/orgauthorization/pairings": { + "operationId": "postorgauthorizationpairings", + "functionName": "postOrgauthorizationPairings", + "signature": "postOrgauthorizationPairings(body)", + "parameters": [ + { + "name": "body", + "type": "TrustRequestCreate", + "required": "true" + } + ], + "return": "TrustRequest" + }, + "POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups": { + "operationId": "postorgauthorizationtrusteegroups", + "functionName": "postOrgauthorizationTrusteeGroups", + "signature": "postOrgauthorizationTrusteeGroups(trusteeOrgId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TrustMemberCreate", + "required": "true" + } + ], + "return": "TrustGroup" + }, + "POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users": { + "operationId": "postorgauthorizationtrusteeusers", + "functionName": "postOrgauthorizationTrusteeUsers", + "signature": "postOrgauthorizationTrusteeUsers(trusteeOrgId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TrustMemberCreate", + "required": "true" + } + ], + "return": "TrustUser" + }, + "POST /api/v2/orgauthorization/trustees": { + "operationId": "postorgauthorizationtrustees", + "functionName": "postOrgauthorizationTrustees", + "signature": "postOrgauthorizationTrustees(body)", + "parameters": [ + { + "name": "body", + "type": "TrustCreate", + "required": "true" + } + ], + "return": "Trustee" + }, + "POST /api/v2/orgauthorization/trustees/audits": { + "operationId": "postorgauthorizationtrusteesaudits", + "functionName": "postOrgauthorizationTrusteesAudits", + "signature": "postOrgauthorizationTrusteesAudits(body, pageSize, pageNumber, sortBy, sortOrder)", + "parameters": [ + { + "name": "body", + "type": "TrusteeAuditQueryRequest", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "POST /api/v2/orgauthorization/trustees/default": { + "operationId": "postorgauthorizationtrusteesdefault", + "functionName": "postOrgauthorizationTrusteesDefault", + "signature": "postOrgauthorizationTrusteesDefault(assignDefaultRole, autoExpire)", + "parameters": [ + { + "name": "assignDefaultRole", + "type": "Bool", + "required": "false" + }, + { + "name": "autoExpire", + "type": "Bool", + "required": "false" + } + ], + "return": "Trustee" + }, + "POST /api/v2/orgauthorization/trustor/audits": { + "operationId": "postorgauthorizationtrustoraudits", + "functionName": "postOrgauthorizationTrustorAudits", + "signature": "postOrgauthorizationTrustorAudits(body, pageSize, pageNumber, sortBy, sortOrder)", + "parameters": [ + { + "name": "body", + "type": "TrustorAuditQueryRequest", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}": { + "operationId": "putorgauthorizationtrustee", + "functionName": "putOrgauthorizationTrustee", + "signature": "putOrgauthorizationTrustee(trusteeOrgId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TrustUpdate", + "required": "true" + } + ], + "return": "Trustee" + }, + "PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions": { + "operationId": "putorgauthorizationtrusteegrouproledivisions", + "functionName": "putOrgauthorizationTrusteeGroupRoledivisions", + "signature": "putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId, trusteeGroupId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles": { + "operationId": "putorgauthorizationtrusteegrouproles", + "functionName": "putOrgauthorizationTrusteeGroupRoles", + "signature": "putOrgauthorizationTrusteeGroupRoles(trusteeOrgId, trusteeGroupId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions": { + "operationId": "putorgauthorizationtrusteeuserroledivisions", + "functionName": "putOrgauthorizationTrusteeUserRoledivisions", + "signature": "putOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId, trusteeUserId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles": { + "operationId": "putorgauthorizationtrusteeuserroles", + "functionName": "putOrgauthorizationTrusteeUserRoles", + "signature": "putOrgauthorizationTrusteeUserRoles(trusteeOrgId, trusteeUserId, body)", + "parameters": [ + { + "name": "trusteeOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}": { + "operationId": "putorgauthorizationtrustorcloneduser", + "functionName": "putOrgauthorizationTrustorCloneduser", + "signature": "putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "ClonedUser" + }, + "PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}": { + "operationId": "putorgauthorizationtrustorgroup", + "functionName": "putOrgauthorizationTrustorGroup", + "signature": "putOrgauthorizationTrustorGroup(trustorOrgId, trustorGroupId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trustorGroupId", + "type": "String", + "required": "true" + } + ], + "return": "TrustGroup" + }, + "PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}": { + "operationId": "putorgauthorizationtrustoruser", + "functionName": "putOrgauthorizationTrustorUser", + "signature": "putOrgauthorizationTrustorUser(trustorOrgId, trusteeUserId)", + "parameters": [ + { + "name": "trustorOrgId", + "type": "String", + "required": "true" + }, + { + "name": "trusteeUserId", + "type": "String", + "required": "true" + } + ], + "return": "TrustUser" + } + +} \ No newline at end of file diff --git a/build/docs/OutboundAPI.json b/build/docs/OutboundAPI.json new file mode 100644 index 000000000..90ba33c3e --- /dev/null +++ b/build/docs/OutboundAPI.json @@ -0,0 +1,2598 @@ +{ + "DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId}": { + "operationId": "deleteoutboundattemptlimit", + "functionName": "deleteOutboundAttemptlimit", + "signature": "deleteOutboundAttemptlimit(attemptLimitsId)", + "parameters": [ + { + "name": "attemptLimitsId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId}": { + "operationId": "deleteoutboundcallabletimeset", + "functionName": "deleteOutboundCallabletimeset", + "signature": "deleteOutboundCallabletimeset(callableTimeSetId)", + "parameters": [ + { + "name": "callableTimeSetId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}": { + "operationId": "deleteoutboundcallanalysisresponseset", + "functionName": "deleteOutboundCallanalysisresponseset", + "signature": "deleteOutboundCallanalysisresponseset(callAnalysisSetId)", + "parameters": [ + { + "name": "callAnalysisSetId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/campaigns/{campaignId}": { + "operationId": "deleteoutboundcampaign", + "functionName": "deleteOutboundCampaign", + "signature": "deleteOutboundCampaign(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "Campaign" + }, + "DELETE /api/v2/outbound/campaigns/{campaignId}/progress": { + "operationId": "deleteoutboundcampaignprogress", + "functionName": "deleteOutboundCampaignProgress", + "signature": "deleteOutboundCampaignProgress(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/campaignrules/{campaignRuleId}": { + "operationId": "deleteoutboundcampaignrule", + "functionName": "deleteOutboundCampaignrule", + "signature": "deleteOutboundCampaignrule(campaignRuleId)", + "parameters": [ + { + "name": "campaignRuleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/contactlists/{contactListId}": { + "operationId": "deleteoutboundcontactlist", + "functionName": "deleteOutboundContactlist", + "signature": "deleteOutboundContactlist(contactListId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}": { + "operationId": "deleteoutboundcontactlistcontact", + "functionName": "deleteOutboundContactlistContact", + "signature": "deleteOutboundContactlistContact(contactListId, contactId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "contactId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/contactlists/{contactListId}/contacts": { + "operationId": "deleteoutboundcontactlistcontacts", + "functionName": "deleteOutboundContactlistContacts", + "signature": "deleteOutboundContactlistContacts(contactListId, contactIds)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "contactIds", + "type": "[String]", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId}": { + "operationId": "deleteoutboundcontactlistfilter", + "functionName": "deleteOutboundContactlistfilter", + "signature": "deleteOutboundContactlistfilter(contactListFilterId)", + "parameters": [ + { + "name": "contactListFilterId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/contactlists": { + "operationId": "deleteoutboundcontactlists", + "functionName": "deleteOutboundContactlists", + "signature": "deleteOutboundContactlists(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/digitalrulesets/{digitalRuleSetId}": { + "operationId": "deleteoutbounddigitalruleset", + "functionName": "deleteOutboundDigitalruleset", + "signature": "deleteOutboundDigitalruleset(digitalRuleSetId)", + "parameters": [ + { + "name": "digitalRuleSetId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/dnclists/{dncListId}": { + "operationId": "deleteoutbounddnclist", + "functionName": "deleteOutboundDnclist", + "signature": "deleteOutboundDnclist(dncListId)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns": { + "operationId": "deleteoutbounddnclistcustomexclusioncolumns", + "functionName": "deleteOutboundDnclistCustomexclusioncolumns", + "signature": "deleteOutboundDnclistCustomexclusioncolumns(dncListId, expiredOnly)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "expiredOnly", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/outbound/dnclists/{dncListId}/emailaddresses": { + "operationId": "deleteoutbounddnclistemailaddresses", + "functionName": "deleteOutboundDnclistEmailaddresses", + "signature": "deleteOutboundDnclistEmailaddresses(dncListId, expiredOnly)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "expiredOnly", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/outbound/dnclists/{dncListId}/phonenumbers": { + "operationId": "deleteoutbounddnclistphonenumbers", + "functionName": "deleteOutboundDnclistPhonenumbers", + "signature": "deleteOutboundDnclistPhonenumbers(dncListId, expiredOnly)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "expiredOnly", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}": { + "operationId": "deleteoutboundmessagingcampaign", + "functionName": "deleteOutboundMessagingcampaign", + "signature": "deleteOutboundMessagingcampaign(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingCampaign" + }, + "DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress": { + "operationId": "deleteoutboundmessagingcampaignprogress", + "functionName": "deleteOutboundMessagingcampaignProgress", + "signature": "deleteOutboundMessagingcampaignProgress(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/rulesets/{ruleSetId}": { + "operationId": "deleteoutboundruleset", + "functionName": "deleteOutboundRuleset", + "signature": "deleteOutboundRuleset(ruleSetId)", + "parameters": [ + { + "name": "ruleSetId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/schedules/campaigns/{campaignId}": { + "operationId": "deleteoutboundschedulescampaign", + "functionName": "deleteOutboundSchedulesCampaign", + "signature": "deleteOutboundSchedulesCampaign(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}": { + "operationId": "deleteoutboundschedulesemailcampaign", + "functionName": "deleteOutboundSchedulesEmailcampaign", + "signature": "deleteOutboundSchedulesEmailcampaign(emailCampaignId)", + "parameters": [ + { + "name": "emailCampaignId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}": { + "operationId": "deleteoutboundschedulesmessagingcampaign", + "functionName": "deleteOutboundSchedulesMessagingcampaign", + "signature": "deleteOutboundSchedulesMessagingcampaign(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/schedules/sequences/{sequenceId}": { + "operationId": "deleteoutboundschedulessequence", + "functionName": "deleteOutboundSchedulesSequence", + "signature": "deleteOutboundSchedulesSequence(sequenceId)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/outbound/sequences/{sequenceId}": { + "operationId": "deleteoutboundsequence", + "functionName": "deleteOutboundSequence", + "signature": "deleteOutboundSequence(sequenceId)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/outbound/attemptlimits/{attemptLimitsId}": { + "operationId": "getoutboundattemptlimit", + "functionName": "getOutboundAttemptlimit", + "signature": "getOutboundAttemptlimit(attemptLimitsId)", + "parameters": [ + { + "name": "attemptLimitsId", + "type": "String", + "required": "true" + } + ], + "return": "AttemptLimits" + }, + "GET /api/v2/outbound/attemptlimits": { + "operationId": "getoutboundattemptlimits", + "functionName": "getOutboundAttemptlimits", + "signature": "getOutboundAttemptlimits(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "AttemptLimitsEntityListing" + }, + "GET /api/v2/outbound/callabletimesets/{callableTimeSetId}": { + "operationId": "getoutboundcallabletimeset", + "functionName": "getOutboundCallabletimeset", + "signature": "getOutboundCallabletimeset(callableTimeSetId)", + "parameters": [ + { + "name": "callableTimeSetId", + "type": "String", + "required": "true" + } + ], + "return": "CallableTimeSet" + }, + "GET /api/v2/outbound/callabletimesets": { + "operationId": "getoutboundcallabletimesets", + "functionName": "getOutboundCallabletimesets", + "signature": "getOutboundCallabletimesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CallableTimeSetEntityListing" + }, + "GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}": { + "operationId": "getoutboundcallanalysisresponseset", + "functionName": "getOutboundCallanalysisresponseset", + "signature": "getOutboundCallanalysisresponseset(callAnalysisSetId)", + "parameters": [ + { + "name": "callAnalysisSetId", + "type": "String", + "required": "true" + } + ], + "return": "ResponseSet" + }, + "GET /api/v2/outbound/callanalysisresponsesets": { + "operationId": "getoutboundcallanalysisresponsesets", + "functionName": "getOutboundCallanalysisresponsesets", + "signature": "getOutboundCallanalysisresponsesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "ResponseSetEntityListing" + }, + "GET /api/v2/outbound/campaigns/{campaignId}": { + "operationId": "getoutboundcampaign", + "functionName": "getOutboundCampaign", + "signature": "getOutboundCampaign(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "Campaign" + }, + "GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results": { + "operationId": "getoutboundcampaignagentownedmappingpreviewresults", + "functionName": "getOutboundCampaignAgentownedmappingpreviewResults", + "signature": "getOutboundCampaignAgentownedmappingpreviewResults(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "AgentOwnedMappingPreviewListing" + }, + "GET /api/v2/outbound/campaigns/{campaignId}/diagnostics": { + "operationId": "getoutboundcampaigndiagnostics", + "functionName": "getOutboundCampaignDiagnostics", + "signature": "getOutboundCampaignDiagnostics(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignDiagnostics" + }, + "GET /api/v2/outbound/campaigns/{campaignId}/interactions": { + "operationId": "getoutboundcampaigninteractions", + "functionName": "getOutboundCampaignInteractions", + "signature": "getOutboundCampaignInteractions(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignInteractions" + }, + "GET /api/v2/outbound/campaigns/{campaignId}/progress": { + "operationId": "getoutboundcampaignprogress", + "functionName": "getOutboundCampaignProgress", + "signature": "getOutboundCampaignProgress(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignProgress" + }, + "GET /api/v2/outbound/campaigns/{campaignId}/stats": { + "operationId": "getoutboundcampaignstats", + "functionName": "getOutboundCampaignStats", + "signature": "getOutboundCampaignStats(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignStats" + }, + "GET /api/v2/outbound/campaignrules/{campaignRuleId}": { + "operationId": "getoutboundcampaignrule", + "functionName": "getOutboundCampaignrule", + "signature": "getOutboundCampaignrule(campaignRuleId)", + "parameters": [ + { + "name": "campaignRuleId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignRule" + }, + "GET /api/v2/outbound/campaignrules": { + "operationId": "getoutboundcampaignrules", + "functionName": "getOutboundCampaignrules", + "signature": "getOutboundCampaignrules(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CampaignRuleEntityListing" + }, + "GET /api/v2/outbound/campaigns": { + "operationId": "getoutboundcampaigns", + "functionName": "getOutboundCampaigns", + "signature": "getOutboundCampaigns(pageSize, pageNumber, filterType, name, _id, contactListId, dncListIds, distributionQueueId, edgeGroupId, callAnalysisResponseSetId, divisionId, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "contactListId", + "type": "String", + "required": "false" + }, + { + "name": "dncListIds", + "type": "String", + "required": "false" + }, + { + "name": "distributionQueueId", + "type": "String", + "required": "false" + }, + { + "name": "edgeGroupId", + "type": "String", + "required": "false" + }, + { + "name": "callAnalysisResponseSetId", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CampaignEntityListing" + }, + "GET /api/v2/outbound/campaigns/all": { + "operationId": "getoutboundcampaignsall", + "functionName": "getOutboundCampaignsAll", + "signature": "getOutboundCampaignsAll(pageSize, pageNumber, _id, name, divisionId, mediaType, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "mediaType", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CommonCampaignEntityListing" + }, + "GET /api/v2/outbound/campaigns/all/divisionviews": { + "operationId": "getoutboundcampaignsalldivisionviews", + "functionName": "getOutboundCampaignsAllDivisionviews", + "signature": "getOutboundCampaignsAllDivisionviews(pageSize, pageNumber, _id, name, divisionId, mediaType, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "mediaType", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CommonCampaignDivisionViewEntityListing" + }, + "GET /api/v2/outbound/campaigns/divisionviews/{campaignId}": { + "operationId": "getoutboundcampaignsdivisionview", + "functionName": "getOutboundCampaignsDivisionview", + "signature": "getOutboundCampaignsDivisionview(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignDivisionView" + }, + "GET /api/v2/outbound/campaigns/divisionviews": { + "operationId": "getoutboundcampaignsdivisionviews", + "functionName": "getOutboundCampaignsDivisionviews", + "signature": "getOutboundCampaignsDivisionviews(pageSize, pageNumber, filterType, name, _id, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CampaignDivisionViewListing" + }, + "GET /api/v2/outbound/contactlists/{contactListId}": { + "operationId": "getoutboundcontactlist", + "functionName": "getOutboundContactlist", + "signature": "getOutboundContactlist(contactListId, includeImportStatus, includeSize)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + } + ], + "return": "ContactList" + }, + "GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}": { + "operationId": "getoutboundcontactlistcontact", + "functionName": "getOutboundContactlistContact", + "signature": "getOutboundContactlistContact(contactListId, contactId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "contactId", + "type": "String", + "required": "true" + } + ], + "return": "DialerContact" + }, + "GET /api/v2/outbound/contactlists/{contactListId}/export": { + "operationId": "getoutboundcontactlistexport", + "functionName": "getOutboundContactlistExport", + "signature": "getOutboundContactlistExport(contactListId, download)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "download", + "type": "String", + "required": "false" + } + ], + "return": "ExportUri" + }, + "GET /api/v2/outbound/contactlists/{contactListId}/importstatus": { + "operationId": "getoutboundcontactlistimportstatus", + "functionName": "getOutboundContactlistImportstatus", + "signature": "getOutboundContactlistImportstatus(contactListId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + } + ], + "return": "ImportStatus" + }, + "GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview": { + "operationId": "getoutboundcontactlisttimezonemappingpreview", + "functionName": "getOutboundContactlistTimezonemappingpreview", + "signature": "getOutboundContactlistTimezonemappingpreview(contactListId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + } + ], + "return": "TimeZoneMappingPreview" + }, + "GET /api/v2/outbound/contactlistfilters/{contactListFilterId}": { + "operationId": "getoutboundcontactlistfilter", + "functionName": "getOutboundContactlistfilter", + "signature": "getOutboundContactlistfilter(contactListFilterId)", + "parameters": [ + { + "name": "contactListFilterId", + "type": "String", + "required": "true" + } + ], + "return": "ContactListFilter" + }, + "GET /api/v2/outbound/contactlistfilters": { + "operationId": "getoutboundcontactlistfilters", + "functionName": "getOutboundContactlistfilters", + "signature": "getOutboundContactlistfilters(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder, contactListId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "contactListId", + "type": "String", + "required": "false" + } + ], + "return": "ContactListFilterEntityListing" + }, + "GET /api/v2/outbound/contactlists": { + "operationId": "getoutboundcontactlists", + "functionName": "getOutboundContactlists", + "signature": "getOutboundContactlists(includeImportStatus, includeSize, pageSize, pageNumber, allowEmptyResult, filterType, name, _id, divisionId, sortBy, sortOrder)", + "parameters": [ + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "ContactListEntityListing" + }, + "GET /api/v2/outbound/contactlists/divisionviews/{contactListId}": { + "operationId": "getoutboundcontactlistsdivisionview", + "functionName": "getOutboundContactlistsDivisionview", + "signature": "getOutboundContactlistsDivisionview(contactListId, includeImportStatus, includeSize)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + } + ], + "return": "ContactListDivisionView" + }, + "GET /api/v2/outbound/contactlists/divisionviews": { + "operationId": "getoutboundcontactlistsdivisionviews", + "functionName": "getOutboundContactlistsDivisionviews", + "signature": "getOutboundContactlistsDivisionviews(includeImportStatus, includeSize, pageSize, pageNumber, filterType, name, _id, sortBy, sortOrder)", + "parameters": [ + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "ContactListDivisionViewListing" + }, + "GET /api/v2/outbound/digitalrulesets/{digitalRuleSetId}": { + "operationId": "getoutbounddigitalruleset", + "functionName": "getOutboundDigitalruleset", + "signature": "getOutboundDigitalruleset(digitalRuleSetId)", + "parameters": [ + { + "name": "digitalRuleSetId", + "type": "String", + "required": "true" + } + ], + "return": "DigitalRuleSet" + }, + "GET /api/v2/outbound/digitalrulesets": { + "operationId": "getoutbounddigitalrulesets", + "functionName": "getOutboundDigitalrulesets", + "signature": "getOutboundDigitalrulesets(pageSize, pageNumber, sortBy, sortOrder, name, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "DigitalRuleSetEntityListing" + }, + "GET /api/v2/outbound/dnclists/{dncListId}": { + "operationId": "getoutbounddnclist", + "functionName": "getOutboundDnclist", + "signature": "getOutboundDnclist(dncListId, includeImportStatus, includeSize)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + } + ], + "return": "DncList" + }, + "GET /api/v2/outbound/dnclists/{dncListId}/export": { + "operationId": "getoutbounddnclistexport", + "functionName": "getOutboundDnclistExport", + "signature": "getOutboundDnclistExport(dncListId, download)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "download", + "type": "String", + "required": "false" + } + ], + "return": "ExportUri" + }, + "GET /api/v2/outbound/dnclists/{dncListId}/importstatus": { + "operationId": "getoutbounddnclistimportstatus", + "functionName": "getOutboundDnclistImportstatus", + "signature": "getOutboundDnclistImportstatus(dncListId)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + } + ], + "return": "ImportStatus" + }, + "GET /api/v2/outbound/dnclists": { + "operationId": "getoutbounddnclists", + "functionName": "getOutboundDnclists", + "signature": "getOutboundDnclists(includeImportStatus, includeSize, pageSize, pageNumber, allowEmptyResult, filterType, name, dncSourceType, divisionId, sortBy, sortOrder)", + "parameters": [ + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "dncSourceType", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DncListEntityListing" + }, + "GET /api/v2/outbound/dnclists/divisionviews/{dncListId}": { + "operationId": "getoutbounddnclistsdivisionview", + "functionName": "getOutboundDnclistsDivisionview", + "signature": "getOutboundDnclistsDivisionview(dncListId, includeImportStatus, includeSize)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + } + ], + "return": "DncListDivisionView" + }, + "GET /api/v2/outbound/dnclists/divisionviews": { + "operationId": "getoutbounddnclistsdivisionviews", + "functionName": "getOutboundDnclistsDivisionviews", + "signature": "getOutboundDnclistsDivisionviews(includeImportStatus, includeSize, pageSize, pageNumber, filterType, name, dncSourceType, _id, sortBy, sortOrder)", + "parameters": [ + { + "name": "includeImportStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "includeSize", + "type": "Bool", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "dncSourceType", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DncListDivisionViewListing" + }, + "GET /api/v2/outbound/events/{eventId}": { + "operationId": "getoutboundevent", + "functionName": "getOutboundEvent", + "signature": "getOutboundEvent(eventId)", + "parameters": [ + { + "name": "eventId", + "type": "String", + "required": "true" + } + ], + "return": "EventLog" + }, + "GET /api/v2/outbound/events": { + "operationId": "getoutboundevents", + "functionName": "getOutboundEvents", + "signature": "getOutboundEvents(pageSize, pageNumber, filterType, category, level, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "category", + "type": "String", + "required": "false" + }, + { + "name": "level", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DialerEventEntityListing" + }, + "GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}": { + "operationId": "getoutboundmessagingcampaign", + "functionName": "getOutboundMessagingcampaign", + "signature": "getOutboundMessagingcampaign(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingCampaign" + }, + "GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics": { + "operationId": "getoutboundmessagingcampaigndiagnostics", + "functionName": "getOutboundMessagingcampaignDiagnostics", + "signature": "getOutboundMessagingcampaignDiagnostics(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingCampaignDiagnostics" + }, + "GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress": { + "operationId": "getoutboundmessagingcampaignprogress", + "functionName": "getOutboundMessagingcampaignProgress", + "signature": "getOutboundMessagingcampaignProgress(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignProgress" + }, + "GET /api/v2/outbound/messagingcampaigns": { + "operationId": "getoutboundmessagingcampaigns", + "functionName": "getOutboundMessagingcampaigns", + "signature": "getOutboundMessagingcampaigns(pageSize, pageNumber, sortBy, sortOrder, name, contactListId, divisionId, type, senderSmsPhoneNumber, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "contactListId", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "senderSmsPhoneNumber", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "MessagingCampaignEntityListing" + }, + "GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}": { + "operationId": "getoutboundmessagingcampaignsdivisionview", + "functionName": "getOutboundMessagingcampaignsDivisionview", + "signature": "getOutboundMessagingcampaignsDivisionview(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingCampaignDivisionView" + }, + "GET /api/v2/outbound/messagingcampaigns/divisionviews": { + "operationId": "getoutboundmessagingcampaignsdivisionviews", + "functionName": "getOutboundMessagingcampaignsDivisionviews", + "signature": "getOutboundMessagingcampaignsDivisionviews(pageSize, pageNumber, sortOrder, name, type, _id, senderSmsPhoneNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "senderSmsPhoneNumber", + "type": "String", + "required": "false" + } + ], + "return": "MessagingCampaignDivisionViewEntityListing" + }, + "GET /api/v2/outbound/rulesets/{ruleSetId}": { + "operationId": "getoutboundruleset", + "functionName": "getOutboundRuleset", + "signature": "getOutboundRuleset(ruleSetId)", + "parameters": [ + { + "name": "ruleSetId", + "type": "String", + "required": "true" + } + ], + "return": "RuleSet" + }, + "GET /api/v2/outbound/rulesets": { + "operationId": "getoutboundrulesets", + "functionName": "getOutboundRulesets", + "signature": "getOutboundRulesets(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "RuleSetEntityListing" + }, + "GET /api/v2/outbound/schedules/campaigns/{campaignId}": { + "operationId": "getoutboundschedulescampaign", + "functionName": "getOutboundSchedulesCampaign", + "signature": "getOutboundSchedulesCampaign(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignSchedule" + }, + "GET /api/v2/outbound/schedules/campaigns": { + "operationId": "getoutboundschedulescampaigns", + "functionName": "getOutboundSchedulesCampaigns", + "signature": "getOutboundSchedulesCampaigns()", + + "return": "[CampaignSchedule]" + }, + "GET /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}": { + "operationId": "getoutboundschedulesemailcampaign", + "functionName": "getOutboundSchedulesEmailcampaign", + "signature": "getOutboundSchedulesEmailcampaign(emailCampaignId)", + "parameters": [ + { + "name": "emailCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "EmailCampaignSchedule" + }, + "GET /api/v2/outbound/schedules/emailcampaigns": { + "operationId": "getoutboundschedulesemailcampaigns", + "functionName": "getOutboundSchedulesEmailcampaigns", + "signature": "getOutboundSchedulesEmailcampaigns()", + + "return": "MessagingCampaignScheduleEntityListing" + }, + "GET /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}": { + "operationId": "getoutboundschedulesmessagingcampaign", + "functionName": "getOutboundSchedulesMessagingcampaign", + "signature": "getOutboundSchedulesMessagingcampaign(messagingCampaignId)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + } + ], + "return": "MessagingCampaignSchedule" + }, + "GET /api/v2/outbound/schedules/messagingcampaigns": { + "operationId": "getoutboundschedulesmessagingcampaigns", + "functionName": "getOutboundSchedulesMessagingcampaigns", + "signature": "getOutboundSchedulesMessagingcampaigns()", + + "return": "MessagingCampaignScheduleEntityListing" + }, + "GET /api/v2/outbound/schedules/sequences/{sequenceId}": { + "operationId": "getoutboundschedulessequence", + "functionName": "getOutboundSchedulesSequence", + "signature": "getOutboundSchedulesSequence(sequenceId)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + } + ], + "return": "SequenceSchedule" + }, + "GET /api/v2/outbound/schedules/sequences": { + "operationId": "getoutboundschedulessequences", + "functionName": "getOutboundSchedulesSequences", + "signature": "getOutboundSchedulesSequences()", + + "return": "[SequenceSchedule]" + }, + "GET /api/v2/outbound/sequences/{sequenceId}": { + "operationId": "getoutboundsequence", + "functionName": "getOutboundSequence", + "signature": "getOutboundSequence(sequenceId)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + } + ], + "return": "CampaignSequence" + }, + "GET /api/v2/outbound/sequences": { + "operationId": "getoutboundsequences", + "functionName": "getOutboundSequences", + "signature": "getOutboundSequences(pageSize, pageNumber, allowEmptyResult, filterType, name, sortBy, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "allowEmptyResult", + "type": "Bool", + "required": "false" + }, + { + "name": "filterType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "CampaignSequenceEntityListing" + }, + "GET /api/v2/outbound/settings": { + "operationId": "getoutboundsettings", + "functionName": "getOutboundSettings", + "signature": "getOutboundSettings()", + + "return": "OutboundSettings" + }, + "GET /api/v2/outbound/wrapupcodemappings": { + "operationId": "getoutboundwrapupcodemappings", + "functionName": "getOutboundWrapupcodemappings", + "signature": "getOutboundWrapupcodemappings()", + + "return": "WrapUpCodeMapping" + }, + "PATCH /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns": { + "operationId": "patchoutbounddnclistcustomexclusioncolumns", + "functionName": "patchOutboundDnclistCustomexclusioncolumns", + "signature": "patchOutboundDnclistCustomexclusioncolumns(dncListId, body)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DncPatchCustomExclusionColumnsRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/outbound/dnclists/{dncListId}/emailaddresses": { + "operationId": "patchoutbounddnclistemailaddresses", + "functionName": "patchOutboundDnclistEmailaddresses", + "signature": "patchOutboundDnclistEmailaddresses(dncListId, body)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DncPatchEmailsRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/outbound/dnclists/{dncListId}/phonenumbers": { + "operationId": "patchoutbounddnclistphonenumbers", + "functionName": "patchOutboundDnclistPhonenumbers", + "signature": "patchOutboundDnclistPhonenumbers(dncListId, body)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DncPatchPhoneNumbersRequest", + "required": "true" + } + ] + }, + "PATCH /api/v2/outbound/settings": { + "operationId": "patchoutboundsettings", + "functionName": "patchOutboundSettings", + "signature": "patchOutboundSettings(body)", + "parameters": [ + { + "name": "body", + "type": "OutboundSettings", + "required": "true" + } + ] + }, + "POST /api/v2/outbound/attemptlimits": { + "operationId": "postoutboundattemptlimits", + "functionName": "postOutboundAttemptlimits", + "signature": "postOutboundAttemptlimits(body)", + "parameters": [ + { + "name": "body", + "type": "AttemptLimits", + "required": "true" + } + ], + "return": "AttemptLimits" + }, + "POST /api/v2/outbound/audits": { + "operationId": "postoutboundaudits", + "functionName": "postOutboundAudits", + "signature": "postOutboundAudits(body, pageSize, pageNumber, sortBy, sortOrder, facetsOnly)", + "parameters": [ + { + "name": "body", + "type": "DialerAuditRequest", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "facetsOnly", + "type": "Bool", + "required": "false" + } + ], + "return": "AuditSearchResult" + }, + "POST /api/v2/outbound/callabletimesets": { + "operationId": "postoutboundcallabletimesets", + "functionName": "postOutboundCallabletimesets", + "signature": "postOutboundCallabletimesets(body)", + "parameters": [ + { + "name": "body", + "type": "CallableTimeSet", + "required": "true" + } + ], + "return": "CallableTimeSet" + }, + "POST /api/v2/outbound/callanalysisresponsesets": { + "operationId": "postoutboundcallanalysisresponsesets", + "functionName": "postOutboundCallanalysisresponsesets", + "signature": "postOutboundCallanalysisresponsesets(body)", + "parameters": [ + { + "name": "body", + "type": "ResponseSet", + "required": "true" + } + ], + "return": "ResponseSet" + }, + "POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview": { + "operationId": "postoutboundcampaignagentownedmappingpreview", + "functionName": "postOutboundCampaignAgentownedmappingpreview", + "signature": "postOutboundCampaignAgentownedmappingpreview(campaignId)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule": { + "operationId": "postoutboundcampaigncallbackschedule", + "functionName": "postOutboundCampaignCallbackSchedule", + "signature": "postOutboundCampaignCallbackSchedule(campaignId, body)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ContactCallbackRequest", + "required": "true" + } + ], + "return": "ContactCallbackRequest" + }, + "POST /api/v2/outbound/campaignrules": { + "operationId": "postoutboundcampaignrules", + "functionName": "postOutboundCampaignrules", + "signature": "postOutboundCampaignrules(body)", + "parameters": [ + { + "name": "body", + "type": "CampaignRule", + "required": "true" + } + ], + "return": "CampaignRule" + }, + "POST /api/v2/outbound/campaigns": { + "operationId": "postoutboundcampaigns", + "functionName": "postOutboundCampaigns", + "signature": "postOutboundCampaigns(body)", + "parameters": [ + { + "name": "body", + "type": "Campaign", + "required": "true" + } + ], + "return": "Campaign" + }, + "POST /api/v2/outbound/campaigns/progress": { + "operationId": "postoutboundcampaignsprogress", + "functionName": "postOutboundCampaignsProgress", + "signature": "postOutboundCampaignsProgress(body)", + "parameters": [ + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[CampaignProgress]" + }, + "POST /api/v2/outbound/contactlists/{contactListId}/clear": { + "operationId": "postoutboundcontactlistclear", + "functionName": "postOutboundContactlistClear", + "signature": "postOutboundContactlistClear(contactListId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/outbound/contactlists/{contactListId}/contacts": { + "operationId": "postoutboundcontactlistcontacts", + "functionName": "postOutboundContactlistContacts", + "signature": "postOutboundContactlistContacts(contactListId, body, priority, clearSystemData, doNotQueue)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[WritableDialerContact]", + "required": "true" + }, + { + "name": "priority", + "type": "Bool", + "required": "false" + }, + { + "name": "clearSystemData", + "type": "Bool", + "required": "false" + }, + { + "name": "doNotQueue", + "type": "Bool", + "required": "false" + } + ], + "return": "[DialerContact]" + }, + "POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk": { + "operationId": "postoutboundcontactlistcontactsbulk", + "functionName": "postOutboundContactlistContactsBulk", + "signature": "postOutboundContactlistContactsBulk(contactListId, body)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[DialerContact]" + }, + "POST /api/v2/outbound/contactlists/{contactListId}/export": { + "operationId": "postoutboundcontactlistexport", + "functionName": "postOutboundContactlistExport", + "signature": "postOutboundContactlistExport(contactListId)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + } + ], + "return": "DomainEntityRef" + }, + "POST /api/v2/outbound/contactlistfilters": { + "operationId": "postoutboundcontactlistfilters", + "functionName": "postOutboundContactlistfilters", + "signature": "postOutboundContactlistfilters(body)", + "parameters": [ + { + "name": "body", + "type": "ContactListFilter", + "required": "true" + } + ], + "return": "ContactListFilter" + }, + "POST /api/v2/outbound/contactlistfilters/preview": { + "operationId": "postoutboundcontactlistfilterspreview", + "functionName": "postOutboundContactlistfiltersPreview", + "signature": "postOutboundContactlistfiltersPreview(body)", + "parameters": [ + { + "name": "body", + "type": "ContactListFilter", + "required": "true" + } + ], + "return": "FilterPreviewResponse" + }, + "POST /api/v2/outbound/contactlists": { + "operationId": "postoutboundcontactlists", + "functionName": "postOutboundContactlists", + "signature": "postOutboundContactlists(body)", + "parameters": [ + { + "name": "body", + "type": "ContactList", + "required": "true" + } + ], + "return": "ContactList" + }, + "POST /api/v2/outbound/conversations/{conversationId}/dnc": { + "operationId": "postoutboundconversationdnc", + "functionName": "postOutboundConversationDnc", + "signature": "postOutboundConversationDnc(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/outbound/digitalrulesets": { + "operationId": "postoutbounddigitalrulesets", + "functionName": "postOutboundDigitalrulesets", + "signature": "postOutboundDigitalrulesets(body)", + "parameters": [ + { + "name": "body", + "type": "DigitalRuleSet", + "required": "true" + } + ], + "return": "DigitalRuleSet" + }, + "POST /api/v2/outbound/dnclists/{dncListId}/emailaddresses": { + "operationId": "postoutbounddnclistemailaddresses", + "functionName": "postOutboundDnclistEmailaddresses", + "signature": "postOutboundDnclistEmailaddresses(dncListId, body)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ] + }, + "POST /api/v2/outbound/dnclists/{dncListId}/export": { + "operationId": "postoutbounddnclistexport", + "functionName": "postOutboundDnclistExport", + "signature": "postOutboundDnclistExport(dncListId)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + } + ], + "return": "DomainEntityRef" + }, + "POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers": { + "operationId": "postoutbounddnclistphonenumbers", + "functionName": "postOutboundDnclistPhonenumbers", + "signature": "postOutboundDnclistPhonenumbers(dncListId, body, expirationDateTime)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + }, + { + "name": "expirationDateTime", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/outbound/dnclists": { + "operationId": "postoutbounddnclists", + "functionName": "postOutboundDnclists", + "signature": "postOutboundDnclists(body)", + "parameters": [ + { + "name": "body", + "type": "DncListCreate", + "required": "true" + } + ], + "return": "DncList" + }, + "POST /api/v2/outbound/messagingcampaigns": { + "operationId": "postoutboundmessagingcampaigns", + "functionName": "postOutboundMessagingcampaigns", + "signature": "postOutboundMessagingcampaigns(body)", + "parameters": [ + { + "name": "body", + "type": "MessagingCampaign", + "required": "true" + } + ], + "return": "MessagingCampaign" + }, + "POST /api/v2/outbound/messagingcampaigns/progress": { + "operationId": "postoutboundmessagingcampaignsprogress", + "functionName": "postOutboundMessagingcampaignsProgress", + "signature": "postOutboundMessagingcampaignsProgress(body)", + "parameters": [ + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[CampaignProgress]" + }, + "POST /api/v2/outbound/rulesets": { + "operationId": "postoutboundrulesets", + "functionName": "postOutboundRulesets", + "signature": "postOutboundRulesets(body)", + "parameters": [ + { + "name": "body", + "type": "RuleSet", + "required": "true" + } + ], + "return": "RuleSet" + }, + "POST /api/v2/outbound/sequences": { + "operationId": "postoutboundsequences", + "functionName": "postOutboundSequences", + "signature": "postOutboundSequences(body)", + "parameters": [ + { + "name": "body", + "type": "CampaignSequence", + "required": "true" + } + ], + "return": "CampaignSequence" + }, + "PUT /api/v2/outbound/attemptlimits/{attemptLimitsId}": { + "operationId": "putoutboundattemptlimit", + "functionName": "putOutboundAttemptlimit", + "signature": "putOutboundAttemptlimit(attemptLimitsId, body)", + "parameters": [ + { + "name": "attemptLimitsId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AttemptLimits", + "required": "true" + } + ], + "return": "AttemptLimits" + }, + "PUT /api/v2/outbound/callabletimesets/{callableTimeSetId}": { + "operationId": "putoutboundcallabletimeset", + "functionName": "putOutboundCallabletimeset", + "signature": "putOutboundCallabletimeset(callableTimeSetId, body)", + "parameters": [ + { + "name": "callableTimeSetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CallableTimeSet", + "required": "true" + } + ], + "return": "CallableTimeSet" + }, + "PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}": { + "operationId": "putoutboundcallanalysisresponseset", + "functionName": "putOutboundCallanalysisresponseset", + "signature": "putOutboundCallanalysisresponseset(callAnalysisSetId, body)", + "parameters": [ + { + "name": "callAnalysisSetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ResponseSet", + "required": "true" + } + ], + "return": "ResponseSet" + }, + "PUT /api/v2/outbound/campaigns/{campaignId}": { + "operationId": "putoutboundcampaign", + "functionName": "putOutboundCampaign", + "signature": "putOutboundCampaign(campaignId, body)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Campaign", + "required": "true" + } + ], + "return": "Campaign" + }, + "PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId}": { + "operationId": "putoutboundcampaignagent", + "functionName": "putOutboundCampaignAgent", + "signature": "putOutboundCampaignAgent(campaignId, userId, body)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Agent", + "required": "true" + } + ], + "return": "String" + }, + "PUT /api/v2/outbound/campaignrules/{campaignRuleId}": { + "operationId": "putoutboundcampaignrule", + "functionName": "putOutboundCampaignrule", + "signature": "putOutboundCampaignrule(campaignRuleId, body)", + "parameters": [ + { + "name": "campaignRuleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CampaignRule", + "required": "true" + } + ], + "return": "CampaignRule" + }, + "PUT /api/v2/outbound/contactlists/{contactListId}": { + "operationId": "putoutboundcontactlist", + "functionName": "putOutboundContactlist", + "signature": "putOutboundContactlist(contactListId, body)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ContactList", + "required": "true" + } + ], + "return": "ContactList" + }, + "PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}": { + "operationId": "putoutboundcontactlistcontact", + "functionName": "putOutboundContactlistContact", + "signature": "putOutboundContactlistContact(contactListId, contactId, body)", + "parameters": [ + { + "name": "contactListId", + "type": "String", + "required": "true" + }, + { + "name": "contactId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DialerContact", + "required": "true" + } + ], + "return": "DialerContact" + }, + "PUT /api/v2/outbound/contactlistfilters/{contactListFilterId}": { + "operationId": "putoutboundcontactlistfilter", + "functionName": "putOutboundContactlistfilter", + "signature": "putOutboundContactlistfilter(contactListFilterId, body)", + "parameters": [ + { + "name": "contactListFilterId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ContactListFilter", + "required": "true" + } + ], + "return": "ContactListFilter" + }, + "PUT /api/v2/outbound/digitalrulesets/{digitalRuleSetId}": { + "operationId": "putoutbounddigitalruleset", + "functionName": "putOutboundDigitalruleset", + "signature": "putOutboundDigitalruleset(digitalRuleSetId, body)", + "parameters": [ + { + "name": "digitalRuleSetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DigitalRuleSet", + "required": "true" + } + ], + "return": "DigitalRuleSet" + }, + "PUT /api/v2/outbound/dnclists/{dncListId}": { + "operationId": "putoutbounddnclist", + "functionName": "putOutboundDnclist", + "signature": "putOutboundDnclist(dncListId, body)", + "parameters": [ + { + "name": "dncListId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DncList", + "required": "true" + } + ], + "return": "DncList" + }, + "PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId}": { + "operationId": "putoutboundmessagingcampaign", + "functionName": "putOutboundMessagingcampaign", + "signature": "putOutboundMessagingcampaign(messagingCampaignId, body)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MessagingCampaign", + "required": "true" + } + ], + "return": "MessagingCampaign" + }, + "PUT /api/v2/outbound/rulesets/{ruleSetId}": { + "operationId": "putoutboundruleset", + "functionName": "putOutboundRuleset", + "signature": "putOutboundRuleset(ruleSetId, body)", + "parameters": [ + { + "name": "ruleSetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RuleSet", + "required": "true" + } + ], + "return": "RuleSet" + }, + "PUT /api/v2/outbound/schedules/campaigns/{campaignId}": { + "operationId": "putoutboundschedulescampaign", + "functionName": "putOutboundSchedulesCampaign", + "signature": "putOutboundSchedulesCampaign(campaignId, body)", + "parameters": [ + { + "name": "campaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CampaignSchedule", + "required": "true" + } + ], + "return": "CampaignSchedule" + }, + "PUT /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}": { + "operationId": "putoutboundschedulesemailcampaign", + "functionName": "putOutboundSchedulesEmailcampaign", + "signature": "putOutboundSchedulesEmailcampaign(emailCampaignId, body)", + "parameters": [ + { + "name": "emailCampaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EmailCampaignSchedule", + "required": "true" + } + ], + "return": "EmailCampaignSchedule" + }, + "PUT /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}": { + "operationId": "putoutboundschedulesmessagingcampaign", + "functionName": "putOutboundSchedulesMessagingcampaign", + "signature": "putOutboundSchedulesMessagingcampaign(messagingCampaignId, body)", + "parameters": [ + { + "name": "messagingCampaignId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MessagingCampaignSchedule", + "required": "true" + } + ], + "return": "MessagingCampaignSchedule" + }, + "PUT /api/v2/outbound/schedules/sequences/{sequenceId}": { + "operationId": "putoutboundschedulessequence", + "functionName": "putOutboundSchedulesSequence", + "signature": "putOutboundSchedulesSequence(sequenceId, body)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SequenceSchedule", + "required": "true" + } + ], + "return": "SequenceSchedule" + }, + "PUT /api/v2/outbound/sequences/{sequenceId}": { + "operationId": "putoutboundsequence", + "functionName": "putOutboundSequence", + "signature": "putOutboundSequence(sequenceId, body)", + "parameters": [ + { + "name": "sequenceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CampaignSequence", + "required": "true" + } + ], + "return": "CampaignSequence" + }, + "PUT /api/v2/outbound/wrapupcodemappings": { + "operationId": "putoutboundwrapupcodemappings", + "functionName": "putOutboundWrapupcodemappings", + "signature": "putOutboundWrapupcodemappings(body)", + "parameters": [ + { + "name": "body", + "type": "WrapUpCodeMapping", + "required": "true" + } + ], + "return": "WrapUpCodeMapping" + } + +} \ No newline at end of file diff --git a/build/docs/PresenceAPI.json b/build/docs/PresenceAPI.json new file mode 100644 index 000000000..3ce755686 --- /dev/null +++ b/build/docs/PresenceAPI.json @@ -0,0 +1,335 @@ +{ + "DELETE /api/v2/presence/sources/{sourceId}": { + "operationId": "deletepresencesource", + "functionName": "deletePresenceSource", + "signature": "deletePresenceSource(sourceId)", + "parameters": [ + { + "name": "sourceId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/presencedefinitions/{presenceId}": { + "operationId": "deletepresencedefinition", + "functionName": "deletePresencedefinition", + "signature": "deletePresencedefinition(presenceId)", + "parameters": [ + { + "name": "presenceId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/presence/settings": { + "operationId": "getpresencesettings", + "functionName": "getPresenceSettings", + "signature": "getPresenceSettings()", + + "return": "PresenceSettings" + }, + "GET /api/v2/presence/sources/{sourceId}": { + "operationId": "getpresencesource", + "functionName": "getPresenceSource", + "signature": "getPresenceSource(sourceId)", + "parameters": [ + { + "name": "sourceId", + "type": "String", + "required": "true" + } + ], + "return": "Source" + }, + "GET /api/v2/presence/sources": { + "operationId": "getpresencesources", + "functionName": "getPresenceSources", + "signature": "getPresenceSources(deactivated)", + "parameters": [ + { + "name": "deactivated", + "type": "String", + "required": "false" + } + ], + "return": "SourceEntityListing" + }, + "GET /api/v2/presence/users/{userId}/primarysource": { + "operationId": "getpresenceuserprimarysource", + "functionName": "getPresenceUserPrimarysource", + "signature": "getPresenceUserPrimarysource(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "UserPrimarySource" + }, + "GET /api/v2/presencedefinitions/{presenceId}": { + "operationId": "getpresencedefinition", + "functionName": "getPresencedefinition", + "signature": "getPresencedefinition(presenceId, localeCode)", + "parameters": [ + { + "name": "presenceId", + "type": "String", + "required": "true" + }, + { + "name": "localeCode", + "type": "String", + "required": "false" + } + ], + "return": "OrganizationPresence" + }, + "GET /api/v2/presencedefinitions": { + "operationId": "getpresencedefinitions", + "functionName": "getPresencedefinitions", + "signature": "getPresencedefinitions(pageNumber, pageSize, deleted, localeCode)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "deleted", + "type": "String", + "required": "false" + }, + { + "name": "localeCode", + "type": "String", + "required": "false" + } + ], + "return": "OrganizationPresenceEntityListing" + }, + "GET /api/v2/systempresences": { + "operationId": "getsystempresences", + "functionName": "getSystempresences", + "signature": "getSystempresences()", + + "return": "[SystemPresence]" + }, + "GET /api/v2/users/{userId}/presences/{sourceId}": { + "operationId": "getuserpresence", + "functionName": "getUserPresence", + "signature": "getUserPresence(userId, sourceId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "sourceId", + "type": "String", + "required": "true" + } + ], + "return": "UserPresence" + }, + "GET /api/v2/users/{userId}/presences/purecloud": { + "operationId": "getuserpresencespurecloud", + "functionName": "getUserPresencesPurecloud", + "signature": "getUserPresencesPurecloud(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "UserPresence" + }, + "GET /api/v2/users/presences/{sourceId}/bulk": { + "operationId": "getuserspresencebulk", + "functionName": "getUsersPresenceBulk", + "signature": "getUsersPresenceBulk(sourceId, _id)", + "parameters": [ + { + "name": "sourceId", + "type": "String", + "required": "true" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "[UcUserPresence]" + }, + "GET /api/v2/users/presences/purecloud/bulk": { + "operationId": "getuserspresencespurecloudbulk", + "functionName": "getUsersPresencesPurecloudBulk", + "signature": "getUsersPresencesPurecloudBulk(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "[UcUserPresence]" + }, + "PATCH /api/v2/users/{userId}/presences/{sourceId}": { + "operationId": "patchuserpresence", + "functionName": "patchUserPresence", + "signature": "patchUserPresence(userId, sourceId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "sourceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserPresence", + "required": "true" + } + ], + "return": "UserPresence" + }, + "PATCH /api/v2/users/{userId}/presences/purecloud": { + "operationId": "patchuserpresencespurecloud", + "functionName": "patchUserPresencesPurecloud", + "signature": "patchUserPresencesPurecloud(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserPresence", + "required": "true" + } + ], + "return": "UserPresence" + }, + "POST /api/v2/presence/sources": { + "operationId": "postpresencesources", + "functionName": "postPresenceSources", + "signature": "postPresenceSources(body)", + "parameters": [ + { + "name": "body", + "type": "Source", + "required": "true" + } + ], + "return": "Source" + }, + "POST /api/v2/presencedefinitions": { + "operationId": "postpresencedefinitions", + "functionName": "postPresencedefinitions", + "signature": "postPresencedefinitions(body)", + "parameters": [ + { + "name": "body", + "type": "OrganizationPresence", + "required": "true" + } + ], + "return": "OrganizationPresence" + }, + "PUT /api/v2/presence/settings": { + "operationId": "putpresencesettings", + "functionName": "putPresenceSettings", + "signature": "putPresenceSettings(body)", + "parameters": [ + { + "name": "body", + "type": "PresenceSettings", + "required": "true" + } + ], + "return": "PresenceSettings" + }, + "PUT /api/v2/presence/sources/{sourceId}": { + "operationId": "putpresencesource", + "functionName": "putPresenceSource", + "signature": "putPresenceSource(sourceId, body)", + "parameters": [ + { + "name": "sourceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Source", + "required": "true" + } + ], + "return": "Source" + }, + "PUT /api/v2/presence/users/{userId}/primarysource": { + "operationId": "putpresenceuserprimarysource", + "functionName": "putPresenceUserPrimarysource", + "signature": "putPresenceUserPrimarysource(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserPrimarySource", + "required": "true" + } + ], + "return": "UserPrimarySource" + }, + "PUT /api/v2/presencedefinitions/{presenceId}": { + "operationId": "putpresencedefinition", + "functionName": "putPresencedefinition", + "signature": "putPresencedefinition(presenceId, body)", + "parameters": [ + { + "name": "presenceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OrganizationPresence", + "required": "true" + } + ], + "return": "OrganizationPresence" + }, + "PUT /api/v2/users/presences/bulk": { + "operationId": "putuserspresencesbulk", + "functionName": "putUsersPresencesBulk", + "signature": "putUsersPresencesBulk(body)", + "parameters": [ + { + "name": "body", + "type": "[UserPresence]", + "required": "true" + } + ], + "return": "[UserPresence]" + } + +} \ No newline at end of file diff --git a/build/docs/ProcessAutomationAPI.json b/build/docs/ProcessAutomationAPI.json new file mode 100644 index 000000000..a8a03f55c --- /dev/null +++ b/build/docs/ProcessAutomationAPI.json @@ -0,0 +1,156 @@ +{ + "DELETE /api/v2/processautomation/triggers/{triggerId}": { + "operationId": "deleteprocessautomationtrigger", + "functionName": "deleteProcessautomationTrigger", + "signature": "deleteProcessautomationTrigger(triggerId)", + "parameters": [ + { + "name": "triggerId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/processautomation/triggers/{triggerId}": { + "operationId": "getprocessautomationtrigger", + "functionName": "getProcessautomationTrigger", + "signature": "getProcessautomationTrigger(triggerId)", + "parameters": [ + { + "name": "triggerId", + "type": "String", + "required": "true" + } + ], + "return": "Trigger" + }, + "GET /api/v2/processautomation/triggers": { + "operationId": "getprocessautomationtriggers", + "functionName": "getProcessautomationTriggers", + "signature": "getProcessautomationTriggers(before, after, pageSize, topicName, enabled, hasDelayBy)", + "parameters": [ + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "topicName", + "type": "String", + "required": "false" + }, + { + "name": "enabled", + "type": "Bool", + "required": "false" + }, + { + "name": "hasDelayBy", + "type": "Bool", + "required": "false" + } + ], + "return": "TriggerEntityListing" + }, + "GET /api/v2/processautomation/triggers/topics": { + "operationId": "getprocessautomationtriggerstopics", + "functionName": "getProcessautomationTriggersTopics", + "signature": "getProcessautomationTriggersTopics(before, after, pageSize)", + "parameters": [ + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + } + ], + "return": "TopicCursorEntityListing" + }, + "POST /api/v2/processautomation/triggers/{triggerId}/test": { + "operationId": "postprocessautomationtriggertest", + "functionName": "postProcessautomationTriggerTest", + "signature": "postProcessautomationTriggerTest(triggerId, body)", + "parameters": [ + { + "name": "triggerId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "String", + "required": "false" + } + ], + "return": "TestModeResults" + }, + "POST /api/v2/processautomation/triggers": { + "operationId": "postprocessautomationtriggers", + "functionName": "postProcessautomationTriggers", + "signature": "postProcessautomationTriggers(body)", + "parameters": [ + { + "name": "body", + "type": "CreateTriggerRequest", + "required": "true" + } + ], + "return": "Trigger" + }, + "POST /api/v2/processautomation/triggers/topics/{topicName}/test": { + "operationId": "postprocessautomationtriggerstopictest", + "functionName": "postProcessautomationTriggersTopicTest", + "signature": "postProcessautomationTriggersTopicTest(topicName, body)", + "parameters": [ + { + "name": "topicName", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "String", + "required": "false" + } + ], + "return": "TestModeEventResults" + }, + "PUT /api/v2/processautomation/triggers/{triggerId}": { + "operationId": "putprocessautomationtrigger", + "functionName": "putProcessautomationTrigger", + "signature": "putProcessautomationTrigger(triggerId, body)", + "parameters": [ + { + "name": "triggerId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateTriggerRequest", + "required": "true" + } + ], + "return": "Trigger" + } + +} \ No newline at end of file diff --git a/build/docs/QualityAPI.json b/build/docs/QualityAPI.json new file mode 100644 index 000000000..89638b670 --- /dev/null +++ b/build/docs/QualityAPI.json @@ -0,0 +1,1265 @@ +{ + "DELETE /api/v2/quality/calibrations/{calibrationId}": { + "operationId": "deletequalitycalibration", + "functionName": "deleteQualityCalibration", + "signature": "deleteQualityCalibration(calibrationId, calibratorId)", + "parameters": [ + { + "name": "calibrationId", + "type": "String", + "required": "true" + }, + { + "name": "calibratorId", + "type": "String", + "required": "true" + } + ], + "return": "Calibration" + }, + "DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}": { + "operationId": "deletequalityconversationevaluation", + "functionName": "deleteQualityConversationEvaluation", + "signature": "deleteQualityConversationEvaluation(conversationId, evaluationId, expand)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "evaluationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationResponse" + }, + "DELETE /api/v2/quality/forms/{formId}": { + "operationId": "deletequalityform", + "functionName": "deleteQualityForm", + "signature": "deleteQualityForm(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/quality/forms/evaluations/{formId}": { + "operationId": "deletequalityformsevaluation", + "functionName": "deleteQualityFormsEvaluation", + "signature": "deleteQualityFormsEvaluation(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/quality/forms/surveys/{formId}": { + "operationId": "deletequalityformssurvey", + "functionName": "deleteQualityFormsSurvey", + "signature": "deleteQualityFormsSurvey(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/quality/agents/activity": { + "operationId": "getqualityagentsactivity", + "functionName": "getQualityAgentsActivity", + "signature": "getQualityAgentsActivity(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, startTime, endTime, agentUserId, evaluatorUserId, name, group, formContextId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "startTime", + "type": "Date", + "required": "false" + }, + { + "name": "endTime", + "type": "Date", + "required": "false" + }, + { + "name": "agentUserId", + "type": "[String]", + "required": "false" + }, + { + "name": "evaluatorUserId", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "group", + "type": "String", + "required": "false" + }, + { + "name": "formContextId", + "type": "String", + "required": "false" + } + ], + "return": "AgentActivityEntityListing" + }, + "GET /api/v2/quality/calibrations/{calibrationId}": { + "operationId": "getqualitycalibration", + "functionName": "getQualityCalibration", + "signature": "getQualityCalibration(calibrationId, calibratorId, conversationId)", + "parameters": [ + { + "name": "calibrationId", + "type": "String", + "required": "true" + }, + { + "name": "calibratorId", + "type": "String", + "required": "false" + }, + { + "name": "conversationId", + "type": "String", + "required": "false" + } + ], + "return": "Calibration" + }, + "GET /api/v2/quality/calibrations": { + "operationId": "getqualitycalibrations", + "functionName": "getQualityCalibrations", + "signature": "getQualityCalibrations(calibratorId, pageSize, pageNumber, sortBy, expand, nextPage, previousPage, conversationId, startTime, endTime)", + "parameters": [ + { + "name": "calibratorId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "conversationId", + "type": "String", + "required": "false" + }, + { + "name": "startTime", + "type": "Date", + "required": "false" + }, + { + "name": "endTime", + "type": "Date", + "required": "false" + } + ], + "return": "CalibrationEntityListing" + }, + "GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}": { + "operationId": "getqualityconversationevaluation", + "functionName": "getQualityConversationEvaluation", + "signature": "getQualityConversationEvaluation(conversationId, evaluationId, expand)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "evaluationId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationResponse" + }, + "GET /api/v2/quality/conversations/{conversationId}/surveys": { + "operationId": "getqualityconversationsurveys", + "functionName": "getQualityConversationSurveys", + "signature": "getQualityConversationSurveys(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "[Survey]" + }, + "GET /api/v2/quality/conversations/audits/query/{transactionId}": { + "operationId": "getqualityconversationsauditsquerytransactionid", + "functionName": "getQualityConversationsAuditsQueryTransactionId", + "signature": "getQualityConversationsAuditsQueryTransactionId(transactionId)", + "parameters": [ + { + "name": "transactionId", + "type": "String", + "required": "true" + } + ], + "return": "QualityAuditQueryExecutionStatusResponse" + }, + "GET /api/v2/quality/conversations/audits/query/{transactionId}/results": { + "operationId": "getqualityconversationsauditsquerytransactionidresults", + "functionName": "getQualityConversationsAuditsQueryTransactionIdResults", + "signature": "getQualityConversationsAuditsQueryTransactionIdResults(transactionId, cursor, pageSize, expand)", + "parameters": [ + { + "name": "transactionId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "QualityAuditQueryExecutionResultsResponse" + }, + "GET /api/v2/quality/evaluations/query": { + "operationId": "getqualityevaluationsquery", + "functionName": "getQualityEvaluationsQuery", + "signature": "getQualityEvaluationsQuery(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, conversationId, agentUserId, evaluatorUserId, assigneeUserId, queueId, startTime, endTime, formContextId, evaluationState, isReleased, agentHasRead, expandAnswerTotalScores, maximum, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "conversationId", + "type": "String", + "required": "false" + }, + { + "name": "agentUserId", + "type": "String", + "required": "false" + }, + { + "name": "evaluatorUserId", + "type": "String", + "required": "false" + }, + { + "name": "assigneeUserId", + "type": "String", + "required": "false" + }, + { + "name": "queueId", + "type": "String", + "required": "false" + }, + { + "name": "startTime", + "type": "String", + "required": "false" + }, + { + "name": "endTime", + "type": "String", + "required": "false" + }, + { + "name": "formContextId", + "type": "String", + "required": "false" + }, + { + "name": "evaluationState", + "type": "[String]", + "required": "false" + }, + { + "name": "isReleased", + "type": "Bool", + "required": "false" + }, + { + "name": "agentHasRead", + "type": "Bool", + "required": "false" + }, + { + "name": "expandAnswerTotalScores", + "type": "Bool", + "required": "false" + }, + { + "name": "maximum", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationEntityListing" + }, + "GET /api/v2/quality/evaluators/activity": { + "operationId": "getqualityevaluatorsactivity", + "functionName": "getQualityEvaluatorsActivity", + "signature": "getQualityEvaluatorsActivity(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, startTime, endTime, name, permission, group)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "startTime", + "type": "Date", + "required": "false" + }, + { + "name": "endTime", + "type": "Date", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "permission", + "type": "[String]", + "required": "false" + }, + { + "name": "group", + "type": "String", + "required": "false" + } + ], + "return": "EvaluatorActivityEntityListing" + }, + "GET /api/v2/quality/forms/{formId}": { + "operationId": "getqualityform", + "functionName": "getQualityForm", + "signature": "getQualityForm(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "GET /api/v2/quality/forms/{formId}/versions": { + "operationId": "getqualityformversions", + "functionName": "getQualityFormVersions", + "signature": "getQualityFormVersions(formId, pageSize, pageNumber)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/forms": { + "operationId": "getqualityforms", + "functionName": "getQualityForms", + "signature": "getQualityForms(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/forms/evaluations/{formId}": { + "operationId": "getqualityformsevaluation", + "functionName": "getQualityFormsEvaluation", + "signature": "getQualityFormsEvaluation(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "GET /api/v2/quality/forms/evaluations/{formId}/versions": { + "operationId": "getqualityformsevaluationversions", + "functionName": "getQualityFormsEvaluationVersions", + "signature": "getQualityFormsEvaluationVersions(formId, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/forms/evaluations": { + "operationId": "getqualityformsevaluations", + "functionName": "getQualityFormsEvaluations", + "signature": "getQualityFormsEvaluations(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/forms/evaluations/bulk/contexts": { + "operationId": "getqualityformsevaluationsbulkcontexts", + "functionName": "getQualityFormsEvaluationsBulkContexts", + "signature": "getQualityFormsEvaluationsBulkContexts(contextId)", + "parameters": [ + { + "name": "contextId", + "type": "[String]", + "required": "true" + } + ], + "return": "[EvaluationForm]" + }, + "GET /api/v2/quality/forms/surveys/{formId}": { + "operationId": "getqualityformssurvey", + "functionName": "getQualityFormsSurvey", + "signature": "getQualityFormsSurvey(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "GET /api/v2/quality/forms/surveys/{formId}/versions": { + "operationId": "getqualityformssurveyversions", + "functionName": "getQualityFormsSurveyVersions", + "signature": "getQualityFormsSurveyVersions(formId, pageSize, pageNumber)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "SurveyFormEntityListing" + }, + "GET /api/v2/quality/forms/surveys": { + "operationId": "getqualityformssurveys", + "functionName": "getQualityFormsSurveys", + "signature": "getQualityFormsSurveys(pageSize, pageNumber, sortBy, nextPage, previousPage, expand, name, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "SurveyFormEntityListing" + }, + "GET /api/v2/quality/forms/surveys/bulk": { + "operationId": "getqualityformssurveysbulk", + "functionName": "getQualityFormsSurveysBulk", + "signature": "getQualityFormsSurveysBulk(_id)", + "parameters": [ + { + "name": "_id", + "type": "[String]", + "required": "true" + } + ], + "return": "SurveyFormEntityListing" + }, + "GET /api/v2/quality/forms/surveys/bulk/contexts": { + "operationId": "getqualityformssurveysbulkcontexts", + "functionName": "getQualityFormsSurveysBulkContexts", + "signature": "getQualityFormsSurveysBulkContexts(contextId, published)", + "parameters": [ + { + "name": "contextId", + "type": "[String]", + "required": "true" + }, + { + "name": "published", + "type": "Bool", + "required": "false" + } + ], + "return": "[SurveyForm]" + }, + "GET /api/v2/quality/publishedforms/{formId}": { + "operationId": "getqualitypublishedform", + "functionName": "getQualityPublishedform", + "signature": "getQualityPublishedform(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "GET /api/v2/quality/publishedforms": { + "operationId": "getqualitypublishedforms", + "functionName": "getQualityPublishedforms", + "signature": "getQualityPublishedforms(pageSize, pageNumber, name, onlyLatestPerContext)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "onlyLatestPerContext", + "type": "Bool", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/publishedforms/evaluations/{formId}": { + "operationId": "getqualitypublishedformsevaluation", + "functionName": "getQualityPublishedformsEvaluation", + "signature": "getQualityPublishedformsEvaluation(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "GET /api/v2/quality/publishedforms/evaluations": { + "operationId": "getqualitypublishedformsevaluations", + "functionName": "getQualityPublishedformsEvaluations", + "signature": "getQualityPublishedformsEvaluations(pageSize, pageNumber, name, onlyLatestPerContext)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "onlyLatestPerContext", + "type": "Bool", + "required": "false" + } + ], + "return": "EvaluationFormEntityListing" + }, + "GET /api/v2/quality/publishedforms/surveys/{formId}": { + "operationId": "getqualitypublishedformssurvey", + "functionName": "getQualityPublishedformsSurvey", + "signature": "getQualityPublishedformsSurvey(formId)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "GET /api/v2/quality/publishedforms/surveys": { + "operationId": "getqualitypublishedformssurveys", + "functionName": "getQualityPublishedformsSurveys", + "signature": "getQualityPublishedformsSurveys(pageSize, pageNumber, name, onlyLatestEnabledPerContext)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "onlyLatestEnabledPerContext", + "type": "Bool", + "required": "false" + } + ], + "return": "SurveyFormEntityListing" + }, + "GET /api/v2/quality/surveys/{surveyId}": { + "operationId": "getqualitysurvey", + "functionName": "getQualitySurvey", + "signature": "getQualitySurvey(surveyId)", + "parameters": [ + { + "name": "surveyId", + "type": "String", + "required": "true" + } + ], + "return": "Survey" + }, + "GET /api/v2/quality/surveys/scorable": { + "operationId": "getqualitysurveysscorable", + "functionName": "getQualitySurveysScorable", + "signature": "getQualitySurveysScorable(customerSurveyUrl)", + "parameters": [ + { + "name": "customerSurveyUrl", + "type": "String", + "required": "true" + } + ], + "return": "ScorableSurvey" + }, + "PATCH /api/v2/quality/forms/surveys/{formId}": { + "operationId": "patchqualityformssurvey", + "functionName": "patchQualityFormsSurvey", + "signature": "patchQualityFormsSurvey(formId, body)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SurveyForm", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "POST /api/v2/analytics/evaluations/aggregates/query": { + "operationId": "postanalyticsevaluationsaggregatesquery", + "functionName": "postAnalyticsEvaluationsAggregatesQuery", + "signature": "postAnalyticsEvaluationsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationAggregationQuery", + "required": "true" + } + ], + "return": "EvaluationAggregateQueryResponse" + }, + "POST /api/v2/analytics/surveys/aggregates/query": { + "operationId": "postanalyticssurveysaggregatesquery", + "functionName": "postAnalyticsSurveysAggregatesQuery", + "signature": "postAnalyticsSurveysAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "SurveyAggregationQuery", + "required": "true" + } + ], + "return": "SurveyAggregateQueryResponse" + }, + "POST /api/v2/quality/calibrations": { + "operationId": "postqualitycalibrations", + "functionName": "postQualityCalibrations", + "signature": "postQualityCalibrations(body, expand)", + "parameters": [ + { + "name": "body", + "type": "CalibrationCreate", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "Calibration" + }, + "POST /api/v2/quality/conversations/{conversationId}/evaluations": { + "operationId": "postqualityconversationevaluations", + "functionName": "postQualityConversationEvaluations", + "signature": "postQualityConversationEvaluations(conversationId, body, expand)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Evaluation", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "Evaluation" + }, + "POST /api/v2/quality/conversations/audits/query": { + "operationId": "postqualityconversationsauditsquery", + "functionName": "postQualityConversationsAuditsQuery", + "signature": "postQualityConversationsAuditsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "QMAuditQueryRequest", + "required": "true" + } + ], + "return": "QualityAuditQueryExecutionStatusResponse" + }, + "POST /api/v2/quality/evaluations/aggregates/query/me": { + "operationId": "postqualityevaluationsaggregatesqueryme", + "functionName": "postQualityEvaluationsAggregatesQueryMe", + "signature": "postQualityEvaluationsAggregatesQueryMe(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationAggregationQueryMe", + "required": "true" + } + ], + "return": "EvaluationAggregateQueryResponse" + }, + "POST /api/v2/quality/evaluations/scoring": { + "operationId": "postqualityevaluationsscoring", + "functionName": "postQualityEvaluationsScoring", + "signature": "postQualityEvaluationsScoring(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationFormAndScoringSet", + "required": "true" + } + ], + "return": "EvaluationScoringSet" + }, + "POST /api/v2/quality/forms": { + "operationId": "postqualityforms", + "functionName": "postQualityForms", + "signature": "postQualityForms(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "POST /api/v2/quality/forms/evaluations": { + "operationId": "postqualityformsevaluations", + "functionName": "postQualityFormsEvaluations", + "signature": "postQualityFormsEvaluations(body)", + "parameters": [ + { + "name": "body", + "type": "EvaluationForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "POST /api/v2/quality/forms/surveys": { + "operationId": "postqualityformssurveys", + "functionName": "postQualityFormsSurveys", + "signature": "postQualityFormsSurveys(body)", + "parameters": [ + { + "name": "body", + "type": "SurveyForm", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "POST /api/v2/quality/publishedforms": { + "operationId": "postqualitypublishedforms", + "functionName": "postQualityPublishedforms", + "signature": "postQualityPublishedforms(body)", + "parameters": [ + { + "name": "body", + "type": "PublishForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "POST /api/v2/quality/publishedforms/evaluations": { + "operationId": "postqualitypublishedformsevaluations", + "functionName": "postQualityPublishedformsEvaluations", + "signature": "postQualityPublishedformsEvaluations(body)", + "parameters": [ + { + "name": "body", + "type": "PublishForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "POST /api/v2/quality/publishedforms/surveys": { + "operationId": "postqualitypublishedformssurveys", + "functionName": "postQualityPublishedformsSurveys", + "signature": "postQualityPublishedformsSurveys(body)", + "parameters": [ + { + "name": "body", + "type": "PublishForm", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "POST /api/v2/quality/surveys/scoring": { + "operationId": "postqualitysurveysscoring", + "functionName": "postQualitySurveysScoring", + "signature": "postQualitySurveysScoring(body)", + "parameters": [ + { + "name": "body", + "type": "SurveyFormAndScoringSet", + "required": "true" + } + ], + "return": "SurveyScoringSet" + }, + "PUT /api/v2/quality/calibrations/{calibrationId}": { + "operationId": "putqualitycalibration", + "functionName": "putQualityCalibration", + "signature": "putQualityCalibration(calibrationId, body)", + "parameters": [ + { + "name": "calibrationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Calibration", + "required": "true" + } + ], + "return": "Calibration" + }, + "PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}": { + "operationId": "putqualityconversationevaluation", + "functionName": "putQualityConversationEvaluation", + "signature": "putQualityConversationEvaluation(conversationId, evaluationId, body, expand)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "evaluationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Evaluation", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "EvaluationResponse" + }, + "PUT /api/v2/quality/forms/{formId}": { + "operationId": "putqualityform", + "functionName": "putQualityForm", + "signature": "putQualityForm(formId, body)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EvaluationForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "PUT /api/v2/quality/forms/evaluations/{formId}": { + "operationId": "putqualityformsevaluation", + "functionName": "putQualityFormsEvaluation", + "signature": "putQualityFormsEvaluation(formId, body)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EvaluationForm", + "required": "true" + } + ], + "return": "EvaluationForm" + }, + "PUT /api/v2/quality/forms/surveys/{formId}": { + "operationId": "putqualityformssurvey", + "functionName": "putQualityFormsSurvey", + "signature": "putQualityFormsSurvey(formId, body)", + "parameters": [ + { + "name": "formId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SurveyForm", + "required": "true" + } + ], + "return": "SurveyForm" + }, + "PUT /api/v2/quality/surveys/scorable": { + "operationId": "putqualitysurveysscorable", + "functionName": "putQualitySurveysScorable", + "signature": "putQualitySurveysScorable(customerSurveyUrl, body)", + "parameters": [ + { + "name": "customerSurveyUrl", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScorableSurvey", + "required": "true" + } + ], + "return": "ScorableSurvey" + } + +} \ No newline at end of file diff --git a/build/docs/RecordingAPI.json b/build/docs/RecordingAPI.json new file mode 100644 index 000000000..7d69e62c2 --- /dev/null +++ b/build/docs/RecordingAPI.json @@ -0,0 +1,1154 @@ +{ + "DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}": { + "operationId": "deleteconversationrecordingannotation", + "functionName": "deleteConversationRecordingAnnotation", + "signature": "deleteConversationRecordingAnnotation(conversationId, recordingId, annotationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/orphanrecordings/{orphanId}": { + "operationId": "deleteorphanrecording", + "functionName": "deleteOrphanrecording", + "signature": "deleteOrphanrecording(orphanId)", + "parameters": [ + { + "name": "orphanId", + "type": "String", + "required": "true" + } + ], + "return": "OrphanRecording" + }, + "DELETE /api/v2/recording/crossplatform/mediaretentionpolicies": { + "operationId": "deleterecordingcrossplatformmediaretentionpolicies", + "functionName": "deleteRecordingCrossplatformMediaretentionpolicies", + "signature": "deleteRecordingCrossplatformMediaretentionpolicies(ids)", + "parameters": [ + { + "name": "ids", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}": { + "operationId": "deleterecordingcrossplatformmediaretentionpolicy", + "functionName": "deleteRecordingCrossplatformMediaretentionpolicy", + "signature": "deleteRecordingCrossplatformMediaretentionpolicy(policyId)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/recording/jobs/{jobId}": { + "operationId": "deleterecordingjob", + "functionName": "deleteRecordingJob", + "signature": "deleteRecordingJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/recording/mediaretentionpolicies": { + "operationId": "deleterecordingmediaretentionpolicies", + "functionName": "deleteRecordingMediaretentionpolicies", + "signature": "deleteRecordingMediaretentionpolicies(ids)", + "parameters": [ + { + "name": "ids", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/recording/mediaretentionpolicies/{policyId}": { + "operationId": "deleterecordingmediaretentionpolicy", + "functionName": "deleteRecordingMediaretentionpolicy", + "signature": "deleteRecordingMediaretentionpolicy(policyId)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/conversations/{conversationId}/recordings/{recordingId}": { + "operationId": "getconversationrecording", + "functionName": "getConversationRecording", + "signature": "getConversationRecording(conversationId, recordingId, formatId, emailFormatId, chatFormatId, messageFormatId, download, fileName, locale, mediaFormats)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + }, + { + "name": "emailFormatId", + "type": "String", + "required": "false" + }, + { + "name": "chatFormatId", + "type": "String", + "required": "false" + }, + { + "name": "messageFormatId", + "type": "String", + "required": "false" + }, + { + "name": "download", + "type": "Bool", + "required": "false" + }, + { + "name": "fileName", + "type": "String", + "required": "false" + }, + { + "name": "locale", + "type": "String", + "required": "false" + }, + { + "name": "mediaFormats", + "type": "[String]", + "required": "false" + } + ], + "return": "Recording" + }, + "GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}": { + "operationId": "getconversationrecordingannotation", + "functionName": "getConversationRecordingAnnotation", + "signature": "getConversationRecordingAnnotation(conversationId, recordingId, annotationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + } + ], + "return": "Annotation" + }, + "GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations": { + "operationId": "getconversationrecordingannotations", + "functionName": "getConversationRecordingAnnotations", + "signature": "getConversationRecordingAnnotations(conversationId, recordingId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + } + ], + "return": "[Annotation]" + }, + "GET /api/v2/conversations/{conversationId}/recordingmetadata": { + "operationId": "getconversationrecordingmetadata", + "functionName": "getConversationRecordingmetadata", + "signature": "getConversationRecordingmetadata(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "[RecordingMetadata]" + }, + "GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}": { + "operationId": "getconversationrecordingmetadatarecordingid", + "functionName": "getConversationRecordingmetadataRecordingId", + "signature": "getConversationRecordingmetadataRecordingId(conversationId, recordingId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + } + ], + "return": "RecordingMetadata" + }, + "GET /api/v2/conversations/{conversationId}/recordings": { + "operationId": "getconversationrecordings", + "functionName": "getConversationRecordings", + "signature": "getConversationRecordings(conversationId, maxWaitMs, formatId, mediaFormats)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "maxWaitMs", + "type": "Int", + "required": "false" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + }, + { + "name": "mediaFormats", + "type": "[String]", + "required": "false" + } + ], + "return": "[Recording]" + }, + "GET /api/v2/orphanrecordings/{orphanId}": { + "operationId": "getorphanrecording", + "functionName": "getOrphanrecording", + "signature": "getOrphanrecording(orphanId)", + "parameters": [ + { + "name": "orphanId", + "type": "String", + "required": "true" + } + ], + "return": "OrphanRecording" + }, + "GET /api/v2/orphanrecordings/{orphanId}/media": { + "operationId": "getorphanrecordingmedia", + "functionName": "getOrphanrecordingMedia", + "signature": "getOrphanrecordingMedia(orphanId, formatId, emailFormatId, chatFormatId, messageFormatId, download, fileName, locale, mediaFormats)", + "parameters": [ + { + "name": "orphanId", + "type": "String", + "required": "true" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + }, + { + "name": "emailFormatId", + "type": "String", + "required": "false" + }, + { + "name": "chatFormatId", + "type": "String", + "required": "false" + }, + { + "name": "messageFormatId", + "type": "String", + "required": "false" + }, + { + "name": "download", + "type": "Bool", + "required": "false" + }, + { + "name": "fileName", + "type": "String", + "required": "false" + }, + { + "name": "locale", + "type": "String", + "required": "false" + }, + { + "name": "mediaFormats", + "type": "[String]", + "required": "false" + } + ], + "return": "Recording" + }, + "GET /api/v2/orphanrecordings": { + "operationId": "getorphanrecordings", + "functionName": "getOrphanrecordings", + "signature": "getOrphanrecordings(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, hasConversation, media)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "hasConversation", + "type": "Bool", + "required": "false" + }, + { + "name": "media", + "type": "String", + "required": "false" + } + ], + "return": "OrphanRecordingListing" + }, + "GET /api/v2/recording/batchrequests/{jobId}": { + "operationId": "getrecordingbatchrequest", + "functionName": "getRecordingBatchrequest", + "signature": "getRecordingBatchrequest(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "BatchDownloadJobStatusResult" + }, + "GET /api/v2/recording/crossplatform/mediaretentionpolicies": { + "operationId": "getrecordingcrossplatformmediaretentionpolicies", + "functionName": "getRecordingCrossplatformMediaretentionpolicies", + "signature": "getRecordingCrossplatformMediaretentionpolicies(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, enabled, summary, hasErrors, deleteDaysThreshold)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "enabled", + "type": "Bool", + "required": "false" + }, + { + "name": "summary", + "type": "Bool", + "required": "false" + }, + { + "name": "hasErrors", + "type": "Bool", + "required": "false" + }, + { + "name": "deleteDaysThreshold", + "type": "Int", + "required": "false" + } + ], + "return": "PolicyEntityListing" + }, + "GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}": { + "operationId": "getrecordingcrossplatformmediaretentionpolicy", + "functionName": "getRecordingCrossplatformMediaretentionpolicy", + "signature": "getRecordingCrossplatformMediaretentionpolicy(policyId)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + } + ], + "return": "CrossPlatformPolicy" + }, + "GET /api/v2/recording/jobs/{jobId}": { + "operationId": "getrecordingjob", + "functionName": "getRecordingJob", + "signature": "getRecordingJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "RecordingJob" + }, + "GET /api/v2/recording/jobs/{jobId}/failedrecordings": { + "operationId": "getrecordingjobfailedrecordings", + "functionName": "getRecordingJobFailedrecordings", + "signature": "getRecordingJobFailedrecordings(jobId, pageSize, pageNumber, includeTotal, cursor)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "includeTotal", + "type": "Bool", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "FailedRecordingEntityListing" + }, + "GET /api/v2/recording/jobs": { + "operationId": "getrecordingjobs", + "functionName": "getRecordingJobs", + "signature": "getRecordingJobs(pageSize, pageNumber, sortBy, state, showOnlyMyJobs, jobType, includeTotal, cursor)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + }, + { + "name": "showOnlyMyJobs", + "type": "Bool", + "required": "false" + }, + { + "name": "jobType", + "type": "String", + "required": "false" + }, + { + "name": "includeTotal", + "type": "Bool", + "required": "false" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "RecordingJobEntityListing" + }, + "GET /api/v2/recording/keyconfigurations/{keyConfigurationId}": { + "operationId": "getrecordingkeyconfiguration", + "functionName": "getRecordingKeyconfiguration", + "signature": "getRecordingKeyconfiguration(keyConfigurationId)", + "parameters": [ + { + "name": "keyConfigurationId", + "type": "String", + "required": "true" + } + ], + "return": "RecordingEncryptionConfiguration" + }, + "GET /api/v2/recording/keyconfigurations": { + "operationId": "getrecordingkeyconfigurations", + "functionName": "getRecordingKeyconfigurations", + "signature": "getRecordingKeyconfigurations()", + + "return": "RecordingEncryptionConfigurationListing" + }, + "GET /api/v2/recording/mediaretentionpolicies": { + "operationId": "getrecordingmediaretentionpolicies", + "functionName": "getRecordingMediaretentionpolicies", + "signature": "getRecordingMediaretentionpolicies(pageSize, pageNumber, sortBy, expand, nextPage, previousPage, name, enabled, summary, hasErrors, deleteDaysThreshold)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "previousPage", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "enabled", + "type": "Bool", + "required": "false" + }, + { + "name": "summary", + "type": "Bool", + "required": "false" + }, + { + "name": "hasErrors", + "type": "Bool", + "required": "false" + }, + { + "name": "deleteDaysThreshold", + "type": "Int", + "required": "false" + } + ], + "return": "PolicyEntityListing" + }, + "GET /api/v2/recording/mediaretentionpolicies/{policyId}": { + "operationId": "getrecordingmediaretentionpolicy", + "functionName": "getRecordingMediaretentionpolicy", + "signature": "getRecordingMediaretentionpolicy(policyId)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + } + ], + "return": "Policy" + }, + "GET /api/v2/recording/recordingkeys": { + "operationId": "getrecordingrecordingkeys", + "functionName": "getRecordingRecordingkeys", + "signature": "getRecordingRecordingkeys(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "EncryptionKeyEntityListing" + }, + "GET /api/v2/recording/recordingkeys/rotationschedule": { + "operationId": "getrecordingrecordingkeysrotationschedule", + "functionName": "getRecordingRecordingkeysRotationschedule", + "signature": "getRecordingRecordingkeysRotationschedule()", + + "return": "KeyRotationSchedule" + }, + "GET /api/v2/recording/settings": { + "operationId": "getrecordingsettings", + "functionName": "getRecordingSettings", + "signature": "getRecordingSettings(createDefault)", + "parameters": [ + { + "name": "createDefault", + "type": "Bool", + "required": "false" + } + ], + "return": "RecordingSettings" + }, + "GET /api/v2/recording/uploads/reports/{reportId}": { + "operationId": "getrecordinguploadsreport", + "functionName": "getRecordingUploadsReport", + "signature": "getRecordingUploadsReport(reportId)", + "parameters": [ + { + "name": "reportId", + "type": "String", + "required": "true" + } + ], + "return": "RecordingUploadReport" + }, + "GET /api/v2/recordings/retention/query": { + "operationId": "getrecordingsretentionquery", + "functionName": "getRecordingsRetentionQuery", + "signature": "getRecordingsRetentionQuery(retentionThresholdDays, cursor, pageSize)", + "parameters": [ + { + "name": "retentionThresholdDays", + "type": "Int", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "RecordingRetentionCursorEntityListing" + }, + "GET /api/v2/recordings/screensessions": { + "operationId": "getrecordingsscreensessions", + "functionName": "getRecordingsScreensessions", + "signature": "getRecordingsScreensessions(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "ScreenRecordingSessionListing" + }, + "PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}": { + "operationId": "patchrecordingcrossplatformmediaretentionpolicy", + "functionName": "patchRecordingCrossplatformMediaretentionpolicy", + "signature": "patchRecordingCrossplatformMediaretentionpolicy(policyId, body)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CrossPlatformPolicyUpdate", + "required": "true" + } + ], + "return": "CrossPlatformPolicy" + }, + "PATCH /api/v2/recording/mediaretentionpolicies/{policyId}": { + "operationId": "patchrecordingmediaretentionpolicy", + "functionName": "patchRecordingMediaretentionpolicy", + "signature": "patchRecordingMediaretentionpolicy(policyId, body)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PolicyUpdate", + "required": "true" + } + ], + "return": "Policy" + }, + "PATCH /api/v2/recordings/screensessions/{recordingSessionId}": { + "operationId": "patchrecordingsscreensession", + "functionName": "patchRecordingsScreensession", + "signature": "patchRecordingsScreensession(recordingSessionId, body)", + "parameters": [ + { + "name": "recordingSessionId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScreenRecordingSessionRequest", + "required": "false" + } + ] + }, + "POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations": { + "operationId": "postconversationrecordingannotations", + "functionName": "postConversationRecordingAnnotations", + "signature": "postConversationRecordingAnnotations(conversationId, recordingId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Annotation", + "required": "true" + } + ], + "return": "Annotation" + }, + "POST /api/v2/recording/batchrequests": { + "operationId": "postrecordingbatchrequests", + "functionName": "postRecordingBatchrequests", + "signature": "postRecordingBatchrequests(body)", + "parameters": [ + { + "name": "body", + "type": "BatchDownloadJobSubmission", + "required": "true" + } + ], + "return": "BatchDownloadJobSubmissionResult" + }, + "POST /api/v2/recording/crossplatform/mediaretentionpolicies": { + "operationId": "postrecordingcrossplatformmediaretentionpolicies", + "functionName": "postRecordingCrossplatformMediaretentionpolicies", + "signature": "postRecordingCrossplatformMediaretentionpolicies(body)", + "parameters": [ + { + "name": "body", + "type": "CrossPlatformPolicyCreate", + "required": "true" + } + ], + "return": "CrossPlatformPolicy" + }, + "POST /api/v2/recording/jobs": { + "operationId": "postrecordingjobs", + "functionName": "postRecordingJobs", + "signature": "postRecordingJobs(body)", + "parameters": [ + { + "name": "body", + "type": "RecordingJobsQuery", + "required": "true" + } + ], + "return": "RecordingJob" + }, + "POST /api/v2/recording/keyconfigurations": { + "operationId": "postrecordingkeyconfigurations", + "functionName": "postRecordingKeyconfigurations", + "signature": "postRecordingKeyconfigurations(body)", + "parameters": [ + { + "name": "body", + "type": "RecordingEncryptionConfiguration", + "required": "true" + } + ], + "return": "RecordingEncryptionConfiguration" + }, + "POST /api/v2/recording/keyconfigurations/validate": { + "operationId": "postrecordingkeyconfigurationsvalidate", + "functionName": "postRecordingKeyconfigurationsValidate", + "signature": "postRecordingKeyconfigurationsValidate(body)", + "parameters": [ + { + "name": "body", + "type": "RecordingEncryptionConfiguration", + "required": "true" + } + ], + "return": "RecordingEncryptionConfiguration" + }, + "POST /api/v2/recording/localkeys": { + "operationId": "postrecordinglocalkeys", + "functionName": "postRecordingLocalkeys", + "signature": "postRecordingLocalkeys(body)", + "parameters": [ + { + "name": "body", + "type": "LocalEncryptionKeyRequest", + "required": "true" + } + ], + "return": "EncryptionKey" + }, + "POST /api/v2/recording/mediaretentionpolicies": { + "operationId": "postrecordingmediaretentionpolicies", + "functionName": "postRecordingMediaretentionpolicies", + "signature": "postRecordingMediaretentionpolicies(body)", + "parameters": [ + { + "name": "body", + "type": "PolicyCreate", + "required": "true" + } + ], + "return": "Policy" + }, + "POST /api/v2/recording/recordingkeys": { + "operationId": "postrecordingrecordingkeys", + "functionName": "postRecordingRecordingkeys", + "signature": "postRecordingRecordingkeys()", + + "return": "EncryptionKey" + }, + "POST /api/v2/recording/uploads/reports": { + "operationId": "postrecordinguploadsreports", + "functionName": "postRecordingUploadsReports", + "signature": "postRecordingUploadsReports(body)", + "parameters": [ + { + "name": "body", + "type": "RecordingUploadReportRequest", + "required": "true" + } + ], + "return": "RecordingUploadReport" + }, + "POST /api/v2/recordings/deletionprotection": { + "operationId": "postrecordingsdeletionprotection", + "functionName": "postRecordingsDeletionprotection", + "signature": "postRecordingsDeletionprotection(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationDeletionProtectionQuery", + "required": "true" + } + ], + "return": "[AddressableEntityRef]" + }, + "POST /api/v2/recordings/screensessions/acknowledge": { + "operationId": "postrecordingsscreensessionsacknowledge", + "functionName": "postRecordingsScreensessionsAcknowledge", + "signature": "postRecordingsScreensessionsAcknowledge(body)", + "parameters": [ + { + "name": "body", + "type": "AcknowledgeScreenRecordingRequest", + "required": "true" + } + ] + }, + "POST /api/v2/recordings/screensessions/metadata": { + "operationId": "postrecordingsscreensessionsmetadata", + "functionName": "postRecordingsScreensessionsMetadata", + "signature": "postRecordingsScreensessionsMetadata(body)", + "parameters": [ + { + "name": "body", + "type": "ScreenRecordingMetaDataRequest", + "required": "true" + } + ] + }, + "PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}": { + "operationId": "putconversationrecording", + "functionName": "putConversationRecording", + "signature": "putConversationRecording(conversationId, recordingId, body, clearExport)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Recording", + "required": "true" + }, + { + "name": "clearExport", + "type": "Bool", + "required": "false" + } + ], + "return": "Recording" + }, + "PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}": { + "operationId": "putconversationrecordingannotation", + "functionName": "putConversationRecordingAnnotation", + "signature": "putConversationRecordingAnnotation(conversationId, recordingId, annotationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "annotationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Annotation", + "required": "true" + } + ], + "return": "Annotation" + }, + "PUT /api/v2/orphanrecordings/{orphanId}": { + "operationId": "putorphanrecording", + "functionName": "putOrphanrecording", + "signature": "putOrphanrecording(orphanId, body)", + "parameters": [ + { + "name": "orphanId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OrphanUpdateRequest", + "required": "false" + } + ], + "return": "Recording" + }, + "PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}": { + "operationId": "putrecordingcrossplatformmediaretentionpolicy", + "functionName": "putRecordingCrossplatformMediaretentionpolicy", + "signature": "putRecordingCrossplatformMediaretentionpolicy(policyId, body)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CrossPlatformPolicy", + "required": "true" + } + ], + "return": "CrossPlatformPolicy" + }, + "PUT /api/v2/recording/jobs/{jobId}": { + "operationId": "putrecordingjob", + "functionName": "putRecordingJob", + "signature": "putRecordingJob(jobId, body)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExecuteRecordingJobsQuery", + "required": "true" + } + ], + "return": "RecordingJob" + }, + "PUT /api/v2/recording/keyconfigurations/{keyConfigurationId}": { + "operationId": "putrecordingkeyconfiguration", + "functionName": "putRecordingKeyconfiguration", + "signature": "putRecordingKeyconfiguration(keyConfigurationId, body)", + "parameters": [ + { + "name": "keyConfigurationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RecordingEncryptionConfiguration", + "required": "true" + } + ], + "return": "RecordingEncryptionConfiguration" + }, + "PUT /api/v2/recording/mediaretentionpolicies/{policyId}": { + "operationId": "putrecordingmediaretentionpolicy", + "functionName": "putRecordingMediaretentionpolicy", + "signature": "putRecordingMediaretentionpolicy(policyId, body)", + "parameters": [ + { + "name": "policyId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Policy", + "required": "true" + } + ], + "return": "Policy" + }, + "PUT /api/v2/recording/recordingkeys/rotationschedule": { + "operationId": "putrecordingrecordingkeysrotationschedule", + "functionName": "putRecordingRecordingkeysRotationschedule", + "signature": "putRecordingRecordingkeysRotationschedule(body)", + "parameters": [ + { + "name": "body", + "type": "KeyRotationSchedule", + "required": "true" + } + ], + "return": "KeyRotationSchedule" + }, + "PUT /api/v2/recording/settings": { + "operationId": "putrecordingsettings", + "functionName": "putRecordingSettings", + "signature": "putRecordingSettings(body)", + "parameters": [ + { + "name": "body", + "type": "RecordingSettings", + "required": "true" + } + ], + "return": "RecordingSettings" + }, + "PUT /api/v2/recordings/deletionprotection": { + "operationId": "putrecordingsdeletionprotection", + "functionName": "putRecordingsDeletionprotection", + "signature": "putRecordingsDeletionprotection(protect, body)", + "parameters": [ + { + "name": "protect", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "ConversationDeletionProtectionQuery", + "required": "false" + } + ] + } + +} \ No newline at end of file diff --git a/build/docs/ResponseManagementAPI.json b/build/docs/ResponseManagementAPI.json new file mode 100644 index 000000000..3cf0ba72f --- /dev/null +++ b/build/docs/ResponseManagementAPI.json @@ -0,0 +1,286 @@ +{ + "DELETE /api/v2/responsemanagement/libraries/{libraryId}": { + "operationId": "deleteresponsemanagementlibrary", + "functionName": "deleteResponsemanagementLibrary", + "signature": "deleteResponsemanagementLibrary(libraryId)", + "parameters": [ + { + "name": "libraryId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/responsemanagement/responses/{responseId}": { + "operationId": "deleteresponsemanagementresponse", + "functionName": "deleteResponsemanagementResponse", + "signature": "deleteResponsemanagementResponse(responseId)", + "parameters": [ + { + "name": "responseId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/responsemanagement/responseassets/{responseAssetId}": { + "operationId": "deleteresponsemanagementresponseasset", + "functionName": "deleteResponsemanagementResponseasset", + "signature": "deleteResponsemanagementResponseasset(responseAssetId)", + "parameters": [ + { + "name": "responseAssetId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/responsemanagement/libraries": { + "operationId": "getresponsemanagementlibraries", + "functionName": "getResponsemanagementLibraries", + "signature": "getResponsemanagementLibraries(pageNumber, pageSize, messagingTemplateFilter, libraryPrefix)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "messagingTemplateFilter", + "type": "String", + "required": "false" + }, + { + "name": "libraryPrefix", + "type": "String", + "required": "false" + } + ], + "return": "LibraryEntityListing" + }, + "GET /api/v2/responsemanagement/libraries/{libraryId}": { + "operationId": "getresponsemanagementlibrary", + "functionName": "getResponsemanagementLibrary", + "signature": "getResponsemanagementLibrary(libraryId)", + "parameters": [ + { + "name": "libraryId", + "type": "String", + "required": "true" + } + ], + "return": "Library" + }, + "GET /api/v2/responsemanagement/responses/{responseId}": { + "operationId": "getresponsemanagementresponse", + "functionName": "getResponsemanagementResponse", + "signature": "getResponsemanagementResponse(responseId, expand)", + "parameters": [ + { + "name": "responseId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "ModelResponse" + }, + "GET /api/v2/responsemanagement/responseassets/{responseAssetId}": { + "operationId": "getresponsemanagementresponseasset", + "functionName": "getResponsemanagementResponseasset", + "signature": "getResponsemanagementResponseasset(responseAssetId)", + "parameters": [ + { + "name": "responseAssetId", + "type": "String", + "required": "true" + } + ], + "return": "ResponseAsset" + }, + "GET /api/v2/responsemanagement/responseassets/status/{statusId}": { + "operationId": "getresponsemanagementresponseassetsstatusstatusid", + "functionName": "getResponsemanagementResponseassetsStatusStatusId", + "signature": "getResponsemanagementResponseassetsStatusStatusId(statusId)", + "parameters": [ + { + "name": "statusId", + "type": "String", + "required": "true" + } + ], + "return": "ResponseAssetStatus" + }, + "GET /api/v2/responsemanagement/responses": { + "operationId": "getresponsemanagementresponses", + "functionName": "getResponsemanagementResponses", + "signature": "getResponsemanagementResponses(libraryId, pageNumber, pageSize, expand)", + "parameters": [ + { + "name": "libraryId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "ResponseEntityListing" + }, + "POST /api/v2/responsemanagement/libraries": { + "operationId": "postresponsemanagementlibraries", + "functionName": "postResponsemanagementLibraries", + "signature": "postResponsemanagementLibraries(body)", + "parameters": [ + { + "name": "body", + "type": "Library", + "required": "true" + } + ], + "return": "Library" + }, + "POST /api/v2/responsemanagement/responseassets/search": { + "operationId": "postresponsemanagementresponseassetssearch", + "functionName": "postResponsemanagementResponseassetsSearch", + "signature": "postResponsemanagementResponseassetsSearch(body, expand)", + "parameters": [ + { + "name": "body", + "type": "ResponseAssetSearchRequest", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ResponseAssetSearchResults" + }, + "POST /api/v2/responsemanagement/responseassets/uploads": { + "operationId": "postresponsemanagementresponseassetsuploads", + "functionName": "postResponsemanagementResponseassetsUploads", + "signature": "postResponsemanagementResponseassetsUploads(body)", + "parameters": [ + { + "name": "body", + "type": "CreateResponseAssetRequest", + "required": "true" + } + ], + "return": "CreateResponseAssetResponse" + }, + "POST /api/v2/responsemanagement/responses": { + "operationId": "postresponsemanagementresponses", + "functionName": "postResponsemanagementResponses", + "signature": "postResponsemanagementResponses(body, expand)", + "parameters": [ + { + "name": "body", + "type": "ModelResponse", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "ModelResponse" + }, + "POST /api/v2/responsemanagement/responses/query": { + "operationId": "postresponsemanagementresponsesquery", + "functionName": "postResponsemanagementResponsesQuery", + "signature": "postResponsemanagementResponsesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ResponseQueryRequest", + "required": "true" + } + ], + "return": "ResponseQueryResults" + }, + "PUT /api/v2/responsemanagement/libraries/{libraryId}": { + "operationId": "putresponsemanagementlibrary", + "functionName": "putResponsemanagementLibrary", + "signature": "putResponsemanagementLibrary(libraryId, body)", + "parameters": [ + { + "name": "libraryId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Library", + "required": "true" + } + ], + "return": "Library" + }, + "PUT /api/v2/responsemanagement/responses/{responseId}": { + "operationId": "putresponsemanagementresponse", + "functionName": "putResponsemanagementResponse", + "signature": "putResponsemanagementResponse(responseId, body, expand)", + "parameters": [ + { + "name": "responseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ModelResponse", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "ModelResponse" + }, + "PUT /api/v2/responsemanagement/responseassets/{responseAssetId}": { + "operationId": "putresponsemanagementresponseasset", + "functionName": "putResponsemanagementResponseasset", + "signature": "putResponsemanagementResponseasset(responseAssetId, body)", + "parameters": [ + { + "name": "responseAssetId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ResponseAssetRequest", + "required": "true" + } + ], + "return": "ResponseAsset" + } + +} \ No newline at end of file diff --git a/build/docs/RoutingAPI.json b/build/docs/RoutingAPI.json new file mode 100644 index 000000000..e387fd92e --- /dev/null +++ b/build/docs/RoutingAPI.json @@ -0,0 +1,2382 @@ +{ + "DELETE /api/v2/routing/assessments/{assessmentId}": { + "operationId": "deleteroutingassessment", + "functionName": "deleteRoutingAssessment", + "signature": "deleteRoutingAssessment(assessmentId)", + "parameters": [ + { + "name": "assessmentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/email/domains/{domainId}": { + "operationId": "deleteroutingemaildomain", + "functionName": "deleteRoutingEmailDomain", + "signature": "deleteRoutingEmailDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}": { + "operationId": "deleteroutingemaildomainroute", + "functionName": "deleteRoutingEmailDomainRoute", + "signature": "deleteRoutingEmailDomainRoute(domainName, routeId)", + "parameters": [ + { + "name": "domainName", + "type": "String", + "required": "true" + }, + { + "name": "routeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/email/outbound/domains/{domainId}": { + "operationId": "deleteroutingemailoutbounddomain", + "functionName": "deleteRoutingEmailOutboundDomain", + "signature": "deleteRoutingEmailOutboundDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/languages/{languageId}": { + "operationId": "deleteroutinglanguage", + "functionName": "deleteRoutingLanguage", + "signature": "deleteRoutingLanguage(languageId)", + "parameters": [ + { + "name": "languageId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/predictors/{predictorId}": { + "operationId": "deleteroutingpredictor", + "functionName": "deleteRoutingPredictor", + "signature": "deleteRoutingPredictor(predictorId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/queues/{queueId}": { + "operationId": "deleteroutingqueue", + "functionName": "deleteRoutingQueue", + "signature": "deleteRoutingQueue(queueId, forceDelete)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "forceDelete", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/routing/queues/{queueId}/members/{memberId}": { + "operationId": "deleteroutingqueuemember", + "functionName": "deleteRoutingQueueMember", + "signature": "deleteRoutingQueueMember(queueId, memberId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/queues/{queueId}/users/{memberId}": { + "operationId": "deleteroutingqueueuser", + "functionName": "deleteRoutingQueueUser", + "signature": "deleteRoutingQueueUser(queueId, memberId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}": { + "operationId": "deleteroutingqueuewrapupcode", + "functionName": "deleteRoutingQueueWrapupcode", + "signature": "deleteRoutingQueueWrapupcode(queueId, codeId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "codeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/settings": { + "operationId": "deleteroutingsettings", + "functionName": "deleteRoutingSettings", + "signature": "deleteRoutingSettings()" + + }, + "DELETE /api/v2/routing/skills/{skillId}": { + "operationId": "deleteroutingskill", + "functionName": "deleteRoutingSkill", + "signature": "deleteRoutingSkill(skillId)", + "parameters": [ + { + "name": "skillId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/skillgroups/{skillGroupId}": { + "operationId": "deleteroutingskillgroup", + "functionName": "deleteRoutingSkillgroup", + "signature": "deleteRoutingSkillgroup(skillGroupId)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/sms/addresses/{addressId}": { + "operationId": "deleteroutingsmsaddress", + "functionName": "deleteRoutingSmsAddress", + "signature": "deleteRoutingSmsAddress(addressId)", + "parameters": [ + { + "name": "addressId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/sms/phonenumbers/{addressId}": { + "operationId": "deleteroutingsmsphonenumber", + "functionName": "deleteRoutingSmsPhonenumber", + "signature": "deleteRoutingSmsPhonenumber(addressId)", + "parameters": [ + { + "name": "addressId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/users/{userId}/utilization": { + "operationId": "deleteroutinguserutilization", + "functionName": "deleteRoutingUserUtilization", + "signature": "deleteRoutingUserUtilization(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/utilization": { + "operationId": "deleteroutingutilization", + "functionName": "deleteRoutingUtilization", + "signature": "deleteRoutingUtilization()" + + }, + "DELETE /api/v2/routing/wrapupcodes/{codeId}": { + "operationId": "deleteroutingwrapupcode", + "functionName": "deleteRoutingWrapupcode", + "signature": "deleteRoutingWrapupcode(codeId)", + "parameters": [ + { + "name": "codeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}/routinglanguages/{languageId}": { + "operationId": "deleteuserroutinglanguage", + "functionName": "deleteUserRoutinglanguage", + "signature": "deleteUserRoutinglanguage(userId, languageId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "languageId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}/routingskills/{skillId}": { + "operationId": "deleteuserroutingskill", + "functionName": "deleteUserRoutingskill", + "signature": "deleteUserRoutingskill(userId, skillId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "skillId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/routing/assessments/{assessmentId}": { + "operationId": "getroutingassessment", + "functionName": "getRoutingAssessment", + "signature": "getRoutingAssessment(assessmentId)", + "parameters": [ + { + "name": "assessmentId", + "type": "String", + "required": "true" + } + ], + "return": "BenefitAssessment" + }, + "GET /api/v2/routing/assessments": { + "operationId": "getroutingassessments", + "functionName": "getRoutingAssessments", + "signature": "getRoutingAssessments(before, after, limit, pageSize, queueId)", + "parameters": [ + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "queueId", + "type": "[String]", + "required": "false" + } + ], + "return": "AssessmentListing" + }, + "GET /api/v2/routing/assessments/jobs/{jobId}": { + "operationId": "getroutingassessmentsjob", + "functionName": "getRoutingAssessmentsJob", + "signature": "getRoutingAssessmentsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "BenefitAssessmentJob" + }, + "GET /api/v2/routing/assessments/jobs": { + "operationId": "getroutingassessmentsjobs", + "functionName": "getRoutingAssessmentsJobs", + "signature": "getRoutingAssessmentsJobs(divisionId)", + "parameters": [ + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "AssessmentJobListing" + }, + "GET /api/v2/routing/availablemediatypes": { + "operationId": "getroutingavailablemediatypes", + "functionName": "getRoutingAvailablemediatypes", + "signature": "getRoutingAvailablemediatypes()", + + "return": "AvailableMediaTypeEntityListing" + }, + "GET /api/v2/routing/email/domains/{domainId}": { + "operationId": "getroutingemaildomain", + "functionName": "getRoutingEmailDomain", + "signature": "getRoutingEmailDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "InboundDomain" + }, + "GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}": { + "operationId": "getroutingemaildomainroute", + "functionName": "getRoutingEmailDomainRoute", + "signature": "getRoutingEmailDomainRoute(domainName, routeId)", + "parameters": [ + { + "name": "domainName", + "type": "String", + "required": "true" + }, + { + "name": "routeId", + "type": "String", + "required": "true" + } + ], + "return": "InboundRoute" + }, + "GET /api/v2/routing/email/domains/{domainName}/routes": { + "operationId": "getroutingemaildomainroutes", + "functionName": "getRoutingEmailDomainRoutes", + "signature": "getRoutingEmailDomainRoutes(domainName, pageSize, pageNumber, pattern)", + "parameters": [ + { + "name": "domainName", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pattern", + "type": "String", + "required": "false" + } + ], + "return": "InboundRouteEntityListing" + }, + "GET /api/v2/routing/email/domains": { + "operationId": "getroutingemaildomains", + "functionName": "getRoutingEmailDomains", + "signature": "getRoutingEmailDomains(pageSize, pageNumber, excludeStatus, filter)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "excludeStatus", + "type": "Bool", + "required": "false" + }, + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "InboundDomainEntityListing" + }, + "GET /api/v2/routing/email/outbound/domains/{domainId}": { + "operationId": "getroutingemailoutbounddomain", + "functionName": "getRoutingEmailOutboundDomain", + "signature": "getRoutingEmailOutboundDomain(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "OutboundDomain" + }, + "GET /api/v2/routing/email/outbound/domains/{domainId}/activation": { + "operationId": "getroutingemailoutbounddomainactivation", + "functionName": "getRoutingEmailOutboundDomainActivation", + "signature": "getRoutingEmailOutboundDomainActivation(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "EmailOutboundDomainResult" + }, + "GET /api/v2/routing/email/outbound/domains/{domainId}/search": { + "operationId": "getroutingemailoutbounddomainsearch", + "functionName": "getRoutingEmailOutboundDomainSearch", + "signature": "getRoutingEmailOutboundDomainSearch(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "OutboundDomain" + }, + "GET /api/v2/routing/email/outbound/domains": { + "operationId": "getroutingemailoutbounddomains", + "functionName": "getRoutingEmailOutboundDomains", + "signature": "getRoutingEmailOutboundDomains(filter)", + "parameters": [ + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "OutboundDomainEntityListing" + }, + "GET /api/v2/routing/email/setup": { + "operationId": "getroutingemailsetup", + "functionName": "getRoutingEmailSetup", + "signature": "getRoutingEmailSetup()", + + "return": "EmailSetup" + }, + "GET /api/v2/routing/languages/{languageId}": { + "operationId": "getroutinglanguage", + "functionName": "getRoutingLanguage", + "signature": "getRoutingLanguage(languageId)", + "parameters": [ + { + "name": "languageId", + "type": "String", + "required": "true" + } + ], + "return": "Language" + }, + "GET /api/v2/routing/languages": { + "operationId": "getroutinglanguages", + "functionName": "getRoutingLanguages", + "signature": "getRoutingLanguages(pageSize, pageNumber, sortOrder, name, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "LanguageEntityListing" + }, + "GET /api/v2/routing/message/recipients/{recipientId}": { + "operationId": "getroutingmessagerecipient", + "functionName": "getRoutingMessageRecipient", + "signature": "getRoutingMessageRecipient(recipientId)", + "parameters": [ + { + "name": "recipientId", + "type": "String", + "required": "true" + } + ], + "return": "Recipient" + }, + "GET /api/v2/routing/message/recipients": { + "operationId": "getroutingmessagerecipients", + "functionName": "getRoutingMessageRecipients", + "signature": "getRoutingMessageRecipients(messengerType, name, pageSize, pageNumber)", + "parameters": [ + { + "name": "messengerType", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "RecipientListing" + }, + "GET /api/v2/routing/predictors/{predictorId}": { + "operationId": "getroutingpredictor", + "functionName": "getRoutingPredictor", + "signature": "getRoutingPredictor(predictorId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + } + ], + "return": "Predictor" + }, + "GET /api/v2/routing/predictors/{predictorId}/models/{modelId}/features": { + "operationId": "getroutingpredictormodelfeatures", + "functionName": "getRoutingPredictorModelFeatures", + "signature": "getRoutingPredictorModelFeatures(predictorId, modelId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + }, + { + "name": "modelId", + "type": "String", + "required": "true" + } + ], + "return": "PredictorModelFeatureListing" + }, + "GET /api/v2/routing/predictors/{predictorId}/models": { + "operationId": "getroutingpredictormodels", + "functionName": "getRoutingPredictorModels", + "signature": "getRoutingPredictorModels(predictorId)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + } + ], + "return": "PredictorModels" + }, + "GET /api/v2/routing/predictors": { + "operationId": "getroutingpredictors", + "functionName": "getRoutingPredictors", + "signature": "getRoutingPredictors(before, after, limit, pageSize, queueId)", + "parameters": [ + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "limit", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "queueId", + "type": "[String]", + "required": "false" + } + ], + "return": "PredictorListing" + }, + "GET /api/v2/routing/predictors/keyperformanceindicators": { + "operationId": "getroutingpredictorskeyperformanceindicators", + "functionName": "getRoutingPredictorsKeyperformanceindicators", + "signature": "getRoutingPredictorsKeyperformanceindicators(kpiGroup, expand)", + "parameters": [ + { + "name": "kpiGroup", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "[KeyPerformanceIndicator]" + }, + "GET /api/v2/routing/queues/{queueId}": { + "operationId": "getroutingqueue", + "functionName": "getRoutingQueue", + "signature": "getRoutingQueue(queueId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + } + ], + "return": "Queue" + }, + "GET /api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}": { + "operationId": "getroutingqueuecomparisonperiod", + "functionName": "getRoutingQueueComparisonperiod", + "signature": "getRoutingQueueComparisonperiod(queueId, comparisonPeriodId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "comparisonPeriodId", + "type": "String", + "required": "true" + } + ], + "return": "ComparisonPeriod" + }, + "GET /api/v2/routing/queues/{queueId}/comparisonperiods": { + "operationId": "getroutingqueuecomparisonperiods", + "functionName": "getRoutingQueueComparisonperiods", + "signature": "getRoutingQueueComparisonperiods(queueId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + } + ], + "return": "ComparisonPeriodListing" + }, + "GET /api/v2/routing/queues/{queueId}/estimatedwaittime": { + "operationId": "getroutingqueueestimatedwaittime", + "functionName": "getRoutingQueueEstimatedwaittime", + "signature": "getRoutingQueueEstimatedwaittime(queueId, conversationId)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "conversationId", + "type": "String", + "required": "false" + } + ], + "return": "EstimatedWaitTimePredictions" + }, + "GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime": { + "operationId": "getroutingqueuemediatypeestimatedwaittime", + "functionName": "getRoutingQueueMediatypeEstimatedwaittime", + "signature": "getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "mediaType", + "type": "String", + "required": "true" + } + ], + "return": "EstimatedWaitTimePredictions" + }, + "GET /api/v2/routing/queues/{queueId}/members": { + "operationId": "getroutingqueuemembers", + "functionName": "getRoutingQueueMembers", + "signature": "getRoutingQueueMembers(queueId, pageNumber, pageSize, sortOrder, expand, name, profileSkills, skills, languages, routingStatus, presence, memberBy, joined)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "profileSkills", + "type": "[String]", + "required": "false" + }, + { + "name": "skills", + "type": "[String]", + "required": "false" + }, + { + "name": "languages", + "type": "[String]", + "required": "false" + }, + { + "name": "routingStatus", + "type": "[String]", + "required": "false" + }, + { + "name": "presence", + "type": "[String]", + "required": "false" + }, + { + "name": "memberBy", + "type": "String", + "required": "false" + }, + { + "name": "joined", + "type": "Bool", + "required": "false" + } + ], + "return": "QueueMemberEntityListing" + }, + "GET /api/v2/routing/queues/{queueId}/users": { + "operationId": "getroutingqueueusers", + "functionName": "getRoutingQueueUsers", + "signature": "getRoutingQueueUsers(queueId, pageNumber, pageSize, sortOrder, expand, joined, name, profileSkills, skills, languages, routingStatus, presence)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "joined", + "type": "Bool", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "profileSkills", + "type": "[String]", + "required": "false" + }, + { + "name": "skills", + "type": "[String]", + "required": "false" + }, + { + "name": "languages", + "type": "[String]", + "required": "false" + }, + { + "name": "routingStatus", + "type": "[String]", + "required": "false" + }, + { + "name": "presence", + "type": "[String]", + "required": "false" + } + ], + "return": "QueueMemberEntityListingV1" + }, + "GET /api/v2/routing/queues/{queueId}/wrapupcodes": { + "operationId": "getroutingqueuewrapupcodes", + "functionName": "getRoutingQueueWrapupcodes", + "signature": "getRoutingQueueWrapupcodes(queueId, pageSize, pageNumber)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "WrapupCodeEntityListing" + }, + "GET /api/v2/routing/queues": { + "operationId": "getroutingqueues", + "functionName": "getRoutingQueues", + "signature": "getRoutingQueues(pageNumber, pageSize, sortOrder, name, _id, divisionId, peerId, hasPeer)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + }, + { + "name": "peerId", + "type": "[String]", + "required": "false" + }, + { + "name": "hasPeer", + "type": "Bool", + "required": "false" + } + ], + "return": "QueueEntityListing" + }, + "GET /api/v2/routing/queues/divisionviews": { + "operationId": "getroutingqueuesdivisionviews", + "functionName": "getRoutingQueuesDivisionviews", + "signature": "getRoutingQueuesDivisionviews(pageSize, pageNumber, sortBy, sortOrder, name, _id, divisionId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "QueueEntityListing" + }, + "GET /api/v2/routing/queues/divisionviews/all": { + "operationId": "getroutingqueuesdivisionviewsall", + "functionName": "getRoutingQueuesDivisionviewsAll", + "signature": "getRoutingQueuesDivisionviewsAll(pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "QueueEntityListing" + }, + "GET /api/v2/routing/queues/me": { + "operationId": "getroutingqueuesme", + "functionName": "getRoutingQueuesMe", + "signature": "getRoutingQueuesMe(pageNumber, pageSize, joined, sortOrder)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "joined", + "type": "Bool", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "UserQueueEntityListing" + }, + "GET /api/v2/routing/settings": { + "operationId": "getroutingsettings", + "functionName": "getRoutingSettings", + "signature": "getRoutingSettings()", + + "return": "RoutingSettings" + }, + "GET /api/v2/routing/settings/contactcenter": { + "operationId": "getroutingsettingscontactcenter", + "functionName": "getRoutingSettingsContactcenter", + "signature": "getRoutingSettingsContactcenter()", + + "return": "ContactCenterSettings" + }, + "GET /api/v2/routing/settings/transcription": { + "operationId": "getroutingsettingstranscription", + "functionName": "getRoutingSettingsTranscription", + "signature": "getRoutingSettingsTranscription()", + + "return": "TranscriptionSettings" + }, + "GET /api/v2/routing/skills/{skillId}": { + "operationId": "getroutingskill", + "functionName": "getRoutingSkill", + "signature": "getRoutingSkill(skillId)", + "parameters": [ + { + "name": "skillId", + "type": "String", + "required": "true" + } + ], + "return": "RoutingSkill" + }, + "GET /api/v2/routing/skillgroups/{skillGroupId}": { + "operationId": "getroutingskillgroup", + "functionName": "getRoutingSkillgroup", + "signature": "getRoutingSkillgroup(skillGroupId)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + } + ], + "return": "SkillGroup" + }, + "GET /api/v2/routing/skillgroups/{skillGroupId}/members": { + "operationId": "getroutingskillgroupmembers", + "functionName": "getRoutingSkillgroupMembers", + "signature": "getRoutingSkillgroupMembers(skillGroupId, pageSize, after, before, expand)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "SkillGroupMemberEntityListing" + }, + "GET /api/v2/routing/skillgroups/{skillGroupId}/members/divisions": { + "operationId": "getroutingskillgroupmembersdivisions", + "functionName": "getRoutingSkillgroupMembersDivisions", + "signature": "getRoutingSkillgroupMembersDivisions(skillGroupId, expand)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "SkillGroupMemberDivisionList" + }, + "GET /api/v2/routing/skillgroups": { + "operationId": "getroutingskillgroups", + "functionName": "getRoutingSkillgroups", + "signature": "getRoutingSkillgroups(pageSize, name, after, before)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + } + ], + "return": "SkillGroupEntityListing" + }, + "GET /api/v2/routing/skills": { + "operationId": "getroutingskills", + "functionName": "getRoutingSkills", + "signature": "getRoutingSkills(pageSize, pageNumber, name, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "SkillEntityListing" + }, + "GET /api/v2/routing/sms/addresses/{addressId}": { + "operationId": "getroutingsmsaddress", + "functionName": "getRoutingSmsAddress", + "signature": "getRoutingSmsAddress(addressId)", + "parameters": [ + { + "name": "addressId", + "type": "String", + "required": "true" + } + ], + "return": "SmsAddress" + }, + "GET /api/v2/routing/sms/addresses": { + "operationId": "getroutingsmsaddresses", + "functionName": "getRoutingSmsAddresses", + "signature": "getRoutingSmsAddresses(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "SmsAddressEntityListing" + }, + "GET /api/v2/routing/sms/availablephonenumbers": { + "operationId": "getroutingsmsavailablephonenumbers", + "functionName": "getRoutingSmsAvailablephonenumbers", + "signature": "getRoutingSmsAvailablephonenumbers(countryCode, phoneNumberType, region, city, areaCode, pattern, addressRequirement)", + "parameters": [ + { + "name": "countryCode", + "type": "String", + "required": "true" + }, + { + "name": "phoneNumberType", + "type": "String", + "required": "true" + }, + { + "name": "region", + "type": "String", + "required": "false" + }, + { + "name": "city", + "type": "String", + "required": "false" + }, + { + "name": "areaCode", + "type": "String", + "required": "false" + }, + { + "name": "pattern", + "type": "String", + "required": "false" + }, + { + "name": "addressRequirement", + "type": "String", + "required": "false" + } + ], + "return": "SMSAvailablePhoneNumberEntityListing" + }, + "GET /api/v2/routing/sms/phonenumbers/{addressId}": { + "operationId": "getroutingsmsphonenumber", + "functionName": "getRoutingSmsPhonenumber", + "signature": "getRoutingSmsPhonenumber(addressId, expand)", + "parameters": [ + { + "name": "addressId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "SmsPhoneNumber" + }, + "GET /api/v2/routing/sms/phonenumbers": { + "operationId": "getroutingsmsphonenumbers", + "functionName": "getRoutingSmsPhonenumbers", + "signature": "getRoutingSmsPhonenumbers(phoneNumber, phoneNumberType, phoneNumberStatus, countryCode, pageSize, pageNumber, sortBy, sortOrder, language, integrationId)", + "parameters": [ + { + "name": "phoneNumber", + "type": "String", + "required": "false" + }, + { + "name": "phoneNumberType", + "type": "[String]", + "required": "false" + }, + { + "name": "phoneNumberStatus", + "type": "[String]", + "required": "false" + }, + { + "name": "countryCode", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "language", + "type": "String", + "required": "false" + }, + { + "name": "integrationId", + "type": "String", + "required": "false" + } + ], + "return": "SmsPhoneNumberEntityListing" + }, + "GET /api/v2/routing/users/{userId}/utilization": { + "operationId": "getroutinguserutilization", + "functionName": "getRoutingUserUtilization", + "signature": "getRoutingUserUtilization(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "AgentMaxUtilization" + }, + "GET /api/v2/routing/utilization": { + "operationId": "getroutingutilization", + "functionName": "getRoutingUtilization", + "signature": "getRoutingUtilization()", + + "return": "Utilization" + }, + "GET /api/v2/routing/wrapupcodes/{codeId}": { + "operationId": "getroutingwrapupcode", + "functionName": "getRoutingWrapupcode", + "signature": "getRoutingWrapupcode(codeId)", + "parameters": [ + { + "name": "codeId", + "type": "String", + "required": "true" + } + ], + "return": "WrapupCode" + }, + "GET /api/v2/routing/wrapupcodes": { + "operationId": "getroutingwrapupcodes", + "functionName": "getRoutingWrapupcodes", + "signature": "getRoutingWrapupcodes(pageSize, pageNumber, sortBy, sortOrder, name, _id, divisionId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "WrapupCodeEntityListing" + }, + "GET /api/v2/users/{userId}/queues": { + "operationId": "getuserqueues", + "functionName": "getUserQueues", + "signature": "getUserQueues(userId, pageSize, pageNumber, joined, divisionId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "joined", + "type": "Bool", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "UserQueueEntityListing" + }, + "GET /api/v2/users/{userId}/routinglanguages": { + "operationId": "getuserroutinglanguages", + "functionName": "getUserRoutinglanguages", + "signature": "getUserRoutinglanguages(userId, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "UserLanguageEntityListing" + }, + "GET /api/v2/users/{userId}/routingskills": { + "operationId": "getuserroutingskills", + "functionName": "getUserRoutingskills", + "signature": "getUserRoutingskills(userId, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "UserSkillEntityListing" + }, + "GET /api/v2/users/{userId}/skillgroups": { + "operationId": "getuserskillgroups", + "functionName": "getUserSkillgroups", + "signature": "getUserSkillgroups(userId, pageSize, after, before)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + } + ], + "return": "UserSkillGroupEntityListing" + }, + "PATCH /api/v2/routing/conversations/{conversationId}": { + "operationId": "patchroutingconversation", + "functionName": "patchRoutingConversation", + "signature": "patchRoutingConversation(conversationId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoutingConversationAttributesRequest", + "required": "true" + } + ], + "return": "RoutingConversationAttributesResponse" + }, + "PATCH /api/v2/routing/email/domains/{domainId}": { + "operationId": "patchroutingemaildomain", + "functionName": "patchRoutingEmailDomain", + "signature": "patchRoutingEmailDomain(domainId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InboundDomainPatchRequest", + "required": "true" + } + ], + "return": "InboundDomain" + }, + "PATCH /api/v2/routing/email/domains/{domainId}/validate": { + "operationId": "patchroutingemaildomainvalidate", + "functionName": "patchRoutingEmailDomainValidate", + "signature": "patchRoutingEmailDomainValidate(domainId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InboundDomainPatchRequest", + "required": "true" + } + ], + "return": "InboundDomain" + }, + "PATCH /api/v2/routing/predictors/{predictorId}": { + "operationId": "patchroutingpredictor", + "functionName": "patchRoutingPredictor", + "signature": "patchRoutingPredictor(predictorId, body)", + "parameters": [ + { + "name": "predictorId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchPredictorRequest", + "required": "false" + } + ], + "return": "Predictor" + }, + "PATCH /api/v2/routing/queues/{queueId}/members/{memberId}": { + "operationId": "patchroutingqueuemember", + "functionName": "patchRoutingQueueMember", + "signature": "patchRoutingQueueMember(queueId, memberId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueueMember", + "required": "true" + } + ] + }, + "PATCH /api/v2/routing/queues/{queueId}/members": { + "operationId": "patchroutingqueuemembers", + "functionName": "patchRoutingQueueMembers", + "signature": "patchRoutingQueueMembers(queueId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[QueueMember]", + "required": "true" + } + ], + "return": "QueueMemberEntityListing" + }, + "PATCH /api/v2/routing/queues/{queueId}/users/{memberId}": { + "operationId": "patchroutingqueueuser", + "functionName": "patchRoutingQueueUser", + "signature": "patchRoutingQueueUser(queueId, memberId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueueMember", + "required": "true" + } + ] + }, + "PATCH /api/v2/routing/queues/{queueId}/users": { + "operationId": "patchroutingqueueusers", + "functionName": "patchRoutingQueueUsers", + "signature": "patchRoutingQueueUsers(queueId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[QueueMember]", + "required": "true" + } + ], + "return": "QueueMemberEntityListingV1" + }, + "PATCH /api/v2/routing/settings/contactcenter": { + "operationId": "patchroutingsettingscontactcenter", + "functionName": "patchRoutingSettingsContactcenter", + "signature": "patchRoutingSettingsContactcenter(body)", + "parameters": [ + { + "name": "body", + "type": "ContactCenterSettings", + "required": "true" + } + ] + }, + "PATCH /api/v2/routing/skillgroups/{skillGroupId}": { + "operationId": "patchroutingskillgroup", + "functionName": "patchRoutingSkillgroup", + "signature": "patchRoutingSkillgroup(skillGroupId, body)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SkillGroup", + "required": "true" + } + ], + "return": "SkillGroup" + }, + "PATCH /api/v2/users/{userId}/queues/{queueId}": { + "operationId": "patchuserqueue", + "functionName": "patchUserQueue", + "signature": "patchUserQueue(queueId, userId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserQueue", + "required": "true" + } + ], + "return": "UserQueue" + }, + "PATCH /api/v2/users/{userId}/queues": { + "operationId": "patchuserqueues", + "functionName": "patchUserQueues", + "signature": "patchUserQueues(userId, body, divisionId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserQueue]", + "required": "true" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "UserQueueEntityListing" + }, + "PATCH /api/v2/users/{userId}/routinglanguages/{languageId}": { + "operationId": "patchuserroutinglanguage", + "functionName": "patchUserRoutinglanguage", + "signature": "patchUserRoutinglanguage(userId, languageId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "languageId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingLanguage", + "required": "true" + } + ], + "return": "UserRoutingLanguage" + }, + "PATCH /api/v2/users/{userId}/routinglanguages/bulk": { + "operationId": "patchuserroutinglanguagesbulk", + "functionName": "patchUserRoutinglanguagesBulk", + "signature": "patchUserRoutinglanguagesBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingLanguagePost]", + "required": "true" + } + ], + "return": "UserLanguageEntityListing" + }, + "PATCH /api/v2/users/{userId}/routingskills/bulk": { + "operationId": "patchuserroutingskillsbulk", + "functionName": "patchUserRoutingskillsBulk", + "signature": "patchUserRoutingskillsBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingSkillPost]", + "required": "true" + } + ], + "return": "UserSkillEntityListing" + }, + "POST /api/v2/analytics/queues/observations/query": { + "operationId": "postanalyticsqueuesobservationsquery", + "functionName": "postAnalyticsQueuesObservationsQuery", + "signature": "postAnalyticsQueuesObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "QueueObservationQuery", + "required": "true" + } + ], + "return": "QueueObservationQueryResponse" + }, + "POST /api/v2/routing/assessments": { + "operationId": "postroutingassessments", + "functionName": "postRoutingAssessments", + "signature": "postRoutingAssessments(body)", + "parameters": [ + { + "name": "body", + "type": "CreateBenefitAssessmentRequest", + "required": "false" + } + ], + "return": "BenefitAssessment" + }, + "POST /api/v2/routing/assessments/jobs": { + "operationId": "postroutingassessmentsjobs", + "functionName": "postRoutingAssessmentsJobs", + "signature": "postRoutingAssessmentsJobs(body)", + "parameters": [ + { + "name": "body", + "type": "CreateBenefitAssessmentJobRequest", + "required": "false" + } + ], + "return": "BenefitAssessmentJob" + }, + "POST /api/v2/routing/email/domains/{domainName}/routes": { + "operationId": "postroutingemaildomainroutes", + "functionName": "postRoutingEmailDomainRoutes", + "signature": "postRoutingEmailDomainRoutes(domainName, body)", + "parameters": [ + { + "name": "domainName", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InboundRoute", + "required": "true" + } + ], + "return": "InboundRoute" + }, + "POST /api/v2/routing/email/domains/{domainId}/testconnection": { + "operationId": "postroutingemaildomaintestconnection", + "functionName": "postRoutingEmailDomainTestconnection", + "signature": "postRoutingEmailDomainTestconnection(domainId, body)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TestMessage", + "required": "false" + } + ], + "return": "TestMessage" + }, + "POST /api/v2/routing/email/domains": { + "operationId": "postroutingemaildomains", + "functionName": "postRoutingEmailDomains", + "signature": "postRoutingEmailDomains(body)", + "parameters": [ + { + "name": "body", + "type": "InboundDomain", + "required": "true" + } + ], + "return": "InboundDomain" + }, + "POST /api/v2/routing/email/outbound/domains": { + "operationId": "postroutingemailoutbounddomains", + "functionName": "postRoutingEmailOutboundDomains", + "signature": "postRoutingEmailOutboundDomains(body)", + "parameters": [ + { + "name": "body", + "type": "OutboundDomain", + "required": "true" + } + ], + "return": "EmailOutboundDomainResult" + }, + "POST /api/v2/routing/email/outbound/domains/simulated": { + "operationId": "postroutingemailoutbounddomainssimulated", + "functionName": "postRoutingEmailOutboundDomainsSimulated", + "signature": "postRoutingEmailOutboundDomainsSimulated(body)", + "parameters": [ + { + "name": "body", + "type": "OutboundDomain", + "required": "true" + } + ], + "return": "EmailOutboundDomainResult" + }, + "POST /api/v2/routing/languages": { + "operationId": "postroutinglanguages", + "functionName": "postRoutingLanguages", + "signature": "postRoutingLanguages(body)", + "parameters": [ + { + "name": "body", + "type": "Language", + "required": "true" + } + ], + "return": "Language" + }, + "POST /api/v2/routing/predictors": { + "operationId": "postroutingpredictors", + "functionName": "postRoutingPredictors", + "signature": "postRoutingPredictors(body)", + "parameters": [ + { + "name": "body", + "type": "CreatePredictorRequest", + "required": "false" + } + ], + "return": "Predictor" + }, + "POST /api/v2/routing/queues/{queueId}/members": { + "operationId": "postroutingqueuemembers", + "functionName": "postRoutingQueueMembers", + "signature": "postRoutingQueueMembers(queueId, body, delete)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[WritableEntity]", + "required": "true" + }, + { + "name": "delete", + "type": "Bool", + "required": "false" + } + ] + }, + "POST /api/v2/routing/queues/{queueId}/users": { + "operationId": "postroutingqueueusers", + "functionName": "postRoutingQueueUsers", + "signature": "postRoutingQueueUsers(queueId, body, delete)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[WritableEntity]", + "required": "true" + }, + { + "name": "delete", + "type": "Bool", + "required": "false" + } + ] + }, + "POST /api/v2/routing/queues/{queueId}/wrapupcodes": { + "operationId": "postroutingqueuewrapupcodes", + "functionName": "postRoutingQueueWrapupcodes", + "signature": "postRoutingQueueWrapupcodes(queueId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[WrapUpCodeReference]", + "required": "true" + } + ], + "return": "[WrapupCode]" + }, + "POST /api/v2/routing/queues": { + "operationId": "postroutingqueues", + "functionName": "postRoutingQueues", + "signature": "postRoutingQueues(body)", + "parameters": [ + { + "name": "body", + "type": "CreateQueueRequest", + "required": "true" + } + ], + "return": "Queue" + }, + "POST /api/v2/routing/skillgroups/{skillGroupId}/members/divisions": { + "operationId": "postroutingskillgroupmembersdivisions", + "functionName": "postRoutingSkillgroupMembersDivisions", + "signature": "postRoutingSkillgroupMembersDivisions(skillGroupId, body)", + "parameters": [ + { + "name": "skillGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SkillGroupMemberDivisions", + "required": "false" + } + ] + }, + "POST /api/v2/routing/skillgroups": { + "operationId": "postroutingskillgroups", + "functionName": "postRoutingSkillgroups", + "signature": "postRoutingSkillgroups(body)", + "parameters": [ + { + "name": "body", + "type": "SkillGroupWithMemberDivisions", + "required": "true" + } + ], + "return": "SkillGroupWithMemberDivisions" + }, + "POST /api/v2/routing/skills": { + "operationId": "postroutingskills", + "functionName": "postRoutingSkills", + "signature": "postRoutingSkills(body)", + "parameters": [ + { + "name": "body", + "type": "RoutingSkill", + "required": "true" + } + ], + "return": "RoutingSkill" + }, + "POST /api/v2/routing/sms/addresses": { + "operationId": "postroutingsmsaddresses", + "functionName": "postRoutingSmsAddresses", + "signature": "postRoutingSmsAddresses(body)", + "parameters": [ + { + "name": "body", + "type": "SmsAddressProvision", + "required": "true" + } + ], + "return": "SmsAddress" + }, + "POST /api/v2/routing/sms/phonenumbers": { + "operationId": "postroutingsmsphonenumbers", + "functionName": "postRoutingSmsPhonenumbers", + "signature": "postRoutingSmsPhonenumbers(body)", + "parameters": [ + { + "name": "body", + "type": "SmsPhoneNumberProvision", + "required": "true" + } + ], + "return": "SmsPhoneNumber" + }, + "POST /api/v2/routing/wrapupcodes": { + "operationId": "postroutingwrapupcodes", + "functionName": "postRoutingWrapupcodes", + "signature": "postRoutingWrapupcodes(body)", + "parameters": [ + { + "name": "body", + "type": "WrapupCodeRequest", + "required": "true" + } + ], + "return": "WrapupCode" + }, + "POST /api/v2/users/{userId}/routinglanguages": { + "operationId": "postuserroutinglanguages", + "functionName": "postUserRoutinglanguages", + "signature": "postUserRoutinglanguages(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingLanguagePost", + "required": "true" + } + ], + "return": "UserRoutingLanguage" + }, + "POST /api/v2/users/{userId}/routingskills": { + "operationId": "postuserroutingskills", + "functionName": "postUserRoutingskills", + "signature": "postUserRoutingskills(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingSkillPost", + "required": "true" + } + ], + "return": "UserRoutingSkill" + }, + "PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}": { + "operationId": "putroutingemaildomainroute", + "functionName": "putRoutingEmailDomainRoute", + "signature": "putRoutingEmailDomainRoute(domainName, routeId, body)", + "parameters": [ + { + "name": "domainName", + "type": "String", + "required": "true" + }, + { + "name": "routeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "InboundRoute", + "required": "true" + } + ], + "return": "InboundRoute" + }, + "PUT /api/v2/routing/email/outbound/domains/{domainId}/activation": { + "operationId": "putroutingemailoutbounddomainactivation", + "functionName": "putRoutingEmailOutboundDomainActivation", + "signature": "putRoutingEmailOutboundDomainActivation(domainId)", + "parameters": [ + { + "name": "domainId", + "type": "String", + "required": "true" + } + ], + "return": "EmailOutboundDomainResult" + }, + "PUT /api/v2/routing/message/recipients/{recipientId}": { + "operationId": "putroutingmessagerecipient", + "functionName": "putRoutingMessageRecipient", + "signature": "putRoutingMessageRecipient(recipientId, body)", + "parameters": [ + { + "name": "recipientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RecipientRequest", + "required": "true" + } + ], + "return": "Recipient" + }, + "PUT /api/v2/routing/queues/{queueId}": { + "operationId": "putroutingqueue", + "functionName": "putRoutingQueue", + "signature": "putRoutingQueue(queueId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueueRequest", + "required": "true" + } + ], + "return": "Queue" + }, + "PUT /api/v2/routing/settings": { + "operationId": "putroutingsettings", + "functionName": "putRoutingSettings", + "signature": "putRoutingSettings(body)", + "parameters": [ + { + "name": "body", + "type": "RoutingSettings", + "required": "true" + } + ], + "return": "RoutingSettings" + }, + "PUT /api/v2/routing/settings/transcription": { + "operationId": "putroutingsettingstranscription", + "functionName": "putRoutingSettingsTranscription", + "signature": "putRoutingSettingsTranscription(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptionSettings", + "required": "true" + } + ], + "return": "TranscriptionSettings" + }, + "PUT /api/v2/routing/sms/phonenumbers/{addressId}": { + "operationId": "putroutingsmsphonenumber", + "functionName": "putRoutingSmsPhonenumber", + "signature": "putRoutingSmsPhonenumber(addressId, body)", + "parameters": [ + { + "name": "addressId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SmsPhoneNumber", + "required": "true" + } + ], + "return": "SmsPhoneNumber" + }, + "PUT /api/v2/routing/users/{userId}/utilization": { + "operationId": "putroutinguserutilization", + "functionName": "putRoutingUserUtilization", + "signature": "putRoutingUserUtilization(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Utilization", + "required": "true" + } + ], + "return": "AgentMaxUtilization" + }, + "PUT /api/v2/routing/utilization": { + "operationId": "putroutingutilization", + "functionName": "putRoutingUtilization", + "signature": "putRoutingUtilization(body)", + "parameters": [ + { + "name": "body", + "type": "Utilization", + "required": "true" + } + ], + "return": "Utilization" + }, + "PUT /api/v2/routing/wrapupcodes/{codeId}": { + "operationId": "putroutingwrapupcode", + "functionName": "putRoutingWrapupcode", + "signature": "putRoutingWrapupcode(codeId, body)", + "parameters": [ + { + "name": "codeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WrapupCodeRequest", + "required": "true" + } + ], + "return": "WrapupCode" + }, + "PUT /api/v2/users/{userId}/routingskills/{skillId}": { + "operationId": "putuserroutingskill", + "functionName": "putUserRoutingskill", + "signature": "putUserRoutingskill(userId, skillId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "skillId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingSkill", + "required": "true" + } + ], + "return": "UserRoutingSkill" + }, + "PUT /api/v2/users/{userId}/routingskills/bulk": { + "operationId": "putuserroutingskillsbulk", + "functionName": "putUserRoutingskillsBulk", + "signature": "putUserRoutingskillsBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingSkillPost]", + "required": "true" + } + ], + "return": "UserSkillEntityListing" + } + +} \ No newline at end of file diff --git a/build/docs/SCIMAPI.json b/build/docs/SCIMAPI.json new file mode 100644 index 000000000..abee96dc9 --- /dev/null +++ b/build/docs/SCIMAPI.json @@ -0,0 +1,611 @@ +{ + "DELETE /api/v2/scim/users/{userId}": { + "operationId": "deletescimuser", + "functionName": "deleteScimUser", + "signature": "deleteScimUser(userId, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/scim/v2/users/{userId}": { + "operationId": "deletescimv2user", + "functionName": "deleteScimV2User", + "signature": "deleteScimV2User(userId, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "GET /api/v2/scim/groups/{groupId}": { + "operationId": "getscimgroup", + "functionName": "getScimGroup", + "signature": "getScimGroup(groupId, attributes, excludedAttributes, ifNoneMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "GET /api/v2/scim/groups": { + "operationId": "getscimgroups", + "functionName": "getScimGroups", + "signature": "getScimGroups(startIndex, count, attributes, excludedAttributes, filter)", + "parameters": [ + { + "name": "startIndex", + "type": "Int", + "required": "false" + }, + { + "name": "count", + "type": "Int", + "required": "false" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "ScimGroupListResponse" + }, + "GET /api/v2/scim/resourcetypes/{resourceType}": { + "operationId": "getscimresourcetype", + "functionName": "getScimResourcetype", + "signature": "getScimResourcetype(resourceType)", + "parameters": [ + { + "name": "resourceType", + "type": "String", + "required": "true" + } + ], + "return": "ScimConfigResourceType" + }, + "GET /api/v2/scim/resourcetypes": { + "operationId": "getscimresourcetypes", + "functionName": "getScimResourcetypes", + "signature": "getScimResourcetypes()", + + "return": "ScimConfigResourceTypesListResponse" + }, + "GET /api/v2/scim/schemas/{schemaId}": { + "operationId": "getscimschema", + "functionName": "getScimSchema", + "signature": "getScimSchema(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "ScimV2SchemaDefinition" + }, + "GET /api/v2/scim/schemas": { + "operationId": "getscimschemas", + "functionName": "getScimSchemas", + "signature": "getScimSchemas(filter)", + "parameters": [ + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2SchemaListResponse" + }, + "GET /api/v2/scim/serviceproviderconfig": { + "operationId": "getscimserviceproviderconfig", + "functionName": "getScimServiceproviderconfig", + "signature": "getScimServiceproviderconfig(ifNoneMatch)", + "parameters": [ + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimServiceProviderConfig" + }, + "GET /api/v2/scim/users/{userId}": { + "operationId": "getscimuser", + "functionName": "getScimUser", + "signature": "getScimUser(userId, attributes, excludedAttributes, ifNoneMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + }, + "GET /api/v2/scim/users": { + "operationId": "getscimusers", + "functionName": "getScimUsers", + "signature": "getScimUsers(startIndex, count, attributes, excludedAttributes, filter)", + "parameters": [ + { + "name": "startIndex", + "type": "Int", + "required": "false" + }, + { + "name": "count", + "type": "Int", + "required": "false" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "ScimUserListResponse" + }, + "GET /api/v2/scim/v2/groups/{groupId}": { + "operationId": "getscimv2group", + "functionName": "getScimV2Group", + "signature": "getScimV2Group(groupId, attributes, excludedAttributes, ifNoneMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "GET /api/v2/scim/v2/groups": { + "operationId": "getscimv2groups", + "functionName": "getScimV2Groups", + "signature": "getScimV2Groups(filter, startIndex, count, attributes, excludedAttributes)", + "parameters": [ + { + "name": "filter", + "type": "String", + "required": "true" + }, + { + "name": "startIndex", + "type": "Int", + "required": "false" + }, + { + "name": "count", + "type": "Int", + "required": "false" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + } + ], + "return": "ScimGroupListResponse" + }, + "GET /api/v2/scim/v2/resourcetypes/{resourceType}": { + "operationId": "getscimv2resourcetype", + "functionName": "getScimV2Resourcetype", + "signature": "getScimV2Resourcetype(resourceType)", + "parameters": [ + { + "name": "resourceType", + "type": "String", + "required": "true" + } + ], + "return": "ScimConfigResourceType" + }, + "GET /api/v2/scim/v2/resourcetypes": { + "operationId": "getscimv2resourcetypes", + "functionName": "getScimV2Resourcetypes", + "signature": "getScimV2Resourcetypes()", + + "return": "ScimConfigResourceTypesListResponse" + }, + "GET /api/v2/scim/v2/schemas/{schemaId}": { + "operationId": "getscimv2schema", + "functionName": "getScimV2Schema", + "signature": "getScimV2Schema(schemaId)", + "parameters": [ + { + "name": "schemaId", + "type": "String", + "required": "true" + } + ], + "return": "ScimV2SchemaDefinition" + }, + "GET /api/v2/scim/v2/schemas": { + "operationId": "getscimv2schemas", + "functionName": "getScimV2Schemas", + "signature": "getScimV2Schemas(filter)", + "parameters": [ + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2SchemaListResponse" + }, + "GET /api/v2/scim/v2/serviceproviderconfig": { + "operationId": "getscimv2serviceproviderconfig", + "functionName": "getScimV2Serviceproviderconfig", + "signature": "getScimV2Serviceproviderconfig(ifNoneMatch)", + "parameters": [ + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimServiceProviderConfig" + }, + "GET /api/v2/scim/v2/users/{userId}": { + "operationId": "getscimv2user", + "functionName": "getScimV2User", + "signature": "getScimV2User(userId, attributes, excludedAttributes, ifNoneMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "ifNoneMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + }, + "GET /api/v2/scim/v2/users": { + "operationId": "getscimv2users", + "functionName": "getScimV2Users", + "signature": "getScimV2Users(startIndex, count, attributes, excludedAttributes, filter)", + "parameters": [ + { + "name": "startIndex", + "type": "Int", + "required": "false" + }, + { + "name": "count", + "type": "Int", + "required": "false" + }, + { + "name": "attributes", + "type": "[String]", + "required": "false" + }, + { + "name": "excludedAttributes", + "type": "[String]", + "required": "false" + }, + { + "name": "filter", + "type": "String", + "required": "false" + } + ], + "return": "ScimUserListResponse" + }, + "PATCH /api/v2/scim/groups/{groupId}": { + "operationId": "patchscimgroup", + "functionName": "patchScimGroup", + "signature": "patchScimGroup(groupId, body, ifMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2PatchRequest", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "PATCH /api/v2/scim/users/{userId}": { + "operationId": "patchscimuser", + "functionName": "patchScimUser", + "signature": "patchScimUser(userId, body, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2PatchRequest", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + }, + "PATCH /api/v2/scim/v2/groups/{groupId}": { + "operationId": "patchscimv2group", + "functionName": "patchScimV2Group", + "signature": "patchScimV2Group(groupId, body, ifMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2PatchRequest", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "PATCH /api/v2/scim/v2/users/{userId}": { + "operationId": "patchscimv2user", + "functionName": "patchScimV2User", + "signature": "patchScimV2User(userId, body, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2PatchRequest", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + }, + "POST /api/v2/scim/users": { + "operationId": "postscimusers", + "functionName": "postScimUsers", + "signature": "postScimUsers(body)", + "parameters": [ + { + "name": "body", + "type": "ScimV2CreateUser", + "required": "true" + } + ], + "return": "ScimV2User" + }, + "POST /api/v2/scim/v2/users": { + "operationId": "postscimv2users", + "functionName": "postScimV2Users", + "signature": "postScimV2Users(body)", + "parameters": [ + { + "name": "body", + "type": "ScimV2CreateUser", + "required": "true" + } + ], + "return": "ScimV2User" + }, + "PUT /api/v2/scim/groups/{groupId}": { + "operationId": "putscimgroup", + "functionName": "putScimGroup", + "signature": "putScimGroup(groupId, body, ifMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2Group", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "PUT /api/v2/scim/users/{userId}": { + "operationId": "putscimuser", + "functionName": "putScimUser", + "signature": "putScimUser(userId, body, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2User", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + }, + "PUT /api/v2/scim/v2/groups/{groupId}": { + "operationId": "putscimv2group", + "functionName": "putScimV2Group", + "signature": "putScimV2Group(groupId, body, ifMatch)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2Group", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2Group" + }, + "PUT /api/v2/scim/v2/users/{userId}": { + "operationId": "putscimv2user", + "functionName": "putScimV2User", + "signature": "putScimV2User(userId, body, ifMatch)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ScimV2User", + "required": "true" + }, + { + "name": "ifMatch", + "type": "String", + "required": "false" + } + ], + "return": "ScimV2User" + } + +} \ No newline at end of file diff --git a/build/docs/ScriptsAPI.json b/build/docs/ScriptsAPI.json new file mode 100644 index 000000000..aa0c5802a --- /dev/null +++ b/build/docs/ScriptsAPI.json @@ -0,0 +1,415 @@ +{ + "GET /api/v2/scripts/{scriptId}": { + "operationId": "getscript", + "functionName": "getScript", + "signature": "getScript(scriptId)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + } + ], + "return": "Script" + }, + "GET /api/v2/scripts/{scriptId}/pages/{pageId}": { + "operationId": "getscriptpage", + "functionName": "getScriptPage", + "signature": "getScriptPage(scriptId, pageId, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "pageId", + "type": "String", + "required": "true" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "Page" + }, + "GET /api/v2/scripts/{scriptId}/pages": { + "operationId": "getscriptpages", + "functionName": "getScriptPages", + "signature": "getScriptPages(scriptId, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "[Page]" + }, + "GET /api/v2/scripts": { + "operationId": "getscripts", + "functionName": "getScripts", + "signature": "getScripts(pageSize, pageNumber, expand, name, feature, flowId, sortBy, sortOrder, scriptDataVersion, divisionIds)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "flowId", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + }, + { + "name": "divisionIds", + "type": "String", + "required": "false" + } + ], + "return": "ScriptEntityListing" + }, + "GET /api/v2/scripts/divisionviews": { + "operationId": "getscriptsdivisionviews", + "functionName": "getScriptsDivisionviews", + "signature": "getScriptsDivisionviews(pageSize, pageNumber, expand, name, feature, flowId, sortBy, sortOrder, scriptDataVersion, divisionIds)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "flowId", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + }, + { + "name": "divisionIds", + "type": "String", + "required": "false" + } + ], + "return": "ScriptEntityListing" + }, + "GET /api/v2/scripts/published": { + "operationId": "getscriptspublished", + "functionName": "getScriptsPublished", + "signature": "getScriptsPublished(pageSize, pageNumber, expand, name, feature, flowId, scriptDataVersion, divisionIds)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "flowId", + "type": "String", + "required": "false" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + }, + { + "name": "divisionIds", + "type": "String", + "required": "false" + } + ], + "return": "ScriptEntityListing" + }, + "GET /api/v2/scripts/published/divisionviews": { + "operationId": "getscriptspublisheddivisionviews", + "functionName": "getScriptsPublishedDivisionviews", + "signature": "getScriptsPublishedDivisionviews(pageSize, pageNumber, expand, name, feature, flowId, scriptDataVersion, divisionIds)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "flowId", + "type": "String", + "required": "false" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + }, + { + "name": "divisionIds", + "type": "String", + "required": "false" + } + ], + "return": "ScriptEntityListing" + }, + "GET /api/v2/scripts/published/{scriptId}": { + "operationId": "getscriptspublishedscriptid", + "functionName": "getScriptsPublishedScriptId", + "signature": "getScriptsPublishedScriptId(scriptId, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "Script" + }, + "GET /api/v2/scripts/published/{scriptId}/pages/{pageId}": { + "operationId": "getscriptspublishedscriptidpage", + "functionName": "getScriptsPublishedScriptIdPage", + "signature": "getScriptsPublishedScriptIdPage(scriptId, pageId, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "pageId", + "type": "String", + "required": "true" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "Page" + }, + "GET /api/v2/scripts/published/{scriptId}/pages": { + "operationId": "getscriptspublishedscriptidpages", + "functionName": "getScriptsPublishedScriptIdPages", + "signature": "getScriptsPublishedScriptIdPages(scriptId, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "[Page]" + }, + "GET /api/v2/scripts/published/{scriptId}/variables": { + "operationId": "getscriptspublishedscriptidvariables", + "functionName": "getScriptsPublishedScriptIdVariables", + "signature": "getScriptsPublishedScriptIdVariables(scriptId, input, output, type, scriptDataVersion)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "input", + "type": "String", + "required": "false" + }, + { + "name": "output", + "type": "String", + "required": "false" + }, + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + } + ], + "return": "JSON" + }, + "GET /api/v2/scripts/uploads/{uploadId}/status": { + "operationId": "getscriptsuploadstatus", + "functionName": "getScriptsUploadStatus", + "signature": "getScriptsUploadStatus(uploadId, longPoll)", + "parameters": [ + { + "name": "uploadId", + "type": "String", + "required": "true" + }, + { + "name": "longPoll", + "type": "Bool", + "required": "false" + } + ], + "return": "ImportScriptStatusResponse" + }, + "POST /api/v2/scripts/{scriptId}/export": { + "operationId": "postscriptexport", + "functionName": "postScriptExport", + "signature": "postScriptExport(scriptId, body)", + "parameters": [ + { + "name": "scriptId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExportScriptRequest", + "required": "false" + } + ], + "return": "ExportScriptResponse" + }, + "POST /api/v2/scripts/published": { + "operationId": "postscriptspublished", + "functionName": "postScriptsPublished", + "signature": "postScriptsPublished(scriptDataVersion, body)", + "parameters": [ + { + "name": "scriptDataVersion", + "type": "String", + "required": "false" + }, + { + "name": "body", + "type": "PublishScriptRequestData", + "required": "false" + } + ], + "return": "Script" + } + +} \ No newline at end of file diff --git a/build/docs/SearchAPI.json b/build/docs/SearchAPI.json new file mode 100644 index 000000000..1bdfbdc8a --- /dev/null +++ b/build/docs/SearchAPI.json @@ -0,0 +1,349 @@ +{ + "GET /api/v2/documentation/gkn/search": { + "operationId": "getdocumentationgknsearch", + "functionName": "getDocumentationGknSearch", + "signature": "getDocumentationGknSearch(q64)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + } + ], + "return": "GKNDocumentationSearchResponse" + }, + "GET /api/v2/documentation/search": { + "operationId": "getdocumentationsearch", + "functionName": "getDocumentationSearch", + "signature": "getDocumentationSearch(q64)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + } + ], + "return": "DocumentationSearchResponse" + }, + "GET /api/v2/groups/search": { + "operationId": "getgroupssearch", + "functionName": "getGroupsSearch", + "signature": "getGroupsSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "GroupsSearchResponse" + }, + "GET /api/v2/locations/search": { + "operationId": "getlocationssearch", + "functionName": "getLocationsSearch", + "signature": "getLocationsSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LocationsSearchResponse" + }, + "GET /api/v2/search": { + "operationId": "getsearch", + "functionName": "getSearch", + "signature": "getSearch(q64, expand, profile)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "GET /api/v2/search/suggest": { + "operationId": "getsearchsuggest", + "functionName": "getSearchSuggest", + "signature": "getSearchSuggest(q64, expand, profile)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "GET /api/v2/users/search": { + "operationId": "getuserssearch", + "functionName": "getUsersSearch", + "signature": "getUsersSearch(q64, expand, integrationPresenceSource)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + } + ], + "return": "UsersSearchResponse" + }, + "GET /api/v2/voicemail/search": { + "operationId": "getvoicemailsearch", + "functionName": "getVoicemailSearch", + "signature": "getVoicemailSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "VoicemailsSearchResponse" + }, + "POST /api/v2/analytics/conversations/transcripts/query": { + "operationId": "postanalyticsconversationstranscriptsquery", + "functionName": "postAnalyticsConversationsTranscriptsQuery", + "signature": "postAnalyticsConversationsTranscriptsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptConversationDetailSearchRequest", + "required": "true" + } + ], + "return": "AnalyticsConversationWithoutAttributesMultiGetResponse" + }, + "POST /api/v2/conversations/participants/attributes/search": { + "operationId": "postconversationsparticipantsattributessearch", + "functionName": "postConversationsParticipantsAttributesSearch", + "signature": "postConversationsParticipantsAttributesSearch(body)", + "parameters": [ + { + "name": "body", + "type": "ConversationParticipantSearchRequest", + "required": "true" + } + ], + "return": "JsonCursorSearchResponse" + }, + "POST /api/v2/documentation/gkn/search": { + "operationId": "postdocumentationgknsearch", + "functionName": "postDocumentationGknSearch", + "signature": "postDocumentationGknSearch(body)", + "parameters": [ + { + "name": "body", + "type": "GKNDocumentationSearchRequest", + "required": "true" + } + ], + "return": "GKNDocumentationSearchResponse" + }, + "POST /api/v2/documentation/search": { + "operationId": "postdocumentationsearch", + "functionName": "postDocumentationSearch", + "signature": "postDocumentationSearch(body)", + "parameters": [ + { + "name": "body", + "type": "DocumentationSearchRequest", + "required": "true" + } + ], + "return": "DocumentationSearchResponse" + }, + "POST /api/v2/groups/search": { + "operationId": "postgroupssearch", + "functionName": "postGroupsSearch", + "signature": "postGroupsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "GroupSearchRequest", + "required": "true" + } + ], + "return": "GroupsSearchResponse" + }, + "POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search": { + "operationId": "postknowledgeknowledgebasesearch", + "functionName": "postKnowledgeKnowledgebaseSearch", + "signature": "postKnowledgeKnowledgebaseSearch(knowledgeBaseId, body)", + "parameters": [ + { + "name": "knowledgeBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "KnowledgeSearchRequest", + "required": "false" + } + ], + "return": "KnowledgeSearchResponse" + }, + "POST /api/v2/locations/search": { + "operationId": "postlocationssearch", + "functionName": "postLocationsSearch", + "signature": "postLocationsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "LocationSearchRequest", + "required": "true" + } + ], + "return": "LocationsSearchResponse" + }, + "POST /api/v2/search": { + "operationId": "postsearch", + "functionName": "postSearch", + "signature": "postSearch(body, profile)", + "parameters": [ + { + "name": "body", + "type": "SearchRequest", + "required": "true" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "POST /api/v2/search/suggest": { + "operationId": "postsearchsuggest", + "functionName": "postSearchSuggest", + "signature": "postSearchSuggest(body, profile)", + "parameters": [ + { + "name": "body", + "type": "SuggestSearchRequest", + "required": "true" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "POST /api/v2/speechandtextanalytics/transcripts/search": { + "operationId": "postspeechandtextanalyticstranscriptssearch", + "functionName": "postSpeechandtextanalyticsTranscriptsSearch", + "signature": "postSpeechandtextanalyticsTranscriptsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptSearchRequest", + "required": "true" + } + ], + "return": "JsonSearchResponse" + }, + "POST /api/v2/teams/search": { + "operationId": "postteamssearch", + "functionName": "postTeamsSearch", + "signature": "postTeamsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "TeamSearchRequest", + "required": "true" + } + ], + "return": "TeamsSearchResponse" + }, + "POST /api/v2/users/search": { + "operationId": "postuserssearch", + "functionName": "postUsersSearch", + "signature": "postUsersSearch(body)", + "parameters": [ + { + "name": "body", + "type": "UserSearchRequest", + "required": "true" + } + ], + "return": "UsersSearchResponse" + }, + "POST /api/v2/users/search/teams/assign": { + "operationId": "postuserssearchteamsassign", + "functionName": "postUsersSearchTeamsAssign", + "signature": "postUsersSearchTeamsAssign(body)", + "parameters": [ + { + "name": "body", + "type": "UserSearchRequest", + "required": "true" + } + ], + "return": "UsersSearchResponse" + }, + "POST /api/v2/voicemail/search": { + "operationId": "postvoicemailsearch", + "functionName": "postVoicemailSearch", + "signature": "postVoicemailSearch(body)", + "parameters": [ + { + "name": "body", + "type": "VoicemailSearchRequest", + "required": "true" + } + ], + "return": "VoicemailsSearchResponse" + } + +} \ No newline at end of file diff --git a/build/docs/SettingsAPI.json b/build/docs/SettingsAPI.json new file mode 100644 index 000000000..a441d90ef --- /dev/null +++ b/build/docs/SettingsAPI.json @@ -0,0 +1,23 @@ +{ + "GET /api/v2/emails/settings": { + "operationId": "getemailssettings", + "functionName": "getEmailsSettings", + "signature": "getEmailsSettings()", + + "return": "EmailSettings" + }, + "PATCH /api/v2/emails/settings": { + "operationId": "patchemailssettings", + "functionName": "patchEmailsSettings", + "signature": "patchEmailsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "EmailSettings", + "required": "false" + } + ], + "return": "EmailSettings" + } + +} \ No newline at end of file diff --git a/build/docs/SpeechTextAnalyticsAPI.json b/build/docs/SpeechTextAnalyticsAPI.json new file mode 100644 index 000000000..c7965b615 --- /dev/null +++ b/build/docs/SpeechTextAnalyticsAPI.json @@ -0,0 +1,627 @@ +{ + "DELETE /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}": { + "operationId": "deletespeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", + "functionName": "deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", + "signature": "deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId)", + "parameters": [ + { + "name": "dictionaryFeedbackId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/speechandtextanalytics/programs/{programId}": { + "operationId": "deletespeechandtextanalyticsprogram", + "functionName": "deleteSpeechandtextanalyticsProgram", + "signature": "deleteSpeechandtextanalyticsProgram(programId, forceDelete)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + }, + { + "name": "forceDelete", + "type": "Bool", + "required": "false" + } + ] + }, + "DELETE /api/v2/speechandtextanalytics/sentimentfeedback": { + "operationId": "deletespeechandtextanalyticssentimentfeedback", + "functionName": "deleteSpeechandtextanalyticsSentimentfeedback", + "signature": "deleteSpeechandtextanalyticsSentimentfeedback()" + + }, + "DELETE /api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}": { + "operationId": "deletespeechandtextanalyticssentimentfeedbacksentimentfeedbackid", + "functionName": "deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId", + "signature": "deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId)", + "parameters": [ + { + "name": "sentimentFeedbackId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/speechandtextanalytics/topics/{topicId}": { + "operationId": "deletespeechandtextanalyticstopic", + "functionName": "deleteSpeechandtextanalyticsTopic", + "signature": "deleteSpeechandtextanalyticsTopic(topicId)", + "parameters": [ + { + "name": "topicId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/speechandtextanalytics/conversations/{conversationId}": { + "operationId": "getspeechandtextanalyticsconversation", + "functionName": "getSpeechandtextanalyticsConversation", + "signature": "getSpeechandtextanalyticsConversation(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "ConversationMetrics" + }, + "GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl": { + "operationId": "getspeechandtextanalyticsconversationcommunicationtranscripturl", + "functionName": "getSpeechandtextanalyticsConversationCommunicationTranscripturl", + "signature": "getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId, communicationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + } + ], + "return": "TranscriptUrl" + }, + "GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls": { + "operationId": "getspeechandtextanalyticsconversationcommunicationtranscripturls", + "functionName": "getSpeechandtextanalyticsConversationCommunicationTranscripturls", + "signature": "getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "communicationId", + "type": "String", + "required": "true" + } + ], + "return": "TranscriptUrls" + }, + "GET /api/v2/speechandtextanalytics/dictionaryfeedback": { + "operationId": "getspeechandtextanalyticsdictionaryfeedback", + "functionName": "getSpeechandtextanalyticsDictionaryfeedback", + "signature": "getSpeechandtextanalyticsDictionaryfeedback(dialect, nextPage, pageSize)", + "parameters": [ + { + "name": "dialect", + "type": "String", + "required": "false" + }, + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DictionaryFeedbackEntityListing" + }, + "GET /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}": { + "operationId": "getspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", + "functionName": "getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", + "signature": "getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId)", + "parameters": [ + { + "name": "dictionaryFeedbackId", + "type": "String", + "required": "true" + } + ], + "return": "DictionaryFeedback" + }, + "GET /api/v2/speechandtextanalytics/programs/{programId}": { + "operationId": "getspeechandtextanalyticsprogram", + "functionName": "getSpeechandtextanalyticsProgram", + "signature": "getSpeechandtextanalyticsProgram(programId)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + } + ], + "return": "Program" + }, + "GET /api/v2/speechandtextanalytics/programs/{programId}/mappings": { + "operationId": "getspeechandtextanalyticsprogrammappings", + "functionName": "getSpeechandtextanalyticsProgramMappings", + "signature": "getSpeechandtextanalyticsProgramMappings(programId)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + } + ], + "return": "ProgramMappings" + }, + "GET /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines": { + "operationId": "getspeechandtextanalyticsprogramtranscriptionengines", + "functionName": "getSpeechandtextanalyticsProgramTranscriptionengines", + "signature": "getSpeechandtextanalyticsProgramTranscriptionengines(programId)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + } + ], + "return": "ProgramTranscriptionEngines" + }, + "GET /api/v2/speechandtextanalytics/programs": { + "operationId": "getspeechandtextanalyticsprograms", + "functionName": "getSpeechandtextanalyticsPrograms", + "signature": "getSpeechandtextanalyticsPrograms(nextPage, pageSize, state)", + "parameters": [ + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + } + ], + "return": "ProgramsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId}": { + "operationId": "getspeechandtextanalyticsprogramsgeneraljob", + "functionName": "getSpeechandtextanalyticsProgramsGeneralJob", + "signature": "getSpeechandtextanalyticsProgramsGeneralJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "GeneralProgramJob" + }, + "GET /api/v2/speechandtextanalytics/programs/mappings": { + "operationId": "getspeechandtextanalyticsprogramsmappings", + "functionName": "getSpeechandtextanalyticsProgramsMappings", + "signature": "getSpeechandtextanalyticsProgramsMappings(nextPage, pageSize)", + "parameters": [ + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "ProgramsMappingsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId}": { + "operationId": "getspeechandtextanalyticsprogramspublishjob", + "functionName": "getSpeechandtextanalyticsProgramsPublishjob", + "signature": "getSpeechandtextanalyticsProgramsPublishjob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "ProgramJob" + }, + "GET /api/v2/speechandtextanalytics/programs/transcriptionengines/dialects": { + "operationId": "getspeechandtextanalyticsprogramstranscriptionenginesdialects", + "functionName": "getSpeechandtextanalyticsProgramsTranscriptionenginesDialects", + "signature": "getSpeechandtextanalyticsProgramsTranscriptionenginesDialects()", + + "return": "SupportedDialectsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/programs/unpublished": { + "operationId": "getspeechandtextanalyticsprogramsunpublished", + "functionName": "getSpeechandtextanalyticsProgramsUnpublished", + "signature": "getSpeechandtextanalyticsProgramsUnpublished(nextPage, pageSize)", + "parameters": [ + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "UnpublishedProgramsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/sentiment/dialects": { + "operationId": "getspeechandtextanalyticssentimentdialects", + "functionName": "getSpeechandtextanalyticsSentimentDialects", + "signature": "getSpeechandtextanalyticsSentimentDialects()", + + "return": "EntityListing" + }, + "GET /api/v2/speechandtextanalytics/sentimentfeedback": { + "operationId": "getspeechandtextanalyticssentimentfeedback", + "functionName": "getSpeechandtextanalyticsSentimentfeedback", + "signature": "getSpeechandtextanalyticsSentimentfeedback(dialect)", + "parameters": [ + { + "name": "dialect", + "type": "String", + "required": "false" + } + ], + "return": "SentimentFeedbackEntityListing" + }, + "GET /api/v2/speechandtextanalytics/settings": { + "operationId": "getspeechandtextanalyticssettings", + "functionName": "getSpeechandtextanalyticsSettings", + "signature": "getSpeechandtextanalyticsSettings()", + + "return": "SpeechTextAnalyticsSettingsResponse" + }, + "GET /api/v2/speechandtextanalytics/topics/{topicId}": { + "operationId": "getspeechandtextanalyticstopic", + "functionName": "getSpeechandtextanalyticsTopic", + "signature": "getSpeechandtextanalyticsTopic(topicId)", + "parameters": [ + { + "name": "topicId", + "type": "String", + "required": "true" + } + ], + "return": "Topic" + }, + "GET /api/v2/speechandtextanalytics/topics": { + "operationId": "getspeechandtextanalyticstopics", + "functionName": "getSpeechandtextanalyticsTopics", + "signature": "getSpeechandtextanalyticsTopics(nextPage, pageSize, state, name, ids, sortBy, sortOrder)", + "parameters": [ + { + "name": "nextPage", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "ids", + "type": "[String]", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "TopicsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/topics/dialects": { + "operationId": "getspeechandtextanalyticstopicsdialects", + "functionName": "getSpeechandtextanalyticsTopicsDialects", + "signature": "getSpeechandtextanalyticsTopicsDialects()", + + "return": "EntityListing" + }, + "GET /api/v2/speechandtextanalytics/topics/general": { + "operationId": "getspeechandtextanalyticstopicsgeneral", + "functionName": "getSpeechandtextanalyticsTopicsGeneral", + "signature": "getSpeechandtextanalyticsTopicsGeneral(dialect)", + "parameters": [ + { + "name": "dialect", + "type": "String", + "required": "false" + } + ], + "return": "GeneralTopicsEntityListing" + }, + "GET /api/v2/speechandtextanalytics/topics/general/status": { + "operationId": "getspeechandtextanalyticstopicsgeneralstatus", + "functionName": "getSpeechandtextanalyticsTopicsGeneralStatus", + "signature": "getSpeechandtextanalyticsTopicsGeneralStatus(dialect)", + "parameters": [ + { + "name": "dialect", + "type": "String", + "required": "false" + } + ], + "return": "UnifiedGeneralTopicEntityListing" + }, + "GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId}": { + "operationId": "getspeechandtextanalyticstopicspublishjob", + "functionName": "getSpeechandtextanalyticsTopicsPublishjob", + "signature": "getSpeechandtextanalyticsTopicsPublishjob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "TopicJob" + }, + "PATCH /api/v2/speechandtextanalytics/settings": { + "operationId": "patchspeechandtextanalyticssettings", + "functionName": "patchSpeechandtextanalyticsSettings", + "signature": "patchSpeechandtextanalyticsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "SpeechTextAnalyticsSettingsRequest", + "required": "true" + } + ], + "return": "SpeechTextAnalyticsSettingsResponse" + }, + "POST /api/v2/speechandtextanalytics/dictionaryfeedback": { + "operationId": "postspeechandtextanalyticsdictionaryfeedback", + "functionName": "postSpeechandtextanalyticsDictionaryfeedback", + "signature": "postSpeechandtextanalyticsDictionaryfeedback(body)", + "parameters": [ + { + "name": "body", + "type": "DictionaryFeedback", + "required": "true" + } + ], + "return": "DictionaryFeedback" + }, + "POST /api/v2/speechandtextanalytics/programs": { + "operationId": "postspeechandtextanalyticsprograms", + "functionName": "postSpeechandtextanalyticsPrograms", + "signature": "postSpeechandtextanalyticsPrograms(body)", + "parameters": [ + { + "name": "body", + "type": "ProgramRequest", + "required": "true" + } + ], + "return": "Program" + }, + "POST /api/v2/speechandtextanalytics/programs/general/jobs": { + "operationId": "postspeechandtextanalyticsprogramsgeneraljobs", + "functionName": "postSpeechandtextanalyticsProgramsGeneralJobs", + "signature": "postSpeechandtextanalyticsProgramsGeneralJobs(body)", + "parameters": [ + { + "name": "body", + "type": "GeneralProgramJobRequest", + "required": "true" + } + ], + "return": "GeneralProgramJob" + }, + "POST /api/v2/speechandtextanalytics/programs/publishjobs": { + "operationId": "postspeechandtextanalyticsprogramspublishjobs", + "functionName": "postSpeechandtextanalyticsProgramsPublishjobs", + "signature": "postSpeechandtextanalyticsProgramsPublishjobs(body)", + "parameters": [ + { + "name": "body", + "type": "ProgramJobRequest", + "required": "true" + } + ], + "return": "ProgramJob" + }, + "POST /api/v2/speechandtextanalytics/sentimentfeedback": { + "operationId": "postspeechandtextanalyticssentimentfeedback", + "functionName": "postSpeechandtextanalyticsSentimentfeedback", + "signature": "postSpeechandtextanalyticsSentimentfeedback(body)", + "parameters": [ + { + "name": "body", + "type": "SentimentFeedback", + "required": "true" + } + ], + "return": "SentimentFeedback" + }, + "POST /api/v2/speechandtextanalytics/topics": { + "operationId": "postspeechandtextanalyticstopics", + "functionName": "postSpeechandtextanalyticsTopics", + "signature": "postSpeechandtextanalyticsTopics(body)", + "parameters": [ + { + "name": "body", + "type": "TopicRequest", + "required": "true" + } + ], + "return": "Topic" + }, + "POST /api/v2/speechandtextanalytics/topics/publishjobs": { + "operationId": "postspeechandtextanalyticstopicspublishjobs", + "functionName": "postSpeechandtextanalyticsTopicsPublishjobs", + "signature": "postSpeechandtextanalyticsTopicsPublishjobs(body)", + "parameters": [ + { + "name": "body", + "type": "TopicJobRequest", + "required": "true" + } + ], + "return": "TopicJob" + }, + "POST /api/v2/speechandtextanalytics/transcripts/search": { + "operationId": "postspeechandtextanalyticstranscriptssearch", + "functionName": "postSpeechandtextanalyticsTranscriptsSearch", + "signature": "postSpeechandtextanalyticsTranscriptsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "TranscriptSearchRequest", + "required": "true" + } + ], + "return": "JsonSearchResponse" + }, + "PUT /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}": { + "operationId": "putspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", + "functionName": "putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", + "signature": "putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId, body)", + "parameters": [ + { + "name": "dictionaryFeedbackId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DictionaryFeedback", + "required": "false" + } + ], + "return": "DictionaryFeedback" + }, + "PUT /api/v2/speechandtextanalytics/programs/{programId}": { + "operationId": "putspeechandtextanalyticsprogram", + "functionName": "putSpeechandtextanalyticsProgram", + "signature": "putSpeechandtextanalyticsProgram(programId, body)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ProgramRequest", + "required": "true" + } + ], + "return": "Program" + }, + "PUT /api/v2/speechandtextanalytics/programs/{programId}/mappings": { + "operationId": "putspeechandtextanalyticsprogrammappings", + "functionName": "putSpeechandtextanalyticsProgramMappings", + "signature": "putSpeechandtextanalyticsProgramMappings(programId, body)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ProgramMappingsRequest", + "required": "true" + } + ], + "return": "ProgramMappings" + }, + "PUT /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines": { + "operationId": "putspeechandtextanalyticsprogramtranscriptionengines", + "functionName": "putSpeechandtextanalyticsProgramTranscriptionengines", + "signature": "putSpeechandtextanalyticsProgramTranscriptionengines(programId, body)", + "parameters": [ + { + "name": "programId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TranscriptionEnginesRequest", + "required": "true" + } + ], + "return": "ProgramTranscriptionEngines" + }, + "PUT /api/v2/speechandtextanalytics/settings": { + "operationId": "putspeechandtextanalyticssettings", + "functionName": "putSpeechandtextanalyticsSettings", + "signature": "putSpeechandtextanalyticsSettings(body)", + "parameters": [ + { + "name": "body", + "type": "SpeechTextAnalyticsSettingsRequest", + "required": "true" + } + ], + "return": "SpeechTextAnalyticsSettingsResponse" + }, + "PUT /api/v2/speechandtextanalytics/topics/{topicId}": { + "operationId": "putspeechandtextanalyticstopic", + "functionName": "putSpeechandtextanalyticsTopic", + "signature": "putSpeechandtextanalyticsTopic(topicId, body)", + "parameters": [ + { + "name": "topicId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TopicRequest", + "required": "true" + } + ], + "return": "Topic" + } + +} \ No newline at end of file diff --git a/build/docs/StationsAPI.json b/build/docs/StationsAPI.json new file mode 100644 index 000000000..2a2aeee23 --- /dev/null +++ b/build/docs/StationsAPI.json @@ -0,0 +1,76 @@ +{ + "DELETE /api/v2/stations/{stationId}/associateduser": { + "operationId": "deletestationassociateduser", + "functionName": "deleteStationAssociateduser", + "signature": "deleteStationAssociateduser(stationId)", + "parameters": [ + { + "name": "stationId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/stations/{stationId}": { + "operationId": "getstation", + "functionName": "getStation", + "signature": "getStation(stationId)", + "parameters": [ + { + "name": "stationId", + "type": "String", + "required": "true" + } + ], + "return": "Station" + }, + "GET /api/v2/stations": { + "operationId": "getstations", + "functionName": "getStations", + "signature": "getStations(pageSize, pageNumber, sortBy, name, userSelectable, webRtcUserId, _id, lineAppearanceId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "userSelectable", + "type": "String", + "required": "false" + }, + { + "name": "webRtcUserId", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "String", + "required": "false" + }, + { + "name": "lineAppearanceId", + "type": "String", + "required": "false" + } + ], + "return": "StationEntityListing" + } + +} \ No newline at end of file diff --git a/build/docs/SuggestAPI.json b/build/docs/SuggestAPI.json new file mode 100644 index 000000000..2a45c84c9 --- /dev/null +++ b/build/docs/SuggestAPI.json @@ -0,0 +1,85 @@ +{ + "GET /api/v2/search": { + "operationId": "getsearch", + "functionName": "getSearch", + "signature": "getSearch(q64, expand, profile)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "GET /api/v2/search/suggest": { + "operationId": "getsearchsuggest", + "functionName": "getSearchSuggest", + "signature": "getSearchSuggest(q64, expand, profile)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "POST /api/v2/search": { + "operationId": "postsearch", + "functionName": "postSearch", + "signature": "postSearch(body, profile)", + "parameters": [ + { + "name": "body", + "type": "SearchRequest", + "required": "true" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + }, + "POST /api/v2/search/suggest": { + "operationId": "postsearchsuggest", + "functionName": "postSearchSuggest", + "signature": "postSearchSuggest(body, profile)", + "parameters": [ + { + "name": "body", + "type": "SuggestSearchRequest", + "required": "true" + }, + { + "name": "profile", + "type": "Bool", + "required": "false" + } + ], + "return": "JsonNodeSearchResponse" + } + +} \ No newline at end of file diff --git a/build/docs/TeamsAPI.json b/build/docs/TeamsAPI.json new file mode 100644 index 000000000..ac75ff7a8 --- /dev/null +++ b/build/docs/TeamsAPI.json @@ -0,0 +1,173 @@ +{ + "DELETE /api/v2/teams/{teamId}": { + "operationId": "deleteteam", + "functionName": "deleteTeam", + "signature": "deleteTeam(teamId)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/teams/{teamId}/members": { + "operationId": "deleteteammembers", + "functionName": "deleteTeamMembers", + "signature": "deleteTeamMembers(teamId, _id)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "_id", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/teams/{teamId}": { + "operationId": "getteam", + "functionName": "getTeam", + "signature": "getTeam(teamId)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + } + ], + "return": "Team" + }, + "GET /api/v2/teams/{teamId}/members": { + "operationId": "getteammembers", + "functionName": "getTeamMembers", + "signature": "getTeamMembers(teamId, pageSize, before, after, expand)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "TeamMemberEntityListing" + }, + "GET /api/v2/teams": { + "operationId": "getteams", + "functionName": "getTeams", + "signature": "getTeams(pageSize, name, after, before, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "TeamEntityListing" + }, + "PATCH /api/v2/teams/{teamId}": { + "operationId": "patchteam", + "functionName": "patchTeam", + "signature": "patchTeam(teamId, body)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Team", + "required": "true" + } + ], + "return": "Team" + }, + "POST /api/v2/teams/{teamId}/members": { + "operationId": "postteammembers", + "functionName": "postTeamMembers", + "signature": "postTeamMembers(teamId, body)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TeamMembers", + "required": "true" + } + ], + "return": "TeamMemberAddListingResponse" + }, + "POST /api/v2/teams": { + "operationId": "postteams", + "functionName": "postTeams", + "signature": "postTeams(body)", + "parameters": [ + { + "name": "body", + "type": "Team", + "required": "true" + } + ], + "return": "Team" + }, + "POST /api/v2/teams/search": { + "operationId": "postteamssearch", + "functionName": "postTeamsSearch", + "signature": "postTeamsSearch(body)", + "parameters": [ + { + "name": "body", + "type": "TeamSearchRequest", + "required": "true" + } + ], + "return": "TeamsSearchResponse" + } + +} \ No newline at end of file diff --git a/build/docs/TelephonyAPI.json b/build/docs/TelephonyAPI.json new file mode 100644 index 000000000..32ca5c9e9 --- /dev/null +++ b/build/docs/TelephonyAPI.json @@ -0,0 +1,74 @@ +{ + "GET /api/v2/telephony/mediaregions": { + "operationId": "gettelephonymediaregions", + "functionName": "getTelephonyMediaregions", + "signature": "getTelephonyMediaregions()", + + "return": "MediaRegions" + }, + "GET /api/v2/telephony/siptraces": { + "operationId": "gettelephonysiptraces", + "functionName": "getTelephonySiptraces", + "signature": "getTelephonySiptraces(dateStart, dateEnd, callId, toUser, fromUser, conversationId)", + "parameters": [ + { + "name": "dateStart", + "type": "Date", + "required": "true" + }, + { + "name": "dateEnd", + "type": "Date", + "required": "true" + }, + { + "name": "callId", + "type": "String", + "required": "false" + }, + { + "name": "toUser", + "type": "String", + "required": "false" + }, + { + "name": "fromUser", + "type": "String", + "required": "false" + }, + { + "name": "conversationId", + "type": "String", + "required": "false" + } + ], + "return": "SipSearchResult" + }, + "GET /api/v2/telephony/siptraces/download/{downloadId}": { + "operationId": "gettelephonysiptracesdownloaddownloadid", + "functionName": "getTelephonySiptracesDownloadDownloadId", + "signature": "getTelephonySiptracesDownloadDownloadId(downloadId)", + "parameters": [ + { + "name": "downloadId", + "type": "String", + "required": "true" + } + ], + "return": "SignedUrlResponse" + }, + "POST /api/v2/telephony/siptraces/download": { + "operationId": "posttelephonysiptracesdownload", + "functionName": "postTelephonySiptracesDownload", + "signature": "postTelephonySiptracesDownload(sIPSearchPublicRequest)", + "parameters": [ + { + "name": "sIPSearchPublicRequest", + "type": "SIPSearchPublicRequest", + "required": "true" + } + ], + "return": "SipDownloadResponse" + } + +} \ No newline at end of file diff --git a/build/docs/TelephonyProvidersEdgeAPI.json b/build/docs/TelephonyProvidersEdgeAPI.json new file mode 100644 index 000000000..0141125de --- /dev/null +++ b/build/docs/TelephonyProvidersEdgeAPI.json @@ -0,0 +1,2197 @@ +{ + "DELETE /api/v2/telephony/providers/edges/{edgeId}": { + "operationId": "deletetelephonyprovidersedge", + "functionName": "deleteTelephonyProvidersEdge", + "signature": "deleteTelephonyProvidersEdge(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}": { + "operationId": "deletetelephonyprovidersedgelogicalinterface", + "functionName": "deleteTelephonyProvidersEdgeLogicalinterface", + "signature": "deleteTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "interfaceId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate": { + "operationId": "deletetelephonyprovidersedgesoftwareupdate", + "functionName": "deleteTelephonyProvidersEdgeSoftwareupdate", + "signature": "deleteTelephonyProvidersEdgeSoftwareupdate(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}": { + "operationId": "deletetelephonyprovidersedgescertificateauthority", + "functionName": "deleteTelephonyProvidersEdgesCertificateauthority", + "signature": "deleteTelephonyProvidersEdgesCertificateauthority(certificateId)", + "parameters": [ + { + "name": "certificateId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId}": { + "operationId": "deletetelephonyprovidersedgesdidpool", + "functionName": "deleteTelephonyProvidersEdgesDidpool", + "signature": "deleteTelephonyProvidersEdgesDidpool(didPoolId)", + "parameters": [ + { + "name": "didPoolId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}": { + "operationId": "deletetelephonyprovidersedgesedgegroup", + "functionName": "deleteTelephonyProvidersEdgesEdgegroup", + "signature": "deleteTelephonyProvidersEdgesEdgegroup(edgeGroupId)", + "parameters": [ + { + "name": "edgeGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}": { + "operationId": "deletetelephonyprovidersedgesextensionpool", + "functionName": "deleteTelephonyProvidersEdgesExtensionpool", + "signature": "deleteTelephonyProvidersEdgesExtensionpool(extensionPoolId)", + "parameters": [ + { + "name": "extensionPoolId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/phones/{phoneId}": { + "operationId": "deletetelephonyprovidersedgesphone", + "functionName": "deleteTelephonyProvidersEdgesPhone", + "signature": "deleteTelephonyProvidersEdgesPhone(phoneId)", + "parameters": [ + { + "name": "phoneId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}": { + "operationId": "deletetelephonyprovidersedgesphonebasesetting", + "functionName": "deleteTelephonyProvidersEdgesPhonebasesetting", + "signature": "deleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId)", + "parameters": [ + { + "name": "phoneBaseId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/sites/{siteId}": { + "operationId": "deletetelephonyprovidersedgessite", + "functionName": "deleteTelephonyProvidersEdgesSite", + "signature": "deleteTelephonyProvidersEdgesSite(siteId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}": { + "operationId": "deletetelephonyprovidersedgessiteoutboundroute", + "functionName": "deleteTelephonyProvidersEdgesSiteOutboundroute", + "signature": "deleteTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "outboundRouteId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}": { + "operationId": "deletetelephonyprovidersedgestrunkbasesetting", + "functionName": "deleteTelephonyProvidersEdgesTrunkbasesetting", + "signature": "deleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId)", + "parameters": [ + { + "name": "trunkBaseSettingsId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/telephony/providers/edges/{edgeId}": { + "operationId": "gettelephonyprovidersedge", + "functionName": "getTelephonyProvidersEdge", + "signature": "getTelephonyProvidersEdge(edgeId, expand)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Edge" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup": { + "operationId": "gettelephonyprovidersedgediagnosticnslookup", + "functionName": "getTelephonyProvidersEdgeDiagnosticNslookup", + "signature": "getTelephonyProvidersEdgeDiagnosticNslookup(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnosticResponse" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping": { + "operationId": "gettelephonyprovidersedgediagnosticping", + "functionName": "getTelephonyProvidersEdgeDiagnosticPing", + "signature": "getTelephonyProvidersEdgeDiagnosticPing(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnosticResponse" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route": { + "operationId": "gettelephonyprovidersedgediagnosticroute", + "functionName": "getTelephonyProvidersEdgeDiagnosticRoute", + "signature": "getTelephonyProvidersEdgeDiagnosticRoute(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnosticResponse" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath": { + "operationId": "gettelephonyprovidersedgediagnostictracepath", + "functionName": "getTelephonyProvidersEdgeDiagnosticTracepath", + "signature": "getTelephonyProvidersEdgeDiagnosticTracepath(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnosticResponse" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}": { + "operationId": "gettelephonyprovidersedgelogicalinterface", + "functionName": "getTelephonyProvidersEdgeLogicalinterface", + "signature": "getTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId, expand)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "interfaceId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "DomainLogicalInterface" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces": { + "operationId": "gettelephonyprovidersedgelogicalinterfaces", + "functionName": "getTelephonyProvidersEdgeLogicalinterfaces", + "signature": "getTelephonyProvidersEdgeLogicalinterfaces(edgeId, expand)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LogicalInterfaceEntityListing" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}": { + "operationId": "gettelephonyprovidersedgelogsjob", + "functionName": "getTelephonyProvidersEdgeLogsJob", + "signature": "getTelephonyProvidersEdgeLogsJob(edgeId, jobId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeLogsJob" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/metrics": { + "operationId": "gettelephonyprovidersedgemetrics", + "functionName": "getTelephonyProvidersEdgeMetrics", + "signature": "getTelephonyProvidersEdgeMetrics(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeMetrics" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}": { + "operationId": "gettelephonyprovidersedgephysicalinterface", + "functionName": "getTelephonyProvidersEdgePhysicalinterface", + "signature": "getTelephonyProvidersEdgePhysicalinterface(edgeId, interfaceId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "interfaceId", + "type": "String", + "required": "true" + } + ], + "return": "DomainPhysicalInterface" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces": { + "operationId": "gettelephonyprovidersedgephysicalinterfaces", + "functionName": "getTelephonyProvidersEdgePhysicalinterfaces", + "signature": "getTelephonyProvidersEdgePhysicalinterfaces(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "PhysicalInterfaceEntityListing" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage": { + "operationId": "gettelephonyprovidersedgesetuppackage", + "functionName": "getTelephonyProvidersEdgeSetuppackage", + "signature": "getTelephonyProvidersEdgeSetuppackage(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "VmPairingInfo" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate": { + "operationId": "gettelephonyprovidersedgesoftwareupdate", + "functionName": "getTelephonyProvidersEdgeSoftwareupdate", + "signature": "getTelephonyProvidersEdgeSoftwareupdate(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "DomainEdgeSoftwareUpdateDto" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions": { + "operationId": "gettelephonyprovidersedgesoftwareversions", + "functionName": "getTelephonyProvidersEdgeSoftwareversions", + "signature": "getTelephonyProvidersEdgeSoftwareversions(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "DomainEdgeSoftwareVersionDtoEntityListing" + }, + "GET /api/v2/telephony/providers/edges/{edgeId}/trunks": { + "operationId": "gettelephonyprovidersedgetrunks", + "functionName": "getTelephonyProvidersEdgeTrunks", + "signature": "getTelephonyProvidersEdgeTrunks(edgeId, pageNumber, pageSize, sortBy, sortOrder, trunkBaseId, trunkType)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "trunkBaseId", + "type": "String", + "required": "false" + }, + { + "name": "trunkType", + "type": "String", + "required": "false" + } + ], + "return": "TrunkEntityListing" + }, + "GET /api/v2/telephony/providers/edges": { + "operationId": "gettelephonyprovidersedges", + "functionName": "getTelephonyProvidersEdges", + "signature": "getTelephonyProvidersEdges(pageSize, pageNumber, name, siteId, edgeGroupId, sortBy, managed, showCloudMedia)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "siteId", + "type": "String", + "required": "false" + }, + { + "name": "edgeGroupId", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "managed", + "type": "Bool", + "required": "false" + }, + { + "name": "showCloudMedia", + "type": "Bool", + "required": "false" + } + ], + "return": "EdgeEntityListing" + }, + "GET /api/v2/telephony/providers/edges/availablelanguages": { + "operationId": "gettelephonyprovidersedgesavailablelanguages", + "functionName": "getTelephonyProvidersEdgesAvailablelanguages", + "signature": "getTelephonyProvidersEdgesAvailablelanguages()", + + "return": "AvailableLanguageList" + }, + "GET /api/v2/telephony/providers/edges/certificateauthorities": { + "operationId": "gettelephonyprovidersedgescertificateauthorities", + "functionName": "getTelephonyProvidersEdgesCertificateauthorities", + "signature": "getTelephonyProvidersEdgesCertificateauthorities()", + + "return": "CertificateAuthorityEntityListing" + }, + "GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}": { + "operationId": "gettelephonyprovidersedgescertificateauthority", + "functionName": "getTelephonyProvidersEdgesCertificateauthority", + "signature": "getTelephonyProvidersEdgesCertificateauthority(certificateId)", + "parameters": [ + { + "name": "certificateId", + "type": "String", + "required": "true" + } + ], + "return": "DomainCertificateAuthority" + }, + "GET /api/v2/telephony/providers/edges/dids/{didId}": { + "operationId": "gettelephonyprovidersedgesdid", + "functionName": "getTelephonyProvidersEdgesDid", + "signature": "getTelephonyProvidersEdgesDid(didId)", + "parameters": [ + { + "name": "didId", + "type": "String", + "required": "true" + } + ], + "return": "DID" + }, + "GET /api/v2/telephony/providers/edges/didpools/{didPoolId}": { + "operationId": "gettelephonyprovidersedgesdidpool", + "functionName": "getTelephonyProvidersEdgesDidpool", + "signature": "getTelephonyProvidersEdgesDidpool(didPoolId)", + "parameters": [ + { + "name": "didPoolId", + "type": "String", + "required": "true" + } + ], + "return": "DIDPool" + }, + "GET /api/v2/telephony/providers/edges/didpools": { + "operationId": "gettelephonyprovidersedgesdidpools", + "functionName": "getTelephonyProvidersEdgesDidpools", + "signature": "getTelephonyProvidersEdgesDidpools(pageSize, pageNumber, sortBy, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "DIDPoolEntityListing" + }, + "GET /api/v2/telephony/providers/edges/didpools/dids": { + "operationId": "gettelephonyprovidersedgesdidpoolsdids", + "functionName": "getTelephonyProvidersEdgesDidpoolsDids", + "signature": "getTelephonyProvidersEdgesDidpoolsDids(type, _id, numberMatch, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "type", + "type": "String", + "required": "true" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "numberMatch", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "DIDNumberEntityListing" + }, + "GET /api/v2/telephony/providers/edges/dids": { + "operationId": "gettelephonyprovidersedgesdids", + "functionName": "getTelephonyProvidersEdgesDids", + "signature": "getTelephonyProvidersEdgesDids(pageSize, pageNumber, sortBy, sortOrder, phoneNumber, ownerId, didPoolId, _id)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "phoneNumber", + "type": "String", + "required": "false" + }, + { + "name": "ownerId", + "type": "String", + "required": "false" + }, + { + "name": "didPoolId", + "type": "String", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + } + ], + "return": "DIDEntityListing" + }, + "GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}": { + "operationId": "gettelephonyprovidersedgesedgegroup", + "functionName": "getTelephonyProvidersEdgesEdgegroup", + "signature": "getTelephonyProvidersEdgesEdgegroup(edgeGroupId, expand)", + "parameters": [ + { + "name": "edgeGroupId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "EdgeGroup" + }, + "GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}": { + "operationId": "gettelephonyprovidersedgesedgegroupedgetrunkbase", + "functionName": "getTelephonyProvidersEdgesEdgegroupEdgetrunkbase", + "signature": "getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId, edgetrunkbaseId)", + "parameters": [ + { + "name": "edgegroupId", + "type": "String", + "required": "true" + }, + { + "name": "edgetrunkbaseId", + "type": "String", + "required": "true" + } + ], + "return": "EdgeTrunkBase" + }, + "GET /api/v2/telephony/providers/edges/edgegroups": { + "operationId": "gettelephonyprovidersedgesedgegroups", + "functionName": "getTelephonyProvidersEdgesEdgegroups", + "signature": "getTelephonyProvidersEdgesEdgegroups(pageSize, pageNumber, name, sortBy, managed)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "managed", + "type": "Bool", + "required": "false" + } + ], + "return": "EdgeGroupEntityListing" + }, + "GET /api/v2/telephony/providers/edges/edgeversionreport": { + "operationId": "gettelephonyprovidersedgesedgeversionreport", + "functionName": "getTelephonyProvidersEdgesEdgeversionreport", + "signature": "getTelephonyProvidersEdgesEdgeversionreport()", + + "return": "EdgeVersionReport" + }, + "GET /api/v2/telephony/providers/edges/expired": { + "operationId": "gettelephonyprovidersedgesexpired", + "functionName": "getTelephonyProvidersEdgesExpired", + "signature": "getTelephonyProvidersEdgesExpired()", + + "return": "ExpiredEdgeListing" + }, + "GET /api/v2/telephony/providers/edges/extensions/{extensionId}": { + "operationId": "gettelephonyprovidersedgesextension", + "functionName": "getTelephonyProvidersEdgesExtension", + "signature": "getTelephonyProvidersEdgesExtension(extensionId)", + "parameters": [ + { + "name": "extensionId", + "type": "String", + "required": "true" + } + ], + "return": "Extension" + }, + "GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}": { + "operationId": "gettelephonyprovidersedgesextensionpool", + "functionName": "getTelephonyProvidersEdgesExtensionpool", + "signature": "getTelephonyProvidersEdgesExtensionpool(extensionPoolId)", + "parameters": [ + { + "name": "extensionPoolId", + "type": "String", + "required": "true" + } + ], + "return": "ExtensionPool" + }, + "GET /api/v2/telephony/providers/edges/extensionpools": { + "operationId": "gettelephonyprovidersedgesextensionpools", + "functionName": "getTelephonyProvidersEdgesExtensionpools", + "signature": "getTelephonyProvidersEdgesExtensionpools(pageSize, pageNumber, sortBy, number)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "number", + "type": "String", + "required": "false" + } + ], + "return": "ExtensionPoolEntityListing" + }, + "GET /api/v2/telephony/providers/edges/extensions": { + "operationId": "gettelephonyprovidersedgesextensions", + "functionName": "getTelephonyProvidersEdgesExtensions", + "signature": "getTelephonyProvidersEdgesExtensions(pageSize, pageNumber, sortBy, sortOrder, number)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "number", + "type": "String", + "required": "false" + } + ], + "return": "ExtensionEntityListing" + }, + "GET /api/v2/telephony/providers/edges/lines/{lineId}": { + "operationId": "gettelephonyprovidersedgesline", + "functionName": "getTelephonyProvidersEdgesLine", + "signature": "getTelephonyProvidersEdgesLine(lineId)", + "parameters": [ + { + "name": "lineId", + "type": "String", + "required": "true" + } + ], + "return": "Line" + }, + "GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}": { + "operationId": "gettelephonyprovidersedgeslinebasesetting", + "functionName": "getTelephonyProvidersEdgesLinebasesetting", + "signature": "getTelephonyProvidersEdgesLinebasesetting(lineBaseId)", + "parameters": [ + { + "name": "lineBaseId", + "type": "String", + "required": "true" + } + ], + "return": "LineBase" + }, + "GET /api/v2/telephony/providers/edges/linebasesettings": { + "operationId": "gettelephonyprovidersedgeslinebasesettings", + "functionName": "getTelephonyProvidersEdgesLinebasesettings", + "signature": "getTelephonyProvidersEdgesLinebasesettings(pageNumber, pageSize, sortBy, sortOrder, expand)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LineBaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/lines": { + "operationId": "gettelephonyprovidersedgeslines", + "functionName": "getTelephonyProvidersEdgesLines", + "signature": "getTelephonyProvidersEdgesLines(pageSize, pageNumber, name, sortBy, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LineEntityListing" + }, + "GET /api/v2/telephony/providers/edges/lines/template": { + "operationId": "gettelephonyprovidersedgeslinestemplate", + "functionName": "getTelephonyProvidersEdgesLinesTemplate", + "signature": "getTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId)", + "parameters": [ + { + "name": "lineBaseSettingsId", + "type": "String", + "required": "true" + } + ], + "return": "Line" + }, + "GET /api/v2/telephony/providers/edges/logicalinterfaces": { + "operationId": "gettelephonyprovidersedgeslogicalinterfaces", + "functionName": "getTelephonyProvidersEdgesLogicalinterfaces", + "signature": "getTelephonyProvidersEdgesLogicalinterfaces(edgeIds, expand)", + "parameters": [ + { + "name": "edgeIds", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LogicalInterfaceEntityListing" + }, + "GET /api/v2/telephony/providers/edges/metrics": { + "operationId": "gettelephonyprovidersedgesmetrics", + "functionName": "getTelephonyProvidersEdgesMetrics", + "signature": "getTelephonyProvidersEdgesMetrics(edgeIds)", + "parameters": [ + { + "name": "edgeIds", + "type": "String", + "required": "true" + } + ], + "return": "[EdgeMetrics]" + }, + "GET /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}": { + "operationId": "gettelephonyprovidersedgesoutboundroute", + "functionName": "getTelephonyProvidersEdgesOutboundroute", + "signature": "getTelephonyProvidersEdgesOutboundroute(outboundRouteId)", + "parameters": [ + { + "name": "outboundRouteId", + "type": "String", + "required": "true" + } + ], + "return": "OutboundRoute" + }, + "GET /api/v2/telephony/providers/edges/outboundroutes": { + "operationId": "gettelephonyprovidersedgesoutboundroutes", + "functionName": "getTelephonyProvidersEdgesOutboundroutes", + "signature": "getTelephonyProvidersEdgesOutboundroutes(pageSize, pageNumber, name, siteId, externalTrunkBasesIds, sortBy)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "siteId", + "type": "String", + "required": "false" + }, + { + "name": "externalTrunkBasesIds", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + } + ], + "return": "OutboundRouteEntityListing" + }, + "GET /api/v2/telephony/providers/edges/phones/{phoneId}": { + "operationId": "gettelephonyprovidersedgesphone", + "functionName": "getTelephonyProvidersEdgesPhone", + "signature": "getTelephonyProvidersEdgesPhone(phoneId)", + "parameters": [ + { + "name": "phoneId", + "type": "String", + "required": "true" + } + ], + "return": "Phone" + }, + "GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}": { + "operationId": "gettelephonyprovidersedgesphonebasesetting", + "functionName": "getTelephonyProvidersEdgesPhonebasesetting", + "signature": "getTelephonyProvidersEdgesPhonebasesetting(phoneBaseId)", + "parameters": [ + { + "name": "phoneBaseId", + "type": "String", + "required": "true" + } + ], + "return": "PhoneBase" + }, + "GET /api/v2/telephony/providers/edges/phonebasesettings": { + "operationId": "gettelephonyprovidersedgesphonebasesettings", + "functionName": "getTelephonyProvidersEdgesPhonebasesettings", + "signature": "getTelephonyProvidersEdgesPhonebasesettings(pageSize, pageNumber, sortBy, sortOrder, expand, name)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "PhoneBaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases": { + "operationId": "gettelephonyprovidersedgesphonebasesettingsavailablemetabases", + "functionName": "getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases", + "signature": "getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "PhoneMetaBaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/phonebasesettings/template": { + "operationId": "gettelephonyprovidersedgesphonebasesettingstemplate", + "functionName": "getTelephonyProvidersEdgesPhonebasesettingsTemplate", + "signature": "getTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId)", + "parameters": [ + { + "name": "phoneMetabaseId", + "type": "String", + "required": "true" + } + ], + "return": "PhoneBase" + }, + "GET /api/v2/telephony/providers/edges/phones": { + "operationId": "gettelephonyprovidersedgesphones", + "functionName": "getTelephonyProvidersEdgesPhones", + "signature": "getTelephonyProvidersEdgesPhones(pageNumber, pageSize, sortBy, sortOrder, siteId, webRtcUserId, phoneBaseSettingsId, linesLoggedInUserId, linesDefaultForUserId, phoneHardwareId, linesId, linesName, name, statusOperationalStatus, secondaryStatusOperationalStatus, expand, fields)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "siteId", + "type": "String", + "required": "false" + }, + { + "name": "webRtcUserId", + "type": "String", + "required": "false" + }, + { + "name": "phoneBaseSettingsId", + "type": "String", + "required": "false" + }, + { + "name": "linesLoggedInUserId", + "type": "String", + "required": "false" + }, + { + "name": "linesDefaultForUserId", + "type": "String", + "required": "false" + }, + { + "name": "phoneHardwareId", + "type": "String", + "required": "false" + }, + { + "name": "linesId", + "type": "String", + "required": "false" + }, + { + "name": "linesName", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "statusOperationalStatus", + "type": "String", + "required": "false" + }, + { + "name": "secondaryStatusOperationalStatus", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "fields", + "type": "[String]", + "required": "false" + } + ], + "return": "PhoneEntityListing" + }, + "GET /api/v2/telephony/providers/edges/phones/template": { + "operationId": "gettelephonyprovidersedgesphonestemplate", + "functionName": "getTelephonyProvidersEdgesPhonesTemplate", + "signature": "getTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId)", + "parameters": [ + { + "name": "phoneBaseSettingsId", + "type": "String", + "required": "true" + } + ], + "return": "Phone" + }, + "GET /api/v2/telephony/providers/edges/physicalinterfaces": { + "operationId": "gettelephonyprovidersedgesphysicalinterfaces", + "functionName": "getTelephonyProvidersEdgesPhysicalinterfaces", + "signature": "getTelephonyProvidersEdgesPhysicalinterfaces(edgeIds)", + "parameters": [ + { + "name": "edgeIds", + "type": "String", + "required": "true" + } + ], + "return": "PhysicalInterfaceEntityListing" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}": { + "operationId": "gettelephonyprovidersedgessite", + "functionName": "getTelephonyProvidersEdgesSite", + "signature": "getTelephonyProvidersEdgesSite(siteId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + } + ], + "return": "Site" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}": { + "operationId": "gettelephonyprovidersedgessitenumberplan", + "functionName": "getTelephonyProvidersEdgesSiteNumberplan", + "signature": "getTelephonyProvidersEdgesSiteNumberplan(siteId, numberPlanId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "numberPlanId", + "type": "String", + "required": "true" + } + ], + "return": "NumberPlan" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans": { + "operationId": "gettelephonyprovidersedgessitenumberplans", + "functionName": "getTelephonyProvidersEdgesSiteNumberplans", + "signature": "getTelephonyProvidersEdgesSiteNumberplans(siteId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + } + ], + "return": "[NumberPlan]" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications": { + "operationId": "gettelephonyprovidersedgessitenumberplansclassifications", + "functionName": "getTelephonyProvidersEdgesSiteNumberplansClassifications", + "signature": "getTelephonyProvidersEdgesSiteNumberplansClassifications(siteId, classification)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "classification", + "type": "String", + "required": "false" + } + ], + "return": "[String]" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}": { + "operationId": "gettelephonyprovidersedgessiteoutboundroute", + "functionName": "getTelephonyProvidersEdgesSiteOutboundroute", + "signature": "getTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "outboundRouteId", + "type": "String", + "required": "true" + } + ], + "return": "OutboundRouteBase" + }, + "GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes": { + "operationId": "gettelephonyprovidersedgessiteoutboundroutes", + "functionName": "getTelephonyProvidersEdgesSiteOutboundroutes", + "signature": "getTelephonyProvidersEdgesSiteOutboundroutes(siteId, pageSize, pageNumber, name, externalTrunkBasesIds, sortBy)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "externalTrunkBasesIds", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + } + ], + "return": "OutboundRouteBaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/sites": { + "operationId": "gettelephonyprovidersedgessites", + "functionName": "getTelephonyProvidersEdgesSites", + "signature": "getTelephonyProvidersEdgesSites(pageSize, pageNumber, sortBy, sortOrder, name, locationId, managed)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "locationId", + "type": "String", + "required": "false" + }, + { + "name": "managed", + "type": "Bool", + "required": "false" + } + ], + "return": "SiteEntityListing" + }, + "GET /api/v2/telephony/providers/edges/timezones": { + "operationId": "gettelephonyprovidersedgestimezones", + "functionName": "getTelephonyProvidersEdgesTimezones", + "signature": "getTelephonyProvidersEdgesTimezones(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TimeZoneEntityListing" + }, + "GET /api/v2/telephony/providers/edges/trunks/{trunkId}": { + "operationId": "gettelephonyprovidersedgestrunk", + "functionName": "getTelephonyProvidersEdgesTrunk", + "signature": "getTelephonyProvidersEdgesTrunk(trunkId)", + "parameters": [ + { + "name": "trunkId", + "type": "String", + "required": "true" + } + ], + "return": "Trunk" + }, + "GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics": { + "operationId": "gettelephonyprovidersedgestrunkmetrics", + "functionName": "getTelephonyProvidersEdgesTrunkMetrics", + "signature": "getTelephonyProvidersEdgesTrunkMetrics(trunkId)", + "parameters": [ + { + "name": "trunkId", + "type": "String", + "required": "true" + } + ], + "return": "TrunkMetrics" + }, + "GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}": { + "operationId": "gettelephonyprovidersedgestrunkbasesetting", + "functionName": "getTelephonyProvidersEdgesTrunkbasesetting", + "signature": "getTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId, ignoreHidden)", + "parameters": [ + { + "name": "trunkBaseSettingsId", + "type": "String", + "required": "true" + }, + { + "name": "ignoreHidden", + "type": "Bool", + "required": "false" + } + ], + "return": "TrunkBase" + }, + "GET /api/v2/telephony/providers/edges/trunkbasesettings": { + "operationId": "gettelephonyprovidersedgestrunkbasesettings", + "functionName": "getTelephonyProvidersEdgesTrunkbasesettings", + "signature": "getTelephonyProvidersEdgesTrunkbasesettings(pageNumber, pageSize, sortBy, sortOrder, recordingEnabled, ignoreHidden, managed, expand, name)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "recordingEnabled", + "type": "Bool", + "required": "false" + }, + { + "name": "ignoreHidden", + "type": "Bool", + "required": "false" + }, + { + "name": "managed", + "type": "Bool", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "TrunkBaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases": { + "operationId": "gettelephonyprovidersedgestrunkbasesettingsavailablemetabases", + "functionName": "getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases", + "signature": "getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(type, pageSize, pageNumber)", + "parameters": [ + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrunkMetabaseEntityListing" + }, + "GET /api/v2/telephony/providers/edges/trunkbasesettings/template": { + "operationId": "gettelephonyprovidersedgestrunkbasesettingstemplate", + "functionName": "getTelephonyProvidersEdgesTrunkbasesettingsTemplate", + "signature": "getTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId)", + "parameters": [ + { + "name": "trunkMetabaseId", + "type": "String", + "required": "true" + } + ], + "return": "TrunkBase" + }, + "GET /api/v2/telephony/providers/edges/trunks": { + "operationId": "gettelephonyprovidersedgestrunks", + "functionName": "getTelephonyProvidersEdgesTrunks", + "signature": "getTelephonyProvidersEdgesTrunks(pageNumber, pageSize, sortBy, sortOrder, edgeId, trunkBaseId, trunkType)", + "parameters": [ + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "edgeId", + "type": "String", + "required": "false" + }, + { + "name": "trunkBaseId", + "type": "String", + "required": "false" + }, + { + "name": "trunkType", + "type": "String", + "required": "false" + } + ], + "return": "TrunkEntityListing" + }, + "GET /api/v2/telephony/providers/edges/trunks/metrics": { + "operationId": "gettelephonyprovidersedgestrunksmetrics", + "functionName": "getTelephonyProvidersEdgesTrunksMetrics", + "signature": "getTelephonyProvidersEdgesTrunksMetrics(trunkIds)", + "parameters": [ + { + "name": "trunkIds", + "type": "String", + "required": "true" + } + ], + "return": "[TrunkMetrics]" + }, + "GET /api/v2/telephony/providers/edges/trunkswithrecording": { + "operationId": "gettelephonyprovidersedgestrunkswithrecording", + "functionName": "getTelephonyProvidersEdgesTrunkswithrecording", + "signature": "getTelephonyProvidersEdgesTrunkswithrecording(trunkType)", + "parameters": [ + { + "name": "trunkType", + "type": "String", + "required": "false" + } + ], + "return": "TrunkRecordingEnabledCount" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup": { + "operationId": "posttelephonyprovidersedgediagnosticnslookup", + "functionName": "postTelephonyProvidersEdgeDiagnosticNslookup", + "signature": "postTelephonyProvidersEdgeDiagnosticNslookup(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeNetworkDiagnosticRequest", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnostic" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping": { + "operationId": "posttelephonyprovidersedgediagnosticping", + "functionName": "postTelephonyProvidersEdgeDiagnosticPing", + "signature": "postTelephonyProvidersEdgeDiagnosticPing(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeNetworkDiagnosticRequest", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnostic" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route": { + "operationId": "posttelephonyprovidersedgediagnosticroute", + "functionName": "postTelephonyProvidersEdgeDiagnosticRoute", + "signature": "postTelephonyProvidersEdgeDiagnosticRoute(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeNetworkDiagnosticRequest", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnostic" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath": { + "operationId": "posttelephonyprovidersedgediagnostictracepath", + "functionName": "postTelephonyProvidersEdgeDiagnosticTracepath", + "signature": "postTelephonyProvidersEdgeDiagnosticTracepath(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeNetworkDiagnosticRequest", + "required": "true" + } + ], + "return": "EdgeNetworkDiagnostic" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces": { + "operationId": "posttelephonyprovidersedgelogicalinterfaces", + "functionName": "postTelephonyProvidersEdgeLogicalinterfaces", + "signature": "postTelephonyProvidersEdgeLogicalinterfaces(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainLogicalInterface", + "required": "true" + } + ], + "return": "DomainLogicalInterface" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload": { + "operationId": "posttelephonyprovidersedgelogsjobupload", + "functionName": "postTelephonyProvidersEdgeLogsJobUpload", + "signature": "postTelephonyProvidersEdgeLogsJobUpload(edgeId, jobId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeLogsJobUploadRequest", + "required": "true" + } + ] + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs": { + "operationId": "posttelephonyprovidersedgelogsjobs", + "functionName": "postTelephonyProvidersEdgeLogsJobs", + "signature": "postTelephonyProvidersEdgeLogsJobs(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeLogsJobRequest", + "required": "true" + } + ], + "return": "EdgeLogsJobResponse" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/reboot": { + "operationId": "posttelephonyprovidersedgereboot", + "functionName": "postTelephonyProvidersEdgeReboot", + "signature": "postTelephonyProvidersEdgeReboot(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeRebootParameters", + "required": "false" + } + ], + "return": "String" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate": { + "operationId": "posttelephonyprovidersedgesoftwareupdate", + "functionName": "postTelephonyProvidersEdgeSoftwareupdate", + "signature": "postTelephonyProvidersEdgeSoftwareupdate(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainEdgeSoftwareUpdateDto", + "required": "true" + } + ], + "return": "DomainEdgeSoftwareUpdateDto" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/statuscode": { + "operationId": "posttelephonyprovidersedgestatuscode", + "functionName": "postTelephonyProvidersEdgeStatuscode", + "signature": "postTelephonyProvidersEdgeStatuscode(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeServiceStateRequest", + "required": "false" + } + ], + "return": "String" + }, + "POST /api/v2/telephony/providers/edges/{edgeId}/unpair": { + "operationId": "posttelephonyprovidersedgeunpair", + "functionName": "postTelephonyProvidersEdgeUnpair", + "signature": "postTelephonyProvidersEdgeUnpair(edgeId)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "POST /api/v2/telephony/providers/edges": { + "operationId": "posttelephonyprovidersedges", + "functionName": "postTelephonyProvidersEdges", + "signature": "postTelephonyProvidersEdges(body)", + "parameters": [ + { + "name": "body", + "type": "Edge", + "required": "true" + } + ], + "return": "Edge" + }, + "POST /api/v2/telephony/providers/edges/addressvalidation": { + "operationId": "posttelephonyprovidersedgesaddressvalidation", + "functionName": "postTelephonyProvidersEdgesAddressvalidation", + "signature": "postTelephonyProvidersEdgesAddressvalidation(body)", + "parameters": [ + { + "name": "body", + "type": "ValidateAddressRequest", + "required": "true" + } + ], + "return": "ValidateAddressResponse" + }, + "POST /api/v2/telephony/providers/edges/certificateauthorities": { + "operationId": "posttelephonyprovidersedgescertificateauthorities", + "functionName": "postTelephonyProvidersEdgesCertificateauthorities", + "signature": "postTelephonyProvidersEdgesCertificateauthorities(body)", + "parameters": [ + { + "name": "body", + "type": "DomainCertificateAuthority", + "required": "true" + } + ], + "return": "DomainCertificateAuthority" + }, + "POST /api/v2/telephony/providers/edges/didpools": { + "operationId": "posttelephonyprovidersedgesdidpools", + "functionName": "postTelephonyProvidersEdgesDidpools", + "signature": "postTelephonyProvidersEdgesDidpools(body)", + "parameters": [ + { + "name": "body", + "type": "DIDPool", + "required": "true" + } + ], + "return": "DIDPool" + }, + "POST /api/v2/telephony/providers/edges/edgegroups": { + "operationId": "posttelephonyprovidersedgesedgegroups", + "functionName": "postTelephonyProvidersEdgesEdgegroups", + "signature": "postTelephonyProvidersEdgesEdgegroups(body)", + "parameters": [ + { + "name": "body", + "type": "EdgeGroup", + "required": "true" + } + ], + "return": "EdgeGroup" + }, + "POST /api/v2/telephony/providers/edges/extensionpools": { + "operationId": "posttelephonyprovidersedgesextensionpools", + "functionName": "postTelephonyProvidersEdgesExtensionpools", + "signature": "postTelephonyProvidersEdgesExtensionpools(body)", + "parameters": [ + { + "name": "body", + "type": "ExtensionPool", + "required": "true" + } + ], + "return": "ExtensionPool" + }, + "POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot": { + "operationId": "posttelephonyprovidersedgesphonereboot", + "functionName": "postTelephonyProvidersEdgesPhoneReboot", + "signature": "postTelephonyProvidersEdgesPhoneReboot(phoneId)", + "parameters": [ + { + "name": "phoneId", + "type": "String", + "required": "true" + } + ] + }, + "POST /api/v2/telephony/providers/edges/phonebasesettings": { + "operationId": "posttelephonyprovidersedgesphonebasesettings", + "functionName": "postTelephonyProvidersEdgesPhonebasesettings", + "signature": "postTelephonyProvidersEdgesPhonebasesettings(body)", + "parameters": [ + { + "name": "body", + "type": "PhoneBase", + "required": "true" + } + ], + "return": "PhoneBase" + }, + "POST /api/v2/telephony/providers/edges/phones": { + "operationId": "posttelephonyprovidersedgesphones", + "functionName": "postTelephonyProvidersEdgesPhones", + "signature": "postTelephonyProvidersEdgesPhones(body)", + "parameters": [ + { + "name": "body", + "type": "Phone", + "required": "true" + } + ], + "return": "Phone" + }, + "POST /api/v2/telephony/providers/edges/phones/reboot": { + "operationId": "posttelephonyprovidersedgesphonesreboot", + "functionName": "postTelephonyProvidersEdgesPhonesReboot", + "signature": "postTelephonyProvidersEdgesPhonesReboot(body)", + "parameters": [ + { + "name": "body", + "type": "PhonesReboot", + "required": "true" + } + ] + }, + "POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes": { + "operationId": "posttelephonyprovidersedgessiteoutboundroutes", + "functionName": "postTelephonyProvidersEdgesSiteOutboundroutes", + "signature": "postTelephonyProvidersEdgesSiteOutboundroutes(siteId, body)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OutboundRouteBase", + "required": "true" + } + ], + "return": "OutboundRouteBase" + }, + "POST /api/v2/telephony/providers/edges/sites": { + "operationId": "posttelephonyprovidersedgessites", + "functionName": "postTelephonyProvidersEdgesSites", + "signature": "postTelephonyProvidersEdgesSites(body)", + "parameters": [ + { + "name": "body", + "type": "Site", + "required": "true" + } + ], + "return": "Site" + }, + "POST /api/v2/telephony/providers/edges/trunkbasesettings": { + "operationId": "posttelephonyprovidersedgestrunkbasesettings", + "functionName": "postTelephonyProvidersEdgesTrunkbasesettings", + "signature": "postTelephonyProvidersEdgesTrunkbasesettings(body)", + "parameters": [ + { + "name": "body", + "type": "TrunkBase", + "required": "true" + } + ], + "return": "TrunkBase" + }, + "PUT /api/v2/telephony/providers/edges/{edgeId}": { + "operationId": "puttelephonyprovidersedge", + "functionName": "putTelephonyProvidersEdge", + "signature": "putTelephonyProvidersEdge(edgeId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Edge", + "required": "true" + } + ], + "return": "Edge" + }, + "PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}": { + "operationId": "puttelephonyprovidersedgelogicalinterface", + "functionName": "putTelephonyProvidersEdgeLogicalinterface", + "signature": "putTelephonyProvidersEdgeLogicalinterface(edgeId, interfaceId, body)", + "parameters": [ + { + "name": "edgeId", + "type": "String", + "required": "true" + }, + { + "name": "interfaceId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainLogicalInterface", + "required": "true" + } + ], + "return": "DomainLogicalInterface" + }, + "PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}": { + "operationId": "puttelephonyprovidersedgescertificateauthority", + "functionName": "putTelephonyProvidersEdgesCertificateauthority", + "signature": "putTelephonyProvidersEdgesCertificateauthority(certificateId, body)", + "parameters": [ + { + "name": "certificateId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DomainCertificateAuthority", + "required": "true" + } + ], + "return": "DomainCertificateAuthority" + }, + "PUT /api/v2/telephony/providers/edges/didpools/{didPoolId}": { + "operationId": "puttelephonyprovidersedgesdidpool", + "functionName": "putTelephonyProvidersEdgesDidpool", + "signature": "putTelephonyProvidersEdgesDidpool(didPoolId, body)", + "parameters": [ + { + "name": "didPoolId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "DIDPool", + "required": "true" + } + ], + "return": "DIDPool" + }, + "PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}": { + "operationId": "puttelephonyprovidersedgesedgegroup", + "functionName": "putTelephonyProvidersEdgesEdgegroup", + "signature": "putTelephonyProvidersEdgesEdgegroup(edgeGroupId, body)", + "parameters": [ + { + "name": "edgeGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeGroup", + "required": "true" + } + ], + "return": "EdgeGroup" + }, + "PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}": { + "operationId": "puttelephonyprovidersedgesedgegroupedgetrunkbase", + "functionName": "putTelephonyProvidersEdgesEdgegroupEdgetrunkbase", + "signature": "putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId, edgetrunkbaseId, body)", + "parameters": [ + { + "name": "edgegroupId", + "type": "String", + "required": "true" + }, + { + "name": "edgetrunkbaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EdgeTrunkBase", + "required": "true" + } + ], + "return": "EdgeTrunkBase" + }, + "PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}": { + "operationId": "puttelephonyprovidersedgesextensionpool", + "functionName": "putTelephonyProvidersEdgesExtensionpool", + "signature": "putTelephonyProvidersEdgesExtensionpool(extensionPoolId, body)", + "parameters": [ + { + "name": "extensionPoolId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ExtensionPool", + "required": "true" + } + ], + "return": "ExtensionPool" + }, + "PUT /api/v2/telephony/providers/edges/phones/{phoneId}": { + "operationId": "puttelephonyprovidersedgesphone", + "functionName": "putTelephonyProvidersEdgesPhone", + "signature": "putTelephonyProvidersEdgesPhone(phoneId, body)", + "parameters": [ + { + "name": "phoneId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Phone", + "required": "true" + } + ], + "return": "Phone" + }, + "PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}": { + "operationId": "puttelephonyprovidersedgesphonebasesetting", + "functionName": "putTelephonyProvidersEdgesPhonebasesetting", + "signature": "putTelephonyProvidersEdgesPhonebasesetting(phoneBaseId, body)", + "parameters": [ + { + "name": "phoneBaseId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PhoneBase", + "required": "true" + } + ], + "return": "PhoneBase" + }, + "PUT /api/v2/telephony/providers/edges/sites/{siteId}": { + "operationId": "puttelephonyprovidersedgessite", + "functionName": "putTelephonyProvidersEdgesSite", + "signature": "putTelephonyProvidersEdgesSite(siteId, body)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Site", + "required": "true" + } + ], + "return": "Site" + }, + "PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans": { + "operationId": "puttelephonyprovidersedgessitenumberplans", + "functionName": "putTelephonyProvidersEdgesSiteNumberplans", + "signature": "putTelephonyProvidersEdgesSiteNumberplans(siteId, body)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[NumberPlan]", + "required": "true" + } + ], + "return": "[NumberPlan]" + }, + "PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}": { + "operationId": "puttelephonyprovidersedgessiteoutboundroute", + "functionName": "putTelephonyProvidersEdgesSiteOutboundroute", + "signature": "putTelephonyProvidersEdgesSiteOutboundroute(siteId, outboundRouteId, body)", + "parameters": [ + { + "name": "siteId", + "type": "String", + "required": "true" + }, + { + "name": "outboundRouteId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OutboundRouteBase", + "required": "true" + } + ], + "return": "OutboundRouteBase" + }, + "PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}": { + "operationId": "puttelephonyprovidersedgestrunkbasesetting", + "functionName": "putTelephonyProvidersEdgesTrunkbasesetting", + "signature": "putTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId, body)", + "parameters": [ + { + "name": "trunkBaseSettingsId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TrunkBase", + "required": "true" + } + ], + "return": "TrunkBase" + } + +} \ No newline at end of file diff --git a/build/docs/TextbotsAPI.json b/build/docs/TextbotsAPI.json new file mode 100644 index 000000000..5bae502e4 --- /dev/null +++ b/build/docs/TextbotsAPI.json @@ -0,0 +1,75 @@ +{ + "GET /api/v2/textbots/bots/search": { + "operationId": "gettextbotsbotssearch", + "functionName": "getTextbotsBotsSearch", + "signature": "getTextbotsBotsSearch(botType, botName, botId, pageSize)", + "parameters": [ + { + "name": "botType", + "type": "[String]", + "required": "false" + }, + { + "name": "botName", + "type": "String", + "required": "false" + }, + { + "name": "botId", + "type": "[String]", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "BotSearchResponseEntityListing" + }, + "POST /api/v2/textbots/botflows/sessions/{sessionId}/turns": { + "operationId": "posttextbotsbotflowssessionturns", + "functionName": "postTextbotsBotflowsSessionTurns", + "signature": "postTextbotsBotflowsSessionTurns(sessionId, turnRequest)", + "parameters": [ + { + "name": "sessionId", + "type": "String", + "required": "true" + }, + { + "name": "turnRequest", + "type": "TextBotFlowTurnRequest", + "required": "true" + } + ], + "return": "TextBotFlowTurnResponse" + }, + "POST /api/v2/textbots/botflows/sessions": { + "operationId": "posttextbotsbotflowssessions", + "functionName": "postTextbotsBotflowsSessions", + "signature": "postTextbotsBotflowsSessions(launchRequest)", + "parameters": [ + { + "name": "launchRequest", + "type": "TextBotFlowLaunchRequest", + "required": "true" + } + ], + "return": "TextBotFlowLaunchResponse" + }, + "POST /api/v2/textbots/bots/execute": { + "operationId": "posttextbotsbotsexecute", + "functionName": "postTextbotsBotsExecute", + "signature": "postTextbotsBotsExecute(postTextRequest)", + "parameters": [ + { + "name": "postTextRequest", + "type": "PostTextRequest", + "required": "true" + } + ], + "return": "PostTextResponse" + } + +} \ No newline at end of file diff --git a/build/docs/TokensAPI.json b/build/docs/TokensAPI.json new file mode 100644 index 000000000..57ca352be --- /dev/null +++ b/build/docs/TokensAPI.json @@ -0,0 +1,40 @@ +{ + "DELETE /api/v2/tokens/{userId}": { + "operationId": "deletetoken", + "functionName": "deleteToken", + "signature": "deleteToken(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/tokens/me": { + "operationId": "deletetokensme", + "functionName": "deleteTokensMe", + "signature": "deleteTokensMe()" + + }, + "GET /api/v2/tokens/me": { + "operationId": "gettokensme", + "functionName": "getTokensMe", + "signature": "getTokensMe(preserveIdleTTL)", + "parameters": [ + { + "name": "preserveIdleTTL", + "type": "Bool", + "required": "false" + } + ], + "return": "TokenInfo" + }, + "HEAD /api/v2/tokens/me": { + "operationId": "headtokensme", + "functionName": "headTokensMe", + "signature": "headTokensMe()" + + } + +} \ No newline at end of file diff --git a/build/docs/UploadsAPI.json b/build/docs/UploadsAPI.json new file mode 100644 index 000000000..f33d43d05 --- /dev/null +++ b/build/docs/UploadsAPI.json @@ -0,0 +1,86 @@ +{ + "POST /api/v2/knowledge/documentuploads": { + "operationId": "postknowledgedocumentuploads", + "functionName": "postKnowledgeDocumentuploads", + "signature": "postKnowledgeDocumentuploads(body)", + "parameters": [ + { + "name": "body", + "type": "UploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/languageunderstanding/miners/{minerId}/uploads": { + "operationId": "postlanguageunderstandingmineruploads", + "functionName": "postLanguageunderstandingMinerUploads", + "signature": "postLanguageunderstandingMinerUploads(minerId, body)", + "parameters": [ + { + "name": "minerId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "JSON", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/uploads/learning/coverart": { + "operationId": "postuploadslearningcoverart", + "functionName": "postUploadsLearningCoverart", + "signature": "postUploadsLearningCoverart(body)", + "parameters": [ + { + "name": "body", + "type": "LearningCoverArtUploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/uploads/publicassets/images": { + "operationId": "postuploadspublicassetsimages", + "functionName": "postUploadsPublicassetsImages", + "signature": "postUploadsPublicassetsImages(body)", + "parameters": [ + { + "name": "body", + "type": "UploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/uploads/recordings": { + "operationId": "postuploadsrecordings", + "functionName": "postUploadsRecordings", + "signature": "postUploadsRecordings(body)", + "parameters": [ + { + "name": "body", + "type": "UploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + }, + "POST /api/v2/uploads/workforcemanagement/historicaldata/csv": { + "operationId": "postuploadsworkforcemanagementhistoricaldatacsv", + "functionName": "postUploadsWorkforcemanagementHistoricaldataCsv", + "signature": "postUploadsWorkforcemanagementHistoricaldataCsv(body)", + "parameters": [ + { + "name": "body", + "type": "UploadUrlRequest", + "required": "true" + } + ], + "return": "UploadUrlResponse" + } + +} \ No newline at end of file diff --git a/build/docs/UsageAPI.json b/build/docs/UsageAPI.json new file mode 100644 index 000000000..6a91d5574 --- /dev/null +++ b/build/docs/UsageAPI.json @@ -0,0 +1,109 @@ +{ + "GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}": { + "operationId": "getoauthclientusagequeryresult", + "functionName": "getOauthClientUsageQueryResult", + "signature": "getOauthClientUsageQueryResult(executionId, clientId)", + "parameters": [ + { + "name": "executionId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "ApiUsageQueryResult" + }, + "GET /api/v2/oauth/clients/{clientId}/usage/summary": { + "operationId": "getoauthclientusagesummary", + "functionName": "getOauthClientUsageSummary", + "signature": "getOauthClientUsageSummary(clientId, days)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "days", + "type": "String", + "required": "false" + } + ], + "return": "UsageExecutionResult" + }, + "GET /api/v2/usage/query/{executionId}/results": { + "operationId": "getusagequeryexecutionidresults", + "functionName": "getUsageQueryExecutionIdResults", + "signature": "getUsageQueryExecutionIdResults(executionId)", + "parameters": [ + { + "name": "executionId", + "type": "String", + "required": "true" + } + ], + "return": "ApiUsageQueryResult" + }, + "GET /api/v2/usage/simplesearch/{executionId}/results": { + "operationId": "getusagesimplesearchexecutionidresults", + "functionName": "getUsageSimplesearchExecutionIdResults", + "signature": "getUsageSimplesearchExecutionIdResults(executionId)", + "parameters": [ + { + "name": "executionId", + "type": "String", + "required": "true" + } + ], + "return": "ApiUsageQueryResult" + }, + "POST /api/v2/oauth/clients/{clientId}/usage/query": { + "operationId": "postoauthclientusagequery", + "functionName": "postOauthClientUsageQuery", + "signature": "postOauthClientUsageQuery(clientId, body)", + "parameters": [ + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ApiUsageClientQuery", + "required": "true" + } + ], + "return": "UsageExecutionResult" + }, + "POST /api/v2/usage/query": { + "operationId": "postusagequery", + "functionName": "postUsageQuery", + "signature": "postUsageQuery(body)", + "parameters": [ + { + "name": "body", + "type": "ApiUsageOrganizationQuery", + "required": "true" + } + ], + "return": "UsageExecutionResult" + }, + "POST /api/v2/usage/simplesearch": { + "operationId": "postusagesimplesearch", + "functionName": "postUsageSimplesearch", + "signature": "postUsageSimplesearch(body)", + "parameters": [ + { + "name": "body", + "type": "ApiUsageSimpleSearch", + "required": "true" + } + ], + "return": "UsageExecutionResult" + } + +} \ No newline at end of file diff --git a/build/docs/UserRecordingsAPI.json b/build/docs/UserRecordingsAPI.json new file mode 100644 index 000000000..2d000de80 --- /dev/null +++ b/build/docs/UserRecordingsAPI.json @@ -0,0 +1,109 @@ +{ + "DELETE /api/v2/userrecordings/{recordingId}": { + "operationId": "deleteuserrecording", + "functionName": "deleteUserrecording", + "signature": "deleteUserrecording(recordingId)", + "parameters": [ + { + "name": "recordingId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/userrecordings/{recordingId}": { + "operationId": "getuserrecording", + "functionName": "getUserrecording", + "signature": "getUserrecording(recordingId, expand)", + "parameters": [ + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UserRecording" + }, + "GET /api/v2/userrecordings/{recordingId}/media": { + "operationId": "getuserrecordingmedia", + "functionName": "getUserrecordingMedia", + "signature": "getUserrecordingMedia(recordingId, formatId, async)", + "parameters": [ + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + }, + { + "name": "async", + "type": "Bool", + "required": "false" + } + ], + "return": "DownloadResponse" + }, + "GET /api/v2/userrecordings": { + "operationId": "getuserrecordings", + "functionName": "getUserrecordings", + "signature": "getUserrecordings(pageSize, pageNumber, expand)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UserRecordingEntityListing" + }, + "GET /api/v2/userrecordings/summary": { + "operationId": "getuserrecordingssummary", + "functionName": "getUserrecordingsSummary", + "signature": "getUserrecordingsSummary()", + + "return": "FaxSummary" + }, + "PUT /api/v2/userrecordings/{recordingId}": { + "operationId": "putuserrecording", + "functionName": "putUserrecording", + "signature": "putUserrecording(recordingId, body, expand)", + "parameters": [ + { + "name": "recordingId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRecording", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UserRecording" + } + +} \ No newline at end of file diff --git a/build/docs/UsersAPI.json b/build/docs/UsersAPI.json new file mode 100644 index 000000000..a06838bd1 --- /dev/null +++ b/build/docs/UsersAPI.json @@ -0,0 +1,1616 @@ +{ + "DELETE /api/v2/analytics/users/details/jobs/{jobId}": { + "operationId": "deleteanalyticsusersdetailsjob", + "functionName": "deleteAnalyticsUsersDetailsJob", + "signature": "deleteAnalyticsUsersDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}": { + "operationId": "deleteauthorizationsubjectdivisionrole", + "functionName": "deleteAuthorizationSubjectDivisionRole", + "signature": "deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "roleId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/routing/users/{userId}/utilization": { + "operationId": "deleteroutinguserutilization", + "functionName": "deleteRoutingUserUtilization", + "signature": "deleteRoutingUserUtilization(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}": { + "operationId": "deleteuser", + "functionName": "deleteUser", + "signature": "deleteUser(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/users/{userId}/routinglanguages/{languageId}": { + "operationId": "deleteuserroutinglanguage", + "functionName": "deleteUserRoutinglanguage", + "signature": "deleteUserRoutinglanguage(userId, languageId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "languageId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}/routingskills/{skillId}": { + "operationId": "deleteuserroutingskill", + "functionName": "deleteUserRoutingskill", + "signature": "deleteUserRoutingskill(userId, skillId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "skillId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}/station/associatedstation": { + "operationId": "deleteuserstationassociatedstation", + "functionName": "deleteUserStationAssociatedstation", + "signature": "deleteUserStationAssociatedstation(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/users/{userId}/station/defaultstation": { + "operationId": "deleteuserstationdefaultstation", + "functionName": "deleteUserStationDefaultstation", + "signature": "deleteUserStationDefaultstation(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/analytics/users/details/jobs/{jobId}": { + "operationId": "getanalyticsusersdetailsjob", + "functionName": "getAnalyticsUsersDetailsJob", + "signature": "getAnalyticsUsersDetailsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AsyncQueryStatus" + }, + "GET /api/v2/analytics/users/details/jobs/{jobId}/results": { + "operationId": "getanalyticsusersdetailsjobresults", + "functionName": "getAnalyticsUsersDetailsJobResults", + "signature": "getAnalyticsUsersDetailsJobResults(jobId, cursor, pageSize)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "AnalyticsUserDetailsAsyncQueryResponse" + }, + "GET /api/v2/analytics/users/details/jobs/availability": { + "operationId": "getanalyticsusersdetailsjobsavailability", + "functionName": "getAnalyticsUsersDetailsJobsAvailability", + "signature": "getAnalyticsUsersDetailsJobsAvailability()", + + "return": "DataAvailabilityResponse" + }, + "GET /api/v2/authorization/divisionspermitted/me": { + "operationId": "getauthorizationdivisionspermittedme", + "functionName": "getAuthorizationDivisionspermittedMe", + "signature": "getAuthorizationDivisionspermittedMe(permission, name)", + "parameters": [ + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "[AuthzDivision]" + }, + "GET /api/v2/authorization/divisionspermitted/paged/me": { + "operationId": "getauthorizationdivisionspermittedpagedme", + "functionName": "getAuthorizationDivisionspermittedPagedMe", + "signature": "getAuthorizationDivisionspermittedPagedMe(permission, pageNumber, pageSize)", + "parameters": [ + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DivsPermittedEntityListing" + }, + "GET /api/v2/authorization/divisionspermitted/paged/{subjectId}": { + "operationId": "getauthorizationdivisionspermittedpagedsubjectid", + "functionName": "getAuthorizationDivisionspermittedPagedSubjectId", + "signature": "getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, pageNumber, pageSize)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "permission", + "type": "String", + "required": "true" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + } + ], + "return": "DivsPermittedEntityListing" + }, + "GET /api/v2/authorization/subjects/{subjectId}": { + "operationId": "getauthorizationsubject", + "functionName": "getAuthorizationSubject", + "signature": "getAuthorizationSubject(subjectId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + } + ], + "return": "AuthzSubject" + }, + "GET /api/v2/authorization/subjects/me": { + "operationId": "getauthorizationsubjectsme", + "functionName": "getAuthorizationSubjectsMe", + "signature": "getAuthorizationSubjectsMe()", + + "return": "AuthzSubject" + }, + "GET /api/v2/fieldconfig": { + "operationId": "getfieldconfig", + "functionName": "getFieldconfig", + "signature": "getFieldconfig(type)", + "parameters": [ + { + "name": "type", + "type": "String", + "required": "true" + } + ], + "return": "FieldConfig" + }, + "GET /api/v2/profiles/users": { + "operationId": "getprofilesusers", + "functionName": "getProfilesUsers", + "signature": "getProfilesUsers(pageSize, pageNumber, _id, jid, sortOrder, expand, integrationPresenceSource)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "jid", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + } + ], + "return": "UserProfileEntityListing" + }, + "GET /api/v2/routing/users/{userId}/utilization": { + "operationId": "getroutinguserutilization", + "functionName": "getRoutingUserUtilization", + "signature": "getRoutingUserUtilization(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "AgentMaxUtilization" + }, + "GET /api/v2/users/{userId}": { + "operationId": "getuser", + "functionName": "getUser", + "signature": "getUser(userId, expand, integrationPresenceSource, state)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + } + ], + "return": "User" + }, + "GET /api/v2/users/{userId}/adjacents": { + "operationId": "getuseradjacents", + "functionName": "getUserAdjacents", + "signature": "getUserAdjacents(userId, expand)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "Adjacents" + }, + "GET /api/v2/users/{userId}/callforwarding": { + "operationId": "getusercallforwarding", + "functionName": "getUserCallforwarding", + "signature": "getUserCallforwarding(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "CallForwarding" + }, + "GET /api/v2/users/{userId}/directreports": { + "operationId": "getuserdirectreports", + "functionName": "getUserDirectreports", + "signature": "getUserDirectreports(userId, expand)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "[User]" + }, + "GET /api/v2/users/{userId}/favorites": { + "operationId": "getuserfavorites", + "functionName": "getUserFavorites", + "signature": "getUserFavorites(userId, pageSize, pageNumber, sortOrder, expand)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "UserEntityListing" + }, + "GET /api/v2/users/{userId}/geolocations/{clientId}": { + "operationId": "getusergeolocation", + "functionName": "getUserGeolocation", + "signature": "getUserGeolocation(userId, clientId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + } + ], + "return": "Geolocation" + }, + "GET /api/v2/users/{userId}/outofoffice": { + "operationId": "getuseroutofoffice", + "functionName": "getUserOutofoffice", + "signature": "getUserOutofoffice(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "OutOfOffice" + }, + "GET /api/v2/users/{userId}/profile": { + "operationId": "getuserprofile", + "functionName": "getUserProfile", + "signature": "getUserProfile(userId, expand, integrationPresenceSource)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + } + ], + "return": "UserProfile" + }, + "GET /api/v2/users/{userId}/profileskills": { + "operationId": "getuserprofileskills", + "functionName": "getUserProfileskills", + "signature": "getUserProfileskills(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "[String]" + }, + "GET /api/v2/users/{userId}/queues": { + "operationId": "getuserqueues", + "functionName": "getUserQueues", + "signature": "getUserQueues(userId, pageSize, pageNumber, joined, divisionId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "joined", + "type": "Bool", + "required": "false" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "UserQueueEntityListing" + }, + "GET /api/v2/users/{subjectId}/roles": { + "operationId": "getuserroles", + "functionName": "getUserRoles", + "signature": "getUserRoles(subjectId)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "GET /api/v2/users/{userId}/routinglanguages": { + "operationId": "getuserroutinglanguages", + "functionName": "getUserRoutinglanguages", + "signature": "getUserRoutinglanguages(userId, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "UserLanguageEntityListing" + }, + "GET /api/v2/users/{userId}/routingskills": { + "operationId": "getuserroutingskills", + "functionName": "getUserRoutingskills", + "signature": "getUserRoutingskills(userId, pageSize, pageNumber, sortOrder)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + } + ], + "return": "UserSkillEntityListing" + }, + "GET /api/v2/users/{userId}/routingstatus": { + "operationId": "getuserroutingstatus", + "functionName": "getUserRoutingstatus", + "signature": "getUserRoutingstatus(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "RoutingStatus" + }, + "GET /api/v2/users/{userId}/skillgroups": { + "operationId": "getuserskillgroups", + "functionName": "getUserSkillgroups", + "signature": "getUserSkillgroups(userId, pageSize, after, before)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + } + ], + "return": "UserSkillGroupEntityListing" + }, + "GET /api/v2/users/{userId}/state": { + "operationId": "getuserstate", + "functionName": "getUserState", + "signature": "getUserState(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "UserState" + }, + "GET /api/v2/users/{userId}/station": { + "operationId": "getuserstation", + "functionName": "getUserStation", + "signature": "getUserStation(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "UserStations" + }, + "GET /api/v2/users/{userId}/superiors": { + "operationId": "getusersuperiors", + "functionName": "getUserSuperiors", + "signature": "getUserSuperiors(userId, expand)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "[User]" + }, + "GET /api/v2/users/{userId}/trustors": { + "operationId": "getusertrustors", + "functionName": "getUserTrustors", + "signature": "getUserTrustors(userId, pageSize, pageNumber)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TrustorEntityListing" + }, + "GET /api/v2/users": { + "operationId": "getusers", + "functionName": "getUsers", + "signature": "getUsers(pageSize, pageNumber, _id, jabberId, sortOrder, expand, integrationPresenceSource, state)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "_id", + "type": "[String]", + "required": "false" + }, + { + "name": "jabberId", + "type": "[String]", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + }, + { + "name": "state", + "type": "String", + "required": "false" + } + ], + "return": "UserEntityListing" + }, + "GET /api/v2/users/development/activities": { + "operationId": "getusersdevelopmentactivities", + "functionName": "getUsersDevelopmentActivities", + "signature": "getUsersDevelopmentActivities(userId, moduleId, interval, completionInterval, overdue, pass, pageSize, pageNumber, sortOrder, types, statuses, relationship)", + "parameters": [ + { + "name": "userId", + "type": "[String]", + "required": "false" + }, + { + "name": "moduleId", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "pass", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "types", + "type": "[String]", + "required": "false" + }, + { + "name": "statuses", + "type": "[String]", + "required": "false" + }, + { + "name": "relationship", + "type": "[String]", + "required": "false" + } + ], + "return": "DevelopmentActivityListing" + }, + "GET /api/v2/users/development/activities/me": { + "operationId": "getusersdevelopmentactivitiesme", + "functionName": "getUsersDevelopmentActivitiesMe", + "signature": "getUsersDevelopmentActivitiesMe(moduleId, interval, completionInterval, overdue, pass, pageSize, pageNumber, sortOrder, types, statuses, relationship)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "false" + }, + { + "name": "interval", + "type": "String", + "required": "false" + }, + { + "name": "completionInterval", + "type": "String", + "required": "false" + }, + { + "name": "overdue", + "type": "String", + "required": "false" + }, + { + "name": "pass", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "types", + "type": "[String]", + "required": "false" + }, + { + "name": "statuses", + "type": "[String]", + "required": "false" + }, + { + "name": "relationship", + "type": "[String]", + "required": "false" + } + ], + "return": "DevelopmentActivityListing" + }, + "GET /api/v2/users/development/activities/{activityId}": { + "operationId": "getusersdevelopmentactivity", + "functionName": "getUsersDevelopmentActivity", + "signature": "getUsersDevelopmentActivity(activityId, type)", + "parameters": [ + { + "name": "activityId", + "type": "String", + "required": "true" + }, + { + "name": "type", + "type": "String", + "required": "true" + } + ], + "return": "DevelopmentActivity" + }, + "GET /api/v2/users/me": { + "operationId": "getusersme", + "functionName": "getUsersMe", + "signature": "getUsersMe(expand, integrationPresenceSource)", + "parameters": [ + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + } + ], + "return": "UserMe" + }, + "GET /api/v2/users/search": { + "operationId": "getuserssearch", + "functionName": "getUsersSearch", + "signature": "getUsersSearch(q64, expand, integrationPresenceSource)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "integrationPresenceSource", + "type": "String", + "required": "false" + } + ], + "return": "UsersSearchResponse" + }, + "PATCH /api/v2/users/{userId}": { + "operationId": "patchuser", + "functionName": "patchUser", + "signature": "patchUser(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateUser", + "required": "true" + } + ], + "return": "User" + }, + "PATCH /api/v2/users/{userId}/callforwarding": { + "operationId": "patchusercallforwarding", + "functionName": "patchUserCallforwarding", + "signature": "patchUserCallforwarding(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CallForwarding", + "required": "true" + } + ], + "return": "CallForwarding" + }, + "PATCH /api/v2/users/{userId}/geolocations/{clientId}": { + "operationId": "patchusergeolocation", + "functionName": "patchUserGeolocation", + "signature": "patchUserGeolocation(userId, clientId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "clientId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Geolocation", + "required": "true" + } + ], + "return": "Geolocation" + }, + "PATCH /api/v2/users/{userId}/queues/{queueId}": { + "operationId": "patchuserqueue", + "functionName": "patchUserQueue", + "signature": "patchUserQueue(queueId, userId, body)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserQueue", + "required": "true" + } + ], + "return": "UserQueue" + }, + "PATCH /api/v2/users/{userId}/queues": { + "operationId": "patchuserqueues", + "functionName": "patchUserQueues", + "signature": "patchUserQueues(userId, body, divisionId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserQueue]", + "required": "true" + }, + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "UserQueueEntityListing" + }, + "PATCH /api/v2/users/{userId}/routinglanguages/{languageId}": { + "operationId": "patchuserroutinglanguage", + "functionName": "patchUserRoutinglanguage", + "signature": "patchUserRoutinglanguage(userId, languageId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "languageId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingLanguage", + "required": "true" + } + ], + "return": "UserRoutingLanguage" + }, + "PATCH /api/v2/users/{userId}/routinglanguages/bulk": { + "operationId": "patchuserroutinglanguagesbulk", + "functionName": "patchUserRoutinglanguagesBulk", + "signature": "patchUserRoutinglanguagesBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingLanguagePost]", + "required": "true" + } + ], + "return": "UserLanguageEntityListing" + }, + "PATCH /api/v2/users/{userId}/routingskills/bulk": { + "operationId": "patchuserroutingskillsbulk", + "functionName": "patchUserRoutingskillsBulk", + "signature": "patchUserRoutingskillsBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingSkillPost]", + "required": "true" + } + ], + "return": "UserSkillEntityListing" + }, + "PATCH /api/v2/users/bulk": { + "operationId": "patchusersbulk", + "functionName": "patchUsersBulk", + "signature": "patchUsersBulk(body)", + "parameters": [ + { + "name": "body", + "type": "[PatchUser]", + "required": "true" + } + ], + "return": "UserEntityListing" + }, + "POST /api/v2/analytics/users/aggregates/query": { + "operationId": "postanalyticsusersaggregatesquery", + "functionName": "postAnalyticsUsersAggregatesQuery", + "signature": "postAnalyticsUsersAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserAggregationQuery", + "required": "true" + } + ], + "return": "UserAggregateQueryResponse" + }, + "POST /api/v2/analytics/users/details/jobs": { + "operationId": "postanalyticsusersdetailsjobs", + "functionName": "postAnalyticsUsersDetailsJobs", + "signature": "postAnalyticsUsersDetailsJobs(body)", + "parameters": [ + { + "name": "body", + "type": "AsyncUserDetailsQuery", + "required": "true" + } + ], + "return": "AsyncQueryResponse" + }, + "POST /api/v2/analytics/users/details/query": { + "operationId": "postanalyticsusersdetailsquery", + "functionName": "postAnalyticsUsersDetailsQuery", + "signature": "postAnalyticsUsersDetailsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserDetailsQuery", + "required": "true" + } + ], + "return": "AnalyticsUserDetailsQueryResponse" + }, + "POST /api/v2/analytics/users/observations/query": { + "operationId": "postanalyticsusersobservationsquery", + "functionName": "postAnalyticsUsersObservationsQuery", + "signature": "postAnalyticsUsersObservationsQuery(body)", + "parameters": [ + { + "name": "body", + "type": "UserObservationQuery", + "required": "true" + } + ], + "return": "UserObservationQueryResponse" + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkadd": { + "operationId": "postauthorizationsubjectbulkadd", + "functionName": "postAuthorizationSubjectBulkadd", + "signature": "postAuthorizationSubjectBulkadd(subjectId, body, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkremove": { + "operationId": "postauthorizationsubjectbulkremove", + "functionName": "postAuthorizationSubjectBulkremove", + "signature": "postAuthorizationSubjectBulkremove(subjectId, body)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/bulkreplace": { + "operationId": "postauthorizationsubjectbulkreplace", + "functionName": "postAuthorizationSubjectBulkreplace", + "signature": "postAuthorizationSubjectBulkreplace(subjectId, body, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoleDivisionGrants", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}": { + "operationId": "postauthorizationsubjectdivisionrole", + "functionName": "postAuthorizationSubjectDivisionRole", + "signature": "postAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId, subjectType)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "divisionId", + "type": "String", + "required": "true" + }, + { + "name": "roleId", + "type": "String", + "required": "true" + }, + { + "name": "subjectType", + "type": "String", + "required": "false" + } + ] + }, + "POST /api/v2/users/{userId}/externalid": { + "operationId": "postuserexternalid", + "functionName": "postUserExternalid", + "signature": "postUserExternalid(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserExternalIdentifier", + "required": "true" + } + ], + "return": "[UserExternalIdentifier]" + }, + "POST /api/v2/users/{userId}/invite": { + "operationId": "postuserinvite", + "functionName": "postUserInvite", + "signature": "postUserInvite(userId, force)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "force", + "type": "Bool", + "required": "false" + } + ] + }, + "POST /api/v2/users/{userId}/password": { + "operationId": "postuserpassword", + "functionName": "postUserPassword", + "signature": "postUserPassword(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ChangePasswordRequest", + "required": "true" + } + ] + }, + "POST /api/v2/users/{userId}/routinglanguages": { + "operationId": "postuserroutinglanguages", + "functionName": "postUserRoutinglanguages", + "signature": "postUserRoutinglanguages(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingLanguagePost", + "required": "true" + } + ], + "return": "UserRoutingLanguage" + }, + "POST /api/v2/users/{userId}/routingskills": { + "operationId": "postuserroutingskills", + "functionName": "postUserRoutingskills", + "signature": "postUserRoutingskills(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingSkillPost", + "required": "true" + } + ], + "return": "UserRoutingSkill" + }, + "POST /api/v2/users": { + "operationId": "postusers", + "functionName": "postUsers", + "signature": "postUsers(body)", + "parameters": [ + { + "name": "body", + "type": "CreateUser", + "required": "true" + } + ], + "return": "User" + }, + "POST /api/v2/users/development/activities/aggregates/query": { + "operationId": "postusersdevelopmentactivitiesaggregatesquery", + "functionName": "postUsersDevelopmentActivitiesAggregatesQuery", + "signature": "postUsersDevelopmentActivitiesAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "DevelopmentActivityAggregateParam", + "required": "true" + } + ], + "return": "DevelopmentActivityAggregateResponse" + }, + "POST /api/v2/users/me/password": { + "operationId": "postusersmepassword", + "functionName": "postUsersMePassword", + "signature": "postUsersMePassword(body)", + "parameters": [ + { + "name": "body", + "type": "ChangeMyPasswordRequest", + "required": "true" + } + ] + }, + "POST /api/v2/users/search": { + "operationId": "postuserssearch", + "functionName": "postUsersSearch", + "signature": "postUsersSearch(body)", + "parameters": [ + { + "name": "body", + "type": "UserSearchRequest", + "required": "true" + } + ], + "return": "UsersSearchResponse" + }, + "POST /api/v2/users/search/teams/assign": { + "operationId": "postuserssearchteamsassign", + "functionName": "postUsersSearchTeamsAssign", + "signature": "postUsersSearchTeamsAssign(body)", + "parameters": [ + { + "name": "body", + "type": "UserSearchRequest", + "required": "true" + } + ], + "return": "UsersSearchResponse" + }, + "PUT /api/v2/routing/users/{userId}/utilization": { + "operationId": "putroutinguserutilization", + "functionName": "putRoutingUserUtilization", + "signature": "putRoutingUserUtilization(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Utilization", + "required": "true" + } + ], + "return": "AgentMaxUtilization" + }, + "PUT /api/v2/users/{userId}/callforwarding": { + "operationId": "putusercallforwarding", + "functionName": "putUserCallforwarding", + "signature": "putUserCallforwarding(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CallForwarding", + "required": "true" + } + ], + "return": "CallForwarding" + }, + "PUT /api/v2/users/{userId}/outofoffice": { + "operationId": "putuseroutofoffice", + "functionName": "putUserOutofoffice", + "signature": "putUserOutofoffice(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "OutOfOffice", + "required": "true" + } + ], + "return": "OutOfOffice" + }, + "PUT /api/v2/users/{userId}/profileskills": { + "operationId": "putuserprofileskills", + "functionName": "putUserProfileskills", + "signature": "putUserProfileskills(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "[String]" + }, + "PUT /api/v2/users/{subjectId}/roles": { + "operationId": "putuserroles", + "functionName": "putUserRoles", + "signature": "putUserRoles(subjectId, body)", + "parameters": [ + { + "name": "subjectId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[String]", + "required": "true" + } + ], + "return": "UserAuthorization" + }, + "PUT /api/v2/users/{userId}/routingskills/{skillId}": { + "operationId": "putuserroutingskill", + "functionName": "putUserRoutingskill", + "signature": "putUserRoutingskill(userId, skillId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "skillId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserRoutingSkill", + "required": "true" + } + ], + "return": "UserRoutingSkill" + }, + "PUT /api/v2/users/{userId}/routingskills/bulk": { + "operationId": "putuserroutingskillsbulk", + "functionName": "putUserRoutingskillsBulk", + "signature": "putUserRoutingskillsBulk(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "[UserRoutingSkillPost]", + "required": "true" + } + ], + "return": "UserSkillEntityListing" + }, + "PUT /api/v2/users/{userId}/routingstatus": { + "operationId": "putuserroutingstatus", + "functionName": "putUserRoutingstatus", + "signature": "putUserRoutingstatus(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "RoutingStatus", + "required": "true" + } + ], + "return": "RoutingStatus" + }, + "PUT /api/v2/users/{userId}/state": { + "operationId": "putuserstate", + "functionName": "putUserState", + "signature": "putUserState(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserState", + "required": "true" + } + ], + "return": "UserState" + }, + "PUT /api/v2/users/{userId}/station/associatedstation/{stationId}": { + "operationId": "putuserstationassociatedstationstationid", + "functionName": "putUserStationAssociatedstationStationId", + "signature": "putUserStationAssociatedstationStationId(userId, stationId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "stationId", + "type": "String", + "required": "true" + } + ] + }, + "PUT /api/v2/users/{userId}/station/defaultstation/{stationId}": { + "operationId": "putuserstationdefaultstationstationid", + "functionName": "putUserStationDefaultstationStationId", + "signature": "putUserStationDefaultstationStationId(userId, stationId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "stationId", + "type": "String", + "required": "true" + } + ] + } + +} \ No newline at end of file diff --git a/build/docs/UtilitiesAPI.json b/build/docs/UtilitiesAPI.json new file mode 100644 index 000000000..cf5efe442 --- /dev/null +++ b/build/docs/UtilitiesAPI.json @@ -0,0 +1,48 @@ +{ + "GET /api/v2/date": { + "operationId": "getdate", + "functionName": "getDate", + "signature": "getDate()", + + "return": "ServerDate" + }, + "GET /api/v2/ipranges": { + "operationId": "getipranges", + "functionName": "getIpranges", + "signature": "getIpranges()", + + "return": "IpAddressRangeListing" + }, + "GET /api/v2/timezones": { + "operationId": "gettimezones", + "functionName": "getTimezones", + "signature": "getTimezones(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "TimeZoneEntityListing" + }, + "POST /api/v2/certificate/details": { + "operationId": "postcertificatedetails", + "functionName": "postCertificateDetails", + "signature": "postCertificateDetails(body)", + "parameters": [ + { + "name": "body", + "type": "Certificate", + "required": "true" + } + ], + "return": "ParsedCertificate" + } + +} \ No newline at end of file diff --git a/build/docs/VoicemailAPI.json b/build/docs/VoicemailAPI.json new file mode 100644 index 000000000..1dccdb375 --- /dev/null +++ b/build/docs/VoicemailAPI.json @@ -0,0 +1,366 @@ +{ + "DELETE /api/v2/voicemail/messages/{messageId}": { + "operationId": "deletevoicemailmessage", + "functionName": "deleteVoicemailMessage", + "signature": "deleteVoicemailMessage(messageId)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/voicemail/messages": { + "operationId": "deletevoicemailmessages", + "functionName": "deleteVoicemailMessages", + "signature": "deleteVoicemailMessages()" + + }, + "GET /api/v2/voicemail/groups/{groupId}/mailbox": { + "operationId": "getvoicemailgroupmailbox", + "functionName": "getVoicemailGroupMailbox", + "signature": "getVoicemailGroupMailbox(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ], + "return": "VoicemailMailboxInfo" + }, + "GET /api/v2/voicemail/groups/{groupId}/messages": { + "operationId": "getvoicemailgroupmessages", + "functionName": "getVoicemailGroupMessages", + "signature": "getVoicemailGroupMessages(groupId, pageSize, pageNumber)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "VoicemailMessageEntityListing" + }, + "GET /api/v2/voicemail/groups/{groupId}/policy": { + "operationId": "getvoicemailgrouppolicy", + "functionName": "getVoicemailGroupPolicy", + "signature": "getVoicemailGroupPolicy(groupId)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + } + ], + "return": "VoicemailGroupPolicy" + }, + "GET /api/v2/voicemail/mailbox": { + "operationId": "getvoicemailmailbox", + "functionName": "getVoicemailMailbox", + "signature": "getVoicemailMailbox()", + + "return": "VoicemailMailboxInfo" + }, + "GET /api/v2/voicemail/me/mailbox": { + "operationId": "getvoicemailmemailbox", + "functionName": "getVoicemailMeMailbox", + "signature": "getVoicemailMeMailbox()", + + "return": "VoicemailMailboxInfo" + }, + "GET /api/v2/voicemail/me/messages": { + "operationId": "getvoicemailmemessages", + "functionName": "getVoicemailMeMessages", + "signature": "getVoicemailMeMessages(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "VoicemailMessageEntityListing" + }, + "GET /api/v2/voicemail/me/policy": { + "operationId": "getvoicemailmepolicy", + "functionName": "getVoicemailMePolicy", + "signature": "getVoicemailMePolicy()", + + "return": "VoicemailUserPolicy" + }, + "GET /api/v2/voicemail/messages/{messageId}": { + "operationId": "getvoicemailmessage", + "functionName": "getVoicemailMessage", + "signature": "getVoicemailMessage(messageId, expand)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "VoicemailMessage" + }, + "GET /api/v2/voicemail/messages/{messageId}/media": { + "operationId": "getvoicemailmessagemedia", + "functionName": "getVoicemailMessageMedia", + "signature": "getVoicemailMessageMedia(messageId, formatId)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "formatId", + "type": "String", + "required": "false" + } + ], + "return": "VoicemailMediaInfo" + }, + "GET /api/v2/voicemail/messages": { + "operationId": "getvoicemailmessages", + "functionName": "getVoicemailMessages", + "signature": "getVoicemailMessages(ids, expand)", + "parameters": [ + { + "name": "ids", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "VoicemailMessageEntityListing" + }, + "GET /api/v2/voicemail/policy": { + "operationId": "getvoicemailpolicy", + "functionName": "getVoicemailPolicy", + "signature": "getVoicemailPolicy()", + + "return": "VoicemailOrganizationPolicy" + }, + "GET /api/v2/voicemail/queues/{queueId}/messages": { + "operationId": "getvoicemailqueuemessages", + "functionName": "getVoicemailQueueMessages", + "signature": "getVoicemailQueueMessages(queueId, pageSize, pageNumber)", + "parameters": [ + { + "name": "queueId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "VoicemailMessageEntityListing" + }, + "GET /api/v2/voicemail/search": { + "operationId": "getvoicemailsearch", + "functionName": "getVoicemailSearch", + "signature": "getVoicemailSearch(q64, expand)", + "parameters": [ + { + "name": "q64", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "VoicemailsSearchResponse" + }, + "GET /api/v2/voicemail/userpolicies/{userId}": { + "operationId": "getvoicemailuserpolicy", + "functionName": "getVoicemailUserpolicy", + "signature": "getVoicemailUserpolicy(userId)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + } + ], + "return": "VoicemailUserPolicy" + }, + "PATCH /api/v2/voicemail/groups/{groupId}/policy": { + "operationId": "patchvoicemailgrouppolicy", + "functionName": "patchVoicemailGroupPolicy", + "signature": "patchVoicemailGroupPolicy(groupId, body)", + "parameters": [ + { + "name": "groupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "VoicemailGroupPolicy", + "required": "true" + } + ], + "return": "VoicemailGroupPolicy" + }, + "PATCH /api/v2/voicemail/me/policy": { + "operationId": "patchvoicemailmepolicy", + "functionName": "patchVoicemailMePolicy", + "signature": "patchVoicemailMePolicy(body)", + "parameters": [ + { + "name": "body", + "type": "VoicemailUserPolicy", + "required": "true" + } + ], + "return": "VoicemailUserPolicy" + }, + "PATCH /api/v2/voicemail/messages/{messageId}": { + "operationId": "patchvoicemailmessage", + "functionName": "patchVoicemailMessage", + "signature": "patchVoicemailMessage(messageId, body)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "VoicemailMessage", + "required": "true" + } + ], + "return": "VoicemailMessage" + }, + "PATCH /api/v2/voicemail/userpolicies/{userId}": { + "operationId": "patchvoicemailuserpolicy", + "functionName": "patchVoicemailUserpolicy", + "signature": "patchVoicemailUserpolicy(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "VoicemailUserPolicy", + "required": "true" + } + ], + "return": "VoicemailUserPolicy" + }, + "POST /api/v2/voicemail/messages": { + "operationId": "postvoicemailmessages", + "functionName": "postVoicemailMessages", + "signature": "postVoicemailMessages(body)", + "parameters": [ + { + "name": "body", + "type": "CopyVoicemailMessage", + "required": "false" + } + ], + "return": "VoicemailMessage" + }, + "POST /api/v2/voicemail/search": { + "operationId": "postvoicemailsearch", + "functionName": "postVoicemailSearch", + "signature": "postVoicemailSearch(body)", + "parameters": [ + { + "name": "body", + "type": "VoicemailSearchRequest", + "required": "true" + } + ], + "return": "VoicemailsSearchResponse" + }, + "PUT /api/v2/voicemail/messages/{messageId}": { + "operationId": "putvoicemailmessage", + "functionName": "putVoicemailMessage", + "signature": "putVoicemailMessage(messageId, body)", + "parameters": [ + { + "name": "messageId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "VoicemailMessage", + "required": "true" + } + ], + "return": "VoicemailMessage" + }, + "PUT /api/v2/voicemail/policy": { + "operationId": "putvoicemailpolicy", + "functionName": "putVoicemailPolicy", + "signature": "putVoicemailPolicy(body)", + "parameters": [ + { + "name": "body", + "type": "VoicemailOrganizationPolicy", + "required": "true" + } + ], + "return": "VoicemailOrganizationPolicy" + }, + "PUT /api/v2/voicemail/userpolicies/{userId}": { + "operationId": "putvoicemailuserpolicy", + "functionName": "putVoicemailUserpolicy", + "signature": "putVoicemailUserpolicy(userId, body)", + "parameters": [ + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "VoicemailUserPolicy", + "required": "true" + } + ], + "return": "VoicemailUserPolicy" + } + +} \ No newline at end of file diff --git a/build/docs/WebChatAPI.json b/build/docs/WebChatAPI.json new file mode 100644 index 000000000..706f1283a --- /dev/null +++ b/build/docs/WebChatAPI.json @@ -0,0 +1,314 @@ +{ + "DELETE /api/v2/webchat/deployments/{deploymentId}": { + "operationId": "deletewebchatdeployment", + "functionName": "deleteWebchatDeployment", + "signature": "deleteWebchatDeployment(deploymentId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}": { + "operationId": "deletewebchatguestconversationmember", + "functionName": "deleteWebchatGuestConversationMember", + "signature": "deleteWebchatGuestConversationMember(conversationId, memberId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/webchat/settings": { + "operationId": "deletewebchatsettings", + "functionName": "deleteWebchatSettings", + "signature": "deleteWebchatSettings()" + + }, + "GET /api/v2/webchat/deployments/{deploymentId}": { + "operationId": "getwebchatdeployment", + "functionName": "getWebchatDeployment", + "signature": "getWebchatDeployment(deploymentId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatDeployment" + }, + "GET /api/v2/webchat/deployments": { + "operationId": "getwebchatdeployments", + "functionName": "getWebchatDeployments", + "signature": "getWebchatDeployments()", + + "return": "WebChatDeploymentEntityListing" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}": { + "operationId": "getwebchatguestconversationmediarequest", + "functionName": "getWebchatGuestConversationMediarequest", + "signature": "getWebchatGuestConversationMediarequest(conversationId, mediaRequestId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "mediaRequestId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatGuestMediaRequest" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests": { + "operationId": "getwebchatguestconversationmediarequests", + "functionName": "getWebchatGuestConversationMediarequests", + "signature": "getWebchatGuestConversationMediarequests(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatGuestMediaRequestEntityList" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}": { + "operationId": "getwebchatguestconversationmember", + "functionName": "getWebchatGuestConversationMember", + "signature": "getWebchatGuestConversationMember(conversationId, memberId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatMemberInfo" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/members": { + "operationId": "getwebchatguestconversationmembers", + "functionName": "getWebchatGuestConversationMembers", + "signature": "getWebchatGuestConversationMembers(conversationId, pageSize, pageNumber, excludeDisconnectedMembers)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "excludeDisconnectedMembers", + "type": "Bool", + "required": "false" + } + ], + "return": "WebChatMemberInfoEntityList" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}": { + "operationId": "getwebchatguestconversationmessage", + "functionName": "getWebchatGuestConversationMessage", + "signature": "getWebchatGuestConversationMessage(conversationId, messageId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "messageId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatMessage" + }, + "GET /api/v2/webchat/guest/conversations/{conversationId}/messages": { + "operationId": "getwebchatguestconversationmessages", + "functionName": "getWebchatGuestConversationMessages", + "signature": "getWebchatGuestConversationMessages(conversationId, after, before, sortOrder, maxResults)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "before", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "maxResults", + "type": "Int", + "required": "false" + } + ], + "return": "WebChatMessageEntityList" + }, + "GET /api/v2/webchat/settings": { + "operationId": "getwebchatsettings", + "functionName": "getWebchatSettings", + "signature": "getWebchatSettings()", + + "return": "WebChatSettings" + }, + "PATCH /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}": { + "operationId": "patchwebchatguestconversationmediarequest", + "functionName": "patchWebchatGuestConversationMediarequest", + "signature": "patchWebchatGuestConversationMediarequest(conversationId, mediaRequestId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "mediaRequestId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WebChatGuestMediaRequest", + "required": "true" + } + ], + "return": "WebChatGuestMediaRequest" + }, + "POST /api/v2/webchat/deployments": { + "operationId": "postwebchatdeployments", + "functionName": "postWebchatDeployments", + "signature": "postWebchatDeployments(body)", + "parameters": [ + { + "name": "body", + "type": "WebChatDeployment", + "required": "true" + } + ], + "return": "WebChatDeployment" + }, + "POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages": { + "operationId": "postwebchatguestconversationmembermessages", + "functionName": "postWebchatGuestConversationMemberMessages", + "signature": "postWebchatGuestConversationMemberMessages(conversationId, memberId, body)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateWebChatMessageRequest", + "required": "true" + } + ], + "return": "WebChatMessage" + }, + "POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing": { + "operationId": "postwebchatguestconversationmembertyping", + "functionName": "postWebchatGuestConversationMemberTyping", + "signature": "postWebchatGuestConversationMemberTyping(conversationId, memberId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "memberId", + "type": "String", + "required": "true" + } + ], + "return": "WebChatTyping" + }, + "POST /api/v2/webchat/guest/conversations": { + "operationId": "postwebchatguestconversations", + "functionName": "postWebchatGuestConversations", + "signature": "postWebchatGuestConversations(body)", + "parameters": [ + { + "name": "body", + "type": "CreateWebChatConversationRequest", + "required": "true" + } + ], + "return": "CreateWebChatConversationResponse" + }, + "PUT /api/v2/webchat/deployments/{deploymentId}": { + "operationId": "putwebchatdeployment", + "functionName": "putWebchatDeployment", + "signature": "putWebchatDeployment(deploymentId, body)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WebChatDeployment", + "required": "true" + } + ], + "return": "WebChatDeployment" + }, + "PUT /api/v2/webchat/settings": { + "operationId": "putwebchatsettings", + "functionName": "putWebchatSettings", + "signature": "putWebchatSettings(body)", + "parameters": [ + { + "name": "body", + "type": "WebChatSettings", + "required": "true" + } + ], + "return": "WebChatSettings" + } + +} \ No newline at end of file diff --git a/build/docs/WebDeploymentsAPI.json b/build/docs/WebDeploymentsAPI.json new file mode 100644 index 000000000..dd52fccc5 --- /dev/null +++ b/build/docs/WebDeploymentsAPI.json @@ -0,0 +1,292 @@ +{ + "DELETE /api/v2/webdeployments/configurations/{configurationId}": { + "operationId": "deletewebdeploymentsconfiguration", + "functionName": "deleteWebdeploymentsConfiguration", + "signature": "deleteWebdeploymentsConfiguration(configurationId)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/webdeployments/deployments/{deploymentId}": { + "operationId": "deletewebdeploymentsdeployment", + "functionName": "deleteWebdeploymentsDeployment", + "signature": "deleteWebdeploymentsDeployment(deploymentId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}": { + "operationId": "deletewebdeploymentsdeploymentcobrowsesessionid", + "functionName": "deleteWebdeploymentsDeploymentCobrowseSessionId", + "signature": "deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "sessionId", + "type": "String", + "required": "true" + } + ], + "return": "JSON" + }, + "DELETE /api/v2/webdeployments/token/revoke": { + "operationId": "deletewebdeploymentstokenrevoke", + "functionName": "deleteWebdeploymentsTokenRevoke", + "signature": "deleteWebdeploymentsTokenRevoke(xJourneySessionId, xJourneySessionType)", + "parameters": [ + { + "name": "xJourneySessionId", + "type": "String", + "required": "false" + }, + { + "name": "xJourneySessionType", + "type": "String", + "required": "false" + } + ] + }, + "GET /api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}": { + "operationId": "getwebdeploymentsconfigurationversion", + "functionName": "getWebdeploymentsConfigurationVersion", + "signature": "getWebdeploymentsConfigurationVersion(configurationId, versionId)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + }, + { + "name": "versionId", + "type": "String", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersion" + }, + "GET /api/v2/webdeployments/configurations/{configurationId}/versions": { + "operationId": "getwebdeploymentsconfigurationversions", + "functionName": "getWebdeploymentsConfigurationVersions", + "signature": "getWebdeploymentsConfigurationVersions(configurationId)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersionEntityListing" + }, + "GET /api/v2/webdeployments/configurations/{configurationId}/versions/draft": { + "operationId": "getwebdeploymentsconfigurationversionsdraft", + "functionName": "getWebdeploymentsConfigurationVersionsDraft", + "signature": "getWebdeploymentsConfigurationVersionsDraft(configurationId)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersion" + }, + "GET /api/v2/webdeployments/configurations": { + "operationId": "getwebdeploymentsconfigurations", + "functionName": "getWebdeploymentsConfigurations", + "signature": "getWebdeploymentsConfigurations(showOnlyPublished)", + "parameters": [ + { + "name": "showOnlyPublished", + "type": "Bool", + "required": "false" + } + ], + "return": "WebDeploymentConfigurationVersionEntityListing" + }, + "GET /api/v2/webdeployments/deployments/{deploymentId}": { + "operationId": "getwebdeploymentsdeployment", + "functionName": "getWebdeploymentsDeployment", + "signature": "getWebdeploymentsDeployment(deploymentId, expand)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WebDeployment" + }, + "GET /api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}": { + "operationId": "getwebdeploymentsdeploymentcobrowsesessionid", + "functionName": "getWebdeploymentsDeploymentCobrowseSessionId", + "signature": "getWebdeploymentsDeploymentCobrowseSessionId(deploymentId, sessionId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "sessionId", + "type": "String", + "required": "true" + } + ], + "return": "CobrowseWebMessagingSession" + }, + "GET /api/v2/webdeployments/deployments/{deploymentId}/configurations": { + "operationId": "getwebdeploymentsdeploymentconfigurations", + "functionName": "getWebdeploymentsDeploymentConfigurations", + "signature": "getWebdeploymentsDeploymentConfigurations(deploymentId, type, expand)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "type", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WebDeploymentActiveConfigurationOnDeployment" + }, + "GET /api/v2/webdeployments/deployments": { + "operationId": "getwebdeploymentsdeployments", + "functionName": "getWebdeploymentsDeployments", + "signature": "getWebdeploymentsDeployments(expand)", + "parameters": [ + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ExpandableWebDeploymentEntityListing" + }, + "POST /api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish": { + "operationId": "postwebdeploymentsconfigurationversionsdraftpublish", + "functionName": "postWebdeploymentsConfigurationVersionsDraftPublish", + "signature": "postWebdeploymentsConfigurationVersionsDraftPublish(configurationId)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersion" + }, + "POST /api/v2/webdeployments/configurations": { + "operationId": "postwebdeploymentsconfigurations", + "functionName": "postWebdeploymentsConfigurations", + "signature": "postWebdeploymentsConfigurations(configurationVersion)", + "parameters": [ + { + "name": "configurationVersion", + "type": "WebDeploymentConfigurationVersion", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersion" + }, + "POST /api/v2/webdeployments/deployments": { + "operationId": "postwebdeploymentsdeployments", + "functionName": "postWebdeploymentsDeployments", + "signature": "postWebdeploymentsDeployments(deployment)", + "parameters": [ + { + "name": "deployment", + "type": "WebDeployment", + "required": "true" + } + ], + "return": "WebDeployment" + }, + "POST /api/v2/webdeployments/token/oauthcodegrantjwtexchange": { + "operationId": "postwebdeploymentstokenoauthcodegrantjwtexchange", + "functionName": "postWebdeploymentsTokenOauthcodegrantjwtexchange", + "signature": "postWebdeploymentsTokenOauthcodegrantjwtexchange(body)", + "parameters": [ + { + "name": "body", + "type": "WebDeploymentsOAuthExchangeRequest", + "required": "true" + } + ], + "return": "WebDeploymentsAuthorizationResponse" + }, + "POST /api/v2/webdeployments/token/refresh": { + "operationId": "postwebdeploymentstokenrefresh", + "functionName": "postWebdeploymentsTokenRefresh", + "signature": "postWebdeploymentsTokenRefresh(body)", + "parameters": [ + { + "name": "body", + "type": "WebDeploymentsRefreshJWTRequest", + "required": "false" + } + ], + "return": "SignedData" + }, + "PUT /api/v2/webdeployments/configurations/{configurationId}/versions/draft": { + "operationId": "putwebdeploymentsconfigurationversionsdraft", + "functionName": "putWebdeploymentsConfigurationVersionsDraft", + "signature": "putWebdeploymentsConfigurationVersionsDraft(configurationId, configurationVersion)", + "parameters": [ + { + "name": "configurationId", + "type": "String", + "required": "true" + }, + { + "name": "configurationVersion", + "type": "WebDeploymentConfigurationVersion", + "required": "true" + } + ], + "return": "WebDeploymentConfigurationVersion" + }, + "PUT /api/v2/webdeployments/deployments/{deploymentId}": { + "operationId": "putwebdeploymentsdeployment", + "functionName": "putWebdeploymentsDeployment", + "signature": "putWebdeploymentsDeployment(deploymentId, deployment)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "deployment", + "type": "WebDeployment", + "required": "true" + } + ], + "return": "WebDeployment" + } + +} \ No newline at end of file diff --git a/build/docs/WebMessagingAPI.json b/build/docs/WebMessagingAPI.json new file mode 100644 index 000000000..08b77d8b8 --- /dev/null +++ b/build/docs/WebMessagingAPI.json @@ -0,0 +1,21 @@ +{ + "GET /api/v2/webmessaging/messages": { + "operationId": "getwebmessagingmessages", + "functionName": "getWebmessagingMessages", + "signature": "getWebmessagingMessages(pageSize, pageNumber)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + } + ], + "return": "WebMessagingMessageEntityList" + } + +} \ No newline at end of file diff --git a/build/docs/WidgetsAPI.json b/build/docs/WidgetsAPI.json new file mode 100644 index 000000000..bc73e6f38 --- /dev/null +++ b/build/docs/WidgetsAPI.json @@ -0,0 +1,66 @@ +{ + "DELETE /api/v2/widgets/deployments/{deploymentId}": { + "operationId": "deletewidgetsdeployment", + "functionName": "deleteWidgetsDeployment", + "signature": "deleteWidgetsDeployment(deploymentId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/widgets/deployments/{deploymentId}": { + "operationId": "getwidgetsdeployment", + "functionName": "getWidgetsDeployment", + "signature": "getWidgetsDeployment(deploymentId)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + } + ], + "return": "WidgetDeployment" + }, + "GET /api/v2/widgets/deployments": { + "operationId": "getwidgetsdeployments", + "functionName": "getWidgetsDeployments", + "signature": "getWidgetsDeployments()", + + "return": "WidgetDeploymentEntityListing" + }, + "POST /api/v2/widgets/deployments": { + "operationId": "postwidgetsdeployments", + "functionName": "postWidgetsDeployments", + "signature": "postWidgetsDeployments(body)", + "parameters": [ + { + "name": "body", + "type": "WidgetDeployment", + "required": "true" + } + ], + "return": "WidgetDeployment" + }, + "PUT /api/v2/widgets/deployments/{deploymentId}": { + "operationId": "putwidgetsdeployment", + "functionName": "putWidgetsDeployment", + "signature": "putWidgetsDeployment(deploymentId, body)", + "parameters": [ + { + "name": "deploymentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WidgetDeployment", + "required": "true" + } + ], + "return": "WidgetDeployment" + } + +} \ No newline at end of file diff --git a/build/docs/WorkforceManagementAPI.json b/build/docs/WorkforceManagementAPI.json new file mode 100644 index 000000000..2d65bd82c --- /dev/null +++ b/build/docs/WorkforceManagementAPI.json @@ -0,0 +1,3230 @@ +{ + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}": { + "operationId": "deleteworkforcemanagementbusinessunit", + "functionName": "deleteWorkforcemanagementBusinessunit", + "signature": "deleteWorkforcemanagementBusinessunit(businessUnitId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}": { + "operationId": "deleteworkforcemanagementbusinessunitactivitycode", + "functionName": "deleteWorkforcemanagementBusinessunitActivitycode", + "signature": "deleteWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "activityCodeId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}": { + "operationId": "deleteworkforcemanagementbusinessunitplanninggroup", + "functionName": "deleteWorkforcemanagementBusinessunitPlanninggroup", + "signature": "deleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "planningGroupId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}": { + "operationId": "deleteworkforcemanagementbusinessunitschedulingrun", + "functionName": "deleteWorkforcemanagementBusinessunitSchedulingRun", + "signature": "deleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "runId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}": { + "operationId": "deleteworkforcemanagementbusinessunitservicegoaltemplate", + "functionName": "deleteWorkforcemanagementBusinessunitServicegoaltemplate", + "signature": "deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "serviceGoalTemplateId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}": { + "operationId": "deleteworkforcemanagementbusinessunitweekschedule", + "functionName": "deleteWorkforcemanagementBusinessunitWeekSchedule", + "signature": "deleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId, weekId, scheduleId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "BuAsyncScheduleResponse" + }, + "DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}": { + "operationId": "deleteworkforcemanagementbusinessunitweekshorttermforecast", + "functionName": "deleteWorkforcemanagementBusinessunitWeekShorttermforecast", + "signature": "deleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/calendar/url/ics": { + "operationId": "deleteworkforcemanagementcalendarurlics", + "functionName": "deleteWorkforcemanagementCalendarUrlIcs", + "signature": "deleteWorkforcemanagementCalendarUrlIcs()" + + }, + "DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}": { + "operationId": "deleteworkforcemanagementmanagementunit", + "functionName": "deleteWorkforcemanagementManagementunit", + "signature": "deleteWorkforcemanagementManagementunit(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}": { + "operationId": "deleteworkforcemanagementmanagementunittimeofflimit", + "functionName": "deleteWorkforcemanagementManagementunitTimeofflimit", + "signature": "deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffLimitId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}": { + "operationId": "deleteworkforcemanagementmanagementunittimeoffplan", + "functionName": "deleteWorkforcemanagementManagementunitTimeoffplan", + "signature": "deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffPlanId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}": { + "operationId": "deleteworkforcemanagementmanagementunitworkplan", + "functionName": "deleteWorkforcemanagementManagementunitWorkplan", + "signature": "deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanId", + "type": "String", + "required": "true" + } + ] + }, + "DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}": { + "operationId": "deleteworkforcemanagementmanagementunitworkplanrotation", + "functionName": "deleteWorkforcemanagementManagementunitWorkplanrotation", + "signature": "deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanRotationId", + "type": "String", + "required": "true" + } + ] + }, + "GET /api/v2/workforcemanagement/adherence": { + "operationId": "getworkforcemanagementadherence", + "functionName": "getWorkforcemanagementAdherence", + "signature": "getWorkforcemanagementAdherence(userId)", + "parameters": [ + { + "name": "userId", + "type": "[String]", + "required": "true" + } + ], + "return": "[UserScheduleAdherence]" + }, + "GET /api/v2/workforcemanagement/adherence/explanations/{explanationId}": { + "operationId": "getworkforcemanagementadherenceexplanation", + "functionName": "getWorkforcemanagementAdherenceExplanation", + "signature": "getWorkforcemanagementAdherenceExplanation(explanationId)", + "parameters": [ + { + "name": "explanationId", + "type": "String", + "required": "true" + } + ], + "return": "AdherenceExplanationResponse" + }, + "GET /api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}": { + "operationId": "getworkforcemanagementadherenceexplanationsjob", + "functionName": "getWorkforcemanagementAdherenceExplanationsJob", + "signature": "getWorkforcemanagementAdherenceExplanationsJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AdherenceExplanationJob" + }, + "GET /api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}": { + "operationId": "getworkforcemanagementadherencehistoricalbulkjob", + "functionName": "getWorkforcemanagementAdherenceHistoricalBulkJob", + "signature": "getWorkforcemanagementAdherenceHistoricalBulkJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "WfmHistoricalAdherenceBulkResponse" + }, + "GET /api/v2/workforcemanagement/adherence/historical/jobs/{jobId}": { + "operationId": "getworkforcemanagementadherencehistoricaljob", + "functionName": "getWorkforcemanagementAdherenceHistoricalJob", + "signature": "getWorkforcemanagementAdherenceHistoricalJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "WfmHistoricalAdherenceResponse" + }, + "GET /api/v2/workforcemanagement/adhocmodelingjobs/{jobId}": { + "operationId": "getworkforcemanagementadhocmodelingjob", + "functionName": "getWorkforcemanagementAdhocmodelingjob", + "signature": "getWorkforcemanagementAdhocmodelingjob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "ModelingStatusResponse" + }, + "GET /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}": { + "operationId": "getworkforcemanagementagentadherenceexplanation", + "functionName": "getWorkforcemanagementAgentAdherenceExplanation", + "signature": "getWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "explanationId", + "type": "String", + "required": "true" + } + ], + "return": "AdherenceExplanationResponse" + }, + "GET /api/v2/workforcemanagement/agents/{agentId}/managementunit": { + "operationId": "getworkforcemanagementagentmanagementunit", + "functionName": "getWorkforcemanagementAgentManagementunit", + "signature": "getWorkforcemanagementAgentManagementunit(agentId)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + } + ], + "return": "AgentManagementUnitReference" + }, + "GET /api/v2/workforcemanagement/agents/me/managementunit": { + "operationId": "getworkforcemanagementagentsmemanagementunit", + "functionName": "getWorkforcemanagementAgentsMeManagementunit", + "signature": "getWorkforcemanagementAgentsMeManagementunit()", + + "return": "AgentManagementUnitReference" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}": { + "operationId": "getworkforcemanagementbusinessunit", + "functionName": "getWorkforcemanagementBusinessunit", + "signature": "getWorkforcemanagementBusinessunit(businessUnitId, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "BusinessUnitResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}": { + "operationId": "getworkforcemanagementbusinessunitactivitycode", + "functionName": "getWorkforcemanagementBusinessunitActivitycode", + "signature": "getWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "activityCodeId", + "type": "String", + "required": "true" + } + ], + "return": "BusinessUnitActivityCode" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes": { + "operationId": "getworkforcemanagementbusinessunitactivitycodes", + "functionName": "getWorkforcemanagementBusinessunitActivitycodes", + "signature": "getWorkforcemanagementBusinessunitActivitycodes(businessUnitId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + } + ], + "return": "BusinessUnitActivityCodeListing" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups": { + "operationId": "getworkforcemanagementbusinessunitintradayplanninggroups", + "functionName": "getWorkforcemanagementBusinessunitIntradayPlanninggroups", + "signature": "getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, date)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "date", + "type": "Date", + "required": "true" + } + ], + "return": "WfmIntradayPlanningGroupListing" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits": { + "operationId": "getworkforcemanagementbusinessunitmanagementunits", + "functionName": "getWorkforcemanagementBusinessunitManagementunits", + "signature": "getWorkforcemanagementBusinessunitManagementunits(businessUnitId, feature, divisionId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "String", + "required": "false" + } + ], + "return": "ManagementUnitListing" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}": { + "operationId": "getworkforcemanagementbusinessunitplanninggroup", + "functionName": "getWorkforcemanagementBusinessunitPlanninggroup", + "signature": "getWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "planningGroupId", + "type": "String", + "required": "true" + } + ], + "return": "PlanningGroup" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups": { + "operationId": "getworkforcemanagementbusinessunitplanninggroups", + "functionName": "getWorkforcemanagementBusinessunitPlanninggroups", + "signature": "getWorkforcemanagementBusinessunitPlanninggroups(businessUnitId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + } + ], + "return": "PlanningGroupList" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}": { + "operationId": "getworkforcemanagementbusinessunitschedulingrun", + "functionName": "getWorkforcemanagementBusinessunitSchedulingRun", + "signature": "getWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "runId", + "type": "String", + "required": "true" + } + ], + "return": "BuScheduleRun" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result": { + "operationId": "getworkforcemanagementbusinessunitschedulingrunresult", + "functionName": "getWorkforcemanagementBusinessunitSchedulingRunResult", + "signature": "getWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId, runId, managementUnitIds, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "runId", + "type": "String", + "required": "true" + }, + { + "name": "managementUnitIds", + "type": "[String]", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "true" + } + ], + "return": "BuRescheduleResult" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs": { + "operationId": "getworkforcemanagementbusinessunitschedulingruns", + "functionName": "getWorkforcemanagementBusinessunitSchedulingRuns", + "signature": "getWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + } + ], + "return": "BuScheduleRunListing" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}": { + "operationId": "getworkforcemanagementbusinessunitservicegoaltemplate", + "functionName": "getWorkforcemanagementBusinessunitServicegoaltemplate", + "signature": "getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "serviceGoalTemplateId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ServiceGoalTemplate" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates": { + "operationId": "getworkforcemanagementbusinessunitservicegoaltemplates", + "functionName": "getWorkforcemanagementBusinessunitServicegoaltemplates", + "signature": "getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ServiceGoalTemplateList" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}": { + "operationId": "getworkforcemanagementbusinessunitweekschedule", + "functionName": "getWorkforcemanagementBusinessunitWeekSchedule", + "signature": "getWorkforcemanagementBusinessunitWeekSchedule(businessUnitId, weekId, scheduleId, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "BuScheduleMetadata" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults": { + "operationId": "getworkforcemanagementbusinessunitweekschedulegenerationresults", + "functionName": "getWorkforcemanagementBusinessunitWeekScheduleGenerationresults", + "signature": "getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId, weekId, scheduleId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + } + ], + "return": "ScheduleGenerationResult" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast": { + "operationId": "getworkforcemanagementbusinessunitweekscheduleheadcountforecast", + "functionName": "getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast", + "signature": "getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId, weekId, scheduleId, forceDownload)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "forceDownload", + "type": "Bool", + "required": "false" + } + ], + "return": "BuHeadcountForecastResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}": { + "operationId": "getworkforcemanagementbusinessunitweekschedulehistoryagent", + "functionName": "getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent", + "signature": "getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId, weekId, scheduleId, agentId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "agentId", + "type": "String", + "required": "true" + } + ], + "return": "BuAgentScheduleHistoryResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules": { + "operationId": "getworkforcemanagementbusinessunitweekschedules", + "functionName": "getWorkforcemanagementBusinessunitWeekSchedules", + "signature": "getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId, weekId, includeOnlyPublished, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "String", + "required": "true" + }, + { + "name": "includeOnlyPublished", + "type": "Bool", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + } + ], + "return": "BuScheduleListing" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecast", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecast", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId, weekDateId, forecastId, expand)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "BuShortTermForecast" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastdata", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastData", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId, weekDateId, forecastId, weekNumber, forceDownloadService)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + }, + { + "name": "weekNumber", + "type": "Int", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "BuForecastResultResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastgenerationresults", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId, weekDateId, forecastId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + } + ], + "return": "BuForecastGenerationResult" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastlongtermforecastdata", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(businessUnitId, weekDateId, forecastId, forceDownloadService)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "LongTermForecastResultResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecastplanninggroups", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId, weekDateId, forecastId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + } + ], + "return": "ForecastPlanningGroupsResponse" + }, + "GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts": { + "operationId": "getworkforcemanagementbusinessunitweekshorttermforecasts", + "functionName": "getWorkforcemanagementBusinessunitWeekShorttermforecasts", + "signature": "getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "String", + "required": "true" + } + ], + "return": "BuShortTermForecastListing" + }, + "GET /api/v2/workforcemanagement/businessunits": { + "operationId": "getworkforcemanagementbusinessunits", + "functionName": "getWorkforcemanagementBusinessunits", + "signature": "getWorkforcemanagementBusinessunits(feature, divisionId)", + "parameters": [ + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "String", + "required": "false" + } + ], + "return": "BusinessUnitListing" + }, + "GET /api/v2/workforcemanagement/businessunits/divisionviews": { + "operationId": "getworkforcemanagementbusinessunitsdivisionviews", + "functionName": "getWorkforcemanagementBusinessunitsDivisionviews", + "signature": "getWorkforcemanagementBusinessunitsDivisionviews(divisionId)", + "parameters": [ + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "BusinessUnitListing" + }, + "GET /api/v2/workforcemanagement/calendar/data/ics": { + "operationId": "getworkforcemanagementcalendardataics", + "functionName": "getWorkforcemanagementCalendarDataIcs", + "signature": "getWorkforcemanagementCalendarDataIcs(calendarId)", + "parameters": [ + { + "name": "calendarId", + "type": "String", + "required": "true" + } + ], + "return": "String" + }, + "GET /api/v2/workforcemanagement/calendar/url/ics": { + "operationId": "getworkforcemanagementcalendarurlics", + "functionName": "getWorkforcemanagementCalendarUrlIcs", + "signature": "getWorkforcemanagementCalendarUrlIcs()", + + "return": "CalendarUrlResponse" + }, + "GET /api/v2/workforcemanagement/historicaldata/deletejob": { + "operationId": "getworkforcemanagementhistoricaldatadeletejob", + "functionName": "getWorkforcemanagementHistoricaldataDeletejob", + "signature": "getWorkforcemanagementHistoricaldataDeletejob()", + + "return": "HistoricalImportDeleteJobResponse" + }, + "GET /api/v2/workforcemanagement/historicaldata/importstatus": { + "operationId": "getworkforcemanagementhistoricaldataimportstatus", + "functionName": "getWorkforcemanagementHistoricaldataImportstatus", + "signature": "getWorkforcemanagementHistoricaldataImportstatus()", + + "return": "HistoricalImportStatusListing" + }, + "GET /api/v2/workforcemanagement/integrations/hris": { + "operationId": "getworkforcemanagementintegrationshris", + "functionName": "getWorkforcemanagementIntegrationsHris", + "signature": "getWorkforcemanagementIntegrationsHris()", + + "return": "WfmIntegrationListing" + }, + "GET /api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}": { + "operationId": "getworkforcemanagementintegrationshristimeofftypesjob", + "functionName": "getWorkforcemanagementIntegrationsHrisTimeofftypesJob", + "signature": "getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "HrisTimeOffTypesJobResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}": { + "operationId": "getworkforcemanagementmanagementunit", + "functionName": "getWorkforcemanagementManagementunit", + "signature": "getWorkforcemanagementManagementunit(managementUnitId, expand)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "ManagementUnit" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes": { + "operationId": "getworkforcemanagementmanagementunitactivitycodes", + "functionName": "getWorkforcemanagementManagementunitActivitycodes", + "signature": "getWorkforcemanagementManagementunitActivitycodes(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "ActivityCodeContainer" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence": { + "operationId": "getworkforcemanagementmanagementunitadherence", + "functionName": "getWorkforcemanagementManagementunitAdherence", + "signature": "getWorkforcemanagementManagementunitAdherence(managementUnitId, forceDownloadService)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "UserScheduleAdherenceListing" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}": { + "operationId": "getworkforcemanagementmanagementunitagent", + "functionName": "getWorkforcemanagementManagementunitAgent", + "signature": "getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, excludeCapabilities)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "excludeCapabilities", + "type": "Bool", + "required": "false" + } + ], + "return": "WfmAgent" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades": { + "operationId": "getworkforcemanagementmanagementunitagentshifttrades", + "functionName": "getWorkforcemanagementManagementunitAgentShifttrades", + "signature": "getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "agentId", + "type": "String", + "required": "true" + } + ], + "return": "ShiftTradeListResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched": { + "operationId": "getworkforcemanagementmanagementunitshifttradesmatched", + "functionName": "getWorkforcemanagementManagementunitShifttradesMatched", + "signature": "getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "ShiftTradeMatchesSummaryResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users": { + "operationId": "getworkforcemanagementmanagementunitshifttradesusers", + "functionName": "getWorkforcemanagementManagementunitShifttradesUsers", + "signature": "getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "WfmUserEntityListing" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}": { + "operationId": "getworkforcemanagementmanagementunittimeofflimit", + "functionName": "getWorkforcemanagementManagementunitTimeofflimit", + "signature": "getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffLimitId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffLimit" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits": { + "operationId": "getworkforcemanagementmanagementunittimeofflimits", + "functionName": "getWorkforcemanagementManagementunitTimeofflimits", + "signature": "getWorkforcemanagementManagementunitTimeofflimits(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffLimitListing" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}": { + "operationId": "getworkforcemanagementmanagementunittimeoffplan", + "functionName": "getWorkforcemanagementManagementunitTimeoffplan", + "signature": "getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffPlanId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffPlan" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans": { + "operationId": "getworkforcemanagementmanagementunittimeoffplans", + "functionName": "getWorkforcemanagementManagementunitTimeoffplans", + "signature": "getWorkforcemanagementManagementunitTimeoffplans(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffPlanListing" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}": { + "operationId": "getworkforcemanagementmanagementunitusertimeoffrequest", + "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequest", + "signature": "getWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffRequestResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits": { + "operationId": "getworkforcemanagementmanagementunitusertimeoffrequesttimeofflimits", + "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits", + "signature": "getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + } + ], + "return": "QueryTimeOffLimitValuesResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests": { + "operationId": "getworkforcemanagementmanagementunitusertimeoffrequests", + "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequests", + "signature": "getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId, recentlyReviewed)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "recentlyReviewed", + "type": "Bool", + "required": "false" + } + ], + "return": "TimeOffRequestList" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users": { + "operationId": "getworkforcemanagementmanagementunitusers", + "functionName": "getWorkforcemanagementManagementunitUsers", + "signature": "getWorkforcemanagementManagementunitUsers(managementUnitId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + } + ], + "return": "WfmUserEntityListing" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}": { + "operationId": "getworkforcemanagementmanagementunitweekschedule", + "functionName": "getWorkforcemanagementManagementunitWeekSchedule", + "signature": "getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, expand, forceDownloadService)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "String", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "WeekScheduleResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules": { + "operationId": "getworkforcemanagementmanagementunitweekschedules", + "functionName": "getWorkforcemanagementManagementunitWeekSchedules", + "signature": "getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, includeOnlyPublished, earliestWeekDate, latestWeekDate)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "String", + "required": "true" + }, + { + "name": "includeOnlyPublished", + "type": "Bool", + "required": "false" + }, + { + "name": "earliestWeekDate", + "type": "String", + "required": "false" + }, + { + "name": "latestWeekDate", + "type": "String", + "required": "false" + } + ], + "return": "WeekScheduleListResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades": { + "operationId": "getworkforcemanagementmanagementunitweekshifttrades", + "functionName": "getWorkforcemanagementManagementunitWeekShifttrades", + "signature": "getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, evaluateMatches)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "evaluateMatches", + "type": "Bool", + "required": "false" + } + ], + "return": "WeekShiftTradeListResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}": { + "operationId": "getworkforcemanagementmanagementunitworkplan", + "functionName": "getWorkforcemanagementManagementunitWorkplan", + "signature": "getWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, includeOnly)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanId", + "type": "String", + "required": "true" + }, + { + "name": "includeOnly", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkPlan" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}": { + "operationId": "getworkforcemanagementmanagementunitworkplanrotation", + "functionName": "getWorkforcemanagementManagementunitWorkplanrotation", + "signature": "getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanRotationId", + "type": "String", + "required": "true" + } + ], + "return": "WorkPlanRotationResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations": { + "operationId": "getworkforcemanagementmanagementunitworkplanrotations", + "functionName": "getWorkforcemanagementManagementunitWorkplanrotations", + "signature": "getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, expand)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkPlanRotationListResponse" + }, + "GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans": { + "operationId": "getworkforcemanagementmanagementunitworkplans", + "functionName": "getWorkforcemanagementManagementunitWorkplans", + "signature": "getWorkforcemanagementManagementunitWorkplans(managementUnitId, expand)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "WorkPlanListResponse" + }, + "GET /api/v2/workforcemanagement/managementunits": { + "operationId": "getworkforcemanagementmanagementunits", + "functionName": "getWorkforcemanagementManagementunits", + "signature": "getWorkforcemanagementManagementunits(pageSize, pageNumber, expand, feature, divisionId)", + "parameters": [ + { + "name": "pageSize", + "type": "Int", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Int", + "required": "false" + }, + { + "name": "expand", + "type": "String", + "required": "false" + }, + { + "name": "feature", + "type": "String", + "required": "false" + }, + { + "name": "divisionId", + "type": "String", + "required": "false" + } + ], + "return": "ManagementUnitListing" + }, + "GET /api/v2/workforcemanagement/managementunits/divisionviews": { + "operationId": "getworkforcemanagementmanagementunitsdivisionviews", + "functionName": "getWorkforcemanagementManagementunitsDivisionviews", + "signature": "getWorkforcemanagementManagementunitsDivisionviews(divisionId)", + "parameters": [ + { + "name": "divisionId", + "type": "[String]", + "required": "false" + } + ], + "return": "ManagementUnitListing" + }, + "GET /api/v2/workforcemanagement/notifications": { + "operationId": "getworkforcemanagementnotifications", + "functionName": "getWorkforcemanagementNotifications", + "signature": "getWorkforcemanagementNotifications()", + + "return": "NotificationsResponse" + }, + "GET /api/v2/workforcemanagement/schedulingjobs/{jobId}": { + "operationId": "getworkforcemanagementschedulingjob", + "functionName": "getWorkforcemanagementSchedulingjob", + "signature": "getWorkforcemanagementSchedulingjob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "SchedulingStatusResponse" + }, + "GET /api/v2/workforcemanagement/shifttrades": { + "operationId": "getworkforcemanagementshifttrades", + "functionName": "getWorkforcemanagementShifttrades", + "signature": "getWorkforcemanagementShifttrades()", + + "return": "ShiftTradeListResponse" + }, + "GET /api/v2/workforcemanagement/shrinkage/jobs/{jobId}": { + "operationId": "getworkforcemanagementshrinkagejob", + "functionName": "getWorkforcemanagementShrinkageJob", + "signature": "getWorkforcemanagementShrinkageJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "WfmHistoricalShrinkageResponse" + }, + "GET /api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}": { + "operationId": "getworkforcemanagementtimeoffbalancejob", + "functionName": "getWorkforcemanagementTimeoffbalanceJob", + "signature": "getWorkforcemanagementTimeoffbalanceJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffBalanceJobResponse" + }, + "GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}": { + "operationId": "getworkforcemanagementtimeoffrequest", + "functionName": "getWorkforcemanagementTimeoffrequest", + "signature": "getWorkforcemanagementTimeoffrequest(timeOffRequestId)", + "parameters": [ + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffRequestResponse" + }, + "GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions": { + "operationId": "getworkforcemanagementtimeoffrequestwaitlistpositions", + "functionName": "getWorkforcemanagementTimeoffrequestWaitlistpositions", + "signature": "getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId)", + "parameters": [ + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + } + ], + "return": "WaitlistPositionListing" + }, + "GET /api/v2/workforcemanagement/timeoffrequests": { + "operationId": "getworkforcemanagementtimeoffrequests", + "functionName": "getWorkforcemanagementTimeoffrequests", + "signature": "getWorkforcemanagementTimeoffrequests(recentlyReviewed)", + "parameters": [ + { + "name": "recentlyReviewed", + "type": "Bool", + "required": "false" + } + ], + "return": "TimeOffRequestList" + }, + "PATCH /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}": { + "operationId": "patchworkforcemanagementagentadherenceexplanation", + "functionName": "patchWorkforcemanagementAgentAdherenceExplanation", + "signature": "patchWorkforcemanagementAgentAdherenceExplanation(agentId, explanationId, body)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "explanationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateAdherenceExplanationStatusRequest", + "required": "true" + } + ], + "return": "AdherenceExplanationAsyncResponse" + }, + "PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}": { + "operationId": "patchworkforcemanagementbusinessunit", + "functionName": "patchWorkforcemanagementBusinessunit", + "signature": "patchWorkforcemanagementBusinessunit(businessUnitId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateBusinessUnitRequest", + "required": "false" + } + ], + "return": "BusinessUnitResponse" + }, + "PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}": { + "operationId": "patchworkforcemanagementbusinessunitactivitycode", + "functionName": "patchWorkforcemanagementBusinessunitActivitycode", + "signature": "patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "activityCodeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateActivityCodeRequest", + "required": "false" + } + ], + "return": "BusinessUnitActivityCode" + }, + "PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}": { + "operationId": "patchworkforcemanagementbusinessunitplanninggroup", + "functionName": "patchWorkforcemanagementBusinessunitPlanninggroup", + "signature": "patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "planningGroupId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdatePlanningGroupRequest", + "required": "false" + } + ], + "return": "PlanningGroup" + }, + "PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}": { + "operationId": "patchworkforcemanagementbusinessunitschedulingrun", + "functionName": "patchWorkforcemanagementBusinessunitSchedulingRun", + "signature": "patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "runId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchBuScheduleRunRequest", + "required": "false" + } + ] + }, + "PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}": { + "operationId": "patchworkforcemanagementbusinessunitservicegoaltemplate", + "functionName": "patchWorkforcemanagementBusinessunitServicegoaltemplate", + "signature": "patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "serviceGoalTemplateId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateServiceGoalTemplate", + "required": "false" + } + ], + "return": "ServiceGoalTemplate" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}": { + "operationId": "patchworkforcemanagementmanagementunit", + "functionName": "patchWorkforcemanagementManagementunit", + "signature": "patchWorkforcemanagementManagementunit(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateManagementUnitRequest", + "required": "false" + } + ], + "return": "ManagementUnit" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}": { + "operationId": "patchworkforcemanagementmanagementunittimeofflimit", + "functionName": "patchWorkforcemanagementManagementunitTimeofflimit", + "signature": "patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffLimitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateTimeOffLimitRequest", + "required": "false" + } + ], + "return": "TimeOffLimit" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}": { + "operationId": "patchworkforcemanagementmanagementunittimeoffplan", + "functionName": "patchWorkforcemanagementManagementunitTimeoffplan", + "signature": "patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffPlanId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateTimeOffPlanRequest", + "required": "false" + } + ], + "return": "TimeOffPlan" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus": { + "operationId": "patchworkforcemanagementmanagementunittimeoffrequestuserintegrationstatus", + "functionName": "patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus", + "signature": "patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetTimeOffIntegrationStatusRequest", + "required": "false" + } + ], + "return": "UserTimeOffIntegrationStatusResponse" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}": { + "operationId": "patchworkforcemanagementmanagementunitusertimeoffrequest", + "functionName": "patchWorkforcemanagementManagementunitUserTimeoffrequest", + "signature": "patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AdminTimeOffRequestPatch", + "required": "false" + } + ], + "return": "TimeOffRequestResponse" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}": { + "operationId": "patchworkforcemanagementmanagementunitweekshifttrade", + "functionName": "patchWorkforcemanagementManagementunitWeekShifttrade", + "signature": "patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "tradeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "PatchShiftTradeRequest", + "required": "true" + } + ], + "return": "ShiftTradeResponse" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}": { + "operationId": "patchworkforcemanagementmanagementunitworkplan", + "functionName": "patchWorkforcemanagementManagementunitWorkplan", + "signature": "patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, validationMode, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanId", + "type": "String", + "required": "true" + }, + { + "name": "validationMode", + "type": "String", + "required": "false" + }, + { + "name": "body", + "type": "WorkPlan", + "required": "false" + } + ], + "return": "WorkPlan" + }, + "PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}": { + "operationId": "patchworkforcemanagementmanagementunitworkplanrotation", + "functionName": "patchWorkforcemanagementManagementunitWorkplanrotation", + "signature": "patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanRotationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UpdateWorkPlanRotationRequest", + "required": "false" + } + ], + "return": "WorkPlanRotationResponse" + }, + "PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}": { + "operationId": "patchworkforcemanagementtimeoffrequest", + "functionName": "patchWorkforcemanagementTimeoffrequest", + "signature": "patchWorkforcemanagementTimeoffrequest(timeOffRequestId, body)", + "parameters": [ + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AgentTimeOffRequestPatch", + "required": "false" + } + ], + "return": "TimeOffRequestResponse" + }, + "POST /api/v2/workforcemanagement/adherence/explanations": { + "operationId": "postworkforcemanagementadherenceexplanations", + "functionName": "postWorkforcemanagementAdherenceExplanations", + "signature": "postWorkforcemanagementAdherenceExplanations(body)", + "parameters": [ + { + "name": "body", + "type": "AddAdherenceExplanationAgentRequest", + "required": "true" + } + ], + "return": "AdherenceExplanationAsyncResponse" + }, + "POST /api/v2/workforcemanagement/adherence/explanations/query": { + "operationId": "postworkforcemanagementadherenceexplanationsquery", + "functionName": "postWorkforcemanagementAdherenceExplanationsQuery", + "signature": "postWorkforcemanagementAdherenceExplanationsQuery(body, forceAsync, forceDownloadService)", + "parameters": [ + { + "name": "body", + "type": "AgentQueryAdherenceExplanationsRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "QueryAdherenceExplanationsResponse" + }, + "POST /api/v2/workforcemanagement/adherence/historical": { + "operationId": "postworkforcemanagementadherencehistorical", + "functionName": "postWorkforcemanagementAdherenceHistorical", + "signature": "postWorkforcemanagementAdherenceHistorical(body)", + "parameters": [ + { + "name": "body", + "type": "WfmHistoricalAdherenceQueryForUsers", + "required": "false" + } + ], + "return": "WfmHistoricalAdherenceResponse" + }, + "POST /api/v2/workforcemanagement/adherence/historical/bulk": { + "operationId": "postworkforcemanagementadherencehistoricalbulk", + "functionName": "postWorkforcemanagementAdherenceHistoricalBulk", + "signature": "postWorkforcemanagementAdherenceHistoricalBulk(body)", + "parameters": [ + { + "name": "body", + "type": "WfmHistoricalAdherenceBulkQuery", + "required": "false" + } + ], + "return": "WfmHistoricalAdherenceBulkResponse" + }, + "POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations": { + "operationId": "postworkforcemanagementagentadherenceexplanations", + "functionName": "postWorkforcemanagementAgentAdherenceExplanations", + "signature": "postWorkforcemanagementAgentAdherenceExplanations(agentId, body)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AddAdherenceExplanationAdminRequest", + "required": "true" + } + ], + "return": "AdherenceExplanationAsyncResponse" + }, + "POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query": { + "operationId": "postworkforcemanagementagentadherenceexplanationsquery", + "functionName": "postWorkforcemanagementAgentAdherenceExplanationsQuery", + "signature": "postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId, body, forceAsync, forceDownloadService)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AgentQueryAdherenceExplanationsRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "AgentQueryAdherenceExplanationsResponse" + }, + "POST /api/v2/workforcemanagement/agents": { + "operationId": "postworkforcemanagementagents", + "functionName": "postWorkforcemanagementAgents", + "signature": "postWorkforcemanagementAgents(body)", + "parameters": [ + { + "name": "body", + "type": "MoveAgentsRequest", + "required": "false" + } + ], + "return": "MoveAgentsResponse" + }, + "POST /api/v2/workforcemanagement/agents/integrations/hris/query": { + "operationId": "postworkforcemanagementagentsintegrationshrisquery", + "functionName": "postWorkforcemanagementAgentsIntegrationsHrisQuery", + "signature": "postWorkforcemanagementAgentsIntegrationsHrisQuery(body)", + "parameters": [ + { + "name": "body", + "type": "QueryAgentsIntegrationsRequest", + "required": "false" + } + ], + "return": "AgentsIntegrationsListing" + }, + "POST /api/v2/workforcemanagement/agents/me/possibleworkshifts": { + "operationId": "postworkforcemanagementagentsmepossibleworkshifts", + "functionName": "postWorkforcemanagementAgentsMePossibleworkshifts", + "signature": "postWorkforcemanagementAgentsMePossibleworkshifts(body)", + "parameters": [ + { + "name": "body", + "type": "AgentPossibleWorkShiftsRequest", + "required": "true" + } + ], + "return": "AgentPossibleWorkShiftsResponse" + }, + "POST /api/v2/workforcemanagement/agentschedules/mine": { + "operationId": "postworkforcemanagementagentschedulesmine", + "functionName": "postWorkforcemanagementAgentschedulesMine", + "signature": "postWorkforcemanagementAgentschedulesMine(body)", + "parameters": [ + { + "name": "body", + "type": "BuGetCurrentAgentScheduleRequest", + "required": "false" + } + ], + "return": "BuCurrentAgentScheduleSearchResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes": { + "operationId": "postworkforcemanagementbusinessunitactivitycodes", + "functionName": "postWorkforcemanagementBusinessunitActivitycodes", + "signature": "postWorkforcemanagementBusinessunitActivitycodes(businessUnitId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateActivityCodeRequest", + "required": "false" + } + ], + "return": "BusinessUnitActivityCode" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query": { + "operationId": "postworkforcemanagementbusinessunitadherenceexplanationsquery", + "functionName": "postWorkforcemanagementBusinessunitAdherenceExplanationsQuery", + "signature": "postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId, body, forceAsync, forceDownloadService)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "BuQueryAdherenceExplanationsRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "BuQueryAdherenceExplanationsResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search": { + "operationId": "postworkforcemanagementbusinessunitagentschedulessearch", + "functionName": "postWorkforcemanagementBusinessunitAgentschedulesSearch", + "signature": "postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, forceAsync, forceDownloadService, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "BuSearchAgentSchedulesRequest", + "required": "false" + } + ], + "return": "BuAsyncAgentSchedulesSearchResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday": { + "operationId": "postworkforcemanagementbusinessunitintraday", + "functionName": "postWorkforcemanagementBusinessunitIntraday", + "signature": "postWorkforcemanagementBusinessunitIntraday(businessUnitId, forceAsync, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "IntradayPlanningGroupRequest", + "required": "false" + } + ], + "return": "AsyncIntradayResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups": { + "operationId": "postworkforcemanagementbusinessunitplanninggroups", + "functionName": "postWorkforcemanagementBusinessunitPlanninggroups", + "signature": "postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreatePlanningGroupRequest", + "required": "false" + } + ], + "return": "PlanningGroup" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates": { + "operationId": "postworkforcemanagementbusinessunitservicegoaltemplates", + "functionName": "postWorkforcemanagementBusinessunitServicegoaltemplates", + "signature": "postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateServiceGoalTemplate", + "required": "false" + } + ], + "return": "ServiceGoalTemplate" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query": { + "operationId": "postworkforcemanagementbusinessunitweekscheduleagentschedulesquery", + "functionName": "postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery", + "signature": "postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId, weekId, scheduleId, body, forceAsync, forceDownloadService)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "BuQueryAgentSchedulesRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + } + ], + "return": "BuAsyncAgentSchedulesQueryResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy": { + "operationId": "postworkforcemanagementbusinessunitweekschedulecopy", + "functionName": "postWorkforcemanagementBusinessunitWeekScheduleCopy", + "signature": "postWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId, weekId, scheduleId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "BuCopyScheduleRequest", + "required": "true" + } + ], + "return": "BuAsyncScheduleResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule": { + "operationId": "postworkforcemanagementbusinessunitweekschedulereschedule", + "functionName": "postWorkforcemanagementBusinessunitWeekScheduleReschedule", + "signature": "postWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId, weekId, scheduleId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "BuRescheduleRequest", + "required": "true" + } + ], + "return": "BuAsyncScheduleRunResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update": { + "operationId": "postworkforcemanagementbusinessunitweekscheduleupdate", + "functionName": "postWorkforcemanagementBusinessunitWeekScheduleUpdate", + "signature": "postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId, weekId, scheduleId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ProcessScheduleUpdateUploadRequest", + "required": "true" + } + ], + "return": "BuAsyncScheduleResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl": { + "operationId": "postworkforcemanagementbusinessunitweekscheduleupdateuploadurl", + "functionName": "postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl", + "signature": "postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId, weekId, scheduleId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "scheduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UploadUrlRequestBody", + "required": "true" + } + ], + "return": "UpdateScheduleUploadResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules": { + "operationId": "postworkforcemanagementbusinessunitweekschedules", + "functionName": "postWorkforcemanagementBusinessunitWeekSchedules", + "signature": "postWorkforcemanagementBusinessunitWeekSchedules(businessUnitId, weekId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "BuCreateBlankScheduleRequest", + "required": "true" + } + ], + "return": "BuScheduleMetadata" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate": { + "operationId": "postworkforcemanagementbusinessunitweekschedulesgenerate", + "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesGenerate", + "signature": "postWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId, weekId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "BuGenerateScheduleRequest", + "required": "true" + } + ], + "return": "BuAsyncScheduleRunResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import": { + "operationId": "postworkforcemanagementbusinessunitweekschedulesimport", + "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesImport", + "signature": "postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId, weekId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "WfmProcessUploadRequest", + "required": "true" + } + ], + "return": "ScheduleUploadProcessingResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl": { + "operationId": "postworkforcemanagementbusinessunitweekschedulesimportuploadurl", + "functionName": "postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl", + "signature": "postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId, weekId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "UploadUrlRequestBody", + "required": "true" + } + ], + "return": "ImportScheduleUploadResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy": { + "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastcopy", + "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastCopy", + "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId, weekDateId, forecastId, body, forceAsync)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "forecastId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CopyBuForecastRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + } + ], + "return": "AsyncForecastOperationResult" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate": { + "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsgenerate", + "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate", + "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId, weekDateId, body, forceAsync)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "GenerateBuForecastRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + } + ], + "return": "AsyncForecastOperationResult" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import": { + "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsimport", + "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImport", + "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "WfmProcessUploadRequest", + "required": "true" + } + ], + "return": "ImportForecastResponse" + }, + "POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl": { + "operationId": "postworkforcemanagementbusinessunitweekshorttermforecastsimportuploadurl", + "functionName": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl", + "signature": "postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId, weekDateId, body)", + "parameters": [ + { + "name": "businessUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "UploadUrlRequestBody", + "required": "true" + } + ], + "return": "ImportForecastUploadResponse" + }, + "POST /api/v2/workforcemanagement/businessunits": { + "operationId": "postworkforcemanagementbusinessunits", + "functionName": "postWorkforcemanagementBusinessunits", + "signature": "postWorkforcemanagementBusinessunits(body)", + "parameters": [ + { + "name": "body", + "type": "CreateBusinessUnitRequest", + "required": "false" + } + ], + "return": "BusinessUnitResponse" + }, + "POST /api/v2/workforcemanagement/calendar/url/ics": { + "operationId": "postworkforcemanagementcalendarurlics", + "functionName": "postWorkforcemanagementCalendarUrlIcs", + "signature": "postWorkforcemanagementCalendarUrlIcs(language)", + "parameters": [ + { + "name": "language", + "type": "String", + "required": "false" + } + ], + "return": "CalendarUrlResponse" + }, + "POST /api/v2/workforcemanagement/historicaldata/deletejob": { + "operationId": "postworkforcemanagementhistoricaldatadeletejob", + "functionName": "postWorkforcemanagementHistoricaldataDeletejob", + "signature": "postWorkforcemanagementHistoricaldataDeletejob()", + + "return": "HistoricalImportDeleteJobResponse" + }, + "POST /api/v2/workforcemanagement/historicaldata/validate": { + "operationId": "postworkforcemanagementhistoricaldatavalidate", + "functionName": "postWorkforcemanagementHistoricaldataValidate", + "signature": "postWorkforcemanagementHistoricaldataValidate(body)", + "parameters": [ + { + "name": "body", + "type": "ValidationServiceRequest", + "required": "false" + } + ] + }, + "POST /api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs": { + "operationId": "postworkforcemanagementintegrationshritimeofftypesjobs", + "functionName": "postWorkforcemanagementIntegrationsHriTimeofftypesJobs", + "signature": "postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId)", + "parameters": [ + { + "name": "hrisIntegrationId", + "type": "String", + "required": "true" + } + ], + "return": "HrisTimeOffTypesResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search": { + "operationId": "postworkforcemanagementmanagementunitagentschedulessearch", + "functionName": "postWorkforcemanagementManagementunitAgentschedulesSearch", + "signature": "postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, forceAsync, forceDownloadService, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + }, + { + "name": "forceDownloadService", + "type": "Bool", + "required": "false" + }, + { + "name": "body", + "type": "BuSearchAgentSchedulesRequest", + "required": "false" + } + ], + "return": "BuAsyncAgentSchedulesSearchResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery": { + "operationId": "postworkforcemanagementmanagementunithistoricaladherencequery", + "functionName": "postWorkforcemanagementManagementunitHistoricaladherencequery", + "signature": "postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WfmHistoricalAdherenceQuery", + "required": "false" + } + ], + "return": "WfmHistoricalAdherenceResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/move": { + "operationId": "postworkforcemanagementmanagementunitmove", + "functionName": "postWorkforcemanagementManagementunitMove", + "signature": "postWorkforcemanagementManagementunitMove(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MoveManagementUnitRequest", + "required": "false" + } + ], + "return": "MoveManagementUnitResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search": { + "operationId": "postworkforcemanagementmanagementunitschedulessearch", + "functionName": "postWorkforcemanagementManagementunitSchedulesSearch", + "signature": "postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "UserListScheduleRequestBody", + "required": "false" + } + ], + "return": "UserScheduleContainer" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs": { + "operationId": "postworkforcemanagementmanagementunitshrinkagejobs", + "functionName": "postWorkforcemanagementManagementunitShrinkageJobs", + "signature": "postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WfmHistoricalShrinkageRequest", + "required": "false" + } + ], + "return": "WfmHistoricalShrinkageResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits": { + "operationId": "postworkforcemanagementmanagementunittimeofflimits", + "functionName": "postWorkforcemanagementManagementunitTimeofflimits", + "signature": "postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateTimeOffLimitRequest", + "required": "false" + } + ], + "return": "TimeOffLimit" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query": { + "operationId": "postworkforcemanagementmanagementunittimeofflimitsvaluesquery", + "functionName": "postWorkforcemanagementManagementunitTimeofflimitsValuesQuery", + "signature": "postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueryTimeOffLimitValuesRequest", + "required": "false" + } + ], + "return": "QueryTimeOffLimitValuesResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans": { + "operationId": "postworkforcemanagementmanagementunittimeoffplans", + "functionName": "postWorkforcemanagementManagementunitTimeoffplans", + "signature": "postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateTimeOffPlanRequest", + "required": "false" + } + ], + "return": "TimeOffPlan" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests": { + "operationId": "postworkforcemanagementmanagementunittimeoffrequests", + "functionName": "postWorkforcemanagementManagementunitTimeoffrequests", + "signature": "postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CreateAdminTimeOffRequest", + "required": "false" + } + ], + "return": "TimeOffRequestList" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query": { + "operationId": "postworkforcemanagementmanagementunittimeoffrequestsintegrationstatusquery", + "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery", + "signature": "postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueryTimeOffIntegrationStatusRequest", + "required": "false" + } + ], + "return": "UserTimeOffIntegrationStatusResponseListing" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query": { + "operationId": "postworkforcemanagementmanagementunittimeoffrequestsquery", + "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsQuery", + "signature": "postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TimeOffRequestQueryBody", + "required": "false" + } + ], + "return": "TimeOffRequestListing" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query": { + "operationId": "postworkforcemanagementmanagementunittimeoffrequestswaitlistpositionsquery", + "functionName": "postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery", + "signature": "postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "QueryWaitlistPositionsRequest", + "required": "false" + } + ], + "return": "WaitlistPositionListing" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs": { + "operationId": "postworkforcemanagementmanagementunitusertimeoffbalancejobs", + "functionName": "postWorkforcemanagementManagementunitUserTimeoffbalanceJobs", + "signature": "postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId, userId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "TimeOffBalanceRequest", + "required": "true" + } + ], + "return": "TimeOffBalancesResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs": { + "operationId": "postworkforcemanagementmanagementunitusertimeoffrequesttimeoffbalancejobs", + "functionName": "postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs", + "signature": "postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId, userId, timeOffRequestId)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffRequestId", + "type": "String", + "required": "true" + } + ], + "return": "TimeOffBalancesResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate": { + "operationId": "postworkforcemanagementmanagementunitusertimeoffrequestsestimate", + "functionName": "postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate", + "signature": "postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "userId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "EstimateAvailableTimeOffRequest", + "required": "false" + } + ], + "return": "EstimateAvailableTimeOffResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match": { + "operationId": "postworkforcemanagementmanagementunitweekshifttradematch", + "functionName": "postWorkforcemanagementManagementunitWeekShifttradeMatch", + "signature": "postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "tradeId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MatchShiftTradeRequest", + "required": "true" + } + ], + "return": "MatchShiftTradeResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades": { + "operationId": "postworkforcemanagementmanagementunitweekshifttrades", + "functionName": "postWorkforcemanagementManagementunitWeekShifttrades", + "signature": "postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "AddShiftTradeRequest", + "required": "true" + } + ], + "return": "ShiftTradeResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search": { + "operationId": "postworkforcemanagementmanagementunitweekshifttradessearch", + "functionName": "postWorkforcemanagementManagementunitWeekShifttradesSearch", + "signature": "postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "SearchShiftTradesRequest", + "required": "true" + } + ], + "return": "SearchShiftTradesResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk": { + "operationId": "postworkforcemanagementmanagementunitweekshifttradesstatebulk", + "functionName": "postWorkforcemanagementManagementunitWeekShifttradesStateBulk", + "signature": "postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, forceAsync)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "weekDateId", + "type": "Date", + "required": "true" + }, + { + "name": "body", + "type": "BulkShiftTradeStateUpdateRequest", + "required": "true" + }, + { + "name": "forceAsync", + "type": "Bool", + "required": "false" + } + ], + "return": "BulkUpdateShiftTradeStateResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy": { + "operationId": "postworkforcemanagementmanagementunitworkplancopy", + "functionName": "postWorkforcemanagementManagementunitWorkplanCopy", + "signature": "postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CopyWorkPlan", + "required": "false" + } + ], + "return": "WorkPlan" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate": { + "operationId": "postworkforcemanagementmanagementunitworkplanvalidate", + "functionName": "postWorkforcemanagementManagementunitWorkplanValidate", + "signature": "postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, expand, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanId", + "type": "String", + "required": "true" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + }, + { + "name": "body", + "type": "WorkPlanValidationRequest", + "required": "false" + } + ], + "return": "ValidateWorkPlanResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy": { + "operationId": "postworkforcemanagementmanagementunitworkplanrotationcopy", + "functionName": "postWorkforcemanagementManagementunitWorkplanrotationCopy", + "signature": "postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "workPlanRotationId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "CopyWorkPlanRotationRequest", + "required": "false" + } + ], + "return": "WorkPlanRotationResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations": { + "operationId": "postworkforcemanagementmanagementunitworkplanrotations", + "functionName": "postWorkforcemanagementManagementunitWorkplanrotations", + "signature": "postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AddWorkPlanRotationRequest", + "required": "false" + } + ], + "return": "WorkPlanRotationResponse" + }, + "POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans": { + "operationId": "postworkforcemanagementmanagementunitworkplans", + "functionName": "postWorkforcemanagementManagementunitWorkplans", + "signature": "postWorkforcemanagementManagementunitWorkplans(managementUnitId, validationMode, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "validationMode", + "type": "String", + "required": "false" + }, + { + "name": "body", + "type": "CreateWorkPlan", + "required": "false" + } + ], + "return": "WorkPlan" + }, + "POST /api/v2/workforcemanagement/managementunits": { + "operationId": "postworkforcemanagementmanagementunits", + "functionName": "postWorkforcemanagementManagementunits", + "signature": "postWorkforcemanagementManagementunits(body)", + "parameters": [ + { + "name": "body", + "type": "CreateManagementUnitApiRequest", + "required": "false" + } + ], + "return": "ManagementUnit" + }, + "POST /api/v2/workforcemanagement/notifications/update": { + "operationId": "postworkforcemanagementnotificationsupdate", + "functionName": "postWorkforcemanagementNotificationsUpdate", + "signature": "postWorkforcemanagementNotificationsUpdate(body)", + "parameters": [ + { + "name": "body", + "type": "UpdateNotificationsRequest", + "required": "false" + } + ], + "return": "UpdateNotificationsResponse" + }, + "POST /api/v2/workforcemanagement/schedules": { + "operationId": "postworkforcemanagementschedules", + "functionName": "postWorkforcemanagementSchedules", + "signature": "postWorkforcemanagementSchedules(body)", + "parameters": [ + { + "name": "body", + "type": "CurrentUserScheduleRequestBody", + "required": "false" + } + ], + "return": "UserScheduleContainer" + }, + "POST /api/v2/workforcemanagement/teams/{teamId}/adherence/historical": { + "operationId": "postworkforcemanagementteamadherencehistorical", + "functionName": "postWorkforcemanagementTeamAdherenceHistorical", + "signature": "postWorkforcemanagementTeamAdherenceHistorical(teamId, body)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WfmHistoricalAdherenceQueryForTeams", + "required": "false" + } + ], + "return": "WfmHistoricalAdherenceResponse" + }, + "POST /api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs": { + "operationId": "postworkforcemanagementteamshrinkagejobs", + "functionName": "postWorkforcemanagementTeamShrinkageJobs", + "signature": "postWorkforcemanagementTeamShrinkageJobs(teamId, body)", + "parameters": [ + { + "name": "teamId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "WfmHistoricalShrinkageTeamsRequest", + "required": "false" + } + ], + "return": "WfmHistoricalShrinkageResponse" + }, + "POST /api/v2/workforcemanagement/timeoffbalance/jobs": { + "operationId": "postworkforcemanagementtimeoffbalancejobs", + "functionName": "postWorkforcemanagementTimeoffbalanceJobs", + "signature": "postWorkforcemanagementTimeoffbalanceJobs(body)", + "parameters": [ + { + "name": "body", + "type": "TimeOffBalanceRequest", + "required": "true" + } + ], + "return": "TimeOffBalancesResponse" + }, + "POST /api/v2/workforcemanagement/timeofflimits/available/query": { + "operationId": "postworkforcemanagementtimeofflimitsavailablequery", + "functionName": "postWorkforcemanagementTimeofflimitsAvailableQuery", + "signature": "postWorkforcemanagementTimeofflimitsAvailableQuery(body)", + "parameters": [ + { + "name": "body", + "type": "AvailableTimeOffRequest", + "required": "false" + } + ], + "return": "AvailableTimeOffResponse" + }, + "POST /api/v2/workforcemanagement/timeoffrequests": { + "operationId": "postworkforcemanagementtimeoffrequests", + "functionName": "postWorkforcemanagementTimeoffrequests", + "signature": "postWorkforcemanagementTimeoffrequests(body)", + "parameters": [ + { + "name": "body", + "type": "CreateAgentTimeOffRequest", + "required": "false" + } + ], + "return": "TimeOffRequestResponse" + }, + "POST /api/v2/workforcemanagement/timeoffrequests/estimate": { + "operationId": "postworkforcemanagementtimeoffrequestsestimate", + "functionName": "postWorkforcemanagementTimeoffrequestsEstimate", + "signature": "postWorkforcemanagementTimeoffrequestsEstimate(body)", + "parameters": [ + { + "name": "body", + "type": "EstimateAvailableTimeOffRequest", + "required": "false" + } + ], + "return": "EstimateAvailableTimeOffResponse" + }, + "POST /api/v2/workforcemanagement/timeoffrequests/integrationstatus/query": { + "operationId": "postworkforcemanagementtimeoffrequestsintegrationstatusquery", + "functionName": "postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery", + "signature": "postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body)", + "parameters": [ + { + "name": "body", + "type": "CurrentUserTimeOffIntegrationStatusRequest", + "required": "false" + } + ], + "return": "TimeOffIntegrationStatusResponseListing" + }, + "PUT /api/v2/workforcemanagement/agents/{agentId}/integrations/hris": { + "operationId": "putworkforcemanagementagentintegrationshris", + "functionName": "putWorkforcemanagementAgentIntegrationsHris", + "signature": "putWorkforcemanagementAgentIntegrationsHris(agentId, body)", + "parameters": [ + { + "name": "agentId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "AgentIntegrationsRequest", + "required": "true" + } + ], + "return": "AgentIntegrationsResponse" + }, + "PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values": { + "operationId": "putworkforcemanagementmanagementunittimeofflimitvalues", + "functionName": "putWorkforcemanagementManagementunitTimeofflimitValues", + "signature": "putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, body)", + "parameters": [ + { + "name": "managementUnitId", + "type": "String", + "required": "true" + }, + { + "name": "timeOffLimitId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "SetTimeOffLimitValuesRequest", + "required": "false" + } + ], + "return": "TimeOffLimit" + } + +} \ No newline at end of file diff --git a/build/docs/deleteAlertingAlert-example.txt b/build/docs/deleteAlertingAlert-example.txt new file mode 100644 index 000000000..40a711367 --- /dev/null +++ b/build/docs/deleteAlertingAlert-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID + +// Delete an alert +DeleteAlertingAlertRequest.deleteAlertingAlert(alertId: alertId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAlertingAlertRequest.deleteAlertingAlert was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAlertingInteractionstatsAlert-example.txt b/build/docs/deleteAlertingInteractionstatsAlert-example.txt new file mode 100644 index 000000000..4a2568a2f --- /dev/null +++ b/build/docs/deleteAlertingInteractionstatsAlert-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID + +// Delete an interaction stats alert +DeleteAlertingInteractionstatsAlertRequest.deleteAlertingInteractionstatsAlert(alertId: alertId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAlertingInteractionstatsAlertRequest.deleteAlertingInteractionstatsAlert was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAlertingInteractionstatsRule-example.txt b/build/docs/deleteAlertingInteractionstatsRule-example.txt new file mode 100644 index 000000000..2696d5729 --- /dev/null +++ b/build/docs/deleteAlertingInteractionstatsRule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule ID + +// Delete an interaction stats rule. +DeleteAlertingInteractionstatsRuleRequest.deleteAlertingInteractionstatsRule(ruleId: ruleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAlertingInteractionstatsRuleRequest.deleteAlertingInteractionstatsRule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAlertingRule-example.txt b/build/docs/deleteAlertingRule-example.txt new file mode 100644 index 000000000..b80edb55a --- /dev/null +++ b/build/docs/deleteAlertingRule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule Id + +// Delete a rule. +DeleteAlertingRuleRequest.deleteAlertingRule(ruleId: ruleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAlertingRuleRequest.deleteAlertingRule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAnalyticsConversationsDetailsJob-example.txt b/build/docs/deleteAnalyticsConversationsDetailsJob-example.txt new file mode 100644 index 000000000..d79d1cb71 --- /dev/null +++ b/build/docs/deleteAnalyticsConversationsDetailsJob-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Delete/cancel an async details job +DeleteAnalyticsConversationsDetailsJobRequest.deleteAnalyticsConversationsDetailsJob(jobId: jobId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAnalyticsConversationsDetailsJobRequest.deleteAnalyticsConversationsDetailsJob was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAnalyticsReportingSchedule-example.txt b/build/docs/deleteAnalyticsReportingSchedule-example.txt new file mode 100644 index 000000000..051cf71de --- /dev/null +++ b/build/docs/deleteAnalyticsReportingSchedule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Delete a scheduled report job. +DeleteAnalyticsReportingScheduleRequest.deleteAnalyticsReportingSchedule(scheduleId: scheduleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAnalyticsReportingScheduleRequest.deleteAnalyticsReportingSchedule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAnalyticsUsersDetailsJob-example.txt b/build/docs/deleteAnalyticsUsersDetailsJob-example.txt new file mode 100644 index 000000000..e4b8334e3 --- /dev/null +++ b/build/docs/deleteAnalyticsUsersDetailsJob-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Delete/cancel an async request +DeleteAnalyticsUsersDetailsJobRequest.deleteAnalyticsUsersDetailsJob(jobId: jobId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAnalyticsUsersDetailsJobRequest.deleteAnalyticsUsersDetailsJob was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectEmergencygroup-example.txt b/build/docs/deleteArchitectEmergencygroup-example.txt new file mode 100644 index 000000000..5e7f01751 --- /dev/null +++ b/build/docs/deleteArchitectEmergencygroup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emergencyGroupId: String = "" // Emergency group ID + +// Deletes a emergency group by ID +DeleteArchitectEmergencygroupRequest.deleteArchitectEmergencygroup(emergencyGroupId: emergencyGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectEmergencygroupRequest.deleteArchitectEmergencygroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectIvr-example.txt b/build/docs/deleteArchitectIvr-example.txt new file mode 100644 index 000000000..cd545e7c2 --- /dev/null +++ b/build/docs/deleteArchitectIvr-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ivrId: String = "" // IVR id + +// Delete an IVR Config. +DeleteArchitectIvrRequest.deleteArchitectIvr(ivrId: ivrId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectIvrRequest.deleteArchitectIvr was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectPrompt-example.txt b/build/docs/deleteArchitectPrompt-example.txt new file mode 100644 index 000000000..a4e5ae86f --- /dev/null +++ b/build/docs/deleteArchitectPrompt-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let allResources: Bool = true // Whether or not to delete all the prompt resources + +// Delete specified user prompt +DeleteArchitectPromptRequest.deleteArchitectPrompt(promptId: promptId, allResources: allResources) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectPromptRequest.deleteArchitectPrompt was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectPromptResource-example.txt b/build/docs/deleteArchitectPromptResource-example.txt new file mode 100644 index 000000000..dae77a35a --- /dev/null +++ b/build/docs/deleteArchitectPromptResource-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language + +// Delete specified user prompt resource +DeleteArchitectPromptResourceRequest.deleteArchitectPromptResource(promptId: promptId, languageCode: languageCode) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectPromptResourceRequest.deleteArchitectPromptResource was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectPromptResourceAudio-example.txt b/build/docs/deleteArchitectPromptResourceAudio-example.txt new file mode 100644 index 000000000..2ebce5f97 --- /dev/null +++ b/build/docs/deleteArchitectPromptResourceAudio-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language + +// Delete specified user prompt resource audio +DeleteArchitectPromptResourceAudioRequest.deleteArchitectPromptResourceAudio(promptId: promptId, languageCode: languageCode) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectPromptResourceAudioRequest.deleteArchitectPromptResourceAudio was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectPrompts-example.txt b/build/docs/deleteArchitectPrompts-example.txt new file mode 100644 index 000000000..20ec227c5 --- /dev/null +++ b/build/docs/deleteArchitectPrompts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // List of Prompt IDs + +// Batch-delete a list of prompts +DeleteArchitectPromptsRequest.deleteArchitectPrompts(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteArchitectPromptsRequest.deleteArchitectPrompts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectSchedule-example.txt b/build/docs/deleteArchitectSchedule-example.txt new file mode 100644 index 000000000..8cba08d2e --- /dev/null +++ b/build/docs/deleteArchitectSchedule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Delete a schedule by id +DeleteArchitectScheduleRequest.deleteArchitectSchedule(scheduleId: scheduleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectScheduleRequest.deleteArchitectSchedule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectSchedulegroup-example.txt b/build/docs/deleteArchitectSchedulegroup-example.txt new file mode 100644 index 000000000..660fcc3a6 --- /dev/null +++ b/build/docs/deleteArchitectSchedulegroup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleGroupId: String = "" // Schedule group ID + +// Deletes a schedule group by ID +DeleteArchitectSchedulegroupRequest.deleteArchitectSchedulegroup(scheduleGroupId: scheduleGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectSchedulegroupRequest.deleteArchitectSchedulegroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteArchitectSystempromptResource-example.txt b/build/docs/deleteArchitectSystempromptResource-example.txt new file mode 100644 index 000000000..f40e6aca1 --- /dev/null +++ b/build/docs/deleteArchitectSystempromptResource-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language + +// Delete a system prompt resource override. +DeleteArchitectSystempromptResourceRequest.deleteArchitectSystempromptResource(promptId: promptId, languageCode: languageCode) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteArchitectSystempromptResourceRequest.deleteArchitectSystempromptResource was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAuthorizationDivision-example.txt b/build/docs/deleteAuthorizationDivision-example.txt new file mode 100644 index 000000000..bd834b92b --- /dev/null +++ b/build/docs/deleteAuthorizationDivision-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let force: Bool = true // Force delete this division as well as the grants and objects associated with it + +// Delete a division. +DeleteAuthorizationDivisionRequest.deleteAuthorizationDivision(divisionId: divisionId, force: force) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAuthorizationDivisionRequest.deleteAuthorizationDivision was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAuthorizationRole-example.txt b/build/docs/deleteAuthorizationRole-example.txt new file mode 100644 index 000000000..c30ac4718 --- /dev/null +++ b/build/docs/deleteAuthorizationRole-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID + +// Delete an organization role. +DeleteAuthorizationRoleRequest.deleteAuthorizationRole(roleId: roleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAuthorizationRoleRequest.deleteAuthorizationRole was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteAuthorizationSubjectDivisionRole-example.txt b/build/docs/deleteAuthorizationSubjectDivisionRole-example.txt new file mode 100644 index 000000000..a2e2e6b2a --- /dev/null +++ b/build/docs/deleteAuthorizationSubjectDivisionRole-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let divisionId: String = "" // the id of the division of the grant +let roleId: String = "" // the id of the role of the grant + +// Delete a grant of a role in a division +DeleteAuthorizationSubjectDivisionRoleRequest.deleteAuthorizationSubjectDivisionRole(subjectId: subjectId, divisionId: divisionId, roleId: roleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteAuthorizationSubjectDivisionRoleRequest.deleteAuthorizationSubjectDivisionRole was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteCoachingAppointment-example.txt b/build/docs/deleteCoachingAppointment-example.txt new file mode 100644 index 000000000..c91f576d9 --- /dev/null +++ b/build/docs/deleteCoachingAppointment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. + +// Delete an existing appointment +DeleteCoachingAppointmentRequest.deleteCoachingAppointment(appointmentId: appointmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteCoachingAppointmentRequest.deleteCoachingAppointment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteCoachingAppointmentAnnotation-example.txt b/build/docs/deleteCoachingAppointmentAnnotation-example.txt new file mode 100644 index 000000000..d98a5d7d6 --- /dev/null +++ b/build/docs/deleteCoachingAppointmentAnnotation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let annotationId: String = "" // The ID of the annotation. + +// Delete an existing annotation +DeleteCoachingAppointmentAnnotationRequest.deleteCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteCoachingAppointmentAnnotationRequest.deleteCoachingAppointmentAnnotation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementDocument-example.txt b/build/docs/deleteContentmanagementDocument-example.txt new file mode 100644 index 000000000..807ab807d --- /dev/null +++ b/build/docs/deleteContentmanagementDocument-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let _override: Bool = true // Override any lock on the document + +// Delete a document. +DeleteContentmanagementDocumentRequest.deleteContentmanagementDocument(documentId: documentId, _override: _override) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementDocumentRequest.deleteContentmanagementDocument was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementShare-example.txt b/build/docs/deleteContentmanagementShare-example.txt new file mode 100644 index 000000000..baf79df9b --- /dev/null +++ b/build/docs/deleteContentmanagementShare-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let shareId: String = "" // Share ID + +// Deletes an existing share. +DeleteContentmanagementShareRequest.deleteContentmanagementShare(shareId: shareId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementShareRequest.deleteContentmanagementShare was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementStatusStatusId-example.txt b/build/docs/deleteContentmanagementStatusStatusId-example.txt new file mode 100644 index 000000000..b9931d2cc --- /dev/null +++ b/build/docs/deleteContentmanagementStatusStatusId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let statusId: String = "" // Status ID + +// Cancel the command for this status +DeleteContentmanagementStatusStatusIdRequest.deleteContentmanagementStatusStatusId(statusId: statusId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementStatusStatusIdRequest.deleteContentmanagementStatusStatusId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementWorkspace-example.txt b/build/docs/deleteContentmanagementWorkspace-example.txt new file mode 100644 index 000000000..232f5038f --- /dev/null +++ b/build/docs/deleteContentmanagementWorkspace-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let moveChildrenToWorkspaceId: String = "" // New location for objects in deleted workspace. + +// Delete a workspace +DeleteContentmanagementWorkspaceRequest.deleteContentmanagementWorkspace(workspaceId: workspaceId, moveChildrenToWorkspaceId: moveChildrenToWorkspaceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementWorkspaceRequest.deleteContentmanagementWorkspace was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementWorkspaceMember-example.txt b/build/docs/deleteContentmanagementWorkspaceMember-example.txt new file mode 100644 index 000000000..36b0f1ef4 --- /dev/null +++ b/build/docs/deleteContentmanagementWorkspaceMember-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let memberId: String = "" // Member ID + +// Delete a member from a workspace +DeleteContentmanagementWorkspaceMemberRequest.deleteContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementWorkspaceMemberRequest.deleteContentmanagementWorkspaceMember was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteContentmanagementWorkspaceTagvalue-example.txt b/build/docs/deleteContentmanagementWorkspaceTagvalue-example.txt new file mode 100644 index 000000000..8675947de --- /dev/null +++ b/build/docs/deleteContentmanagementWorkspaceTagvalue-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let tagId: String = "" // Tag ID + +// Delete workspace tag +DeleteContentmanagementWorkspaceTagvalueRequest.deleteContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteContentmanagementWorkspaceTagvalueRequest.deleteContentmanagementWorkspaceTagvalue was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationParticipantCode-example.txt b/build/docs/deleteConversationParticipantCode-example.txt new file mode 100644 index 000000000..530a87ca8 --- /dev/null +++ b/build/docs/deleteConversationParticipantCode-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let addCommunicationCode: String = "" // addCommunicationCode + +// Delete a code used to add a communication to this participant +DeleteConversationParticipantCodeRequest.deleteConversationParticipantCode(conversationId: conversationId, participantId: participantId, addCommunicationCode: addCommunicationCode) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationParticipantCodeRequest.deleteConversationParticipantCode was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationParticipantFlaggedreason-example.txt b/build/docs/deleteConversationParticipantFlaggedreason-example.txt new file mode 100644 index 000000000..2277e393a --- /dev/null +++ b/build/docs/deleteConversationParticipantFlaggedreason-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID + +// Remove flagged reason from conversation participant. +DeleteConversationParticipantFlaggedreasonRequest.deleteConversationParticipantFlaggedreason(conversationId: conversationId, participantId: participantId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationParticipantFlaggedreasonRequest.deleteConversationParticipantFlaggedreason was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationRecordingAnnotation-example.txt b/build/docs/deleteConversationRecordingAnnotation-example.txt new file mode 100644 index 000000000..53ec6b4be --- /dev/null +++ b/build/docs/deleteConversationRecordingAnnotation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let annotationId: String = "" // Annotation ID + +// Delete annotation +DeleteConversationRecordingAnnotationRequest.deleteConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationRecordingAnnotationRequest.deleteConversationRecordingAnnotation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsCallParticipantConsult-example.txt b/build/docs/deleteConversationsCallParticipantConsult-example.txt new file mode 100644 index 000000000..ab4e4c9f0 --- /dev/null +++ b/build/docs/deleteConversationsCallParticipantConsult-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Cancel the transfer +DeleteConversationsCallParticipantConsultRequest.deleteConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsCallParticipantConsultRequest.deleteConversationsCallParticipantConsult was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsEmailMessagesDraftAttachment-example.txt b/build/docs/deleteConversationsEmailMessagesDraftAttachment-example.txt new file mode 100644 index 000000000..f0c87c9fd --- /dev/null +++ b/build/docs/deleteConversationsEmailMessagesDraftAttachment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let attachmentId: String = "" // attachmentId + +// Delete attachment from draft +DeleteConversationsEmailMessagesDraftAttachmentRequest.deleteConversationsEmailMessagesDraftAttachment(conversationId: conversationId, attachmentId: attachmentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsEmailMessagesDraftAttachmentRequest.deleteConversationsEmailMessagesDraftAttachment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagesCachedmediaCachedMediaItemId-example.txt b/build/docs/deleteConversationsMessagesCachedmediaCachedMediaItemId-example.txt new file mode 100644 index 000000000..537469543 --- /dev/null +++ b/build/docs/deleteConversationsMessagesCachedmediaCachedMediaItemId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let cachedMediaItemId: String = "" // cachedMediaItemId + +// Remove a cached media item asychronously +DeleteConversationsMessagesCachedmediaCachedMediaItemIdRequest.deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId: cachedMediaItemId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagesCachedmediaCachedMediaItemIdRequest.deleteConversationsMessagesCachedmediaCachedMediaItemId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsFacebookIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsFacebookIntegrationId-example.txt new file mode 100644 index 000000000..a59079a5d --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsFacebookIntegrationId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete a Facebook messaging integration +DeleteConversationsMessagingIntegrationsFacebookIntegrationIdRequest.deleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingIntegrationsFacebookIntegrationIdRequest.deleteConversationsMessagingIntegrationsFacebookIntegrationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsInstagramIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsInstagramIntegrationId-example.txt new file mode 100644 index 000000000..b1c9cc567 --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsInstagramIntegrationId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete Instagram messaging integration +DeleteConversationsMessagingIntegrationsInstagramIntegrationIdRequest.deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingIntegrationsInstagramIntegrationIdRequest.deleteConversationsMessagingIntegrationsInstagramIntegrationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsLineIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsLineIntegrationId-example.txt new file mode 100644 index 000000000..538c3958b --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsLineIntegrationId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete a LINE messenger integration +DeleteConversationsMessagingIntegrationsLineIntegrationIdRequest.deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingIntegrationsLineIntegrationIdRequest.deleteConversationsMessagingIntegrationsLineIntegrationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsOpenIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsOpenIntegrationId-example.txt new file mode 100644 index 000000000..fd2a9f9ee --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsOpenIntegrationId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete an Open messaging integration +DeleteConversationsMessagingIntegrationsOpenIntegrationIdRequest.deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingIntegrationsOpenIntegrationIdRequest.deleteConversationsMessagingIntegrationsOpenIntegrationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsTwitterIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsTwitterIntegrationId-example.txt new file mode 100644 index 000000000..1ea79b4fc --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsTwitterIntegrationId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete a Twitter messaging integration +DeleteConversationsMessagingIntegrationsTwitterIntegrationIdRequest.deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingIntegrationsTwitterIntegrationIdRequest.deleteConversationsMessagingIntegrationsTwitterIntegrationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt b/build/docs/deleteConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt new file mode 100644 index 000000000..162e89414 --- /dev/null +++ b/build/docs/deleteConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID + +// Delete a WhatsApp messaging integration +DeleteConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.deleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.deleteConversationsMessagingIntegrationsWhatsappIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingSetting-example.txt b/build/docs/deleteConversationsMessagingSetting-example.txt new file mode 100644 index 000000000..b3962f527 --- /dev/null +++ b/build/docs/deleteConversationsMessagingSetting-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Setting ID + +// Delete a messaging setting +DeleteConversationsMessagingSettingRequest.deleteConversationsMessagingSetting(messageSettingId: messageSettingId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingSettingRequest.deleteConversationsMessagingSetting was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingSettingsDefault-example.txt b/build/docs/deleteConversationsMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..fa7d00a64 --- /dev/null +++ b/build/docs/deleteConversationsMessagingSettingsDefault-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete the organization's default setting, a global default will be applied to integrations without settings +DeleteConversationsMessagingSettingsDefaultRequest.deleteConversationsMessagingSettingsDefault() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingSettingsDefaultRequest.deleteConversationsMessagingSettingsDefault was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteConversationsMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/deleteConversationsMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..92181a6ab --- /dev/null +++ b/build/docs/deleteConversationsMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID + +// Delete a supported content profile +DeleteConversationsMessagingSupportedcontentSupportedContentIdRequest.deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteConversationsMessagingSupportedcontentSupportedContentIdRequest.deleteConversationsMessagingSupportedcontentSupportedContentId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteEmployeeperformanceExternalmetricsDefinition-example.txt b/build/docs/deleteEmployeeperformanceExternalmetricsDefinition-example.txt new file mode 100644 index 000000000..035ac902b --- /dev/null +++ b/build/docs/deleteEmployeeperformanceExternalmetricsDefinition-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let metricId: String = "" // Specifies the External Metric Definition ID + +// Delete an External Metric Definition +DeleteEmployeeperformanceExternalmetricsDefinitionRequest.deleteEmployeeperformanceExternalmetricsDefinition(metricId: metricId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteEmployeeperformanceExternalmetricsDefinitionRequest.deleteEmployeeperformanceExternalmetricsDefinition was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsContact-example.txt b/build/docs/deleteExternalcontactsContact-example.txt new file mode 100644 index 000000000..81e17dc43 --- /dev/null +++ b/build/docs/deleteExternalcontactsContact-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID + +// Delete an external contact +DeleteExternalcontactsContactRequest.deleteExternalcontactsContact(contactId: contactId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteExternalcontactsContactRequest.deleteExternalcontactsContact was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsContactNote-example.txt b/build/docs/deleteExternalcontactsContactNote-example.txt new file mode 100644 index 000000000..4f18e31ae --- /dev/null +++ b/build/docs/deleteExternalcontactsContactNote-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact Id +let noteId: String = "" // Note Id + +// Delete a note for an external contact +DeleteExternalcontactsContactNoteRequest.deleteExternalcontactsContactNote(contactId: contactId, noteId: noteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteExternalcontactsContactNoteRequest.deleteExternalcontactsContactNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsContactsSchema-example.txt b/build/docs/deleteExternalcontactsContactsSchema-example.txt new file mode 100644 index 000000000..6a560c437 --- /dev/null +++ b/build/docs/deleteExternalcontactsContactsSchema-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID + +// Delete a schema +DeleteExternalcontactsContactsSchemaRequest.deleteExternalcontactsContactsSchema(schemaId: schemaId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteExternalcontactsContactsSchemaRequest.deleteExternalcontactsContactsSchema was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsOrganization-example.txt b/build/docs/deleteExternalcontactsOrganization-example.txt new file mode 100644 index 000000000..f251c60bf --- /dev/null +++ b/build/docs/deleteExternalcontactsOrganization-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID + +// Delete an external organization +DeleteExternalcontactsOrganizationRequest.deleteExternalcontactsOrganization(externalOrganizationId: externalOrganizationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteExternalcontactsOrganizationRequest.deleteExternalcontactsOrganization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsOrganizationNote-example.txt b/build/docs/deleteExternalcontactsOrganizationNote-example.txt new file mode 100644 index 000000000..9b12f0f6d --- /dev/null +++ b/build/docs/deleteExternalcontactsOrganizationNote-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization Id +let noteId: String = "" // Note Id + +// Delete a note for an external organization +DeleteExternalcontactsOrganizationNoteRequest.deleteExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteExternalcontactsOrganizationNoteRequest.deleteExternalcontactsOrganizationNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsOrganizationTrustor-example.txt b/build/docs/deleteExternalcontactsOrganizationTrustor-example.txt new file mode 100644 index 000000000..219a4a2e6 --- /dev/null +++ b/build/docs/deleteExternalcontactsOrganizationTrustor-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID + +// Unlink the Trustor for this External Organization +DeleteExternalcontactsOrganizationTrustorRequest.deleteExternalcontactsOrganizationTrustor(externalOrganizationId: externalOrganizationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteExternalcontactsOrganizationTrustorRequest.deleteExternalcontactsOrganizationTrustor was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteExternalcontactsRelationship-example.txt b/build/docs/deleteExternalcontactsRelationship-example.txt new file mode 100644 index 000000000..007f14f7a --- /dev/null +++ b/build/docs/deleteExternalcontactsRelationship-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let relationshipId: String = "" // Relationship Id + +// Delete a relationship +DeleteExternalcontactsRelationshipRequest.deleteExternalcontactsRelationship(relationshipId: relationshipId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteExternalcontactsRelationshipRequest.deleteExternalcontactsRelationship was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteFaxDocument-example.txt b/build/docs/deleteFaxDocument-example.txt new file mode 100644 index 000000000..41fc9e69b --- /dev/null +++ b/build/docs/deleteFaxDocument-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID + +// Delete a fax document. +DeleteFaxDocumentRequest.deleteFaxDocument(documentId: documentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteFaxDocumentRequest.deleteFaxDocument was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteFlow-example.txt b/build/docs/deleteFlow-example.txt new file mode 100644 index 000000000..3ff82d1eb --- /dev/null +++ b/build/docs/deleteFlow-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID + +// Delete flow +DeleteFlowRequest.deleteFlow(flowId: flowId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteFlowRequest.deleteFlow was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteFlows-example.txt b/build/docs/deleteFlows-example.txt new file mode 100644 index 000000000..ba53dc0e4 --- /dev/null +++ b/build/docs/deleteFlows-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // List of Flow IDs + +// Batch-delete a list of flows +DeleteFlowsRequest.deleteFlows(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteFlowsRequest.deleteFlows was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteFlowsDatatable-example.txt b/build/docs/deleteFlowsDatatable-example.txt new file mode 100644 index 000000000..57905b227 --- /dev/null +++ b/build/docs/deleteFlowsDatatable-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let force: Bool = true // force delete, even if in use + +// deletes a specific datatable by id +DeleteFlowsDatatableRequest.deleteFlowsDatatable(datatableId: datatableId, force: force) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteFlowsDatatableRequest.deleteFlowsDatatable was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteFlowsDatatableRow-example.txt b/build/docs/deleteFlowsDatatableRow-example.txt new file mode 100644 index 000000000..23535dc1f --- /dev/null +++ b/build/docs/deleteFlowsDatatableRow-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let rowId: String = "" // the key for the row + +// Delete a row entry +DeleteFlowsDatatableRowRequest.deleteFlowsDatatableRow(datatableId: datatableId, rowId: rowId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteFlowsDatatableRowRequest.deleteFlowsDatatableRow was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteFlowsMilestone-example.txt b/build/docs/deleteFlowsMilestone-example.txt new file mode 100644 index 000000000..f187e10aa --- /dev/null +++ b/build/docs/deleteFlowsMilestone-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let milestoneId: String = "" // flow milestone ID + +// Delete a flow milestone. +DeleteFlowsMilestoneRequest.deleteFlowsMilestone(milestoneId: milestoneId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteFlowsMilestoneRequest.deleteFlowsMilestone was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteGreeting-example.txt b/build/docs/deleteGreeting-example.txt new file mode 100644 index 000000000..576ca3303 --- /dev/null +++ b/build/docs/deleteGreeting-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let greetingId: String = "" // Greeting ID + +// Deletes a Greeting with the given GreetingId +DeleteGreetingRequest.deleteGreeting(greetingId: greetingId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteGreetingRequest.deleteGreeting was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteGroup-example.txt b/build/docs/deleteGroup-example.txt new file mode 100644 index 000000000..237d0a452 --- /dev/null +++ b/build/docs/deleteGroup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID + +// Delete group +DeleteGroupRequest.deleteGroup(groupId: groupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteGroupRequest.deleteGroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteGroupMembers-example.txt b/build/docs/deleteGroupMembers-example.txt new file mode 100644 index 000000000..c38c3682f --- /dev/null +++ b/build/docs/deleteGroupMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let ids: String = "" // Comma separated list of userIds to remove + +// Remove members +DeleteGroupMembersRequest.deleteGroupMembers(groupId: groupId, ids: ids) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteGroupMembersRequest.deleteGroupMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersAdfs-example.txt b/build/docs/deleteIdentityprovidersAdfs-example.txt new file mode 100644 index 000000000..bf9357a01 --- /dev/null +++ b/build/docs/deleteIdentityprovidersAdfs-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete ADFS Identity Provider +DeleteIdentityprovidersAdfsRequest.deleteIdentityprovidersAdfs() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersAdfsRequest.deleteIdentityprovidersAdfs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersCic-example.txt b/build/docs/deleteIdentityprovidersCic-example.txt new file mode 100644 index 000000000..f0831eca4 --- /dev/null +++ b/build/docs/deleteIdentityprovidersCic-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete Customer Interaction Center (CIC) Identity Provider +DeleteIdentityprovidersCicRequest.deleteIdentityprovidersCic() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersCicRequest.deleteIdentityprovidersCic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersGeneric-example.txt b/build/docs/deleteIdentityprovidersGeneric-example.txt new file mode 100644 index 000000000..cd9a2740b --- /dev/null +++ b/build/docs/deleteIdentityprovidersGeneric-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete Generic SAML Identity Provider +DeleteIdentityprovidersGenericRequest.deleteIdentityprovidersGeneric() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersGenericRequest.deleteIdentityprovidersGeneric was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersGsuite-example.txt b/build/docs/deleteIdentityprovidersGsuite-example.txt new file mode 100644 index 000000000..744cd2990 --- /dev/null +++ b/build/docs/deleteIdentityprovidersGsuite-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete G Suite Identity Provider +DeleteIdentityprovidersGsuiteRequest.deleteIdentityprovidersGsuite() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersGsuiteRequest.deleteIdentityprovidersGsuite was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersIdentitynow-example.txt b/build/docs/deleteIdentityprovidersIdentitynow-example.txt new file mode 100644 index 000000000..f008c499a --- /dev/null +++ b/build/docs/deleteIdentityprovidersIdentitynow-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete IdentityNow Provider +DeleteIdentityprovidersIdentitynowRequest.deleteIdentityprovidersIdentitynow() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersIdentitynowRequest.deleteIdentityprovidersIdentitynow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersOkta-example.txt b/build/docs/deleteIdentityprovidersOkta-example.txt new file mode 100644 index 000000000..6cf9ac1b7 --- /dev/null +++ b/build/docs/deleteIdentityprovidersOkta-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete Okta Identity Provider +DeleteIdentityprovidersOktaRequest.deleteIdentityprovidersOkta() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersOktaRequest.deleteIdentityprovidersOkta was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersOnelogin-example.txt b/build/docs/deleteIdentityprovidersOnelogin-example.txt new file mode 100644 index 000000000..65f1ac868 --- /dev/null +++ b/build/docs/deleteIdentityprovidersOnelogin-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete OneLogin Identity Provider +DeleteIdentityprovidersOneloginRequest.deleteIdentityprovidersOnelogin() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersOneloginRequest.deleteIdentityprovidersOnelogin was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersPing-example.txt b/build/docs/deleteIdentityprovidersPing-example.txt new file mode 100644 index 000000000..c25d21da2 --- /dev/null +++ b/build/docs/deleteIdentityprovidersPing-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete Ping Identity Provider +DeleteIdentityprovidersPingRequest.deleteIdentityprovidersPing() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersPingRequest.deleteIdentityprovidersPing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersPurecloud-example.txt b/build/docs/deleteIdentityprovidersPurecloud-example.txt new file mode 100644 index 000000000..95fc1584c --- /dev/null +++ b/build/docs/deleteIdentityprovidersPurecloud-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete PureCloud Identity Provider +DeleteIdentityprovidersPurecloudRequest.deleteIdentityprovidersPurecloud() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersPurecloudRequest.deleteIdentityprovidersPurecloud was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersPureengage-example.txt b/build/docs/deleteIdentityprovidersPureengage-example.txt new file mode 100644 index 000000000..471192ece --- /dev/null +++ b/build/docs/deleteIdentityprovidersPureengage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete PureEngage Identity Provider +DeleteIdentityprovidersPureengageRequest.deleteIdentityprovidersPureengage() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersPureengageRequest.deleteIdentityprovidersPureengage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIdentityprovidersSalesforce-example.txt b/build/docs/deleteIdentityprovidersSalesforce-example.txt new file mode 100644 index 000000000..bc01f6966 --- /dev/null +++ b/build/docs/deleteIdentityprovidersSalesforce-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete Salesforce Identity Provider +DeleteIdentityprovidersSalesforceRequest.deleteIdentityprovidersSalesforce() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIdentityprovidersSalesforceRequest.deleteIdentityprovidersSalesforce was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIntegration-example.txt b/build/docs/deleteIntegration-example.txt new file mode 100644 index 000000000..90b1917b5 --- /dev/null +++ b/build/docs/deleteIntegration-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration Id + +// Delete integration. +DeleteIntegrationRequest.deleteIntegration(integrationId: integrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteIntegrationRequest.deleteIntegration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteIntegrationsAction-example.txt b/build/docs/deleteIntegrationsAction-example.txt new file mode 100644 index 000000000..57f802a3d --- /dev/null +++ b/build/docs/deleteIntegrationsAction-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId + +// Delete an Action +DeleteIntegrationsActionRequest.deleteIntegrationsAction(actionId: actionId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteIntegrationsActionRequest.deleteIntegrationsAction was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteIntegrationsActionDraft-example.txt b/build/docs/deleteIntegrationsActionDraft-example.txt new file mode 100644 index 000000000..f8e9c1199 --- /dev/null +++ b/build/docs/deleteIntegrationsActionDraft-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId + +// Delete a Draft +DeleteIntegrationsActionDraftRequest.deleteIntegrationsActionDraft(actionId: actionId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteIntegrationsActionDraftRequest.deleteIntegrationsActionDraft was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteIntegrationsCredential-example.txt b/build/docs/deleteIntegrationsCredential-example.txt new file mode 100644 index 000000000..0c369290c --- /dev/null +++ b/build/docs/deleteIntegrationsCredential-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let credentialId: String = "" // Credential ID + +// Delete a set of credentials +DeleteIntegrationsCredentialRequest.deleteIntegrationsCredential(credentialId: credentialId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteIntegrationsCredentialRequest.deleteIntegrationsCredential was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteJourneyActionmap-example.txt b/build/docs/deleteJourneyActionmap-example.txt new file mode 100644 index 000000000..29f3cad80 --- /dev/null +++ b/build/docs/deleteJourneyActionmap-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionMapId: String = "" // ID of the action map. + +// Delete single action map. +DeleteJourneyActionmapRequest.deleteJourneyActionmap(actionMapId: actionMapId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteJourneyActionmapRequest.deleteJourneyActionmap was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteJourneyActiontemplate-example.txt b/build/docs/deleteJourneyActiontemplate-example.txt new file mode 100644 index 000000000..75824f22c --- /dev/null +++ b/build/docs/deleteJourneyActiontemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionTemplateId: String = "" // ID of the action template. +let hardDelete: Bool = true // 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. + +// Delete a single action template. +DeleteJourneyActiontemplateRequest.deleteJourneyActiontemplate(actionTemplateId: actionTemplateId, hardDelete: hardDelete) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteJourneyActiontemplateRequest.deleteJourneyActiontemplate was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteJourneyOutcome-example.txt b/build/docs/deleteJourneyOutcome-example.txt new file mode 100644 index 000000000..791a5e059 --- /dev/null +++ b/build/docs/deleteJourneyOutcome-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let outcomeId: String = "" // ID of the outcome. + +// Delete an outcome. +DeleteJourneyOutcomeRequest.deleteJourneyOutcome(outcomeId: outcomeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteJourneyOutcomeRequest.deleteJourneyOutcome was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteJourneyOutcomesPredictor-example.txt b/build/docs/deleteJourneyOutcomesPredictor-example.txt new file mode 100644 index 000000000..dc26ef385 --- /dev/null +++ b/build/docs/deleteJourneyOutcomesPredictor-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // ID of predictor + +// Delete an outcome predictor. +DeleteJourneyOutcomesPredictorRequest.deleteJourneyOutcomesPredictor(predictorId: predictorId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteJourneyOutcomesPredictorRequest.deleteJourneyOutcomesPredictor was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteJourneySegment-example.txt b/build/docs/deleteJourneySegment-example.txt new file mode 100644 index 000000000..13b4c2dcc --- /dev/null +++ b/build/docs/deleteJourneySegment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let segmentId: String = "" // ID of the segment. + +// Delete a segment. +DeleteJourneySegmentRequest.deleteJourneySegment(segmentId: segmentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteJourneySegmentRequest.deleteJourneySegment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebase-example.txt b/build/docs/deleteKnowledgeKnowledgebase-example.txt new file mode 100644 index 000000000..7d1a15d78 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebase-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID + +// Delete knowledge base +DeleteKnowledgeKnowledgebaseRequest.deleteKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteKnowledgeKnowledgebaseRequest.deleteKnowledgeKnowledgebase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseCategory-example.txt b/build/docs/deleteKnowledgeKnowledgebaseCategory-example.txt new file mode 100644 index 000000000..6c4cc52fc --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseCategory-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let categoryId: String = "" // Category ID + +// Delete category +DeleteKnowledgeKnowledgebaseCategoryRequest.deleteKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteKnowledgeKnowledgebaseCategoryRequest.deleteKnowledgeKnowledgebaseCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseDocument-example.txt b/build/docs/deleteKnowledgeKnowledgebaseDocument-example.txt new file mode 100644 index 000000000..5c527858c --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseDocument-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. + +// Delete document. +DeleteKnowledgeKnowledgebaseDocumentRequest.deleteKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteKnowledgeKnowledgebaseDocumentRequest.deleteKnowledgeKnowledgebaseDocument was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseDocumentVariation-example.txt b/build/docs/deleteKnowledgeKnowledgebaseDocumentVariation-example.txt new file mode 100644 index 000000000..f5207bd46 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseDocumentVariation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentVariationId: String = "" // Globally unique identifier for a document variation. +let documentId: String = "" // Globally unique identifier for a document. +let knowledgeBaseId: String = "" // Globally unique identifier for a knowledge base. + +// Delete a variation for a document. +DeleteKnowledgeKnowledgebaseDocumentVariationRequest.deleteKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteKnowledgeKnowledgebaseDocumentVariationRequest.deleteKnowledgeKnowledgebaseDocumentVariation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseExportJob-example.txt b/build/docs/deleteKnowledgeKnowledgebaseExportJob-example.txt new file mode 100644 index 000000000..ab1ed3063 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseExportJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let exportJobId: String = "" // Export job ID + +// Delete export job +DeleteKnowledgeKnowledgebaseExportJobRequest.deleteKnowledgeKnowledgebaseExportJob(knowledgeBaseId: knowledgeBaseId, exportJobId: exportJobId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteKnowledgeKnowledgebaseExportJobRequest.deleteKnowledgeKnowledgebaseExportJob was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseImportJob-example.txt b/build/docs/deleteKnowledgeKnowledgebaseImportJob-example.txt new file mode 100644 index 000000000..a3a30c4d2 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseImportJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let importJobId: String = "" // Import job ID + +// Delete import job +DeleteKnowledgeKnowledgebaseImportJobRequest.deleteKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteKnowledgeKnowledgebaseImportJobRequest.deleteKnowledgeKnowledgebaseImportJob was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseLabel-example.txt b/build/docs/deleteKnowledgeKnowledgebaseLabel-example.txt new file mode 100644 index 000000000..f3b3e4fc0 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseLabel-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let labelId: String = "" // Label ID + +// Delete label +DeleteKnowledgeKnowledgebaseLabelRequest.deleteKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteKnowledgeKnowledgebaseLabelRequest.deleteKnowledgeKnowledgebaseLabel was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseLanguageCategory-example.txt b/build/docs/deleteKnowledgeKnowledgebaseLanguageCategory-example.txt new file mode 100644 index 000000000..3a5a72d51 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseLanguageCategory-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let categoryId: String = "" // Category ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageCategory = DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE + +// Delete category +DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.deleteKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteKnowledgeKnowledgebaseLanguageCategoryRequest.deleteKnowledgeKnowledgebaseLanguageCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseLanguageDocument-example.txt b/build/docs/deleteKnowledgeKnowledgebaseLanguageDocument-example.txt new file mode 100644 index 000000000..18b5aac0f --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseLanguageDocument-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocument = DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE + +// Delete document +DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.deleteKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteKnowledgeKnowledgebaseLanguageDocumentRequest.deleteKnowledgeKnowledgebaseLanguageDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt b/build/docs/deleteKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt new file mode 100644 index 000000000..71b164fa8 --- /dev/null +++ b/build/docs/deleteKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocumentsImport = DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_deleteKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE +let importId: String = "" // Import ID + +// Delete import operation +DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteKnowledgeKnowledgebaseLanguageDocumentsImportRequest.deleteKnowledgeKnowledgebaseLanguageDocumentsImport was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguage-example.txt b/build/docs/deleteLanguage-example.txt new file mode 100644 index 000000000..0d85b9aba --- /dev/null +++ b/build/docs/deleteLanguage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let languageId: String = "" // Language ID + +// Delete Language (Deprecated) +DeleteLanguageRequest.deleteLanguage(languageId: languageId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageRequest.deleteLanguage was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguageunderstandingDomain-example.txt b/build/docs/deleteLanguageunderstandingDomain-example.txt new file mode 100644 index 000000000..0436a139d --- /dev/null +++ b/build/docs/deleteLanguageunderstandingDomain-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. + +// Delete an NLU Domain. +DeleteLanguageunderstandingDomainRequest.deleteLanguageunderstandingDomain(domainId: domainId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageunderstandingDomainRequest.deleteLanguageunderstandingDomain was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguageunderstandingDomainFeedbackFeedbackId-example.txt b/build/docs/deleteLanguageunderstandingDomainFeedbackFeedbackId-example.txt new file mode 100644 index 000000000..71089df8d --- /dev/null +++ b/build/docs/deleteLanguageunderstandingDomainFeedbackFeedbackId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let feedbackId: String = "" // ID of the Feedback + +// Delete the feedback on the NLU Domain Version. +DeleteLanguageunderstandingDomainFeedbackFeedbackIdRequest.deleteLanguageunderstandingDomainFeedbackFeedbackId(domainId: domainId, feedbackId: feedbackId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageunderstandingDomainFeedbackFeedbackIdRequest.deleteLanguageunderstandingDomainFeedbackFeedbackId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguageunderstandingDomainVersion-example.txt b/build/docs/deleteLanguageunderstandingDomainVersion-example.txt new file mode 100644 index 000000000..1361d3127 --- /dev/null +++ b/build/docs/deleteLanguageunderstandingDomainVersion-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. + +// Delete an NLU Domain Version +DeleteLanguageunderstandingDomainVersionRequest.deleteLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageunderstandingDomainVersionRequest.deleteLanguageunderstandingDomainVersion was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguageunderstandingMiner-example.txt b/build/docs/deleteLanguageunderstandingMiner-example.txt new file mode 100644 index 000000000..8a82b8df4 --- /dev/null +++ b/build/docs/deleteLanguageunderstandingMiner-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID + +// Delete a miner. +DeleteLanguageunderstandingMinerRequest.deleteLanguageunderstandingMiner(minerId: minerId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageunderstandingMinerRequest.deleteLanguageunderstandingMiner was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLanguageunderstandingMinerDraft-example.txt b/build/docs/deleteLanguageunderstandingMinerDraft-example.txt new file mode 100644 index 000000000..29f6e6fc6 --- /dev/null +++ b/build/docs/deleteLanguageunderstandingMinerDraft-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let draftId: String = "" // Draft ID + +// Delete a draft +DeleteLanguageunderstandingMinerDraftRequest.deleteLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLanguageunderstandingMinerDraftRequest.deleteLanguageunderstandingMinerDraft was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLearningAssignment-example.txt b/build/docs/deleteLearningAssignment-example.txt new file mode 100644 index 000000000..9c3d44f66 --- /dev/null +++ b/build/docs/deleteLearningAssignment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The Learning Assignment ID + +// Delete a learning assignment +DeleteLearningAssignmentRequest.deleteLearningAssignment(assignmentId: assignmentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLearningAssignmentRequest.deleteLearningAssignment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLearningModule-example.txt b/build/docs/deleteLearningModule-example.txt new file mode 100644 index 000000000..54fc53663 --- /dev/null +++ b/build/docs/deleteLearningModule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module + +// Delete a learning module +DeleteLearningModuleRequest.deleteLearningModule(moduleId: moduleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLearningModuleRequest.deleteLearningModule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteLocation-example.txt b/build/docs/deleteLocation-example.txt new file mode 100644 index 000000000..cbaa2bc62 --- /dev/null +++ b/build/docs/deleteLocation-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let locationId: String = "" // Location ID + +// Delete a location +DeleteLocationRequest.deleteLocation(locationId: locationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteLocationRequest.deleteLocation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteMessagingSetting-example.txt b/build/docs/deleteMessagingSetting-example.txt new file mode 100644 index 000000000..83b4f4ead --- /dev/null +++ b/build/docs/deleteMessagingSetting-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Settings ID + +// Delete a messaging setting +DeleteMessagingSettingRequest.deleteMessagingSetting(messageSettingId: messageSettingId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteMessagingSettingRequest.deleteMessagingSetting was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteMessagingSettingsDefault-example.txt b/build/docs/deleteMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..45cf75a9e --- /dev/null +++ b/build/docs/deleteMessagingSettingsDefault-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete the organization's default setting, a global default will be applied to integrations without settings +DeleteMessagingSettingsDefaultRequest.deleteMessagingSettingsDefault() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteMessagingSettingsDefaultRequest.deleteMessagingSettingsDefault was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/deleteMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..5ae1e255b --- /dev/null +++ b/build/docs/deleteMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID + +// Delete a supported content profile +DeleteMessagingSupportedcontentSupportedContentIdRequest.deleteMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteMessagingSupportedcontentSupportedContentIdRequest.deleteMessagingSupportedcontentSupportedContentId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteMobiledevice-example.txt b/build/docs/deleteMobiledevice-example.txt new file mode 100644 index 000000000..a4a6a3f7e --- /dev/null +++ b/build/docs/deleteMobiledevice-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deviceId: String = "" // Device ID + +// Delete device +DeleteMobiledeviceRequest.deleteMobiledevice(deviceId: deviceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteMobiledeviceRequest.deleteMobiledevice was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteNotificationsChannelSubscriptions-example.txt b/build/docs/deleteNotificationsChannelSubscriptions-example.txt new file mode 100644 index 000000000..c7cd9315a --- /dev/null +++ b/build/docs/deleteNotificationsChannelSubscriptions-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let channelId: String = "" // Channel ID + +// Remove all subscriptions +DeleteNotificationsChannelSubscriptionsRequest.deleteNotificationsChannelSubscriptions(channelId: channelId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteNotificationsChannelSubscriptionsRequest.deleteNotificationsChannelSubscriptions was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOauthClient-example.txt b/build/docs/deleteOauthClient-example.txt new file mode 100644 index 000000000..feb782b1f --- /dev/null +++ b/build/docs/deleteOauthClient-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID + +// Delete OAuth Client +DeleteOauthClientRequest.deleteOauthClient(clientId: clientId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOauthClientRequest.deleteOauthClient was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrustee-example.txt b/build/docs/deleteOrgauthorizationTrustee-example.txt new file mode 100644 index 000000000..2e15d04e3 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrustee-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id + +// Delete Org Trust +DeleteOrgauthorizationTrusteeRequest.deleteOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeRequest.deleteOrgauthorizationTrustee was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrusteeCloneduser-example.txt b/build/docs/deleteOrgauthorizationTrusteeCloneduser-example.txt new file mode 100644 index 000000000..ad8bd9c81 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrusteeCloneduser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Id of the cloned user to delete + +// Deletes cloned user +DeleteOrgauthorizationTrusteeCloneduserRequest.deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeCloneduserRequest.deleteOrgauthorizationTrusteeCloneduser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrusteeGroup-example.txt b/build/docs/deleteOrgauthorizationTrusteeGroup-example.txt new file mode 100644 index 000000000..c96cd8906 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrusteeGroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id + +// Delete Trustee Group +DeleteOrgauthorizationTrusteeGroupRequest.deleteOrgauthorizationTrusteeGroup(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeGroupRequest.deleteOrgauthorizationTrusteeGroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrusteeGroupRoles-example.txt b/build/docs/deleteOrgauthorizationTrusteeGroupRoles-example.txt new file mode 100644 index 000000000..79181b858 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrusteeGroupRoles-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id + +// Delete Trustee Group Roles +DeleteOrgauthorizationTrusteeGroupRolesRequest.deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeGroupRolesRequest.deleteOrgauthorizationTrusteeGroupRoles was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrusteeUser-example.txt b/build/docs/deleteOrgauthorizationTrusteeUser-example.txt new file mode 100644 index 000000000..6b903ab56 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrusteeUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Delete Trustee User +DeleteOrgauthorizationTrusteeUserRequest.deleteOrgauthorizationTrusteeUser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeUserRequest.deleteOrgauthorizationTrusteeUser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrusteeUserRoles-example.txt b/build/docs/deleteOrgauthorizationTrusteeUserRoles-example.txt new file mode 100644 index 000000000..57d1a035c --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrusteeUserRoles-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Delete Trustee User Roles +DeleteOrgauthorizationTrusteeUserRolesRequest.deleteOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrusteeUserRolesRequest.deleteOrgauthorizationTrusteeUserRoles was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrustor-example.txt b/build/docs/deleteOrgauthorizationTrustor-example.txt new file mode 100644 index 000000000..6cedfc76e --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrustor-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id + +// Delete Org Trust +DeleteOrgauthorizationTrustorRequest.deleteOrgauthorizationTrustor(trustorOrgId: trustorOrgId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrustorRequest.deleteOrgauthorizationTrustor was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrustorCloneduser-example.txt b/build/docs/deleteOrgauthorizationTrustorCloneduser-example.txt new file mode 100644 index 000000000..2d5b1fd2e --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrustorCloneduser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Delete Cloned User +DeleteOrgauthorizationTrustorCloneduserRequest.deleteOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrustorCloneduserRequest.deleteOrgauthorizationTrustorCloneduser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrustorGroup-example.txt b/build/docs/deleteOrgauthorizationTrustorGroup-example.txt new file mode 100644 index 000000000..f1fb0b1f1 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrustorGroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trustorGroupId: String = "" // Trustor Group Id + +// Delete Trustee Group +DeleteOrgauthorizationTrustorGroupRequest.deleteOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrustorGroupRequest.deleteOrgauthorizationTrustorGroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrgauthorizationTrustorUser-example.txt b/build/docs/deleteOrgauthorizationTrustorUser-example.txt new file mode 100644 index 000000000..9e978c305 --- /dev/null +++ b/build/docs/deleteOrgauthorizationTrustorUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Delete Trustee User +DeleteOrgauthorizationTrustorUserRequest.deleteOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOrgauthorizationTrustorUserRequest.deleteOrgauthorizationTrustorUser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOrphanrecording-example.txt b/build/docs/deleteOrphanrecording-example.txt new file mode 100644 index 000000000..f3d3d3b3a --- /dev/null +++ b/build/docs/deleteOrphanrecording-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let orphanId: String = "" // Orphan ID + +// Deletes a single orphan recording +DeleteOrphanrecordingRequest.deleteOrphanrecording(orphanId: orphanId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteOrphanrecordingRequest.deleteOrphanrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundAttemptlimit-example.txt b/build/docs/deleteOutboundAttemptlimit-example.txt new file mode 100644 index 000000000..563cb52a4 --- /dev/null +++ b/build/docs/deleteOutboundAttemptlimit-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let attemptLimitsId: String = "" // Attempt limits ID + +// Delete attempt limits +DeleteOutboundAttemptlimitRequest.deleteOutboundAttemptlimit(attemptLimitsId: attemptLimitsId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundAttemptlimitRequest.deleteOutboundAttemptlimit was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundCallabletimeset-example.txt b/build/docs/deleteOutboundCallabletimeset-example.txt new file mode 100644 index 000000000..40c5ab05b --- /dev/null +++ b/build/docs/deleteOutboundCallabletimeset-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callableTimeSetId: String = "" // Callable Time Set ID + +// Delete callable time set +DeleteOutboundCallabletimesetRequest.deleteOutboundCallabletimeset(callableTimeSetId: callableTimeSetId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundCallabletimesetRequest.deleteOutboundCallabletimeset was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundCallanalysisresponseset-example.txt b/build/docs/deleteOutboundCallanalysisresponseset-example.txt new file mode 100644 index 000000000..648da7dbf --- /dev/null +++ b/build/docs/deleteOutboundCallanalysisresponseset-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callAnalysisSetId: String = "" // Call Analysis Response Set ID + +// Delete a dialer call analysis response set. +DeleteOutboundCallanalysisresponsesetRequest.deleteOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundCallanalysisresponsesetRequest.deleteOutboundCallanalysisresponseset was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundCampaign-example.txt b/build/docs/deleteOutboundCampaign-example.txt new file mode 100644 index 000000000..408a64fda --- /dev/null +++ b/build/docs/deleteOutboundCampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Delete a campaign. +DeleteOutboundCampaignRequest.deleteOutboundCampaign(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteOutboundCampaignRequest.deleteOutboundCampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundCampaignProgress-example.txt b/build/docs/deleteOutboundCampaignProgress-example.txt new file mode 100644 index 000000000..20991dfe9 --- /dev/null +++ b/build/docs/deleteOutboundCampaignProgress-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Reset campaign progress and recycle the campaign +DeleteOutboundCampaignProgressRequest.deleteOutboundCampaignProgress(campaignId: campaignId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundCampaignProgressRequest.deleteOutboundCampaignProgress was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundCampaignrule-example.txt b/build/docs/deleteOutboundCampaignrule-example.txt new file mode 100644 index 000000000..76c8a5434 --- /dev/null +++ b/build/docs/deleteOutboundCampaignrule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignRuleId: String = "" // Campaign Rule ID + +// Delete Campaign Rule +DeleteOutboundCampaignruleRequest.deleteOutboundCampaignrule(campaignRuleId: campaignRuleId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundCampaignruleRequest.deleteOutboundCampaignrule was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundContactlist-example.txt b/build/docs/deleteOutboundContactlist-example.txt new file mode 100644 index 000000000..1df1cb2f1 --- /dev/null +++ b/build/docs/deleteOutboundContactlist-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID + +// Delete a contact list. +DeleteOutboundContactlistRequest.deleteOutboundContactlist(contactListId: contactListId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundContactlistRequest.deleteOutboundContactlist was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundContactlistContact-example.txt b/build/docs/deleteOutboundContactlistContact-example.txt new file mode 100644 index 000000000..1a584fd82 --- /dev/null +++ b/build/docs/deleteOutboundContactlistContact-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let contactId: String = "" // Contact ID + +// Delete a contact. +DeleteOutboundContactlistContactRequest.deleteOutboundContactlistContact(contactListId: contactListId, contactId: contactId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundContactlistContactRequest.deleteOutboundContactlistContact was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundContactlistContacts-example.txt b/build/docs/deleteOutboundContactlistContacts-example.txt new file mode 100644 index 000000000..7a073114f --- /dev/null +++ b/build/docs/deleteOutboundContactlistContacts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let contactIds: [String] = [""] // ContactIds to delete. + +// Delete contacts from a contact list. +DeleteOutboundContactlistContactsRequest.deleteOutboundContactlistContacts(contactListId: contactListId, contactIds: contactIds) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundContactlistContactsRequest.deleteOutboundContactlistContacts was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundContactlistfilter-example.txt b/build/docs/deleteOutboundContactlistfilter-example.txt new file mode 100644 index 000000000..21625958c --- /dev/null +++ b/build/docs/deleteOutboundContactlistfilter-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListFilterId: String = "" // Contact List Filter ID + +// Delete Contact List Filter +DeleteOutboundContactlistfilterRequest.deleteOutboundContactlistfilter(contactListFilterId: contactListFilterId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundContactlistfilterRequest.deleteOutboundContactlistfilter was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundContactlists-example.txt b/build/docs/deleteOutboundContactlists-example.txt new file mode 100644 index 000000000..ebcb19fce --- /dev/null +++ b/build/docs/deleteOutboundContactlists-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // contact list id(s) to delete + +// Delete multiple contact lists. +DeleteOutboundContactlistsRequest.deleteOutboundContactlists(_id: _id) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundContactlistsRequest.deleteOutboundContactlists was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundDigitalruleset-example.txt b/build/docs/deleteOutboundDigitalruleset-example.txt new file mode 100644 index 000000000..f44671a31 --- /dev/null +++ b/build/docs/deleteOutboundDigitalruleset-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let digitalRuleSetId: String = "" // The Digital Rule Set ID + +// Delete an Outbound Digital Rule Set +DeleteOutboundDigitalrulesetRequest.deleteOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundDigitalrulesetRequest.deleteOutboundDigitalruleset was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundDnclist-example.txt b/build/docs/deleteOutboundDnclist-example.txt new file mode 100644 index 000000000..d637a167c --- /dev/null +++ b/build/docs/deleteOutboundDnclist-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID + +// Delete dialer DNC list +DeleteOutboundDnclistRequest.deleteOutboundDnclist(dncListId: dncListId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundDnclistRequest.deleteOutboundDnclist was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundDnclistCustomexclusioncolumns-example.txt b/build/docs/deleteOutboundDnclistCustomexclusioncolumns-example.txt new file mode 100644 index 000000000..7c0bff617 --- /dev/null +++ b/build/docs/deleteOutboundDnclistCustomexclusioncolumns-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired + +// Deletes all or expired custom exclusion column entries from a DNC list. +DeleteOutboundDnclistCustomexclusioncolumnsRequest.deleteOutboundDnclistCustomexclusioncolumns(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundDnclistCustomexclusioncolumnsRequest.deleteOutboundDnclistCustomexclusioncolumns was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundDnclistEmailaddresses-example.txt b/build/docs/deleteOutboundDnclistEmailaddresses-example.txt new file mode 100644 index 000000000..ffbd107ca --- /dev/null +++ b/build/docs/deleteOutboundDnclistEmailaddresses-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired + +// Deletes all or expired email addresses from a DNC list. +DeleteOutboundDnclistEmailaddressesRequest.deleteOutboundDnclistEmailaddresses(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundDnclistEmailaddressesRequest.deleteOutboundDnclistEmailaddresses was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundDnclistPhonenumbers-example.txt b/build/docs/deleteOutboundDnclistPhonenumbers-example.txt new file mode 100644 index 000000000..cce1cfeca --- /dev/null +++ b/build/docs/deleteOutboundDnclistPhonenumbers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let expiredOnly: Bool = true // Set to true to only remove DNC entries that are expired + +// Deletes all or expired phone numbers from a DNC list. +DeleteOutboundDnclistPhonenumbersRequest.deleteOutboundDnclistPhonenumbers(dncListId: dncListId, expiredOnly: expiredOnly) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundDnclistPhonenumbersRequest.deleteOutboundDnclistPhonenumbers was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundMessagingcampaign-example.txt b/build/docs/deleteOutboundMessagingcampaign-example.txt new file mode 100644 index 000000000..9a59799e9 --- /dev/null +++ b/build/docs/deleteOutboundMessagingcampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Delete an Outbound Messaging Campaign +DeleteOutboundMessagingcampaignRequest.deleteOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteOutboundMessagingcampaignRequest.deleteOutboundMessagingcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundMessagingcampaignProgress-example.txt b/build/docs/deleteOutboundMessagingcampaignProgress-example.txt new file mode 100644 index 000000000..1d3ce64b2 --- /dev/null +++ b/build/docs/deleteOutboundMessagingcampaignProgress-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Reset messaging campaign progress and recycle the messaging campaign +DeleteOutboundMessagingcampaignProgressRequest.deleteOutboundMessagingcampaignProgress(messagingCampaignId: messagingCampaignId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundMessagingcampaignProgressRequest.deleteOutboundMessagingcampaignProgress was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundRuleset-example.txt b/build/docs/deleteOutboundRuleset-example.txt new file mode 100644 index 000000000..f245f637a --- /dev/null +++ b/build/docs/deleteOutboundRuleset-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleSetId: String = "" // Rule Set ID + +// Delete a Rule Set. +DeleteOutboundRulesetRequest.deleteOutboundRuleset(ruleSetId: ruleSetId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundRulesetRequest.deleteOutboundRuleset was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundSchedulesCampaign-example.txt b/build/docs/deleteOutboundSchedulesCampaign-example.txt new file mode 100644 index 000000000..344940912 --- /dev/null +++ b/build/docs/deleteOutboundSchedulesCampaign-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Delete a dialer campaign schedule. +DeleteOutboundSchedulesCampaignRequest.deleteOutboundSchedulesCampaign(campaignId: campaignId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundSchedulesCampaignRequest.deleteOutboundSchedulesCampaign was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundSchedulesEmailcampaign-example.txt b/build/docs/deleteOutboundSchedulesEmailcampaign-example.txt new file mode 100644 index 000000000..06019d1ce --- /dev/null +++ b/build/docs/deleteOutboundSchedulesEmailcampaign-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emailCampaignId: String = "" // Email Campaign ID + +// Delete an email campaign schedule. +DeleteOutboundSchedulesEmailcampaignRequest.deleteOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundSchedulesEmailcampaignRequest.deleteOutboundSchedulesEmailcampaign was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundSchedulesMessagingcampaign-example.txt b/build/docs/deleteOutboundSchedulesMessagingcampaign-example.txt new file mode 100644 index 000000000..56cfb3287 --- /dev/null +++ b/build/docs/deleteOutboundSchedulesMessagingcampaign-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // Messaging Campaign ID + +// Delete a messaging campaign schedule. +DeleteOutboundSchedulesMessagingcampaignRequest.deleteOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundSchedulesMessagingcampaignRequest.deleteOutboundSchedulesMessagingcampaign was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundSchedulesSequence-example.txt b/build/docs/deleteOutboundSchedulesSequence-example.txt new file mode 100644 index 000000000..55049373d --- /dev/null +++ b/build/docs/deleteOutboundSchedulesSequence-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Sequence ID + +// Delete a dialer sequence schedule. +DeleteOutboundSchedulesSequenceRequest.deleteOutboundSchedulesSequence(sequenceId: sequenceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundSchedulesSequenceRequest.deleteOutboundSchedulesSequence was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteOutboundSequence-example.txt b/build/docs/deleteOutboundSequence-example.txt new file mode 100644 index 000000000..5c67a2c48 --- /dev/null +++ b/build/docs/deleteOutboundSequence-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Campaign Sequence ID + +// Delete a dialer campaign sequence. +DeleteOutboundSequenceRequest.deleteOutboundSequence(sequenceId: sequenceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteOutboundSequenceRequest.deleteOutboundSequence was successful") + } +} \ No newline at end of file diff --git a/build/docs/deletePresenceSource-example.txt b/build/docs/deletePresenceSource-example.txt new file mode 100644 index 000000000..6641acee9 --- /dev/null +++ b/build/docs/deletePresenceSource-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sourceId: String = "" // Presence Source ID + +// Delete a Presence Source +DeletePresenceSourceRequest.deletePresenceSource(sourceId: sourceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeletePresenceSourceRequest.deletePresenceSource was successful") + } +} \ No newline at end of file diff --git a/build/docs/deletePresencedefinition-example.txt b/build/docs/deletePresencedefinition-example.txt new file mode 100644 index 000000000..bcd9182f1 --- /dev/null +++ b/build/docs/deletePresencedefinition-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let presenceId: String = "" // Organization Presence ID + +// Delete a Presence Definition +DeletePresencedefinitionRequest.deletePresencedefinition(presenceId: presenceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeletePresencedefinitionRequest.deletePresencedefinition was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteProcessautomationTrigger-example.txt b/build/docs/deleteProcessautomationTrigger-example.txt new file mode 100644 index 000000000..1feb9276c --- /dev/null +++ b/build/docs/deleteProcessautomationTrigger-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let triggerId: String = "" // triggerId + +// Delete a Trigger +DeleteProcessautomationTriggerRequest.deleteProcessautomationTrigger(triggerId: triggerId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteProcessautomationTriggerRequest.deleteProcessautomationTrigger was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteQualityCalibration-example.txt b/build/docs/deleteQualityCalibration-example.txt new file mode 100644 index 000000000..1aa8ea8c7 --- /dev/null +++ b/build/docs/deleteQualityCalibration-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let calibrationId: String = "" // Calibration ID +let calibratorId: String = "" // calibratorId + +// Delete a calibration by id. +DeleteQualityCalibrationRequest.deleteQualityCalibration(calibrationId: calibrationId, calibratorId: calibratorId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteQualityCalibrationRequest.deleteQualityCalibration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteQualityConversationEvaluation-example.txt b/build/docs/deleteQualityConversationEvaluation-example.txt new file mode 100644 index 000000000..471409989 --- /dev/null +++ b/build/docs/deleteQualityConversationEvaluation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let evaluationId: String = "" // evaluationId +let expand: String = "" // evaluatorId, evaluationForm + +// Delete an evaluation +DeleteQualityConversationEvaluationRequest.deleteQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteQualityConversationEvaluationRequest.deleteQualityConversationEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteQualityForm-example.txt b/build/docs/deleteQualityForm-example.txt new file mode 100644 index 000000000..f93f5f120 --- /dev/null +++ b/build/docs/deleteQualityForm-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Delete an evaluation form. +DeleteQualityFormRequest.deleteQualityForm(formId: formId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteQualityFormRequest.deleteQualityForm was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteQualityFormsEvaluation-example.txt b/build/docs/deleteQualityFormsEvaluation-example.txt new file mode 100644 index 000000000..5544b1307 --- /dev/null +++ b/build/docs/deleteQualityFormsEvaluation-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Delete an evaluation form. +DeleteQualityFormsEvaluationRequest.deleteQualityFormsEvaluation(formId: formId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteQualityFormsEvaluationRequest.deleteQualityFormsEvaluation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteQualityFormsSurvey-example.txt b/build/docs/deleteQualityFormsSurvey-example.txt new file mode 100644 index 000000000..a65601ae9 --- /dev/null +++ b/build/docs/deleteQualityFormsSurvey-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Delete a survey form. +DeleteQualityFormsSurveyRequest.deleteQualityFormsSurvey(formId: formId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteQualityFormsSurveyRequest.deleteQualityFormsSurvey was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRecordingCrossplatformMediaretentionpolicies-example.txt b/build/docs/deleteRecordingCrossplatformMediaretentionpolicies-example.txt new file mode 100644 index 000000000..a43beefc6 --- /dev/null +++ b/build/docs/deleteRecordingCrossplatformMediaretentionpolicies-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ids: String = "" // + +// Delete media retention policies +DeleteRecordingCrossplatformMediaretentionpoliciesRequest.deleteRecordingCrossplatformMediaretentionpolicies(ids: ids) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRecordingCrossplatformMediaretentionpoliciesRequest.deleteRecordingCrossplatformMediaretentionpolicies was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRecordingCrossplatformMediaretentionpolicy-example.txt b/build/docs/deleteRecordingCrossplatformMediaretentionpolicy-example.txt new file mode 100644 index 000000000..3ee408412 --- /dev/null +++ b/build/docs/deleteRecordingCrossplatformMediaretentionpolicy-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID + +// Delete a media retention policy +DeleteRecordingCrossplatformMediaretentionpolicyRequest.deleteRecordingCrossplatformMediaretentionpolicy(policyId: policyId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRecordingCrossplatformMediaretentionpolicyRequest.deleteRecordingCrossplatformMediaretentionpolicy was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRecordingJob-example.txt b/build/docs/deleteRecordingJob-example.txt new file mode 100644 index 000000000..15c84fe64 --- /dev/null +++ b/build/docs/deleteRecordingJob-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Delete the recording bulk job +DeleteRecordingJobRequest.deleteRecordingJob(jobId: jobId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRecordingJobRequest.deleteRecordingJob was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRecordingMediaretentionpolicies-example.txt b/build/docs/deleteRecordingMediaretentionpolicies-example.txt new file mode 100644 index 000000000..f82c3a0a6 --- /dev/null +++ b/build/docs/deleteRecordingMediaretentionpolicies-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ids: String = "" // + +// Delete media retention policies +DeleteRecordingMediaretentionpoliciesRequest.deleteRecordingMediaretentionpolicies(ids: ids) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRecordingMediaretentionpoliciesRequest.deleteRecordingMediaretentionpolicies was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRecordingMediaretentionpolicy-example.txt b/build/docs/deleteRecordingMediaretentionpolicy-example.txt new file mode 100644 index 000000000..733c7bc65 --- /dev/null +++ b/build/docs/deleteRecordingMediaretentionpolicy-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID + +// Delete a media retention policy +DeleteRecordingMediaretentionpolicyRequest.deleteRecordingMediaretentionpolicy(policyId: policyId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRecordingMediaretentionpolicyRequest.deleteRecordingMediaretentionpolicy was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteResponsemanagementLibrary-example.txt b/build/docs/deleteResponsemanagementLibrary-example.txt new file mode 100644 index 000000000..5ff12a4f9 --- /dev/null +++ b/build/docs/deleteResponsemanagementLibrary-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let libraryId: String = "" // Library ID + +// Delete an existing response library. +DeleteResponsemanagementLibraryRequest.deleteResponsemanagementLibrary(libraryId: libraryId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteResponsemanagementLibraryRequest.deleteResponsemanagementLibrary was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteResponsemanagementResponse-example.txt b/build/docs/deleteResponsemanagementResponse-example.txt new file mode 100644 index 000000000..c416642fe --- /dev/null +++ b/build/docs/deleteResponsemanagementResponse-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseId: String = "" // Response ID + +// Delete an existing response. +DeleteResponsemanagementResponseRequest.deleteResponsemanagementResponse(responseId: responseId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteResponsemanagementResponseRequest.deleteResponsemanagementResponse was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteResponsemanagementResponseasset-example.txt b/build/docs/deleteResponsemanagementResponseasset-example.txt new file mode 100644 index 000000000..12a4e978b --- /dev/null +++ b/build/docs/deleteResponsemanagementResponseasset-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseAssetId: String = "" // Asset Id + +// Delete response asset +DeleteResponsemanagementResponseassetRequest.deleteResponsemanagementResponseasset(responseAssetId: responseAssetId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteResponsemanagementResponseassetRequest.deleteResponsemanagementResponseasset was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingAssessment-example.txt b/build/docs/deleteRoutingAssessment-example.txt new file mode 100644 index 000000000..3d0ba4857 --- /dev/null +++ b/build/docs/deleteRoutingAssessment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assessmentId: String = "" // Benefit Assessment ID + +// Delete single benefit assessment. +DeleteRoutingAssessmentRequest.deleteRoutingAssessment(assessmentId: assessmentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingAssessmentRequest.deleteRoutingAssessment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingEmailDomain-example.txt b/build/docs/deleteRoutingEmailDomain-example.txt new file mode 100644 index 000000000..c076a963c --- /dev/null +++ b/build/docs/deleteRoutingEmailDomain-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Delete a domain +DeleteRoutingEmailDomainRequest.deleteRoutingEmailDomain(domainId: domainId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingEmailDomainRequest.deleteRoutingEmailDomain was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingEmailDomainRoute-example.txt b/build/docs/deleteRoutingEmailDomainRoute-example.txt new file mode 100644 index 000000000..05634e342 --- /dev/null +++ b/build/docs/deleteRoutingEmailDomainRoute-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainName: String = "" // email domain +let routeId: String = "" // route ID + +// Delete a route +DeleteRoutingEmailDomainRouteRequest.deleteRoutingEmailDomainRoute(domainName: domainName, routeId: routeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingEmailDomainRouteRequest.deleteRoutingEmailDomainRoute was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingEmailOutboundDomain-example.txt b/build/docs/deleteRoutingEmailOutboundDomain-example.txt new file mode 100644 index 000000000..63b81321d --- /dev/null +++ b/build/docs/deleteRoutingEmailOutboundDomain-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Delete an outbound domain +DeleteRoutingEmailOutboundDomainRequest.deleteRoutingEmailOutboundDomain(domainId: domainId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingEmailOutboundDomainRequest.deleteRoutingEmailOutboundDomain was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingLanguage-example.txt b/build/docs/deleteRoutingLanguage-example.txt new file mode 100644 index 000000000..a96a78be3 --- /dev/null +++ b/build/docs/deleteRoutingLanguage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let languageId: String = "" // Language ID + +// Delete a routing language +DeleteRoutingLanguageRequest.deleteRoutingLanguage(languageId: languageId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingLanguageRequest.deleteRoutingLanguage was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingPredictor-example.txt b/build/docs/deleteRoutingPredictor-example.txt new file mode 100644 index 000000000..3a3c02e49 --- /dev/null +++ b/build/docs/deleteRoutingPredictor-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // Predictor ID + +// Delete single predictor. +DeleteRoutingPredictorRequest.deleteRoutingPredictor(predictorId: predictorId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingPredictorRequest.deleteRoutingPredictor was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingQueue-example.txt b/build/docs/deleteRoutingQueue-example.txt new file mode 100644 index 000000000..1bef5fbb0 --- /dev/null +++ b/build/docs/deleteRoutingQueue-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let forceDelete: Bool = true // forceDelete + +// Delete a queue +DeleteRoutingQueueRequest.deleteRoutingQueue(queueId: queueId, forceDelete: forceDelete) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingQueueRequest.deleteRoutingQueue was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingQueueMember-example.txt b/build/docs/deleteRoutingQueueMember-example.txt new file mode 100644 index 000000000..af8938ede --- /dev/null +++ b/build/docs/deleteRoutingQueueMember-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let memberId: String = "" // Member ID + +// Delete a queue member. +DeleteRoutingQueueMemberRequest.deleteRoutingQueueMember(queueId: queueId, memberId: memberId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingQueueMemberRequest.deleteRoutingQueueMember was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingQueueUser-example.txt b/build/docs/deleteRoutingQueueUser-example.txt new file mode 100644 index 000000000..a2da3c2e1 --- /dev/null +++ b/build/docs/deleteRoutingQueueUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let memberId: String = "" // Member ID + +// DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member. +DeleteRoutingQueueUserRequest.deleteRoutingQueueUser(queueId: queueId, memberId: memberId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingQueueUserRequest.deleteRoutingQueueUser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingQueueWrapupcode-example.txt b/build/docs/deleteRoutingQueueWrapupcode-example.txt new file mode 100644 index 000000000..3e73c5cd6 --- /dev/null +++ b/build/docs/deleteRoutingQueueWrapupcode-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let codeId: String = "" // Code ID + +// Delete a wrap-up code from a queue +DeleteRoutingQueueWrapupcodeRequest.deleteRoutingQueueWrapupcode(queueId: queueId, codeId: codeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingQueueWrapupcodeRequest.deleteRoutingQueueWrapupcode was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingSettings-example.txt b/build/docs/deleteRoutingSettings-example.txt new file mode 100644 index 000000000..d561beab5 --- /dev/null +++ b/build/docs/deleteRoutingSettings-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete an organization's routing settings +DeleteRoutingSettingsRequest.deleteRoutingSettings() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingSettingsRequest.deleteRoutingSettings was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingSkill-example.txt b/build/docs/deleteRoutingSkill-example.txt new file mode 100644 index 000000000..b3c115d3c --- /dev/null +++ b/build/docs/deleteRoutingSkill-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillId: String = "" // Skill ID + +// Delete Routing Skill +DeleteRoutingSkillRequest.deleteRoutingSkill(skillId: skillId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingSkillRequest.deleteRoutingSkill was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingSkillgroup-example.txt b/build/docs/deleteRoutingSkillgroup-example.txt new file mode 100644 index 000000000..2610902da --- /dev/null +++ b/build/docs/deleteRoutingSkillgroup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID + +// Remove skill group definition +DeleteRoutingSkillgroupRequest.deleteRoutingSkillgroup(skillGroupId: skillGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingSkillgroupRequest.deleteRoutingSkillgroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingSmsAddress-example.txt b/build/docs/deleteRoutingSmsAddress-example.txt new file mode 100644 index 000000000..7664bd409 --- /dev/null +++ b/build/docs/deleteRoutingSmsAddress-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let addressId: String = "" // Address ID + +// Delete an Address by Id for SMS +DeleteRoutingSmsAddressRequest.deleteRoutingSmsAddress(addressId: addressId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingSmsAddressRequest.deleteRoutingSmsAddress was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingSmsPhonenumber-example.txt b/build/docs/deleteRoutingSmsPhonenumber-example.txt new file mode 100644 index 000000000..ce2b7b84d --- /dev/null +++ b/build/docs/deleteRoutingSmsPhonenumber-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let addressId: String = "" // Address ID + +// Delete a phone number provisioned for SMS. +DeleteRoutingSmsPhonenumberRequest.deleteRoutingSmsPhonenumber(addressId: addressId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingSmsPhonenumberRequest.deleteRoutingSmsPhonenumber was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingUserUtilization-example.txt b/build/docs/deleteRoutingUserUtilization-example.txt new file mode 100644 index 000000000..ea3b75eb4 --- /dev/null +++ b/build/docs/deleteRoutingUserUtilization-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Delete the user's max utilization settings and revert to the organization-wide default. +DeleteRoutingUserUtilizationRequest.deleteRoutingUserUtilization(userId: userId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingUserUtilizationRequest.deleteRoutingUserUtilization was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingUtilization-example.txt b/build/docs/deleteRoutingUtilization-example.txt new file mode 100644 index 000000000..4654f220e --- /dev/null +++ b/build/docs/deleteRoutingUtilization-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete the organization-wide max utilization settings and revert to the system default. +DeleteRoutingUtilizationRequest.deleteRoutingUtilization() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingUtilizationRequest.deleteRoutingUtilization was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteRoutingWrapupcode-example.txt b/build/docs/deleteRoutingWrapupcode-example.txt new file mode 100644 index 000000000..e219d0c61 --- /dev/null +++ b/build/docs/deleteRoutingWrapupcode-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let codeId: String = "" // Wrapup Code ID + +// Delete wrap-up code +DeleteRoutingWrapupcodeRequest.deleteRoutingWrapupcode(codeId: codeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteRoutingWrapupcodeRequest.deleteRoutingWrapupcode was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteScimUser-example.txt b/build/docs/deleteScimUser-example.txt new file mode 100644 index 000000000..7ed74cc45 --- /dev/null +++ b/build/docs/deleteScimUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/users. +let ifMatch: String = "" // 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\". + +// Delete a user +DeleteScimUserRequest.deleteScimUser(userId: userId, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteScimUserRequest.deleteScimUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteScimV2User-example.txt b/build/docs/deleteScimV2User-example.txt new file mode 100644 index 000000000..715807b34 --- /dev/null +++ b/build/docs/deleteScimV2User-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/v2/users. +let ifMatch: String = "" // 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\". + +// Delete a user +DeleteScimV2UserRequest.deleteScimV2User(userId: userId, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteScimV2UserRequest.deleteScimV2User was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt b/build/docs/deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt new file mode 100644 index 000000000..279a5220e --- /dev/null +++ b/build/docs/deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dictionaryFeedbackId: String = "" // The Id of the Dictionary Feedback + +// Delete a Speech & Text Analytics DictionaryFeedback by Id +DeleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteSpeechandtextanalyticsProgram-example.txt b/build/docs/deleteSpeechandtextanalyticsProgram-example.txt new file mode 100644 index 000000000..2f3aa78ec --- /dev/null +++ b/build/docs/deleteSpeechandtextanalyticsProgram-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program +let forceDelete: Bool = true // Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program. + +// Delete a Speech & Text Analytics program by id +DeleteSpeechandtextanalyticsProgramRequest.deleteSpeechandtextanalyticsProgram(programId: programId, forceDelete: forceDelete) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteSpeechandtextanalyticsProgramRequest.deleteSpeechandtextanalyticsProgram was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteSpeechandtextanalyticsSentimentfeedback-example.txt b/build/docs/deleteSpeechandtextanalyticsSentimentfeedback-example.txt new file mode 100644 index 000000000..0659c6033 --- /dev/null +++ b/build/docs/deleteSpeechandtextanalyticsSentimentfeedback-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete All Speech & Text Analytics SentimentFeedback +DeleteSpeechandtextanalyticsSentimentfeedbackRequest.deleteSpeechandtextanalyticsSentimentfeedback() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteSpeechandtextanalyticsSentimentfeedbackRequest.deleteSpeechandtextanalyticsSentimentfeedback was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId-example.txt b/build/docs/deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId-example.txt new file mode 100644 index 000000000..50290ae13 --- /dev/null +++ b/build/docs/deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sentimentFeedbackId: String = "" // The Id of the SentimentFeedback + +// Delete a Speech & Text Analytics SentimentFeedback by Id +DeleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackIdRequest.deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId: sentimentFeedbackId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackIdRequest.deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteSpeechandtextanalyticsTopic-example.txt b/build/docs/deleteSpeechandtextanalyticsTopic-example.txt new file mode 100644 index 000000000..8427c166a --- /dev/null +++ b/build/docs/deleteSpeechandtextanalyticsTopic-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let topicId: String = "" // The id of the topic + +// Delete a Speech & Text Analytics topic by id +DeleteSpeechandtextanalyticsTopicRequest.deleteSpeechandtextanalyticsTopic(topicId: topicId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteSpeechandtextanalyticsTopicRequest.deleteSpeechandtextanalyticsTopic was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteStationAssociateduser-example.txt b/build/docs/deleteStationAssociateduser-example.txt new file mode 100644 index 000000000..5621f5b23 --- /dev/null +++ b/build/docs/deleteStationAssociateduser-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let stationId: String = "" // Station ID + +// Unassigns the user assigned to this station +DeleteStationAssociateduserRequest.deleteStationAssociateduser(stationId: stationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteStationAssociateduserRequest.deleteStationAssociateduser was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTeam-example.txt b/build/docs/deleteTeam-example.txt new file mode 100644 index 000000000..6684cb586 --- /dev/null +++ b/build/docs/deleteTeam-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID + +// Delete team +DeleteTeamRequest.deleteTeam(teamId: teamId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTeamRequest.deleteTeam was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTeamMembers-example.txt b/build/docs/deleteTeamMembers-example.txt new file mode 100644 index 000000000..e7eee3c10 --- /dev/null +++ b/build/docs/deleteTeamMembers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID +let _id: String = "" // Comma separated list of member ids to remove + +// Delete team members +DeleteTeamMembersRequest.deleteTeamMembers(teamId: teamId, _id: _id) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTeamMembersRequest.deleteTeamMembers was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdge-example.txt b/build/docs/deleteTelephonyProvidersEdge-example.txt new file mode 100644 index 000000000..8da7a5560 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdge-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Delete a edge. +DeleteTelephonyProvidersEdgeRequest.deleteTelephonyProvidersEdge(edgeId: edgeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgeRequest.deleteTelephonyProvidersEdge was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgeLogicalinterface-example.txt b/build/docs/deleteTelephonyProvidersEdgeLogicalinterface-example.txt new file mode 100644 index 000000000..05211fa6a --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgeLogicalinterface-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let interfaceId: String = "" // Interface ID + +// Delete an edge logical interface +DeleteTelephonyProvidersEdgeLogicalinterfaceRequest.deleteTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgeLogicalinterfaceRequest.deleteTelephonyProvidersEdgeLogicalinterface was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgeSoftwareupdate-example.txt b/build/docs/deleteTelephonyProvidersEdgeSoftwareupdate-example.txt new file mode 100644 index 000000000..db16cceb6 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgeSoftwareupdate-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Cancels any in-progress update for this edge. +DeleteTelephonyProvidersEdgeSoftwareupdateRequest.deleteTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgeSoftwareupdateRequest.deleteTelephonyProvidersEdgeSoftwareupdate was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesCertificateauthority-example.txt b/build/docs/deleteTelephonyProvidersEdgesCertificateauthority-example.txt new file mode 100644 index 000000000..802945fce --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesCertificateauthority-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let certificateId: String = "" // Certificate ID + +// Delete a certificate authority. +DeleteTelephonyProvidersEdgesCertificateauthorityRequest.deleteTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesCertificateauthorityRequest.deleteTelephonyProvidersEdgesCertificateauthority was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesDidpool-example.txt b/build/docs/deleteTelephonyProvidersEdgesDidpool-example.txt new file mode 100644 index 000000000..7a5872eb9 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesDidpool-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let didPoolId: String = "" // DID pool ID + +// Delete a DID Pool by ID. +DeleteTelephonyProvidersEdgesDidpoolRequest.deleteTelephonyProvidersEdgesDidpool(didPoolId: didPoolId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesDidpoolRequest.deleteTelephonyProvidersEdgesDidpool was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesEdgegroup-example.txt b/build/docs/deleteTelephonyProvidersEdgesEdgegroup-example.txt new file mode 100644 index 000000000..c1ec3e0e5 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesEdgegroup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeGroupId: String = "" // Edge group ID + +// Delete an edge group. +DeleteTelephonyProvidersEdgesEdgegroupRequest.deleteTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesEdgegroupRequest.deleteTelephonyProvidersEdgesEdgegroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesExtensionpool-example.txt b/build/docs/deleteTelephonyProvidersEdgesExtensionpool-example.txt new file mode 100644 index 000000000..de975e56d --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesExtensionpool-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let extensionPoolId: String = "" // Extension pool ID + +// Delete an extension pool by ID +DeleteTelephonyProvidersEdgesExtensionpoolRequest.deleteTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesExtensionpoolRequest.deleteTelephonyProvidersEdgesExtensionpool was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesPhone-example.txt b/build/docs/deleteTelephonyProvidersEdgesPhone-example.txt new file mode 100644 index 000000000..4ee759ef6 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesPhone-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneId: String = "" // Phone ID + +// Delete a Phone by ID +DeleteTelephonyProvidersEdgesPhoneRequest.deleteTelephonyProvidersEdgesPhone(phoneId: phoneId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesPhoneRequest.deleteTelephonyProvidersEdgesPhone was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesPhonebasesetting-example.txt b/build/docs/deleteTelephonyProvidersEdgesPhonebasesetting-example.txt new file mode 100644 index 000000000..5f3d8eebc --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesPhonebasesetting-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneBaseId: String = "" // Phone base ID + +// Delete a Phone Base Settings by ID +DeleteTelephonyProvidersEdgesPhonebasesettingRequest.deleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesPhonebasesettingRequest.deleteTelephonyProvidersEdgesPhonebasesetting was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesSite-example.txt b/build/docs/deleteTelephonyProvidersEdgesSite-example.txt new file mode 100644 index 000000000..3823d4bf6 --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesSite-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID + +// Delete a Site by ID +DeleteTelephonyProvidersEdgesSiteRequest.deleteTelephonyProvidersEdgesSite(siteId: siteId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesSiteRequest.deleteTelephonyProvidersEdgesSite was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesSiteOutboundroute-example.txt b/build/docs/deleteTelephonyProvidersEdgesSiteOutboundroute-example.txt new file mode 100644 index 000000000..304701fad --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesSiteOutboundroute-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let outboundRouteId: String = "" // Outbound route ID + +// Delete Outbound Route +DeleteTelephonyProvidersEdgesSiteOutboundrouteRequest.deleteTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesSiteOutboundrouteRequest.deleteTelephonyProvidersEdgesSiteOutboundroute was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTelephonyProvidersEdgesTrunkbasesetting-example.txt b/build/docs/deleteTelephonyProvidersEdgesTrunkbasesetting-example.txt new file mode 100644 index 000000000..d1cc329ce --- /dev/null +++ b/build/docs/deleteTelephonyProvidersEdgesTrunkbasesetting-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkBaseSettingsId: String = "" // Trunk Base ID + +// Delete a Trunk Base Settings object by ID +DeleteTelephonyProvidersEdgesTrunkbasesettingRequest.deleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTelephonyProvidersEdgesTrunkbasesettingRequest.deleteTelephonyProvidersEdgesTrunkbasesetting was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteToken-example.txt b/build/docs/deleteToken-example.txt new file mode 100644 index 000000000..4af414d8e --- /dev/null +++ b/build/docs/deleteToken-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Delete all auth tokens for the specified user. +DeleteTokenRequest.deleteToken(userId: userId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTokenRequest.deleteToken was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteTokensMe-example.txt b/build/docs/deleteTokensMe-example.txt new file mode 100644 index 000000000..b7470f3cf --- /dev/null +++ b/build/docs/deleteTokensMe-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete auth token used to make the request. +DeleteTokensMeRequest.deleteTokensMe() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteTokensMeRequest.deleteTokensMe was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteUser-example.txt b/build/docs/deleteUser-example.txt new file mode 100644 index 000000000..c6d281b86 --- /dev/null +++ b/build/docs/deleteUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Delete user +DeleteUserRequest.deleteUser(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteUserRequest.deleteUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteUserRoutinglanguage-example.txt b/build/docs/deleteUserRoutinglanguage-example.txt new file mode 100644 index 000000000..7152a15af --- /dev/null +++ b/build/docs/deleteUserRoutinglanguage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let languageId: String = "" // languageId + +// Remove routing language from user +DeleteUserRoutinglanguageRequest.deleteUserRoutinglanguage(userId: userId, languageId: languageId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteUserRoutinglanguageRequest.deleteUserRoutinglanguage was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteUserRoutingskill-example.txt b/build/docs/deleteUserRoutingskill-example.txt new file mode 100644 index 000000000..2490ee6d9 --- /dev/null +++ b/build/docs/deleteUserRoutingskill-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let skillId: String = "" // skillId + +// Remove routing skill from user +DeleteUserRoutingskillRequest.deleteUserRoutingskill(userId: userId, skillId: skillId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteUserRoutingskillRequest.deleteUserRoutingskill was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteUserStationAssociatedstation-example.txt b/build/docs/deleteUserStationAssociatedstation-example.txt new file mode 100644 index 000000000..abf6fb68c --- /dev/null +++ b/build/docs/deleteUserStationAssociatedstation-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Clear associated station +DeleteUserStationAssociatedstationRequest.deleteUserStationAssociatedstation(userId: userId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteUserStationAssociatedstationRequest.deleteUserStationAssociatedstation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteUserStationDefaultstation-example.txt b/build/docs/deleteUserStationDefaultstation-example.txt new file mode 100644 index 000000000..721d404e0 --- /dev/null +++ b/build/docs/deleteUserStationDefaultstation-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Clear default station +DeleteUserStationDefaultstationRequest.deleteUserStationDefaultstation(userId: userId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteUserStationDefaultstationRequest.deleteUserStationDefaultstation was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteUserrecording-example.txt b/build/docs/deleteUserrecording-example.txt new file mode 100644 index 000000000..3101f1b4c --- /dev/null +++ b/build/docs/deleteUserrecording-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recordingId: String = "" // User Recording ID + +// Delete a user recording. +DeleteUserrecordingRequest.deleteUserrecording(recordingId: recordingId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteUserrecordingRequest.deleteUserrecording was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteVoicemailMessage-example.txt b/build/docs/deleteVoicemailMessage-example.txt new file mode 100644 index 000000000..b4afb9cfe --- /dev/null +++ b/build/docs/deleteVoicemailMessage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // Message ID + +// Delete a voicemail message. +DeleteVoicemailMessageRequest.deleteVoicemailMessage(messageId: messageId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteVoicemailMessageRequest.deleteVoicemailMessage was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteVoicemailMessages-example.txt b/build/docs/deleteVoicemailMessages-example.txt new file mode 100644 index 000000000..86641fbe4 --- /dev/null +++ b/build/docs/deleteVoicemailMessages-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete all voicemail messages +DeleteVoicemailMessagesRequest.deleteVoicemailMessages() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteVoicemailMessagesRequest.deleteVoicemailMessages was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebchatDeployment-example.txt b/build/docs/deleteWebchatDeployment-example.txt new file mode 100644 index 000000000..ba5dea7ee --- /dev/null +++ b/build/docs/deleteWebchatDeployment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Deployment Id + +// Delete a WebChat deployment +DeleteWebchatDeploymentRequest.deleteWebchatDeployment(deploymentId: deploymentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebchatDeploymentRequest.deleteWebchatDeployment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebchatGuestConversationMember-example.txt b/build/docs/deleteWebchatGuestConversationMember-example.txt new file mode 100644 index 000000000..1db8f840a --- /dev/null +++ b/build/docs/deleteWebchatGuestConversationMember-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let memberId: String = "" // memberId + +// Remove a member from a chat conversation +DeleteWebchatGuestConversationMemberRequest.deleteWebchatGuestConversationMember(conversationId: conversationId, memberId: memberId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebchatGuestConversationMemberRequest.deleteWebchatGuestConversationMember was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebchatSettings-example.txt b/build/docs/deleteWebchatSettings-example.txt new file mode 100644 index 000000000..6fb5bceaa --- /dev/null +++ b/build/docs/deleteWebchatSettings-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Remove WebChat deployment settings +DeleteWebchatSettingsRequest.deleteWebchatSettings() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebchatSettingsRequest.deleteWebchatSettings was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebdeploymentsConfiguration-example.txt b/build/docs/deleteWebdeploymentsConfiguration-example.txt new file mode 100644 index 000000000..97044b269 --- /dev/null +++ b/build/docs/deleteWebdeploymentsConfiguration-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID + +// Delete all versions of a configuration +DeleteWebdeploymentsConfigurationRequest.deleteWebdeploymentsConfiguration(configurationId: configurationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebdeploymentsConfigurationRequest.deleteWebdeploymentsConfiguration was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebdeploymentsDeployment-example.txt b/build/docs/deleteWebdeploymentsDeployment-example.txt new file mode 100644 index 000000000..089c6382f --- /dev/null +++ b/build/docs/deleteWebdeploymentsDeployment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // The deployment ID + +// Delete a deployment +DeleteWebdeploymentsDeploymentRequest.deleteWebdeploymentsDeployment(deploymentId: deploymentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebdeploymentsDeploymentRequest.deleteWebdeploymentsDeployment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWebdeploymentsDeploymentCobrowseSessionId-example.txt b/build/docs/deleteWebdeploymentsDeploymentCobrowseSessionId-example.txt new file mode 100644 index 000000000..10e592511 --- /dev/null +++ b/build/docs/deleteWebdeploymentsDeploymentCobrowseSessionId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // WebMessaging deployment ID +let sessionId: String = "" // Cobrowse session id or join code + +// Deletes a cobrowse session +DeleteWebdeploymentsDeploymentCobrowseSessionIdRequest.deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId: deploymentId, sessionId: sessionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteWebdeploymentsDeploymentCobrowseSessionIdRequest.deleteWebdeploymentsDeploymentCobrowseSessionId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteWebdeploymentsTokenRevoke-example.txt b/build/docs/deleteWebdeploymentsTokenRevoke-example.txt new file mode 100644 index 000000000..df4c66afc --- /dev/null +++ b/build/docs/deleteWebdeploymentsTokenRevoke-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let xJourneySessionId: String = "" // The Customer's journey sessionId. +let xJourneySessionType: String = "" // The Customer's journey session type. + +// Invalidate JWT +DeleteWebdeploymentsTokenRevokeRequest.deleteWebdeploymentsTokenRevoke(xJourneySessionId: xJourneySessionId, xJourneySessionType: xJourneySessionType) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWebdeploymentsTokenRevokeRequest.deleteWebdeploymentsTokenRevoke was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWidgetsDeployment-example.txt b/build/docs/deleteWidgetsDeployment-example.txt new file mode 100644 index 000000000..2756bad07 --- /dev/null +++ b/build/docs/deleteWidgetsDeployment-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Widget Config Id + +// Delete a Widget deployment +DeleteWidgetsDeploymentRequest.deleteWidgetsDeployment(deploymentId: deploymentId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWidgetsDeploymentRequest.deleteWidgetsDeployment was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunit-example.txt b/build/docs/deleteWorkforcemanagementBusinessunit-example.txt new file mode 100644 index 000000000..eb2231af2 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunit-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. + +// Delete business unit +DeleteWorkforcemanagementBusinessunitRequest.deleteWorkforcemanagementBusinessunit(businessUnitId: businessUnitId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitRequest.deleteWorkforcemanagementBusinessunit was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitActivitycode-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitActivitycode-example.txt new file mode 100644 index 000000000..20e0ccc6b --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitActivitycode-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let activityCodeId: String = "" // The ID of the activity code to delete + +// Deletes an activity code +DeleteWorkforcemanagementBusinessunitActivitycodeRequest.deleteWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitActivitycodeRequest.deleteWorkforcemanagementBusinessunitActivitycode was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitPlanninggroup-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitPlanninggroup-example.txt new file mode 100644 index 000000000..1ee341e3f --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitPlanninggroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let planningGroupId: String = "" // The ID of a planning group to delete + +// Deletes the planning group +DeleteWorkforcemanagementBusinessunitPlanninggroupRequest.deleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitPlanninggroupRequest.deleteWorkforcemanagementBusinessunitPlanninggroup was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitSchedulingRun-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitSchedulingRun-example.txt new file mode 100644 index 000000000..be104898b --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitSchedulingRun-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let runId: String = "" // The ID of the schedule run + +// Cancel a scheduling run +DeleteWorkforcemanagementBusinessunitSchedulingRunRequest.deleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitSchedulingRunRequest.deleteWorkforcemanagementBusinessunitSchedulingRun was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitServicegoaltemplate-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitServicegoaltemplate-example.txt new file mode 100644 index 000000000..956a24f65 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitServicegoaltemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let serviceGoalTemplateId: String = "" // The ID of the service goal template to delete + +// Delete a service goal template +DeleteWorkforcemanagementBusinessunitServicegoaltemplateRequest.deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitServicegoaltemplateRequest.deleteWorkforcemanagementBusinessunitServicegoaltemplate was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitWeekSchedule-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitWeekSchedule-example.txt new file mode 100644 index 000000000..8b576060f --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitWeekSchedule-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule + +// Delete a schedule +DeleteWorkforcemanagementBusinessunitWeekScheduleRequest.deleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DeleteWorkforcemanagementBusinessunitWeekScheduleRequest.deleteWorkforcemanagementBusinessunitWeekSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt b/build/docs/deleteWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt new file mode 100644 index 000000000..523a50f8f --- /dev/null +++ b/build/docs/deleteWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast + +// Delete a short term forecast +DeleteWorkforcemanagementBusinessunitWeekShorttermforecastRequest.deleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementBusinessunitWeekShorttermforecastRequest.deleteWorkforcemanagementBusinessunitWeekShorttermforecast was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementCalendarUrlIcs-example.txt b/build/docs/deleteWorkforcemanagementCalendarUrlIcs-example.txt new file mode 100644 index 000000000..9e03b8e95 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementCalendarUrlIcs-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Disable generated calendar link for the current user +DeleteWorkforcemanagementCalendarUrlIcsRequest.deleteWorkforcemanagementCalendarUrlIcs() { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementCalendarUrlIcsRequest.deleteWorkforcemanagementCalendarUrlIcs was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementManagementunit-example.txt b/build/docs/deleteWorkforcemanagementManagementunit-example.txt new file mode 100644 index 000000000..37995d43a --- /dev/null +++ b/build/docs/deleteWorkforcemanagementManagementunit-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. + +// Delete management unit +DeleteWorkforcemanagementManagementunitRequest.deleteWorkforcemanagementManagementunit(managementUnitId: managementUnitId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementManagementunitRequest.deleteWorkforcemanagementManagementunit was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementManagementunitTimeofflimit-example.txt b/build/docs/deleteWorkforcemanagementManagementunitTimeofflimit-example.txt new file mode 100644 index 000000000..79b3f9488 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementManagementunitTimeofflimit-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let timeOffLimitId: String = "" // The ID of the time off limit object to delete + +// Deletes a time off limit object +DeleteWorkforcemanagementManagementunitTimeofflimitRequest.deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementManagementunitTimeofflimitRequest.deleteWorkforcemanagementManagementunitTimeofflimit was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementManagementunitTimeoffplan-example.txt b/build/docs/deleteWorkforcemanagementManagementunitTimeoffplan-example.txt new file mode 100644 index 000000000..72aa5ba78 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementManagementunitTimeoffplan-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let timeOffPlanId: String = "" // The ID of the time off plan to delete + +// Deletes a time off plan +DeleteWorkforcemanagementManagementunitTimeoffplanRequest.deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementManagementunitTimeoffplanRequest.deleteWorkforcemanagementManagementunitTimeoffplan was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementManagementunitWorkplan-example.txt b/build/docs/deleteWorkforcemanagementManagementunitWorkplan-example.txt new file mode 100644 index 000000000..39d2d8726 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementManagementunitWorkplan-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanId: String = "" // The ID of the work plan to delete + +// Delete a work plan +DeleteWorkforcemanagementManagementunitWorkplanRequest.deleteWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementManagementunitWorkplanRequest.deleteWorkforcemanagementManagementunitWorkplan was successful") + } +} \ No newline at end of file diff --git a/build/docs/deleteWorkforcemanagementManagementunitWorkplanrotation-example.txt b/build/docs/deleteWorkforcemanagementManagementunitWorkplanrotation-example.txt new file mode 100644 index 000000000..6b9b166a6 --- /dev/null +++ b/build/docs/deleteWorkforcemanagementManagementunitWorkplanrotation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanRotationId: String = "" // The ID of the work plan rotation to be deleted + +// Delete a work plan rotation +DeleteWorkforcemanagementManagementunitWorkplanrotationRequest.deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId) { (error) in + if let error = error { + dump(error) + } else { + print("DeleteWorkforcemanagementManagementunitWorkplanrotationRequest.deleteWorkforcemanagementManagementunitWorkplanrotation was successful") + } +} \ No newline at end of file diff --git a/build/docs/getAlertingAlert-example.txt b/build/docs/getAlertingAlert-example.txt new file mode 100644 index 000000000..63f2e98ba --- /dev/null +++ b/build/docs/getAlertingAlert-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID + +// Get an alert +GetAlertingAlertRequest.getAlertingAlert(alertId: alertId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingAlertRequest.getAlertingAlert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingAlertsActive-example.txt b/build/docs/getAlertingAlertsActive-example.txt new file mode 100644 index 000000000..8cb746bb1 --- /dev/null +++ b/build/docs/getAlertingAlertsActive-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Gets active alert count for a user. +GetAlertingAlertsActiveRequest.getAlertingAlertsActive() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingAlertsActiveRequest.getAlertingAlertsActive was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingInteractionstatsAlert-example.txt b/build/docs/getAlertingInteractionstatsAlert-example.txt new file mode 100644 index 000000000..bdbfa32d7 --- /dev/null +++ b/build/docs/getAlertingInteractionstatsAlert-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get an interaction stats alert +GetAlertingInteractionstatsAlertRequest.getAlertingInteractionstatsAlert(alertId: alertId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingInteractionstatsAlertRequest.getAlertingInteractionstatsAlert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingInteractionstatsAlerts-example.txt b/build/docs/getAlertingInteractionstatsAlerts-example.txt new file mode 100644 index 000000000..c66441bd1 --- /dev/null +++ b/build/docs/getAlertingInteractionstatsAlerts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: [String] = [""] // Which fields, if any, to expand + +// Get interaction stats alert list. +GetAlertingInteractionstatsAlertsRequest.getAlertingInteractionstatsAlerts(expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingInteractionstatsAlertsRequest.getAlertingInteractionstatsAlerts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingInteractionstatsAlertsUnread-example.txt b/build/docs/getAlertingInteractionstatsAlertsUnread-example.txt new file mode 100644 index 000000000..8b744b240 --- /dev/null +++ b/build/docs/getAlertingInteractionstatsAlertsUnread-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Gets user unread count of interaction stats alerts. +GetAlertingInteractionstatsAlertsUnreadRequest.getAlertingInteractionstatsAlertsUnread() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingInteractionstatsAlertsUnreadRequest.getAlertingInteractionstatsAlertsUnread was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingInteractionstatsRule-example.txt b/build/docs/getAlertingInteractionstatsRule-example.txt new file mode 100644 index 000000000..20fb2079d --- /dev/null +++ b/build/docs/getAlertingInteractionstatsRule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get an interaction stats rule. +GetAlertingInteractionstatsRuleRequest.getAlertingInteractionstatsRule(ruleId: ruleId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingInteractionstatsRuleRequest.getAlertingInteractionstatsRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingInteractionstatsRules-example.txt b/build/docs/getAlertingInteractionstatsRules-example.txt new file mode 100644 index 000000000..5582f9d26 --- /dev/null +++ b/build/docs/getAlertingInteractionstatsRules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: [String] = [""] // Which fields, if any, to expand + +// Get an interaction stats rule list. +GetAlertingInteractionstatsRulesRequest.getAlertingInteractionstatsRules(expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingInteractionstatsRulesRequest.getAlertingInteractionstatsRules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAlertingRule-example.txt b/build/docs/getAlertingRule-example.txt new file mode 100644 index 000000000..58fd48e22 --- /dev/null +++ b/build/docs/getAlertingRule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule Id + +// Get a rule. +GetAlertingRuleRequest.getAlertingRule(ruleId: ruleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAlertingRuleRequest.getAlertingRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsBotflowReportingturns-example.txt b/build/docs/getAnalyticsBotflowReportingturns-example.txt new file mode 100644 index 000000000..e4008bb82 --- /dev/null +++ b/build/docs/getAnalyticsBotflowReportingturns-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let botFlowId: String = "" // ID of the bot flow. +let after: String = "" // The cursor that points to the ID of the last item in the list of entities that has been returned. +let pageSize: String = "" // Max number of entities to return. Maximum of 250 +let interval: String = 2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z // Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss +let actionId: String = "" // Optional action ID to get the reporting turns associated to a particular flow action +let sessionId: String = "" // Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed. +let language: String = en-us // Optional language code to get the reporting turns for a particular language +let askActionResults: GetAnalyticsBotflowReportingturnsRequest.AskActionResults_getAnalyticsBotflowReportingturns = GetAnalyticsBotflowReportingturnsRequest.AskActionResults_getAnalyticsBotflowReportingturns.enummember // Optional case-insensitive comma separated list of ask action results to filter the reporting turns. + +// Get Reporting Turns. +GetAnalyticsBotflowReportingturnsRequest.getAnalyticsBotflowReportingturns(botFlowId: botFlowId, after: after, pageSize: pageSize, interval: interval, actionId: actionId, sessionId: sessionId, language: language, askActionResults: askActionResults) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsBotflowReportingturnsRequest.getAnalyticsBotflowReportingturns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsConversationDetails-example.txt b/build/docs/getAnalyticsConversationDetails-example.txt new file mode 100644 index 000000000..cef3f1254 --- /dev/null +++ b/build/docs/getAnalyticsConversationDetails-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get a conversation by id +GetAnalyticsConversationDetailsRequest.getAnalyticsConversationDetails(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsConversationDetailsRequest.getAnalyticsConversationDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsConversationsDetails-example.txt b/build/docs/getAnalyticsConversationsDetails-example.txt new file mode 100644 index 000000000..e8e23d1e3 --- /dev/null +++ b/build/docs/getAnalyticsConversationsDetails-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // Comma-separated conversation ids + +// Gets multiple conversations by id +GetAnalyticsConversationsDetailsRequest.getAnalyticsConversationsDetails(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsConversationsDetailsRequest.getAnalyticsConversationsDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsConversationsDetailsJob-example.txt b/build/docs/getAnalyticsConversationsDetailsJob-example.txt new file mode 100644 index 000000000..f994c0120 --- /dev/null +++ b/build/docs/getAnalyticsConversationsDetailsJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Get status for async query for conversation details +GetAnalyticsConversationsDetailsJobRequest.getAnalyticsConversationsDetailsJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsConversationsDetailsJobRequest.getAnalyticsConversationsDetailsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsConversationsDetailsJobResults-example.txt b/build/docs/getAnalyticsConversationsDetailsJobResults-example.txt new file mode 100644 index 000000000..f26bc2588 --- /dev/null +++ b/build/docs/getAnalyticsConversationsDetailsJobResults-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId +let cursor: String = "" // Indicates where to resume query results (not required for first page) +let pageSize: Int = 0 // The desired maximum number of results + +// Fetch a page of results for an async details job +GetAnalyticsConversationsDetailsJobResultsRequest.getAnalyticsConversationsDetailsJobResults(jobId: jobId, cursor: cursor, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsConversationsDetailsJobResultsRequest.getAnalyticsConversationsDetailsJobResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsConversationsDetailsJobsAvailability-example.txt b/build/docs/getAnalyticsConversationsDetailsJobsAvailability-example.txt new file mode 100644 index 000000000..08f53021d --- /dev/null +++ b/build/docs/getAnalyticsConversationsDetailsJobsAvailability-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Lookup the datalake availability date and time +GetAnalyticsConversationsDetailsJobsAvailabilityRequest.getAnalyticsConversationsDetailsJobsAvailability() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsConversationsDetailsJobsAvailabilityRequest.getAnalyticsConversationsDetailsJobsAvailability was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsDataretentionSettings-example.txt b/build/docs/getAnalyticsDataretentionSettings-example.txt new file mode 100644 index 000000000..5a6b189f2 --- /dev/null +++ b/build/docs/getAnalyticsDataretentionSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get analytics data retention setting +GetAnalyticsDataretentionSettingsRequest.getAnalyticsDataretentionSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsDataretentionSettingsRequest.getAnalyticsDataretentionSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingExports-example.txt b/build/docs/getAnalyticsReportingExports-example.txt new file mode 100644 index 000000000..5730f94ae --- /dev/null +++ b/build/docs/getAnalyticsReportingExports-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get all view export requests for a user +GetAnalyticsReportingExportsRequest.getAnalyticsReportingExports(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingExportsRequest.getAnalyticsReportingExports was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingExportsMetadata-example.txt b/build/docs/getAnalyticsReportingExportsMetadata-example.txt new file mode 100644 index 000000000..8ae1d84a6 --- /dev/null +++ b/build/docs/getAnalyticsReportingExportsMetadata-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get all export metadata +GetAnalyticsReportingExportsMetadataRequest.getAnalyticsReportingExportsMetadata() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingExportsMetadataRequest.getAnalyticsReportingExportsMetadata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingMetadata-example.txt b/build/docs/getAnalyticsReportingMetadata-example.txt new file mode 100644 index 000000000..e3484a84d --- /dev/null +++ b/build/docs/getAnalyticsReportingMetadata-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let locale: String = "" // Locale + +// Get list of reporting metadata. +GetAnalyticsReportingMetadataRequest.getAnalyticsReportingMetadata(pageNumber: pageNumber, pageSize: pageSize, locale: locale) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingMetadataRequest.getAnalyticsReportingMetadata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingReportIdMetadata-example.txt b/build/docs/getAnalyticsReportingReportIdMetadata-example.txt new file mode 100644 index 000000000..6370dabe0 --- /dev/null +++ b/build/docs/getAnalyticsReportingReportIdMetadata-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let reportId: String = "" // Report ID +let locale: String = "" // Locale + +// Get a reporting metadata. +GetAnalyticsReportingReportIdMetadataRequest.getAnalyticsReportingReportIdMetadata(reportId: reportId, locale: locale) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingReportIdMetadataRequest.getAnalyticsReportingReportIdMetadata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingReportformats-example.txt b/build/docs/getAnalyticsReportingReportformats-example.txt new file mode 100644 index 000000000..904a16d1e --- /dev/null +++ b/build/docs/getAnalyticsReportingReportformats-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of report formats +GetAnalyticsReportingReportformatsRequest.getAnalyticsReportingReportformats() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingReportformatsRequest.getAnalyticsReportingReportformats was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingSchedule-example.txt b/build/docs/getAnalyticsReportingSchedule-example.txt new file mode 100644 index 000000000..682a3c1a9 --- /dev/null +++ b/build/docs/getAnalyticsReportingSchedule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Get a scheduled report job. +GetAnalyticsReportingScheduleRequest.getAnalyticsReportingSchedule(scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingScheduleRequest.getAnalyticsReportingSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingScheduleHistory-example.txt b/build/docs/getAnalyticsReportingScheduleHistory-example.txt new file mode 100644 index 000000000..fbdbeaaa7 --- /dev/null +++ b/build/docs/getAnalyticsReportingScheduleHistory-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID +let pageNumber: Int = 0 // +let pageSize: Int = 0 // + +// Get list of completed scheduled report jobs. +GetAnalyticsReportingScheduleHistoryRequest.getAnalyticsReportingScheduleHistory(scheduleId: scheduleId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingScheduleHistoryRequest.getAnalyticsReportingScheduleHistory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingScheduleHistoryLatest-example.txt b/build/docs/getAnalyticsReportingScheduleHistoryLatest-example.txt new file mode 100644 index 000000000..0eea7f575 --- /dev/null +++ b/build/docs/getAnalyticsReportingScheduleHistoryLatest-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Get most recently completed scheduled report job. +GetAnalyticsReportingScheduleHistoryLatestRequest.getAnalyticsReportingScheduleHistoryLatest(scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingScheduleHistoryLatestRequest.getAnalyticsReportingScheduleHistoryLatest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingScheduleHistoryRunId-example.txt b/build/docs/getAnalyticsReportingScheduleHistoryRunId-example.txt new file mode 100644 index 000000000..78915e463 --- /dev/null +++ b/build/docs/getAnalyticsReportingScheduleHistoryRunId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let runId: String = "" // Run ID +let scheduleId: String = "" // Schedule ID + +// A completed scheduled report job +GetAnalyticsReportingScheduleHistoryRunIdRequest.getAnalyticsReportingScheduleHistoryRunId(runId: runId, scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingScheduleHistoryRunIdRequest.getAnalyticsReportingScheduleHistoryRunId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingSchedules-example.txt b/build/docs/getAnalyticsReportingSchedules-example.txt new file mode 100644 index 000000000..d90472513 --- /dev/null +++ b/build/docs/getAnalyticsReportingSchedules-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a list of scheduled report jobs +GetAnalyticsReportingSchedulesRequest.getAnalyticsReportingSchedules(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingSchedulesRequest.getAnalyticsReportingSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingSettings-example.txt b/build/docs/getAnalyticsReportingSettings-example.txt new file mode 100644 index 000000000..56e2cd723 --- /dev/null +++ b/build/docs/getAnalyticsReportingSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get AnalyticsReportingSettings for an organization +GetAnalyticsReportingSettingsRequest.getAnalyticsReportingSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingSettingsRequest.getAnalyticsReportingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsReportingTimeperiods-example.txt b/build/docs/getAnalyticsReportingTimeperiods-example.txt new file mode 100644 index 000000000..b40c1013e --- /dev/null +++ b/build/docs/getAnalyticsReportingTimeperiods-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of report time periods. +GetAnalyticsReportingTimeperiodsRequest.getAnalyticsReportingTimeperiods() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsReportingTimeperiodsRequest.getAnalyticsReportingTimeperiods was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsUsersDetailsJob-example.txt b/build/docs/getAnalyticsUsersDetailsJob-example.txt new file mode 100644 index 000000000..ffabbf0c1 --- /dev/null +++ b/build/docs/getAnalyticsUsersDetailsJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Get status for async query for user details +GetAnalyticsUsersDetailsJobRequest.getAnalyticsUsersDetailsJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsUsersDetailsJobRequest.getAnalyticsUsersDetailsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsUsersDetailsJobResults-example.txt b/build/docs/getAnalyticsUsersDetailsJobResults-example.txt new file mode 100644 index 000000000..c2a3752e1 --- /dev/null +++ b/build/docs/getAnalyticsUsersDetailsJobResults-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId +let cursor: String = "" // Indicates where to resume query results (not required for first page) +let pageSize: Int = 0 // The desired maximum number of results + +// Fetch a page of results for an async query +GetAnalyticsUsersDetailsJobResultsRequest.getAnalyticsUsersDetailsJobResults(jobId: jobId, cursor: cursor, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsUsersDetailsJobResultsRequest.getAnalyticsUsersDetailsJobResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAnalyticsUsersDetailsJobsAvailability-example.txt b/build/docs/getAnalyticsUsersDetailsJobsAvailability-example.txt new file mode 100644 index 000000000..a0b00351b --- /dev/null +++ b/build/docs/getAnalyticsUsersDetailsJobsAvailability-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Lookup the datalake availability date and time +GetAnalyticsUsersDetailsJobsAvailabilityRequest.getAnalyticsUsersDetailsJobsAvailability() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAnalyticsUsersDetailsJobsAvailabilityRequest.getAnalyticsUsersDetailsJobsAvailability was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytracking-example.txt b/build/docs/getArchitectDependencytracking-example.txt new file mode 100644 index 000000000..d9706a0f5 --- /dev/null +++ b/build/docs/getArchitectDependencytracking-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let name: String = "" // Object name to search for +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let objectType: [String] = [""] // Object type(s) to search for +let consumedResources: Bool = true // Include resources each result item consumes +let consumingResources: Bool = true // Include resources that consume each result item +let consumedResourceType: [String] = [""] // Types of consumed resources to return, if consumed resources are requested +let consumingResourceType: [String] = [""] // Types of consuming resources to return, if consuming resources are requested + +// Get Dependency Tracking objects that have a given display name +GetArchitectDependencytrackingRequest.getArchitectDependencytracking(name: name, pageNumber: pageNumber, pageSize: pageSize, objectType: objectType, consumedResources: consumedResources, consumingResources: consumingResources, consumedResourceType: consumedResourceType, consumingResourceType: consumingResourceType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingRequest.getArchitectDependencytracking was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingBuild-example.txt b/build/docs/getArchitectDependencytrackingBuild-example.txt new file mode 100644 index 000000000..4083dfde2 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingBuild-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Dependency Tracking build status for an organization +GetArchitectDependencytrackingBuildRequest.getArchitectDependencytrackingBuild() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingBuildRequest.getArchitectDependencytrackingBuild was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingConsumedresources-example.txt b/build/docs/getArchitectDependencytrackingConsumedresources-example.txt new file mode 100644 index 000000000..942af5c49 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingConsumedresources-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: String = "" // Consuming object ID +let version: String = "" // Consuming object version +let objectType: GetArchitectDependencytrackingConsumedresourcesRequest.ObjectType_getArchitectDependencytrackingConsumedresources = GetArchitectDependencytrackingConsumedresourcesRequest.ObjectType_getArchitectDependencytrackingConsumedresources.enummember // Consuming object type. Only versioned types are allowed here. +let resourceType: [String] = [""] // Types of consumed resources to show +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get resources that are consumed by a given Dependency Tracking object +GetArchitectDependencytrackingConsumedresourcesRequest.getArchitectDependencytrackingConsumedresources(_id: _id, version: version, objectType: objectType, resourceType: resourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingConsumedresourcesRequest.getArchitectDependencytrackingConsumedresources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingConsumingresources-example.txt b/build/docs/getArchitectDependencytrackingConsumingresources-example.txt new file mode 100644 index 000000000..c33a87e18 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingConsumingresources-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: String = "" // Consumed object ID +let objectType: GetArchitectDependencytrackingConsumingresourcesRequest.ObjectType_getArchitectDependencytrackingConsumingresources = GetArchitectDependencytrackingConsumingresourcesRequest.ObjectType_getArchitectDependencytrackingConsumingresources.enummember // Consumed object type +let resourceType: [String] = [""] // Types of consuming resources to show. Only versioned types are allowed here. +let version: String = "" // Object version +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let flowFilter: GetArchitectDependencytrackingConsumingresourcesRequest.FlowFilter_getArchitectDependencytrackingConsumingresources = GetArchitectDependencytrackingConsumingresourcesRequest.FlowFilter_getArchitectDependencytrackingConsumingresources.enummember // Show only checkedIn or published flows + +// Get resources that consume a given Dependency Tracking object +GetArchitectDependencytrackingConsumingresourcesRequest.getArchitectDependencytrackingConsumingresources(_id: _id, objectType: objectType, resourceType: resourceType, version: version, pageNumber: pageNumber, pageSize: pageSize, flowFilter: flowFilter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingConsumingresourcesRequest.getArchitectDependencytrackingConsumingresources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingDeletedresourceconsumers-example.txt b/build/docs/getArchitectDependencytrackingDeletedresourceconsumers-example.txt new file mode 100644 index 000000000..e28557154 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingDeletedresourceconsumers-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let name: String = "" // Name to search for +let objectType: [String] = [""] // Object type(s) to search for +let flowFilter: GetArchitectDependencytrackingDeletedresourceconsumersRequest.FlowFilter_getArchitectDependencytrackingDeletedresourceconsumers = GetArchitectDependencytrackingDeletedresourceconsumersRequest.FlowFilter_getArchitectDependencytrackingDeletedresourceconsumers.enummember // Show only checkedIn or published flows +let consumedResources: Bool = true // Return consumed resources? +let consumedResourceType: [String] = [""] // Resource type(s) to return +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get Dependency Tracking objects that consume deleted resources +GetArchitectDependencytrackingDeletedresourceconsumersRequest.getArchitectDependencytrackingDeletedresourceconsumers(name: name, objectType: objectType, flowFilter: flowFilter, consumedResources: consumedResources, consumedResourceType: consumedResourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingDeletedresourceconsumersRequest.getArchitectDependencytrackingDeletedresourceconsumers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingObject-example.txt b/build/docs/getArchitectDependencytrackingObject-example.txt new file mode 100644 index 000000000..613508a8c --- /dev/null +++ b/build/docs/getArchitectDependencytrackingObject-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: String = "" // Object ID +let version: String = "" // Object version +let objectType: GetArchitectDependencytrackingObjectRequest.ObjectType_getArchitectDependencytrackingObject = GetArchitectDependencytrackingObjectRequest.ObjectType_getArchitectDependencytrackingObject.enummember // Object type +let consumedResources: Bool = true // Include resources this item consumes +let consumingResources: Bool = true // Include resources that consume this item +let consumedResourceType: [String] = [""] // Types of consumed resources to return, if consumed resources are requested +let consumingResourceType: [String] = [""] // Types of consuming resources to return, if consuming resources are requested +let consumedResourceRequest: Bool = true // Indicate that this is going to look up a consumed resource object + +// Get a Dependency Tracking object +GetArchitectDependencytrackingObjectRequest.getArchitectDependencytrackingObject(_id: _id, version: version, objectType: objectType, consumedResources: consumedResources, consumingResources: consumingResources, consumedResourceType: consumedResourceType, consumingResourceType: consumingResourceType, consumedResourceRequest: consumedResourceRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingObjectRequest.getArchitectDependencytrackingObject was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingType-example.txt b/build/docs/getArchitectDependencytrackingType-example.txt new file mode 100644 index 000000000..590fbe663 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingType-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let typeId: String = "" // Type ID + +// Get a Dependency Tracking type. +GetArchitectDependencytrackingTypeRequest.getArchitectDependencytrackingType(typeId: typeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingTypeRequest.getArchitectDependencytrackingType was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingTypes-example.txt b/build/docs/getArchitectDependencytrackingTypes-example.txt new file mode 100644 index 000000000..33515ec92 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingTypes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get Dependency Tracking types. +GetArchitectDependencytrackingTypesRequest.getArchitectDependencytrackingTypes(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingTypesRequest.getArchitectDependencytrackingTypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectDependencytrackingUpdatedresourceconsumers-example.txt b/build/docs/getArchitectDependencytrackingUpdatedresourceconsumers-example.txt new file mode 100644 index 000000000..f3b911e98 --- /dev/null +++ b/build/docs/getArchitectDependencytrackingUpdatedresourceconsumers-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let name: String = "" // Name to search for +let objectType: [String] = [""] // Object type(s) to search for +let consumedResources: Bool = true // Return consumed resources? +let consumedResourceType: [String] = [""] // Resource type(s) to return +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get Dependency Tracking objects that depend on updated resources +GetArchitectDependencytrackingUpdatedresourceconsumersRequest.getArchitectDependencytrackingUpdatedresourceconsumers(name: name, objectType: objectType, consumedResources: consumedResources, consumedResourceType: consumedResourceType, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectDependencytrackingUpdatedresourceconsumersRequest.getArchitectDependencytrackingUpdatedresourceconsumers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectEmergencygroup-example.txt b/build/docs/getArchitectEmergencygroup-example.txt new file mode 100644 index 000000000..04f97f167 --- /dev/null +++ b/build/docs/getArchitectEmergencygroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emergencyGroupId: String = "" // Emergency group ID + +// Gets a emergency group by ID +GetArchitectEmergencygroupRequest.getArchitectEmergencygroup(emergencyGroupId: emergencyGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectEmergencygroupRequest.getArchitectEmergencygroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectEmergencygroups-example.txt b/build/docs/getArchitectEmergencygroups-example.txt new file mode 100644 index 000000000..d6b28ef51 --- /dev/null +++ b/build/docs/getArchitectEmergencygroups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name of the Emergency Group to filter by. + +// Get a list of emergency groups. +GetArchitectEmergencygroupsRequest.getArchitectEmergencygroups(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectEmergencygroupsRequest.getArchitectEmergencygroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectEmergencygroupsDivisionviews-example.txt b/build/docs/getArchitectEmergencygroupsDivisionviews-example.txt new file mode 100644 index 000000000..c5b9f5a95 --- /dev/null +++ b/build/docs/getArchitectEmergencygroupsDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID of the Emergency Groups to filter by. +let name: String = "" // Name of the Emergency Group to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a pageable list of basic emergency group objects filterable by query parameters. +GetArchitectEmergencygroupsDivisionviewsRequest.getArchitectEmergencygroupsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectEmergencygroupsDivisionviewsRequest.getArchitectEmergencygroupsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectIvr-example.txt b/build/docs/getArchitectIvr-example.txt new file mode 100644 index 000000000..5f7fbf5ba --- /dev/null +++ b/build/docs/getArchitectIvr-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ivrId: String = "" // IVR id + +// Get an IVR config. +GetArchitectIvrRequest.getArchitectIvr(ivrId: ivrId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectIvrRequest.getArchitectIvr was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectIvrs-example.txt b/build/docs/getArchitectIvrs-example.txt new file mode 100644 index 000000000..bf62f0523 --- /dev/null +++ b/build/docs/getArchitectIvrs-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name of the IVR to filter by. +let dnis: String = "" // The phone number of the IVR to filter by. +let scheduleGroup: String = "" // The Schedule Group of the IVR to filter by. + +// Get IVR configs. +GetArchitectIvrsRequest.getArchitectIvrs(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, dnis: dnis, scheduleGroup: scheduleGroup) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectIvrsRequest.getArchitectIvrs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectIvrsDivisionviews-example.txt b/build/docs/getArchitectIvrsDivisionviews-example.txt new file mode 100644 index 000000000..7bad6dfd5 --- /dev/null +++ b/build/docs/getArchitectIvrsDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID of the IVR to filter by. +let name: String = "" // Name of the IVR to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a pageable list of basic ivr configuration information objects filterable by query parameters. +GetArchitectIvrsDivisionviewsRequest.getArchitectIvrsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectIvrsDivisionviewsRequest.getArchitectIvrsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectPrompt-example.txt b/build/docs/getArchitectPrompt-example.txt new file mode 100644 index 000000000..d198b982d --- /dev/null +++ b/build/docs/getArchitectPrompt-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID + +// Get specified user prompt +GetArchitectPromptRequest.getArchitectPrompt(promptId: promptId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectPromptRequest.getArchitectPrompt was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectPromptHistoryHistoryId-example.txt b/build/docs/getArchitectPromptHistoryHistoryId-example.txt new file mode 100644 index 000000000..2543477a5 --- /dev/null +++ b/build/docs/getArchitectPromptHistoryHistoryId-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let historyId: String = "" // History request ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortOrder: String = "" // Sort order +let sortBy: GetArchitectPromptHistoryHistoryIdRequest.SortBy_getArchitectPromptHistoryHistoryId = GetArchitectPromptHistoryHistoryIdRequest.SortBy_getArchitectPromptHistoryHistoryId.enummember // Sort by +let action: [String] = [""] // Flow actions to include (omit to include all) + +// Get generated prompt history +GetArchitectPromptHistoryHistoryIdRequest.getArchitectPromptHistoryHistoryId(promptId: promptId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectPromptHistoryHistoryIdRequest.getArchitectPromptHistoryHistoryId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectPromptResource-example.txt b/build/docs/getArchitectPromptResource-example.txt new file mode 100644 index 000000000..1b2c62324 --- /dev/null +++ b/build/docs/getArchitectPromptResource-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language + +// Get specified user prompt resource +GetArchitectPromptResourceRequest.getArchitectPromptResource(promptId: promptId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectPromptResourceRequest.getArchitectPromptResource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectPromptResources-example.txt b/build/docs/getArchitectPromptResources-example.txt new file mode 100644 index 000000000..605df50bf --- /dev/null +++ b/build/docs/getArchitectPromptResources-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a pageable list of user prompt resources +GetArchitectPromptResourcesRequest.getArchitectPromptResources(promptId: promptId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectPromptResourcesRequest.getArchitectPromptResources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectPrompts-example.txt b/build/docs/getArchitectPrompts-example.txt new file mode 100644 index 000000000..af4037ca7 --- /dev/null +++ b/build/docs/getArchitectPrompts-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let name: [String] = [""] // Name +let _description: String = "" // Description +let nameOrDescription: String = "" // Name or description +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order + +// Get a pageable list of user prompts +GetArchitectPromptsRequest.getArchitectPrompts(pageNumber: pageNumber, pageSize: pageSize, name: name, _description: _description, nameOrDescription: nameOrDescription, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectPromptsRequest.getArchitectPrompts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedule-example.txt b/build/docs/getArchitectSchedule-example.txt new file mode 100644 index 000000000..4d2efbf21 --- /dev/null +++ b/build/docs/getArchitectSchedule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Get a schedule by ID +GetArchitectScheduleRequest.getArchitectSchedule(scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectScheduleRequest.getArchitectSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedulegroup-example.txt b/build/docs/getArchitectSchedulegroup-example.txt new file mode 100644 index 000000000..9e2444b70 --- /dev/null +++ b/build/docs/getArchitectSchedulegroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleGroupId: String = "" // Schedule group ID + +// Gets a schedule group by ID +GetArchitectSchedulegroupRequest.getArchitectSchedulegroup(scheduleGroupId: scheduleGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSchedulegroupRequest.getArchitectSchedulegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedulegroups-example.txt b/build/docs/getArchitectSchedulegroups-example.txt new file mode 100644 index 000000000..ca655432b --- /dev/null +++ b/build/docs/getArchitectSchedulegroups-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name of the Schedule Group to filter by. +let scheduleIds: String = "" // A comma-delimited list of Schedule IDs to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a list of schedule groups. +GetArchitectSchedulegroupsRequest.getArchitectSchedulegroups(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, scheduleIds: scheduleIds, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSchedulegroupsRequest.getArchitectSchedulegroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedulegroupsDivisionviews-example.txt b/build/docs/getArchitectSchedulegroupsDivisionviews-example.txt new file mode 100644 index 000000000..59d60d717 --- /dev/null +++ b/build/docs/getArchitectSchedulegroupsDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID of the schedule group to filter by. +let name: String = "" // Name of the schedule group to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a pageable list of basic schedule group configuration information objects filterable by query parameters. +GetArchitectSchedulegroupsDivisionviewsRequest.getArchitectSchedulegroupsDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSchedulegroupsDivisionviewsRequest.getArchitectSchedulegroupsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedules-example.txt b/build/docs/getArchitectSchedules-example.txt new file mode 100644 index 000000000..f3f230afd --- /dev/null +++ b/build/docs/getArchitectSchedules-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name of the Schedule to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a list of schedules. +GetArchitectSchedulesRequest.getArchitectSchedules(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSchedulesRequest.getArchitectSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSchedulesDivisionviews-example.txt b/build/docs/getArchitectSchedulesDivisionviews-example.txt new file mode 100644 index 000000000..3676b3978 --- /dev/null +++ b/build/docs/getArchitectSchedulesDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID of the schedule group to filter by. +let name: String = "" // Name of the schedule group to filter by. +let divisionId: [String] = [""] // List of divisionIds on which to filter. + +// Get a pageable list of basic schedule configuration information objects filterable by query parameters. +GetArchitectSchedulesDivisionviewsRequest.getArchitectSchedulesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSchedulesDivisionviewsRequest.getArchitectSchedulesDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSystemprompt-example.txt b/build/docs/getArchitectSystemprompt-example.txt new file mode 100644 index 000000000..c458a95ee --- /dev/null +++ b/build/docs/getArchitectSystemprompt-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // promptId + +// Get a system prompt +GetArchitectSystempromptRequest.getArchitectSystemprompt(promptId: promptId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSystempromptRequest.getArchitectSystemprompt was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSystempromptHistoryHistoryId-example.txt b/build/docs/getArchitectSystempromptHistoryHistoryId-example.txt new file mode 100644 index 000000000..a0fa75786 --- /dev/null +++ b/build/docs/getArchitectSystempromptHistoryHistoryId-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // promptId +let historyId: String = "" // History request ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortOrder: String = "" // Sort order +let sortBy: GetArchitectSystempromptHistoryHistoryIdRequest.SortBy_getArchitectSystempromptHistoryHistoryId = GetArchitectSystempromptHistoryHistoryIdRequest.SortBy_getArchitectSystempromptHistoryHistoryId.enummember // Sort by +let action: [String] = [""] // Flow actions to include (omit to include all) + +// Get generated prompt history +GetArchitectSystempromptHistoryHistoryIdRequest.getArchitectSystempromptHistoryHistoryId(promptId: promptId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSystempromptHistoryHistoryIdRequest.getArchitectSystempromptHistoryHistoryId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSystempromptResource-example.txt b/build/docs/getArchitectSystempromptResource-example.txt new file mode 100644 index 000000000..5f3a34ff2 --- /dev/null +++ b/build/docs/getArchitectSystempromptResource-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language + +// Get a system prompt resource. +GetArchitectSystempromptResourceRequest.getArchitectSystempromptResource(promptId: promptId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSystempromptResourceRequest.getArchitectSystempromptResource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSystempromptResources-example.txt b/build/docs/getArchitectSystempromptResources-example.txt new file mode 100644 index 000000000..e726df6a1 --- /dev/null +++ b/build/docs/getArchitectSystempromptResources-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order + +// Get system prompt resources. +GetArchitectSystempromptResourcesRequest.getArchitectSystempromptResources(promptId: promptId, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSystempromptResourcesRequest.getArchitectSystempromptResources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getArchitectSystemprompts-example.txt b/build/docs/getArchitectSystemprompts-example.txt new file mode 100644 index 000000000..d99a210d4 --- /dev/null +++ b/build/docs/getArchitectSystemprompts-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name +let _description: String = "" // Description +let nameOrDescription: String = "" // Name or description + +// Get System Prompts +GetArchitectSystempromptsRequest.getArchitectSystemprompts(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, name: name, _description: _description, nameOrDescription: nameOrDescription) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetArchitectSystempromptsRequest.getArchitectSystemprompts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuditsQueryRealtimeServicemapping-example.txt b/build/docs/getAuditsQueryRealtimeServicemapping-example.txt new file mode 100644 index 000000000..534b5628b --- /dev/null +++ b/build/docs/getAuditsQueryRealtimeServicemapping-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get service mapping information used in realtime audits. +GetAuditsQueryRealtimeServicemappingRequest.getAuditsQueryRealtimeServicemapping() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuditsQueryRealtimeServicemappingRequest.getAuditsQueryRealtimeServicemapping was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuditsQueryServicemapping-example.txt b/build/docs/getAuditsQueryServicemapping-example.txt new file mode 100644 index 000000000..5f1a2fde4 --- /dev/null +++ b/build/docs/getAuditsQueryServicemapping-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get service mapping information used in audits. +GetAuditsQueryServicemappingRequest.getAuditsQueryServicemapping() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuditsQueryServicemappingRequest.getAuditsQueryServicemapping was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuditsQueryTransactionId-example.txt b/build/docs/getAuditsQueryTransactionId-example.txt new file mode 100644 index 000000000..cb1d8627f --- /dev/null +++ b/build/docs/getAuditsQueryTransactionId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let transactionId: String = "" // Transaction ID + +// Get status of audit query execution +GetAuditsQueryTransactionIdRequest.getAuditsQueryTransactionId(transactionId: transactionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuditsQueryTransactionIdRequest.getAuditsQueryTransactionId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuditsQueryTransactionIdResults-example.txt b/build/docs/getAuditsQueryTransactionIdResults-example.txt new file mode 100644 index 000000000..f4aea952c --- /dev/null +++ b/build/docs/getAuditsQueryTransactionIdResults-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let transactionId: String = "" // Transaction ID +let cursor: String = "" // Indicates where to resume query results (not required for first page) +let pageSize: Int = 0 // Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. +let expand: [String] = [""] // Which fields, if any, to expand + +// Get results of audit query +GetAuditsQueryTransactionIdResultsRequest.getAuditsQueryTransactionIdResults(transactionId: transactionId, cursor: cursor, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuditsQueryTransactionIdResultsRequest.getAuditsQueryTransactionIdResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivision-example.txt b/build/docs/getAuthorizationDivision-example.txt new file mode 100644 index 000000000..6a60306a5 --- /dev/null +++ b/build/docs/getAuthorizationDivision-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let objectCount: Bool = true // Get count of objects in this division, grouped by type + +// Returns an authorization division. +GetAuthorizationDivisionRequest.getAuthorizationDivision(divisionId: divisionId, objectCount: objectCount) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionRequest.getAuthorizationDivision was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionGrants-example.txt b/build/docs/getAuthorizationDivisionGrants-example.txt new file mode 100644 index 000000000..4c7f43c45 --- /dev/null +++ b/build/docs/getAuthorizationDivisionGrants-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Gets all grants for a given division. +GetAuthorizationDivisionGrantsRequest.getAuthorizationDivisionGrants(divisionId: divisionId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionGrantsRequest.getAuthorizationDivisionGrants was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisions-example.txt b/build/docs/getAuthorizationDivisions-example.txt new file mode 100644 index 000000000..26025d087 --- /dev/null +++ b/build/docs/getAuthorizationDivisions-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let objectCount: Bool = true // Include the count of objects contained in the division +let _id: [String] = [""] // Optionally request specific divisions by their IDs +let name: String = "" // Search term to filter by division name + +// Retrieve a list of all divisions defined for the organization +GetAuthorizationDivisionsRequest.getAuthorizationDivisions(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, objectCount: objectCount, _id: _id, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionsRequest.getAuthorizationDivisions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionsHome-example.txt b/build/docs/getAuthorizationDivisionsHome-example.txt new file mode 100644 index 000000000..b1ce3f342 --- /dev/null +++ b/build/docs/getAuthorizationDivisionsHome-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Retrieve the home division for the organization. +GetAuthorizationDivisionsHomeRequest.getAuthorizationDivisionsHome() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionsHomeRequest.getAuthorizationDivisionsHome was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionsLimit-example.txt b/build/docs/getAuthorizationDivisionsLimit-example.txt new file mode 100644 index 000000000..dd4e04927 --- /dev/null +++ b/build/docs/getAuthorizationDivisionsLimit-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Returns the maximum allowed number of divisions. +GetAuthorizationDivisionsLimitRequest.getAuthorizationDivisionsLimit() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionsLimitRequest.getAuthorizationDivisionsLimit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionspermittedMe-example.txt b/build/docs/getAuthorizationDivisionspermittedMe-example.txt new file mode 100644 index 000000000..e8bb6fbc3 --- /dev/null +++ b/build/docs/getAuthorizationDivisionspermittedMe-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let permission: String = "" // The permission string, including the object to access, e.g. routing:queue:view +let name: String = "" // Search term to filter by division name + +// Returns which divisions the current user has the given permission in. +GetAuthorizationDivisionspermittedMeRequest.getAuthorizationDivisionspermittedMe(permission: permission, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionspermittedMeRequest.getAuthorizationDivisionspermittedMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionspermittedPagedMe-example.txt b/build/docs/getAuthorizationDivisionspermittedPagedMe-example.txt new file mode 100644 index 000000000..1f8ab7bae --- /dev/null +++ b/build/docs/getAuthorizationDivisionspermittedPagedMe-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let permission: String = "" // The permission string, including the object to access, e.g. routing:queue:view +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Returns which divisions the current user has the given permission in. +GetAuthorizationDivisionspermittedPagedMeRequest.getAuthorizationDivisionspermittedPagedMe(permission: permission, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionspermittedPagedMeRequest.getAuthorizationDivisionspermittedPagedMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationDivisionspermittedPagedSubjectId-example.txt b/build/docs/getAuthorizationDivisionspermittedPagedSubjectId-example.txt new file mode 100644 index 000000000..dc351c7dc --- /dev/null +++ b/build/docs/getAuthorizationDivisionspermittedPagedSubjectId-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let permission: String = "" // The permission string, including the object to access, e.g. routing:queue:view +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Returns which divisions the specified user has the given permission in. +GetAuthorizationDivisionspermittedPagedSubjectIdRequest.getAuthorizationDivisionspermittedPagedSubjectId(subjectId: subjectId, permission: permission, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationDivisionspermittedPagedSubjectIdRequest.getAuthorizationDivisionspermittedPagedSubjectId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationPermissions-example.txt b/build/docs/getAuthorizationPermissions-example.txt new file mode 100644 index 000000000..7ccc075d3 --- /dev/null +++ b/build/docs/getAuthorizationPermissions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let queryType: GetAuthorizationPermissionsRequest.QueryType_getAuthorizationPermissions = GetAuthorizationPermissionsRequest.QueryType_getAuthorizationPermissions.enummember // Query filter type +let query: String = "" // Comma-separated list of permissions or domains to query + +// Get all permissions. +GetAuthorizationPermissionsRequest.getAuthorizationPermissions(pageSize: pageSize, pageNumber: pageNumber, queryType: queryType, query: query) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationPermissionsRequest.getAuthorizationPermissions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationProducts-example.txt b/build/docs/getAuthorizationProducts-example.txt new file mode 100644 index 000000000..2b2b0f494 --- /dev/null +++ b/build/docs/getAuthorizationProducts-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of enabled products +GetAuthorizationProductsRequest.getAuthorizationProducts() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationProductsRequest.getAuthorizationProducts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationRole-example.txt b/build/docs/getAuthorizationRole-example.txt new file mode 100644 index 000000000..ff5b86a49 --- /dev/null +++ b/build/docs/getAuthorizationRole-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let userCount: Bool = true // Fetch the count of users who have this role granted in at least one division +let expand: [String] = [""] // Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role + +// Get a single organization role. +GetAuthorizationRoleRequest.getAuthorizationRole(roleId: roleId, userCount: userCount, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationRoleRequest.getAuthorizationRole was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationRoleComparedefaultRightRoleId-example.txt b/build/docs/getAuthorizationRoleComparedefaultRightRoleId-example.txt new file mode 100644 index 000000000..c6c3d4379 --- /dev/null +++ b/build/docs/getAuthorizationRoleComparedefaultRightRoleId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let leftRoleId: String = "" // Left Role ID +let rightRoleId: String = "" // Right Role id + +// Get an org role to default role comparison +GetAuthorizationRoleComparedefaultRightRoleIdRequest.getAuthorizationRoleComparedefaultRightRoleId(leftRoleId: leftRoleId, rightRoleId: rightRoleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationRoleComparedefaultRightRoleIdRequest.getAuthorizationRoleComparedefaultRightRoleId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationRoleSubjectgrants-example.txt b/build/docs/getAuthorizationRoleSubjectgrants-example.txt new file mode 100644 index 000000000..53c477fda --- /dev/null +++ b/build/docs/getAuthorizationRoleSubjectgrants-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// Get the subjects' granted divisions in the specified role. +GetAuthorizationRoleSubjectgrantsRequest.getAuthorizationRoleSubjectgrants(roleId: roleId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationRoleSubjectgrantsRequest.getAuthorizationRoleSubjectgrants was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationRoleUsers-example.txt b/build/docs/getAuthorizationRoleUsers-example.txt new file mode 100644 index 000000000..36729599e --- /dev/null +++ b/build/docs/getAuthorizationRoleUsers-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of the users in a specified role. +GetAuthorizationRoleUsersRequest.getAuthorizationRoleUsers(roleId: roleId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationRoleUsersRequest.getAuthorizationRoleUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationRoles-example.txt b/build/docs/getAuthorizationRoles-example.txt new file mode 100644 index 000000000..e7991feea --- /dev/null +++ b/build/docs/getAuthorizationRoles-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let name: String = "" // +let permission: [String] = [""] // +let defaultRoleId: [String] = [""] // +let userCount: Bool = true // +let _id: [String] = [""] // id + +// Retrieve a list of all roles defined for the organization +GetAuthorizationRolesRequest.getAuthorizationRoles(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, permission: permission, defaultRoleId: defaultRoleId, userCount: userCount, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationRolesRequest.getAuthorizationRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationSettings-example.txt b/build/docs/getAuthorizationSettings-example.txt new file mode 100644 index 000000000..8db570a62 --- /dev/null +++ b/build/docs/getAuthorizationSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get authorization settings +GetAuthorizationSettingsRequest.getAuthorizationSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationSettingsRequest.getAuthorizationSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationSubject-example.txt b/build/docs/getAuthorizationSubject-example.txt new file mode 100644 index 000000000..7e4599a3f --- /dev/null +++ b/build/docs/getAuthorizationSubject-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) + +// Returns a listing of roles and permissions for a user. +GetAuthorizationSubjectRequest.getAuthorizationSubject(subjectId: subjectId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationSubjectRequest.getAuthorizationSubject was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationSubjectsMe-example.txt b/build/docs/getAuthorizationSubjectsMe-example.txt new file mode 100644 index 000000000..c107ab62c --- /dev/null +++ b/build/docs/getAuthorizationSubjectsMe-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Returns a listing of roles and permissions for the currently authenticated user. +GetAuthorizationSubjectsMeRequest.getAuthorizationSubjectsMe() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationSubjectsMeRequest.getAuthorizationSubjectsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getAuthorizationSubjectsRolecounts-example.txt b/build/docs/getAuthorizationSubjectsRolecounts-example.txt new file mode 100644 index 000000000..d8bf29cbf --- /dev/null +++ b/build/docs/getAuthorizationSubjectsRolecounts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // id + +// Get the count of roles granted to a list of subjects +GetAuthorizationSubjectsRolecountsRequest.getAuthorizationSubjectsRolecounts(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetAuthorizationSubjectsRolecountsRequest.getAuthorizationSubjectsRolecounts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getBillingReportsBillableusage-example.txt b/build/docs/getBillingReportsBillableusage-example.txt new file mode 100644 index 000000000..bf11855cf --- /dev/null +++ b/build/docs/getBillingReportsBillableusage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startDate: Date = new Date(...) // The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let endDate: Date = new Date(...) // The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + +// Get a report of the billable license usages +GetBillingReportsBillableusageRequest.getBillingReportsBillableusage(startDate: startDate, endDate: endDate) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetBillingReportsBillableusageRequest.getBillingReportsBillableusage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getBillingTrusteebillingoverviewTrustorOrgId-example.txt b/build/docs/getBillingTrusteebillingoverviewTrustorOrgId-example.txt new file mode 100644 index 000000000..257efc6dc --- /dev/null +++ b/build/docs/getBillingTrusteebillingoverviewTrustorOrgId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // The organization ID of the trustor (customer) organization. +let billingPeriodIndex: Int = 0 // 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. + +// Get the billing overview for an organization that is managed by a partner. +GetBillingTrusteebillingoverviewTrustorOrgIdRequest.getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId: trustorOrgId, billingPeriodIndex: billingPeriodIndex) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetBillingTrusteebillingoverviewTrustorOrgIdRequest.getBillingTrusteebillingoverviewTrustorOrgId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCarrierservicesIntegrationsEmergencylocationsMe-example.txt b/build/docs/getCarrierservicesIntegrationsEmergencylocationsMe-example.txt new file mode 100644 index 000000000..137b98f14 --- /dev/null +++ b/build/docs/getCarrierservicesIntegrationsEmergencylocationsMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneNumber: String = "" // Phone number in E164 format + +// Get location for the logged in user +GetCarrierservicesIntegrationsEmergencylocationsMeRequest.getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber: phoneNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCarrierservicesIntegrationsEmergencylocationsMeRequest.getCarrierservicesIntegrationsEmergencylocationsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getChatSettings-example.txt b/build/docs/getChatSettings-example.txt new file mode 100644 index 000000000..1205fdf69 --- /dev/null +++ b/build/docs/getChatSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Chat Settings. +GetChatSettingsRequest.getChatSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetChatSettingsRequest.getChatSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getChatsSettings-example.txt b/build/docs/getChatsSettings-example.txt new file mode 100644 index 000000000..f9758ea3d --- /dev/null +++ b/build/docs/getChatsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Chat Settings. +GetChatsSettingsRequest.getChatsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetChatsSettingsRequest.getChatsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointment-example.txt b/build/docs/getCoachingAppointment-example.txt new file mode 100644 index 000000000..6d662436b --- /dev/null +++ b/build/docs/getCoachingAppointment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. + +// Retrieve an appointment +GetCoachingAppointmentRequest.getCoachingAppointment(appointmentId: appointmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentRequest.getCoachingAppointment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointmentAnnotation-example.txt b/build/docs/getCoachingAppointmentAnnotation-example.txt new file mode 100644 index 000000000..dcaf1d664 --- /dev/null +++ b/build/docs/getCoachingAppointmentAnnotation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let annotationId: String = "" // The ID of the annotation. + +// Retrieve an annotation. +GetCoachingAppointmentAnnotationRequest.getCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentAnnotationRequest.getCoachingAppointmentAnnotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointmentAnnotations-example.txt b/build/docs/getCoachingAppointmentAnnotations-example.txt new file mode 100644 index 000000000..059f55ff0 --- /dev/null +++ b/build/docs/getCoachingAppointmentAnnotations-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a list of annotations. +GetCoachingAppointmentAnnotationsRequest.getCoachingAppointmentAnnotations(appointmentId: appointmentId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentAnnotationsRequest.getCoachingAppointmentAnnotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointmentStatuses-example.txt b/build/docs/getCoachingAppointmentStatuses-example.txt new file mode 100644 index 000000000..cd60320b1 --- /dev/null +++ b/build/docs/getCoachingAppointmentStatuses-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get the list of status changes for a coaching appointment. +GetCoachingAppointmentStatusesRequest.getCoachingAppointmentStatuses(appointmentId: appointmentId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentStatusesRequest.getCoachingAppointmentStatuses was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointments-example.txt b/build/docs/getCoachingAppointments-example.txt new file mode 100644 index 000000000..38f181bca --- /dev/null +++ b/build/docs/getCoachingAppointments-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userIds: [String] = [""] // The user IDs for which to retrieve appointments +let interval: String = "" // 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 +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let statuses: [String] = [""] // Appointment Statuses to filter by +let facilitatorIds: [String] = [""] // The facilitator IDs for which to retrieve appointments +let sortOrder: GetCoachingAppointmentsRequest.SortOrder_getCoachingAppointments = GetCoachingAppointmentsRequest.SortOrder_getCoachingAppointments.enummember // Sort (by due date) either Asc or Desc +let relationships: [String] = [""] // Relationships to filter by +let completionInterval: String = "" // 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 +let overdue: GetCoachingAppointmentsRequest.Overdue_getCoachingAppointments = GetCoachingAppointmentsRequest.Overdue_getCoachingAppointments.enummember // Overdue status to filter by +let intervalCondition: GetCoachingAppointmentsRequest.IntervalCondition_getCoachingAppointments = GetCoachingAppointmentsRequest.IntervalCondition_getCoachingAppointments.enummember // Filter condition for interval + +// Get appointments for users and optional date range +GetCoachingAppointmentsRequest.getCoachingAppointments(userIds: userIds, interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue, intervalCondition: intervalCondition) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentsRequest.getCoachingAppointments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingAppointmentsMe-example.txt b/build/docs/getCoachingAppointmentsMe-example.txt new file mode 100644 index 000000000..e79c5e8bb --- /dev/null +++ b/build/docs/getCoachingAppointmentsMe-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let interval: String = "" // 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 +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let statuses: [String] = [""] // Appointment Statuses to filter by +let facilitatorIds: [String] = [""] // The facilitator IDs for which to retrieve appointments +let sortOrder: GetCoachingAppointmentsMeRequest.SortOrder_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.SortOrder_getCoachingAppointmentsMe.enummember // Sort (by due date) either Asc or Desc +let relationships: [String] = [""] // Relationships to filter by +let completionInterval: String = "" // 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 +let overdue: GetCoachingAppointmentsMeRequest.Overdue_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.Overdue_getCoachingAppointmentsMe.enummember // Overdue status to filter by +let intervalCondition: GetCoachingAppointmentsMeRequest.IntervalCondition_getCoachingAppointmentsMe = GetCoachingAppointmentsMeRequest.IntervalCondition_getCoachingAppointmentsMe.enummember // Filter condition for interval + +// Get my appointments for a given date range +GetCoachingAppointmentsMeRequest.getCoachingAppointmentsMe(interval: interval, pageNumber: pageNumber, pageSize: pageSize, statuses: statuses, facilitatorIds: facilitatorIds, sortOrder: sortOrder, relationships: relationships, completionInterval: completionInterval, overdue: overdue, intervalCondition: intervalCondition) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingAppointmentsMeRequest.getCoachingAppointmentsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingNotification-example.txt b/build/docs/getCoachingNotification-example.txt new file mode 100644 index 000000000..c38423119 --- /dev/null +++ b/build/docs/getCoachingNotification-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let notificationId: String = "" // The ID of the notification. +let expand: [String] = [""] // Indicates a field in the response which should be expanded. + +// Get an existing notification +GetCoachingNotificationRequest.getCoachingNotification(notificationId: notificationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingNotificationRequest.getCoachingNotification was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getCoachingNotifications-example.txt b/build/docs/getCoachingNotifications-example.txt new file mode 100644 index 000000000..d2a11ef6d --- /dev/null +++ b/build/docs/getCoachingNotifications-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let expand: [String] = [""] // Indicates a field in the response which should be expanded. + +// Retrieve the list of your notifications. +GetCoachingNotificationsRequest.getCoachingNotifications(pageNumber: pageNumber, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetCoachingNotificationsRequest.getCoachingNotifications was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementDocument-example.txt b/build/docs/getContentmanagementDocument-example.txt new file mode 100644 index 000000000..02a171af2 --- /dev/null +++ b/build/docs/getContentmanagementDocument-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a document. +GetContentmanagementDocumentRequest.getContentmanagementDocument(documentId: documentId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementDocumentRequest.getContentmanagementDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementDocumentAudits-example.txt b/build/docs/getContentmanagementDocumentAudits-example.txt new file mode 100644 index 000000000..3e3644677 --- /dev/null +++ b/build/docs/getContentmanagementDocumentAudits-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let transactionFilter: String = "" // Transaction filter +let level: String = "" // level +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order + +// Get a list of audits for a document. +GetContentmanagementDocumentAuditsRequest.getContentmanagementDocumentAudits(documentId: documentId, pageSize: pageSize, pageNumber: pageNumber, transactionFilter: transactionFilter, level: level, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementDocumentAuditsRequest.getContentmanagementDocumentAudits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementDocumentContent-example.txt b/build/docs/getContentmanagementDocumentContent-example.txt new file mode 100644 index 000000000..ec58530c3 --- /dev/null +++ b/build/docs/getContentmanagementDocumentContent-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let disposition: GetContentmanagementDocumentContentRequest.Disposition_getContentmanagementDocumentContent = GetContentmanagementDocumentContentRequest.Disposition_getContentmanagementDocumentContent.enummember // Request how the content will be downloaded: a file attachment or inline. Default is attachment. +let contentType: String = "" // The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav + +// Download a document. +GetContentmanagementDocumentContentRequest.getContentmanagementDocumentContent(documentId: documentId, disposition: disposition, contentType: contentType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementDocumentContentRequest.getContentmanagementDocumentContent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementDocuments-example.txt b/build/docs/getContentmanagementDocuments-example.txt new file mode 100644 index 000000000..49e3521ba --- /dev/null +++ b/build/docs/getContentmanagementDocuments-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let name: String = "" // Name +let expand: [String] = [""] // Which fields, if any, to expand. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // name or dateCreated +let sortOrder: String = "" // ascending or descending + +// Get a list of documents. +GetContentmanagementDocumentsRequest.getContentmanagementDocuments(workspaceId: workspaceId, name: name, expand: expand, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementDocumentsRequest.getContentmanagementDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementQuery-example.txt b/build/docs/getContentmanagementQuery-example.txt new file mode 100644 index 000000000..7f84c5e84 --- /dev/null +++ b/build/docs/getContentmanagementQuery-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queryPhrase: String = "" // Phrase tokens are ANDed together over all searchable fields +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // name or dateCreated +let sortOrder: String = "" // ascending or descending +let expand: [String] = [""] // Which fields, if any, to expand. + +// Query content +GetContentmanagementQueryRequest.getContentmanagementQuery(queryPhrase: queryPhrase, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementQueryRequest.getContentmanagementQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementSecurityprofile-example.txt b/build/docs/getContentmanagementSecurityprofile-example.txt new file mode 100644 index 000000000..e686dac9d --- /dev/null +++ b/build/docs/getContentmanagementSecurityprofile-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let securityProfileId: String = "" // Security Profile Id + +// Get a Security Profile +GetContentmanagementSecurityprofileRequest.getContentmanagementSecurityprofile(securityProfileId: securityProfileId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementSecurityprofileRequest.getContentmanagementSecurityprofile was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementSecurityprofiles-example.txt b/build/docs/getContentmanagementSecurityprofiles-example.txt new file mode 100644 index 000000000..becbd0a04 --- /dev/null +++ b/build/docs/getContentmanagementSecurityprofiles-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a List of Security Profiles +GetContentmanagementSecurityprofilesRequest.getContentmanagementSecurityprofiles() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementSecurityprofilesRequest.getContentmanagementSecurityprofiles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementShare-example.txt b/build/docs/getContentmanagementShare-example.txt new file mode 100644 index 000000000..43fde1ce8 --- /dev/null +++ b/build/docs/getContentmanagementShare-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let shareId: String = "" // Share ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Retrieve details about an existing share. +GetContentmanagementShareRequest.getContentmanagementShare(shareId: shareId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementShareRequest.getContentmanagementShare was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementSharedSharedId-example.txt b/build/docs/getContentmanagementSharedSharedId-example.txt new file mode 100644 index 000000000..fa9a6c290 --- /dev/null +++ b/build/docs/getContentmanagementSharedSharedId-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sharedId: String = "" // Shared ID +let redirect: Bool = true // Turn on or off redirect +let disposition: GetContentmanagementSharedSharedIdRequest.Disposition_getContentmanagementSharedSharedId = GetContentmanagementSharedSharedIdRequest.Disposition_getContentmanagementSharedSharedId.enummember // Request how the share content will be downloaded: attached as a file or inline. Default is attachment. +let contentType: String = "" // The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav +let expand: GetContentmanagementSharedSharedIdRequest.Expand_getContentmanagementSharedSharedId = GetContentmanagementSharedSharedIdRequest.Expand_getContentmanagementSharedSharedId.enummember // Expand some document fields + +// Get shared documents. Securely download a shared document. +GetContentmanagementSharedSharedIdRequest.getContentmanagementSharedSharedId(sharedId: sharedId, redirect: redirect, disposition: disposition, contentType: contentType, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementSharedSharedIdRequest.getContentmanagementSharedSharedId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementShares-example.txt b/build/docs/getContentmanagementShares-example.txt new file mode 100644 index 000000000..0e3955132 --- /dev/null +++ b/build/docs/getContentmanagementShares-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let entityId: String = "" // Filters the shares returned to only the entity specified by the value of this parameter. +let expand: [String] = [""] // Which fields, if any, to expand. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Gets a list of shares. You must specify at least one filter (e.g. entityId). +GetContentmanagementSharesRequest.getContentmanagementShares(entityId: entityId, expand: expand, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementSharesRequest.getContentmanagementShares was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementStatus-example.txt b/build/docs/getContentmanagementStatus-example.txt new file mode 100644 index 000000000..c09270342 --- /dev/null +++ b/build/docs/getContentmanagementStatus-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of statuses for pending operations +GetContentmanagementStatusRequest.getContentmanagementStatus(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementStatusRequest.getContentmanagementStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementStatusStatusId-example.txt b/build/docs/getContentmanagementStatusStatusId-example.txt new file mode 100644 index 000000000..bb54fb3fe --- /dev/null +++ b/build/docs/getContentmanagementStatusStatusId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let statusId: String = "" // Status ID + +// Get a status. +GetContentmanagementStatusStatusIdRequest.getContentmanagementStatusStatusId(statusId: statusId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementStatusStatusIdRequest.getContentmanagementStatusStatusId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementUsage-example.txt b/build/docs/getContentmanagementUsage-example.txt new file mode 100644 index 000000000..1940550e0 --- /dev/null +++ b/build/docs/getContentmanagementUsage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get usage details. +GetContentmanagementUsageRequest.getContentmanagementUsage() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementUsageRequest.getContentmanagementUsage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspace-example.txt b/build/docs/getContentmanagementWorkspace-example.txt new file mode 100644 index 000000000..d2f5b0304 --- /dev/null +++ b/build/docs/getContentmanagementWorkspace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a workspace. +GetContentmanagementWorkspaceRequest.getContentmanagementWorkspace(workspaceId: workspaceId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceRequest.getContentmanagementWorkspace was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaceDocuments-example.txt b/build/docs/getContentmanagementWorkspaceDocuments-example.txt new file mode 100644 index 000000000..055e2179e --- /dev/null +++ b/build/docs/getContentmanagementWorkspaceDocuments-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let expand: [String] = [""] // Which fields, if any, to expand. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // name or dateCreated +let sortOrder: String = "" // ascending or descending + +// Get a list of documents. +GetContentmanagementWorkspaceDocumentsRequest.getContentmanagementWorkspaceDocuments(workspaceId: workspaceId, expand: expand, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceDocumentsRequest.getContentmanagementWorkspaceDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaceMember-example.txt b/build/docs/getContentmanagementWorkspaceMember-example.txt new file mode 100644 index 000000000..fad9438c1 --- /dev/null +++ b/build/docs/getContentmanagementWorkspaceMember-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let memberId: String = "" // Member ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a workspace member +GetContentmanagementWorkspaceMemberRequest.getContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceMemberRequest.getContentmanagementWorkspaceMember was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaceMembers-example.txt b/build/docs/getContentmanagementWorkspaceMembers-example.txt new file mode 100644 index 000000000..e8bae9cd3 --- /dev/null +++ b/build/docs/getContentmanagementWorkspaceMembers-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a list workspace members +GetContentmanagementWorkspaceMembersRequest.getContentmanagementWorkspaceMembers(workspaceId: workspaceId, pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceMembersRequest.getContentmanagementWorkspaceMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaceTagvalue-example.txt b/build/docs/getContentmanagementWorkspaceTagvalue-example.txt new file mode 100644 index 000000000..9546e3d11 --- /dev/null +++ b/build/docs/getContentmanagementWorkspaceTagvalue-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let tagId: String = "" // Tag ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a workspace tag +GetContentmanagementWorkspaceTagvalueRequest.getContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceTagvalueRequest.getContentmanagementWorkspaceTagvalue was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaceTagvalues-example.txt b/build/docs/getContentmanagementWorkspaceTagvalues-example.txt new file mode 100644 index 000000000..391ab2794 --- /dev/null +++ b/build/docs/getContentmanagementWorkspaceTagvalues-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let value: String = "" // filter the list of tags returned +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a list of workspace tags +GetContentmanagementWorkspaceTagvaluesRequest.getContentmanagementWorkspaceTagvalues(workspaceId: workspaceId, value: value, pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspaceTagvaluesRequest.getContentmanagementWorkspaceTagvalues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getContentmanagementWorkspaces-example.txt b/build/docs/getContentmanagementWorkspaces-example.txt new file mode 100644 index 000000000..c713eb976 --- /dev/null +++ b/build/docs/getContentmanagementWorkspaces-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let access: [String] = [""] // Requested access level. +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a list of workspaces. +GetContentmanagementWorkspacesRequest.getContentmanagementWorkspaces(pageSize: pageSize, pageNumber: pageNumber, access: access, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetContentmanagementWorkspacesRequest.getContentmanagementWorkspaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversation-example.txt b/build/docs/getConversation-example.txt new file mode 100644 index 000000000..9c894bf89 --- /dev/null +++ b/build/docs/getConversation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID + +// Get conversation +GetConversationRequest.getConversation(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRequest.getConversation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationParticipantSecureivrsession-example.txt b/build/docs/getConversationParticipantSecureivrsession-example.txt new file mode 100644 index 000000000..b364f7690 --- /dev/null +++ b/build/docs/getConversationParticipantSecureivrsession-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let secureSessionId: String = "" // secure IVR session ID + +// Fetch info on a secure session +GetConversationParticipantSecureivrsessionRequest.getConversationParticipantSecureivrsession(conversationId: conversationId, participantId: participantId, secureSessionId: secureSessionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationParticipantSecureivrsessionRequest.getConversationParticipantSecureivrsession was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationParticipantSecureivrsessions-example.txt b/build/docs/getConversationParticipantSecureivrsessions-example.txt new file mode 100644 index 000000000..291a7a39f --- /dev/null +++ b/build/docs/getConversationParticipantSecureivrsessions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID + +// Get a list of secure sessions for this participant. +GetConversationParticipantSecureivrsessionsRequest.getConversationParticipantSecureivrsessions(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationParticipantSecureivrsessionsRequest.getConversationParticipantSecureivrsessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationParticipantWrapup-example.txt b/build/docs/getConversationParticipantWrapup-example.txt new file mode 100644 index 000000000..f94e7deab --- /dev/null +++ b/build/docs/getConversationParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationParticipantWrapupRequest.getConversationParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationParticipantWrapupRequest.getConversationParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationParticipantWrapupcodes-example.txt b/build/docs/getConversationParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..6b7820ccd --- /dev/null +++ b/build/docs/getConversationParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID + +// Get list of wrapup codes for this conversation participant +GetConversationParticipantWrapupcodesRequest.getConversationParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationParticipantWrapupcodesRequest.getConversationParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecording-example.txt b/build/docs/getConversationRecording-example.txt new file mode 100644 index 000000000..c3a67fcdb --- /dev/null +++ b/build/docs/getConversationRecording-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let formatId: GetConversationRecordingRequest.FormatId_getConversationRecording = GetConversationRecordingRequest.FormatId_getConversationRecording.enummember // The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE +let emailFormatId: GetConversationRecordingRequest.EmailFormatId_getConversationRecording = GetConversationRecordingRequest.EmailFormatId_getConversationRecording.enummember // The desired media format when downloading an email recording. Valid values:EML,NONE +let chatFormatId: GetConversationRecordingRequest.ChatFormatId_getConversationRecording = GetConversationRecordingRequest.ChatFormatId_getConversationRecording.enummember // The desired media format when downloading a chat recording. Valid values:ZIP,NONE +let messageFormatId: GetConversationRecordingRequest.MessageFormatId_getConversationRecording = GetConversationRecordingRequest.MessageFormatId_getConversationRecording.enummember // The desired media format when downloading a message recording. Valid values:ZIP,NONE +let download: Bool = true // requesting a download format of the recording. Valid values:true,false +let fileName: String = "" // the name of the downloaded fileName +let locale: String = "" // The locale for the requested file when downloading, as an ISO 639-1 code +let mediaFormats: [String] = [""] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 + +// Gets a specific recording. +GetConversationRecordingRequest.getConversationRecording(conversationId: conversationId, recordingId: recordingId, formatId: formatId, emailFormatId: emailFormatId, chatFormatId: chatFormatId, messageFormatId: messageFormatId, download: download, fileName: fileName, locale: locale, mediaFormats: mediaFormats) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingRequest.getConversationRecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecordingAnnotation-example.txt b/build/docs/getConversationRecordingAnnotation-example.txt new file mode 100644 index 000000000..43191e3e8 --- /dev/null +++ b/build/docs/getConversationRecordingAnnotation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let annotationId: String = "" // Annotation ID + +// Get annotation +GetConversationRecordingAnnotationRequest.getConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingAnnotationRequest.getConversationRecordingAnnotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecordingAnnotations-example.txt b/build/docs/getConversationRecordingAnnotations-example.txt new file mode 100644 index 000000000..49023a62b --- /dev/null +++ b/build/docs/getConversationRecordingAnnotations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID + +// Get annotations for recording +GetConversationRecordingAnnotationsRequest.getConversationRecordingAnnotations(conversationId: conversationId, recordingId: recordingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingAnnotationsRequest.getConversationRecordingAnnotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecordingmetadata-example.txt b/build/docs/getConversationRecordingmetadata-example.txt new file mode 100644 index 000000000..c2c241d6f --- /dev/null +++ b/build/docs/getConversationRecordingmetadata-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID + +// Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing. +GetConversationRecordingmetadataRequest.getConversationRecordingmetadata(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingmetadataRequest.getConversationRecordingmetadata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecordingmetadataRecordingId-example.txt b/build/docs/getConversationRecordingmetadataRecordingId-example.txt new file mode 100644 index 000000000..3e4c3e95e --- /dev/null +++ b/build/docs/getConversationRecordingmetadataRecordingId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID + +// Get metadata for a specific recording. Does not return playable media. +GetConversationRecordingmetadataRecordingIdRequest.getConversationRecordingmetadataRecordingId(conversationId: conversationId, recordingId: recordingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingmetadataRecordingIdRequest.getConversationRecordingmetadataRecordingId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationRecordings-example.txt b/build/docs/getConversationRecordings-example.txt new file mode 100644 index 000000000..7c92730cd --- /dev/null +++ b/build/docs/getConversationRecordings-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let maxWaitMs: Int = 0 // The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. +let formatId: GetConversationRecordingsRequest.FormatId_getConversationRecordings = GetConversationRecordingsRequest.FormatId_getConversationRecordings.enummember // The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. +let mediaFormats: [String] = [""] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3. + +// Get all of a Conversation's Recordings. +GetConversationRecordingsRequest.getConversationRecordings(conversationId: conversationId, maxWaitMs: maxWaitMs, formatId: formatId, mediaFormats: mediaFormats) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationRecordingsRequest.getConversationRecordings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationSecureattributes-example.txt b/build/docs/getConversationSecureattributes-example.txt new file mode 100644 index 000000000..d0896d1a8 --- /dev/null +++ b/build/docs/getConversationSecureattributes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID + +// Get the secure attributes on a conversation. +GetConversationSecureattributesRequest.getConversationSecureattributes(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationSecureattributesRequest.getConversationSecureattributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversations-example.txt b/build/docs/getConversations-example.txt new file mode 100644 index 000000000..fd43c431a --- /dev/null +++ b/build/docs/getConversations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let communicationType: String = "" // Call or Chat communication filtering + +// Get active conversations for the logged in user +GetConversationsRequest.getConversations(communicationType: communicationType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsRequest.getConversations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCall-example.txt b/build/docs/getConversationsCall-example.txt new file mode 100644 index 000000000..6a128c569 --- /dev/null +++ b/build/docs/getConversationsCall-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get call conversation +GetConversationsCallRequest.getConversationsCall(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallRequest.getConversationsCall was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsCallParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..dc7c07fa1 --- /dev/null +++ b/build/docs/getConversationsCallParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsCallParticipantCommunicationWrapupRequest.getConversationsCallParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallParticipantCommunicationWrapupRequest.getConversationsCallParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallParticipantWrapup-example.txt b/build/docs/getConversationsCallParticipantWrapup-example.txt new file mode 100644 index 000000000..be207a0c0 --- /dev/null +++ b/build/docs/getConversationsCallParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsCallParticipantWrapupRequest.getConversationsCallParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallParticipantWrapupRequest.getConversationsCallParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallParticipantWrapupcodes-example.txt b/build/docs/getConversationsCallParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..7a084d298 --- /dev/null +++ b/build/docs/getConversationsCallParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsCallParticipantWrapupcodesRequest.getConversationsCallParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallParticipantWrapupcodesRequest.getConversationsCallParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallback-example.txt b/build/docs/getConversationsCallback-example.txt new file mode 100644 index 000000000..b9c3c1936 --- /dev/null +++ b/build/docs/getConversationsCallback-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get callback conversation +GetConversationsCallbackRequest.getConversationsCallback(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallbackRequest.getConversationsCallback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallbackParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsCallbackParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..ec643a118 --- /dev/null +++ b/build/docs/getConversationsCallbackParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsCallbackParticipantCommunicationWrapupRequest.getConversationsCallbackParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallbackParticipantCommunicationWrapupRequest.getConversationsCallbackParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallbackParticipantWrapup-example.txt b/build/docs/getConversationsCallbackParticipantWrapup-example.txt new file mode 100644 index 000000000..f8ad018a6 --- /dev/null +++ b/build/docs/getConversationsCallbackParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsCallbackParticipantWrapupRequest.getConversationsCallbackParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallbackParticipantWrapupRequest.getConversationsCallbackParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallbackParticipantWrapupcodes-example.txt b/build/docs/getConversationsCallbackParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..fe6bfdeb4 --- /dev/null +++ b/build/docs/getConversationsCallbackParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsCallbackParticipantWrapupcodesRequest.getConversationsCallbackParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallbackParticipantWrapupcodesRequest.getConversationsCallbackParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallbacks-example.txt b/build/docs/getConversationsCallbacks-example.txt new file mode 100644 index 000000000..637da4988 --- /dev/null +++ b/build/docs/getConversationsCallbacks-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active callback conversations for the logged in user +GetConversationsCallbacksRequest.getConversationsCallbacks() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallbacksRequest.getConversationsCallbacks was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCalls-example.txt b/build/docs/getConversationsCalls-example.txt new file mode 100644 index 000000000..3e2077fc1 --- /dev/null +++ b/build/docs/getConversationsCalls-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active call conversations for the logged in user +GetConversationsCallsRequest.getConversationsCalls() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallsRequest.getConversationsCalls was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallsHistory-example.txt b/build/docs/getConversationsCallsHistory-example.txt new file mode 100644 index 000000000..ec8ad9b3f --- /dev/null +++ b/build/docs/getConversationsCallsHistory-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size, maximum 50 +let pageNumber: Int = 0 // Page number +let interval: String = "" // Interval string; format is ISO-8601. Separate start and end times with forward slash '/' +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get call history +GetConversationsCallsHistoryRequest.getConversationsCallsHistory(pageSize: pageSize, pageNumber: pageNumber, interval: interval, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallsHistoryRequest.getConversationsCallsHistory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCallsMaximumconferenceparties-example.txt b/build/docs/getConversationsCallsMaximumconferenceparties-example.txt new file mode 100644 index 000000000..2e0bf4fdb --- /dev/null +++ b/build/docs/getConversationsCallsMaximumconferenceparties-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the maximum number of participants that this user can have on a conference +GetConversationsCallsMaximumconferencepartiesRequest.getConversationsCallsMaximumconferenceparties() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCallsMaximumconferencepartiesRequest.getConversationsCallsMaximumconferenceparties was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChat-example.txt b/build/docs/getConversationsChat-example.txt new file mode 100644 index 000000000..3e81a0710 --- /dev/null +++ b/build/docs/getConversationsChat-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get chat conversation +GetConversationsChatRequest.getConversationsChat(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatRequest.getConversationsChat was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChatMessage-example.txt b/build/docs/getConversationsChatMessage-example.txt new file mode 100644 index 000000000..c466779bb --- /dev/null +++ b/build/docs/getConversationsChatMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let messageId: String = "" // messageId + +// Get a web chat conversation message +GetConversationsChatMessageRequest.getConversationsChatMessage(conversationId: conversationId, messageId: messageId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatMessageRequest.getConversationsChatMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChatMessages-example.txt b/build/docs/getConversationsChatMessages-example.txt new file mode 100644 index 000000000..958391872 --- /dev/null +++ b/build/docs/getConversationsChatMessages-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let after: String = "" // If specified, get the messages chronologically after the id of this message +let before: String = "" // If specified, get the messages chronologically before the id of this message +let sortOrder: GetConversationsChatMessagesRequest.SortOrder_getConversationsChatMessages = GetConversationsChatMessagesRequest.SortOrder_getConversationsChatMessages.enummember // Sort order +let maxResults: Int = 0 // Limit the returned number of messages, up to a maximum of 100 + +// Get the messages of a chat conversation. +GetConversationsChatMessagesRequest.getConversationsChatMessages(conversationId: conversationId, after: after, before: before, sortOrder: sortOrder, maxResults: maxResults) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatMessagesRequest.getConversationsChatMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChatParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsChatParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..2b53d5a2e --- /dev/null +++ b/build/docs/getConversationsChatParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsChatParticipantCommunicationWrapupRequest.getConversationsChatParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatParticipantCommunicationWrapupRequest.getConversationsChatParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChatParticipantWrapup-example.txt b/build/docs/getConversationsChatParticipantWrapup-example.txt new file mode 100644 index 000000000..a4f167f55 --- /dev/null +++ b/build/docs/getConversationsChatParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsChatParticipantWrapupRequest.getConversationsChatParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatParticipantWrapupRequest.getConversationsChatParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChatParticipantWrapupcodes-example.txt b/build/docs/getConversationsChatParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..c34cc0f48 --- /dev/null +++ b/build/docs/getConversationsChatParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsChatParticipantWrapupcodesRequest.getConversationsChatParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatParticipantWrapupcodesRequest.getConversationsChatParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsChats-example.txt b/build/docs/getConversationsChats-example.txt new file mode 100644 index 000000000..fee31cffd --- /dev/null +++ b/build/docs/getConversationsChats-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active chat conversations for the logged in user +GetConversationsChatsRequest.getConversationsChats() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsChatsRequest.getConversationsChats was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCobrowsesession-example.txt b/build/docs/getConversationsCobrowsesession-example.txt new file mode 100644 index 000000000..663296604 --- /dev/null +++ b/build/docs/getConversationsCobrowsesession-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get cobrowse conversation +GetConversationsCobrowsesessionRequest.getConversationsCobrowsesession(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCobrowsesessionRequest.getConversationsCobrowsesession was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..de27632a8 --- /dev/null +++ b/build/docs/getConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsCobrowsesessionParticipantCommunicationWrapupRequest.getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCobrowsesessionParticipantCommunicationWrapupRequest.getConversationsCobrowsesessionParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCobrowsesessionParticipantWrapup-example.txt b/build/docs/getConversationsCobrowsesessionParticipantWrapup-example.txt new file mode 100644 index 000000000..617a5aa74 --- /dev/null +++ b/build/docs/getConversationsCobrowsesessionParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsCobrowsesessionParticipantWrapupRequest.getConversationsCobrowsesessionParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCobrowsesessionParticipantWrapupRequest.getConversationsCobrowsesessionParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCobrowsesessionParticipantWrapupcodes-example.txt b/build/docs/getConversationsCobrowsesessionParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..ed87bcfab --- /dev/null +++ b/build/docs/getConversationsCobrowsesessionParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsCobrowsesessionParticipantWrapupcodesRequest.getConversationsCobrowsesessionParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCobrowsesessionParticipantWrapupcodesRequest.getConversationsCobrowsesessionParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsCobrowsesessions-example.txt b/build/docs/getConversationsCobrowsesessions-example.txt new file mode 100644 index 000000000..50effd7eb --- /dev/null +++ b/build/docs/getConversationsCobrowsesessions-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active cobrowse conversations for the logged in user +GetConversationsCobrowsesessionsRequest.getConversationsCobrowsesessions() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsCobrowsesessionsRequest.getConversationsCobrowsesessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmail-example.txt b/build/docs/getConversationsEmail-example.txt new file mode 100644 index 000000000..74e80c748 --- /dev/null +++ b/build/docs/getConversationsEmail-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get email conversation +GetConversationsEmailRequest.getConversationsEmail(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailRequest.getConversationsEmail was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailMessage-example.txt b/build/docs/getConversationsEmailMessage-example.txt new file mode 100644 index 000000000..3275a3769 --- /dev/null +++ b/build/docs/getConversationsEmailMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let messageId: String = "" // messageId + +// Get conversation message +GetConversationsEmailMessageRequest.getConversationsEmailMessage(conversationId: conversationId, messageId: messageId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailMessageRequest.getConversationsEmailMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailMessages-example.txt b/build/docs/getConversationsEmailMessages-example.txt new file mode 100644 index 000000000..0bf6a9317 --- /dev/null +++ b/build/docs/getConversationsEmailMessages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get conversation messages +GetConversationsEmailMessagesRequest.getConversationsEmailMessages(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailMessagesRequest.getConversationsEmailMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailMessagesDraft-example.txt b/build/docs/getConversationsEmailMessagesDraft-example.txt new file mode 100644 index 000000000..8a4ae0bdb --- /dev/null +++ b/build/docs/getConversationsEmailMessagesDraft-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get conversation draft reply +GetConversationsEmailMessagesDraftRequest.getConversationsEmailMessagesDraft(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailMessagesDraftRequest.getConversationsEmailMessagesDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsEmailParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..f2dd0171d --- /dev/null +++ b/build/docs/getConversationsEmailParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsEmailParticipantCommunicationWrapupRequest.getConversationsEmailParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailParticipantCommunicationWrapupRequest.getConversationsEmailParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailParticipantWrapup-example.txt b/build/docs/getConversationsEmailParticipantWrapup-example.txt new file mode 100644 index 000000000..14003c240 --- /dev/null +++ b/build/docs/getConversationsEmailParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsEmailParticipantWrapupRequest.getConversationsEmailParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailParticipantWrapupRequest.getConversationsEmailParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailParticipantWrapupcodes-example.txt b/build/docs/getConversationsEmailParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..6075607ac --- /dev/null +++ b/build/docs/getConversationsEmailParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsEmailParticipantWrapupcodesRequest.getConversationsEmailParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailParticipantWrapupcodesRequest.getConversationsEmailParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmailSettings-example.txt b/build/docs/getConversationsEmailSettings-example.txt new file mode 100644 index 000000000..85da691f8 --- /dev/null +++ b/build/docs/getConversationsEmailSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get emails settings for a given conversation +GetConversationsEmailSettingsRequest.getConversationsEmailSettings(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailSettingsRequest.getConversationsEmailSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsEmails-example.txt b/build/docs/getConversationsEmails-example.txt new file mode 100644 index 000000000..0efe35e5f --- /dev/null +++ b/build/docs/getConversationsEmails-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active email conversations for the logged in user +GetConversationsEmailsRequest.getConversationsEmails() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsEmailsRequest.getConversationsEmails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsKeyconfiguration-example.txt b/build/docs/getConversationsKeyconfiguration-example.txt new file mode 100644 index 000000000..86c7a9ca8 --- /dev/null +++ b/build/docs/getConversationsKeyconfiguration-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let keyconfigurationsId: String = "" // Key Configurations Id + +// Get the encryption key configurations +GetConversationsKeyconfigurationRequest.getConversationsKeyconfiguration(keyconfigurationsId: keyconfigurationsId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsKeyconfigurationRequest.getConversationsKeyconfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsKeyconfigurations-example.txt b/build/docs/getConversationsKeyconfigurations-example.txt new file mode 100644 index 000000000..55aac0709 --- /dev/null +++ b/build/docs/getConversationsKeyconfigurations-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of key configurations data +GetConversationsKeyconfigurationsRequest.getConversationsKeyconfigurations() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsKeyconfigurationsRequest.getConversationsKeyconfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessage-example.txt b/build/docs/getConversationsMessage-example.txt new file mode 100644 index 000000000..8dfbe2b78 --- /dev/null +++ b/build/docs/getConversationsMessage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get message conversation +GetConversationsMessageRequest.getConversationsMessage(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageRequest.getConversationsMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageCommunicationMessagesMediaMediaId-example.txt b/build/docs/getConversationsMessageCommunicationMessagesMediaMediaId-example.txt new file mode 100644 index 000000000..3a968045c --- /dev/null +++ b/build/docs/getConversationsMessageCommunicationMessagesMediaMediaId-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId +let mediaId: String = "" // mediaId + +// Get media +GetConversationsMessageCommunicationMessagesMediaMediaIdRequest.getConversationsMessageCommunicationMessagesMediaMediaId(conversationId: conversationId, communicationId: communicationId, mediaId: mediaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageCommunicationMessagesMediaMediaIdRequest.getConversationsMessageCommunicationMessagesMediaMediaId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageDetails-example.txt b/build/docs/getConversationsMessageDetails-example.txt new file mode 100644 index 000000000..5c54f090f --- /dev/null +++ b/build/docs/getConversationsMessageDetails-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // messageId +let useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers) + +// Get message +GetConversationsMessageDetailsRequest.getConversationsMessageDetails(messageId: messageId, useNormalizedMessage: useNormalizedMessage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageDetailsRequest.getConversationsMessageDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageMessage-example.txt b/build/docs/getConversationsMessageMessage-example.txt new file mode 100644 index 000000000..8389d2612 --- /dev/null +++ b/build/docs/getConversationsMessageMessage-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let messageId: String = "" // messageId +let useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers) + +// Get conversation message +GetConversationsMessageMessageRequest.getConversationsMessageMessage(conversationId: conversationId, messageId: messageId, useNormalizedMessage: useNormalizedMessage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageMessageRequest.getConversationsMessageMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsMessageParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..74191b30a --- /dev/null +++ b/build/docs/getConversationsMessageParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsMessageParticipantCommunicationWrapupRequest.getConversationsMessageParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageParticipantCommunicationWrapupRequest.getConversationsMessageParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageParticipantWrapup-example.txt b/build/docs/getConversationsMessageParticipantWrapup-example.txt new file mode 100644 index 000000000..4f997a8cb --- /dev/null +++ b/build/docs/getConversationsMessageParticipantWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation participant. +GetConversationsMessageParticipantWrapupRequest.getConversationsMessageParticipantWrapup(conversationId: conversationId, participantId: participantId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageParticipantWrapupRequest.getConversationsMessageParticipantWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessageParticipantWrapupcodes-example.txt b/build/docs/getConversationsMessageParticipantWrapupcodes-example.txt new file mode 100644 index 000000000..13be1028c --- /dev/null +++ b/build/docs/getConversationsMessageParticipantWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Get list of wrapup codes for this conversation participant +GetConversationsMessageParticipantWrapupcodesRequest.getConversationsMessageParticipantWrapupcodes(conversationId: conversationId, participantId: participantId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessageParticipantWrapupcodesRequest.getConversationsMessageParticipantWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessages-example.txt b/build/docs/getConversationsMessages-example.txt new file mode 100644 index 000000000..6b996aa6f --- /dev/null +++ b/build/docs/getConversationsMessages-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get active message conversations for the logged in user +GetConversationsMessagesRequest.getConversationsMessages() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagesRequest.getConversationsMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagesCachedmedia-example.txt b/build/docs/getConversationsMessagesCachedmedia-example.txt new file mode 100644 index 000000000..a75ef08fd --- /dev/null +++ b/build/docs/getConversationsMessagesCachedmedia-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let url: String = "" // URL to search for + +// Get a list of cached media items +GetConversationsMessagesCachedmediaRequest.getConversationsMessagesCachedmedia(pageSize: pageSize, pageNumber: pageNumber, url: url) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagesCachedmediaRequest.getConversationsMessagesCachedmedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagesCachedmediaCachedMediaItemId-example.txt b/build/docs/getConversationsMessagesCachedmediaCachedMediaItemId-example.txt new file mode 100644 index 000000000..198574e8f --- /dev/null +++ b/build/docs/getConversationsMessagesCachedmediaCachedMediaItemId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let cachedMediaItemId: String = "" // cachedMediaItemId + +// Get a cached media item +GetConversationsMessagesCachedmediaCachedMediaItemIdRequest.getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId: cachedMediaItemId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagesCachedmediaCachedMediaItemIdRequest.getConversationsMessagesCachedmediaCachedMediaItemId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingFacebookApp-example.txt b/build/docs/getConversationsMessagingFacebookApp-example.txt new file mode 100644 index 000000000..6ea81013c --- /dev/null +++ b/build/docs/getConversationsMessagingFacebookApp-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Genesys Facebook App Id +GetConversationsMessagingFacebookAppRequest.getConversationsMessagingFacebookApp() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingFacebookAppRequest.getConversationsMessagingFacebookApp was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrations-example.txt b/build/docs/getConversationsMessagingIntegrations-example.txt new file mode 100644 index 000000000..013fbfb49 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrations-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: [String] = [""] // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of Integrations +GetConversationsMessagingIntegrationsRequest.getConversationsMessagingIntegrations(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsRequest.getConversationsMessagingIntegrations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsFacebook-example.txt b/build/docs/getConversationsMessagingIntegrationsFacebook-example.txt new file mode 100644 index 000000000..e3d0fc28d --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsFacebook-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsFacebookRequest.Expand_getConversationsMessagingIntegrationsFacebook = GetConversationsMessagingIntegrationsFacebookRequest.Expand_getConversationsMessagingIntegrationsFacebook.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of Facebook Integrations +GetConversationsMessagingIntegrationsFacebookRequest.getConversationsMessagingIntegrationsFacebook(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsFacebookRequest.getConversationsMessagingIntegrationsFacebook was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsFacebookIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsFacebookIntegrationId-example.txt new file mode 100644 index 000000000..7b7ee88e8 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsFacebookIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsFacebookIntegrationId = GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsFacebookIntegrationId.enummember // Expand instructions for the return value. + +// Get a Facebook messaging integration +GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.getConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsFacebookIntegrationIdRequest.getConversationsMessagingIntegrationsFacebookIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsInstagram-example.txt b/build/docs/getConversationsMessagingIntegrationsInstagram-example.txt new file mode 100644 index 000000000..d08b98a5f --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsInstagram-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsInstagramRequest.Expand_getConversationsMessagingIntegrationsInstagram = GetConversationsMessagingIntegrationsInstagramRequest.Expand_getConversationsMessagingIntegrationsInstagram.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of Instagram Integrations +GetConversationsMessagingIntegrationsInstagramRequest.getConversationsMessagingIntegrationsInstagram(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsInstagramRequest.getConversationsMessagingIntegrationsInstagram was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsInstagramIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsInstagramIntegrationId-example.txt new file mode 100644 index 000000000..e2802e728 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsInstagramIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsInstagramIntegrationId = GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsInstagramIntegrationId.enummember // Expand instructions for the return value. + +// Get Instagram messaging integration +GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsInstagramIntegrationIdRequest.getConversationsMessagingIntegrationsInstagramIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsLine-example.txt b/build/docs/getConversationsMessagingIntegrationsLine-example.txt new file mode 100644 index 000000000..32c673da4 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsLine-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsLineRequest.Expand_getConversationsMessagingIntegrationsLine = GetConversationsMessagingIntegrationsLineRequest.Expand_getConversationsMessagingIntegrationsLine.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of LINE messenger Integrations +GetConversationsMessagingIntegrationsLineRequest.getConversationsMessagingIntegrationsLine(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsLineRequest.getConversationsMessagingIntegrationsLine was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsLineIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsLineIntegrationId-example.txt new file mode 100644 index 000000000..527fefe12 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsLineIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsLineIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsLineIntegrationId = GetConversationsMessagingIntegrationsLineIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsLineIntegrationId.enummember // Expand instructions for the return value. + +// Get a LINE messenger integration +GetConversationsMessagingIntegrationsLineIntegrationIdRequest.getConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsLineIntegrationIdRequest.getConversationsMessagingIntegrationsLineIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsOpen-example.txt b/build/docs/getConversationsMessagingIntegrationsOpen-example.txt new file mode 100644 index 000000000..b26ccbce5 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsOpen-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsOpenRequest.Expand_getConversationsMessagingIntegrationsOpen = GetConversationsMessagingIntegrationsOpenRequest.Expand_getConversationsMessagingIntegrationsOpen.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of Open messaging integrations +GetConversationsMessagingIntegrationsOpenRequest.getConversationsMessagingIntegrationsOpen(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsOpenRequest.getConversationsMessagingIntegrationsOpen was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsOpenIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsOpenIntegrationId-example.txt new file mode 100644 index 000000000..c06dc4109 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsOpenIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsOpenIntegrationId = GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsOpenIntegrationId.enummember // Expand instructions for the return value. + +// Get an Open messaging integration +GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.getConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsOpenIntegrationIdRequest.getConversationsMessagingIntegrationsOpenIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsTwitter-example.txt b/build/docs/getConversationsMessagingIntegrationsTwitter-example.txt new file mode 100644 index 000000000..ffd7b1c1b --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsTwitter-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsTwitterRequest.Expand_getConversationsMessagingIntegrationsTwitter = GetConversationsMessagingIntegrationsTwitterRequest.Expand_getConversationsMessagingIntegrationsTwitter.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of Twitter Integrations +GetConversationsMessagingIntegrationsTwitterRequest.getConversationsMessagingIntegrationsTwitter(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsTwitterRequest.getConversationsMessagingIntegrationsTwitter was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsTwitterIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsTwitterIntegrationId-example.txt new file mode 100644 index 000000000..057b8409d --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsTwitterIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsTwitterIntegrationId = GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsTwitterIntegrationId.enummember // Expand instructions for the return value. + +// Get a Twitter messaging integration +GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsTwitterIntegrationIdRequest.getConversationsMessagingIntegrationsTwitterIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsWhatsapp-example.txt b/build/docs/getConversationsMessagingIntegrationsWhatsapp-example.txt new file mode 100644 index 000000000..d1a8cfbd0 --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsWhatsapp-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: GetConversationsMessagingIntegrationsWhatsappRequest.Expand_getConversationsMessagingIntegrationsWhatsapp = GetConversationsMessagingIntegrationsWhatsappRequest.Expand_getConversationsMessagingIntegrationsWhatsapp.enummember // Expand instructions for the return value. +let supportedContentId: String = "" // Filter integrations returned based on the supported content ID +let messagingSettingId: String = "" // Filter integrations returned based on the setting ID + +// Get a list of WhatsApp Integrations +GetConversationsMessagingIntegrationsWhatsappRequest.getConversationsMessagingIntegrationsWhatsapp(pageSize: pageSize, pageNumber: pageNumber, expand: expand, supportedContentId: supportedContentId, messagingSettingId: messagingSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsWhatsappRequest.getConversationsMessagingIntegrationsWhatsapp was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt b/build/docs/getConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt new file mode 100644 index 000000000..6d645815e --- /dev/null +++ b/build/docs/getConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let expand: GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsWhatsappIntegrationId = GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.Expand_getConversationsMessagingIntegrationsWhatsappIntegrationId.enummember // Expand instructions for the return value. + +// Get a WhatsApp messaging integration +GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.getConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.getConversationsMessagingIntegrationsWhatsappIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSetting-example.txt b/build/docs/getConversationsMessagingSetting-example.txt new file mode 100644 index 000000000..65e707268 --- /dev/null +++ b/build/docs/getConversationsMessagingSetting-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Setting ID + +// Get a messaging setting +GetConversationsMessagingSettingRequest.getConversationsMessagingSetting(messageSettingId: messageSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSettingRequest.getConversationsMessagingSetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSettings-example.txt b/build/docs/getConversationsMessagingSettings-example.txt new file mode 100644 index 000000000..97984654c --- /dev/null +++ b/build/docs/getConversationsMessagingSettings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of messaging settings +GetConversationsMessagingSettingsRequest.getConversationsMessagingSettings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSettingsRequest.getConversationsMessagingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSettingsDefault-example.txt b/build/docs/getConversationsMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..4261b2ef0 --- /dev/null +++ b/build/docs/getConversationsMessagingSettingsDefault-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the organization's default settings that will be used as the default when creating an integration. +GetConversationsMessagingSettingsDefaultRequest.getConversationsMessagingSettingsDefault() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSettingsDefaultRequest.getConversationsMessagingSettingsDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSticker-example.txt b/build/docs/getConversationsMessagingSticker-example.txt new file mode 100644 index 000000000..f935ecfef --- /dev/null +++ b/build/docs/getConversationsMessagingSticker-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messengerType: GetConversationsMessagingStickerRequest.MessengerType_getConversationsMessagingSticker = GetConversationsMessagingStickerRequest.MessengerType_getConversationsMessagingSticker.enummember // Messenger Type +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of Messaging Stickers +GetConversationsMessagingStickerRequest.getConversationsMessagingSticker(messengerType: messengerType, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingStickerRequest.getConversationsMessagingSticker was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSupportedcontent-example.txt b/build/docs/getConversationsMessagingSupportedcontent-example.txt new file mode 100644 index 000000000..6271a4bc0 --- /dev/null +++ b/build/docs/getConversationsMessagingSupportedcontent-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of Supported Content profiles +GetConversationsMessagingSupportedcontentRequest.getConversationsMessagingSupportedcontent(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSupportedcontentRequest.getConversationsMessagingSupportedcontent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSupportedcontentDefault-example.txt b/build/docs/getConversationsMessagingSupportedcontentDefault-example.txt new file mode 100644 index 000000000..e29d16117 --- /dev/null +++ b/build/docs/getConversationsMessagingSupportedcontentDefault-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the organization's default supported content profile that will be used as the default when creating an integration. +GetConversationsMessagingSupportedcontentDefaultRequest.getConversationsMessagingSupportedcontentDefault() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSupportedcontentDefaultRequest.getConversationsMessagingSupportedcontentDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/getConversationsMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..1c72e2f63 --- /dev/null +++ b/build/docs/getConversationsMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID + +// Get a supported content profile +GetConversationsMessagingSupportedcontentSupportedContentIdRequest.getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingSupportedcontentSupportedContentIdRequest.getConversationsMessagingSupportedcontentSupportedContentId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsMessagingThreadingtimeline-example.txt b/build/docs/getConversationsMessagingThreadingtimeline-example.txt new file mode 100644 index 000000000..f1d3b3ec7 --- /dev/null +++ b/build/docs/getConversationsMessagingThreadingtimeline-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get conversation threading window timeline for each messaging type +GetConversationsMessagingThreadingtimelineRequest.getConversationsMessagingThreadingtimeline() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsMessagingThreadingtimelineRequest.getConversationsMessagingThreadingtimeline was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsScreenshareParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsScreenshareParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..12ba7468b --- /dev/null +++ b/build/docs/getConversationsScreenshareParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsScreenshareParticipantCommunicationWrapupRequest.getConversationsScreenshareParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsScreenshareParticipantCommunicationWrapupRequest.getConversationsScreenshareParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsSettings-example.txt b/build/docs/getConversationsSettings-example.txt new file mode 100644 index 000000000..70b8861d2 --- /dev/null +++ b/build/docs/getConversationsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Settings +GetConversationsSettingsRequest.getConversationsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsSettingsRequest.getConversationsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsSocialParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsSocialParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..7a76e789c --- /dev/null +++ b/build/docs/getConversationsSocialParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsSocialParticipantCommunicationWrapupRequest.getConversationsSocialParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsSocialParticipantCommunicationWrapupRequest.getConversationsSocialParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getConversationsVideoParticipantCommunicationWrapup-example.txt b/build/docs/getConversationsVideoParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..db8b48789 --- /dev/null +++ b/build/docs/getConversationsVideoParticipantCommunicationWrapup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let provisional: Bool = true // Indicates if the wrap-up code is provisional. + +// Get the wrap-up for this conversation communication. +GetConversationsVideoParticipantCommunicationWrapupRequest.getConversationsVideoParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, provisional: provisional) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetConversationsVideoParticipantCommunicationWrapupRequest.getConversationsVideoParticipantCommunicationWrapup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDataextensionsCoretype-example.txt b/build/docs/getDataextensionsCoretype-example.txt new file mode 100644 index 000000000..db599fac4 --- /dev/null +++ b/build/docs/getDataextensionsCoretype-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let coretypeName: GetDataextensionsCoretypeRequest.CoretypeName_getDataextensionsCoretype = GetDataextensionsCoretypeRequest.CoretypeName_getDataextensionsCoretype.enummember // The core type's name + +// Get a specific named core type. +GetDataextensionsCoretypeRequest.getDataextensionsCoretype(coretypeName: coretypeName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDataextensionsCoretypeRequest.getDataextensionsCoretype was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDataextensionsCoretypes-example.txt b/build/docs/getDataextensionsCoretypes-example.txt new file mode 100644 index 000000000..8445dfcee --- /dev/null +++ b/build/docs/getDataextensionsCoretypes-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the core types from which all schemas are built. +GetDataextensionsCoretypesRequest.getDataextensionsCoretypes() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDataextensionsCoretypesRequest.getDataextensionsCoretypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDataextensionsLimits-example.txt b/build/docs/getDataextensionsLimits-example.txt new file mode 100644 index 000000000..d0b53e411 --- /dev/null +++ b/build/docs/getDataextensionsLimits-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get quantitative limits on schemas +GetDataextensionsLimitsRequest.getDataextensionsLimits() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDataextensionsLimitsRequest.getDataextensionsLimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDate-example.txt b/build/docs/getDate-example.txt new file mode 100644 index 000000000..73791fbc7 --- /dev/null +++ b/build/docs/getDate-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the current system date/time +GetDateRequest.getDate() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDateRequest.getDate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDocumentationGknSearch-example.txt b/build/docs/getDocumentationGknSearch-example.txt new file mode 100644 index 000000000..f8b8de629 --- /dev/null +++ b/build/docs/getDocumentationGknSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 + +// Search gkn documentation using the q64 value returned from a previous search +GetDocumentationGknSearchRequest.getDocumentationGknSearch(q64: q64) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDocumentationGknSearchRequest.getDocumentationGknSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDocumentationSearch-example.txt b/build/docs/getDocumentationSearch-example.txt new file mode 100644 index 000000000..2c4c2978a --- /dev/null +++ b/build/docs/getDocumentationSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 + +// Search documentation using the q64 value returned from a previous search +GetDocumentationSearchRequest.getDocumentationSearch(q64: q64) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDocumentationSearchRequest.getDocumentationSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getDownload-example.txt b/build/docs/getDownload-example.txt new file mode 100644 index 000000000..cd82be934 --- /dev/null +++ b/build/docs/getDownload-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let downloadId: String = "" // Download ID +let contentDisposition: String = "" // +let issueRedirect: Bool = true // +let redirectToAuth: Bool = true // + +// Issues a redirect to a signed secure download URL for specified download +GetDownloadRequest.getDownload(downloadId: downloadId, contentDisposition: contentDisposition, issueRedirect: issueRedirect, redirectToAuth: redirectToAuth) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetDownloadRequest.getDownload was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getEmailsSettings-example.txt b/build/docs/getEmailsSettings-example.txt new file mode 100644 index 000000000..038381f15 --- /dev/null +++ b/build/docs/getEmailsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get email Contact Center settings +GetEmailsSettingsRequest.getEmailsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetEmailsSettingsRequest.getEmailsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getEmployeeperformanceExternalmetricsDefinition-example.txt b/build/docs/getEmployeeperformanceExternalmetricsDefinition-example.txt new file mode 100644 index 000000000..4c76a1171 --- /dev/null +++ b/build/docs/getEmployeeperformanceExternalmetricsDefinition-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let metricId: String = "" // Specifies the External Metric Definition ID + +// Get an External Metric Definition +GetEmployeeperformanceExternalmetricsDefinitionRequest.getEmployeeperformanceExternalmetricsDefinition(metricId: metricId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetEmployeeperformanceExternalmetricsDefinitionRequest.getEmployeeperformanceExternalmetricsDefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getEmployeeperformanceExternalmetricsDefinitions-example.txt b/build/docs/getEmployeeperformanceExternalmetricsDefinitions-example.txt new file mode 100644 index 000000000..256dbee51 --- /dev/null +++ b/build/docs/getEmployeeperformanceExternalmetricsDefinitions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of External Metric Definitions of an organization, sorted by name in ascending order +GetEmployeeperformanceExternalmetricsDefinitionsRequest.getEmployeeperformanceExternalmetricsDefinitions(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetEmployeeperformanceExternalmetricsDefinitionsRequest.getEmployeeperformanceExternalmetricsDefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContact-example.txt b/build/docs/getExternalcontactsContact-example.txt new file mode 100644 index 000000000..1dd0b19ee --- /dev/null +++ b/build/docs/getExternalcontactsContact-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID +let expand: [String] = [""] // which fields, if any, to expand (externalOrganization,externalDataSources) + +// Fetch an external contact +GetExternalcontactsContactRequest.getExternalcontactsContact(contactId: contactId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactRequest.getExternalcontactsContact was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactIdentifiers-example.txt b/build/docs/getExternalcontactsContactIdentifiers-example.txt new file mode 100644 index 000000000..fdceb07dd --- /dev/null +++ b/build/docs/getExternalcontactsContactIdentifiers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID + +// List the identifiers for a contact +GetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers(contactId: contactId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactJourneySessions-example.txt b/build/docs/getExternalcontactsContactJourneySessions-example.txt new file mode 100644 index 000000000..69d8c56d4 --- /dev/null +++ b/build/docs/getExternalcontactsContactJourneySessions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let includeMerged: Bool = true // Indicates whether to return sessions from all external contacts in the merge-set of the given one. + +// Retrieve all sessions for a given external contact. +GetExternalcontactsContactJourneySessionsRequest.getExternalcontactsContactJourneySessions(contactId: contactId, pageSize: pageSize, after: after, includeMerged: includeMerged) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactJourneySessionsRequest.getExternalcontactsContactJourneySessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactNote-example.txt b/build/docs/getExternalcontactsContactNote-example.txt new file mode 100644 index 000000000..5c7cbeff5 --- /dev/null +++ b/build/docs/getExternalcontactsContactNote-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact Id +let noteId: String = "" // Note Id +let expand: [String] = [""] // which fields, if any, to expand + +// Fetch a note for an external contact +GetExternalcontactsContactNoteRequest.getExternalcontactsContactNote(contactId: contactId, noteId: noteId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactNoteRequest.getExternalcontactsContactNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactNotes-example.txt b/build/docs/getExternalcontactsContactNotes-example.txt new file mode 100644 index 000000000..534a30cdf --- /dev/null +++ b/build/docs/getExternalcontactsContactNotes-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact Id +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // which fields, if any, to expand + +// List notes for an external contact +GetExternalcontactsContactNotesRequest.getExternalcontactsContactNotes(contactId: contactId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactNotesRequest.getExternalcontactsContactNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactUnresolved-example.txt b/build/docs/getExternalcontactsContactUnresolved-example.txt new file mode 100644 index 000000000..d37ed724d --- /dev/null +++ b/build/docs/getExternalcontactsContactUnresolved-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID +let expand: [String] = [""] // which fields, if any, to expand (externalOrganization,externalDataSources) + +// Fetch an unresolved external contact +GetExternalcontactsContactUnresolvedRequest.getExternalcontactsContactUnresolved(contactId: contactId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactUnresolvedRequest.getExternalcontactsContactUnresolved was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContacts-example.txt b/build/docs/getExternalcontactsContacts-example.txt new file mode 100644 index 000000000..7f2a852d2 --- /dev/null +++ b/build/docs/getExternalcontactsContacts-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let q: String = "" // User supplied search keywords (no special syntax is currently supported) +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // which fields, if any, to expand + +// Search for external contacts +GetExternalcontactsContactsRequest.getExternalcontactsContacts(pageSize: pageSize, pageNumber: pageNumber, q: q, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactsRequest.getExternalcontactsContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactsSchema-example.txt b/build/docs/getExternalcontactsContactsSchema-example.txt new file mode 100644 index 000000000..850441827 --- /dev/null +++ b/build/docs/getExternalcontactsContactsSchema-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID + +// Get a schema +GetExternalcontactsContactsSchemaRequest.getExternalcontactsContactsSchema(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactsSchemaRequest.getExternalcontactsContactsSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactsSchemaVersion-example.txt b/build/docs/getExternalcontactsContactsSchemaVersion-example.txt new file mode 100644 index 000000000..c64502ddf --- /dev/null +++ b/build/docs/getExternalcontactsContactsSchemaVersion-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID +let versionId: String = "" // Schema version + +// Get a specific version of a schema +GetExternalcontactsContactsSchemaVersionRequest.getExternalcontactsContactsSchemaVersion(schemaId: schemaId, versionId: versionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactsSchemaVersionRequest.getExternalcontactsContactsSchemaVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactsSchemaVersions-example.txt b/build/docs/getExternalcontactsContactsSchemaVersions-example.txt new file mode 100644 index 000000000..361fa32be --- /dev/null +++ b/build/docs/getExternalcontactsContactsSchemaVersions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID + +// Get all versions of an external contact's schema +GetExternalcontactsContactsSchemaVersionsRequest.getExternalcontactsContactsSchemaVersions(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactsSchemaVersionsRequest.getExternalcontactsContactsSchemaVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsContactsSchemas-example.txt b/build/docs/getExternalcontactsContactsSchemas-example.txt new file mode 100644 index 000000000..3df436653 --- /dev/null +++ b/build/docs/getExternalcontactsContactsSchemas-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of schemas. +GetExternalcontactsContactsSchemasRequest.getExternalcontactsContactsSchemas() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsContactsSchemasRequest.getExternalcontactsContactsSchemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganization-example.txt b/build/docs/getExternalcontactsOrganization-example.txt new file mode 100644 index 000000000..ba79b2ae8 --- /dev/null +++ b/build/docs/getExternalcontactsOrganization-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID +let expand: GetExternalcontactsOrganizationRequest.Expand_getExternalcontactsOrganization = GetExternalcontactsOrganizationRequest.Expand_getExternalcontactsOrganization.enummember // which fields, if any, to expand (externalDataSources) +let includeTrustors: Bool = true // (true or false) whether or not to include trustor information embedded in the externalOrganization + +// Fetch an external organization +GetExternalcontactsOrganizationRequest.getExternalcontactsOrganization(externalOrganizationId: externalOrganizationId, expand: expand, includeTrustors: includeTrustors) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationRequest.getExternalcontactsOrganization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationContacts-example.txt b/build/docs/getExternalcontactsOrganizationContacts-example.txt new file mode 100644 index 000000000..02ea1bb90 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationContacts-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let q: String = "" // User supplied search keywords (no special syntax is currently supported) +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // which fields, if any, to expand + +// Search for external contacts in an external organization +GetExternalcontactsOrganizationContactsRequest.getExternalcontactsOrganizationContacts(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, q: q, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationContactsRequest.getExternalcontactsOrganizationContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationNote-example.txt b/build/docs/getExternalcontactsOrganizationNote-example.txt new file mode 100644 index 000000000..17db6ea6b --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationNote-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization Id +let noteId: String = "" // Note Id +let expand: [String] = [""] // which fields, if any, to expand + +// Fetch a note for an external organization +GetExternalcontactsOrganizationNoteRequest.getExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationNoteRequest.getExternalcontactsOrganizationNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationNotes-example.txt b/build/docs/getExternalcontactsOrganizationNotes-example.txt new file mode 100644 index 000000000..0b0a48d37 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationNotes-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization Id +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // which fields, if any, to expand + +// List notes for an external organization +GetExternalcontactsOrganizationNotesRequest.getExternalcontactsOrganizationNotes(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationNotesRequest.getExternalcontactsOrganizationNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationRelationships-example.txt b/build/docs/getExternalcontactsOrganizationRelationships-example.txt new file mode 100644 index 000000000..280d4e7a5 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationRelationships-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let expand: GetExternalcontactsOrganizationRelationshipsRequest.Expand_getExternalcontactsOrganizationRelationships = GetExternalcontactsOrganizationRelationshipsRequest.Expand_getExternalcontactsOrganizationRelationships.enummember // which fields, if any, to expand +let sortOrder: String = "" // Sort order + +// Fetch a relationship for an external organization +GetExternalcontactsOrganizationRelationshipsRequest.getExternalcontactsOrganizationRelationships(externalOrganizationId: externalOrganizationId, pageSize: pageSize, pageNumber: pageNumber, expand: expand, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationRelationshipsRequest.getExternalcontactsOrganizationRelationships was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizations-example.txt b/build/docs/getExternalcontactsOrganizations-example.txt new file mode 100644 index 000000000..824937386 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizations-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let pageNumber: Int = 0 // Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) +let q: String = "" // Search query +let trustorId: [String] = [""] // Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // which fields, if any, to expand +let includeTrustors: Bool = true // (true or false) whether or not to include trustor information embedded in the externalOrganization + +// Search for external organizations +GetExternalcontactsOrganizationsRequest.getExternalcontactsOrganizations(pageSize: pageSize, pageNumber: pageNumber, q: q, trustorId: trustorId, sortOrder: sortOrder, expand: expand, includeTrustors: includeTrustors) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationsRequest.getExternalcontactsOrganizations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationsSchema-example.txt b/build/docs/getExternalcontactsOrganizationsSchema-example.txt new file mode 100644 index 000000000..70d5fdaf9 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationsSchema-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID + +// Get a schema +GetExternalcontactsOrganizationsSchemaRequest.getExternalcontactsOrganizationsSchema(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationsSchemaRequest.getExternalcontactsOrganizationsSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationsSchemaVersion-example.txt b/build/docs/getExternalcontactsOrganizationsSchemaVersion-example.txt new file mode 100644 index 000000000..de24f79d6 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationsSchemaVersion-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID +let versionId: String = "" // Schema version + +// Get a specific version of a schema +GetExternalcontactsOrganizationsSchemaVersionRequest.getExternalcontactsOrganizationsSchemaVersion(schemaId: schemaId, versionId: versionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationsSchemaVersionRequest.getExternalcontactsOrganizationsSchemaVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationsSchemaVersions-example.txt b/build/docs/getExternalcontactsOrganizationsSchemaVersions-example.txt new file mode 100644 index 000000000..e1df447fb --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationsSchemaVersions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID + +// Get all versions of an external organization's schema +GetExternalcontactsOrganizationsSchemaVersionsRequest.getExternalcontactsOrganizationsSchemaVersions(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationsSchemaVersionsRequest.getExternalcontactsOrganizationsSchemaVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsOrganizationsSchemas-example.txt b/build/docs/getExternalcontactsOrganizationsSchemas-example.txt new file mode 100644 index 000000000..b68958aa9 --- /dev/null +++ b/build/docs/getExternalcontactsOrganizationsSchemas-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of schemas. +GetExternalcontactsOrganizationsSchemasRequest.getExternalcontactsOrganizationsSchemas() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsOrganizationsSchemasRequest.getExternalcontactsOrganizationsSchemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsRelationship-example.txt b/build/docs/getExternalcontactsRelationship-example.txt new file mode 100644 index 000000000..f847ecd37 --- /dev/null +++ b/build/docs/getExternalcontactsRelationship-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let relationshipId: String = "" // Relationship Id +let expand: GetExternalcontactsRelationshipRequest.Expand_getExternalcontactsRelationship = GetExternalcontactsRelationshipRequest.Expand_getExternalcontactsRelationship.enummember // which fields, if any, to expand + +// Fetch a relationship +GetExternalcontactsRelationshipRequest.getExternalcontactsRelationship(relationshipId: relationshipId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsRelationshipRequest.getExternalcontactsRelationship was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsReversewhitepageslookup-example.txt b/build/docs/getExternalcontactsReversewhitepageslookup-example.txt new file mode 100644 index 000000000..d829a84ca --- /dev/null +++ b/build/docs/getExternalcontactsReversewhitepageslookup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let lookupVal: String = "" // User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names) +let expand: [String] = [""] // which field, if any, to expand + +// Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned. +GetExternalcontactsReversewhitepageslookupRequest.getExternalcontactsReversewhitepageslookup(lookupVal: lookupVal, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsReversewhitepageslookupRequest.getExternalcontactsReversewhitepageslookup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsScanContacts-example.txt b/build/docs/getExternalcontactsScanContacts-example.txt new file mode 100644 index 000000000..bb1490dda --- /dev/null +++ b/build/docs/getExternalcontactsScanContacts-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let limit: Int = 0 // The number of contacts per page; must be between 10 and 200, default is 100) +let cursor: String = "" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL + +// Scan for external contacts using paging +GetExternalcontactsScanContactsRequest.getExternalcontactsScanContacts(limit: limit, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsScanContactsRequest.getExternalcontactsScanContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsScanNotes-example.txt b/build/docs/getExternalcontactsScanNotes-example.txt new file mode 100644 index 000000000..455a269ba --- /dev/null +++ b/build/docs/getExternalcontactsScanNotes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let limit: Int = 0 // The number of notes per page; must be between 10 and 200, default is 100) +let cursor: String = "" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL + +// Scan for notes using paging +GetExternalcontactsScanNotesRequest.getExternalcontactsScanNotes(limit: limit, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsScanNotesRequest.getExternalcontactsScanNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsScanOrganizations-example.txt b/build/docs/getExternalcontactsScanOrganizations-example.txt new file mode 100644 index 000000000..840f5f58e --- /dev/null +++ b/build/docs/getExternalcontactsScanOrganizations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let limit: Int = 0 // The number of organizations per page; must be between 10 and 200, default is 100) +let cursor: String = "" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL + +// Scan for external organizations using paging +GetExternalcontactsScanOrganizationsRequest.getExternalcontactsScanOrganizations(limit: limit, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsScanOrganizationsRequest.getExternalcontactsScanOrganizations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getExternalcontactsScanRelationships-example.txt b/build/docs/getExternalcontactsScanRelationships-example.txt new file mode 100644 index 000000000..6713a0434 --- /dev/null +++ b/build/docs/getExternalcontactsScanRelationships-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let limit: Int = 0 // The number of relationships per page; must be between 10 and 200, default is 100) +let cursor: String = "" // Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL + +// Scan for relationships +GetExternalcontactsScanRelationshipsRequest.getExternalcontactsScanRelationships(limit: limit, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetExternalcontactsScanRelationshipsRequest.getExternalcontactsScanRelationships was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFaxDocument-example.txt b/build/docs/getFaxDocument-example.txt new file mode 100644 index 000000000..0fbac5d43 --- /dev/null +++ b/build/docs/getFaxDocument-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID + +// Get a document. +GetFaxDocumentRequest.getFaxDocument(documentId: documentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFaxDocumentRequest.getFaxDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFaxDocumentContent-example.txt b/build/docs/getFaxDocumentContent-example.txt new file mode 100644 index 000000000..276ead942 --- /dev/null +++ b/build/docs/getFaxDocumentContent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID + +// Download a fax document. +GetFaxDocumentContentRequest.getFaxDocumentContent(documentId: documentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFaxDocumentContentRequest.getFaxDocumentContent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFaxDocuments-example.txt b/build/docs/getFaxDocuments-example.txt new file mode 100644 index 000000000..ae311eac0 --- /dev/null +++ b/build/docs/getFaxDocuments-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of fax documents. +GetFaxDocumentsRequest.getFaxDocuments(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFaxDocumentsRequest.getFaxDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFaxSummary-example.txt b/build/docs/getFaxSummary-example.txt new file mode 100644 index 000000000..287cb8691 --- /dev/null +++ b/build/docs/getFaxSummary-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get fax summary +GetFaxSummaryRequest.getFaxSummary() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFaxSummaryRequest.getFaxSummary was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFieldconfig-example.txt b/build/docs/getFieldconfig-example.txt new file mode 100644 index 000000000..7e52bfefd --- /dev/null +++ b/build/docs/getFieldconfig-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let type: GetFieldconfigRequest.ModelType_getFieldconfig = GetFieldconfigRequest.ModelType_getFieldconfig.enummember // Field type + +// Fetch field config for an entity type +GetFieldconfigRequest.getFieldconfig(type: type) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFieldconfigRequest.getFieldconfig was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlow-example.txt b/build/docs/getFlow-example.txt new file mode 100644 index 000000000..d43ec0b59 --- /dev/null +++ b/build/docs/getFlow-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let deleted: Bool = true // Deleted flows + +// Get flow +GetFlowRequest.getFlow(flowId: flowId, deleted: deleted) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowRequest.getFlow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowHistoryHistoryId-example.txt b/build/docs/getFlowHistoryHistoryId-example.txt new file mode 100644 index 000000000..eeed0f8e2 --- /dev/null +++ b/build/docs/getFlowHistoryHistoryId-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let historyId: String = "" // History request ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortOrder: String = "" // Sort order +let sortBy: GetFlowHistoryHistoryIdRequest.SortBy_getFlowHistoryHistoryId = GetFlowHistoryHistoryIdRequest.SortBy_getFlowHistoryHistoryId.enummember // Sort by +let action: [String] = [""] // Flow actions to include (omit to include all) + +// Get generated flow history +GetFlowHistoryHistoryIdRequest.getFlowHistoryHistoryId(flowId: flowId, historyId: historyId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, sortBy: sortBy, action: action) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowHistoryHistoryIdRequest.getFlowHistoryHistoryId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowLatestconfiguration-example.txt b/build/docs/getFlowLatestconfiguration-example.txt new file mode 100644 index 000000000..75b274bb1 --- /dev/null +++ b/build/docs/getFlowLatestconfiguration-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let deleted: Bool = true // Deleted flows + +// Get the latest configuration for flow +GetFlowLatestconfigurationRequest.getFlowLatestconfiguration(flowId: flowId, deleted: deleted) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowLatestconfigurationRequest.getFlowLatestconfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersion-example.txt b/build/docs/getFlowVersion-example.txt new file mode 100644 index 000000000..b4b8cbc13 --- /dev/null +++ b/build/docs/getFlowVersion-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let versionId: String = "" // Version ID +let deleted: String = "" // Deleted flows + +// Get flow version +GetFlowVersionRequest.getFlowVersion(flowId: flowId, versionId: versionId, deleted: deleted) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionRequest.getFlowVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersionConfiguration-example.txt b/build/docs/getFlowVersionConfiguration-example.txt new file mode 100644 index 000000000..0e7568fa7 --- /dev/null +++ b/build/docs/getFlowVersionConfiguration-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let versionId: String = "" // Version ID +let deleted: String = "" // Deleted flows + +// Create flow version configuration +GetFlowVersionConfigurationRequest.getFlowVersionConfiguration(flowId: flowId, versionId: versionId, deleted: deleted) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionConfigurationRequest.getFlowVersionConfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersionHealth-example.txt b/build/docs/getFlowVersionHealth-example.txt new file mode 100644 index 000000000..78854d9ee --- /dev/null +++ b/build/docs/getFlowVersionHealth-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID. +let versionId: String = "" // Version ID. +let language: GetFlowVersionHealthRequest.Language_getFlowVersionHealth = GetFlowVersionHealthRequest.Language_getFlowVersionHealth.enummember // Language to filter for + +// Get overall health scores for all intents present in the NLU domain version associated with the bot flow version. +GetFlowVersionHealthRequest.getFlowVersionHealth(flowId: flowId, versionId: versionId, language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionHealthRequest.getFlowVersionHealth was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersionIntentHealth-example.txt b/build/docs/getFlowVersionIntentHealth-example.txt new file mode 100644 index 000000000..978c427a1 --- /dev/null +++ b/build/docs/getFlowVersionIntentHealth-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID. +let versionId: String = "" // Version ID. +let intentId: String = "" // Intent ID. +let language: GetFlowVersionIntentHealthRequest.Language_getFlowVersionIntentHealth = GetFlowVersionIntentHealthRequest.Language_getFlowVersionIntentHealth.enummember // Language to filter for + +// Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent. +GetFlowVersionIntentHealthRequest.getFlowVersionIntentHealth(flowId: flowId, versionId: versionId, intentId: intentId, language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionIntentHealthRequest.getFlowVersionIntentHealth was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersionIntentUtteranceHealth-example.txt b/build/docs/getFlowVersionIntentUtteranceHealth-example.txt new file mode 100644 index 000000000..c3fcafa8a --- /dev/null +++ b/build/docs/getFlowVersionIntentUtteranceHealth-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID. +let versionId: String = "" // Version ID. +let intentId: String = "" // Intent ID. +let utteranceId: String = "" // Utterance ID. +let language: GetFlowVersionIntentUtteranceHealthRequest.Language_getFlowVersionIntentUtteranceHealth = GetFlowVersionIntentUtteranceHealthRequest.Language_getFlowVersionIntentUtteranceHealth.enummember // Language to filter for + +// Get health metrics associated with a specific utterance of an intent. +GetFlowVersionIntentUtteranceHealthRequest.getFlowVersionIntentUtteranceHealth(flowId: flowId, versionId: versionId, intentId: intentId, utteranceId: utteranceId, language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionIntentUtteranceHealthRequest.getFlowVersionIntentUtteranceHealth was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowVersions-example.txt b/build/docs/getFlowVersions-example.txt new file mode 100644 index 000000000..3400d3931 --- /dev/null +++ b/build/docs/getFlowVersions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let deleted: Bool = true // Include Deleted flows + +// Get flow version list +GetFlowVersionsRequest.getFlowVersions(flowId: flowId, pageNumber: pageNumber, pageSize: pageSize, deleted: deleted) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowVersionsRequest.getFlowVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlows-example.txt b/build/docs/getFlows-example.txt new file mode 100644 index 000000000..2aece4120 --- /dev/null +++ b/build/docs/getFlows-example.txt @@ -0,0 +1,34 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let type: [String] = [""] // Type +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let _description: String = "" // Description +let nameOrDescription: String = "" // Name or description +let publishVersionId: String = "" // Publish version ID +let editableBy: String = "" // Editable by +let lockedBy: String = "" // Locked by +let lockedByClientId: String = "" // Locked by client ID +let secure: GetFlowsRequest.Secure_getFlows = GetFlowsRequest.Secure_getFlows.enummember // Secure +let deleted: Bool = true // Include deleted +let includeSchemas: Bool = true // Include variable schemas +let publishedAfter: String = 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 // Published after +let publishedBefore: String = 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 // Published before +let divisionId: [String] = [""] // division ID(s) + +// Get a pageable list of flows, filtered by query parameters +GetFlowsRequest.getFlows(type: type, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, publishVersionId: publishVersionId, editableBy: editableBy, lockedBy: lockedBy, lockedByClientId: lockedByClientId, secure: secure, deleted: deleted, includeSchemas: includeSchemas, publishedAfter: publishedAfter, publishedBefore: publishedBefore, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsRequest.getFlows was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatable-example.txt b/build/docs/getFlowsDatatable-example.txt new file mode 100644 index 000000000..021cd3d34 --- /dev/null +++ b/build/docs/getFlowsDatatable-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let expand: GetFlowsDatatableRequest.Expand_getFlowsDatatable = GetFlowsDatatableRequest.Expand_getFlowsDatatable.enummember // Expand instructions for the result + +// Returns a specific datatable by id +GetFlowsDatatableRequest.getFlowsDatatable(datatableId: datatableId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableRequest.getFlowsDatatable was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatableExportJob-example.txt b/build/docs/getFlowsDatatableExportJob-example.txt new file mode 100644 index 000000000..ef31d054f --- /dev/null +++ b/build/docs/getFlowsDatatableExportJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let exportJobId: String = "" // id of export job + +// Returns the state information about an export job +GetFlowsDatatableExportJobRequest.getFlowsDatatableExportJob(datatableId: datatableId, exportJobId: exportJobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableExportJobRequest.getFlowsDatatableExportJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatableImportJob-example.txt b/build/docs/getFlowsDatatableImportJob-example.txt new file mode 100644 index 000000000..2a5b0e69c --- /dev/null +++ b/build/docs/getFlowsDatatableImportJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let importJobId: String = "" // id of import job + +// Returns the state information about an import job +GetFlowsDatatableImportJobRequest.getFlowsDatatableImportJob(datatableId: datatableId, importJobId: importJobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableImportJobRequest.getFlowsDatatableImportJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatableImportJobs-example.txt b/build/docs/getFlowsDatatableImportJobs-example.txt new file mode 100644 index 000000000..ddf091b0f --- /dev/null +++ b/build/docs/getFlowsDatatableImportJobs-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get all recent import jobs +GetFlowsDatatableImportJobsRequest.getFlowsDatatableImportJobs(datatableId: datatableId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableImportJobsRequest.getFlowsDatatableImportJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatableRow-example.txt b/build/docs/getFlowsDatatableRow-example.txt new file mode 100644 index 000000000..1fc80b734 --- /dev/null +++ b/build/docs/getFlowsDatatableRow-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let rowId: String = "" // The key for the row +let showbrief: Bool = true // if true returns just the key field for the row + +// Returns a specific row for the datatable +GetFlowsDatatableRowRequest.getFlowsDatatableRow(datatableId: datatableId, rowId: rowId, showbrief: showbrief) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableRowRequest.getFlowsDatatableRow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatableRows-example.txt b/build/docs/getFlowsDatatableRows-example.txt new file mode 100644 index 000000000..22c69f695 --- /dev/null +++ b/build/docs/getFlowsDatatableRows-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let showbrief: Bool = true // If true returns just the key value of the row +let sortOrder: GetFlowsDatatableRowsRequest.SortOrder_getFlowsDatatableRows = GetFlowsDatatableRowsRequest.SortOrder_getFlowsDatatableRows.enummember // Sort order + +// Returns the rows for the datatable with the given id +GetFlowsDatatableRowsRequest.getFlowsDatatableRows(datatableId: datatableId, pageNumber: pageNumber, pageSize: pageSize, showbrief: showbrief, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatableRowsRequest.getFlowsDatatableRows was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatables-example.txt b/build/docs/getFlowsDatatables-example.txt new file mode 100644 index 000000000..0ae8e2809 --- /dev/null +++ b/build/docs/getFlowsDatatables-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: GetFlowsDatatablesRequest.Expand_getFlowsDatatables = GetFlowsDatatablesRequest.Expand_getFlowsDatatables.enummember // Expand instructions for the result +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: GetFlowsDatatablesRequest.SortBy_getFlowsDatatables = GetFlowsDatatablesRequest.SortBy_getFlowsDatatables.enummember // Sort by +let sortOrder: String = "" // Sort order +let divisionId: [String] = [""] // division ID(s) +let name: String = exactMatch, beginsWith*, *endsWith, *contains* // Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. + +// Retrieve a list of datatables for the org +GetFlowsDatatablesRequest.getFlowsDatatables(expand: expand, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, divisionId: divisionId, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatablesRequest.getFlowsDatatables was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatablesDivisionview-example.txt b/build/docs/getFlowsDatatablesDivisionview-example.txt new file mode 100644 index 000000000..070406f77 --- /dev/null +++ b/build/docs/getFlowsDatatablesDivisionview-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let expand: GetFlowsDatatablesDivisionviewRequest.Expand_getFlowsDatatablesDivisionview = GetFlowsDatatablesDivisionviewRequest.Expand_getFlowsDatatablesDivisionview.enummember // Expand instructions for the result + +// Returns a specific datatable by id +GetFlowsDatatablesDivisionviewRequest.getFlowsDatatablesDivisionview(datatableId: datatableId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatablesDivisionviewRequest.getFlowsDatatablesDivisionview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDatatablesDivisionviews-example.txt b/build/docs/getFlowsDatatablesDivisionviews-example.txt new file mode 100644 index 000000000..f376ca890 --- /dev/null +++ b/build/docs/getFlowsDatatablesDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: GetFlowsDatatablesDivisionviewsRequest.Expand_getFlowsDatatablesDivisionviews = GetFlowsDatatablesDivisionviewsRequest.Expand_getFlowsDatatablesDivisionviews.enummember // Expand instructions for the result +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: GetFlowsDatatablesDivisionviewsRequest.SortBy_getFlowsDatatablesDivisionviews = GetFlowsDatatablesDivisionviewsRequest.SortBy_getFlowsDatatablesDivisionviews.enummember // Sort by +let sortOrder: String = "" // Sort order +let divisionId: [String] = [""] // division ID(s) +let name: String = exactMatch, beginsWith*, *endsWith, *contains* // Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. + +// Retrieve a list of datatables for the org +GetFlowsDatatablesDivisionviewsRequest.getFlowsDatatablesDivisionviews(expand: expand, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, divisionId: divisionId, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDatatablesDivisionviewsRequest.getFlowsDatatablesDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsDivisionviews-example.txt b/build/docs/getFlowsDivisionviews-example.txt new file mode 100644 index 000000000..5d0b11107 --- /dev/null +++ b/build/docs/getFlowsDivisionviews-example.txt @@ -0,0 +1,27 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let type: [String] = [""] // Type +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let publishVersionId: String = "" // Publish version ID +let publishedAfter: String = 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 // Published after +let publishedBefore: String = 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 // Published before +let divisionId: [String] = [""] // division ID(s) +let includeSchemas: Bool = true // Include variable schemas + +// Get a pageable list of basic flow information objects filterable by query parameters. +GetFlowsDivisionviewsRequest.getFlowsDivisionviews(type: type, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, publishVersionId: publishVersionId, publishedAfter: publishedAfter, publishedBefore: publishedBefore, divisionId: divisionId, includeSchemas: includeSchemas) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsDivisionviewsRequest.getFlowsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsExecution-example.txt b/build/docs/getFlowsExecution-example.txt new file mode 100644 index 000000000..c4ae14e95 --- /dev/null +++ b/build/docs/getFlowsExecution-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowExecutionId: String = "" // flow execution ID + +// Get a flow execution's details. Flow execution details are available for several days after the flow is started. +GetFlowsExecutionRequest.getFlowsExecution(flowExecutionId: flowExecutionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsExecutionRequest.getFlowsExecution was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsJob-example.txt b/build/docs/getFlowsJob-example.txt new file mode 100644 index 000000000..d261ffc06 --- /dev/null +++ b/build/docs/getFlowsJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // Job ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Fetch Architect Job Status +GetFlowsJobRequest.getFlowsJob(jobId: jobId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsJobRequest.getFlowsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsMilestone-example.txt b/build/docs/getFlowsMilestone-example.txt new file mode 100644 index 000000000..ad0f24baf --- /dev/null +++ b/build/docs/getFlowsMilestone-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let milestoneId: String = "" // flow milestone ID + +// Get a flow milestone +GetFlowsMilestoneRequest.getFlowsMilestone(milestoneId: milestoneId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsMilestoneRequest.getFlowsMilestone was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsMilestones-example.txt b/build/docs/getFlowsMilestones-example.txt new file mode 100644 index 000000000..c91fce13e --- /dev/null +++ b/build/docs/getFlowsMilestones-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let _description: String = "" // Description +let nameOrDescription: String = "" // Name or description +let divisionId: [String] = [""] // division ID(s) + +// Get a pageable list of flow milestones, filtered by query parameters +GetFlowsMilestonesRequest.getFlowsMilestones(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsMilestonesRequest.getFlowsMilestones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsMilestonesDivisionviews-example.txt b/build/docs/getFlowsMilestonesDivisionviews-example.txt new file mode 100644 index 000000000..65942d342 --- /dev/null +++ b/build/docs/getFlowsMilestonesDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let divisionId: [String] = [""] // division ID(s) + +// Get a pageable list of basic flow milestone information objects filterable by query parameters. +GetFlowsMilestonesDivisionviewsRequest.getFlowsMilestonesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsMilestonesDivisionviewsRequest.getFlowsMilestonesDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsOutcome-example.txt b/build/docs/getFlowsOutcome-example.txt new file mode 100644 index 000000000..256105537 --- /dev/null +++ b/build/docs/getFlowsOutcome-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowOutcomeId: String = "" // flow outcome ID + +// Get a flow outcome +GetFlowsOutcomeRequest.getFlowsOutcome(flowOutcomeId: flowOutcomeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsOutcomeRequest.getFlowsOutcome was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsOutcomes-example.txt b/build/docs/getFlowsOutcomes-example.txt new file mode 100644 index 000000000..3b7f247c4 --- /dev/null +++ b/build/docs/getFlowsOutcomes-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let _description: String = "" // Description +let nameOrDescription: String = "" // Name or description +let divisionId: [String] = [""] // division ID(s) + +// Get a pageable list of flow outcomes, filtered by query parameters +GetFlowsOutcomesRequest.getFlowsOutcomes(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, _description: _description, nameOrDescription: nameOrDescription, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsOutcomesRequest.getFlowsOutcomes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getFlowsOutcomesDivisionviews-example.txt b/build/docs/getFlowsOutcomesDivisionviews-example.txt new file mode 100644 index 000000000..563cee2b0 --- /dev/null +++ b/build/docs/getFlowsOutcomesDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let _id: [String] = [""] // ID +let name: String = "" // Name +let divisionId: [String] = [""] // division ID(s) + +// Get a pageable list of basic flow outcome information objects filterable by query parameters. +GetFlowsOutcomesDivisionviewsRequest.getFlowsOutcomesDivisionviews(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, _id: _id, name: name, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetFlowsOutcomesDivisionviewsRequest.getFlowsOutcomesDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsights-example.txt b/build/docs/getGamificationInsights-example.txt new file mode 100644 index 000000000..a3bd8a797 --- /dev/null +++ b/build/docs/getGamificationInsights-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsRequest.FilterType_getGamificationInsights = GetGamificationInsightsRequest.FilterType_getGamificationInsights.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsRequest.Granularity_getGamificationInsights = GetGamificationInsightsRequest.Granularity_getGamificationInsights.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortKey: GetGamificationInsightsRequest.SortKey_getGamificationInsights = GetGamificationInsightsRequest.SortKey_getGamificationInsights.enummember // Sort key +let sortMetricId: String = "" // Sort Metric Id +let sortOrder: GetGamificationInsightsRequest.SortOrder_getGamificationInsights = GetGamificationInsightsRequest.SortOrder_getGamificationInsights.enummember // Sort order +let userIds: String = "" // A list of up to 100 comma-separated user Ids + +// Get insights summary +GetGamificationInsightsRequest.getGamificationInsights(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, pageSize: pageSize, pageNumber: pageNumber, sortKey: sortKey, sortMetricId: sortMetricId, sortOrder: sortOrder, userIds: userIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsRequest.getGamificationInsights was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsDetails-example.txt b/build/docs/getGamificationInsightsDetails-example.txt new file mode 100644 index 000000000..c9cf1bab1 --- /dev/null +++ b/build/docs/getGamificationInsightsDetails-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsDetailsRequest.FilterType_getGamificationInsightsDetails = GetGamificationInsightsDetailsRequest.FilterType_getGamificationInsightsDetails.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsDetailsRequest.Granularity_getGamificationInsightsDetails = GetGamificationInsightsDetailsRequest.Granularity_getGamificationInsightsDetails.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights details for the current user +GetGamificationInsightsDetailsRequest.getGamificationInsightsDetails(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsDetailsRequest.getGamificationInsightsDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsGroupsTrends-example.txt b/build/docs/getGamificationInsightsGroupsTrends-example.txt new file mode 100644 index 000000000..326b27003 --- /dev/null +++ b/build/docs/getGamificationInsightsGroupsTrends-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsGroupsTrendsRequest.FilterType_getGamificationInsightsGroupsTrends = GetGamificationInsightsGroupsTrendsRequest.FilterType_getGamificationInsightsGroupsTrends.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsGroupsTrendsRequest.Granularity_getGamificationInsightsGroupsTrends = GetGamificationInsightsGroupsTrendsRequest.Granularity_getGamificationInsightsGroupsTrends.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights overall trend for the current user +GetGamificationInsightsGroupsTrendsRequest.getGamificationInsightsGroupsTrends(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsGroupsTrendsRequest.getGamificationInsightsGroupsTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsGroupsTrendsAll-example.txt b/build/docs/getGamificationInsightsGroupsTrendsAll-example.txt new file mode 100644 index 000000000..2303c7e59 --- /dev/null +++ b/build/docs/getGamificationInsightsGroupsTrendsAll-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsGroupsTrendsAllRequest.FilterType_getGamificationInsightsGroupsTrendsAll = GetGamificationInsightsGroupsTrendsAllRequest.FilterType_getGamificationInsightsGroupsTrendsAll.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsGroupsTrendsAllRequest.Granularity_getGamificationInsightsGroupsTrendsAll = GetGamificationInsightsGroupsTrendsAllRequest.Granularity_getGamificationInsightsGroupsTrendsAll.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights overall trend +GetGamificationInsightsGroupsTrendsAllRequest.getGamificationInsightsGroupsTrendsAll(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsGroupsTrendsAllRequest.getGamificationInsightsGroupsTrendsAll was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsMembers-example.txt b/build/docs/getGamificationInsightsMembers-example.txt new file mode 100644 index 000000000..4824df1f2 --- /dev/null +++ b/build/docs/getGamificationInsightsMembers-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsMembersRequest.FilterType_getGamificationInsightsMembers = GetGamificationInsightsMembersRequest.FilterType_getGamificationInsightsMembers.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsMembersRequest.Granularity_getGamificationInsightsMembers = GetGamificationInsightsMembersRequest.Granularity_getGamificationInsightsMembers.enummember // Granularity +let startWorkday: Date = new Date(...) // The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Query users in a profile during a period of time +GetGamificationInsightsMembersRequest.getGamificationInsightsMembers(filterType: filterType, filterId: filterId, granularity: granularity, startWorkday: startWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsMembersRequest.getGamificationInsightsMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsTrends-example.txt b/build/docs/getGamificationInsightsTrends-example.txt new file mode 100644 index 000000000..6e9d0607b --- /dev/null +++ b/build/docs/getGamificationInsightsTrends-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationInsightsTrendsRequest.FilterType_getGamificationInsightsTrends = GetGamificationInsightsTrendsRequest.FilterType_getGamificationInsightsTrends.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsTrendsRequest.Granularity_getGamificationInsightsTrends = GetGamificationInsightsTrendsRequest.Granularity_getGamificationInsightsTrends.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights user trend for the current user +GetGamificationInsightsTrendsRequest.getGamificationInsightsTrends(filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsTrendsRequest.getGamificationInsightsTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsUserDetails-example.txt b/build/docs/getGamificationInsightsUserDetails-example.txt new file mode 100644 index 000000000..720b7dca1 --- /dev/null +++ b/build/docs/getGamificationInsightsUserDetails-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. +let filterType: GetGamificationInsightsUserDetailsRequest.FilterType_getGamificationInsightsUserDetails = GetGamificationInsightsUserDetailsRequest.FilterType_getGamificationInsightsUserDetails.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsUserDetailsRequest.Granularity_getGamificationInsightsUserDetails = GetGamificationInsightsUserDetailsRequest.Granularity_getGamificationInsightsUserDetails.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights details for the user +GetGamificationInsightsUserDetailsRequest.getGamificationInsightsUserDetails(userId: userId, filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsUserDetailsRequest.getGamificationInsightsUserDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationInsightsUserTrends-example.txt b/build/docs/getGamificationInsightsUserTrends-example.txt new file mode 100644 index 000000000..1909d9c58 --- /dev/null +++ b/build/docs/getGamificationInsightsUserTrends-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. +let filterType: GetGamificationInsightsUserTrendsRequest.FilterType_getGamificationInsightsUserTrends = GetGamificationInsightsUserTrendsRequest.FilterType_getGamificationInsightsUserTrends.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let granularity: GetGamificationInsightsUserTrendsRequest.Granularity_getGamificationInsightsUserTrends = GetGamificationInsightsUserTrendsRequest.Granularity_getGamificationInsightsUserTrends.enummember // Granularity +let comparativePeriodStartWorkday: Date = new Date(...) // The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let comparativePeriodEndWorkday: Date = new Date(...) // The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodStartWorkday: Date = new Date(...) // The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let primaryPeriodEndWorkday: Date = new Date(...) // The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get insights user trend for the user +GetGamificationInsightsUserTrendsRequest.getGamificationInsightsUserTrends(userId: userId, filterType: filterType, filterId: filterId, granularity: granularity, comparativePeriodStartWorkday: comparativePeriodStartWorkday, comparativePeriodEndWorkday: comparativePeriodEndWorkday, primaryPeriodStartWorkday: primaryPeriodStartWorkday, primaryPeriodEndWorkday: primaryPeriodEndWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationInsightsUserTrendsRequest.getGamificationInsightsUserTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationLeaderboard-example.txt b/build/docs/getGamificationLeaderboard-example.txt new file mode 100644 index 000000000..002aa5561 --- /dev/null +++ b/build/docs/getGamificationLeaderboard-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startWorkday: Date = new Date(...) // Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let metricId: String = "" // Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. + +// Leaderboard of the requesting user's division or performance profile +GetGamificationLeaderboardRequest.getGamificationLeaderboard(startWorkday: startWorkday, endWorkday: endWorkday, metricId: metricId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationLeaderboardRequest.getGamificationLeaderboard was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationLeaderboardAll-example.txt b/build/docs/getGamificationLeaderboardAll-example.txt new file mode 100644 index 000000000..fe1df94ab --- /dev/null +++ b/build/docs/getGamificationLeaderboardAll-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationLeaderboardAllRequest.FilterType_getGamificationLeaderboardAll = GetGamificationLeaderboardAllRequest.FilterType_getGamificationLeaderboardAll.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. For example, division or performance profile Id +let startWorkday: Date = new Date(...) // Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let metricId: String = "" // Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. + +// Leaderboard by filter type +GetGamificationLeaderboardAllRequest.getGamificationLeaderboardAll(filterType: filterType, filterId: filterId, startWorkday: startWorkday, endWorkday: endWorkday, metricId: metricId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationLeaderboardAllRequest.getGamificationLeaderboardAll was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationLeaderboardAllBestpoints-example.txt b/build/docs/getGamificationLeaderboardAllBestpoints-example.txt new file mode 100644 index 000000000..20786a1a2 --- /dev/null +++ b/build/docs/getGamificationLeaderboardAllBestpoints-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationLeaderboardAllBestpointsRequest.FilterType_getGamificationLeaderboardAllBestpoints = GetGamificationLeaderboardAllBestpointsRequest.FilterType_getGamificationLeaderboardAllBestpoints.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. For example, division or performance profile Id + +// Best Points by division or performance profile +GetGamificationLeaderboardAllBestpointsRequest.getGamificationLeaderboardAllBestpoints(filterType: filterType, filterId: filterId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationLeaderboardAllBestpointsRequest.getGamificationLeaderboardAllBestpoints was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationLeaderboardBestpoints-example.txt b/build/docs/getGamificationLeaderboardBestpoints-example.txt new file mode 100644 index 000000000..232b07e80 --- /dev/null +++ b/build/docs/getGamificationLeaderboardBestpoints-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Best Points of the requesting user's current performance profile or division +GetGamificationLeaderboardBestpointsRequest.getGamificationLeaderboardBestpoints() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationLeaderboardBestpointsRequest.getGamificationLeaderboardBestpoints was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationMetricdefinition-example.txt b/build/docs/getGamificationMetricdefinition-example.txt new file mode 100644 index 000000000..a866699e9 --- /dev/null +++ b/build/docs/getGamificationMetricdefinition-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let metricDefinitionId: String = "" // metric definition id + +// Metric definition by id +GetGamificationMetricdefinitionRequest.getGamificationMetricdefinition(metricDefinitionId: metricDefinitionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationMetricdefinitionRequest.getGamificationMetricdefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationMetricdefinitions-example.txt b/build/docs/getGamificationMetricdefinitions-example.txt new file mode 100644 index 000000000..84e659a51 --- /dev/null +++ b/build/docs/getGamificationMetricdefinitions-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// All metric definitions +GetGamificationMetricdefinitionsRequest.getGamificationMetricdefinitions() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationMetricdefinitionsRequest.getGamificationMetricdefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfile-example.txt b/build/docs/getGamificationProfile-example.txt new file mode 100644 index 000000000..cce7a2e37 --- /dev/null +++ b/build/docs/getGamificationProfile-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId + +// Performance profile by id +GetGamificationProfileRequest.getGamificationProfile(profileId: profileId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfileRequest.getGamificationProfile was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfileMembers-example.txt b/build/docs/getGamificationProfileMembers-example.txt new file mode 100644 index 000000000..593096104 --- /dev/null +++ b/build/docs/getGamificationProfileMembers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Profile Id + +// Members of a given performance profile +GetGamificationProfileMembersRequest.getGamificationProfileMembers(profileId: profileId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfileMembersRequest.getGamificationProfileMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfileMetric-example.txt b/build/docs/getGamificationProfileMetric-example.txt new file mode 100644 index 000000000..dab8add7f --- /dev/null +++ b/build/docs/getGamificationProfileMetric-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Performance Profile Id +let metricId: String = "" // Metric Id +let workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Performance profile gamified metric by id +GetGamificationProfileMetricRequest.getGamificationProfileMetric(profileId: profileId, metricId: metricId, workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfileMetricRequest.getGamificationProfileMetric was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfileMetrics-example.txt b/build/docs/getGamificationProfileMetrics-example.txt new file mode 100644 index 000000000..efeccc4ad --- /dev/null +++ b/build/docs/getGamificationProfileMetrics-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Performance Profile Id +let expand: [String] = [""] // Which fields, if any, to expand. +let workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let metricIds: String = "" // List of metric ids to filter the response (Optional, comma-separated). + +// All gamified metrics for a given performance profile +GetGamificationProfileMetricsRequest.getGamificationProfileMetrics(profileId: profileId, expand: expand, workday: workday, metricIds: metricIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfileMetricsRequest.getGamificationProfileMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfileMetricsObjectivedetails-example.txt b/build/docs/getGamificationProfileMetricsObjectivedetails-example.txt new file mode 100644 index 000000000..72e46377d --- /dev/null +++ b/build/docs/getGamificationProfileMetricsObjectivedetails-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Performance Profile Id +let workday: Date = new Date(...) // The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// All metrics for a given performance profile with objective details such as order and maxPoints +GetGamificationProfileMetricsObjectivedetailsRequest.getGamificationProfileMetricsObjectivedetails(profileId: profileId, workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfileMetricsObjectivedetailsRequest.getGamificationProfileMetricsObjectivedetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfiles-example.txt b/build/docs/getGamificationProfiles-example.txt new file mode 100644 index 000000000..cd8dab3ac --- /dev/null +++ b/build/docs/getGamificationProfiles-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// All performance profiles +GetGamificationProfilesRequest.getGamificationProfiles() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfilesRequest.getGamificationProfiles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfilesUser-example.txt b/build/docs/getGamificationProfilesUser-example.txt new file mode 100644 index 000000000..b843a0f50 --- /dev/null +++ b/build/docs/getGamificationProfilesUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let workday: Date = new Date(...) // Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Performance profile of a user +GetGamificationProfilesUserRequest.getGamificationProfilesUser(userId: userId, workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfilesUserRequest.getGamificationProfilesUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationProfilesUsersMe-example.txt b/build/docs/getGamificationProfilesUsersMe-example.txt new file mode 100644 index 000000000..2f56cb83e --- /dev/null +++ b/build/docs/getGamificationProfilesUsersMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workday: Date = new Date(...) // Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Performance profile of the requesting user +GetGamificationProfilesUsersMeRequest.getGamificationProfilesUsersMe(workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationProfilesUsersMeRequest.getGamificationProfilesUsersMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecards-example.txt b/build/docs/getGamificationScorecards-example.txt new file mode 100644 index 000000000..59b089b58 --- /dev/null +++ b/build/docs/getGamificationScorecards-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workday: Date = new Date(...) // Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let expand: [String] = [""] // Which fields, if any, to expand. + +// Workday performance metrics of the requesting user +GetGamificationScorecardsRequest.getGamificationScorecards(workday: workday, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsRequest.getGamificationScorecards was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsAttendance-example.txt b/build/docs/getGamificationScorecardsAttendance-example.txt new file mode 100644 index 000000000..bb16004da --- /dev/null +++ b/build/docs/getGamificationScorecardsAttendance-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Attendance status metrics of the requesting user +GetGamificationScorecardsAttendanceRequest.getGamificationScorecardsAttendance(startWorkday: startWorkday, endWorkday: endWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsAttendanceRequest.getGamificationScorecardsAttendance was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsBestpoints-example.txt b/build/docs/getGamificationScorecardsBestpoints-example.txt new file mode 100644 index 000000000..b55dbbd94 --- /dev/null +++ b/build/docs/getGamificationScorecardsBestpoints-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Best points of the requesting user +GetGamificationScorecardsBestpointsRequest.getGamificationScorecardsBestpoints() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsBestpointsRequest.getGamificationScorecardsBestpoints was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsPointsAlltime-example.txt b/build/docs/getGamificationScorecardsPointsAlltime-example.txt new file mode 100644 index 000000000..7dcba2385 --- /dev/null +++ b/build/docs/getGamificationScorecardsPointsAlltime-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// All-time points of the requesting user +GetGamificationScorecardsPointsAlltimeRequest.getGamificationScorecardsPointsAlltime(endWorkday: endWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsPointsAlltimeRequest.getGamificationScorecardsPointsAlltime was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsPointsAverage-example.txt b/build/docs/getGamificationScorecardsPointsAverage-example.txt new file mode 100644 index 000000000..a0ffe9605 --- /dev/null +++ b/build/docs/getGamificationScorecardsPointsAverage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Average points of the requesting user's division or performance profile +GetGamificationScorecardsPointsAverageRequest.getGamificationScorecardsPointsAverage(workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsPointsAverageRequest.getGamificationScorecardsPointsAverage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsPointsTrends-example.txt b/build/docs/getGamificationScorecardsPointsTrends-example.txt new file mode 100644 index 000000000..999bccb05 --- /dev/null +++ b/build/docs/getGamificationScorecardsPointsTrends-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let dayOfWeek: GetGamificationScorecardsPointsTrendsRequest.DayOfWeek_getGamificationScorecardsPointsTrends = GetGamificationScorecardsPointsTrendsRequest.DayOfWeek_getGamificationScorecardsPointsTrends.enummember // Optional filter to specify which day of weeks to be included in the response + +// Points trends of the requesting user +GetGamificationScorecardsPointsTrendsRequest.getGamificationScorecardsPointsTrends(startWorkday: startWorkday, endWorkday: endWorkday, dayOfWeek: dayOfWeek) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsPointsTrendsRequest.getGamificationScorecardsPointsTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsProfileMetricUserValuesTrends-example.txt b/build/docs/getGamificationScorecardsProfileMetricUserValuesTrends-example.txt new file mode 100644 index 000000000..1b5921df8 --- /dev/null +++ b/build/docs/getGamificationScorecardsProfileMetricUserValuesTrends-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId +let metricId: String = "" // metricId +let userId: String = "" // +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Average performance values trends by metric of a user +GetGamificationScorecardsProfileMetricUserValuesTrendsRequest.getGamificationScorecardsProfileMetricUserValuesTrends(profileId: profileId, metricId: metricId, userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsProfileMetricUserValuesTrendsRequest.getGamificationScorecardsProfileMetricUserValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsProfileMetricUsersValuesTrends-example.txt b/build/docs/getGamificationScorecardsProfileMetricUsersValuesTrends-example.txt new file mode 100644 index 000000000..8fd519b66 --- /dev/null +++ b/build/docs/getGamificationScorecardsProfileMetricUsersValuesTrends-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId +let metricId: String = "" // metricId +let filterType: GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricUsersValuesTrends = GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricUsersValuesTrends.enummember // Filter type for the query request. +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let filterId: String = "" // ID for the filter type. Only required when filterType is Division. +let referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Average performance values trends by metric of a division or a performance profile +GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.getGamificationScorecardsProfileMetricUsersValuesTrends(profileId: profileId, metricId: metricId, filterType: filterType, startWorkday: startWorkday, endWorkday: endWorkday, filterId: filterId, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest.getGamificationScorecardsProfileMetricUsersValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsProfileMetricValuesTrends-example.txt b/build/docs/getGamificationScorecardsProfileMetricValuesTrends-example.txt new file mode 100644 index 000000000..2c8793f3b --- /dev/null +++ b/build/docs/getGamificationScorecardsProfileMetricValuesTrends-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId +let metricId: String = "" // metricId +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let filterType: GetGamificationScorecardsProfileMetricValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricValuesTrends = GetGamificationScorecardsProfileMetricValuesTrendsRequest.FilterType_getGamificationScorecardsProfileMetricValuesTrends.enummember // Filter type for the query request. If not set, returns the values trends of the requesting user +let referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Average performance values trends by metric of the requesting user +GetGamificationScorecardsProfileMetricValuesTrendsRequest.getGamificationScorecardsProfileMetricValuesTrends(profileId: profileId, metricId: metricId, startWorkday: startWorkday, endWorkday: endWorkday, filterType: filterType, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsProfileMetricValuesTrendsRequest.getGamificationScorecardsProfileMetricValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUser-example.txt b/build/docs/getGamificationScorecardsUser-example.txt new file mode 100644 index 000000000..5706a9317 --- /dev/null +++ b/build/docs/getGamificationScorecardsUser-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let workday: Date = new Date(...) // Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let expand: [String] = [""] // Which fields, if any, to expand. + +// Workday performance metrics for a user +GetGamificationScorecardsUserRequest.getGamificationScorecardsUser(userId: userId, workday: workday, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserRequest.getGamificationScorecardsUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUserAttendance-example.txt b/build/docs/getGamificationScorecardsUserAttendance-example.txt new file mode 100644 index 000000000..f6325e345 --- /dev/null +++ b/build/docs/getGamificationScorecardsUserAttendance-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Attendance status metrics for a user +GetGamificationScorecardsUserAttendanceRequest.getGamificationScorecardsUserAttendance(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserAttendanceRequest.getGamificationScorecardsUserAttendance was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUserBestpoints-example.txt b/build/docs/getGamificationScorecardsUserBestpoints-example.txt new file mode 100644 index 000000000..b0667351b --- /dev/null +++ b/build/docs/getGamificationScorecardsUserBestpoints-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // + +// Best points of a user +GetGamificationScorecardsUserBestpointsRequest.getGamificationScorecardsUserBestpoints(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserBestpointsRequest.getGamificationScorecardsUserBestpoints was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUserPointsAlltime-example.txt b/build/docs/getGamificationScorecardsUserPointsAlltime-example.txt new file mode 100644 index 000000000..88cd3ce00 --- /dev/null +++ b/build/docs/getGamificationScorecardsUserPointsAlltime-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// All-time points for a user +GetGamificationScorecardsUserPointsAlltimeRequest.getGamificationScorecardsUserPointsAlltime(userId: userId, endWorkday: endWorkday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserPointsAlltimeRequest.getGamificationScorecardsUserPointsAlltime was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUserPointsTrends-example.txt b/build/docs/getGamificationScorecardsUserPointsTrends-example.txt new file mode 100644 index 000000000..756bef5a2 --- /dev/null +++ b/build/docs/getGamificationScorecardsUserPointsTrends-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let dayOfWeek: GetGamificationScorecardsUserPointsTrendsRequest.DayOfWeek_getGamificationScorecardsUserPointsTrends = GetGamificationScorecardsUserPointsTrendsRequest.DayOfWeek_getGamificationScorecardsUserPointsTrends.enummember // Optional filter to specify which day of weeks to be included in the response + +// Points trend for a user +GetGamificationScorecardsUserPointsTrendsRequest.getGamificationScorecardsUserPointsTrends(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, dayOfWeek: dayOfWeek) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserPointsTrendsRequest.getGamificationScorecardsUserPointsTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUserValuesTrends-example.txt b/build/docs/getGamificationScorecardsUserValuesTrends-example.txt new file mode 100644 index 000000000..368c62365 --- /dev/null +++ b/build/docs/getGamificationScorecardsUserValuesTrends-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Values trends of a user +GetGamificationScorecardsUserValuesTrendsRequest.getGamificationScorecardsUserValuesTrends(userId: userId, startWorkday: startWorkday, endWorkday: endWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUserValuesTrendsRequest.getGamificationScorecardsUserValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUsersPointsAverage-example.txt b/build/docs/getGamificationScorecardsUsersPointsAverage-example.txt new file mode 100644 index 000000000..42057ca27 --- /dev/null +++ b/build/docs/getGamificationScorecardsUsersPointsAverage-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationScorecardsUsersPointsAverageRequest.FilterType_getGamificationScorecardsUsersPointsAverage = GetGamificationScorecardsUsersPointsAverageRequest.FilterType_getGamificationScorecardsUsersPointsAverage.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Workday average points by target group +GetGamificationScorecardsUsersPointsAverageRequest.getGamificationScorecardsUsersPointsAverage(filterType: filterType, filterId: filterId, workday: workday) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUsersPointsAverageRequest.getGamificationScorecardsUsersPointsAverage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUsersValuesAverage-example.txt b/build/docs/getGamificationScorecardsUsersValuesAverage-example.txt new file mode 100644 index 000000000..dc17cd30e --- /dev/null +++ b/build/docs/getGamificationScorecardsUsersValuesAverage-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationScorecardsUsersValuesAverageRequest.FilterType_getGamificationScorecardsUsersValuesAverage = GetGamificationScorecardsUsersValuesAverageRequest.FilterType_getGamificationScorecardsUsersValuesAverage.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. For example, division Id +let workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Workday average values by target group +GetGamificationScorecardsUsersValuesAverageRequest.getGamificationScorecardsUsersValuesAverage(filterType: filterType, filterId: filterId, workday: workday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUsersValuesAverageRequest.getGamificationScorecardsUsersValuesAverage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsUsersValuesTrends-example.txt b/build/docs/getGamificationScorecardsUsersValuesTrends-example.txt new file mode 100644 index 000000000..bb0a094fa --- /dev/null +++ b/build/docs/getGamificationScorecardsUsersValuesTrends-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filterType: GetGamificationScorecardsUsersValuesTrendsRequest.FilterType_getGamificationScorecardsUsersValuesTrends = GetGamificationScorecardsUsersValuesTrendsRequest.FilterType_getGamificationScorecardsUsersValuesTrends.enummember // Filter type for the query request. +let filterId: String = "" // ID for the filter type. +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Values trend by target group +GetGamificationScorecardsUsersValuesTrendsRequest.getGamificationScorecardsUsersValuesTrends(filterType: filterType, filterId: filterId, startWorkday: startWorkday, endWorkday: endWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsUsersValuesTrendsRequest.getGamificationScorecardsUsersValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsValuesAverage-example.txt b/build/docs/getGamificationScorecardsValuesAverage-example.txt new file mode 100644 index 000000000..81e23ce33 --- /dev/null +++ b/build/docs/getGamificationScorecardsValuesAverage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workday: Date = new Date(...) // The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Average values of the requesting user's division or performance profile +GetGamificationScorecardsValuesAverageRequest.getGamificationScorecardsValuesAverage(workday: workday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsValuesAverageRequest.getGamificationScorecardsValuesAverage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationScorecardsValuesTrends-example.txt b/build/docs/getGamificationScorecardsValuesTrends-example.txt new file mode 100644 index 000000000..b60901b9b --- /dev/null +++ b/build/docs/getGamificationScorecardsValuesTrends-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startWorkday: Date = new Date(...) // Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let endWorkday: Date = new Date(...) // End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let filterType: GetGamificationScorecardsValuesTrendsRequest.FilterType_getGamificationScorecardsValuesTrends = GetGamificationScorecardsValuesTrendsRequest.FilterType_getGamificationScorecardsValuesTrends.enummember // Filter type for the query request. If not set, then the request is for the requesting user. +let referenceWorkday: Date = new Date(...) // Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let timeZone: String = "" // Timezone for the workday. Defaults to UTC + +// Values trends of the requesting user or group +GetGamificationScorecardsValuesTrendsRequest.getGamificationScorecardsValuesTrends(startWorkday: startWorkday, endWorkday: endWorkday, filterType: filterType, referenceWorkday: referenceWorkday, timeZone: timeZone) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationScorecardsValuesTrendsRequest.getGamificationScorecardsValuesTrends was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationStatus-example.txt b/build/docs/getGamificationStatus-example.txt new file mode 100644 index 000000000..54cec9172 --- /dev/null +++ b/build/docs/getGamificationStatus-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Gamification activation status +GetGamificationStatusRequest.getGamificationStatus() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationStatusRequest.getGamificationStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationTemplate-example.txt b/build/docs/getGamificationTemplate-example.txt new file mode 100644 index 000000000..5d91a5291 --- /dev/null +++ b/build/docs/getGamificationTemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let templateId: String = "" // template id + +// Objective template by id +GetGamificationTemplateRequest.getGamificationTemplate(templateId: templateId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationTemplateRequest.getGamificationTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGamificationTemplates-example.txt b/build/docs/getGamificationTemplates-example.txt new file mode 100644 index 000000000..73332e066 --- /dev/null +++ b/build/docs/getGamificationTemplates-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// All objective templates +GetGamificationTemplatesRequest.getGamificationTemplates() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGamificationTemplatesRequest.getGamificationTemplates was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGdprRequest-example.txt b/build/docs/getGdprRequest-example.txt new file mode 100644 index 000000000..30a47cc1e --- /dev/null +++ b/build/docs/getGdprRequest-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let requestId: String = "" // Request id + +// Get an existing GDPR request +GetGdprRequestRequest.getGdprRequest(requestId: requestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGdprRequestRequest.getGdprRequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGdprRequests-example.txt b/build/docs/getGdprRequests-example.txt new file mode 100644 index 000000000..b541f3187 --- /dev/null +++ b/build/docs/getGdprRequests-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get all GDPR requests +GetGdprRequestsRequest.getGdprRequests(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGdprRequestsRequest.getGdprRequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGdprSubjects-example.txt b/build/docs/getGdprSubjects-example.txt new file mode 100644 index 000000000..11ab1d0c4 --- /dev/null +++ b/build/docs/getGdprSubjects-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let searchType: GetGdprSubjectsRequest.SearchType_getGdprSubjects = GetGdprSubjectsRequest.SearchType_getGdprSubjects.enummember // Search Type +let searchValue: String = "" // Search Value + +// Get GDPR subjects +GetGdprSubjectsRequest.getGdprSubjects(searchType: searchType, searchValue: searchValue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGdprSubjectsRequest.getGdprSubjects was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGeolocationsSettings-example.txt b/build/docs/getGeolocationsSettings-example.txt new file mode 100644 index 000000000..948391e74 --- /dev/null +++ b/build/docs/getGeolocationsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a organization's GeolocationSettings +GetGeolocationsSettingsRequest.getGeolocationsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGeolocationsSettingsRequest.getGeolocationsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGreeting-example.txt b/build/docs/getGreeting-example.txt new file mode 100644 index 000000000..0f2c8a458 --- /dev/null +++ b/build/docs/getGreeting-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let greetingId: String = "" // Greeting ID + +// Get a Greeting with the given GreetingId +GetGreetingRequest.getGreeting(greetingId: greetingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGreetingRequest.getGreeting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGreetingMedia-example.txt b/build/docs/getGreetingMedia-example.txt new file mode 100644 index 000000000..27cbbdb4f --- /dev/null +++ b/build/docs/getGreetingMedia-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let greetingId: String = "" // Greeting ID +let formatId: GetGreetingMediaRequest.FormatId_getGreetingMedia = GetGreetingMediaRequest.FormatId_getGreetingMedia.enummember // The desired media format. + +// Get media playback URI for this greeting +GetGreetingMediaRequest.getGreetingMedia(greetingId: greetingId, formatId: formatId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGreetingMediaRequest.getGreetingMedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGreetings-example.txt b/build/docs/getGreetings-example.txt new file mode 100644 index 000000000..ff4527e62 --- /dev/null +++ b/build/docs/getGreetings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Gets an Organization's Greetings +GetGreetingsRequest.getGreetings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGreetingsRequest.getGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGreetingsDefaults-example.txt b/build/docs/getGreetingsDefaults-example.txt new file mode 100644 index 000000000..b76c78148 --- /dev/null +++ b/build/docs/getGreetingsDefaults-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get an Organization's DefaultGreetingList +GetGreetingsDefaultsRequest.getGreetingsDefaults() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGreetingsDefaultsRequest.getGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroup-example.txt b/build/docs/getGroup-example.txt new file mode 100644 index 000000000..e3f0a695e --- /dev/null +++ b/build/docs/getGroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID + +// Get group +GetGroupRequest.getGroup(groupId: groupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupRequest.getGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupGreetings-example.txt b/build/docs/getGroupGreetings-example.txt new file mode 100644 index 000000000..b6921fa81 --- /dev/null +++ b/build/docs/getGroupGreetings-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of the Group's Greetings +GetGroupGreetingsRequest.getGroupGreetings(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupGreetingsRequest.getGroupGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupGreetingsDefaults-example.txt b/build/docs/getGroupGreetingsDefaults-example.txt new file mode 100644 index 000000000..d2b88d81d --- /dev/null +++ b/build/docs/getGroupGreetingsDefaults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID + +// Grabs the list of Default Greetings given a Group's ID +GetGroupGreetingsDefaultsRequest.getGroupGreetingsDefaults(groupId: groupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupGreetingsDefaultsRequest.getGroupGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupIndividuals-example.txt b/build/docs/getGroupIndividuals-example.txt new file mode 100644 index 000000000..9c65caaf6 --- /dev/null +++ b/build/docs/getGroupIndividuals-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID + +// Get all individuals associated with the group +GetGroupIndividualsRequest.getGroupIndividuals(groupId: groupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupIndividualsRequest.getGroupIndividuals was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupMembers-example.txt b/build/docs/getGroupMembers-example.txt new file mode 100644 index 000000000..b6ca9944e --- /dev/null +++ b/build/docs/getGroupMembers-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetGroupMembersRequest.SortOrder_getGroupMembers = GetGroupMembersRequest.SortOrder_getGroupMembers.enummember // Ascending or descending sort order +let expand: [String] = [""] // Which fields, if any, to expand + +// Get group members, includes individuals, owners, and dynamically included people +GetGroupMembersRequest.getGroupMembers(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupMembersRequest.getGroupMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupProfile-example.txt b/build/docs/getGroupProfile-example.txt new file mode 100644 index 000000000..d7938301b --- /dev/null +++ b/build/docs/getGroupProfile-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // groupId +let fields: String = "" // 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 + +// Get group profile +GetGroupProfileRequest.getGroupProfile(groupId: groupId, fields: fields) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupProfileRequest.getGroupProfile was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroups-example.txt b/build/docs/getGroups-example.txt new file mode 100644 index 000000000..1be34b205 --- /dev/null +++ b/build/docs/getGroups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // id +let jabberId: [String] = [""] // A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) +let sortOrder: GetGroupsRequest.SortOrder_getGroups = GetGroupsRequest.SortOrder_getGroups.enummember // Ascending or descending sort order + +// Get a group list +GetGroupsRequest.getGroups(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupsRequest.getGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getGroupsSearch-example.txt b/build/docs/getGroupsSearch-example.txt new file mode 100644 index 000000000..9a294fbec --- /dev/null +++ b/build/docs/getGroupsSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // expand + +// Search groups using the q64 value returned from a previous search +GetGroupsSearchRequest.getGroupsSearch(q64: q64, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetGroupsSearchRequest.getGroupsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityproviders-example.txt b/build/docs/getIdentityproviders-example.txt new file mode 100644 index 000000000..c155bee83 --- /dev/null +++ b/build/docs/getIdentityproviders-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// The list of identity providers +GetIdentityprovidersRequest.getIdentityproviders() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersRequest.getIdentityproviders was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersAdfs-example.txt b/build/docs/getIdentityprovidersAdfs-example.txt new file mode 100644 index 000000000..e53a0b799 --- /dev/null +++ b/build/docs/getIdentityprovidersAdfs-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get ADFS Identity Provider +GetIdentityprovidersAdfsRequest.getIdentityprovidersAdfs() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersAdfsRequest.getIdentityprovidersAdfs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersCic-example.txt b/build/docs/getIdentityprovidersCic-example.txt new file mode 100644 index 000000000..3eea17bdd --- /dev/null +++ b/build/docs/getIdentityprovidersCic-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Customer Interaction Center (CIC) Identity Provider +GetIdentityprovidersCicRequest.getIdentityprovidersCic() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersCicRequest.getIdentityprovidersCic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersGeneric-example.txt b/build/docs/getIdentityprovidersGeneric-example.txt new file mode 100644 index 000000000..61a813e0b --- /dev/null +++ b/build/docs/getIdentityprovidersGeneric-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Generic SAML Identity Provider +GetIdentityprovidersGenericRequest.getIdentityprovidersGeneric() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersGenericRequest.getIdentityprovidersGeneric was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersGsuite-example.txt b/build/docs/getIdentityprovidersGsuite-example.txt new file mode 100644 index 000000000..ce2c2d611 --- /dev/null +++ b/build/docs/getIdentityprovidersGsuite-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get G Suite Identity Provider +GetIdentityprovidersGsuiteRequest.getIdentityprovidersGsuite() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersGsuiteRequest.getIdentityprovidersGsuite was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersIdentitynow-example.txt b/build/docs/getIdentityprovidersIdentitynow-example.txt new file mode 100644 index 000000000..4d7a8b501 --- /dev/null +++ b/build/docs/getIdentityprovidersIdentitynow-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get IdentityNow Provider +GetIdentityprovidersIdentitynowRequest.getIdentityprovidersIdentitynow() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersIdentitynowRequest.getIdentityprovidersIdentitynow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersOkta-example.txt b/build/docs/getIdentityprovidersOkta-example.txt new file mode 100644 index 000000000..1c44a6fd3 --- /dev/null +++ b/build/docs/getIdentityprovidersOkta-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Okta Identity Provider +GetIdentityprovidersOktaRequest.getIdentityprovidersOkta() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersOktaRequest.getIdentityprovidersOkta was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersOnelogin-example.txt b/build/docs/getIdentityprovidersOnelogin-example.txt new file mode 100644 index 000000000..a84ea314a --- /dev/null +++ b/build/docs/getIdentityprovidersOnelogin-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get OneLogin Identity Provider +GetIdentityprovidersOneloginRequest.getIdentityprovidersOnelogin() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersOneloginRequest.getIdentityprovidersOnelogin was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersPing-example.txt b/build/docs/getIdentityprovidersPing-example.txt new file mode 100644 index 000000000..a9f592763 --- /dev/null +++ b/build/docs/getIdentityprovidersPing-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Ping Identity Provider +GetIdentityprovidersPingRequest.getIdentityprovidersPing() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersPingRequest.getIdentityprovidersPing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersPurecloud-example.txt b/build/docs/getIdentityprovidersPurecloud-example.txt new file mode 100644 index 000000000..d8931dc06 --- /dev/null +++ b/build/docs/getIdentityprovidersPurecloud-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get PureCloud Identity Provider +GetIdentityprovidersPurecloudRequest.getIdentityprovidersPurecloud() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersPurecloudRequest.getIdentityprovidersPurecloud was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersPureengage-example.txt b/build/docs/getIdentityprovidersPureengage-example.txt new file mode 100644 index 000000000..7a3e50093 --- /dev/null +++ b/build/docs/getIdentityprovidersPureengage-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get PureEngage Identity Provider +GetIdentityprovidersPureengageRequest.getIdentityprovidersPureengage() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersPureengageRequest.getIdentityprovidersPureengage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIdentityprovidersSalesforce-example.txt b/build/docs/getIdentityprovidersSalesforce-example.txt new file mode 100644 index 000000000..ae21909a7 --- /dev/null +++ b/build/docs/getIdentityprovidersSalesforce-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Salesforce Identity Provider +GetIdentityprovidersSalesforceRequest.getIdentityprovidersSalesforce() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIdentityprovidersSalesforceRequest.getIdentityprovidersSalesforce was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getInfrastructureascodeAccelerator-example.txt b/build/docs/getInfrastructureascodeAccelerator-example.txt new file mode 100644 index 000000000..cc4c13fe9 --- /dev/null +++ b/build/docs/getInfrastructureascodeAccelerator-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let acceleratorId: String = "" // Accelerator ID +let preferredLanguage: GetInfrastructureascodeAcceleratorRequest.PreferredLanguage_getInfrastructureascodeAccelerator = GetInfrastructureascodeAcceleratorRequest.PreferredLanguage_getInfrastructureascodeAccelerator.enummember // Preferred Language + +// Get information about an accelerator +GetInfrastructureascodeAcceleratorRequest.getInfrastructureascodeAccelerator(acceleratorId: acceleratorId, preferredLanguage: preferredLanguage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetInfrastructureascodeAcceleratorRequest.getInfrastructureascodeAccelerator was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getInfrastructureascodeAccelerators-example.txt b/build/docs/getInfrastructureascodeAccelerators-example.txt new file mode 100644 index 000000000..c431b5953 --- /dev/null +++ b/build/docs/getInfrastructureascodeAccelerators-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let sortOrder: GetInfrastructureascodeAcceleratorsRequest.SortOrder_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.SortOrder_getInfrastructureascodeAccelerators.enummember // Sort order +let name: String = "" // Filter by name +let _description: String = "" // Filter by description +let origin: GetInfrastructureascodeAcceleratorsRequest.Origin_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.Origin_getInfrastructureascodeAccelerators.enummember // Filter by origin +let type: GetInfrastructureascodeAcceleratorsRequest.ModelType_getInfrastructureascodeAccelerators = GetInfrastructureascodeAcceleratorsRequest.ModelType_getInfrastructureascodeAccelerators.enummember // Filter by type +let classification: String = "" // Filter by classification +let tags: String = "" // Filter by tags + +// Get a list of available accelerators +GetInfrastructureascodeAcceleratorsRequest.getInfrastructureascodeAccelerators(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _description: _description, origin: origin, type: type, classification: classification, tags: tags) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetInfrastructureascodeAcceleratorsRequest.getInfrastructureascodeAccelerators was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getInfrastructureascodeJob-example.txt b/build/docs/getInfrastructureascodeJob-example.txt new file mode 100644 index 000000000..9f3220395 --- /dev/null +++ b/build/docs/getInfrastructureascodeJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // Job ID +let details: Bool = true // Include details of execution, including job results or error information + +// Get job status and results +GetInfrastructureascodeJobRequest.getInfrastructureascodeJob(jobId: jobId, details: details) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetInfrastructureascodeJobRequest.getInfrastructureascodeJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getInfrastructureascodeJobs-example.txt b/build/docs/getInfrastructureascodeJobs-example.txt new file mode 100644 index 000000000..329749b8a --- /dev/null +++ b/build/docs/getInfrastructureascodeJobs-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let maxResults: Int = 0 // Number of jobs to show +let includeErrors: Bool = true // Include error messages +let sortBy: GetInfrastructureascodeJobsRequest.SortBy_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.SortBy_getInfrastructureascodeJobs.enummember // Sort by +let sortOrder: GetInfrastructureascodeJobsRequest.SortOrder_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.SortOrder_getInfrastructureascodeJobs.enummember // Sort order +let acceleratorId: String = "" // Find only jobs associated with this accelerator +let submittedBy: String = "" // Find only jobs submitted by this user +let status: GetInfrastructureascodeJobsRequest.Status_getInfrastructureascodeJobs = GetInfrastructureascodeJobsRequest.Status_getInfrastructureascodeJobs.enummember // Find only jobs in this state + +// Get job history +GetInfrastructureascodeJobsRequest.getInfrastructureascodeJobs(maxResults: maxResults, includeErrors: includeErrors, sortBy: sortBy, sortOrder: sortOrder, acceleratorId: acceleratorId, submittedBy: submittedBy, status: status) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetInfrastructureascodeJobsRequest.getInfrastructureascodeJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegration-example.txt b/build/docs/getIntegration-example.txt new file mode 100644 index 000000000..d28973287 --- /dev/null +++ b/build/docs/getIntegration-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration Id +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// Get integration. +GetIntegrationRequest.getIntegration(integrationId: integrationId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationRequest.getIntegration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationConfigCurrent-example.txt b/build/docs/getIntegrationConfigCurrent-example.txt new file mode 100644 index 000000000..3ef927b3c --- /dev/null +++ b/build/docs/getIntegrationConfigCurrent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration Id + +// Get integration configuration. +GetIntegrationConfigCurrentRequest.getIntegrationConfigCurrent(integrationId: integrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationConfigCurrentRequest.getIntegrationConfigCurrent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrations-example.txt b/build/docs/getIntegrations-example.txt new file mode 100644 index 000000000..91fab0e69 --- /dev/null +++ b/build/docs/getIntegrations-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// List integrations +GetIntegrationsRequest.getIntegrations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsRequest.getIntegrations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsAction-example.txt b/build/docs/getIntegrationsAction-example.txt new file mode 100644 index 000000000..a5eebb579 --- /dev/null +++ b/build/docs/getIntegrationsAction-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let expand: GetIntegrationsActionRequest.Expand_getIntegrationsAction = GetIntegrationsActionRequest.Expand_getIntegrationsAction.enummember // Indicates a field in the response which should be expanded. +let includeConfig: Bool = true // Return config in response. + +// Retrieves a single Action matching id. +GetIntegrationsActionRequest.getIntegrationsAction(actionId: actionId, expand: expand, includeConfig: includeConfig) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionRequest.getIntegrationsAction was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionDraft-example.txt b/build/docs/getIntegrationsActionDraft-example.txt new file mode 100644 index 000000000..1b4543d9e --- /dev/null +++ b/build/docs/getIntegrationsActionDraft-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let expand: GetIntegrationsActionDraftRequest.Expand_getIntegrationsActionDraft = GetIntegrationsActionDraftRequest.Expand_getIntegrationsActionDraft.enummember // Indicates a field in the response which should be expanded. +let includeConfig: Bool = true // Return config in response. + +// Retrieve a Draft +GetIntegrationsActionDraftRequest.getIntegrationsActionDraft(actionId: actionId, expand: expand, includeConfig: includeConfig) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionDraftRequest.getIntegrationsActionDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionDraftSchema-example.txt b/build/docs/getIntegrationsActionDraftSchema-example.txt new file mode 100644 index 000000000..0ffe699a1 --- /dev/null +++ b/build/docs/getIntegrationsActionDraftSchema-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let fileName: String = "" // Name of schema file to be retrieved for this draft. + +// Retrieve schema for a Draft based on filename. +GetIntegrationsActionDraftSchemaRequest.getIntegrationsActionDraftSchema(actionId: actionId, fileName: fileName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionDraftSchemaRequest.getIntegrationsActionDraftSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionDraftTemplate-example.txt b/build/docs/getIntegrationsActionDraftTemplate-example.txt new file mode 100644 index 000000000..0b588aeaf --- /dev/null +++ b/build/docs/getIntegrationsActionDraftTemplate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let fileName: String = "" // Name of template file to be retrieved for this action draft. + +// Retrieve templates for a Draft based on filename. +GetIntegrationsActionDraftTemplateRequest.getIntegrationsActionDraftTemplate(actionId: actionId, fileName: fileName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionDraftTemplateRequest.getIntegrationsActionDraftTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionDraftValidation-example.txt b/build/docs/getIntegrationsActionDraftValidation-example.txt new file mode 100644 index 000000000..2aa10826e --- /dev/null +++ b/build/docs/getIntegrationsActionDraftValidation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId + +// Validate current Draft configuration. +GetIntegrationsActionDraftValidationRequest.getIntegrationsActionDraftValidation(actionId: actionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionDraftValidationRequest.getIntegrationsActionDraftValidation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionSchema-example.txt b/build/docs/getIntegrationsActionSchema-example.txt new file mode 100644 index 000000000..30815977c --- /dev/null +++ b/build/docs/getIntegrationsActionSchema-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let fileName: String = "" // Name of schema file to be retrieved for this action. + +// Retrieve schema for an action based on filename. +GetIntegrationsActionSchemaRequest.getIntegrationsActionSchema(actionId: actionId, fileName: fileName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionSchemaRequest.getIntegrationsActionSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionTemplate-example.txt b/build/docs/getIntegrationsActionTemplate-example.txt new file mode 100644 index 000000000..f5a5f1460 --- /dev/null +++ b/build/docs/getIntegrationsActionTemplate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let fileName: String = "" // Name of template file to be retrieved for this action. + +// Retrieve text of templates for an action based on filename. +GetIntegrationsActionTemplateRequest.getIntegrationsActionTemplate(actionId: actionId, fileName: fileName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionTemplateRequest.getIntegrationsActionTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActions-example.txt b/build/docs/getIntegrationsActions-example.txt new file mode 100644 index 000000000..0ef281681 --- /dev/null +++ b/build/docs/getIntegrationsActions-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let sortBy: String = "" // Root level field name to sort on. +let sortOrder: GetIntegrationsActionsRequest.SortOrder_getIntegrationsActions = GetIntegrationsActionsRequest.SortOrder_getIntegrationsActions.enummember // Direction to sort 'sortBy' field. +let category: String = "" // Filter by category name. +let name: String = "" // Filter by partial or complete action name. +let ids: String = "" // Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. +let secure: GetIntegrationsActionsRequest.Secure_getIntegrationsActions = GetIntegrationsActionsRequest.Secure_getIntegrationsActions.enummember // Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. +let includeAuthActions: GetIntegrationsActionsRequest.IncludeAuthActions_getIntegrationsActions = GetIntegrationsActionsRequest.IncludeAuthActions_getIntegrationsActions.enummember // 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. + +// Retrieves all actions associated with filters passed in via query param. +GetIntegrationsActionsRequest.getIntegrationsActions(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, category: category, name: name, ids: ids, secure: secure, includeAuthActions: includeAuthActions) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionsRequest.getIntegrationsActions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionsCategories-example.txt b/build/docs/getIntegrationsActionsCategories-example.txt new file mode 100644 index 000000000..6686ed80c --- /dev/null +++ b/build/docs/getIntegrationsActionsCategories-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let sortBy: String = "" // Root level field name to sort on. Only 'name' is supported on this endpoint. +let sortOrder: GetIntegrationsActionsCategoriesRequest.SortOrder_getIntegrationsActionsCategories = GetIntegrationsActionsCategoriesRequest.SortOrder_getIntegrationsActionsCategories.enummember // Direction to sort 'sortBy' field. +let secure: GetIntegrationsActionsCategoriesRequest.Secure_getIntegrationsActionsCategories = GetIntegrationsActionsCategoriesRequest.Secure_getIntegrationsActionsCategories.enummember // 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. + +// Retrieves all categories of available Actions +GetIntegrationsActionsCategoriesRequest.getIntegrationsActionsCategories(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, secure: secure) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionsCategoriesRequest.getIntegrationsActionsCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsActionsDrafts-example.txt b/build/docs/getIntegrationsActionsDrafts-example.txt new file mode 100644 index 000000000..82f189d9b --- /dev/null +++ b/build/docs/getIntegrationsActionsDrafts-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let sortBy: String = "" // Root level field name to sort on. +let sortOrder: GetIntegrationsActionsDraftsRequest.SortOrder_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.SortOrder_getIntegrationsActionsDrafts.enummember // Direction to sort 'sortBy' field. +let category: String = "" // Filter by category name. +let name: String = "" // Filter by partial or complete action name. +let ids: String = "" // Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. +let secure: GetIntegrationsActionsDraftsRequest.Secure_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.Secure_getIntegrationsActionsDrafts.enummember // Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. +let includeAuthActions: GetIntegrationsActionsDraftsRequest.IncludeAuthActions_getIntegrationsActionsDrafts = GetIntegrationsActionsDraftsRequest.IncludeAuthActions_getIntegrationsActionsDrafts.enummember // 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. + +// Retrieves all action drafts associated with the filters passed in via query param. +GetIntegrationsActionsDraftsRequest.getIntegrationsActionsDrafts(pageSize: pageSize, pageNumber: pageNumber, nextPage: nextPage, previousPage: previousPage, sortBy: sortBy, sortOrder: sortOrder, category: category, name: name, ids: ids, secure: secure, includeAuthActions: includeAuthActions) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsActionsDraftsRequest.getIntegrationsActionsDrafts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsBotconnectorIntegrationIdBot-example.txt b/build/docs/getIntegrationsBotconnectorIntegrationIdBot-example.txt new file mode 100644 index 000000000..760b2a483 --- /dev/null +++ b/build/docs/getIntegrationsBotconnectorIntegrationIdBot-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // The integration ID for this group of bots +let botId: String = "" // The botID for this bot +let version: String = "" // Specific Version + +// Get a specific botConnector bot, plus versions, for this integration +GetIntegrationsBotconnectorIntegrationIdBotRequest.getIntegrationsBotconnectorIntegrationIdBot(integrationId: integrationId, botId: botId, version: version) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsBotconnectorIntegrationIdBotRequest.getIntegrationsBotconnectorIntegrationIdBot was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsBotconnectorIntegrationIdBotVersions-example.txt b/build/docs/getIntegrationsBotconnectorIntegrationIdBotVersions-example.txt new file mode 100644 index 000000000..b9f03e6ff --- /dev/null +++ b/build/docs/getIntegrationsBotconnectorIntegrationIdBotVersions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // The integration ID for this bot group +let botId: String = "" // The botID for this bot +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a list of bot versions for a bot +GetIntegrationsBotconnectorIntegrationIdBotVersionsRequest.getIntegrationsBotconnectorIntegrationIdBotVersions(integrationId: integrationId, botId: botId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsBotconnectorIntegrationIdBotVersionsRequest.getIntegrationsBotconnectorIntegrationIdBotVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsBotconnectorIntegrationIdBots-example.txt b/build/docs/getIntegrationsBotconnectorIntegrationIdBots-example.txt new file mode 100644 index 000000000..e9a4358b2 --- /dev/null +++ b/build/docs/getIntegrationsBotconnectorIntegrationIdBots-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // The integration ID for this group of bots + +// Get a list of botConnector bots for this integration +GetIntegrationsBotconnectorIntegrationIdBotsRequest.getIntegrationsBotconnectorIntegrationIdBots(integrationId: integrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsBotconnectorIntegrationIdBotsRequest.getIntegrationsBotconnectorIntegrationIdBots was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsBotconnectorIntegrationIdBotsSummaries-example.txt b/build/docs/getIntegrationsBotconnectorIntegrationIdBotsSummaries-example.txt new file mode 100644 index 000000000..618334797 --- /dev/null +++ b/build/docs/getIntegrationsBotconnectorIntegrationIdBotsSummaries-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // The integration ID for this group of bots +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a summary list of botConnector bots for this integration +GetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest.getIntegrationsBotconnectorIntegrationIdBotsSummaries(integrationId: integrationId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsBotconnectorIntegrationIdBotsSummariesRequest.getIntegrationsBotconnectorIntegrationIdBotsSummaries was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsClientapps-example.txt b/build/docs/getIntegrationsClientapps-example.txt new file mode 100644 index 000000000..047f905fb --- /dev/null +++ b/build/docs/getIntegrationsClientapps-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// List permitted client app integrations for the logged in user +GetIntegrationsClientappsRequest.getIntegrationsClientapps(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsClientappsRequest.getIntegrationsClientapps was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsClientappsUnifiedcommunications-example.txt b/build/docs/getIntegrationsClientappsUnifiedcommunications-example.txt new file mode 100644 index 000000000..65a57aab8 --- /dev/null +++ b/build/docs/getIntegrationsClientappsUnifiedcommunications-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// UC integration client application configuration. +GetIntegrationsClientappsUnifiedcommunicationsRequest.getIntegrationsClientappsUnifiedcommunications(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsClientappsUnifiedcommunicationsRequest.getIntegrationsClientappsUnifiedcommunications was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsCredential-example.txt b/build/docs/getIntegrationsCredential-example.txt new file mode 100644 index 000000000..783280d54 --- /dev/null +++ b/build/docs/getIntegrationsCredential-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let credentialId: String = "" // Credential ID + +// Get a single credential with sensitive fields redacted +GetIntegrationsCredentialRequest.getIntegrationsCredential(credentialId: credentialId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsCredentialRequest.getIntegrationsCredential was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsCredentials-example.txt b/build/docs/getIntegrationsCredentials-example.txt new file mode 100644 index 000000000..b88ef2ee9 --- /dev/null +++ b/build/docs/getIntegrationsCredentials-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// List multiple sets of credentials +GetIntegrationsCredentialsRequest.getIntegrationsCredentials(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsCredentialsRequest.getIntegrationsCredentials was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsCredentialsTypes-example.txt b/build/docs/getIntegrationsCredentialsTypes-example.txt new file mode 100644 index 000000000..aa772bfac --- /dev/null +++ b/build/docs/getIntegrationsCredentialsTypes-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// List all credential types +GetIntegrationsCredentialsTypesRequest.getIntegrationsCredentialsTypes() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsCredentialsTypesRequest.getIntegrationsCredentialsTypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechDialogflowAgent-example.txt b/build/docs/getIntegrationsSpeechDialogflowAgent-example.txt new file mode 100644 index 000000000..9877a4164 --- /dev/null +++ b/build/docs/getIntegrationsSpeechDialogflowAgent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The agent ID + +// Get details about a Dialogflow agent +GetIntegrationsSpeechDialogflowAgentRequest.getIntegrationsSpeechDialogflowAgent(agentId: agentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechDialogflowAgentRequest.getIntegrationsSpeechDialogflowAgent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechDialogflowAgents-example.txt b/build/docs/getIntegrationsSpeechDialogflowAgents-example.txt new file mode 100644 index 000000000..3321ee607 --- /dev/null +++ b/build/docs/getIntegrationsSpeechDialogflowAgents-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let name: String = "" // Filter on agent name + +// Get a list of Dialogflow agents in the customers' Google accounts +GetIntegrationsSpeechDialogflowAgentsRequest.getIntegrationsSpeechDialogflowAgents(pageNumber: pageNumber, pageSize: pageSize, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechDialogflowAgentsRequest.getIntegrationsSpeechDialogflowAgents was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechLexBotAlias-example.txt b/build/docs/getIntegrationsSpeechLexBotAlias-example.txt new file mode 100644 index 000000000..17c14cae2 --- /dev/null +++ b/build/docs/getIntegrationsSpeechLexBotAlias-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let aliasId: String = "" // The alias ID + +// Get details about a Lex bot alias +GetIntegrationsSpeechLexBotAliasRequest.getIntegrationsSpeechLexBotAlias(aliasId: aliasId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechLexBotAliasRequest.getIntegrationsSpeechLexBotAlias was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechLexBotBotIdAliases-example.txt b/build/docs/getIntegrationsSpeechLexBotBotIdAliases-example.txt new file mode 100644 index 000000000..65b079c50 --- /dev/null +++ b/build/docs/getIntegrationsSpeechLexBotBotIdAliases-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let botId: String = "" // The bot ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let status: GetIntegrationsSpeechLexBotBotIdAliasesRequest.Status_getIntegrationsSpeechLexBotBotIdAliases = GetIntegrationsSpeechLexBotBotIdAliasesRequest.Status_getIntegrationsSpeechLexBotBotIdAliases.enummember // Filter on alias status +let name: String = "" // Filter on alias name + +// Get a list of aliases for a bot in the customer's AWS accounts +GetIntegrationsSpeechLexBotBotIdAliasesRequest.getIntegrationsSpeechLexBotBotIdAliases(botId: botId, pageNumber: pageNumber, pageSize: pageSize, status: status, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechLexBotBotIdAliasesRequest.getIntegrationsSpeechLexBotBotIdAliases was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechLexBots-example.txt b/build/docs/getIntegrationsSpeechLexBots-example.txt new file mode 100644 index 000000000..24600ebda --- /dev/null +++ b/build/docs/getIntegrationsSpeechLexBots-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let name: String = "" // Filter on bot name + +// Get a list of Lex bots in the customers' AWS accounts +GetIntegrationsSpeechLexBotsRequest.getIntegrationsSpeechLexBots(pageNumber: pageNumber, pageSize: pageSize, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechLexBotsRequest.getIntegrationsSpeechLexBots was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechTtsEngine-example.txt b/build/docs/getIntegrationsSpeechTtsEngine-example.txt new file mode 100644 index 000000000..550e1a9d8 --- /dev/null +++ b/build/docs/getIntegrationsSpeechTtsEngine-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let engineId: String = "" // The engine ID +let includeVoices: Bool = true // Include voices for the engine + +// Get details about a TTS engine +GetIntegrationsSpeechTtsEngineRequest.getIntegrationsSpeechTtsEngine(engineId: engineId, includeVoices: includeVoices) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechTtsEngineRequest.getIntegrationsSpeechTtsEngine was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechTtsEngineVoice-example.txt b/build/docs/getIntegrationsSpeechTtsEngineVoice-example.txt new file mode 100644 index 000000000..63e030793 --- /dev/null +++ b/build/docs/getIntegrationsSpeechTtsEngineVoice-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let engineId: String = "" // The engine ID +let voiceId: String = "" // The voice ID + +// Get details about a specific voice for a TTS engine +GetIntegrationsSpeechTtsEngineVoiceRequest.getIntegrationsSpeechTtsEngineVoice(engineId: engineId, voiceId: voiceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechTtsEngineVoiceRequest.getIntegrationsSpeechTtsEngineVoice was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechTtsEngineVoices-example.txt b/build/docs/getIntegrationsSpeechTtsEngineVoices-example.txt new file mode 100644 index 000000000..c396394ca --- /dev/null +++ b/build/docs/getIntegrationsSpeechTtsEngineVoices-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let engineId: String = "" // The engine ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get a list of voices for a TTS engine +GetIntegrationsSpeechTtsEngineVoicesRequest.getIntegrationsSpeechTtsEngineVoices(engineId: engineId, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechTtsEngineVoicesRequest.getIntegrationsSpeechTtsEngineVoices was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechTtsEngines-example.txt b/build/docs/getIntegrationsSpeechTtsEngines-example.txt new file mode 100644 index 000000000..c9481a3a7 --- /dev/null +++ b/build/docs/getIntegrationsSpeechTtsEngines-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let includeVoices: Bool = true // Include voices for the engine +let name: String = "" // Filter on engine name +let language: String = "" // Filter on supported language. If includeVoices=true then the voices are also filtered. + +// Get a list of TTS engines enabled for org +GetIntegrationsSpeechTtsEnginesRequest.getIntegrationsSpeechTtsEngines(pageNumber: pageNumber, pageSize: pageSize, includeVoices: includeVoices, name: name, language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechTtsEnginesRequest.getIntegrationsSpeechTtsEngines was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsSpeechTtsSettings-example.txt b/build/docs/getIntegrationsSpeechTtsSettings-example.txt new file mode 100644 index 000000000..8a895445b --- /dev/null +++ b/build/docs/getIntegrationsSpeechTtsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get TTS settings for an org +GetIntegrationsSpeechTtsSettingsRequest.getIntegrationsSpeechTtsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsSpeechTtsSettingsRequest.getIntegrationsSpeechTtsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsType-example.txt b/build/docs/getIntegrationsType-example.txt new file mode 100644 index 000000000..3b99ab038 --- /dev/null +++ b/build/docs/getIntegrationsType-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let typeId: String = "" // Integration Type Id + +// Get integration type. +GetIntegrationsTypeRequest.getIntegrationsType(typeId: typeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsTypeRequest.getIntegrationsType was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsTypeConfigschema-example.txt b/build/docs/getIntegrationsTypeConfigschema-example.txt new file mode 100644 index 000000000..42a70a05c --- /dev/null +++ b/build/docs/getIntegrationsTypeConfigschema-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let typeId: String = "" // Integration Type Id +let configType: GetIntegrationsTypeConfigschemaRequest.ConfigType_getIntegrationsTypeConfigschema = GetIntegrationsTypeConfigschemaRequest.ConfigType_getIntegrationsTypeConfigschema.enummember // Config schema type + +// Get properties config schema for an integration type. +GetIntegrationsTypeConfigschemaRequest.getIntegrationsTypeConfigschema(typeId: typeId, configType: configType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsTypeConfigschemaRequest.getIntegrationsTypeConfigschema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsTypes-example.txt b/build/docs/getIntegrationsTypes-example.txt new file mode 100644 index 000000000..1977b26d4 --- /dev/null +++ b/build/docs/getIntegrationsTypes-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token + +// List integration types +GetIntegrationsTypesRequest.getIntegrationsTypes(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsTypesRequest.getIntegrationsTypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIntegrationsUserapps-example.txt b/build/docs/getIntegrationsUserapps-example.txt new file mode 100644 index 000000000..5859d87b6 --- /dev/null +++ b/build/docs/getIntegrationsUserapps-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let appHost: String = "" // The type of UserApp to filter by + +// List permitted user app integrations for the logged in user +GetIntegrationsUserappsRequest.getIntegrationsUserapps(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, appHost: appHost) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIntegrationsUserappsRequest.getIntegrationsUserapps was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getIpranges-example.txt b/build/docs/getIpranges-example.txt new file mode 100644 index 000000000..6ccb92b84 --- /dev/null +++ b/build/docs/getIpranges-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get public ip address ranges for Genesys Cloud +GetIprangesRequest.getIpranges() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetIprangesRequest.getIpranges was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActionmap-example.txt b/build/docs/getJourneyActionmap-example.txt new file mode 100644 index 000000000..9d6abc713 --- /dev/null +++ b/build/docs/getJourneyActionmap-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionMapId: String = "" // ID of the action map. + +// Retrieve a single action map. +GetJourneyActionmapRequest.getJourneyActionmap(actionMapId: actionMapId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActionmapRequest.getJourneyActionmap was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActionmaps-example.txt b/build/docs/getJourneyActionmaps-example.txt new file mode 100644 index 000000000..4150b5128 --- /dev/null +++ b/build/docs/getJourneyActionmaps-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). +let filterField: String = "" // Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set. +let filterValue: String = "" // Value to filter by. Requires 'filterValue' to also be set. +let actionMapIds: [String] = [""] // IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request. +let queryFields: [String] = [""] // Action Map field(s) to query on. Requires 'queryValue' to also be set. +let queryValue: String = "" // Value to query on. Requires 'queryFields' to also be set. + +// Retrieve all action maps. +GetJourneyActionmapsRequest.getJourneyActionmaps(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, filterField: filterField, filterValue: filterValue, actionMapIds: actionMapIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActionmapsRequest.getJourneyActionmaps was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActionmapsEstimatesJob-example.txt b/build/docs/getJourneyActionmapsEstimatesJob-example.txt new file mode 100644 index 000000000..f26450977 --- /dev/null +++ b/build/docs/getJourneyActionmapsEstimatesJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // ID of the job. + +// Get status of job. +GetJourneyActionmapsEstimatesJobRequest.getJourneyActionmapsEstimatesJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActionmapsEstimatesJobRequest.getJourneyActionmapsEstimatesJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActionmapsEstimatesJobResults-example.txt b/build/docs/getJourneyActionmapsEstimatesJobResults-example.txt new file mode 100644 index 000000000..aa006121f --- /dev/null +++ b/build/docs/getJourneyActionmapsEstimatesJobResults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // ID of the job. + +// Get estimates from completed job. +GetJourneyActionmapsEstimatesJobResultsRequest.getJourneyActionmapsEstimatesJobResults(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActionmapsEstimatesJobResultsRequest.getJourneyActionmapsEstimatesJobResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActiontarget-example.txt b/build/docs/getJourneyActiontarget-example.txt new file mode 100644 index 000000000..92a563112 --- /dev/null +++ b/build/docs/getJourneyActiontarget-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionTargetId: String = "" // ID of the action target. + +// Retrieve a single action target. +GetJourneyActiontargetRequest.getJourneyActiontarget(actionTargetId: actionTargetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActiontargetRequest.getJourneyActiontarget was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActiontargets-example.txt b/build/docs/getJourneyActiontargets-example.txt new file mode 100644 index 000000000..cbcb34bf5 --- /dev/null +++ b/build/docs/getJourneyActiontargets-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Retrieve all action targets. +GetJourneyActiontargetsRequest.getJourneyActiontargets(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActiontargetsRequest.getJourneyActiontargets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActiontemplate-example.txt b/build/docs/getJourneyActiontemplate-example.txt new file mode 100644 index 000000000..da94f0d5a --- /dev/null +++ b/build/docs/getJourneyActiontemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionTemplateId: String = "" // ID of the action template. + +// Retrieve a single action template. +GetJourneyActiontemplateRequest.getJourneyActiontemplate(actionTemplateId: actionTemplateId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActiontemplateRequest.getJourneyActiontemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyActiontemplates-example.txt b/build/docs/getJourneyActiontemplates-example.txt new file mode 100644 index 000000000..f82541923 --- /dev/null +++ b/build/docs/getJourneyActiontemplates-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate). +let mediaType: GetJourneyActiontemplatesRequest.MediaType_getJourneyActiontemplates = GetJourneyActiontemplatesRequest.MediaType_getJourneyActiontemplates.enummember // Media type +let state: GetJourneyActiontemplatesRequest.State_getJourneyActiontemplates = GetJourneyActiontemplatesRequest.State_getJourneyActiontemplates.enummember // Action template state. +let queryFields: [String] = [""] // ActionTemplate field(s) to query on. Requires 'queryValue' to also be set. +let queryValue: String = "" // Value to query on. Requires 'queryFields' to also be set. + +// Retrieve all action templates. +GetJourneyActiontemplatesRequest.getJourneyActiontemplates(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, mediaType: mediaType, state: state, queryFields: queryFields, queryValue: queryValue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyActiontemplatesRequest.getJourneyActiontemplates was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyOutcome-example.txt b/build/docs/getJourneyOutcome-example.txt new file mode 100644 index 000000000..2b326b85e --- /dev/null +++ b/build/docs/getJourneyOutcome-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let outcomeId: String = "" // ID of the outcome. + +// Retrieve a single outcome. +GetJourneyOutcomeRequest.getJourneyOutcome(outcomeId: outcomeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyOutcomeRequest.getJourneyOutcome was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyOutcomes-example.txt b/build/docs/getJourneyOutcomes-example.txt new file mode 100644 index 000000000..56af62317 --- /dev/null +++ b/build/docs/getJourneyOutcomes-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // 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). +let outcomeIds: [String] = [""] // IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request. +let queryFields: [String] = [""] // Outcome field(s) to query on. Requires 'queryValue' to also be set. +let queryValue: String = "" // Value to query on. Requires 'queryFields' to also be set. + +// Retrieve all outcomes. +GetJourneyOutcomesRequest.getJourneyOutcomes(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, outcomeIds: outcomeIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyOutcomesRequest.getJourneyOutcomes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyOutcomesPredictor-example.txt b/build/docs/getJourneyOutcomesPredictor-example.txt new file mode 100644 index 000000000..fedfa6288 --- /dev/null +++ b/build/docs/getJourneyOutcomesPredictor-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // ID of predictor + +// Retrieve a single outcome predictor. +GetJourneyOutcomesPredictorRequest.getJourneyOutcomesPredictor(predictorId: predictorId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyOutcomesPredictorRequest.getJourneyOutcomesPredictor was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneyOutcomesPredictors-example.txt b/build/docs/getJourneyOutcomesPredictors-example.txt new file mode 100644 index 000000000..08af6dccd --- /dev/null +++ b/build/docs/getJourneyOutcomesPredictors-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Retrieve all outcome predictors. +GetJourneyOutcomesPredictorsRequest.getJourneyOutcomesPredictors() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneyOutcomesPredictorsRequest.getJourneyOutcomesPredictors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneySegment-example.txt b/build/docs/getJourneySegment-example.txt new file mode 100644 index 000000000..64f10a2a2 --- /dev/null +++ b/build/docs/getJourneySegment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let segmentId: String = "" // ID of the segment. + +// Retrieve a single segment. +GetJourneySegmentRequest.getJourneySegment(segmentId: segmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneySegmentRequest.getJourneySegment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneySegments-example.txt b/build/docs/getJourneySegments-example.txt new file mode 100644 index 000000000..7d9adaf46 --- /dev/null +++ b/build/docs/getJourneySegments-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sortBy: String = "" // 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). +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let isActive: Bool = true // Determines whether or not to show only active segments. +let segmentIds: [String] = [""] // IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request. +let queryFields: [String] = [""] // Segment field(s) to query on. Requires 'queryValue' to also be set. +let queryValue: String = "" // Value to query on. Requires 'queryFields' to also be set. + +// Retrieve all segments. +GetJourneySegmentsRequest.getJourneySegments(sortBy: sortBy, pageSize: pageSize, pageNumber: pageNumber, isActive: isActive, segmentIds: segmentIds, queryFields: queryFields, queryValue: queryValue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneySegmentsRequest.getJourneySegments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneySession-example.txt b/build/docs/getJourneySession-example.txt new file mode 100644 index 000000000..3c8bd2b7d --- /dev/null +++ b/build/docs/getJourneySession-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // ID of the session. + +// Retrieve a single session. +GetJourneySessionRequest.getJourneySession(sessionId: sessionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneySessionRequest.getJourneySession was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getJourneySessionOutcomescores-example.txt b/build/docs/getJourneySessionOutcomescores-example.txt new file mode 100644 index 000000000..563832c22 --- /dev/null +++ b/build/docs/getJourneySessionOutcomescores-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // ID of the session. + +// Retrieve latest outcome score associated with a session for all outcomes. +GetJourneySessionOutcomescoresRequest.getJourneySessionOutcomescores(sessionId: sessionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetJourneySessionOutcomescoresRequest.getJourneySessionOutcomescores was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeGuestSessionCategories-example.txt b/build/docs/getKnowledgeGuestSessionCategories-example.txt new file mode 100644 index 000000000..1192899d6 --- /dev/null +++ b/build/docs/getKnowledgeGuestSessionCategories-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let parentId: String = "" // If specified, retrieves the children categories by parent category ID. +let isRoot: Bool = true // If specified, retrieves only the root categories. +let name: String = "" // Filter to return the categories that starts with the given category name. +let sortBy: GetKnowledgeGuestSessionCategoriesRequest.SortBy_getKnowledgeGuestSessionCategories = GetKnowledgeGuestSessionCategoriesRequest.SortBy_getKnowledgeGuestSessionCategories.enummember // Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically +let expand: String = "" // The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. +let includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to category. + +// Get categories +GetKnowledgeGuestSessionCategoriesRequest.getKnowledgeGuestSessionCategories(sessionId: sessionId, before: before, after: after, pageSize: pageSize, parentId: parentId, isRoot: isRoot, name: name, sortBy: sortBy, expand: expand, includeDocumentCount: includeDocumentCount) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeGuestSessionCategoriesRequest.getKnowledgeGuestSessionCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeGuestSessionDocument-example.txt b/build/docs/getKnowledgeGuestSessionDocument-example.txt new file mode 100644 index 000000000..afcd51dae --- /dev/null +++ b/build/docs/getKnowledgeGuestSessionDocument-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let documentId: String = "" // Document ID + +// Get a knowledge document by ID. +GetKnowledgeGuestSessionDocumentRequest.getKnowledgeGuestSessionDocument(sessionId: sessionId, documentId: documentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeGuestSessionDocumentRequest.getKnowledgeGuestSessionDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeGuestSessionDocuments-example.txt b/build/docs/getKnowledgeGuestSessionDocuments-example.txt new file mode 100644 index 000000000..87d28da8b --- /dev/null +++ b/build/docs/getKnowledgeGuestSessionDocuments-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let categoryId: [String] = [""] // If specified, retrieves documents associated with category ids, comma separated values expected. +let pageSize: Int = 0 // Number of entities to return. Maximum of 200. + +// Get documents. +GetKnowledgeGuestSessionDocumentsRequest.getKnowledgeGuestSessionDocuments(sessionId: sessionId, categoryId: categoryId, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeGuestSessionDocumentsRequest.getKnowledgeGuestSessionDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebase-example.txt b/build/docs/getKnowledgeKnowledgebase-example.txt new file mode 100644 index 000000000..eef1d5ba7 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebase-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID + +// Get knowledge base +GetKnowledgeKnowledgebaseRequest.getKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseRequest.getKnowledgeKnowledgebase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseCategories-example.txt b/build/docs/getKnowledgeKnowledgebaseCategories-example.txt new file mode 100644 index 000000000..924dc3efb --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseCategories-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let parentId: String = "" // If specified, retrieves the children categories by parent category ID. +let isRoot: Bool = true // If specified, retrieves only the root categories. +let name: String = "" // Filter to return the categories that starts with the given category name. +let sortBy: GetKnowledgeKnowledgebaseCategoriesRequest.SortBy_getKnowledgeKnowledgebaseCategories = GetKnowledgeKnowledgebaseCategoriesRequest.SortBy_getKnowledgeKnowledgebaseCategories.enummember // Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically +let expand: String = "" // The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. +let includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to category. + +// Get categories +GetKnowledgeKnowledgebaseCategoriesRequest.getKnowledgeKnowledgebaseCategories(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, parentId: parentId, isRoot: isRoot, name: name, sortBy: sortBy, expand: expand, includeDocumentCount: includeDocumentCount) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseCategoriesRequest.getKnowledgeKnowledgebaseCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseCategory-example.txt b/build/docs/getKnowledgeKnowledgebaseCategory-example.txt new file mode 100644 index 000000000..759be6946 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseCategory-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let categoryId: String = "" // Category ID + +// Get category +GetKnowledgeKnowledgebaseCategoryRequest.getKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseCategoryRequest.getKnowledgeKnowledgebaseCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocument-example.txt b/build/docs/getKnowledgeKnowledgebaseDocument-example.txt new file mode 100644 index 000000000..ed641d4d8 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocument-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. +let state: GetKnowledgeKnowledgebaseDocumentRequest.State_getKnowledgeKnowledgebaseDocument = GetKnowledgeKnowledgebaseDocumentRequest.State_getKnowledgeKnowledgebaseDocument.enummember // \"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response. + +// Get document. +GetKnowledgeKnowledgebaseDocumentRequest.getKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId, expand: expand, state: state) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentRequest.getKnowledgeKnowledgebaseDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentFeedback-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentFeedback-example.txt new file mode 100644 index 000000000..c032e943e --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentFeedback-example.txt @@ -0,0 +1,28 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let onlyCommented: Bool = true // If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. +let documentVersionId: String = "" // Document version ID to filter by. Supported only if onlyCommented=true is set. +let documentVariationId: String = "" // Document variation ID to filter by. Supported only if onlyCommented=true is set. +let appType: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.AppType_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.AppType_getKnowledgeKnowledgebaseDocumentFeedback.enummember // Application type to filter by. Supported only if onlyCommented=true is set. +let queryType: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.QueryType_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.QueryType_getKnowledgeKnowledgebaseDocumentFeedback.enummember // Query type to filter by. Supported only if onlyCommented=true is set. +let userId: String = "" // The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. +let queueId: String = "" // Queue ID to filter by. Supported only if onlyCommented=true is set. +let state: GetKnowledgeKnowledgebaseDocumentFeedbackRequest.State_getKnowledgeKnowledgebaseDocumentFeedback = GetKnowledgeKnowledgebaseDocumentFeedbackRequest.State_getKnowledgeKnowledgebaseDocumentFeedback.enummember // State to filter by. Supported only if onlyCommented=true is set. Default: Final + +// Get a list of feedback records given on a document +GetKnowledgeKnowledgebaseDocumentFeedbackRequest.getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, onlyCommented: onlyCommented, documentVersionId: documentVersionId, documentVariationId: documentVariationId, appType: appType, queryType: queryType, userId: userId, queueId: queueId, state: state) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentFeedbackRequest.getKnowledgeKnowledgebaseDocumentFeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId-example.txt new file mode 100644 index 000000000..c59bb42ec --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let feedbackId: String = "" // Feedback ID. + +// Get a single feedback record given on a document +GetKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest.getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId: knowledgeBaseId, documentId: documentId, feedbackId: feedbackId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentFeedbackFeedbackIdRequest.getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVariation-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVariation-example.txt new file mode 100644 index 000000000..4e8dbdd2a --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVariation-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentVariationId: String = "" // Globally unique identifier for a document variation. +let documentId: String = "" // Globally unique identifier for a document. +let knowledgeBaseId: String = "" // Globally unique identifier for a knowledge base. +let documentState: GetKnowledgeKnowledgebaseDocumentVariationRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariation = GetKnowledgeKnowledgebaseDocumentVariationRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariation.enummember // The state of the document. + +// Get a variation for a document. +GetKnowledgeKnowledgebaseDocumentVariationRequest.getKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId, documentState: documentState) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVariationRequest.getKnowledgeKnowledgebaseDocumentVariation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVariations-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVariations-example.txt new file mode 100644 index 000000000..c4df254e1 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVariations-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let documentState: GetKnowledgeKnowledgebaseDocumentVariationsRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariations = GetKnowledgeKnowledgebaseDocumentVariationsRequest.DocumentState_getKnowledgeKnowledgebaseDocumentVariations.enummember // The state of the document. + +// Get variations for a document. +GetKnowledgeKnowledgebaseDocumentVariationsRequest.getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, documentState: documentState) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVariationsRequest.getKnowledgeKnowledgebaseDocumentVariations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVersion-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVersion-example.txt new file mode 100644 index 000000000..259614727 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVersion-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let versionId: String = "" // Globally unique identifier for the document version. +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. + +// Get document version. +GetKnowledgeKnowledgebaseDocumentVersionRequest.getKnowledgeKnowledgebaseDocumentVersion(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVersionRequest.getKnowledgeKnowledgebaseDocumentVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariation-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariation-example.txt new file mode 100644 index 000000000..7a50de5a5 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariation-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let versionId: String = "" // Globally unique identifier for the document version. +let variationId: String = "" // Globally unique identifier for the document version variation. + +// Get variation for the given document version. +GetKnowledgeKnowledgebaseDocumentVersionVariationRequest.getKnowledgeKnowledgebaseDocumentVersionVariation(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, variationId: variationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVersionVariationRequest.getKnowledgeKnowledgebaseDocumentVersionVariation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariations-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariations-example.txt new file mode 100644 index 000000000..1284a503a --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVersionVariations-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let versionId: String = "" // Globally unique identifier for the document version. +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. + +// Get variations for the given document version. +GetKnowledgeKnowledgebaseDocumentVersionVariationsRequest.getKnowledgeKnowledgebaseDocumentVersionVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, versionId: versionId, before: before, after: after, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVersionVariationsRequest.getKnowledgeKnowledgebaseDocumentVersionVariations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocumentVersions-example.txt b/build/docs/getKnowledgeKnowledgebaseDocumentVersions-example.txt new file mode 100644 index 000000000..fd5431cd9 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocumentVersions-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. + +// Get document versions. +GetKnowledgeKnowledgebaseDocumentVersionsRequest.getKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId: knowledgeBaseId, documentId: documentId, before: before, after: after, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentVersionsRequest.getKnowledgeKnowledgebaseDocumentVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseDocuments-example.txt b/build/docs/getKnowledgeKnowledgebaseDocuments-example.txt new file mode 100644 index 000000000..80dad88ee --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseDocuments-example.txt @@ -0,0 +1,27 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let interval: String = "" // Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ +let documentId: [String] = [""] // Retrieves the specified documents, comma separated values expected. +let categoryId: [String] = [""] // If specified, retrieves documents associated with category ids, comma separated values expected. +let includeSubcategories: Bool = true // Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. +let includeDrafts: Bool = true // If includeDrafts is true, Documents in the draft state are also returned in the response. +let labelIds: [String] = [""] // If specified, retrieves documents associated with label ids, comma separated values expected. +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. +let externalIds: [String] = [""] // If specified, retrieves documents associated with external ids, comma separated values expected. + +// Get documents. +GetKnowledgeKnowledgebaseDocumentsRequest.getKnowledgeKnowledgebaseDocuments(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, interval: interval, documentId: documentId, categoryId: categoryId, includeSubcategories: includeSubcategories, includeDrafts: includeDrafts, labelIds: labelIds, expand: expand, externalIds: externalIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseDocumentsRequest.getKnowledgeKnowledgebaseDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseExportJob-example.txt b/build/docs/getKnowledgeKnowledgebaseExportJob-example.txt new file mode 100644 index 000000000..2901b8f75 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseExportJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let exportJobId: String = "" // Export job ID + +// Get export job report +GetKnowledgeKnowledgebaseExportJobRequest.getKnowledgeKnowledgebaseExportJob(knowledgeBaseId: knowledgeBaseId, exportJobId: exportJobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseExportJobRequest.getKnowledgeKnowledgebaseExportJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseImportJob-example.txt b/build/docs/getKnowledgeKnowledgebaseImportJob-example.txt new file mode 100644 index 000000000..4a1c30d75 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseImportJob-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let importJobId: String = "" // Import job ID +let expand: [String] = [""] // If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. + +// Get import job report +GetKnowledgeKnowledgebaseImportJobRequest.getKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseImportJobRequest.getKnowledgeKnowledgebaseImportJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLabel-example.txt b/build/docs/getKnowledgeKnowledgebaseLabel-example.txt new file mode 100644 index 000000000..7e1bc347c --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLabel-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let labelId: String = "" // Label ID + +// Get label +GetKnowledgeKnowledgebaseLabelRequest.getKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLabelRequest.getKnowledgeKnowledgebaseLabel was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLabels-example.txt b/build/docs/getKnowledgeKnowledgebaseLabels-example.txt new file mode 100644 index 000000000..13d4540ec --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLabels-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let name: String = "" // Filter to return the labels that contains the given phrase in the name. +let includeDocumentCount: Bool = true // If specified, retrieves the number of documents related to label. + +// Get labels +GetKnowledgeKnowledgebaseLabelsRequest.getKnowledgeKnowledgebaseLabels(knowledgeBaseId: knowledgeBaseId, before: before, after: after, pageSize: pageSize, name: name, includeDocumentCount: includeDocumentCount) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLabelsRequest.getKnowledgeKnowledgebaseLabels was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageCategories-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageCategories-example.txt new file mode 100644 index 000000000..724317dfd --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageCategories-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategories = GetKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategories.enummember // Language code, format: iso2-LOCALE +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let name: String = "" // Filter to return the categories that starts with the given category name. + +// Get categories +GetKnowledgeKnowledgebaseLanguageCategoriesRequest.getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageCategoriesRequest.getKnowledgeKnowledgebaseLanguageCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageCategory-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageCategory-example.txt new file mode 100644 index 000000000..9508c1903 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageCategory-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let categoryId: String = "" // Category ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategory = GetKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE + +// Get category +GetKnowledgeKnowledgebaseLanguageCategoryRequest.getKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageCategoryRequest.getKnowledgeKnowledgebaseLanguageCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageDocument-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageDocument-example.txt new file mode 100644 index 000000000..e5bc8674b --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageDocument-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocument = GetKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE + +// Get document +GetKnowledgeKnowledgebaseLanguageDocumentRequest.getKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageDocumentRequest.getKnowledgeKnowledgebaseLanguageDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageDocuments-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageDocuments-example.txt new file mode 100644 index 000000000..43566baa9 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageDocuments-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let categories: String = "" // Filter by categories ids, comma separated values expected. +let title: String = "" // Filter by document title. +let sortBy: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortBy_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortBy_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Sort by. +let sortOrder: GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortOrder_getKnowledgeKnowledgebaseLanguageDocuments = GetKnowledgeKnowledgebaseLanguageDocumentsRequest.SortOrder_getKnowledgeKnowledgebaseLanguageDocuments.enummember // Sort Order. +let documentIds: [String] = [""] // Comma-separated list of document identifiers to fetch by. + +// Get documents +GetKnowledgeKnowledgebaseLanguageDocumentsRequest.getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, categories: categories, title: title, sortBy: sortBy, sortOrder: sortOrder, documentIds: documentIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageDocumentsRequest.getKnowledgeKnowledgebaseLanguageDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt new file mode 100644 index 000000000..81ae21c93 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocumentsImport = GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE +let importId: String = "" // Import ID + +// Get import operation report +GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageDocumentsImportRequest.getKnowledgeKnowledgebaseLanguageDocumentsImport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageTraining-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageTraining-example.txt new file mode 100644 index 000000000..dca9bf7a7 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageTraining-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageTrainingRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTraining = GetKnowledgeKnowledgebaseLanguageTrainingRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTraining.enummember // Language code, format: iso2-LOCALE +let trainingId: String = "" // Training ID + +// Get training detail +GetKnowledgeKnowledgebaseLanguageTrainingRequest.getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, trainingId: trainingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageTrainingRequest.getKnowledgeKnowledgebaseLanguageTraining was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseLanguageTrainings-example.txt b/build/docs/getKnowledgeKnowledgebaseLanguageTrainings-example.txt new file mode 100644 index 000000000..2016a1dac --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseLanguageTrainings-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: GetKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTrainings = GetKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_getKnowledgeKnowledgebaseLanguageTrainings.enummember // Language code, format: iso2-LOCALE +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let knowledgeDocumentsState: GetKnowledgeKnowledgebaseLanguageTrainingsRequest.KnowledgeDocumentsState_getKnowledgeKnowledgebaseLanguageTrainings = GetKnowledgeKnowledgebaseLanguageTrainingsRequest.KnowledgeDocumentsState_getKnowledgeKnowledgebaseLanguageTrainings.enummember // Return the training with the specified state of the trained documents. + +// Get all trainings information for a knowledgebase +GetKnowledgeKnowledgebaseLanguageTrainingsRequest.getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, before: before, after: after, limit: limit, pageSize: pageSize, knowledgeDocumentsState: knowledgeDocumentsState) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseLanguageTrainingsRequest.getKnowledgeKnowledgebaseLanguageTrainings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseUnansweredGroup-example.txt b/build/docs/getKnowledgeKnowledgebaseUnansweredGroup-example.txt new file mode 100644 index 000000000..6b84f1ed4 --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseUnansweredGroup-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let groupId: String = "" // The ID of the group to be retrieved. +let app: GetKnowledgeKnowledgebaseUnansweredGroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroup = GetKnowledgeKnowledgebaseUnansweredGroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroup.enummember // The app value to be used for filtering phrases. +let dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get knowledge base unanswered group for a particular groupId +GetKnowledgeKnowledgebaseUnansweredGroupRequest.getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseUnansweredGroupRequest.getKnowledgeKnowledgebaseUnansweredGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt b/build/docs/getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt new file mode 100644 index 000000000..d46b45a5d --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let groupId: String = "" // The ID of the group to be retrieved. +let phraseGroupId: String = "" // The ID of the phraseGroup to be retrieved. +let app: GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup = GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.App_getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup.enummember // The app value to be used for filtering phrases. +let dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get knowledge base unanswered phrase group for a particular phraseGroupId +GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, phraseGroupId: phraseGroupId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebaseUnansweredGroups-example.txt b/build/docs/getKnowledgeKnowledgebaseUnansweredGroups-example.txt new file mode 100644 index 000000000..8436d1cde --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebaseUnansweredGroups-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let app: GetKnowledgeKnowledgebaseUnansweredGroupsRequest.App_getKnowledgeKnowledgebaseUnansweredGroups = GetKnowledgeKnowledgebaseUnansweredGroupsRequest.App_getKnowledgeKnowledgebaseUnansweredGroups.enummember // The app value to be used for filtering phrases. +let dateStart: Date = new Date(...) // The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let dateEnd: Date = new Date(...) // The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd + +// Get knowledge base unanswered groups +GetKnowledgeKnowledgebaseUnansweredGroupsRequest.getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId: knowledgeBaseId, app: app, dateStart: dateStart, dateEnd: dateEnd) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebaseUnansweredGroupsRequest.getKnowledgeKnowledgebaseUnansweredGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getKnowledgeKnowledgebases-example.txt b/build/docs/getKnowledgeKnowledgebases-example.txt new file mode 100644 index 000000000..cc752226e --- /dev/null +++ b/build/docs/getKnowledgeKnowledgebases-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 100. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 100. +let name: String = "" // Filter by Name. +let coreLanguage: GetKnowledgeKnowledgebasesRequest.CoreLanguage_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.CoreLanguage_getKnowledgeKnowledgebases.enummember // Filter by core language. +let published: Bool = true // Filter by published status. +let sortBy: GetKnowledgeKnowledgebasesRequest.SortBy_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.SortBy_getKnowledgeKnowledgebases.enummember // Sort by. +let sortOrder: GetKnowledgeKnowledgebasesRequest.SortOrder_getKnowledgeKnowledgebases = GetKnowledgeKnowledgebasesRequest.SortOrder_getKnowledgeKnowledgebases.enummember // Sort Order. + +// Get knowledge bases +GetKnowledgeKnowledgebasesRequest.getKnowledgeKnowledgebases(before: before, after: after, limit: limit, pageSize: pageSize, name: name, coreLanguage: coreLanguage, published: published, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetKnowledgeKnowledgebasesRequest.getKnowledgeKnowledgebases was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguage-example.txt b/build/docs/getLanguage-example.txt new file mode 100644 index 000000000..aff73b7de --- /dev/null +++ b/build/docs/getLanguage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let languageId: String = "" // Language ID + +// Get Language (Deprecated) +GetLanguageRequest.getLanguage(languageId: languageId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageRequest.getLanguage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguages-example.txt b/build/docs/getLanguages-example.txt new file mode 100644 index 000000000..70c76ddcc --- /dev/null +++ b/build/docs/getLanguages-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetLanguagesRequest.SortOrder_getLanguages = GetLanguagesRequest.SortOrder_getLanguages.enummember // Ascending or descending sort order +let name: String = "" // Name + +// Get the list of supported languages. (Deprecated) +GetLanguagesRequest.getLanguages(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguagesRequest.getLanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguagesTranslations-example.txt b/build/docs/getLanguagesTranslations-example.txt new file mode 100644 index 000000000..68ebf4546 --- /dev/null +++ b/build/docs/getLanguagesTranslations-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get all available languages for translation +GetLanguagesTranslationsRequest.getLanguagesTranslations() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguagesTranslationsRequest.getLanguagesTranslations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguagesTranslationsBuiltin-example.txt b/build/docs/getLanguagesTranslationsBuiltin-example.txt new file mode 100644 index 000000000..92ec7d1e5 --- /dev/null +++ b/build/docs/getLanguagesTranslationsBuiltin-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let language: String = "" // The language of the builtin translation to retrieve + +// Get the builtin translation for a language +GetLanguagesTranslationsBuiltinRequest.getLanguagesTranslationsBuiltin(language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguagesTranslationsBuiltinRequest.getLanguagesTranslationsBuiltin was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguagesTranslationsOrganization-example.txt b/build/docs/getLanguagesTranslationsOrganization-example.txt new file mode 100644 index 000000000..a246ff85c --- /dev/null +++ b/build/docs/getLanguagesTranslationsOrganization-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let language: String = "" // The language of the translation to retrieve for the organization + +// Get effective translation for an organization by language +GetLanguagesTranslationsOrganizationRequest.getLanguagesTranslationsOrganization(language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguagesTranslationsOrganizationRequest.getLanguagesTranslationsOrganization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguagesTranslationsUser-example.txt b/build/docs/getLanguagesTranslationsUser-example.txt new file mode 100644 index 000000000..d01ac30f4 --- /dev/null +++ b/build/docs/getLanguagesTranslationsUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The user id + +// Get effective language translation for a user +GetLanguagesTranslationsUserRequest.getLanguagesTranslationsUser(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguagesTranslationsUserRequest.getLanguagesTranslationsUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomain-example.txt b/build/docs/getLanguageunderstandingDomain-example.txt new file mode 100644 index 000000000..24d7907c2 --- /dev/null +++ b/build/docs/getLanguageunderstandingDomain-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. + +// Find an NLU Domain. +GetLanguageunderstandingDomainRequest.getLanguageunderstandingDomain(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainRequest.getLanguageunderstandingDomain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomainFeedback-example.txt b/build/docs/getLanguageunderstandingDomainFeedback-example.txt new file mode 100644 index 000000000..ea8d963bf --- /dev/null +++ b/build/docs/getLanguageunderstandingDomainFeedback-example.txt @@ -0,0 +1,28 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let intentName: String = "" // The top intent name to retrieve feedback for. +let assessment: GetLanguageunderstandingDomainFeedbackRequest.Assessment_getLanguageunderstandingDomainFeedback = GetLanguageunderstandingDomainFeedbackRequest.Assessment_getLanguageunderstandingDomainFeedback.enummember // The top assessment to retrieve feedback for. +let dateStart: Date = new Date(...) // Begin of time window as ISO-8601 date. +let dateEnd: Date = new Date(...) // End of time window as ISO-8601 date. +let includeDeleted: Bool = true // Whether to include soft-deleted items in the result. +let language: String = "" // Whether to filter response based on the language, e.g. en-us, pt-br. +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let enableCursorPagination: Bool = true // Enable Cursor Pagination +let includeTrainingUtterances: Bool = true // Include Training Utterances. By default they're included. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true +let fields: [String] = [""] // Fields and properties to get, comma-separated + +// Get all feedback in the given NLU Domain Version. +GetLanguageunderstandingDomainFeedbackRequest.getLanguageunderstandingDomainFeedback(domainId: domainId, intentName: intentName, assessment: assessment, dateStart: dateStart, dateEnd: dateEnd, includeDeleted: includeDeleted, language: language, pageNumber: pageNumber, pageSize: pageSize, enableCursorPagination: enableCursorPagination, includeTrainingUtterances: includeTrainingUtterances, after: after, fields: fields) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainFeedbackRequest.getLanguageunderstandingDomainFeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomainFeedbackFeedbackId-example.txt b/build/docs/getLanguageunderstandingDomainFeedbackFeedbackId-example.txt new file mode 100644 index 000000000..72ed0c32f --- /dev/null +++ b/build/docs/getLanguageunderstandingDomainFeedbackFeedbackId-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let feedbackId: String = "" // ID of the Feedback +let fields: [String] = [""] // Fields and properties to get, comma-separated + +// Find a Feedback +GetLanguageunderstandingDomainFeedbackFeedbackIdRequest.getLanguageunderstandingDomainFeedbackFeedbackId(domainId: domainId, feedbackId: feedbackId, fields: fields) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainFeedbackFeedbackIdRequest.getLanguageunderstandingDomainFeedbackFeedbackId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomainVersion-example.txt b/build/docs/getLanguageunderstandingDomainVersion-example.txt new file mode 100644 index 000000000..560a630c3 --- /dev/null +++ b/build/docs/getLanguageunderstandingDomainVersion-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. +let includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response. + +// Find an NLU Domain Version. +GetLanguageunderstandingDomainVersionRequest.getLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId, includeUtterances: includeUtterances) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainVersionRequest.getLanguageunderstandingDomainVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomainVersionReport-example.txt b/build/docs/getLanguageunderstandingDomainVersionReport-example.txt new file mode 100644 index 000000000..69fbc2d35 --- /dev/null +++ b/build/docs/getLanguageunderstandingDomainVersionReport-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. + +// Retrieved quality report for the specified NLU Domain Version +GetLanguageunderstandingDomainVersionReportRequest.getLanguageunderstandingDomainVersionReport(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainVersionReportRequest.getLanguageunderstandingDomainVersionReport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomainVersions-example.txt b/build/docs/getLanguageunderstandingDomainVersions-example.txt new file mode 100644 index 000000000..80fcc63ec --- /dev/null +++ b/build/docs/getLanguageunderstandingDomainVersions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response. +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get all NLU Domain Versions for a given Domain. +GetLanguageunderstandingDomainVersionsRequest.getLanguageunderstandingDomainVersions(domainId: domainId, includeUtterances: includeUtterances, pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainVersionsRequest.getLanguageunderstandingDomainVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingDomains-example.txt b/build/docs/getLanguageunderstandingDomains-example.txt new file mode 100644 index 000000000..d08705db4 --- /dev/null +++ b/build/docs/getLanguageunderstandingDomains-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size + +// Get all NLU Domains. +GetLanguageunderstandingDomainsRequest.getLanguageunderstandingDomains(pageNumber: pageNumber, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingDomainsRequest.getLanguageunderstandingDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMiner-example.txt b/build/docs/getLanguageunderstandingMiner-example.txt new file mode 100644 index 000000000..247c1acdb --- /dev/null +++ b/build/docs/getLanguageunderstandingMiner-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID + +// Get information about a miner. +GetLanguageunderstandingMinerRequest.getLanguageunderstandingMiner(minerId: minerId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerRequest.getLanguageunderstandingMiner was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerDraft-example.txt b/build/docs/getLanguageunderstandingMinerDraft-example.txt new file mode 100644 index 000000000..2d28345e9 --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerDraft-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let draftId: String = "" // Draft ID +let draftIntentId: String = "" // Parameter to filter a specific intent. +let draftTopicId: String = "" // Parameter to filter a specific topic. + +// Get information about a draft. +GetLanguageunderstandingMinerDraftRequest.getLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId, draftIntentId: draftIntentId, draftTopicId: draftTopicId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerDraftRequest.getLanguageunderstandingMinerDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerDrafts-example.txt b/build/docs/getLanguageunderstandingMinerDrafts-example.txt new file mode 100644 index 000000000..d92cc9e44 --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerDrafts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID + +// Retrieve the list of drafts created. +GetLanguageunderstandingMinerDraftsRequest.getLanguageunderstandingMinerDrafts(minerId: minerId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerDraftsRequest.getLanguageunderstandingMinerDrafts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerIntent-example.txt b/build/docs/getLanguageunderstandingMinerIntent-example.txt new file mode 100644 index 000000000..ad578b743 --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerIntent-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let intentId: String = "" // The ID of the intent to be retrieved. +let expand: GetLanguageunderstandingMinerIntentRequest.Expand_getLanguageunderstandingMinerIntent = GetLanguageunderstandingMinerIntentRequest.Expand_getLanguageunderstandingMinerIntent.enummember // Option to fetch utterances + +// Get information about a mined intent +GetLanguageunderstandingMinerIntentRequest.getLanguageunderstandingMinerIntent(minerId: minerId, intentId: intentId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerIntentRequest.getLanguageunderstandingMinerIntent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerIntents-example.txt b/build/docs/getLanguageunderstandingMinerIntents-example.txt new file mode 100644 index 000000000..f116ea67f --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerIntents-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let expand: GetLanguageunderstandingMinerIntentsRequest.Expand_getLanguageunderstandingMinerIntents = GetLanguageunderstandingMinerIntentsRequest.Expand_getLanguageunderstandingMinerIntents.enummember // Option to fetch utterances. + +// Retrieve a list of mined intents. +GetLanguageunderstandingMinerIntentsRequest.getLanguageunderstandingMinerIntents(minerId: minerId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerIntentsRequest.getLanguageunderstandingMinerIntents was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerTopic-example.txt b/build/docs/getLanguageunderstandingMinerTopic-example.txt new file mode 100644 index 000000000..bf152c659 --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerTopic-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let topicId: String = "" // The ID of the topic to be retrieved. +let expand: GetLanguageunderstandingMinerTopicRequest.Expand_getLanguageunderstandingMinerTopic = GetLanguageunderstandingMinerTopicRequest.Expand_getLanguageunderstandingMinerTopic.enummember // Option to fetch phrases + +// Retrieves details of a particular topic. +GetLanguageunderstandingMinerTopicRequest.getLanguageunderstandingMinerTopic(minerId: minerId, topicId: topicId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerTopicRequest.getLanguageunderstandingMinerTopic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerTopicPhrase-example.txt b/build/docs/getLanguageunderstandingMinerTopicPhrase-example.txt new file mode 100644 index 000000000..ef411036e --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerTopicPhrase-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let topicId: String = "" // The ID of the topic to be retrieved. +let phraseId: String = "" // The ID of the phrase to be retrieved. + +// Retrieves utterances related to a phrase in a topic. +GetLanguageunderstandingMinerTopicPhraseRequest.getLanguageunderstandingMinerTopicPhrase(minerId: minerId, topicId: topicId, phraseId: phraseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerTopicPhraseRequest.getLanguageunderstandingMinerTopicPhrase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMinerTopics-example.txt b/build/docs/getLanguageunderstandingMinerTopics-example.txt new file mode 100644 index 000000000..e4d607fce --- /dev/null +++ b/build/docs/getLanguageunderstandingMinerTopics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID + +// Retrieve a list of mined topics. +GetLanguageunderstandingMinerTopicsRequest.getLanguageunderstandingMinerTopics(minerId: minerId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinerTopicsRequest.getLanguageunderstandingMinerTopics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLanguageunderstandingMiners-example.txt b/build/docs/getLanguageunderstandingMiners-example.txt new file mode 100644 index 000000000..bd6512a15 --- /dev/null +++ b/build/docs/getLanguageunderstandingMiners-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerType: String = "" // Type of miner, either intent or topic + +// Retrieve the list of miners created. +GetLanguageunderstandingMinersRequest.getLanguageunderstandingMiners(minerType: minerType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLanguageunderstandingMinersRequest.getLanguageunderstandingMiners was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningAssignment-example.txt b/build/docs/getLearningAssignment-example.txt new file mode 100644 index 000000000..6e0836b83 --- /dev/null +++ b/build/docs/getLearningAssignment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The ID of Learning Assignment +let expand: [String] = [""] // Fields to expand in response + +// Get Learning Assignment +GetLearningAssignmentRequest.getLearningAssignment(assignmentId: assignmentId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningAssignmentRequest.getLearningAssignment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningAssignments-example.txt b/build/docs/getLearningAssignments-example.txt new file mode 100644 index 000000000..ffe88c010 --- /dev/null +++ b/build/docs/getLearningAssignments-example.txt @@ -0,0 +1,30 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // Specifies the ID of the learning module. Fetch assignments for learning module ID +let interval: String = "" // Specifies the range of dueDates 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 +let completionInterval: String = "" // 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 +let overdue: GetLearningAssignmentsRequest.Overdue_getLearningAssignments = GetLearningAssignmentsRequest.Overdue_getLearningAssignments.enummember // Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let pass: GetLearningAssignmentsRequest.Pass_getLearningAssignments = GetLearningAssignmentsRequest.Pass_getLearningAssignments.enummember // Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned +let minPercentageScore: Float = 0 // The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) +let maxPercentageScore: Float = 0 // The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) +let sortOrder: GetLearningAssignmentsRequest.SortOrder_getLearningAssignments = GetLearningAssignmentsRequest.SortOrder_getLearningAssignments.enummember // Specifies result set sort order; if not specified, default sort order is descending (Desc) +let sortBy: GetLearningAssignmentsRequest.SortBy_getLearningAssignments = GetLearningAssignmentsRequest.SortBy_getLearningAssignments.enummember // Specifies which field to sort the results by, default sort is by recommendedCompletionDate +let userId: [String] = [""] // Specifies the list of user IDs to be queried, up to 100 user IDs. +let types: [String] = [""] // Specifies the module types to filter by +let states: [String] = [""] // Specifies the assignment states to filter by +let expand: [String] = [""] // Specifies the expand option for returning additional information + +// List of Learning module Assignments +GetLearningAssignmentsRequest.getLearningAssignments(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pageSize: pageSize, pageNumber: pageNumber, pass: pass, minPercentageScore: minPercentageScore, maxPercentageScore: maxPercentageScore, sortOrder: sortOrder, sortBy: sortBy, userId: userId, types: types, states: states, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningAssignmentsRequest.getLearningAssignments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningAssignmentsMe-example.txt b/build/docs/getLearningAssignmentsMe-example.txt new file mode 100644 index 000000000..76b08eaca --- /dev/null +++ b/build/docs/getLearningAssignmentsMe-example.txt @@ -0,0 +1,29 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // Specifies the ID of the learning module. Fetch assignments for learning module ID +let interval: String = "" // Specifies the range of dueDates 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 +let completionInterval: String = "" // 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 +let overdue: GetLearningAssignmentsMeRequest.Overdue_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.Overdue_getLearningAssignmentsMe.enummember // Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let pass: GetLearningAssignmentsMeRequest.Pass_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.Pass_getLearningAssignmentsMe.enummember // Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned +let minPercentageScore: Float = 0 // The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) +let maxPercentageScore: Float = 0 // The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) +let sortOrder: GetLearningAssignmentsMeRequest.SortOrder_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.SortOrder_getLearningAssignmentsMe.enummember // Specifies result set sort order; if not specified, default sort order is descending (Desc) +let sortBy: GetLearningAssignmentsMeRequest.SortBy_getLearningAssignmentsMe = GetLearningAssignmentsMeRequest.SortBy_getLearningAssignmentsMe.enummember // Specifies which field to sort the results by, default sort is by recommendedCompletionDate +let types: [String] = [""] // Specifies the module types to filter by +let states: [String] = [""] // Specifies the assignment states to filter by +let expand: [String] = [""] // Specifies the expand option for returning additional information + +// List of Learning Assignments assigned to current user +GetLearningAssignmentsMeRequest.getLearningAssignmentsMe(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pageSize: pageSize, pageNumber: pageNumber, pass: pass, minPercentageScore: minPercentageScore, maxPercentageScore: maxPercentageScore, sortOrder: sortOrder, sortBy: sortBy, types: types, states: states, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningAssignmentsMeRequest.getLearningAssignmentsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModule-example.txt b/build/docs/getLearningModule-example.txt new file mode 100644 index 000000000..294abe3b0 --- /dev/null +++ b/build/docs/getLearningModule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let expand: [String] = [""] // Fields to expand in response(case insensitive) + +// Get a learning module +GetLearningModuleRequest.getLearningModule(moduleId: moduleId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModuleRequest.getLearningModule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModuleJob-example.txt b/build/docs/getLearningModuleJob-example.txt new file mode 100644 index 000000000..5ee47bfaf --- /dev/null +++ b/build/docs/getLearningModuleJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let jobId: String = "" // The ID of the learning module job + +// Get a specific Learning Module job status +GetLearningModuleJobRequest.getLearningModuleJob(moduleId: moduleId, jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModuleJobRequest.getLearningModuleJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModuleRule-example.txt b/build/docs/getLearningModuleRule-example.txt new file mode 100644 index 000000000..662f7125a --- /dev/null +++ b/build/docs/getLearningModuleRule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module + +// Get a learning module rule +GetLearningModuleRuleRequest.getLearningModuleRule(moduleId: moduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModuleRuleRequest.getLearningModuleRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModuleVersion-example.txt b/build/docs/getLearningModuleVersion-example.txt new file mode 100644 index 000000000..b4246fce3 --- /dev/null +++ b/build/docs/getLearningModuleVersion-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let versionId: String = "" // The version of learning module +let expand: [String] = [""] // Fields to expand in response(case insensitive) + +// Get specific version of a published module +GetLearningModuleVersionRequest.getLearningModuleVersion(moduleId: moduleId, versionId: versionId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModuleVersionRequest.getLearningModuleVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModules-example.txt b/build/docs/getLearningModules-example.txt new file mode 100644 index 000000000..b6b18c21d --- /dev/null +++ b/build/docs/getLearningModules-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let isArchived: Bool = true // Archive status +let types: [String] = [""] // Specifies the module types. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetLearningModulesRequest.SortOrder_getLearningModules = GetLearningModulesRequest.SortOrder_getLearningModules.enummember // Sort order +let sortBy: GetLearningModulesRequest.SortBy_getLearningModules = GetLearningModulesRequest.SortBy_getLearningModules.enummember // Sort by +let searchTerm: String = "" // Search Term (searchable by name) +let expand: [String] = [""] // Fields to expand in response(case insensitive) +let isPublished: GetLearningModulesRequest.IsPublished_getLearningModules = GetLearningModulesRequest.IsPublished_getLearningModules.enummember // Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned +let statuses: [String] = [""] // Specifies the module statuses to filter by + +// Get all learning modules of an organization +GetLearningModulesRequest.getLearningModules(isArchived: isArchived, types: types, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, sortBy: sortBy, searchTerm: searchTerm, expand: expand, isPublished: isPublished, statuses: statuses) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModulesRequest.getLearningModules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModulesAssignments-example.txt b/build/docs/getLearningModulesAssignments-example.txt new file mode 100644 index 000000000..d60ce6148 --- /dev/null +++ b/build/docs/getLearningModulesAssignments-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userIds: [String] = [""] // The IDs of the users to include +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let searchTerm: String = "" // Search Term (searches by name and description) +let overdue: GetLearningModulesAssignmentsRequest.Overdue_getLearningModulesAssignments = GetLearningModulesAssignmentsRequest.Overdue_getLearningModulesAssignments.enummember // Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned. +let assignmentStates: [String] = [""] // Specifies the assignment states to return. +let expand: [String] = [""] // Fields to expand in response(case insensitive) + +// Get all learning modules of an organization including assignments for a specific user +GetLearningModulesAssignmentsRequest.getLearningModulesAssignments(userIds: userIds, pageSize: pageSize, pageNumber: pageNumber, searchTerm: searchTerm, overdue: overdue, assignmentStates: assignmentStates, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModulesAssignmentsRequest.getLearningModulesAssignments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLearningModulesCoverartCoverArtId-example.txt b/build/docs/getLearningModulesCoverartCoverArtId-example.txt new file mode 100644 index 000000000..f9e7200e6 --- /dev/null +++ b/build/docs/getLearningModulesCoverartCoverArtId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let coverArtId: String = "" // Key identifier for the cover art + +// Get a specific Learning Module cover art using ID +GetLearningModulesCoverartCoverArtIdRequest.getLearningModulesCoverartCoverArtId(coverArtId: coverArtId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLearningModulesCoverartCoverArtIdRequest.getLearningModulesCoverartCoverArtId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLicenseDefinition-example.txt b/build/docs/getLicenseDefinition-example.txt new file mode 100644 index 000000000..8f402e732 --- /dev/null +++ b/build/docs/getLicenseDefinition-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let licenseId: String = "" // ID + +// Get PureCloud license definition. +GetLicenseDefinitionRequest.getLicenseDefinition(licenseId: licenseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLicenseDefinitionRequest.getLicenseDefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLicenseDefinitions-example.txt b/build/docs/getLicenseDefinitions-example.txt new file mode 100644 index 000000000..4f724fdcf --- /dev/null +++ b/build/docs/getLicenseDefinitions-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get all PureCloud license definitions available for the organization. +GetLicenseDefinitionsRequest.getLicenseDefinitions() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLicenseDefinitionsRequest.getLicenseDefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLicenseToggle-example.txt b/build/docs/getLicenseToggle-example.txt new file mode 100644 index 000000000..f2c38c2cf --- /dev/null +++ b/build/docs/getLicenseToggle-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let featureName: String = "" // featureName + +// Deprecated - no alternative required. This operation will always return 'true' for requested toggles +GetLicenseToggleRequest.getLicenseToggle(featureName: featureName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLicenseToggleRequest.getLicenseToggle was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLicenseUser-example.txt b/build/docs/getLicenseUser-example.txt new file mode 100644 index 000000000..a9d8f4ce1 --- /dev/null +++ b/build/docs/getLicenseUser-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // ID + +// Get licenses for specified user. +GetLicenseUserRequest.getLicenseUser(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLicenseUserRequest.getLicenseUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLicenseUsers-example.txt b/build/docs/getLicenseUsers-example.txt new file mode 100644 index 000000000..205af357b --- /dev/null +++ b/build/docs/getLicenseUsers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a page of users and their licenses +GetLicenseUsersRequest.getLicenseUsers(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLicenseUsersRequest.getLicenseUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLocation-example.txt b/build/docs/getLocation-example.txt new file mode 100644 index 000000000..4b148408b --- /dev/null +++ b/build/docs/getLocation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let locationId: String = "" // Location ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get Location by ID. +GetLocationRequest.getLocation(locationId: locationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLocationRequest.getLocation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLocationSublocations-example.txt b/build/docs/getLocationSublocations-example.txt new file mode 100644 index 000000000..57db0a58a --- /dev/null +++ b/build/docs/getLocationSublocations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let locationId: String = "" // Location ID + +// Get sublocations for location ID. +GetLocationSublocationsRequest.getLocationSublocations(locationId: locationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLocationSublocationsRequest.getLocationSublocations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLocations-example.txt b/build/docs/getLocations-example.txt new file mode 100644 index 000000000..bca44bd0f --- /dev/null +++ b/build/docs/getLocations-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // id +let sortOrder: GetLocationsRequest.SortOrder_getLocations = GetLocationsRequest.SortOrder_getLocations.enummember // Sort order + +// Get a list of all locations. +GetLocationsRequest.getLocations(pageSize: pageSize, pageNumber: pageNumber, _id: _id, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLocationsRequest.getLocations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getLocationsSearch-example.txt b/build/docs/getLocationsSearch-example.txt new file mode 100644 index 000000000..2d7643162 --- /dev/null +++ b/build/docs/getLocationsSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // Provides more details about a specified resource + +// Search locations using the q64 value returned from a previous search +GetLocationsSearchRequest.getLocationsSearch(q64: q64, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetLocationsSearchRequest.getLocationsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMessagingSetting-example.txt b/build/docs/getMessagingSetting-example.txt new file mode 100644 index 000000000..0a7c7d667 --- /dev/null +++ b/build/docs/getMessagingSetting-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Settings ID + +// Get a messaging setting +GetMessagingSettingRequest.getMessagingSetting(messageSettingId: messageSettingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMessagingSettingRequest.getMessagingSetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMessagingSettings-example.txt b/build/docs/getMessagingSettings-example.txt new file mode 100644 index 000000000..a73535a10 --- /dev/null +++ b/build/docs/getMessagingSettings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of messaging settings +GetMessagingSettingsRequest.getMessagingSettings(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMessagingSettingsRequest.getMessagingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMessagingSettingsDefault-example.txt b/build/docs/getMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..ea757d9db --- /dev/null +++ b/build/docs/getMessagingSettingsDefault-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the organization's default settings that will be used as the default when creating an integration. +GetMessagingSettingsDefaultRequest.getMessagingSettingsDefault() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMessagingSettingsDefaultRequest.getMessagingSettingsDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMessagingSupportedcontent-example.txt b/build/docs/getMessagingSupportedcontent-example.txt new file mode 100644 index 000000000..0e19f8e35 --- /dev/null +++ b/build/docs/getMessagingSupportedcontent-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of Supported Content profiles +GetMessagingSupportedcontentRequest.getMessagingSupportedcontent(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMessagingSupportedcontentRequest.getMessagingSupportedcontent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/getMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..8192b2fc5 --- /dev/null +++ b/build/docs/getMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID + +// Get a supported content profile +GetMessagingSupportedcontentSupportedContentIdRequest.getMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMessagingSupportedcontentSupportedContentIdRequest.getMessagingSupportedcontentSupportedContentId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMobiledevice-example.txt b/build/docs/getMobiledevice-example.txt new file mode 100644 index 000000000..282436e87 --- /dev/null +++ b/build/docs/getMobiledevice-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deviceId: String = "" // Device ID + +// Get device +GetMobiledeviceRequest.getMobiledevice(deviceId: deviceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMobiledeviceRequest.getMobiledevice was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getMobiledevices-example.txt b/build/docs/getMobiledevices-example.txt new file mode 100644 index 000000000..2b44d3f9e --- /dev/null +++ b/build/docs/getMobiledevices-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetMobiledevicesRequest.SortOrder_getMobiledevices = GetMobiledevicesRequest.SortOrder_getMobiledevices.enummember // Ascending or descending sort order + +// Get a list of all devices. +GetMobiledevicesRequest.getMobiledevices(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetMobiledevicesRequest.getMobiledevices was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getNotificationsAvailabletopics-example.txt b/build/docs/getNotificationsAvailabletopics-example.txt new file mode 100644 index 000000000..1f5308e82 --- /dev/null +++ b/build/docs/getNotificationsAvailabletopics-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: [String] = [""] // Which fields, if any, to expand +let includePreview: Bool = true // Whether or not to include Preview topics + +// Get available notification topics. +GetNotificationsAvailabletopicsRequest.getNotificationsAvailabletopics(expand: expand, includePreview: includePreview) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetNotificationsAvailabletopicsRequest.getNotificationsAvailabletopics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getNotificationsChannelSubscriptions-example.txt b/build/docs/getNotificationsChannelSubscriptions-example.txt new file mode 100644 index 000000000..2dc85cdf1 --- /dev/null +++ b/build/docs/getNotificationsChannelSubscriptions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let channelId: String = "" // Channel ID + +// The list of all subscriptions for this channel +GetNotificationsChannelSubscriptionsRequest.getNotificationsChannelSubscriptions(channelId: channelId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetNotificationsChannelSubscriptionsRequest.getNotificationsChannelSubscriptions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getNotificationsChannels-example.txt b/build/docs/getNotificationsChannels-example.txt new file mode 100644 index 000000000..badfb3830 --- /dev/null +++ b/build/docs/getNotificationsChannels-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let includechannels: GetNotificationsChannelsRequest.Includechannels_getNotificationsChannels = GetNotificationsChannelsRequest.Includechannels_getNotificationsChannels.enummember // 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. + +// The list of existing channels +GetNotificationsChannelsRequest.getNotificationsChannels(includechannels: includechannels) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetNotificationsChannelsRequest.getNotificationsChannels was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthAuthorization-example.txt b/build/docs/getOauthAuthorization-example.txt new file mode 100644 index 000000000..a4f3e66e8 --- /dev/null +++ b/build/docs/getOauthAuthorization-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // The ID of client +let acceptLanguage: String = "" // The language in which to display the client descriptions. + +// Get a client that is authorized by the resource owner +GetOauthAuthorizationRequest.getOauthAuthorization(clientId: clientId, acceptLanguage: acceptLanguage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthAuthorizationRequest.getOauthAuthorization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthAuthorizations-example.txt b/build/docs/getOauthAuthorizations-example.txt new file mode 100644 index 000000000..892e3f2f2 --- /dev/null +++ b/build/docs/getOauthAuthorizations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let acceptLanguage: String = "" // The language in which to display the client descriptions. + +// List clients that have been authorized, requested, or revoked by the resource owner +GetOauthAuthorizationsRequest.getOauthAuthorizations(acceptLanguage: acceptLanguage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthAuthorizationsRequest.getOauthAuthorizations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthClient-example.txt b/build/docs/getOauthClient-example.txt new file mode 100644 index 000000000..93537909e --- /dev/null +++ b/build/docs/getOauthClient-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID + +// Get OAuth Client +GetOauthClientRequest.getOauthClient(clientId: clientId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthClientRequest.getOauthClient was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthClientUsageQueryResult-example.txt b/build/docs/getOauthClientUsageQueryResult-example.txt new file mode 100644 index 000000000..fe213530c --- /dev/null +++ b/build/docs/getOauthClientUsageQueryResult-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let executionId: String = "" // ID of the query execution +let clientId: String = "" // Client ID + +// Get the results of a usage query +GetOauthClientUsageQueryResultRequest.getOauthClientUsageQueryResult(executionId: executionId, clientId: clientId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthClientUsageQueryResultRequest.getOauthClientUsageQueryResult was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthClientUsageSummary-example.txt b/build/docs/getOauthClientUsageSummary-example.txt new file mode 100644 index 000000000..d6105bb1a --- /dev/null +++ b/build/docs/getOauthClientUsageSummary-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID +let days: String = "" // Previous number of days to query + +// Get a summary of OAuth client API usage +GetOauthClientUsageSummaryRequest.getOauthClientUsageSummary(clientId: clientId, days: days) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthClientUsageSummaryRequest.getOauthClientUsageSummary was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthClients-example.txt b/build/docs/getOauthClients-example.txt new file mode 100644 index 000000000..5317e29fa --- /dev/null +++ b/build/docs/getOauthClients-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// The list of OAuth clients +GetOauthClientsRequest.getOauthClients() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthClientsRequest.getOauthClients was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthScope-example.txt b/build/docs/getOauthScope-example.txt new file mode 100644 index 000000000..546e903a5 --- /dev/null +++ b/build/docs/getOauthScope-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scopeId: String = "" // Scope ID +let acceptLanguage: String = "" // The language with which to display the scope description. + +// An OAuth scope +GetOauthScopeRequest.getOauthScope(scopeId: scopeId, acceptLanguage: acceptLanguage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthScopeRequest.getOauthScope was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOauthScopes-example.txt b/build/docs/getOauthScopes-example.txt new file mode 100644 index 000000000..7c2716ca5 --- /dev/null +++ b/build/docs/getOauthScopes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let acceptLanguage: String = "" // The language with which to display the scope descriptions. + +// The list of OAuth scopes +GetOauthScopesRequest.getOauthScopes(acceptLanguage: acceptLanguage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOauthScopesRequest.getOauthScopes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsAuthenticationSettings-example.txt b/build/docs/getOrganizationsAuthenticationSettings-example.txt new file mode 100644 index 000000000..3b83c3aa9 --- /dev/null +++ b/build/docs/getOrganizationsAuthenticationSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Gets the organization's settings +GetOrganizationsAuthenticationSettingsRequest.getOrganizationsAuthenticationSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsAuthenticationSettingsRequest.getOrganizationsAuthenticationSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsEmbeddedintegration-example.txt b/build/docs/getOrganizationsEmbeddedintegration-example.txt new file mode 100644 index 000000000..5f4afb36c --- /dev/null +++ b/build/docs/getOrganizationsEmbeddedintegration-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of domains that will be allowed to embed PureCloud applications +GetOrganizationsEmbeddedintegrationRequest.getOrganizationsEmbeddedintegration() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsEmbeddedintegrationRequest.getOrganizationsEmbeddedintegration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsIpaddressauthentication-example.txt b/build/docs/getOrganizationsIpaddressauthentication-example.txt new file mode 100644 index 000000000..907d99aa0 --- /dev/null +++ b/build/docs/getOrganizationsIpaddressauthentication-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get organization IP address whitelist settings +GetOrganizationsIpaddressauthenticationRequest.getOrganizationsIpaddressauthentication() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsIpaddressauthenticationRequest.getOrganizationsIpaddressauthentication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsChangerequest-example.txt b/build/docs/getOrganizationsLimitsChangerequest-example.txt new file mode 100644 index 000000000..b982d10cd --- /dev/null +++ b/build/docs/getOrganizationsLimitsChangerequest-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let requestId: String = "" // Unique id for the limit change request + +// Get a limit change request +GetOrganizationsLimitsChangerequestRequest.getOrganizationsLimitsChangerequest(requestId: requestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsChangerequestRequest.getOrganizationsLimitsChangerequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsChangerequests-example.txt b/build/docs/getOrganizationsLimitsChangerequests-example.txt new file mode 100644 index 000000000..913c5507a --- /dev/null +++ b/build/docs/getOrganizationsLimitsChangerequests-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let after: Int64 = 0 // Timestamp indicating the date to begin after when searching for requests. +let before: Int64 = 0 // Timestamp indicating the date to end before when searching for requests. +let status: GetOrganizationsLimitsChangerequestsRequest.Status_getOrganizationsLimitsChangerequests = GetOrganizationsLimitsChangerequestsRequest.Status_getOrganizationsLimitsChangerequests.enummember // Status of the request to be filtered by +let pageSize: Int = 0 // Page Size +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get the available limit change requests +GetOrganizationsLimitsChangerequestsRequest.getOrganizationsLimitsChangerequests(after: after, before: before, status: status, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsChangerequestsRequest.getOrganizationsLimitsChangerequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsDocs-example.txt b/build/docs/getOrganizationsLimitsDocs-example.txt new file mode 100644 index 000000000..8c7f14011 --- /dev/null +++ b/build/docs/getOrganizationsLimitsDocs-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a link to the limit documentation +GetOrganizationsLimitsDocsRequest.getOrganizationsLimitsDocs() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsDocsRequest.getOrganizationsLimitsDocs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsNamespace-example.txt b/build/docs/getOrganizationsLimitsNamespace-example.txt new file mode 100644 index 000000000..017468f90 --- /dev/null +++ b/build/docs/getOrganizationsLimitsNamespace-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let namespaceName: String = "" // The namespace to fetch limits for + +// Get the effective limits in a namespace for an organization +GetOrganizationsLimitsNamespaceRequest.getOrganizationsLimitsNamespace(namespaceName: namespaceName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsNamespaceRequest.getOrganizationsLimitsNamespace was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsNamespaceDefaults-example.txt b/build/docs/getOrganizationsLimitsNamespaceDefaults-example.txt new file mode 100644 index 000000000..f8cc509cf --- /dev/null +++ b/build/docs/getOrganizationsLimitsNamespaceDefaults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let namespaceName: String = "" // The namespace to fetch defaults limits for + +// Get the default limits in a namespace for an organization +GetOrganizationsLimitsNamespaceDefaultsRequest.getOrganizationsLimitsNamespaceDefaults(namespaceName: namespaceName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsNamespaceDefaultsRequest.getOrganizationsLimitsNamespaceDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsLimitsNamespaces-example.txt b/build/docs/getOrganizationsLimitsNamespaces-example.txt new file mode 100644 index 000000000..9326be38a --- /dev/null +++ b/build/docs/getOrganizationsLimitsNamespaces-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get the available limit namespaces +GetOrganizationsLimitsNamespacesRequest.getOrganizationsLimitsNamespaces(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsLimitsNamespacesRequest.getOrganizationsLimitsNamespaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsMe-example.txt b/build/docs/getOrganizationsMe-example.txt new file mode 100644 index 000000000..eb16f4f99 --- /dev/null +++ b/build/docs/getOrganizationsMe-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get organization. +GetOrganizationsMeRequest.getOrganizationsMe() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsMeRequest.getOrganizationsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrganizationsWhitelist-example.txt b/build/docs/getOrganizationsWhitelist-example.txt new file mode 100644 index 000000000..a1ae37562 --- /dev/null +++ b/build/docs/getOrganizationsWhitelist-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// This route is deprecated, please use /api/v2/organizations/authentication/settings instead +GetOrganizationsWhitelistRequest.getOrganizationsWhitelist() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrganizationsWhitelistRequest.getOrganizationsWhitelist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationPairing-example.txt b/build/docs/getOrgauthorizationPairing-example.txt new file mode 100644 index 000000000..20b7f9cb7 --- /dev/null +++ b/build/docs/getOrgauthorizationPairing-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pairingId: String = "" // Pairing Id + +// Get Pairing Info +GetOrgauthorizationPairingRequest.getOrgauthorizationPairing(pairingId: pairingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationPairingRequest.getOrgauthorizationPairing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustee-example.txt b/build/docs/getOrgauthorizationTrustee-example.txt new file mode 100644 index 000000000..bf5ed52e1 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustee-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id + +// Get Org Trust +GetOrgauthorizationTrusteeRequest.getOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeRequest.getOrgauthorizationTrustee was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeClonedusers-example.txt b/build/docs/getOrgauthorizationTrusteeClonedusers-example.txt new file mode 100644 index 000000000..51c3bbeef --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeClonedusers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id + +// The list of cloned users from the trustee organization (i.e. users with a native user record). +GetOrgauthorizationTrusteeClonedusersRequest.getOrgauthorizationTrusteeClonedusers(trusteeOrgId: trusteeOrgId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeClonedusersRequest.getOrgauthorizationTrusteeClonedusers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeGroup-example.txt b/build/docs/getOrgauthorizationTrusteeGroup-example.txt new file mode 100644 index 000000000..0deb32c1f --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeGroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id + +// Get Trustee Group +GetOrgauthorizationTrusteeGroupRequest.getOrgauthorizationTrusteeGroup(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeGroupRequest.getOrgauthorizationTrusteeGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeGroupRoles-example.txt b/build/docs/getOrgauthorizationTrusteeGroupRoles-example.txt new file mode 100644 index 000000000..cf6151c31 --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeGroupRoles-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id + +// Get Trustee Group Roles +GetOrgauthorizationTrusteeGroupRolesRequest.getOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeGroupRolesRequest.getOrgauthorizationTrusteeGroupRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeGroups-example.txt b/build/docs/getOrgauthorizationTrusteeGroups-example.txt new file mode 100644 index 000000000..bad055bfe --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeGroups-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of trustee groups for this organization (i.e. groups granted access to this organization). +GetOrgauthorizationTrusteeGroupsRequest.getOrgauthorizationTrusteeGroups(trusteeOrgId: trusteeOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeGroupsRequest.getOrgauthorizationTrusteeGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeUser-example.txt b/build/docs/getOrgauthorizationTrusteeUser-example.txt new file mode 100644 index 000000000..9d3fb0dbc --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Get Trustee User +GetOrgauthorizationTrusteeUserRequest.getOrgauthorizationTrusteeUser(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeUserRequest.getOrgauthorizationTrusteeUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeUserRoles-example.txt b/build/docs/getOrgauthorizationTrusteeUserRoles-example.txt new file mode 100644 index 000000000..b36239528 --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeUserRoles-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Get Trustee User Roles +GetOrgauthorizationTrusteeUserRolesRequest.getOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeUserRolesRequest.getOrgauthorizationTrusteeUserRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteeUsers-example.txt b/build/docs/getOrgauthorizationTrusteeUsers-example.txt new file mode 100644 index 000000000..9e5dae3e6 --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteeUsers-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of trustee users for this organization (i.e. users granted access to this organization). +GetOrgauthorizationTrusteeUsersRequest.getOrgauthorizationTrusteeUsers(trusteeOrgId: trusteeOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteeUsersRequest.getOrgauthorizationTrusteeUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustees-example.txt b/build/docs/getOrgauthorizationTrustees-example.txt new file mode 100644 index 000000000..03d4f06d4 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustees-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of trustees for this organization (i.e. organizations granted access to this organization). +GetOrgauthorizationTrusteesRequest.getOrgauthorizationTrustees(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteesRequest.getOrgauthorizationTrustees was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrusteesDefault-example.txt b/build/docs/getOrgauthorizationTrusteesDefault-example.txt new file mode 100644 index 000000000..ed4fe7cec --- /dev/null +++ b/build/docs/getOrgauthorizationTrusteesDefault-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get organization authorization trust with Customer Care, if one exists. +GetOrgauthorizationTrusteesDefaultRequest.getOrgauthorizationTrusteesDefault() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrusteesDefaultRequest.getOrgauthorizationTrusteesDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustor-example.txt b/build/docs/getOrgauthorizationTrustor-example.txt new file mode 100644 index 000000000..eb2a57fc4 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustor-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id + +// Get Org Trust +GetOrgauthorizationTrustorRequest.getOrgauthorizationTrustor(trustorOrgId: trustorOrgId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorRequest.getOrgauthorizationTrustor was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorCloneduser-example.txt b/build/docs/getOrgauthorizationTrustorCloneduser-example.txt new file mode 100644 index 000000000..75dc514dd --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorCloneduser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Get Cloned User +GetOrgauthorizationTrustorCloneduserRequest.getOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorCloneduserRequest.getOrgauthorizationTrustorCloneduser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorClonedusers-example.txt b/build/docs/getOrgauthorizationTrustorClonedusers-example.txt new file mode 100644 index 000000000..bc7a63744 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorClonedusers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id + +// The list of cloned users in the trustor organization (i.e. users with a native user record). +GetOrgauthorizationTrustorClonedusersRequest.getOrgauthorizationTrustorClonedusers(trustorOrgId: trustorOrgId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorClonedusersRequest.getOrgauthorizationTrustorClonedusers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorGroup-example.txt b/build/docs/getOrgauthorizationTrustorGroup-example.txt new file mode 100644 index 000000000..d573c6a11 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorGroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trustorGroupId: String = "" // Trustor Group Id + +// Get Trustee Group +GetOrgauthorizationTrustorGroupRequest.getOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorGroupRequest.getOrgauthorizationTrustorGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorGroups-example.txt b/build/docs/getOrgauthorizationTrustorGroups-example.txt new file mode 100644 index 000000000..bea3fcd52 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorGroups-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustee Organization Id +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of groups in the trustor organization (i.e. groups granted access). +GetOrgauthorizationTrustorGroupsRequest.getOrgauthorizationTrustorGroups(trustorOrgId: trustorOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorGroupsRequest.getOrgauthorizationTrustorGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorUser-example.txt b/build/docs/getOrgauthorizationTrustorUser-example.txt new file mode 100644 index 000000000..bd677fd27 --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Get Trustee User +GetOrgauthorizationTrustorUserRequest.getOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorUserRequest.getOrgauthorizationTrustorUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustorUsers-example.txt b/build/docs/getOrgauthorizationTrustorUsers-example.txt new file mode 100644 index 000000000..098efc64f --- /dev/null +++ b/build/docs/getOrgauthorizationTrustorUsers-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustee Organization Id +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of users in the trustor organization (i.e. users granted access). +GetOrgauthorizationTrustorUsersRequest.getOrgauthorizationTrustorUsers(trustorOrgId: trustorOrgId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorUsersRequest.getOrgauthorizationTrustorUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrgauthorizationTrustors-example.txt b/build/docs/getOrgauthorizationTrustors-example.txt new file mode 100644 index 000000000..117e0aa1d --- /dev/null +++ b/build/docs/getOrgauthorizationTrustors-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// The list of organizations that have authorized/trusted your organization. +GetOrgauthorizationTrustorsRequest.getOrgauthorizationTrustors(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrgauthorizationTrustorsRequest.getOrgauthorizationTrustors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrphanrecording-example.txt b/build/docs/getOrphanrecording-example.txt new file mode 100644 index 000000000..8ae9d1057 --- /dev/null +++ b/build/docs/getOrphanrecording-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let orphanId: String = "" // Orphan ID + +// Gets a single orphan recording +GetOrphanrecordingRequest.getOrphanrecording(orphanId: orphanId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrphanrecordingRequest.getOrphanrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrphanrecordingMedia-example.txt b/build/docs/getOrphanrecordingMedia-example.txt new file mode 100644 index 000000000..2a385c0f6 --- /dev/null +++ b/build/docs/getOrphanrecordingMedia-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let orphanId: String = "" // Orphan ID +let formatId: GetOrphanrecordingMediaRequest.FormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.FormatId_getOrphanrecordingMedia.enummember // The desired media format. +let emailFormatId: GetOrphanrecordingMediaRequest.EmailFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.EmailFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading an email recording. +let chatFormatId: GetOrphanrecordingMediaRequest.ChatFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.ChatFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading a chat recording. +let messageFormatId: GetOrphanrecordingMediaRequest.MessageFormatId_getOrphanrecordingMedia = GetOrphanrecordingMediaRequest.MessageFormatId_getOrphanrecordingMedia.enummember // The desired media format when downloading a message recording. +let download: Bool = true // requesting a download format of the recording +let fileName: String = "" // the name of the downloaded fileName +let locale: String = "" // The locale for the requested file when downloading, as an ISO 639-1 code +let mediaFormats: [String] = [""] // All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 + +// Gets the media of a single orphan recording +GetOrphanrecordingMediaRequest.getOrphanrecordingMedia(orphanId: orphanId, formatId: formatId, emailFormatId: emailFormatId, chatFormatId: chatFormatId, messageFormatId: messageFormatId, download: download, fileName: fileName, locale: locale, mediaFormats: mediaFormats) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrphanrecordingMediaRequest.getOrphanrecordingMedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOrphanrecordings-example.txt b/build/docs/getOrphanrecordings-example.txt new file mode 100644 index 000000000..870608440 --- /dev/null +++ b/build/docs/getOrphanrecordings-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let hasConversation: Bool = true // Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. +let media: GetOrphanrecordingsRequest.Media_getOrphanrecordings = GetOrphanrecordingsRequest.Media_getOrphanrecordings.enummember // Filter resulting orphans based on their media type + +// Gets all orphan recordings +GetOrphanrecordingsRequest.getOrphanrecordings(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, hasConversation: hasConversation, media: media) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOrphanrecordingsRequest.getOrphanrecordings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundAttemptlimit-example.txt b/build/docs/getOutboundAttemptlimit-example.txt new file mode 100644 index 000000000..5c14af442 --- /dev/null +++ b/build/docs/getOutboundAttemptlimit-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let attemptLimitsId: String = "" // Attempt limits ID + +// Get attempt limits +GetOutboundAttemptlimitRequest.getOutboundAttemptlimit(attemptLimitsId: attemptLimitsId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundAttemptlimitRequest.getOutboundAttemptlimit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundAttemptlimits-example.txt b/build/docs/getOutboundAttemptlimits-example.txt new file mode 100644 index 000000000..222ca0642 --- /dev/null +++ b/build/docs/getOutboundAttemptlimits-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundAttemptlimitsRequest.FilterType_getOutboundAttemptlimits = GetOutboundAttemptlimitsRequest.FilterType_getOutboundAttemptlimits.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundAttemptlimitsRequest.SortOrder_getOutboundAttemptlimits = GetOutboundAttemptlimitsRequest.SortOrder_getOutboundAttemptlimits.enummember // Sort order + +// Query attempt limits list +GetOutboundAttemptlimitsRequest.getOutboundAttemptlimits(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundAttemptlimitsRequest.getOutboundAttemptlimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCallabletimeset-example.txt b/build/docs/getOutboundCallabletimeset-example.txt new file mode 100644 index 000000000..a181fd06c --- /dev/null +++ b/build/docs/getOutboundCallabletimeset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callableTimeSetId: String = "" // Callable Time Set ID + +// Get callable time set +GetOutboundCallabletimesetRequest.getOutboundCallabletimeset(callableTimeSetId: callableTimeSetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCallabletimesetRequest.getOutboundCallabletimeset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCallabletimesets-example.txt b/build/docs/getOutboundCallabletimesets-example.txt new file mode 100644 index 000000000..c2bfa8e75 --- /dev/null +++ b/build/docs/getOutboundCallabletimesets-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundCallabletimesetsRequest.FilterType_getOutboundCallabletimesets = GetOutboundCallabletimesetsRequest.FilterType_getOutboundCallabletimesets.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundCallabletimesetsRequest.SortOrder_getOutboundCallabletimesets = GetOutboundCallabletimesetsRequest.SortOrder_getOutboundCallabletimesets.enummember // Sort order + +// Query callable time set list +GetOutboundCallabletimesetsRequest.getOutboundCallabletimesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCallabletimesetsRequest.getOutboundCallabletimesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCallanalysisresponseset-example.txt b/build/docs/getOutboundCallanalysisresponseset-example.txt new file mode 100644 index 000000000..2d8fd0b43 --- /dev/null +++ b/build/docs/getOutboundCallanalysisresponseset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callAnalysisSetId: String = "" // Call Analysis Response Set ID + +// Get a dialer call analysis response set. +GetOutboundCallanalysisresponsesetRequest.getOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCallanalysisresponsesetRequest.getOutboundCallanalysisresponseset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCallanalysisresponsesets-example.txt b/build/docs/getOutboundCallanalysisresponsesets-example.txt new file mode 100644 index 000000000..6463e8998 --- /dev/null +++ b/build/docs/getOutboundCallanalysisresponsesets-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundCallanalysisresponsesetsRequest.FilterType_getOutboundCallanalysisresponsesets = GetOutboundCallanalysisresponsesetsRequest.FilterType_getOutboundCallanalysisresponsesets.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundCallanalysisresponsesetsRequest.SortOrder_getOutboundCallanalysisresponsesets = GetOutboundCallanalysisresponsesetsRequest.SortOrder_getOutboundCallanalysisresponsesets.enummember // Sort order + +// Query a list of dialer call analysis response sets. +GetOutboundCallanalysisresponsesetsRequest.getOutboundCallanalysisresponsesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCallanalysisresponsesetsRequest.getOutboundCallanalysisresponsesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaign-example.txt b/build/docs/getOutboundCampaign-example.txt new file mode 100644 index 000000000..c49df99dd --- /dev/null +++ b/build/docs/getOutboundCampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get dialer campaign. +GetOutboundCampaignRequest.getOutboundCampaign(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignRequest.getOutboundCampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignAgentownedmappingpreviewResults-example.txt b/build/docs/getOutboundCampaignAgentownedmappingpreviewResults-example.txt new file mode 100644 index 000000000..41ed7331d --- /dev/null +++ b/build/docs/getOutboundCampaignAgentownedmappingpreviewResults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get a preview of how agents will be mapped to this campaign's contact list. +GetOutboundCampaignAgentownedmappingpreviewResultsRequest.getOutboundCampaignAgentownedmappingpreviewResults(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignAgentownedmappingpreviewResultsRequest.getOutboundCampaignAgentownedmappingpreviewResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignDiagnostics-example.txt b/build/docs/getOutboundCampaignDiagnostics-example.txt new file mode 100644 index 000000000..17b495ffa --- /dev/null +++ b/build/docs/getOutboundCampaignDiagnostics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get campaign diagnostics +GetOutboundCampaignDiagnosticsRequest.getOutboundCampaignDiagnostics(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignDiagnosticsRequest.getOutboundCampaignDiagnostics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignInteractions-example.txt b/build/docs/getOutboundCampaignInteractions-example.txt new file mode 100644 index 000000000..668b7210a --- /dev/null +++ b/build/docs/getOutboundCampaignInteractions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get dialer campaign interactions. +GetOutboundCampaignInteractionsRequest.getOutboundCampaignInteractions(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignInteractionsRequest.getOutboundCampaignInteractions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignProgress-example.txt b/build/docs/getOutboundCampaignProgress-example.txt new file mode 100644 index 000000000..5cd4fe0cc --- /dev/null +++ b/build/docs/getOutboundCampaignProgress-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get campaign progress +GetOutboundCampaignProgressRequest.getOutboundCampaignProgress(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignProgressRequest.getOutboundCampaignProgress was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignStats-example.txt b/build/docs/getOutboundCampaignStats-example.txt new file mode 100644 index 000000000..304ef286a --- /dev/null +++ b/build/docs/getOutboundCampaignStats-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get statistics about a Dialer Campaign +GetOutboundCampaignStatsRequest.getOutboundCampaignStats(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignStatsRequest.getOutboundCampaignStats was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignrule-example.txt b/build/docs/getOutboundCampaignrule-example.txt new file mode 100644 index 000000000..9ca26e9a4 --- /dev/null +++ b/build/docs/getOutboundCampaignrule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignRuleId: String = "" // Campaign Rule ID + +// Get Campaign Rule +GetOutboundCampaignruleRequest.getOutboundCampaignrule(campaignRuleId: campaignRuleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignruleRequest.getOutboundCampaignrule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignrules-example.txt b/build/docs/getOutboundCampaignrules-example.txt new file mode 100644 index 000000000..f440c92dc --- /dev/null +++ b/build/docs/getOutboundCampaignrules-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundCampaignrulesRequest.FilterType_getOutboundCampaignrules = GetOutboundCampaignrulesRequest.FilterType_getOutboundCampaignrules.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundCampaignrulesRequest.SortOrder_getOutboundCampaignrules = GetOutboundCampaignrulesRequest.SortOrder_getOutboundCampaignrules.enummember // Sort order + +// Query Campaign Rule list +GetOutboundCampaignrulesRequest.getOutboundCampaignrules(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignrulesRequest.getOutboundCampaignrules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaigns-example.txt b/build/docs/getOutboundCampaigns-example.txt new file mode 100644 index 000000000..d7708556b --- /dev/null +++ b/build/docs/getOutboundCampaigns-example.txt @@ -0,0 +1,28 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let filterType: GetOutboundCampaignsRequest.FilterType_getOutboundCampaigns = GetOutboundCampaignsRequest.FilterType_getOutboundCampaigns.enummember // Filter type +let name: String = "" // Name +let _id: [String] = [""] // id +let contactListId: String = "" // Contact List ID +let dncListIds: String = "" // DNC list ID +let distributionQueueId: String = "" // Distribution queue ID +let edgeGroupId: String = "" // Edge group ID +let callAnalysisResponseSetId: String = "" // Call analysis response set ID +let divisionId: [String] = [""] // Division ID(s) +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundCampaignsRequest.SortOrder_getOutboundCampaigns = GetOutboundCampaignsRequest.SortOrder_getOutboundCampaigns.enummember // Sort order + +// Query a list of dialer campaigns. +GetOutboundCampaignsRequest.getOutboundCampaigns(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, contactListId: contactListId, dncListIds: dncListIds, distributionQueueId: distributionQueueId, edgeGroupId: edgeGroupId, callAnalysisResponseSetId: callAnalysisResponseSetId, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignsRequest.getOutboundCampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignsAll-example.txt b/build/docs/getOutboundCampaignsAll-example.txt new file mode 100644 index 000000000..1c3d80ac4 --- /dev/null +++ b/build/docs/getOutboundCampaignsAll-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // Campaign ID(s) +let name: String = "" // Campaign name(s) +let divisionId: [String] = [""] // Division ID(s) +let mediaType: [String] = [""] // Media type(s) +let sortOrder: GetOutboundCampaignsAllRequest.SortOrder_getOutboundCampaignsAll = GetOutboundCampaignsAllRequest.SortOrder_getOutboundCampaignsAll.enummember // Sort order + +// Query across all types of campaigns by division +GetOutboundCampaignsAllRequest.getOutboundCampaignsAll(pageSize: pageSize, pageNumber: pageNumber, _id: _id, name: name, divisionId: divisionId, mediaType: mediaType, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignsAllRequest.getOutboundCampaignsAll was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignsAllDivisionviews-example.txt b/build/docs/getOutboundCampaignsAllDivisionviews-example.txt new file mode 100644 index 000000000..a83cf2e59 --- /dev/null +++ b/build/docs/getOutboundCampaignsAllDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // Campaign ID(s) +let name: String = "" // Campaign name(s) +let divisionId: [String] = [""] // Division ID(s) +let mediaType: [String] = [""] // Media type(s) +let sortOrder: GetOutboundCampaignsAllDivisionviewsRequest.SortOrder_getOutboundCampaignsAllDivisionviews = GetOutboundCampaignsAllDivisionviewsRequest.SortOrder_getOutboundCampaignsAllDivisionviews.enummember // Sort order + +// Query across all types of campaigns +GetOutboundCampaignsAllDivisionviewsRequest.getOutboundCampaignsAllDivisionviews(pageSize: pageSize, pageNumber: pageNumber, _id: _id, name: name, divisionId: divisionId, mediaType: mediaType, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignsAllDivisionviewsRequest.getOutboundCampaignsAllDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignsDivisionview-example.txt b/build/docs/getOutboundCampaignsDivisionview-example.txt new file mode 100644 index 000000000..e5d3f1fee --- /dev/null +++ b/build/docs/getOutboundCampaignsDivisionview-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get a basic Campaign information object +GetOutboundCampaignsDivisionviewRequest.getOutboundCampaignsDivisionview(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignsDivisionviewRequest.getOutboundCampaignsDivisionview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundCampaignsDivisionviews-example.txt b/build/docs/getOutboundCampaignsDivisionviews-example.txt new file mode 100644 index 000000000..d4219f7bb --- /dev/null +++ b/build/docs/getOutboundCampaignsDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let filterType: GetOutboundCampaignsDivisionviewsRequest.FilterType_getOutboundCampaignsDivisionviews = GetOutboundCampaignsDivisionviewsRequest.FilterType_getOutboundCampaignsDivisionviews.enummember // Filter type +let name: String = "" // Name +let _id: [String] = [""] // id +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundCampaignsDivisionviewsRequest.SortOrder_getOutboundCampaignsDivisionviews = GetOutboundCampaignsDivisionviewsRequest.SortOrder_getOutboundCampaignsDivisionviews.enummember // Sort order + +// Query a list of basic Campaign information objects +GetOutboundCampaignsDivisionviewsRequest.getOutboundCampaignsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundCampaignsDivisionviewsRequest.getOutboundCampaignsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlist-example.txt b/build/docs/getOutboundContactlist-example.txt new file mode 100644 index 000000000..c50c98553 --- /dev/null +++ b/build/docs/getOutboundContactlist-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID +let includeImportStatus: Bool = true // Import status +let includeSize: Bool = true // Include size + +// Get a dialer contact list. +GetOutboundContactlistRequest.getOutboundContactlist(contactListId: contactListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistRequest.getOutboundContactlist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistContact-example.txt b/build/docs/getOutboundContactlistContact-example.txt new file mode 100644 index 000000000..0db298238 --- /dev/null +++ b/build/docs/getOutboundContactlistContact-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let contactId: String = "" // Contact ID + +// Get a contact. +GetOutboundContactlistContactRequest.getOutboundContactlistContact(contactListId: contactListId, contactId: contactId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistContactRequest.getOutboundContactlistContact was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistExport-example.txt b/build/docs/getOutboundContactlistExport-example.txt new file mode 100644 index 000000000..ca4b3924e --- /dev/null +++ b/build/docs/getOutboundContactlistExport-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID +let download: String = "" // Redirect to download uri + +// Get the URI of a contact list export. +GetOutboundContactlistExportRequest.getOutboundContactlistExport(contactListId: contactListId, download: download) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistExportRequest.getOutboundContactlistExport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistImportstatus-example.txt b/build/docs/getOutboundContactlistImportstatus-example.txt new file mode 100644 index 000000000..119392ce8 --- /dev/null +++ b/build/docs/getOutboundContactlistImportstatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID + +// Get dialer contactList import status. +GetOutboundContactlistImportstatusRequest.getOutboundContactlistImportstatus(contactListId: contactListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistImportstatusRequest.getOutboundContactlistImportstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistTimezonemappingpreview-example.txt b/build/docs/getOutboundContactlistTimezonemappingpreview-example.txt new file mode 100644 index 000000000..46af0af38 --- /dev/null +++ b/build/docs/getOutboundContactlistTimezonemappingpreview-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID + +// Preview the result of applying Automatic Time Zone Mapping to a contact list +GetOutboundContactlistTimezonemappingpreviewRequest.getOutboundContactlistTimezonemappingpreview(contactListId: contactListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistTimezonemappingpreviewRequest.getOutboundContactlistTimezonemappingpreview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistfilter-example.txt b/build/docs/getOutboundContactlistfilter-example.txt new file mode 100644 index 000000000..aa4786594 --- /dev/null +++ b/build/docs/getOutboundContactlistfilter-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListFilterId: String = "" // Contact List Filter ID + +// Get Contact list filter +GetOutboundContactlistfilterRequest.getOutboundContactlistfilter(contactListFilterId: contactListFilterId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistfilterRequest.getOutboundContactlistfilter was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistfilters-example.txt b/build/docs/getOutboundContactlistfilters-example.txt new file mode 100644 index 000000000..2a28764f3 --- /dev/null +++ b/build/docs/getOutboundContactlistfilters-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundContactlistfiltersRequest.FilterType_getOutboundContactlistfilters = GetOutboundContactlistfiltersRequest.FilterType_getOutboundContactlistfilters.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundContactlistfiltersRequest.SortOrder_getOutboundContactlistfilters = GetOutboundContactlistfiltersRequest.SortOrder_getOutboundContactlistfilters.enummember // Sort order +let contactListId: String = "" // Contact List ID + +// Query Contact list filters +GetOutboundContactlistfiltersRequest.getOutboundContactlistfilters(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder, contactListId: contactListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistfiltersRequest.getOutboundContactlistfilters was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlists-example.txt b/build/docs/getOutboundContactlists-example.txt new file mode 100644 index 000000000..595941787 --- /dev/null +++ b/build/docs/getOutboundContactlists-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let includeImportStatus: Bool = true // Include import status +let includeSize: Bool = true // Include size +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundContactlistsRequest.FilterType_getOutboundContactlists = GetOutboundContactlistsRequest.FilterType_getOutboundContactlists.enummember // Filter type +let name: String = "" // Name +let _id: [String] = [""] // id +let divisionId: [String] = [""] // Division ID(s) +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundContactlistsRequest.SortOrder_getOutboundContactlists = GetOutboundContactlistsRequest.SortOrder_getOutboundContactlists.enummember // Sort order + +// Query a list of contact lists. +GetOutboundContactlistsRequest.getOutboundContactlists(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, _id: _id, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistsRequest.getOutboundContactlists was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistsDivisionview-example.txt b/build/docs/getOutboundContactlistsDivisionview-example.txt new file mode 100644 index 000000000..a02ccb7a1 --- /dev/null +++ b/build/docs/getOutboundContactlistsDivisionview-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contactlist ID +let includeImportStatus: Bool = true // Include import status +let includeSize: Bool = true // Include size + +// Get a basic ContactList information object +GetOutboundContactlistsDivisionviewRequest.getOutboundContactlistsDivisionview(contactListId: contactListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistsDivisionviewRequest.getOutboundContactlistsDivisionview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundContactlistsDivisionviews-example.txt b/build/docs/getOutboundContactlistsDivisionviews-example.txt new file mode 100644 index 000000000..b719876f3 --- /dev/null +++ b/build/docs/getOutboundContactlistsDivisionviews-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let includeImportStatus: Bool = true // Include import status +let includeSize: Bool = true // Include size +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let filterType: GetOutboundContactlistsDivisionviewsRequest.FilterType_getOutboundContactlistsDivisionviews = GetOutboundContactlistsDivisionviewsRequest.FilterType_getOutboundContactlistsDivisionviews.enummember // Filter type +let name: String = "" // Name +let _id: [String] = [""] // id +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundContactlistsDivisionviewsRequest.SortOrder_getOutboundContactlistsDivisionviews = GetOutboundContactlistsDivisionviewsRequest.SortOrder_getOutboundContactlistsDivisionviews.enummember // Sort order + +// Query a list of simplified contact list objects. +GetOutboundContactlistsDivisionviewsRequest.getOutboundContactlistsDivisionviews(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundContactlistsDivisionviewsRequest.getOutboundContactlistsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDigitalruleset-example.txt b/build/docs/getOutboundDigitalruleset-example.txt new file mode 100644 index 000000000..cf28af8ef --- /dev/null +++ b/build/docs/getOutboundDigitalruleset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let digitalRuleSetId: String = "" // The Digital Rule Set ID + +// Get an Outbound Digital Rule Set +GetOutboundDigitalrulesetRequest.getOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDigitalrulesetRequest.getOutboundDigitalruleset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDigitalrulesets-example.txt b/build/docs/getOutboundDigitalrulesets-example.txt new file mode 100644 index 000000000..c976a185e --- /dev/null +++ b/build/docs/getOutboundDigitalrulesets-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let sortBy: GetOutboundDigitalrulesetsRequest.SortBy_getOutboundDigitalrulesets = GetOutboundDigitalrulesetsRequest.SortBy_getOutboundDigitalrulesets.enummember // The field to sort by +let sortOrder: GetOutboundDigitalrulesetsRequest.SortOrder_getOutboundDigitalrulesets = GetOutboundDigitalrulesetsRequest.SortOrder_getOutboundDigitalrulesets.enummember // The direction to sort +let name: String = "" // Name +let _id: [String] = [""] // A list of digital rule set ids to bulk fetch + +// Query a list of Outbound Digital Rule Sets +GetOutboundDigitalrulesetsRequest.getOutboundDigitalrulesets(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDigitalrulesetsRequest.getOutboundDigitalrulesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclist-example.txt b/build/docs/getOutboundDnclist-example.txt new file mode 100644 index 000000000..7aee1d677 --- /dev/null +++ b/build/docs/getOutboundDnclist-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let includeImportStatus: Bool = true // Import status +let includeSize: Bool = true // Include size + +// Get dialer DNC list +GetOutboundDnclistRequest.getOutboundDnclist(dncListId: dncListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistRequest.getOutboundDnclist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclistExport-example.txt b/build/docs/getOutboundDnclistExport-example.txt new file mode 100644 index 000000000..2b4cffcfc --- /dev/null +++ b/build/docs/getOutboundDnclistExport-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let download: String = "" // Redirect to download uri + +// Get the URI of a DNC list export. +GetOutboundDnclistExportRequest.getOutboundDnclistExport(dncListId: dncListId, download: download) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistExportRequest.getOutboundDnclistExport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclistImportstatus-example.txt b/build/docs/getOutboundDnclistImportstatus-example.txt new file mode 100644 index 000000000..67146c3c8 --- /dev/null +++ b/build/docs/getOutboundDnclistImportstatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID + +// Get dialer dncList import status. +GetOutboundDnclistImportstatusRequest.getOutboundDnclistImportstatus(dncListId: dncListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistImportstatusRequest.getOutboundDnclistImportstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclists-example.txt b/build/docs/getOutboundDnclists-example.txt new file mode 100644 index 000000000..dbe0fefe8 --- /dev/null +++ b/build/docs/getOutboundDnclists-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let includeImportStatus: Bool = true // Import status +let includeSize: Bool = true // Include size +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundDnclistsRequest.FilterType_getOutboundDnclists = GetOutboundDnclistsRequest.FilterType_getOutboundDnclists.enummember // Filter type +let name: String = "" // Name +let dncSourceType: GetOutboundDnclistsRequest.DncSourceType_getOutboundDnclists = GetOutboundDnclistsRequest.DncSourceType_getOutboundDnclists.enummember // DncSourceType +let divisionId: [String] = [""] // Division ID(s) +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundDnclistsRequest.SortOrder_getOutboundDnclists = GetOutboundDnclistsRequest.SortOrder_getOutboundDnclists.enummember // Sort order + +// Query dialer DNC lists +GetOutboundDnclistsRequest.getOutboundDnclists(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, dncSourceType: dncSourceType, divisionId: divisionId, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistsRequest.getOutboundDnclists was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclistsDivisionview-example.txt b/build/docs/getOutboundDnclistsDivisionview-example.txt new file mode 100644 index 000000000..3dff902fa --- /dev/null +++ b/build/docs/getOutboundDnclistsDivisionview-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // Dnclist ID +let includeImportStatus: Bool = true // Include import status +let includeSize: Bool = true // Include size + +// Get a basic DncList information object +GetOutboundDnclistsDivisionviewRequest.getOutboundDnclistsDivisionview(dncListId: dncListId, includeImportStatus: includeImportStatus, includeSize: includeSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistsDivisionviewRequest.getOutboundDnclistsDivisionview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundDnclistsDivisionviews-example.txt b/build/docs/getOutboundDnclistsDivisionviews-example.txt new file mode 100644 index 000000000..ccef13bcd --- /dev/null +++ b/build/docs/getOutboundDnclistsDivisionviews-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let includeImportStatus: Bool = true // Include import status +let includeSize: Bool = true // Include size +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let filterType: GetOutboundDnclistsDivisionviewsRequest.FilterType_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.FilterType_getOutboundDnclistsDivisionviews.enummember // Filter type +let name: String = "" // Name +let dncSourceType: GetOutboundDnclistsDivisionviewsRequest.DncSourceType_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.DncSourceType_getOutboundDnclistsDivisionviews.enummember // DncSourceType +let _id: [String] = [""] // id +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundDnclistsDivisionviewsRequest.SortOrder_getOutboundDnclistsDivisionviews = GetOutboundDnclistsDivisionviewsRequest.SortOrder_getOutboundDnclistsDivisionviews.enummember // Sort order + +// Query a list of simplified dnc list objects. +GetOutboundDnclistsDivisionviewsRequest.getOutboundDnclistsDivisionviews(includeImportStatus: includeImportStatus, includeSize: includeSize, pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, name: name, dncSourceType: dncSourceType, _id: _id, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundDnclistsDivisionviewsRequest.getOutboundDnclistsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundEvent-example.txt b/build/docs/getOutboundEvent-example.txt new file mode 100644 index 000000000..3453dadc4 --- /dev/null +++ b/build/docs/getOutboundEvent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let eventId: String = "" // Event Log ID + +// Get Dialer Event +GetOutboundEventRequest.getOutboundEvent(eventId: eventId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundEventRequest.getOutboundEvent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundEvents-example.txt b/build/docs/getOutboundEvents-example.txt new file mode 100644 index 000000000..ba7d79805 --- /dev/null +++ b/build/docs/getOutboundEvents-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let filterType: GetOutboundEventsRequest.FilterType_getOutboundEvents = GetOutboundEventsRequest.FilterType_getOutboundEvents.enummember // Filter type +let category: String = "" // Category +let level: String = "" // Level +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundEventsRequest.SortOrder_getOutboundEvents = GetOutboundEventsRequest.SortOrder_getOutboundEvents.enummember // Sort order + +// Query Event Logs +GetOutboundEventsRequest.getOutboundEvents(pageSize: pageSize, pageNumber: pageNumber, filterType: filterType, category: category, level: level, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundEventsRequest.getOutboundEvents was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaign-example.txt b/build/docs/getOutboundMessagingcampaign-example.txt new file mode 100644 index 000000000..38eea2247 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Get an Outbound Messaging Campaign +GetOutboundMessagingcampaignRequest.getOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignRequest.getOutboundMessagingcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaignDiagnostics-example.txt b/build/docs/getOutboundMessagingcampaignDiagnostics-example.txt new file mode 100644 index 000000000..dad139b83 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaignDiagnostics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Get messaging campaign diagnostics +GetOutboundMessagingcampaignDiagnosticsRequest.getOutboundMessagingcampaignDiagnostics(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignDiagnosticsRequest.getOutboundMessagingcampaignDiagnostics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaignProgress-example.txt b/build/docs/getOutboundMessagingcampaignProgress-example.txt new file mode 100644 index 000000000..647ad7e63 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaignProgress-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Get messaging campaign's progress +GetOutboundMessagingcampaignProgressRequest.getOutboundMessagingcampaignProgress(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignProgressRequest.getOutboundMessagingcampaignProgress was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaigns-example.txt b/build/docs/getOutboundMessagingcampaigns-example.txt new file mode 100644 index 000000000..95abcf116 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaigns-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let sortBy: GetOutboundMessagingcampaignsRequest.SortBy_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.SortBy_getOutboundMessagingcampaigns.enummember // The field to sort by +let sortOrder: GetOutboundMessagingcampaignsRequest.SortOrder_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.SortOrder_getOutboundMessagingcampaigns.enummember // The direction to sort +let name: String = "" // Name +let contactListId: String = "" // Contact List ID +let divisionId: [String] = [""] // Division ID(s) +let type: GetOutboundMessagingcampaignsRequest.ModelType_getOutboundMessagingcampaigns = GetOutboundMessagingcampaignsRequest.ModelType_getOutboundMessagingcampaigns.enummember // Campaign Type +let senderSmsPhoneNumber: String = "" // Sender SMS Phone Number +let _id: [String] = [""] // A list of messaging campaign ids to bulk fetch + +// Query a list of Messaging Campaigns +GetOutboundMessagingcampaignsRequest.getOutboundMessagingcampaigns(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, contactListId: contactListId, divisionId: divisionId, type: type, senderSmsPhoneNumber: senderSmsPhoneNumber, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignsRequest.getOutboundMessagingcampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaignsDivisionview-example.txt b/build/docs/getOutboundMessagingcampaignsDivisionview-example.txt new file mode 100644 index 000000000..7b0abdf70 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaignsDivisionview-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID + +// Get a basic Messaging Campaign information object +GetOutboundMessagingcampaignsDivisionviewRequest.getOutboundMessagingcampaignsDivisionview(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignsDivisionviewRequest.getOutboundMessagingcampaignsDivisionview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundMessagingcampaignsDivisionviews-example.txt b/build/docs/getOutboundMessagingcampaignsDivisionviews-example.txt new file mode 100644 index 000000000..4ba6d04f1 --- /dev/null +++ b/build/docs/getOutboundMessagingcampaignsDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let sortOrder: GetOutboundMessagingcampaignsDivisionviewsRequest.SortOrder_getOutboundMessagingcampaignsDivisionviews = GetOutboundMessagingcampaignsDivisionviewsRequest.SortOrder_getOutboundMessagingcampaignsDivisionviews.enummember // The direction to sort +let name: String = "" // Name +let type: GetOutboundMessagingcampaignsDivisionviewsRequest.ModelType_getOutboundMessagingcampaignsDivisionviews = GetOutboundMessagingcampaignsDivisionviewsRequest.ModelType_getOutboundMessagingcampaignsDivisionviews.enummember // Campaign Type +let _id: [String] = [""] // id +let senderSmsPhoneNumber: String = "" // Sender SMS Phone Number + +// Query a list of basic Messaging Campaign information objects +GetOutboundMessagingcampaignsDivisionviewsRequest.getOutboundMessagingcampaignsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name, type: type, _id: _id, senderSmsPhoneNumber: senderSmsPhoneNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundMessagingcampaignsDivisionviewsRequest.getOutboundMessagingcampaignsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundRuleset-example.txt b/build/docs/getOutboundRuleset-example.txt new file mode 100644 index 000000000..4264d83a7 --- /dev/null +++ b/build/docs/getOutboundRuleset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleSetId: String = "" // Rule Set ID + +// Get a Rule Set by ID. +GetOutboundRulesetRequest.getOutboundRuleset(ruleSetId: ruleSetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundRulesetRequest.getOutboundRuleset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundRulesets-example.txt b/build/docs/getOutboundRulesets-example.txt new file mode 100644 index 000000000..6e9dd4ce9 --- /dev/null +++ b/build/docs/getOutboundRulesets-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundRulesetsRequest.FilterType_getOutboundRulesets = GetOutboundRulesetsRequest.FilterType_getOutboundRulesets.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundRulesetsRequest.SortOrder_getOutboundRulesets = GetOutboundRulesetsRequest.SortOrder_getOutboundRulesets.enummember // Sort order + +// Query a list of Rule Sets. +GetOutboundRulesetsRequest.getOutboundRulesets(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundRulesetsRequest.getOutboundRulesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesCampaign-example.txt b/build/docs/getOutboundSchedulesCampaign-example.txt new file mode 100644 index 000000000..0e5d2027b --- /dev/null +++ b/build/docs/getOutboundSchedulesCampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Get a dialer campaign schedule. +GetOutboundSchedulesCampaignRequest.getOutboundSchedulesCampaign(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesCampaignRequest.getOutboundSchedulesCampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesCampaigns-example.txt b/build/docs/getOutboundSchedulesCampaigns-example.txt new file mode 100644 index 000000000..bd940908f --- /dev/null +++ b/build/docs/getOutboundSchedulesCampaigns-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Query for a list of dialer campaign schedules. +GetOutboundSchedulesCampaignsRequest.getOutboundSchedulesCampaigns() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesCampaignsRequest.getOutboundSchedulesCampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesEmailcampaign-example.txt b/build/docs/getOutboundSchedulesEmailcampaign-example.txt new file mode 100644 index 000000000..2a3af1e7d --- /dev/null +++ b/build/docs/getOutboundSchedulesEmailcampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emailCampaignId: String = "" // Email Campaign ID + +// Get an email campaign schedule. +GetOutboundSchedulesEmailcampaignRequest.getOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesEmailcampaignRequest.getOutboundSchedulesEmailcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesEmailcampaigns-example.txt b/build/docs/getOutboundSchedulesEmailcampaigns-example.txt new file mode 100644 index 000000000..e63937ecb --- /dev/null +++ b/build/docs/getOutboundSchedulesEmailcampaigns-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Query for a list of email campaign schedules. +GetOutboundSchedulesEmailcampaignsRequest.getOutboundSchedulesEmailcampaigns() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesEmailcampaignsRequest.getOutboundSchedulesEmailcampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesMessagingcampaign-example.txt b/build/docs/getOutboundSchedulesMessagingcampaign-example.txt new file mode 100644 index 000000000..7295cb566 --- /dev/null +++ b/build/docs/getOutboundSchedulesMessagingcampaign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // Messaging Campaign ID + +// Get a messaging campaign schedule. +GetOutboundSchedulesMessagingcampaignRequest.getOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesMessagingcampaignRequest.getOutboundSchedulesMessagingcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesMessagingcampaigns-example.txt b/build/docs/getOutboundSchedulesMessagingcampaigns-example.txt new file mode 100644 index 000000000..48dde1c96 --- /dev/null +++ b/build/docs/getOutboundSchedulesMessagingcampaigns-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Query for a list of messaging campaign schedules. +GetOutboundSchedulesMessagingcampaignsRequest.getOutboundSchedulesMessagingcampaigns() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesMessagingcampaignsRequest.getOutboundSchedulesMessagingcampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesSequence-example.txt b/build/docs/getOutboundSchedulesSequence-example.txt new file mode 100644 index 000000000..0132d2bd6 --- /dev/null +++ b/build/docs/getOutboundSchedulesSequence-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Sequence ID + +// Get a dialer sequence schedule. +GetOutboundSchedulesSequenceRequest.getOutboundSchedulesSequence(sequenceId: sequenceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesSequenceRequest.getOutboundSchedulesSequence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSchedulesSequences-example.txt b/build/docs/getOutboundSchedulesSequences-example.txt new file mode 100644 index 000000000..b5c3e4334 --- /dev/null +++ b/build/docs/getOutboundSchedulesSequences-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Query for a list of dialer sequence schedules. +GetOutboundSchedulesSequencesRequest.getOutboundSchedulesSequences() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSchedulesSequencesRequest.getOutboundSchedulesSequences was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSequence-example.txt b/build/docs/getOutboundSequence-example.txt new file mode 100644 index 000000000..57869e183 --- /dev/null +++ b/build/docs/getOutboundSequence-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Campaign Sequence ID + +// Get a dialer campaign sequence. +GetOutboundSequenceRequest.getOutboundSequence(sequenceId: sequenceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSequenceRequest.getOutboundSequence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSequences-example.txt b/build/docs/getOutboundSequences-example.txt new file mode 100644 index 000000000..1171011cc --- /dev/null +++ b/build/docs/getOutboundSequences-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size. The max that will be returned is 100. +let pageNumber: Int = 0 // Page number +let allowEmptyResult: Bool = true // Whether to return an empty page when there are no results for that page +let filterType: GetOutboundSequencesRequest.FilterType_getOutboundSequences = GetOutboundSequencesRequest.FilterType_getOutboundSequences.enummember // Filter type +let name: String = "" // Name +let sortBy: String = "" // Sort by +let sortOrder: GetOutboundSequencesRequest.SortOrder_getOutboundSequences = GetOutboundSequencesRequest.SortOrder_getOutboundSequences.enummember // Sort order + +// Query a list of dialer campaign sequences. +GetOutboundSequencesRequest.getOutboundSequences(pageSize: pageSize, pageNumber: pageNumber, allowEmptyResult: allowEmptyResult, filterType: filterType, name: name, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSequencesRequest.getOutboundSequences was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundSettings-example.txt b/build/docs/getOutboundSettings-example.txt new file mode 100644 index 000000000..ef6bd4895 --- /dev/null +++ b/build/docs/getOutboundSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the outbound settings for this organization +GetOutboundSettingsRequest.getOutboundSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundSettingsRequest.getOutboundSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getOutboundWrapupcodemappings-example.txt b/build/docs/getOutboundWrapupcodemappings-example.txt new file mode 100644 index 000000000..97161000c --- /dev/null +++ b/build/docs/getOutboundWrapupcodemappings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the Dialer wrap up code mapping. +GetOutboundWrapupcodemappingsRequest.getOutboundWrapupcodemappings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetOutboundWrapupcodemappingsRequest.getOutboundWrapupcodemappings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresenceSettings-example.txt b/build/docs/getPresenceSettings-example.txt new file mode 100644 index 000000000..801cb26a8 --- /dev/null +++ b/build/docs/getPresenceSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the presence settings +GetPresenceSettingsRequest.getPresenceSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresenceSettingsRequest.getPresenceSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresenceSource-example.txt b/build/docs/getPresenceSource-example.txt new file mode 100644 index 000000000..a05616cb2 --- /dev/null +++ b/build/docs/getPresenceSource-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sourceId: String = "" // Presence Source ID + +// Get a Presence Source +GetPresenceSourceRequest.getPresenceSource(sourceId: sourceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresenceSourceRequest.getPresenceSource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresenceSources-example.txt b/build/docs/getPresenceSources-example.txt new file mode 100644 index 000000000..34942bf1d --- /dev/null +++ b/build/docs/getPresenceSources-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deactivated: String = "" // Deactivated query can be TRUE or FALSE + +// Get a list of Presence Sources +GetPresenceSourcesRequest.getPresenceSources(deactivated: deactivated) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresenceSourcesRequest.getPresenceSources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresenceUserPrimarysource-example.txt b/build/docs/getPresenceUserPrimarysource-example.txt new file mode 100644 index 000000000..7ad3d9624 --- /dev/null +++ b/build/docs/getPresenceUserPrimarysource-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user ID + +// Get a user's Primary Presence Source +GetPresenceUserPrimarysourceRequest.getPresenceUserPrimarysource(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresenceUserPrimarysourceRequest.getPresenceUserPrimarysource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresencedefinition-example.txt b/build/docs/getPresencedefinition-example.txt new file mode 100644 index 000000000..7be217395 --- /dev/null +++ b/build/docs/getPresencedefinition-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let presenceId: String = "" // Organization Presence ID +let localeCode: String = "" // The locale code to fetch for the presence definition. Use ALL to fetch everything. + +// Get a Presence Definition +GetPresencedefinitionRequest.getPresencedefinition(presenceId: presenceId, localeCode: localeCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresencedefinitionRequest.getPresencedefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getPresencedefinitions-example.txt b/build/docs/getPresencedefinitions-example.txt new file mode 100644 index 000000000..056314c06 --- /dev/null +++ b/build/docs/getPresencedefinitions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let deleted: String = "" // Deleted query can be TRUE, FALSE or ALL +let localeCode: String = "" // The locale code to fetch for each presence definition. Use ALL to fetch everything. + +// Get an Organization's list of Presence Definitions +GetPresencedefinitionsRequest.getPresencedefinitions(pageNumber: pageNumber, pageSize: pageSize, deleted: deleted, localeCode: localeCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetPresencedefinitionsRequest.getPresencedefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getProcessautomationTrigger-example.txt b/build/docs/getProcessautomationTrigger-example.txt new file mode 100644 index 000000000..746b67590 --- /dev/null +++ b/build/docs/getProcessautomationTrigger-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let triggerId: String = "" // triggerId + +// Retrieve a single Trigger matching id +GetProcessautomationTriggerRequest.getProcessautomationTrigger(triggerId: triggerId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetProcessautomationTriggerRequest.getProcessautomationTrigger was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getProcessautomationTriggers-example.txt b/build/docs/getProcessautomationTriggers-example.txt new file mode 100644 index 000000000..10cdef651 --- /dev/null +++ b/build/docs/getProcessautomationTriggers-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let topicName: String = "" // Topic name(s). Separated by commas +let enabled: Bool = true // Boolean indicating desired enabled state of triggers +let hasDelayBy: Bool = true // Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set. + +// Retrieves all triggers, optionally filtered by query parameters. +GetProcessautomationTriggersRequest.getProcessautomationTriggers(before: before, after: after, pageSize: pageSize, topicName: topicName, enabled: enabled, hasDelayBy: hasDelayBy) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetProcessautomationTriggersRequest.getProcessautomationTriggers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getProcessautomationTriggersTopics-example.txt b/build/docs/getProcessautomationTriggersTopics-example.txt new file mode 100644 index 000000000..b6df8cfe4 --- /dev/null +++ b/build/docs/getProcessautomationTriggersTopics-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 200. + +// Get topics available for organization +GetProcessautomationTriggersTopicsRequest.getProcessautomationTriggersTopics(before: before, after: after, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetProcessautomationTriggersTopicsRequest.getProcessautomationTriggersTopics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getProfilesGroups-example.txt b/build/docs/getProfilesGroups-example.txt new file mode 100644 index 000000000..f8bb9adeb --- /dev/null +++ b/build/docs/getProfilesGroups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // id +let jabberId: [String] = [""] // A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) +let sortOrder: GetProfilesGroupsRequest.SortOrder_getProfilesGroups = GetProfilesGroupsRequest.SortOrder_getProfilesGroups.enummember // Ascending or descending sort order + +// Get group profile listing +GetProfilesGroupsRequest.getProfilesGroups(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetProfilesGroupsRequest.getProfilesGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getProfilesUsers-example.txt b/build/docs/getProfilesUsers-example.txt new file mode 100644 index 000000000..b49f63344 --- /dev/null +++ b/build/docs/getProfilesUsers-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // id +let jid: [String] = [""] // jid +let sortOrder: GetProfilesUsersRequest.SortOrder_getProfilesUsers = GetProfilesUsersRequest.SortOrder_getProfilesUsers.enummember // Ascending or descending sort order +let expand: [String] = [""] // Which fields, if any, to expand +let integrationPresenceSource: GetProfilesUsersRequest.IntegrationPresenceSource_getProfilesUsers = GetProfilesUsersRequest.IntegrationPresenceSource_getProfilesUsers.enummember // Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". + +// Get a user profile listing +GetProfilesUsersRequest.getProfilesUsers(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jid: jid, sortOrder: sortOrder, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetProfilesUsersRequest.getProfilesUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityAgentsActivity-example.txt b/build/docs/getQualityAgentsActivity-example.txt new file mode 100644 index 000000000..4bc7c2c6b --- /dev/null +++ b/build/docs/getQualityAgentsActivity-example.txt @@ -0,0 +1,28 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let startTime: Date = new Date(...) // Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let endTime: Date = new Date(...) // End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let agentUserId: [String] = [""] // user id of agent requested +let evaluatorUserId: String = "" // user id of the evaluator +let name: String = "" // name +let group: String = "" // group id +let formContextId: String = "" // shared id between form versions + +// Gets a list of Agent Activities +GetQualityAgentsActivityRequest.getQualityAgentsActivity(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, startTime: startTime, endTime: endTime, agentUserId: agentUserId, evaluatorUserId: evaluatorUserId, name: name, group: group, formContextId: formContextId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityAgentsActivityRequest.getQualityAgentsActivity was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityCalibration-example.txt b/build/docs/getQualityCalibration-example.txt new file mode 100644 index 000000000..fd970954f --- /dev/null +++ b/build/docs/getQualityCalibration-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let calibrationId: String = "" // Calibration ID +let calibratorId: String = "" // calibratorId +let conversationId: String = "" // conversationId + +// Get a calibration by id. Requires either calibrator id or conversation id +GetQualityCalibrationRequest.getQualityCalibration(calibrationId: calibrationId, calibratorId: calibratorId, conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityCalibrationRequest.getQualityCalibration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityCalibrations-example.txt b/build/docs/getQualityCalibrations-example.txt new file mode 100644 index 000000000..8ebfb7ec5 --- /dev/null +++ b/build/docs/getQualityCalibrations-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let calibratorId: String = "" // user id of calibrator +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let conversationId: String = "" // conversation id +let startTime: Date = new Date(...) // Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let endTime: Date = new Date(...) // end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + +// Get the list of calibrations +GetQualityCalibrationsRequest.getQualityCalibrations(calibratorId: calibratorId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, conversationId: conversationId, startTime: startTime, endTime: endTime) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityCalibrationsRequest.getQualityCalibrations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityConversationEvaluation-example.txt b/build/docs/getQualityConversationEvaluation-example.txt new file mode 100644 index 000000000..07a92f08a --- /dev/null +++ b/build/docs/getQualityConversationEvaluation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let evaluationId: String = "" // evaluationId +let expand: String = "" // agent, assignee, evaluator, evaluationForm + +// Get an evaluation +GetQualityConversationEvaluationRequest.getQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityConversationEvaluationRequest.getQualityConversationEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityConversationSurveys-example.txt b/build/docs/getQualityConversationSurveys-example.txt new file mode 100644 index 000000000..c269f76cb --- /dev/null +++ b/build/docs/getQualityConversationSurveys-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get the surveys for a conversation +GetQualityConversationSurveysRequest.getQualityConversationSurveys(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityConversationSurveysRequest.getQualityConversationSurveys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityConversationsAuditsQueryTransactionId-example.txt b/build/docs/getQualityConversationsAuditsQueryTransactionId-example.txt new file mode 100644 index 000000000..1d0d49d98 --- /dev/null +++ b/build/docs/getQualityConversationsAuditsQueryTransactionId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let transactionId: String = "" // Transaction ID + +// Get status of audit query execution +GetQualityConversationsAuditsQueryTransactionIdRequest.getQualityConversationsAuditsQueryTransactionId(transactionId: transactionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityConversationsAuditsQueryTransactionIdRequest.getQualityConversationsAuditsQueryTransactionId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityConversationsAuditsQueryTransactionIdResults-example.txt b/build/docs/getQualityConversationsAuditsQueryTransactionIdResults-example.txt new file mode 100644 index 000000000..cb0e661d3 --- /dev/null +++ b/build/docs/getQualityConversationsAuditsQueryTransactionIdResults-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let transactionId: String = "" // Transaction ID +let cursor: String = "" // Indicates where to resume query results (not required for first page) +let pageSize: Int = 0 // Page size +let expand: [String] = [""] // Which fields, if any, to expand + +// Get results of audit query +GetQualityConversationsAuditsQueryTransactionIdResultsRequest.getQualityConversationsAuditsQueryTransactionIdResults(transactionId: transactionId, cursor: cursor, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityConversationsAuditsQueryTransactionIdResultsRequest.getQualityConversationsAuditsQueryTransactionIdResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityEvaluationsQuery-example.txt b/build/docs/getQualityEvaluationsQuery-example.txt new file mode 100644 index 000000000..9a1355eb1 --- /dev/null +++ b/build/docs/getQualityEvaluationsQuery-example.txt @@ -0,0 +1,35 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // NOTE: Does not work when querying evaluations +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // NOTE: Does not work when querying evaluations +let previousPage: String = "" // Previous page token +let conversationId: String = "" // conversationId specified +let agentUserId: String = "" // user id of the agent +let evaluatorUserId: String = "" // evaluator user id +let assigneeUserId: String = "" // assignee user id +let queueId: String = "" // queue id +let startTime: String = "" // start time of the evaluation query +let endTime: String = "" // end time of the evaluation query +let formContextId: String = "" // shared id between form versions +let evaluationState: [String] = [""] // +let isReleased: Bool = true // the evaluation has been released +let agentHasRead: Bool = true // agent has the evaluation +let expandAnswerTotalScores: Bool = true // get the total scores for evaluations +let maximum: Int = 0 // the maximum number of results to return +let sortOrder: String = "" // NOTE: Does not work when conversationId is supplied. + +// Queries Evaluations and returns a paged list +GetQualityEvaluationsQueryRequest.getQualityEvaluationsQuery(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, conversationId: conversationId, agentUserId: agentUserId, evaluatorUserId: evaluatorUserId, assigneeUserId: assigneeUserId, queueId: queueId, startTime: startTime, endTime: endTime, formContextId: formContextId, evaluationState: evaluationState, isReleased: isReleased, agentHasRead: agentHasRead, expandAnswerTotalScores: expandAnswerTotalScores, maximum: maximum, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityEvaluationsQueryRequest.getQualityEvaluationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityEvaluatorsActivity-example.txt b/build/docs/getQualityEvaluatorsActivity-example.txt new file mode 100644 index 000000000..a3f268626 --- /dev/null +++ b/build/docs/getQualityEvaluatorsActivity-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let startTime: Date = new Date(...) // The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let endTime: Date = new Date(...) // The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let name: String = "" // Evaluator name +let permission: [String] = [""] // permission strings +let group: String = "" // group id + +// Get an evaluator activity +GetQualityEvaluatorsActivityRequest.getQualityEvaluatorsActivity(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, startTime: startTime, endTime: endTime, name: name, permission: permission, group: group) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityEvaluatorsActivityRequest.getQualityEvaluatorsActivity was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityForm-example.txt b/build/docs/getQualityForm-example.txt new file mode 100644 index 000000000..35d11a042 --- /dev/null +++ b/build/docs/getQualityForm-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get an evaluation form +GetQualityFormRequest.getQualityForm(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormRequest.getQualityForm was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormVersions-example.txt b/build/docs/getQualityFormVersions-example.txt new file mode 100644 index 000000000..77196b97e --- /dev/null +++ b/build/docs/getQualityFormVersions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Gets all the revisions for a specific evaluation. +GetQualityFormVersionsRequest.getQualityFormVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormVersionsRequest.getQualityFormVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityForms-example.txt b/build/docs/getQualityForms-example.txt new file mode 100644 index 000000000..fcd5800a7 --- /dev/null +++ b/build/docs/getQualityForms-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let expand: GetQualityFormsRequest.Expand_getQualityForms = GetQualityFormsRequest.Expand_getQualityForms.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions +let name: String = "" // Name +let sortOrder: String = "" // Order to sort results, either asc or desc + +// Get the list of evaluation forms +GetQualityFormsRequest.getQualityForms(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsRequest.getQualityForms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsEvaluation-example.txt b/build/docs/getQualityFormsEvaluation-example.txt new file mode 100644 index 000000000..9ee13c53e --- /dev/null +++ b/build/docs/getQualityFormsEvaluation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get an evaluation form +GetQualityFormsEvaluationRequest.getQualityFormsEvaluation(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsEvaluationRequest.getQualityFormsEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsEvaluationVersions-example.txt b/build/docs/getQualityFormsEvaluationVersions-example.txt new file mode 100644 index 000000000..ef29b7747 --- /dev/null +++ b/build/docs/getQualityFormsEvaluationVersions-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: String = "" // Sort order + +// Gets all the revisions for a specific evaluation. +GetQualityFormsEvaluationVersionsRequest.getQualityFormsEvaluationVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsEvaluationVersionsRequest.getQualityFormsEvaluationVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsEvaluations-example.txt b/build/docs/getQualityFormsEvaluations-example.txt new file mode 100644 index 000000000..49aaea15e --- /dev/null +++ b/build/docs/getQualityFormsEvaluations-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let expand: GetQualityFormsEvaluationsRequest.Expand_getQualityFormsEvaluations = GetQualityFormsEvaluationsRequest.Expand_getQualityFormsEvaluations.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions +let name: String = "" // Name +let sortOrder: String = "" // Order to sort results, either asc or desc + +// Get the list of evaluation forms +GetQualityFormsEvaluationsRequest.getQualityFormsEvaluations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsEvaluationsRequest.getQualityFormsEvaluations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsEvaluationsBulkContexts-example.txt b/build/docs/getQualityFormsEvaluationsBulkContexts-example.txt new file mode 100644 index 000000000..d146b536e --- /dev/null +++ b/build/docs/getQualityFormsEvaluationsBulkContexts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contextId: [String] = [""] // A comma-delimited list of valid evaluation form context ids + +// Retrieve a list of the latest published evaluation form versions by context ids +GetQualityFormsEvaluationsBulkContextsRequest.getQualityFormsEvaluationsBulkContexts(contextId: contextId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsEvaluationsBulkContextsRequest.getQualityFormsEvaluationsBulkContexts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsSurvey-example.txt b/build/docs/getQualityFormsSurvey-example.txt new file mode 100644 index 000000000..209b5a9b3 --- /dev/null +++ b/build/docs/getQualityFormsSurvey-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get a survey form +GetQualityFormsSurveyRequest.getQualityFormsSurvey(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsSurveyRequest.getQualityFormsSurvey was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsSurveyVersions-example.txt b/build/docs/getQualityFormsSurveyVersions-example.txt new file mode 100644 index 000000000..fa70ee25b --- /dev/null +++ b/build/docs/getQualityFormsSurveyVersions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Gets all the revisions for a specific survey. +GetQualityFormsSurveyVersionsRequest.getQualityFormsSurveyVersions(formId: formId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsSurveyVersionsRequest.getQualityFormsSurveyVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsSurveys-example.txt b/build/docs/getQualityFormsSurveys-example.txt new file mode 100644 index 000000000..f250762c9 --- /dev/null +++ b/build/docs/getQualityFormsSurveys-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let expand: GetQualityFormsSurveysRequest.Expand_getQualityFormsSurveys = GetQualityFormsSurveysRequest.Expand_getQualityFormsSurveys.enummember // If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions +let name: String = "" // Name +let sortOrder: String = "" // Order to sort results, either asc or desc + +// Get the list of survey forms +GetQualityFormsSurveysRequest.getQualityFormsSurveys(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, nextPage: nextPage, previousPage: previousPage, expand: expand, name: name, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsSurveysRequest.getQualityFormsSurveys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsSurveysBulk-example.txt b/build/docs/getQualityFormsSurveysBulk-example.txt new file mode 100644 index 000000000..56b58935f --- /dev/null +++ b/build/docs/getQualityFormsSurveysBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // A comma-delimited list of valid survey form ids + +// Retrieve a list of survey forms by their ids +GetQualityFormsSurveysBulkRequest.getQualityFormsSurveysBulk(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsSurveysBulkRequest.getQualityFormsSurveysBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityFormsSurveysBulkContexts-example.txt b/build/docs/getQualityFormsSurveysBulkContexts-example.txt new file mode 100644 index 000000000..71c73768b --- /dev/null +++ b/build/docs/getQualityFormsSurveysBulkContexts-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contextId: [String] = [""] // A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100. +let published: Bool = true // If true, the latest published version will be included. If false, only the unpublished version will be included. + +// Retrieve a list of the latest form versions by context ids +GetQualityFormsSurveysBulkContextsRequest.getQualityFormsSurveysBulkContexts(contextId: contextId, published: published) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityFormsSurveysBulkContextsRequest.getQualityFormsSurveysBulkContexts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedform-example.txt b/build/docs/getQualityPublishedform-example.txt new file mode 100644 index 000000000..1f2115bf7 --- /dev/null +++ b/build/docs/getQualityPublishedform-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get the published evaluation forms. +GetQualityPublishedformRequest.getQualityPublishedform(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformRequest.getQualityPublishedform was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedforms-example.txt b/build/docs/getQualityPublishedforms-example.txt new file mode 100644 index 000000000..6f498779e --- /dev/null +++ b/build/docs/getQualityPublishedforms-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let onlyLatestPerContext: Bool = true // onlyLatestPerContext + +// Get the published evaluation forms. +GetQualityPublishedformsRequest.getQualityPublishedforms(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestPerContext: onlyLatestPerContext) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformsRequest.getQualityPublishedforms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedformsEvaluation-example.txt b/build/docs/getQualityPublishedformsEvaluation-example.txt new file mode 100644 index 000000000..0afcdff66 --- /dev/null +++ b/build/docs/getQualityPublishedformsEvaluation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get the most recent published version of an evaluation form. +GetQualityPublishedformsEvaluationRequest.getQualityPublishedformsEvaluation(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformsEvaluationRequest.getQualityPublishedformsEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedformsEvaluations-example.txt b/build/docs/getQualityPublishedformsEvaluations-example.txt new file mode 100644 index 000000000..0665c86e9 --- /dev/null +++ b/build/docs/getQualityPublishedformsEvaluations-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let onlyLatestPerContext: Bool = true // onlyLatestPerContext + +// Get the published evaluation forms. +GetQualityPublishedformsEvaluationsRequest.getQualityPublishedformsEvaluations(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestPerContext: onlyLatestPerContext) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformsEvaluationsRequest.getQualityPublishedformsEvaluations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedformsSurvey-example.txt b/build/docs/getQualityPublishedformsSurvey-example.txt new file mode 100644 index 000000000..79fe42296 --- /dev/null +++ b/build/docs/getQualityPublishedformsSurvey-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID + +// Get the most recent published version of a survey form. +GetQualityPublishedformsSurveyRequest.getQualityPublishedformsSurvey(formId: formId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformsSurveyRequest.getQualityPublishedformsSurvey was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualityPublishedformsSurveys-example.txt b/build/docs/getQualityPublishedformsSurveys-example.txt new file mode 100644 index 000000000..e053174c3 --- /dev/null +++ b/build/docs/getQualityPublishedformsSurveys-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let onlyLatestEnabledPerContext: Bool = true // onlyLatestEnabledPerContext + +// Get the published survey forms. +GetQualityPublishedformsSurveysRequest.getQualityPublishedformsSurveys(pageSize: pageSize, pageNumber: pageNumber, name: name, onlyLatestEnabledPerContext: onlyLatestEnabledPerContext) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualityPublishedformsSurveysRequest.getQualityPublishedformsSurveys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualitySurvey-example.txt b/build/docs/getQualitySurvey-example.txt new file mode 100644 index 000000000..4b7539998 --- /dev/null +++ b/build/docs/getQualitySurvey-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let surveyId: String = "" // surveyId + +// Get a survey for a conversation +GetQualitySurveyRequest.getQualitySurvey(surveyId: surveyId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualitySurveyRequest.getQualitySurvey was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getQualitySurveysScorable-example.txt b/build/docs/getQualitySurveysScorable-example.txt new file mode 100644 index 000000000..223cd6418 --- /dev/null +++ b/build/docs/getQualitySurveysScorable-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let customerSurveyUrl: String = "" // customerSurveyUrl + +// Get a survey as an end-customer, for the purposes of scoring it. +GetQualitySurveysScorableRequest.getQualitySurveysScorable(customerSurveyUrl: customerSurveyUrl) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetQualitySurveysScorableRequest.getQualitySurveysScorable was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingBatchrequest-example.txt b/build/docs/getRecordingBatchrequest-example.txt new file mode 100644 index 000000000..8fe207260 --- /dev/null +++ b/build/docs/getRecordingBatchrequest-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Get the status and results for a batch request job, only the user that submitted the job may retrieve results +GetRecordingBatchrequestRequest.getRecordingBatchrequest(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingBatchrequestRequest.getRecordingBatchrequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingCrossplatformMediaretentionpolicies-example.txt b/build/docs/getRecordingCrossplatformMediaretentionpolicies-example.txt new file mode 100644 index 000000000..20d64e2cc --- /dev/null +++ b/build/docs/getRecordingCrossplatformMediaretentionpolicies-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let name: String = "" // the policy name - used for filtering results in searches. +let enabled: Bool = true // checks to see if policy is enabled - use enabled = true or enabled = false +let summary: Bool = true // provides a less verbose response of policy lists. +let hasErrors: Bool = true // provides a way to fetch all policies with errors or policies that do not have errors +let deleteDaysThreshold: Int = 0 // provides a way to fetch all policies with any actions having deleteDays exceeding the provided value + +// Gets media retention policy list with query options to filter on name and enabled. +GetRecordingCrossplatformMediaretentionpoliciesRequest.getRecordingCrossplatformMediaretentionpolicies(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, enabled: enabled, summary: summary, hasErrors: hasErrors, deleteDaysThreshold: deleteDaysThreshold) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingCrossplatformMediaretentionpoliciesRequest.getRecordingCrossplatformMediaretentionpolicies was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingCrossplatformMediaretentionpolicy-example.txt b/build/docs/getRecordingCrossplatformMediaretentionpolicy-example.txt new file mode 100644 index 000000000..2c9c73617 --- /dev/null +++ b/build/docs/getRecordingCrossplatformMediaretentionpolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID + +// Get a media retention policy +GetRecordingCrossplatformMediaretentionpolicyRequest.getRecordingCrossplatformMediaretentionpolicy(policyId: policyId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingCrossplatformMediaretentionpolicyRequest.getRecordingCrossplatformMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingJob-example.txt b/build/docs/getRecordingJob-example.txt new file mode 100644 index 000000000..626f6d6d3 --- /dev/null +++ b/build/docs/getRecordingJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Get the status of the job associated with the job id. +GetRecordingJobRequest.getRecordingJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingJobRequest.getRecordingJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingJobFailedrecordings-example.txt b/build/docs/getRecordingJobFailedrecordings-example.txt new file mode 100644 index 000000000..683b23b7b --- /dev/null +++ b/build/docs/getRecordingJobFailedrecordings-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId +let pageSize: Int = 0 // Page size. Maximum is 100. +let pageNumber: Int = 0 // Page number +let includeTotal: Bool = true // If false, cursor will be used to locate the page instead of pageNumber. +let cursor: String = "" // Indicates where to resume query results (not required for first page) + +// Get IDs of recordings that the bulk job failed for +GetRecordingJobFailedrecordingsRequest.getRecordingJobFailedrecordings(jobId: jobId, pageSize: pageSize, pageNumber: pageNumber, includeTotal: includeTotal, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingJobFailedrecordingsRequest.getRecordingJobFailedrecordings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingJobs-example.txt b/build/docs/getRecordingJobs-example.txt new file mode 100644 index 000000000..eed806d6c --- /dev/null +++ b/build/docs/getRecordingJobs-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: GetRecordingJobsRequest.SortBy_getRecordingJobs = GetRecordingJobsRequest.SortBy_getRecordingJobs.enummember // Sort by +let state: GetRecordingJobsRequest.State_getRecordingJobs = GetRecordingJobsRequest.State_getRecordingJobs.enummember // Filter by state +let showOnlyMyJobs: Bool = true // Show only my jobs +let jobType: GetRecordingJobsRequest.JobType_getRecordingJobs = GetRecordingJobsRequest.JobType_getRecordingJobs.enummember // Job Type (Can be left empty for both) +let includeTotal: Bool = true // If false, cursor will be used to locate the page instead of pageNumber. +let cursor: String = "" // Indicates where to resume query results (not required for first page) + +// Get the status of all jobs within the user's organization +GetRecordingJobsRequest.getRecordingJobs(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, state: state, showOnlyMyJobs: showOnlyMyJobs, jobType: jobType, includeTotal: includeTotal, cursor: cursor) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingJobsRequest.getRecordingJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingKeyconfiguration-example.txt b/build/docs/getRecordingKeyconfiguration-example.txt new file mode 100644 index 000000000..2b076f827 --- /dev/null +++ b/build/docs/getRecordingKeyconfiguration-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let keyConfigurationId: String = "" // Key Configurations Id + +// Get the encryption key configurations +GetRecordingKeyconfigurationRequest.getRecordingKeyconfiguration(keyConfigurationId: keyConfigurationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingKeyconfigurationRequest.getRecordingKeyconfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingKeyconfigurations-example.txt b/build/docs/getRecordingKeyconfigurations-example.txt new file mode 100644 index 000000000..9ee122038 --- /dev/null +++ b/build/docs/getRecordingKeyconfigurations-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of key configurations data +GetRecordingKeyconfigurationsRequest.getRecordingKeyconfigurations() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingKeyconfigurationsRequest.getRecordingKeyconfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingMediaretentionpolicies-example.txt b/build/docs/getRecordingMediaretentionpolicies-example.txt new file mode 100644 index 000000000..15b99c4e9 --- /dev/null +++ b/build/docs/getRecordingMediaretentionpolicies-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let name: String = "" // the policy name - used for filtering results in searches. +let enabled: Bool = true // checks to see if policy is enabled - use enabled = true or enabled = false +let summary: Bool = true // provides a less verbose response of policy lists. +let hasErrors: Bool = true // provides a way to fetch all policies with errors or policies that do not have errors +let deleteDaysThreshold: Int = 0 // provides a way to fetch all policies with any actions having deleteDays exceeding the provided value + +// Gets media retention policy list with query options to filter on name and enabled. +GetRecordingMediaretentionpoliciesRequest.getRecordingMediaretentionpolicies(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, name: name, enabled: enabled, summary: summary, hasErrors: hasErrors, deleteDaysThreshold: deleteDaysThreshold) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingMediaretentionpoliciesRequest.getRecordingMediaretentionpolicies was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingMediaretentionpolicy-example.txt b/build/docs/getRecordingMediaretentionpolicy-example.txt new file mode 100644 index 000000000..6cb829ab2 --- /dev/null +++ b/build/docs/getRecordingMediaretentionpolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID + +// Get a media retention policy +GetRecordingMediaretentionpolicyRequest.getRecordingMediaretentionpolicy(policyId: policyId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingMediaretentionpolicyRequest.getRecordingMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingRecordingkeys-example.txt b/build/docs/getRecordingRecordingkeys-example.txt new file mode 100644 index 000000000..27e4ad126 --- /dev/null +++ b/build/docs/getRecordingRecordingkeys-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get encryption key list +GetRecordingRecordingkeysRequest.getRecordingRecordingkeys(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingRecordingkeysRequest.getRecordingRecordingkeys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingRecordingkeysRotationschedule-example.txt b/build/docs/getRecordingRecordingkeysRotationschedule-example.txt new file mode 100644 index 000000000..fb316da94 --- /dev/null +++ b/build/docs/getRecordingRecordingkeysRotationschedule-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get key rotation schedule +GetRecordingRecordingkeysRotationscheduleRequest.getRecordingRecordingkeysRotationschedule() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingRecordingkeysRotationscheduleRequest.getRecordingRecordingkeysRotationschedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingSettings-example.txt b/build/docs/getRecordingSettings-example.txt new file mode 100644 index 000000000..c6c9a5726 --- /dev/null +++ b/build/docs/getRecordingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let createDefault: Bool = true // If no settings are found, a new one is created with default values + +// Get the Recording Settings for the Organization +GetRecordingSettingsRequest.getRecordingSettings(createDefault: createDefault) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingSettingsRequest.getRecordingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingUploadsReport-example.txt b/build/docs/getRecordingUploadsReport-example.txt new file mode 100644 index 000000000..cbcc7cf99 --- /dev/null +++ b/build/docs/getRecordingUploadsReport-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let reportId: String = "" // reportId + +// Get the status of a recording upload status report +GetRecordingUploadsReportRequest.getRecordingUploadsReport(reportId: reportId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingUploadsReportRequest.getRecordingUploadsReport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingsRetentionQuery-example.txt b/build/docs/getRecordingsRetentionQuery-example.txt new file mode 100644 index 000000000..c37ed5cbd --- /dev/null +++ b/build/docs/getRecordingsRetentionQuery-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let retentionThresholdDays: Int = 0 // Fetch retention data for recordings retained for more days than the provided value. +let cursor: String = "" // Indicates where to resume query results (not required for first page) +let pageSize: Int = 0 // Page size. Maximum is 500. + +// Query for recording retention data +GetRecordingsRetentionQueryRequest.getRecordingsRetentionQuery(retentionThresholdDays: retentionThresholdDays, cursor: cursor, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingsRetentionQueryRequest.getRecordingsRetentionQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRecordingsScreensessions-example.txt b/build/docs/getRecordingsScreensessions-example.txt new file mode 100644 index 000000000..f4de744c4 --- /dev/null +++ b/build/docs/getRecordingsScreensessions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Retrieves a paged listing of screen recording sessions +GetRecordingsScreensessionsRequest.getRecordingsScreensessions(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRecordingsScreensessionsRequest.getRecordingsScreensessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementLibraries-example.txt b/build/docs/getResponsemanagementLibraries-example.txt new file mode 100644 index 000000000..a2cb6c8e3 --- /dev/null +++ b/build/docs/getResponsemanagementLibraries-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let messagingTemplateFilter: GetResponsemanagementLibrariesRequest.MessagingTemplateFilter_getResponsemanagementLibraries = GetResponsemanagementLibrariesRequest.MessagingTemplateFilter_getResponsemanagementLibraries.enummember // Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel +let libraryPrefix: String = "" // Returns a list of libraries that contain the prefix provided + +// Gets a list of existing response libraries. +GetResponsemanagementLibrariesRequest.getResponsemanagementLibraries(pageNumber: pageNumber, pageSize: pageSize, messagingTemplateFilter: messagingTemplateFilter, libraryPrefix: libraryPrefix) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementLibrariesRequest.getResponsemanagementLibraries was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementLibrary-example.txt b/build/docs/getResponsemanagementLibrary-example.txt new file mode 100644 index 000000000..2b24a8a93 --- /dev/null +++ b/build/docs/getResponsemanagementLibrary-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let libraryId: String = "" // Library ID + +// Get details about an existing response library. +GetResponsemanagementLibraryRequest.getResponsemanagementLibrary(libraryId: libraryId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementLibraryRequest.getResponsemanagementLibrary was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementResponse-example.txt b/build/docs/getResponsemanagementResponse-example.txt new file mode 100644 index 000000000..26d35791c --- /dev/null +++ b/build/docs/getResponsemanagementResponse-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseId: String = "" // Response ID +let expand: GetResponsemanagementResponseRequest.Expand_getResponsemanagementResponse = GetResponsemanagementResponseRequest.Expand_getResponsemanagementResponse.enummember // Expand instructions for the return value. + +// Get details about an existing response. +GetResponsemanagementResponseRequest.getResponsemanagementResponse(responseId: responseId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementResponseRequest.getResponsemanagementResponse was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementResponseasset-example.txt b/build/docs/getResponsemanagementResponseasset-example.txt new file mode 100644 index 000000000..3bb29afb4 --- /dev/null +++ b/build/docs/getResponsemanagementResponseasset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseAssetId: String = "" // Asset Id + +// Get response asset information +GetResponsemanagementResponseassetRequest.getResponsemanagementResponseasset(responseAssetId: responseAssetId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementResponseassetRequest.getResponsemanagementResponseasset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementResponseassetsStatusStatusId-example.txt b/build/docs/getResponsemanagementResponseassetsStatusStatusId-example.txt new file mode 100644 index 000000000..22b262f08 --- /dev/null +++ b/build/docs/getResponsemanagementResponseassetsStatusStatusId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let statusId: String = "" // Status Id + +// Get response asset upload status +GetResponsemanagementResponseassetsStatusStatusIdRequest.getResponsemanagementResponseassetsStatusStatusId(statusId: statusId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementResponseassetsStatusStatusIdRequest.getResponsemanagementResponseassetsStatusStatusId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getResponsemanagementResponses-example.txt b/build/docs/getResponsemanagementResponses-example.txt new file mode 100644 index 000000000..59805163a --- /dev/null +++ b/build/docs/getResponsemanagementResponses-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let libraryId: String = "" // Library ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let expand: GetResponsemanagementResponsesRequest.Expand_getResponsemanagementResponses = GetResponsemanagementResponsesRequest.Expand_getResponsemanagementResponses.enummember // Expand instructions for the return value. + +// Gets a list of existing responses. +GetResponsemanagementResponsesRequest.getResponsemanagementResponses(libraryId: libraryId, pageNumber: pageNumber, pageSize: pageSize, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetResponsemanagementResponsesRequest.getResponsemanagementResponses was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingAssessment-example.txt b/build/docs/getRoutingAssessment-example.txt new file mode 100644 index 000000000..c08f0640e --- /dev/null +++ b/build/docs/getRoutingAssessment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assessmentId: String = "" // Benefit Assessment ID + +// Retrieve a single benefit assessment. +GetRoutingAssessmentRequest.getRoutingAssessment(assessmentId: assessmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingAssessmentRequest.getRoutingAssessment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingAssessments-example.txt b/build/docs/getRoutingAssessments-example.txt new file mode 100644 index 000000000..4f116e3b5 --- /dev/null +++ b/build/docs/getRoutingAssessments-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let queueId: [String] = [""] // Queue ID(s) to filter assessments by. + +// Retrieve all benefit assessments. +GetRoutingAssessmentsRequest.getRoutingAssessments(before: before, after: after, limit: limit, pageSize: pageSize, queueId: queueId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingAssessmentsRequest.getRoutingAssessments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingAssessmentsJob-example.txt b/build/docs/getRoutingAssessmentsJob-example.txt new file mode 100644 index 000000000..0add1535f --- /dev/null +++ b/build/docs/getRoutingAssessmentsJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // Benefit Assessment Job ID + +// Retrieve a single benefit assessments job. +GetRoutingAssessmentsJobRequest.getRoutingAssessmentsJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingAssessmentsJobRequest.getRoutingAssessmentsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingAssessmentsJobs-example.txt b/build/docs/getRoutingAssessmentsJobs-example.txt new file mode 100644 index 000000000..d3eaffcd1 --- /dev/null +++ b/build/docs/getRoutingAssessmentsJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: [String] = [""] // Division ID(s) to filter assessment jobs by. + +// Retrieve all benefit assessment jobs. +GetRoutingAssessmentsJobsRequest.getRoutingAssessmentsJobs(divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingAssessmentsJobsRequest.getRoutingAssessmentsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingAvailablemediatypes-example.txt b/build/docs/getRoutingAvailablemediatypes-example.txt new file mode 100644 index 000000000..e18940603 --- /dev/null +++ b/build/docs/getRoutingAvailablemediatypes-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get available media types +GetRoutingAvailablemediatypesRequest.getRoutingAvailablemediatypes() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingAvailablemediatypesRequest.getRoutingAvailablemediatypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailDomain-example.txt b/build/docs/getRoutingEmailDomain-example.txt new file mode 100644 index 000000000..f5972731a --- /dev/null +++ b/build/docs/getRoutingEmailDomain-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Get domain +GetRoutingEmailDomainRequest.getRoutingEmailDomain(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailDomainRequest.getRoutingEmailDomain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailDomainRoute-example.txt b/build/docs/getRoutingEmailDomainRoute-example.txt new file mode 100644 index 000000000..2292ad194 --- /dev/null +++ b/build/docs/getRoutingEmailDomainRoute-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainName: String = "" // email domain +let routeId: String = "" // route ID + +// Get a route +GetRoutingEmailDomainRouteRequest.getRoutingEmailDomainRoute(domainName: domainName, routeId: routeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailDomainRouteRequest.getRoutingEmailDomainRoute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailDomainRoutes-example.txt b/build/docs/getRoutingEmailDomainRoutes-example.txt new file mode 100644 index 000000000..1937cce16 --- /dev/null +++ b/build/docs/getRoutingEmailDomainRoutes-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainName: String = "" // email domain +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let pattern: String = "" // Filter routes by the route's pattern property + +// Get routes +GetRoutingEmailDomainRoutesRequest.getRoutingEmailDomainRoutes(domainName: domainName, pageSize: pageSize, pageNumber: pageNumber, pattern: pattern) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailDomainRoutesRequest.getRoutingEmailDomainRoutes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailDomains-example.txt b/build/docs/getRoutingEmailDomains-example.txt new file mode 100644 index 000000000..a863a4019 --- /dev/null +++ b/build/docs/getRoutingEmailDomains-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let excludeStatus: Bool = true // Exclude MX record data +let filter: String = "" // Optional search filter + +// Get domains +GetRoutingEmailDomainsRequest.getRoutingEmailDomains(pageSize: pageSize, pageNumber: pageNumber, excludeStatus: excludeStatus, filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailDomainsRequest.getRoutingEmailDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailOutboundDomain-example.txt b/build/docs/getRoutingEmailOutboundDomain-example.txt new file mode 100644 index 000000000..aba383567 --- /dev/null +++ b/build/docs/getRoutingEmailOutboundDomain-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Get domain +GetRoutingEmailOutboundDomainRequest.getRoutingEmailOutboundDomain(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailOutboundDomainRequest.getRoutingEmailOutboundDomain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailOutboundDomainActivation-example.txt b/build/docs/getRoutingEmailOutboundDomainActivation-example.txt new file mode 100644 index 000000000..9c428e4eb --- /dev/null +++ b/build/docs/getRoutingEmailOutboundDomainActivation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Get activation status (cname + dkim) of an outbound domain +GetRoutingEmailOutboundDomainActivationRequest.getRoutingEmailOutboundDomainActivation(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailOutboundDomainActivationRequest.getRoutingEmailOutboundDomainActivation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailOutboundDomainSearch-example.txt b/build/docs/getRoutingEmailOutboundDomainSearch-example.txt new file mode 100644 index 000000000..df11b8e25 --- /dev/null +++ b/build/docs/getRoutingEmailOutboundDomainSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Search a domain across organizations +GetRoutingEmailOutboundDomainSearchRequest.getRoutingEmailOutboundDomainSearch(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailOutboundDomainSearchRequest.getRoutingEmailOutboundDomainSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailOutboundDomains-example.txt b/build/docs/getRoutingEmailOutboundDomains-example.txt new file mode 100644 index 000000000..c35efa141 --- /dev/null +++ b/build/docs/getRoutingEmailOutboundDomains-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filter: String = "" // Optional search filter + +// Get outbound domains +GetRoutingEmailOutboundDomainsRequest.getRoutingEmailOutboundDomains(filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailOutboundDomainsRequest.getRoutingEmailOutboundDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingEmailSetup-example.txt b/build/docs/getRoutingEmailSetup-example.txt new file mode 100644 index 000000000..e0d5b314f --- /dev/null +++ b/build/docs/getRoutingEmailSetup-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get email setup +GetRoutingEmailSetupRequest.getRoutingEmailSetup() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingEmailSetupRequest.getRoutingEmailSetup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingLanguage-example.txt b/build/docs/getRoutingLanguage-example.txt new file mode 100644 index 000000000..a0cf76849 --- /dev/null +++ b/build/docs/getRoutingLanguage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let languageId: String = "" // Language ID + +// Get a routing language +GetRoutingLanguageRequest.getRoutingLanguage(languageId: languageId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingLanguageRequest.getRoutingLanguage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingLanguages-example.txt b/build/docs/getRoutingLanguages-example.txt new file mode 100644 index 000000000..988d9c19a --- /dev/null +++ b/build/docs/getRoutingLanguages-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetRoutingLanguagesRequest.SortOrder_getRoutingLanguages = GetRoutingLanguagesRequest.SortOrder_getRoutingLanguages.enummember // Ascending or descending sort order +let name: String = "" // Name +let _id: [String] = [""] // id + +// Get the list of supported languages. +GetRoutingLanguagesRequest.getRoutingLanguages(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, name: name, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingLanguagesRequest.getRoutingLanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingMessageRecipient-example.txt b/build/docs/getRoutingMessageRecipient-example.txt new file mode 100644 index 000000000..e8e38d830 --- /dev/null +++ b/build/docs/getRoutingMessageRecipient-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recipientId: String = "" // Recipient ID + +// Get a recipient +GetRoutingMessageRecipientRequest.getRoutingMessageRecipient(recipientId: recipientId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingMessageRecipientRequest.getRoutingMessageRecipient was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingMessageRecipients-example.txt b/build/docs/getRoutingMessageRecipients-example.txt new file mode 100644 index 000000000..bb36c87b3 --- /dev/null +++ b/build/docs/getRoutingMessageRecipients-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messengerType: GetRoutingMessageRecipientsRequest.MessengerType_getRoutingMessageRecipients = GetRoutingMessageRecipientsRequest.MessengerType_getRoutingMessageRecipients.enummember // Messenger Type +let name: String = "" // Recipient Name +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get recipients +GetRoutingMessageRecipientsRequest.getRoutingMessageRecipients(messengerType: messengerType, name: name, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingMessageRecipientsRequest.getRoutingMessageRecipients was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingPredictor-example.txt b/build/docs/getRoutingPredictor-example.txt new file mode 100644 index 000000000..696dc4a06 --- /dev/null +++ b/build/docs/getRoutingPredictor-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // Predictor ID + +// Retrieve a single predictor. +GetRoutingPredictorRequest.getRoutingPredictor(predictorId: predictorId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingPredictorRequest.getRoutingPredictor was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingPredictorModelFeatures-example.txt b/build/docs/getRoutingPredictorModelFeatures-example.txt new file mode 100644 index 000000000..937ac9488 --- /dev/null +++ b/build/docs/getRoutingPredictorModelFeatures-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // Predictor ID +let modelId: String = "" // Model ID + +// Retrieve Predictor Model Features. +GetRoutingPredictorModelFeaturesRequest.getRoutingPredictorModelFeatures(predictorId: predictorId, modelId: modelId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingPredictorModelFeaturesRequest.getRoutingPredictorModelFeatures was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingPredictorModels-example.txt b/build/docs/getRoutingPredictorModels-example.txt new file mode 100644 index 000000000..7fba368de --- /dev/null +++ b/build/docs/getRoutingPredictorModels-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // Predictor ID + +// Retrieve Predictor Models and Top Features. +GetRoutingPredictorModelsRequest.getRoutingPredictorModels(predictorId: predictorId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingPredictorModelsRequest.getRoutingPredictorModels was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingPredictors-example.txt b/build/docs/getRoutingPredictors-example.txt new file mode 100644 index 000000000..59e7d7836 --- /dev/null +++ b/build/docs/getRoutingPredictors-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let before: String = "" // The cursor that points to the start of the set of entities that has been returned. +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let limit: String = "" // Number of entities to return. Maximum of 200. Deprecated in favour of pageSize +let pageSize: String = "" // Number of entities to return. Maximum of 200. +let queueId: [String] = [""] // Comma-separated list of queue Ids to filter by. + +// Retrieve all predictors. +GetRoutingPredictorsRequest.getRoutingPredictors(before: before, after: after, limit: limit, pageSize: pageSize, queueId: queueId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingPredictorsRequest.getRoutingPredictors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingPredictorsKeyperformanceindicators-example.txt b/build/docs/getRoutingPredictorsKeyperformanceindicators-example.txt new file mode 100644 index 000000000..296c9c820 --- /dev/null +++ b/build/docs/getRoutingPredictorsKeyperformanceindicators-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let kpiGroup: GetRoutingPredictorsKeyperformanceindicatorsRequest.KpiGroup_getRoutingPredictorsKeyperformanceindicators = GetRoutingPredictorsKeyperformanceindicatorsRequest.KpiGroup_getRoutingPredictorsKeyperformanceindicators.enummember // The Group of Key Performance Indicators to return +let expand: [String] = [""] // Parameter to request additional data to return in KPI payload + +// Get a list of Key Performance Indicators +GetRoutingPredictorsKeyperformanceindicatorsRequest.getRoutingPredictorsKeyperformanceindicators(kpiGroup: kpiGroup, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingPredictorsKeyperformanceindicatorsRequest.getRoutingPredictorsKeyperformanceindicators was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueue-example.txt b/build/docs/getRoutingQueue-example.txt new file mode 100644 index 000000000..ddd23c7ec --- /dev/null +++ b/build/docs/getRoutingQueue-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID + +// Get details about this queue. +GetRoutingQueueRequest.getRoutingQueue(queueId: queueId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueRequest.getRoutingQueue was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueComparisonperiod-example.txt b/build/docs/getRoutingQueueComparisonperiod-example.txt new file mode 100644 index 000000000..4ac43ea3a --- /dev/null +++ b/build/docs/getRoutingQueueComparisonperiod-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue id +let comparisonPeriodId: String = "" // ComparisonPeriod id + +// Get a Comparison Period. +GetRoutingQueueComparisonperiodRequest.getRoutingQueueComparisonperiod(queueId: queueId, comparisonPeriodId: comparisonPeriodId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueComparisonperiodRequest.getRoutingQueueComparisonperiod was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueComparisonperiods-example.txt b/build/docs/getRoutingQueueComparisonperiods-example.txt new file mode 100644 index 000000000..86d704830 --- /dev/null +++ b/build/docs/getRoutingQueueComparisonperiods-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue id + +// Get list of comparison periods +GetRoutingQueueComparisonperiodsRequest.getRoutingQueueComparisonperiods(queueId: queueId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueComparisonperiodsRequest.getRoutingQueueComparisonperiods was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueEstimatedwaittime-example.txt b/build/docs/getRoutingQueueEstimatedwaittime-example.txt new file mode 100644 index 000000000..e4218fd57 --- /dev/null +++ b/build/docs/getRoutingQueueEstimatedwaittime-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // queueId +let conversationId: String = "" // conversationId + +// Get Estimated Wait Time +GetRoutingQueueEstimatedwaittimeRequest.getRoutingQueueEstimatedwaittime(queueId: queueId, conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueEstimatedwaittimeRequest.getRoutingQueueEstimatedwaittime was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueMediatypeEstimatedwaittime-example.txt b/build/docs/getRoutingQueueMediatypeEstimatedwaittime-example.txt new file mode 100644 index 000000000..8440e39bb --- /dev/null +++ b/build/docs/getRoutingQueueMediatypeEstimatedwaittime-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // queueId +let mediaType: String = "" // mediaType + +// Get Estimated Wait Time +GetRoutingQueueMediatypeEstimatedwaittimeRequest.getRoutingQueueMediatypeEstimatedwaittime(queueId: queueId, mediaType: mediaType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueMediatypeEstimatedwaittimeRequest.getRoutingQueueMediatypeEstimatedwaittime was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueMembers-example.txt b/build/docs/getRoutingQueueMembers-example.txt new file mode 100644 index 000000000..e7f336bc8 --- /dev/null +++ b/build/docs/getRoutingQueueMembers-example.txt @@ -0,0 +1,28 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let pageNumber: Int = 0 // +let pageSize: Int = 0 // Max value is 100 +let sortOrder: GetRoutingQueueMembersRequest.SortOrder_getRoutingQueueMembers = GetRoutingQueueMembersRequest.SortOrder_getRoutingQueueMembers.enummember // Note: results are sorted by name. +let expand: [String] = [""] // Which fields, if any, to expand. +let name: String = "" // Filter by queue member name (contains-style search) +let profileSkills: [String] = [""] // Filter by profile skill (contains-style search) +let skills: [String] = [""] // Filter by skill (contains-style search) +let languages: [String] = [""] // Filter by language (contains-style search) +let routingStatus: [String] = [""] // Filter by routing status +let presence: [String] = [""] // Filter by presence +let memberBy: GetRoutingQueueMembersRequest.MemberBy_getRoutingQueueMembers = GetRoutingQueueMembersRequest.MemberBy_getRoutingQueueMembers.enummember // Filter by member type +let joined: Bool = true // Filter by joined status + +// Get the members of this queue. +GetRoutingQueueMembersRequest.getRoutingQueueMembers(queueId: queueId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, expand: expand, name: name, profileSkills: profileSkills, skills: skills, languages: languages, routingStatus: routingStatus, presence: presence, memberBy: memberBy, joined: joined) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueMembersRequest.getRoutingQueueMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueUsers-example.txt b/build/docs/getRoutingQueueUsers-example.txt new file mode 100644 index 000000000..5ffe53895 --- /dev/null +++ b/build/docs/getRoutingQueueUsers-example.txt @@ -0,0 +1,27 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let pageNumber: Int = 0 // +let pageSize: Int = 0 // Max value is 100 +let sortOrder: GetRoutingQueueUsersRequest.SortOrder_getRoutingQueueUsers = GetRoutingQueueUsersRequest.SortOrder_getRoutingQueueUsers.enummember // Note: results are sorted by name. +let expand: [String] = [""] // Which fields, if any, to expand. +let joined: Bool = true // Filter by joined status +let name: String = "" // Filter by queue member name +let profileSkills: [String] = [""] // Filter by profile skill +let skills: [String] = [""] // Filter by skill +let languages: [String] = [""] // Filter by language +let routingStatus: [String] = [""] // Filter by routing status +let presence: [String] = [""] // Filter by presence + +// DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue. +GetRoutingQueueUsersRequest.getRoutingQueueUsers(queueId: queueId, pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, expand: expand, joined: joined, name: name, profileSkills: profileSkills, skills: skills, languages: languages, routingStatus: routingStatus, presence: presence) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueUsersRequest.getRoutingQueueUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueueWrapupcodes-example.txt b/build/docs/getRoutingQueueWrapupcodes-example.txt new file mode 100644 index 000000000..3d35411fe --- /dev/null +++ b/build/docs/getRoutingQueueWrapupcodes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get the wrap-up codes for a queue +GetRoutingQueueWrapupcodesRequest.getRoutingQueueWrapupcodes(queueId: queueId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueueWrapupcodesRequest.getRoutingQueueWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueues-example.txt b/build/docs/getRoutingQueues-example.txt new file mode 100644 index 000000000..c061b466b --- /dev/null +++ b/build/docs/getRoutingQueues-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortOrder: GetRoutingQueuesRequest.SortOrder_getRoutingQueues = GetRoutingQueuesRequest.SortOrder_getRoutingQueues.enummember // Note: results are sorted by name. +let name: String = "" // Filter by queue name +let _id: [String] = [""] // Filter by queue ID(s) +let divisionId: [String] = [""] // Filter by queue division ID(s) +let peerId: [String] = [""] // Filter by queue peer ID(s) +let hasPeer: Bool = true // Filter by queues associated with peer + +// Get list of queues. +GetRoutingQueuesRequest.getRoutingQueues(pageNumber: pageNumber, pageSize: pageSize, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId, peerId: peerId, hasPeer: hasPeer) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueuesRequest.getRoutingQueues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueuesDivisionviews-example.txt b/build/docs/getRoutingQueuesDivisionviews-example.txt new file mode 100644 index 000000000..e33c07b4a --- /dev/null +++ b/build/docs/getRoutingQueuesDivisionviews-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size [max value is 100] +let pageNumber: Int = 0 // Page number [max value is 5] +let sortBy: GetRoutingQueuesDivisionviewsRequest.SortBy_getRoutingQueuesDivisionviews = GetRoutingQueuesDivisionviewsRequest.SortBy_getRoutingQueuesDivisionviews.enummember // Sort by +let sortOrder: GetRoutingQueuesDivisionviewsRequest.SortOrder_getRoutingQueuesDivisionviews = GetRoutingQueuesDivisionviewsRequest.SortOrder_getRoutingQueuesDivisionviews.enummember // Sort order +let name: String = "" // Name +let _id: [String] = [""] // Queue ID(s) +let divisionId: [String] = [""] // Division ID(s) + +// Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s). +GetRoutingQueuesDivisionviewsRequest.getRoutingQueuesDivisionviews(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueuesDivisionviewsRequest.getRoutingQueuesDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueuesDivisionviewsAll-example.txt b/build/docs/getRoutingQueuesDivisionviewsAll-example.txt new file mode 100644 index 000000000..c15ac8687 --- /dev/null +++ b/build/docs/getRoutingQueuesDivisionviewsAll-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size [max value is 500] +let pageNumber: Int = 0 // Page number +let sortOrder: GetRoutingQueuesDivisionviewsAllRequest.SortOrder_getRoutingQueuesDivisionviewsAll = GetRoutingQueuesDivisionviewsAllRequest.SortOrder_getRoutingQueuesDivisionviewsAll.enummember // Sort order + +// Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization. +GetRoutingQueuesDivisionviewsAllRequest.getRoutingQueuesDivisionviewsAll(pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueuesDivisionviewsAllRequest.getRoutingQueuesDivisionviewsAll was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingQueuesMe-example.txt b/build/docs/getRoutingQueuesMe-example.txt new file mode 100644 index 000000000..de3a9e4ee --- /dev/null +++ b/build/docs/getRoutingQueuesMe-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let joined: Bool = true // Filter by joined status. +let sortOrder: GetRoutingQueuesMeRequest.SortOrder_getRoutingQueuesMe = GetRoutingQueuesMeRequest.SortOrder_getRoutingQueuesMe.enummember // Note: results are sorted by name. + +// Get a paged listing of queues the user is a member of. +GetRoutingQueuesMeRequest.getRoutingQueuesMe(pageNumber: pageNumber, pageSize: pageSize, joined: joined, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingQueuesMeRequest.getRoutingQueuesMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSettings-example.txt b/build/docs/getRoutingSettings-example.txt new file mode 100644 index 000000000..6045918f3 --- /dev/null +++ b/build/docs/getRoutingSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get an organization's routing settings +GetRoutingSettingsRequest.getRoutingSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSettingsRequest.getRoutingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSettingsContactcenter-example.txt b/build/docs/getRoutingSettingsContactcenter-example.txt new file mode 100644 index 000000000..c39346e76 --- /dev/null +++ b/build/docs/getRoutingSettingsContactcenter-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Contact Center Settings +GetRoutingSettingsContactcenterRequest.getRoutingSettingsContactcenter() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSettingsContactcenterRequest.getRoutingSettingsContactcenter was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSettingsTranscription-example.txt b/build/docs/getRoutingSettingsTranscription-example.txt new file mode 100644 index 000000000..0960d043b --- /dev/null +++ b/build/docs/getRoutingSettingsTranscription-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Transcription Settings +GetRoutingSettingsTranscriptionRequest.getRoutingSettingsTranscription() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSettingsTranscriptionRequest.getRoutingSettingsTranscription was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkill-example.txt b/build/docs/getRoutingSkill-example.txt new file mode 100644 index 000000000..db434dcad --- /dev/null +++ b/build/docs/getRoutingSkill-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillId: String = "" // Skill ID + +// Get Routing Skill +GetRoutingSkillRequest.getRoutingSkill(skillId: skillId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillRequest.getRoutingSkill was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkillgroup-example.txt b/build/docs/getRoutingSkillgroup-example.txt new file mode 100644 index 000000000..30b1d48a8 --- /dev/null +++ b/build/docs/getRoutingSkillgroup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID + +// Get skill group +GetRoutingSkillgroupRequest.getRoutingSkillgroup(skillGroupId: skillGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillgroupRequest.getRoutingSkillgroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkillgroupMembers-example.txt b/build/docs/getRoutingSkillgroupMembers-example.txt new file mode 100644 index 000000000..a79462cf0 --- /dev/null +++ b/build/docs/getRoutingSkillgroupMembers-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID +let pageSize: Int = 0 // Page size +let after: String = "" // The cursor that points to the next item +let before: String = "" // The cursor that points to the previous item +let expand: GetRoutingSkillgroupMembersRequest.Expand_getRoutingSkillgroupMembers = GetRoutingSkillgroupMembersRequest.Expand_getRoutingSkillgroupMembers.enummember // Expand the name on each user + +// Get skill group members +GetRoutingSkillgroupMembersRequest.getRoutingSkillgroupMembers(skillGroupId: skillGroupId, pageSize: pageSize, after: after, before: before, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillgroupMembersRequest.getRoutingSkillgroupMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkillgroupMembersDivisions-example.txt b/build/docs/getRoutingSkillgroupMembersDivisions-example.txt new file mode 100644 index 000000000..0152083c3 --- /dev/null +++ b/build/docs/getRoutingSkillgroupMembersDivisions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID +let expand: GetRoutingSkillgroupMembersDivisionsRequest.Expand_getRoutingSkillgroupMembersDivisions = GetRoutingSkillgroupMembersDivisionsRequest.Expand_getRoutingSkillgroupMembersDivisions.enummember // Expand the name on each user + +// Get list of member divisions for this skill group. +GetRoutingSkillgroupMembersDivisionsRequest.getRoutingSkillgroupMembersDivisions(skillGroupId: skillGroupId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillgroupMembersDivisionsRequest.getRoutingSkillgroupMembersDivisions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkillgroups-example.txt b/build/docs/getRoutingSkillgroups-example.txt new file mode 100644 index 000000000..9b5321e1d --- /dev/null +++ b/build/docs/getRoutingSkillgroups-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let name: String = "" // Return only skill group names whose names start with this value (case-insensitive matching) +let after: String = "" // The cursor that points to the next item +let before: String = "" // The cursor that points to the previous item + +// Get skill group listing +GetRoutingSkillgroupsRequest.getRoutingSkillgroups(pageSize: pageSize, name: name, after: after, before: before) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillgroupsRequest.getRoutingSkillgroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSkills-example.txt b/build/docs/getRoutingSkills-example.txt new file mode 100644 index 000000000..91e93872a --- /dev/null +++ b/build/docs/getRoutingSkills-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Filter for results that start with this value +let _id: [String] = [""] // id + +// Get the list of routing skills. +GetRoutingSkillsRequest.getRoutingSkills(pageSize: pageSize, pageNumber: pageNumber, name: name, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSkillsRequest.getRoutingSkills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSmsAddress-example.txt b/build/docs/getRoutingSmsAddress-example.txt new file mode 100644 index 000000000..86088bd2b --- /dev/null +++ b/build/docs/getRoutingSmsAddress-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let addressId: String = "" // Address ID + +// Get an Address by Id for SMS +GetRoutingSmsAddressRequest.getRoutingSmsAddress(addressId: addressId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSmsAddressRequest.getRoutingSmsAddress was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSmsAddresses-example.txt b/build/docs/getRoutingSmsAddresses-example.txt new file mode 100644 index 000000000..1323f4b86 --- /dev/null +++ b/build/docs/getRoutingSmsAddresses-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of Addresses for SMS +GetRoutingSmsAddressesRequest.getRoutingSmsAddresses(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSmsAddressesRequest.getRoutingSmsAddresses was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSmsAvailablephonenumbers-example.txt b/build/docs/getRoutingSmsAvailablephonenumbers-example.txt new file mode 100644 index 000000000..18413931d --- /dev/null +++ b/build/docs/getRoutingSmsAvailablephonenumbers-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let countryCode: String = "" // The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned +let phoneNumberType: GetRoutingSmsAvailablephonenumbersRequest.PhoneNumberType_getRoutingSmsAvailablephonenumbers = GetRoutingSmsAvailablephonenumbersRequest.PhoneNumberType_getRoutingSmsAvailablephonenumbers.enummember // Type of available phone numbers searched +let region: String = "" // Region/province/state that can be used to restrict the numbers returned +let city: String = "" // City that can be used to restrict the numbers returned +let areaCode: String = "" // Area code that can be used to restrict the numbers returned +let pattern: String = "" // A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. +let addressRequirement: GetRoutingSmsAvailablephonenumbersRequest.AddressRequirement_getRoutingSmsAvailablephonenumbers = GetRoutingSmsAvailablephonenumbersRequest.AddressRequirement_getRoutingSmsAvailablephonenumbers.enummember // This indicates whether the phone number requires to have an Address registered. + +// Get a list of available phone numbers for SMS provisioning. +GetRoutingSmsAvailablephonenumbersRequest.getRoutingSmsAvailablephonenumbers(countryCode: countryCode, phoneNumberType: phoneNumberType, region: region, city: city, areaCode: areaCode, pattern: pattern, addressRequirement: addressRequirement) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSmsAvailablephonenumbersRequest.getRoutingSmsAvailablephonenumbers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSmsPhonenumber-example.txt b/build/docs/getRoutingSmsPhonenumber-example.txt new file mode 100644 index 000000000..a157c022c --- /dev/null +++ b/build/docs/getRoutingSmsPhonenumber-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let addressId: String = "" // Address ID +let expand: GetRoutingSmsPhonenumberRequest.Expand_getRoutingSmsPhonenumber = GetRoutingSmsPhonenumberRequest.Expand_getRoutingSmsPhonenumber.enummember // Expand response with additional information + +// Get a phone number provisioned for SMS. +GetRoutingSmsPhonenumberRequest.getRoutingSmsPhonenumber(addressId: addressId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSmsPhonenumberRequest.getRoutingSmsPhonenumber was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingSmsPhonenumbers-example.txt b/build/docs/getRoutingSmsPhonenumbers-example.txt new file mode 100644 index 000000000..cb1f9b79f --- /dev/null +++ b/build/docs/getRoutingSmsPhonenumbers-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneNumber: String = "" // 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. +let phoneNumberType: [String] = [""] // Filter on phone number type +let phoneNumberStatus: [String] = [""] // Filter on phone number status +let countryCode: [String] = [""] // Filter on country code +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: GetRoutingSmsPhonenumbersRequest.SortBy_getRoutingSmsPhonenumbers = GetRoutingSmsPhonenumbersRequest.SortBy_getRoutingSmsPhonenumbers.enummember // Optional field to sort results +let sortOrder: GetRoutingSmsPhonenumbersRequest.SortOrder_getRoutingSmsPhonenumbers = GetRoutingSmsPhonenumbersRequest.SortOrder_getRoutingSmsPhonenumbers.enummember // Sort order +let language: String = en-US // A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations +let integrationId: String = "" // Filter on the Genesys Cloud integration id to which the phone number belongs to + +// Get a list of provisioned phone numbers. +GetRoutingSmsPhonenumbersRequest.getRoutingSmsPhonenumbers(phoneNumber: phoneNumber, phoneNumberType: phoneNumberType, phoneNumberStatus: phoneNumberStatus, countryCode: countryCode, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, language: language, integrationId: integrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingSmsPhonenumbersRequest.getRoutingSmsPhonenumbers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingUserUtilization-example.txt b/build/docs/getRoutingUserUtilization-example.txt new file mode 100644 index 000000000..3ce355298 --- /dev/null +++ b/build/docs/getRoutingUserUtilization-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get the user's max utilization settings. If not configured, the organization-wide default is returned. +GetRoutingUserUtilizationRequest.getRoutingUserUtilization(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingUserUtilizationRequest.getRoutingUserUtilization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingUtilization-example.txt b/build/docs/getRoutingUtilization-example.txt new file mode 100644 index 000000000..a4b2ef5f6 --- /dev/null +++ b/build/docs/getRoutingUtilization-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the organization-wide max utilization settings. +GetRoutingUtilizationRequest.getRoutingUtilization() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingUtilizationRequest.getRoutingUtilization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingWrapupcode-example.txt b/build/docs/getRoutingWrapupcode-example.txt new file mode 100644 index 000000000..6e39167f8 --- /dev/null +++ b/build/docs/getRoutingWrapupcode-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let codeId: String = "" // Wrapup Code ID + +// Get details about this wrap-up code. +GetRoutingWrapupcodeRequest.getRoutingWrapupcode(codeId: codeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingWrapupcodeRequest.getRoutingWrapupcode was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getRoutingWrapupcodes-example.txt b/build/docs/getRoutingWrapupcodes-example.txt new file mode 100644 index 000000000..d09e6cc1d --- /dev/null +++ b/build/docs/getRoutingWrapupcodes-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: GetRoutingWrapupcodesRequest.SortBy_getRoutingWrapupcodes = GetRoutingWrapupcodesRequest.SortBy_getRoutingWrapupcodes.enummember // Sort by +let sortOrder: GetRoutingWrapupcodesRequest.SortOrder_getRoutingWrapupcodes = GetRoutingWrapupcodesRequest.SortOrder_getRoutingWrapupcodes.enummember // Sort order +let name: String = "" // Wrapup code's name ('Sort by' param is ignored unless this field is provided) +let _id: [String] = [""] // Filter by wrapup code ID(s) +let divisionId: [String] = [""] // Filter by division ID(s) + +// Get list of wrapup codes. +GetRoutingWrapupcodesRequest.getRoutingWrapupcodes(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, _id: _id, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetRoutingWrapupcodesRequest.getRoutingWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimGroup-example.txt b/build/docs/getScimGroup-example.txt new file mode 100644 index 000000000..fa87e6a95 --- /dev/null +++ b/build/docs/getScimGroup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/groups. +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let ifNoneMatch: String = "" // 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. + +// Get a group +GetScimGroupRequest.getScimGroup(groupId: groupId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimGroupRequest.getScimGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimGroups-example.txt b/build/docs/getScimGroups-example.txt new file mode 100644 index 000000000..315ecff17 --- /dev/null +++ b/build/docs/getScimGroups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startIndex: Int = 0 // The 1-based index of the first query result. +let count: Int = 0 // 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\". +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let filter: String = displayName eq groupName // Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". + +// Get a list of groups +GetScimGroupsRequest.getScimGroups(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimGroupsRequest.getScimGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimResourcetype-example.txt b/build/docs/getScimResourcetype-example.txt new file mode 100644 index 000000000..5a68ac983 --- /dev/null +++ b/build/docs/getScimResourcetype-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let resourceType: GetScimResourcetypeRequest.ResourceType_getScimResourcetype = GetScimResourcetypeRequest.ResourceType_getScimResourcetype.enummember // The type of resource. Returned with GET /api/v2/scim/resourcetypes. + +// Get a resource type +GetScimResourcetypeRequest.getScimResourcetype(resourceType: resourceType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimResourcetypeRequest.getScimResourcetype was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimResourcetypes-example.txt b/build/docs/getScimResourcetypes-example.txt new file mode 100644 index 000000000..14c78d5ee --- /dev/null +++ b/build/docs/getScimResourcetypes-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of resource types +GetScimResourcetypesRequest.getScimResourcetypes() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimResourcetypesRequest.getScimResourcetypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimSchema-example.txt b/build/docs/getScimSchema-example.txt new file mode 100644 index 000000000..411a04940 --- /dev/null +++ b/build/docs/getScimSchema-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: GetScimSchemaRequest.SchemaId_getScimSchema = GetScimSchemaRequest.SchemaId_getScimSchema.enummember // The ID of a schema. Returned with GET /api/v2/scim/schemas. + +// Get a SCIM schema +GetScimSchemaRequest.getScimSchema(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimSchemaRequest.getScimSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimSchemas-example.txt b/build/docs/getScimSchemas-example.txt new file mode 100644 index 000000000..3ffa28267 --- /dev/null +++ b/build/docs/getScimSchemas-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filter: String = displayName eq groupName // Filtered results are invalid and return 403 Unauthorized. + +// Get a list of SCIM schemas +GetScimSchemasRequest.getScimSchemas(filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimSchemasRequest.getScimSchemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimServiceproviderconfig-example.txt b/build/docs/getScimServiceproviderconfig-example.txt new file mode 100644 index 000000000..2aa87b8e6 --- /dev/null +++ b/build/docs/getScimServiceproviderconfig-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ifNoneMatch: String = "" // 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. + +// Get a service provider's configuration +GetScimServiceproviderconfigRequest.getScimServiceproviderconfig(ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimServiceproviderconfigRequest.getScimServiceproviderconfig was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimUser-example.txt b/build/docs/getScimUser-example.txt new file mode 100644 index 000000000..6c579db2e --- /dev/null +++ b/build/docs/getScimUser-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/users. +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let ifNoneMatch: String = "" // 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. + +// Get a user +GetScimUserRequest.getScimUser(userId: userId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimUserRequest.getScimUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimUsers-example.txt b/build/docs/getScimUsers-example.txt new file mode 100644 index 000000000..b18b89611 --- /dev/null +++ b/build/docs/getScimUsers-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startIndex: Int = 0 // The 1-based index of the first query result. +let count: Int = 0 // 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\". +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let filter: String = "" // 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\". + +// Get a list of users +GetScimUsersRequest.getScimUsers(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimUsersRequest.getScimUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Group-example.txt b/build/docs/getScimV2Group-example.txt new file mode 100644 index 000000000..c3fa79f05 --- /dev/null +++ b/build/docs/getScimV2Group-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/v2/groups. +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let ifNoneMatch: String = "" // 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. + +// Get a group +GetScimV2GroupRequest.getScimV2Group(groupId: groupId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2GroupRequest.getScimV2Group was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Groups-example.txt b/build/docs/getScimV2Groups-example.txt new file mode 100644 index 000000000..90fa44a58 --- /dev/null +++ b/build/docs/getScimV2Groups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filter: String = displayName eq groupName // Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". +let startIndex: Int = 0 // The 1-based index of the first query result. +let count: Int = 0 // 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\". +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. + +// Get a list of groups +GetScimV2GroupsRequest.getScimV2Groups(filter: filter, startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2GroupsRequest.getScimV2Groups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Resourcetype-example.txt b/build/docs/getScimV2Resourcetype-example.txt new file mode 100644 index 000000000..349a08c28 --- /dev/null +++ b/build/docs/getScimV2Resourcetype-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let resourceType: GetScimV2ResourcetypeRequest.ResourceType_getScimV2Resourcetype = GetScimV2ResourcetypeRequest.ResourceType_getScimV2Resourcetype.enummember // The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. + +// Get a resource type +GetScimV2ResourcetypeRequest.getScimV2Resourcetype(resourceType: resourceType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2ResourcetypeRequest.getScimV2Resourcetype was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Resourcetypes-example.txt b/build/docs/getScimV2Resourcetypes-example.txt new file mode 100644 index 000000000..5bef95a68 --- /dev/null +++ b/build/docs/getScimV2Resourcetypes-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of resource types +GetScimV2ResourcetypesRequest.getScimV2Resourcetypes() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2ResourcetypesRequest.getScimV2Resourcetypes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Schema-example.txt b/build/docs/getScimV2Schema-example.txt new file mode 100644 index 000000000..886306ee0 --- /dev/null +++ b/build/docs/getScimV2Schema-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: GetScimV2SchemaRequest.SchemaId_getScimV2Schema = GetScimV2SchemaRequest.SchemaId_getScimV2Schema.enummember // The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. + +// Get a SCIM schema +GetScimV2SchemaRequest.getScimV2Schema(schemaId: schemaId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2SchemaRequest.getScimV2Schema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Schemas-example.txt b/build/docs/getScimV2Schemas-example.txt new file mode 100644 index 000000000..ae39aee9c --- /dev/null +++ b/build/docs/getScimV2Schemas-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let filter: String = displayName eq groupName // Filtered results are invalid and return 403 Unauthorized. + +// Get a list of SCIM schemas +GetScimV2SchemasRequest.getScimV2Schemas(filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2SchemasRequest.getScimV2Schemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Serviceproviderconfig-example.txt b/build/docs/getScimV2Serviceproviderconfig-example.txt new file mode 100644 index 000000000..abdeca3eb --- /dev/null +++ b/build/docs/getScimV2Serviceproviderconfig-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ifNoneMatch: String = "" // 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. + +// Get a service provider's configuration +GetScimV2ServiceproviderconfigRequest.getScimV2Serviceproviderconfig(ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2ServiceproviderconfigRequest.getScimV2Serviceproviderconfig was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2User-example.txt b/build/docs/getScimV2User-example.txt new file mode 100644 index 000000000..5f0597b1c --- /dev/null +++ b/build/docs/getScimV2User-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/v2/users. +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let ifNoneMatch: String = "" // 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. + +// Get a user +GetScimV2UserRequest.getScimV2User(userId: userId, attributes: attributes, excludedAttributes: excludedAttributes, ifNoneMatch: ifNoneMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2UserRequest.getScimV2User was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScimV2Users-example.txt b/build/docs/getScimV2Users-example.txt new file mode 100644 index 000000000..305449ea3 --- /dev/null +++ b/build/docs/getScimV2Users-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let startIndex: Int = 0 // The 1-based index of the first query result. +let count: Int = 0 // 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\". +let attributes: [String] = [""] // 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. +let excludedAttributes: [String] = [""] // 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. +let filter: String = "" // 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\". + +// Get a list of users +GetScimV2UsersRequest.getScimV2Users(startIndex: startIndex, count: count, attributes: attributes, excludedAttributes: excludedAttributes, filter: filter) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScimV2UsersRequest.getScimV2Users was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScript-example.txt b/build/docs/getScript-example.txt new file mode 100644 index 000000000..150f5c9d1 --- /dev/null +++ b/build/docs/getScript-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID + +// Get a script +GetScriptRequest.getScript(scriptId: scriptId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptRequest.getScript was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptPage-example.txt b/build/docs/getScriptPage-example.txt new file mode 100644 index 000000000..1ec19ea32 --- /dev/null +++ b/build/docs/getScriptPage-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let pageId: String = "" // Page ID +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get a page +GetScriptPageRequest.getScriptPage(scriptId: scriptId, pageId: pageId, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptPageRequest.getScriptPage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptPages-example.txt b/build/docs/getScriptPages-example.txt new file mode 100644 index 000000000..abd11c37b --- /dev/null +++ b/build/docs/getScriptPages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get the list of pages +GetScriptPagesRequest.getScriptPages(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptPagesRequest.getScriptPages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScripts-example.txt b/build/docs/getScripts-example.txt new file mode 100644 index 000000000..eb252a7e3 --- /dev/null +++ b/build/docs/getScripts-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: String = "" // Expand +let name: String = "" // Name filter +let feature: String = "" // Feature filter +let flowId: String = "" // Secure flow id filter +let sortBy: GetScriptsRequest.SortBy_getScripts = GetScriptsRequest.SortBy_getScripts.enummember // SortBy +let sortOrder: GetScriptsRequest.SortOrder_getScripts = GetScriptsRequest.SortOrder_getScripts.enummember // SortOrder +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script +let divisionIds: String = "" // Filters scripts to requested divisionIds + +// Get the list of scripts +GetScriptsRequest.getScripts(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, sortBy: sortBy, sortOrder: sortOrder, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsRequest.getScripts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsDivisionviews-example.txt b/build/docs/getScriptsDivisionviews-example.txt new file mode 100644 index 000000000..2d029301f --- /dev/null +++ b/build/docs/getScriptsDivisionviews-example.txt @@ -0,0 +1,25 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: String = "" // Expand +let name: String = "" // Name filter +let feature: String = "" // Feature filter +let flowId: String = "" // Secure flow id filter +let sortBy: GetScriptsDivisionviewsRequest.SortBy_getScriptsDivisionviews = GetScriptsDivisionviewsRequest.SortBy_getScriptsDivisionviews.enummember // SortBy +let sortOrder: GetScriptsDivisionviewsRequest.SortOrder_getScriptsDivisionviews = GetScriptsDivisionviewsRequest.SortOrder_getScriptsDivisionviews.enummember // SortOrder +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script +let divisionIds: String = "" // Filters scripts to requested divisionIds + +// Get the metadata for a list of scripts +GetScriptsDivisionviewsRequest.getScriptsDivisionviews(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, sortBy: sortBy, sortOrder: sortOrder, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsDivisionviewsRequest.getScriptsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublished-example.txt b/build/docs/getScriptsPublished-example.txt new file mode 100644 index 000000000..10ef31f1e --- /dev/null +++ b/build/docs/getScriptsPublished-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: String = "" // Expand +let name: String = "" // Name filter +let feature: String = "" // Feature filter +let flowId: String = "" // Secure flow id filter +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script +let divisionIds: String = "" // Filters scripts to requested divisionIds + +// Get the published scripts. +GetScriptsPublishedRequest.getScriptsPublished(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedRequest.getScriptsPublished was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublishedDivisionviews-example.txt b/build/docs/getScriptsPublishedDivisionviews-example.txt new file mode 100644 index 000000000..08051d29c --- /dev/null +++ b/build/docs/getScriptsPublishedDivisionviews-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: String = "" // Expand +let name: String = "" // Name filter +let feature: String = "" // Feature filter +let flowId: String = "" // Secure flow id filter +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script +let divisionIds: String = "" // Filters scripts to requested divisionIds + +// Get the published scripts metadata. +GetScriptsPublishedDivisionviewsRequest.getScriptsPublishedDivisionviews(pageSize: pageSize, pageNumber: pageNumber, expand: expand, name: name, feature: feature, flowId: flowId, scriptDataVersion: scriptDataVersion, divisionIds: divisionIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedDivisionviewsRequest.getScriptsPublishedDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublishedScriptId-example.txt b/build/docs/getScriptsPublishedScriptId-example.txt new file mode 100644 index 000000000..b58d311f3 --- /dev/null +++ b/build/docs/getScriptsPublishedScriptId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get the published script. +GetScriptsPublishedScriptIdRequest.getScriptsPublishedScriptId(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedScriptIdRequest.getScriptsPublishedScriptId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublishedScriptIdPage-example.txt b/build/docs/getScriptsPublishedScriptIdPage-example.txt new file mode 100644 index 000000000..14678c34d --- /dev/null +++ b/build/docs/getScriptsPublishedScriptIdPage-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let pageId: String = "" // Page ID +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get the published page. +GetScriptsPublishedScriptIdPageRequest.getScriptsPublishedScriptIdPage(scriptId: scriptId, pageId: pageId, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedScriptIdPageRequest.getScriptsPublishedScriptIdPage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublishedScriptIdPages-example.txt b/build/docs/getScriptsPublishedScriptIdPages-example.txt new file mode 100644 index 000000000..68e349a81 --- /dev/null +++ b/build/docs/getScriptsPublishedScriptIdPages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get the list of published pages +GetScriptsPublishedScriptIdPagesRequest.getScriptsPublishedScriptIdPages(scriptId: scriptId, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedScriptIdPagesRequest.getScriptsPublishedScriptIdPages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsPublishedScriptIdVariables-example.txt b/build/docs/getScriptsPublishedScriptIdVariables-example.txt new file mode 100644 index 000000000..764de9f88 --- /dev/null +++ b/build/docs/getScriptsPublishedScriptIdVariables-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let input: GetScriptsPublishedScriptIdVariablesRequest.Input_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.Input_getScriptsPublishedScriptIdVariables.enummember // input +let output: GetScriptsPublishedScriptIdVariablesRequest.Output_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.Output_getScriptsPublishedScriptIdVariables.enummember // output +let type: GetScriptsPublishedScriptIdVariablesRequest.ModelType_getScriptsPublishedScriptIdVariables = GetScriptsPublishedScriptIdVariablesRequest.ModelType_getScriptsPublishedScriptIdVariables.enummember // type +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script + +// Get the published variables +GetScriptsPublishedScriptIdVariablesRequest.getScriptsPublishedScriptIdVariables(scriptId: scriptId, input: input, output: output, type: type, scriptDataVersion: scriptDataVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsPublishedScriptIdVariablesRequest.getScriptsPublishedScriptIdVariables was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getScriptsUploadStatus-example.txt b/build/docs/getScriptsUploadStatus-example.txt new file mode 100644 index 000000000..ae6fd464c --- /dev/null +++ b/build/docs/getScriptsUploadStatus-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let uploadId: String = "" // Upload ID +let longPoll: Bool = true // Enable longPolling endpoint + +// Get the upload status of an imported script +GetScriptsUploadStatusRequest.getScriptsUploadStatus(uploadId: uploadId, longPoll: longPoll) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetScriptsUploadStatusRequest.getScriptsUploadStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSearch-example.txt b/build/docs/getSearch-example.txt new file mode 100644 index 000000000..0f524b2b7 --- /dev/null +++ b/build/docs/getSearch-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // Which fields, if any, to expand +let profile: Bool = true // profile + +// Search using the q64 value returned from a previous search. +GetSearchRequest.getSearch(q64: q64, expand: expand, profile: profile) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSearchRequest.getSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSearchSuggest-example.txt b/build/docs/getSearchSuggest-example.txt new file mode 100644 index 000000000..c1dbcdb61 --- /dev/null +++ b/build/docs/getSearchSuggest-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // Which fields, if any, to expand +let profile: Bool = true // profile + +// Suggest resources using the q64 value returned from a previous suggest query. +GetSearchSuggestRequest.getSearchSuggest(q64: q64, expand: expand, profile: profile) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSearchSuggestRequest.getSearchSuggest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsConversation-example.txt b/build/docs/getSpeechandtextanalyticsConversation-example.txt new file mode 100644 index 000000000..d8e2c85f0 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsConversation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation Id + +// Get Speech and Text Analytics for a specific conversation +GetSpeechandtextanalyticsConversationRequest.getSpeechandtextanalyticsConversation(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsConversationRequest.getSpeechandtextanalyticsConversation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturl-example.txt b/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturl-example.txt new file mode 100644 index 000000000..1608ccdd2 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturl-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let communicationId: String = "" // Communication ID + +// Get the pre-signed S3 URL for the transcript of a specific communication of a conversation +GetSpeechandtextanalyticsConversationCommunicationTranscripturlRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId: conversationId, communicationId: communicationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsConversationCommunicationTranscripturlRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturl was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturls-example.txt b/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturls-example.txt new file mode 100644 index 000000000..76a5de8e2 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsConversationCommunicationTranscripturls-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let communicationId: String = "" // Communication ID + +// Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation +GetSpeechandtextanalyticsConversationCommunicationTranscripturlsRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId: conversationId, communicationId: communicationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsConversationCommunicationTranscripturlsRequest.getSpeechandtextanalyticsConversationCommunicationTranscripturls was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsDictionaryfeedback-example.txt b/build/docs/getSpeechandtextanalyticsDictionaryfeedback-example.txt new file mode 100644 index 000000000..3e6e8f484 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsDictionaryfeedback-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dialect: String = en-US // The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard +let nextPage: String = "" // The key for listing the next page +let pageSize: Int = 0 // The page size for the listing + +// Get the list of Speech & Text Analytics dictionary feedbacks +GetSpeechandtextanalyticsDictionaryfeedbackRequest.getSpeechandtextanalyticsDictionaryfeedback(dialect: dialect, nextPage: nextPage, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsDictionaryfeedbackRequest.getSpeechandtextanalyticsDictionaryfeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt b/build/docs/getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt new file mode 100644 index 000000000..1745f2af5 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dictionaryFeedbackId: String = "" // The Id of the Dictionary Feedback + +// Get a Speech & Text Analytics dictionary feedback by id +GetSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgram-example.txt b/build/docs/getSpeechandtextanalyticsProgram-example.txt new file mode 100644 index 000000000..dc45a596e --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgram-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program + +// Get a Speech & Text Analytics program by id +GetSpeechandtextanalyticsProgramRequest.getSpeechandtextanalyticsProgram(programId: programId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramRequest.getSpeechandtextanalyticsProgram was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramMappings-example.txt b/build/docs/getSpeechandtextanalyticsProgramMappings-example.txt new file mode 100644 index 000000000..13a885407 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramMappings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program + +// Get Speech & Text Analytics program mappings to queues and flows by id +GetSpeechandtextanalyticsProgramMappingsRequest.getSpeechandtextanalyticsProgramMappings(programId: programId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramMappingsRequest.getSpeechandtextanalyticsProgramMappings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramTranscriptionengines-example.txt b/build/docs/getSpeechandtextanalyticsProgramTranscriptionengines-example.txt new file mode 100644 index 000000000..ad5e60739 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramTranscriptionengines-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program + +// Get transcription engine settings of a program +GetSpeechandtextanalyticsProgramTranscriptionenginesRequest.getSpeechandtextanalyticsProgramTranscriptionengines(programId: programId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramTranscriptionenginesRequest.getSpeechandtextanalyticsProgramTranscriptionengines was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsPrograms-example.txt b/build/docs/getSpeechandtextanalyticsPrograms-example.txt new file mode 100644 index 000000000..000ff4897 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsPrograms-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let nextPage: String = "" // The key for listing the next page +let pageSize: Int = 0 // The page size for the listing +let state: GetSpeechandtextanalyticsProgramsRequest.State_getSpeechandtextanalyticsPrograms = GetSpeechandtextanalyticsProgramsRequest.State_getSpeechandtextanalyticsPrograms.enummember // Program state. Defaults to Latest + +// Get the list of Speech & Text Analytics programs +GetSpeechandtextanalyticsProgramsRequest.getSpeechandtextanalyticsPrograms(nextPage: nextPage, pageSize: pageSize, state: state) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsRequest.getSpeechandtextanalyticsPrograms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramsGeneralJob-example.txt b/build/docs/getSpeechandtextanalyticsProgramsGeneralJob-example.txt new file mode 100644 index 000000000..f851b32f7 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramsGeneralJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The id of the publish programs job + +// Get a Speech & Text Analytics general program job by id +GetSpeechandtextanalyticsProgramsGeneralJobRequest.getSpeechandtextanalyticsProgramsGeneralJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsGeneralJobRequest.getSpeechandtextanalyticsProgramsGeneralJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramsMappings-example.txt b/build/docs/getSpeechandtextanalyticsProgramsMappings-example.txt new file mode 100644 index 000000000..bd88c4111 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramsMappings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let nextPage: String = "" // The key for listing the next page +let pageSize: Int = 0 // The page size for the listing + +// Get the list of Speech & Text Analytics programs mappings to queues and flows +GetSpeechandtextanalyticsProgramsMappingsRequest.getSpeechandtextanalyticsProgramsMappings(nextPage: nextPage, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsMappingsRequest.getSpeechandtextanalyticsProgramsMappings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramsPublishjob-example.txt b/build/docs/getSpeechandtextanalyticsProgramsPublishjob-example.txt new file mode 100644 index 000000000..fce82399f --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramsPublishjob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The id of the publish programs job + +// Get a Speech & Text Analytics publish programs job by id +GetSpeechandtextanalyticsProgramsPublishjobRequest.getSpeechandtextanalyticsProgramsPublishjob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsPublishjobRequest.getSpeechandtextanalyticsProgramsPublishjob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramsTranscriptionenginesDialects-example.txt b/build/docs/getSpeechandtextanalyticsProgramsTranscriptionenginesDialects-example.txt new file mode 100644 index 000000000..dbb365a14 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramsTranscriptionenginesDialects-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get supported dialects for each transcription engine +GetSpeechandtextanalyticsProgramsTranscriptionenginesDialectsRequest.getSpeechandtextanalyticsProgramsTranscriptionenginesDialects() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsTranscriptionenginesDialectsRequest.getSpeechandtextanalyticsProgramsTranscriptionenginesDialects was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsProgramsUnpublished-example.txt b/build/docs/getSpeechandtextanalyticsProgramsUnpublished-example.txt new file mode 100644 index 000000000..736b960ec --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsProgramsUnpublished-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let nextPage: String = "" // The key for listing the next page +let pageSize: Int = 0 // The page size for the listing + +// Get the list of Speech & Text Analytics unpublished programs +GetSpeechandtextanalyticsProgramsUnpublishedRequest.getSpeechandtextanalyticsProgramsUnpublished(nextPage: nextPage, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsProgramsUnpublishedRequest.getSpeechandtextanalyticsProgramsUnpublished was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsSentimentDialects-example.txt b/build/docs/getSpeechandtextanalyticsSentimentDialects-example.txt new file mode 100644 index 000000000..c60fe312b --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsSentimentDialects-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of Speech & Text Analytics sentiment supported dialects +GetSpeechandtextanalyticsSentimentDialectsRequest.getSpeechandtextanalyticsSentimentDialects() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsSentimentDialectsRequest.getSpeechandtextanalyticsSentimentDialects was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsSentimentfeedback-example.txt b/build/docs/getSpeechandtextanalyticsSentimentfeedback-example.txt new file mode 100644 index 000000000..b6d5ed47b --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsSentimentfeedback-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dialect: String = en-US // The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard + +// Get the list of Speech & Text Analytics SentimentFeedback +GetSpeechandtextanalyticsSentimentfeedbackRequest.getSpeechandtextanalyticsSentimentfeedback(dialect: dialect) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsSentimentfeedbackRequest.getSpeechandtextanalyticsSentimentfeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsSettings-example.txt b/build/docs/getSpeechandtextanalyticsSettings-example.txt new file mode 100644 index 000000000..09bc0789f --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get Speech And Text Analytics Settings +GetSpeechandtextanalyticsSettingsRequest.getSpeechandtextanalyticsSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsSettingsRequest.getSpeechandtextanalyticsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopic-example.txt b/build/docs/getSpeechandtextanalyticsTopic-example.txt new file mode 100644 index 000000000..d76e4e892 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopic-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let topicId: String = "" // The id of the topic + +// Get a Speech & Text Analytics topic by id +GetSpeechandtextanalyticsTopicRequest.getSpeechandtextanalyticsTopic(topicId: topicId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicRequest.getSpeechandtextanalyticsTopic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopics-example.txt b/build/docs/getSpeechandtextanalyticsTopics-example.txt new file mode 100644 index 000000000..994659524 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopics-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let nextPage: String = "" // The key for listing the next page +let pageSize: Int = 0 // The page size for the listing +let state: GetSpeechandtextanalyticsTopicsRequest.State_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.State_getSpeechandtextanalyticsTopics.enummember // Topic state. Defaults to latest +let name: String = "" // Case insensitive partial name to filter by +let ids: [String] = [""] // Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. +let sortBy: GetSpeechandtextanalyticsTopicsRequest.SortBy_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.SortBy_getSpeechandtextanalyticsTopics.enummember // Sort results by. Defaults to name +let sortOrder: GetSpeechandtextanalyticsTopicsRequest.SortOrder_getSpeechandtextanalyticsTopics = GetSpeechandtextanalyticsTopicsRequest.SortOrder_getSpeechandtextanalyticsTopics.enummember // Sort order. Defaults to asc + +// Get the list of Speech & Text Analytics topics +GetSpeechandtextanalyticsTopicsRequest.getSpeechandtextanalyticsTopics(nextPage: nextPage, pageSize: pageSize, state: state, name: name, ids: ids, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicsRequest.getSpeechandtextanalyticsTopics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopicsDialects-example.txt b/build/docs/getSpeechandtextanalyticsTopicsDialects-example.txt new file mode 100644 index 000000000..86d98dd78 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopicsDialects-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get list of supported Speech & Text Analytics topics dialects +GetSpeechandtextanalyticsTopicsDialectsRequest.getSpeechandtextanalyticsTopicsDialects() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicsDialectsRequest.getSpeechandtextanalyticsTopicsDialects was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopicsGeneral-example.txt b/build/docs/getSpeechandtextanalyticsTopicsGeneral-example.txt new file mode 100644 index 000000000..bd431cac4 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopicsGeneral-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dialect: GetSpeechandtextanalyticsTopicsGeneralRequest.Dialect_getSpeechandtextanalyticsTopicsGeneral = GetSpeechandtextanalyticsTopicsGeneralRequest.Dialect_getSpeechandtextanalyticsTopicsGeneral.enummember // 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 + +// Get the Speech & Text Analytics general topics for a given dialect +GetSpeechandtextanalyticsTopicsGeneralRequest.getSpeechandtextanalyticsTopicsGeneral(dialect: dialect) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicsGeneralRequest.getSpeechandtextanalyticsTopicsGeneral was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopicsGeneralStatus-example.txt b/build/docs/getSpeechandtextanalyticsTopicsGeneralStatus-example.txt new file mode 100644 index 000000000..9dc44a82b --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopicsGeneralStatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dialect: GetSpeechandtextanalyticsTopicsGeneralStatusRequest.Dialect_getSpeechandtextanalyticsTopicsGeneralStatus = GetSpeechandtextanalyticsTopicsGeneralStatusRequest.Dialect_getSpeechandtextanalyticsTopicsGeneralStatus.enummember // 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 + +// Get the list of general topics from the org and the system with their current status +GetSpeechandtextanalyticsTopicsGeneralStatusRequest.getSpeechandtextanalyticsTopicsGeneralStatus(dialect: dialect) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicsGeneralStatusRequest.getSpeechandtextanalyticsTopicsGeneralStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSpeechandtextanalyticsTopicsPublishjob-example.txt b/build/docs/getSpeechandtextanalyticsTopicsPublishjob-example.txt new file mode 100644 index 000000000..1acd60119 --- /dev/null +++ b/build/docs/getSpeechandtextanalyticsTopicsPublishjob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The id of the publish topics job + +// Get a Speech & Text Analytics publish topics job by id +GetSpeechandtextanalyticsTopicsPublishjobRequest.getSpeechandtextanalyticsTopicsPublishjob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSpeechandtextanalyticsTopicsPublishjobRequest.getSpeechandtextanalyticsTopicsPublishjob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getStation-example.txt b/build/docs/getStation-example.txt new file mode 100644 index 000000000..02f629952 --- /dev/null +++ b/build/docs/getStation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let stationId: String = "" // Station ID + +// Get station. +GetStationRequest.getStation(stationId: stationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetStationRequest.getStation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getStations-example.txt b/build/docs/getStations-example.txt new file mode 100644 index 000000000..534f25f07 --- /dev/null +++ b/build/docs/getStations-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let name: String = "" // Name +let userSelectable: String = "" // True for stations that the user can select otherwise false +let webRtcUserId: String = "" // Filter for the webRtc station of the webRtcUserId +let _id: String = "" // Comma separated list of stationIds +let lineAppearanceId: String = "" // lineAppearanceId + +// Get the list of available stations. +GetStationsRequest.getStations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, name: name, userSelectable: userSelectable, webRtcUserId: webRtcUserId, _id: _id, lineAppearanceId: lineAppearanceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetStationsRequest.getStations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getSystempresences-example.txt b/build/docs/getSystempresences-example.txt new file mode 100644 index 000000000..65446ada9 --- /dev/null +++ b/build/docs/getSystempresences-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of SystemPresences +GetSystempresencesRequest.getSystempresences() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetSystempresencesRequest.getSystempresences was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTeam-example.txt b/build/docs/getTeam-example.txt new file mode 100644 index 000000000..7208b2957 --- /dev/null +++ b/build/docs/getTeam-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID + +// Get team +GetTeamRequest.getTeam(teamId: teamId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTeamRequest.getTeam was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTeamMembers-example.txt b/build/docs/getTeamMembers-example.txt new file mode 100644 index 000000000..3d21e9a07 --- /dev/null +++ b/build/docs/getTeamMembers-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID +let pageSize: Int = 0 // Page size +let before: String = "" // The cursor that points to the previous item in the complete list of teams +let after: String = "" // The cursor that points to the next item in the complete list of teams +let expand: GetTeamMembersRequest.Expand_getTeamMembers = GetTeamMembersRequest.Expand_getTeamMembers.enummember // Expand the name on each user + +// Get team membership +GetTeamMembersRequest.getTeamMembers(teamId: teamId, pageSize: pageSize, before: before, after: after, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTeamMembersRequest.getTeamMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTeams-example.txt b/build/docs/getTeams-example.txt new file mode 100644 index 000000000..d8e8d3e3a --- /dev/null +++ b/build/docs/getTeams-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let name: String = "" // Return only teams whose names start with this value (case-insensitive matching) +let after: String = "" // The cursor that points to the next item in the complete list of teams +let before: String = "" // The cursor that points to the previous item in the complete list of teams +let expand: GetTeamsRequest.Expand_getTeams = GetTeamsRequest.Expand_getTeams.enummember // Expand the name on each user + +// Get Team listing +GetTeamsRequest.getTeams(pageSize: pageSize, name: name, after: after, before: before, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTeamsRequest.getTeams was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyMediaregions-example.txt b/build/docs/getTelephonyMediaregions-example.txt new file mode 100644 index 000000000..d5a0f3deb --- /dev/null +++ b/build/docs/getTelephonyMediaregions-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Retrieve the list of AWS regions media can stream through. +GetTelephonyMediaregionsRequest.getTelephonyMediaregions() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyMediaregionsRequest.getTelephonyMediaregions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdge-example.txt b/build/docs/getTelephonyProvidersEdge-example.txt new file mode 100644 index 000000000..85ae293c3 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdge-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let expand: [String] = [""] // Fields to expand in the response, comma-separated + +// Get edge. +GetTelephonyProvidersEdgeRequest.getTelephonyProvidersEdge(edgeId: edgeId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeRequest.getTelephonyProvidersEdge was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeDiagnosticNslookup-example.txt b/build/docs/getTelephonyProvidersEdgeDiagnosticNslookup-example.txt new file mode 100644 index 000000000..e1340537f --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeDiagnosticNslookup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Get networking-related information from an Edge for a target IP or host. +GetTelephonyProvidersEdgeDiagnosticNslookupRequest.getTelephonyProvidersEdgeDiagnosticNslookup(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeDiagnosticNslookupRequest.getTelephonyProvidersEdgeDiagnosticNslookup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeDiagnosticPing-example.txt b/build/docs/getTelephonyProvidersEdgeDiagnosticPing-example.txt new file mode 100644 index 000000000..3a782b897 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeDiagnosticPing-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Get networking-related information from an Edge for a target IP or host. +GetTelephonyProvidersEdgeDiagnosticPingRequest.getTelephonyProvidersEdgeDiagnosticPing(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeDiagnosticPingRequest.getTelephonyProvidersEdgeDiagnosticPing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeDiagnosticRoute-example.txt b/build/docs/getTelephonyProvidersEdgeDiagnosticRoute-example.txt new file mode 100644 index 000000000..cbb8b41f5 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeDiagnosticRoute-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Get networking-related information from an Edge for a target IP or host. +GetTelephonyProvidersEdgeDiagnosticRouteRequest.getTelephonyProvidersEdgeDiagnosticRoute(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeDiagnosticRouteRequest.getTelephonyProvidersEdgeDiagnosticRoute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeDiagnosticTracepath-example.txt b/build/docs/getTelephonyProvidersEdgeDiagnosticTracepath-example.txt new file mode 100644 index 000000000..0ea74c49f --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeDiagnosticTracepath-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Get networking-related information from an Edge for a target IP or host. +GetTelephonyProvidersEdgeDiagnosticTracepathRequest.getTelephonyProvidersEdgeDiagnosticTracepath(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeDiagnosticTracepathRequest.getTelephonyProvidersEdgeDiagnosticTracepath was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeLogicalinterface-example.txt b/build/docs/getTelephonyProvidersEdgeLogicalinterface-example.txt new file mode 100644 index 000000000..1334c07e1 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeLogicalinterface-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let interfaceId: String = "" // Interface ID +let expand: [String] = [""] // Field to expand in the response + +// Get an edge logical interface +GetTelephonyProvidersEdgeLogicalinterfaceRequest.getTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeLogicalinterfaceRequest.getTelephonyProvidersEdgeLogicalinterface was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeLogicalinterfaces-example.txt b/build/docs/getTelephonyProvidersEdgeLogicalinterfaces-example.txt new file mode 100644 index 000000000..b7f1e17b4 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeLogicalinterfaces-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let expand: [String] = [""] // Field to expand in the response + +// Get edge logical interfaces. +GetTelephonyProvidersEdgeLogicalinterfacesRequest.getTelephonyProvidersEdgeLogicalinterfaces(edgeId: edgeId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeLogicalinterfacesRequest.getTelephonyProvidersEdgeLogicalinterfaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeLogsJob-example.txt b/build/docs/getTelephonyProvidersEdgeLogsJob-example.txt new file mode 100644 index 000000000..b75e26b9a --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeLogsJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let jobId: String = "" // Job ID + +// Get an Edge logs job. +GetTelephonyProvidersEdgeLogsJobRequest.getTelephonyProvidersEdgeLogsJob(edgeId: edgeId, jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeLogsJobRequest.getTelephonyProvidersEdgeLogsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeMetrics-example.txt b/build/docs/getTelephonyProvidersEdgeMetrics-example.txt new file mode 100644 index 000000000..add736fda --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeMetrics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Get the edge metrics. +GetTelephonyProvidersEdgeMetricsRequest.getTelephonyProvidersEdgeMetrics(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeMetricsRequest.getTelephonyProvidersEdgeMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgePhysicalinterface-example.txt b/build/docs/getTelephonyProvidersEdgePhysicalinterface-example.txt new file mode 100644 index 000000000..df9d6c922 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgePhysicalinterface-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let interfaceId: String = "" // Interface ID + +// Get edge physical interface. +GetTelephonyProvidersEdgePhysicalinterfaceRequest.getTelephonyProvidersEdgePhysicalinterface(edgeId: edgeId, interfaceId: interfaceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgePhysicalinterfaceRequest.getTelephonyProvidersEdgePhysicalinterface was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgePhysicalinterfaces-example.txt b/build/docs/getTelephonyProvidersEdgePhysicalinterfaces-example.txt new file mode 100644 index 000000000..4665f0a56 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgePhysicalinterfaces-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Retrieve a list of all configured physical interfaces from a specific edge. +GetTelephonyProvidersEdgePhysicalinterfacesRequest.getTelephonyProvidersEdgePhysicalinterfaces(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgePhysicalinterfacesRequest.getTelephonyProvidersEdgePhysicalinterfaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeSetuppackage-example.txt b/build/docs/getTelephonyProvidersEdgeSetuppackage-example.txt new file mode 100644 index 000000000..7f158a791 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeSetuppackage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. +GetTelephonyProvidersEdgeSetuppackageRequest.getTelephonyProvidersEdgeSetuppackage(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeSetuppackageRequest.getTelephonyProvidersEdgeSetuppackage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeSoftwareupdate-example.txt b/build/docs/getTelephonyProvidersEdgeSoftwareupdate-example.txt new file mode 100644 index 000000000..b55ccfad9 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeSoftwareupdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Gets software update status information about any edge. +GetTelephonyProvidersEdgeSoftwareupdateRequest.getTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeSoftwareupdateRequest.getTelephonyProvidersEdgeSoftwareupdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeSoftwareversions-example.txt b/build/docs/getTelephonyProvidersEdgeSoftwareversions-example.txt new file mode 100644 index 000000000..9719ec557 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeSoftwareversions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID + +// Gets all the available software versions for this edge. +GetTelephonyProvidersEdgeSoftwareversionsRequest.getTelephonyProvidersEdgeSoftwareversions(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeSoftwareversionsRequest.getTelephonyProvidersEdgeSoftwareversions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgeTrunks-example.txt b/build/docs/getTelephonyProvidersEdgeTrunks-example.txt new file mode 100644 index 000000000..b2c760cb0 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgeTrunks-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Value by which to sort +let sortOrder: String = "" // Sort order +let trunkBaseId: String = "" // Filter by Trunk Base Ids +let trunkType: GetTelephonyProvidersEdgeTrunksRequest.TrunkType_getTelephonyProvidersEdgeTrunks = GetTelephonyProvidersEdgeTrunksRequest.TrunkType_getTelephonyProvidersEdgeTrunks.enummember // Filter by a Trunk type + +// Get the list of available trunks for the given Edge. +GetTelephonyProvidersEdgeTrunksRequest.getTelephonyProvidersEdgeTrunks(edgeId: edgeId, pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, trunkBaseId: trunkBaseId, trunkType: trunkType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgeTrunksRequest.getTelephonyProvidersEdgeTrunks was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdges-example.txt b/build/docs/getTelephonyProvidersEdges-example.txt new file mode 100644 index 000000000..7c362e540 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdges-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let siteId: String = "" // Filter by site.id +let edgeGroupId: String = "" // Filter by edgeGroup.id +let sortBy: String = "" // Sort by +let managed: Bool = true // Filter by managed +let showCloudMedia: Bool = true // True to show the cloud media devices in the result. + +// Get the list of edges. +GetTelephonyProvidersEdgesRequest.getTelephonyProvidersEdges(pageSize: pageSize, pageNumber: pageNumber, name: name, siteId: siteId, edgeGroupId: edgeGroupId, sortBy: sortBy, managed: managed, showCloudMedia: showCloudMedia) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesRequest.getTelephonyProvidersEdges was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesAvailablelanguages-example.txt b/build/docs/getTelephonyProvidersEdgesAvailablelanguages-example.txt new file mode 100644 index 000000000..67ed9ff72 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesAvailablelanguages-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of available languages. +GetTelephonyProvidersEdgesAvailablelanguagesRequest.getTelephonyProvidersEdgesAvailablelanguages() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesAvailablelanguagesRequest.getTelephonyProvidersEdgesAvailablelanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesCertificateauthorities-example.txt b/build/docs/getTelephonyProvidersEdgesCertificateauthorities-example.txt new file mode 100644 index 000000000..f9c3c7ffe --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesCertificateauthorities-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the list of certificate authorities. +GetTelephonyProvidersEdgesCertificateauthoritiesRequest.getTelephonyProvidersEdgesCertificateauthorities() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesCertificateauthoritiesRequest.getTelephonyProvidersEdgesCertificateauthorities was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesCertificateauthority-example.txt b/build/docs/getTelephonyProvidersEdgesCertificateauthority-example.txt new file mode 100644 index 000000000..a82babbe9 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesCertificateauthority-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let certificateId: String = "" // Certificate ID + +// Get a certificate authority. +GetTelephonyProvidersEdgesCertificateauthorityRequest.getTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesCertificateauthorityRequest.getTelephonyProvidersEdgesCertificateauthority was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesDid-example.txt b/build/docs/getTelephonyProvidersEdgesDid-example.txt new file mode 100644 index 000000000..7eab3869b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesDid-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let didId: String = "" // DID ID + +// Get a DID by ID. +GetTelephonyProvidersEdgesDidRequest.getTelephonyProvidersEdgesDid(didId: didId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesDidRequest.getTelephonyProvidersEdgesDid was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesDidpool-example.txt b/build/docs/getTelephonyProvidersEdgesDidpool-example.txt new file mode 100644 index 000000000..9aaf90cfb --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesDidpool-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let didPoolId: String = "" // DID pool ID + +// Get a DID Pool by ID. +GetTelephonyProvidersEdgesDidpoolRequest.getTelephonyProvidersEdgesDidpool(didPoolId: didPoolId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesDidpoolRequest.getTelephonyProvidersEdgesDidpool was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesDidpools-example.txt b/build/docs/getTelephonyProvidersEdgesDidpools-example.txt new file mode 100644 index 000000000..fa4902cf3 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesDidpools-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let _id: [String] = [""] // Filter by a specific list of ID's + +// Get a listing of DID Pools +GetTelephonyProvidersEdgesDidpoolsRequest.getTelephonyProvidersEdgesDidpools(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesDidpoolsRequest.getTelephonyProvidersEdgesDidpools was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesDidpoolsDids-example.txt b/build/docs/getTelephonyProvidersEdgesDidpoolsDids-example.txt new file mode 100644 index 000000000..a443cb2b4 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesDidpoolsDids-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let type: GetTelephonyProvidersEdgesDidpoolsDidsRequest.ModelType_getTelephonyProvidersEdgesDidpoolsDids = GetTelephonyProvidersEdgesDidpoolsDidsRequest.ModelType_getTelephonyProvidersEdgesDidpoolsDids.enummember // The type of numbers to return. +let _id: [String] = [""] // Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned. +let numberMatch: String = "" // A number to filter the results by. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: String = "" // Sort order + +// Get a listing of unassigned and/or assigned numbers in a set of DID Pools. +GetTelephonyProvidersEdgesDidpoolsDidsRequest.getTelephonyProvidersEdgesDidpoolsDids(type: type, _id: _id, numberMatch: numberMatch, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesDidpoolsDidsRequest.getTelephonyProvidersEdgesDidpoolsDids was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesDids-example.txt b/build/docs/getTelephonyProvidersEdgesDids-example.txt new file mode 100644 index 000000000..992e8531b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesDids-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let phoneNumber: String = "" // Filter by phoneNumber +let ownerId: String = "" // Filter by the owner of a phone number +let didPoolId: String = "" // Filter by the DID Pool assignment +let _id: [String] = [""] // Filter by a specific list of ID's + +// Get a listing of DIDs +GetTelephonyProvidersEdgesDidsRequest.getTelephonyProvidersEdgesDids(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, phoneNumber: phoneNumber, ownerId: ownerId, didPoolId: didPoolId, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesDidsRequest.getTelephonyProvidersEdgesDids was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesEdgegroup-example.txt b/build/docs/getTelephonyProvidersEdgesEdgegroup-example.txt new file mode 100644 index 000000000..a2c1beaa5 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesEdgegroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeGroupId: String = "" // Edge group ID +let expand: [String] = [""] // Fields to expand in the response + +// Get edge group. +GetTelephonyProvidersEdgesEdgegroupRequest.getTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesEdgegroupRequest.getTelephonyProvidersEdgesEdgegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt b/build/docs/getTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt new file mode 100644 index 000000000..cbaf60c07 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgegroupId: String = "" // Edge Group ID +let edgetrunkbaseId: String = "" // Edge Trunk Base ID + +// Gets the edge trunk base associated with the edge group +GetTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId: edgegroupId, edgetrunkbaseId: edgetrunkbaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.getTelephonyProvidersEdgesEdgegroupEdgetrunkbase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesEdgegroups-example.txt b/build/docs/getTelephonyProvidersEdgesEdgegroups-example.txt new file mode 100644 index 000000000..fb3f623a8 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesEdgegroups-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let sortBy: String = "" // Sort by +let managed: Bool = true // Filter by managed + +// Get the list of edge groups. +GetTelephonyProvidersEdgesEdgegroupsRequest.getTelephonyProvidersEdgesEdgegroups(pageSize: pageSize, pageNumber: pageNumber, name: name, sortBy: sortBy, managed: managed) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesEdgegroupsRequest.getTelephonyProvidersEdgesEdgegroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesEdgeversionreport-example.txt b/build/docs/getTelephonyProvidersEdgesEdgeversionreport-example.txt new file mode 100644 index 000000000..c98f5f38e --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesEdgeversionreport-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the edge version report. +GetTelephonyProvidersEdgesEdgeversionreportRequest.getTelephonyProvidersEdgesEdgeversionreport() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesEdgeversionreportRequest.getTelephonyProvidersEdgesEdgeversionreport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesExpired-example.txt b/build/docs/getTelephonyProvidersEdgesExpired-example.txt new file mode 100644 index 000000000..51b52a1dd --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesExpired-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// List of edges more than 4 edge versions behind the latest software. +GetTelephonyProvidersEdgesExpiredRequest.getTelephonyProvidersEdgesExpired() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesExpiredRequest.getTelephonyProvidersEdgesExpired was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesExtension-example.txt b/build/docs/getTelephonyProvidersEdgesExtension-example.txt new file mode 100644 index 000000000..0a3489292 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesExtension-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let extensionId: String = "" // Extension ID + +// Get an extension by ID. +GetTelephonyProvidersEdgesExtensionRequest.getTelephonyProvidersEdgesExtension(extensionId: extensionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesExtensionRequest.getTelephonyProvidersEdgesExtension was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesExtensionpool-example.txt b/build/docs/getTelephonyProvidersEdgesExtensionpool-example.txt new file mode 100644 index 000000000..a102ac961 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesExtensionpool-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let extensionPoolId: String = "" // Extension pool ID + +// Get an extension pool by ID +GetTelephonyProvidersEdgesExtensionpoolRequest.getTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesExtensionpoolRequest.getTelephonyProvidersEdgesExtensionpool was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesExtensionpools-example.txt b/build/docs/getTelephonyProvidersEdgesExtensionpools-example.txt new file mode 100644 index 000000000..74f0e2bba --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesExtensionpools-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let number: String = "" // Deprecated, filtering by number not supported + +// Get a listing of extension pools +GetTelephonyProvidersEdgesExtensionpoolsRequest.getTelephonyProvidersEdgesExtensionpools(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, number: number) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesExtensionpoolsRequest.getTelephonyProvidersEdgesExtensionpools was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesExtensions-example.txt b/build/docs/getTelephonyProvidersEdgesExtensions-example.txt new file mode 100644 index 000000000..ccadcbd2d --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesExtensions-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let number: String = "" // Filter by number + +// Get a listing of extensions +GetTelephonyProvidersEdgesExtensionsRequest.getTelephonyProvidersEdgesExtensions(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, number: number) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesExtensionsRequest.getTelephonyProvidersEdgesExtensions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLine-example.txt b/build/docs/getTelephonyProvidersEdgesLine-example.txt new file mode 100644 index 000000000..8598254b9 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLine-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let lineId: String = "" // Line ID + +// Get a Line by ID +GetTelephonyProvidersEdgesLineRequest.getTelephonyProvidersEdgesLine(lineId: lineId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLineRequest.getTelephonyProvidersEdgesLine was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLinebasesetting-example.txt b/build/docs/getTelephonyProvidersEdgesLinebasesetting-example.txt new file mode 100644 index 000000000..d530e54f2 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLinebasesetting-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let lineBaseId: String = "" // Line base ID + +// Get a line base settings object by ID +GetTelephonyProvidersEdgesLinebasesettingRequest.getTelephonyProvidersEdgesLinebasesetting(lineBaseId: lineBaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLinebasesettingRequest.getTelephonyProvidersEdgesLinebasesetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLinebasesettings-example.txt b/build/docs/getTelephonyProvidersEdgesLinebasesettings-example.txt new file mode 100644 index 000000000..7c120e672 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLinebasesettings-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Value by which to sort +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // Fields to expand in the response, comma-separated + +// Get a listing of line base settings objects +GetTelephonyProvidersEdgesLinebasesettingsRequest.getTelephonyProvidersEdgesLinebasesettings(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLinebasesettingsRequest.getTelephonyProvidersEdgesLinebasesettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLines-example.txt b/build/docs/getTelephonyProvidersEdgesLines-example.txt new file mode 100644 index 000000000..0fc0edb30 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLines-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let sortBy: String = "" // Value by which to sort +let expand: [String] = [""] // Fields to expand in the response, comma-separated. The edgeGroup value is deprecated. + +// Get a list of Lines +GetTelephonyProvidersEdgesLinesRequest.getTelephonyProvidersEdgesLines(pageSize: pageSize, pageNumber: pageNumber, name: name, sortBy: sortBy, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLinesRequest.getTelephonyProvidersEdgesLines was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLinesTemplate-example.txt b/build/docs/getTelephonyProvidersEdgesLinesTemplate-example.txt new file mode 100644 index 000000000..4f55ce6ec --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLinesTemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let lineBaseSettingsId: String = "" // The id of a Line Base Settings object upon which to base this Line + +// 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 +GetTelephonyProvidersEdgesLinesTemplateRequest.getTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId: lineBaseSettingsId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLinesTemplateRequest.getTelephonyProvidersEdgesLinesTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesLogicalinterfaces-example.txt b/build/docs/getTelephonyProvidersEdgesLogicalinterfaces-example.txt new file mode 100644 index 000000000..b49b7d31d --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesLogicalinterfaces-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeIds: String = "" // Comma separated list of Edge Id's +let expand: [String] = [""] // Field to expand in the response + +// Get edge logical interfaces. +GetTelephonyProvidersEdgesLogicalinterfacesRequest.getTelephonyProvidersEdgesLogicalinterfaces(edgeIds: edgeIds, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesLogicalinterfacesRequest.getTelephonyProvidersEdgesLogicalinterfaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesMetrics-example.txt b/build/docs/getTelephonyProvidersEdgesMetrics-example.txt new file mode 100644 index 000000000..e3dea4e80 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesMetrics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeIds: String = "" // Comma separated list of Edge Id's. Maximum of 100 edge ids allowed. + +// Get the metrics for a list of edges. +GetTelephonyProvidersEdgesMetricsRequest.getTelephonyProvidersEdgesMetrics(edgeIds: edgeIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesMetricsRequest.getTelephonyProvidersEdgesMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesOutboundroute-example.txt b/build/docs/getTelephonyProvidersEdgesOutboundroute-example.txt new file mode 100644 index 000000000..26c9a6394 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesOutboundroute-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let outboundRouteId: String = "" // Outbound route ID + +// Get outbound route +GetTelephonyProvidersEdgesOutboundrouteRequest.getTelephonyProvidersEdgesOutboundroute(outboundRouteId: outboundRouteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesOutboundrouteRequest.getTelephonyProvidersEdgesOutboundroute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesOutboundroutes-example.txt b/build/docs/getTelephonyProvidersEdgesOutboundroutes-example.txt new file mode 100644 index 000000000..a444a3432 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesOutboundroutes-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let siteId: String = "" // Filter by site.id +let externalTrunkBasesIds: String = "" // Filter by externalTrunkBases.ids +let sortBy: String = "" // Sort by + +// Get outbound routes +GetTelephonyProvidersEdgesOutboundroutesRequest.getTelephonyProvidersEdgesOutboundroutes(pageSize: pageSize, pageNumber: pageNumber, name: name, siteId: siteId, externalTrunkBasesIds: externalTrunkBasesIds, sortBy: sortBy) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesOutboundroutesRequest.getTelephonyProvidersEdgesOutboundroutes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhone-example.txt b/build/docs/getTelephonyProvidersEdgesPhone-example.txt new file mode 100644 index 000000000..f832ee55b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhone-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneId: String = "" // Phone ID + +// Get a Phone by ID +GetTelephonyProvidersEdgesPhoneRequest.getTelephonyProvidersEdgesPhone(phoneId: phoneId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhoneRequest.getTelephonyProvidersEdgesPhone was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhonebasesetting-example.txt b/build/docs/getTelephonyProvidersEdgesPhonebasesetting-example.txt new file mode 100644 index 000000000..e7dfd55c2 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhonebasesetting-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneBaseId: String = "" // Phone base ID + +// Get a Phone Base Settings object by ID +GetTelephonyProvidersEdgesPhonebasesettingRequest.getTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonebasesettingRequest.getTelephonyProvidersEdgesPhonebasesetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhonebasesettings-example.txt b/build/docs/getTelephonyProvidersEdgesPhonebasesettings-example.txt new file mode 100644 index 000000000..04bc2b3e7 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhonebasesettings-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Value by which to sort +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // Fields to expand in the response, comma-separated +let name: String = "" // Name + +// Get a list of Phone Base Settings objects +GetTelephonyProvidersEdgesPhonebasesettingsRequest.getTelephonyProvidersEdgesPhonebasesettings(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, expand: expand, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonebasesettingsRequest.getTelephonyProvidersEdgesPhonebasesettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases-example.txt b/build/docs/getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases-example.txt new file mode 100644 index 000000000..4e3a07927 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of available makes and models to create a new Phone Base Settings +GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhonebasesettingsTemplate-example.txt b/build/docs/getTelephonyProvidersEdgesPhonebasesettingsTemplate-example.txt new file mode 100644 index 000000000..ad8c439df --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhonebasesettingsTemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneMetabaseId: String = "" // The id of a metabase object upon which to base this Phone Base Settings + +// 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 +GetTelephonyProvidersEdgesPhonebasesettingsTemplateRequest.getTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId: phoneMetabaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonebasesettingsTemplateRequest.getTelephonyProvidersEdgesPhonebasesettingsTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhones-example.txt b/build/docs/getTelephonyProvidersEdgesPhones-example.txt new file mode 100644 index 000000000..41fd5cdd5 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhones-example.txt @@ -0,0 +1,32 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: GetTelephonyProvidersEdgesPhonesRequest.SortBy_getTelephonyProvidersEdgesPhones = GetTelephonyProvidersEdgesPhonesRequest.SortBy_getTelephonyProvidersEdgesPhones.enummember // The field to sort by +let sortOrder: String = "" // Sort order +let siteId: String = "" // Filter by site.id +let webRtcUserId: String = "" // Filter by webRtcUser.id +let phoneBaseSettingsId: String = "" // Filter by phoneBaseSettings.id +let linesLoggedInUserId: String = "" // Filter by lines.loggedInUser.id +let linesDefaultForUserId: String = "" // Filter by lines.defaultForUser.id +let phoneHardwareId: String = "" // Filter by phone_hardwareId +let linesId: String = "" // Filter by lines.id +let linesName: String = "" // Filter by lines.name +let name: String = "" // Name of the Phone to filter by, comma-separated +let statusOperationalStatus: String = "" // The primary status to filter by +let secondaryStatusOperationalStatus: String = "" // The secondary status to filter by +let expand: [String] = [""] // Fields to expand in the response, comma-separated +let fields: [String] = [""] // Fields and properties to get, comma-separated + +// Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values. +GetTelephonyProvidersEdgesPhonesRequest.getTelephonyProvidersEdgesPhones(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, siteId: siteId, webRtcUserId: webRtcUserId, phoneBaseSettingsId: phoneBaseSettingsId, linesLoggedInUserId: linesLoggedInUserId, linesDefaultForUserId: linesDefaultForUserId, phoneHardwareId: phoneHardwareId, linesId: linesId, linesName: linesName, name: name, statusOperationalStatus: statusOperationalStatus, secondaryStatusOperationalStatus: secondaryStatusOperationalStatus, expand: expand, fields: fields) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonesRequest.getTelephonyProvidersEdgesPhones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhonesTemplate-example.txt b/build/docs/getTelephonyProvidersEdgesPhonesTemplate-example.txt new file mode 100644 index 000000000..2d3b2ad0c --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhonesTemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneBaseSettingsId: String = "" // The id of a Phone Base Settings object upon which to base this Phone + +// 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 +GetTelephonyProvidersEdgesPhonesTemplateRequest.getTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId: phoneBaseSettingsId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhonesTemplateRequest.getTelephonyProvidersEdgesPhonesTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesPhysicalinterfaces-example.txt b/build/docs/getTelephonyProvidersEdgesPhysicalinterfaces-example.txt new file mode 100644 index 000000000..2a33ba29a --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesPhysicalinterfaces-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeIds: String = "" // Comma separated list of Edge Id's + +// Get physical interfaces for edges. +GetTelephonyProvidersEdgesPhysicalinterfacesRequest.getTelephonyProvidersEdgesPhysicalinterfaces(edgeIds: edgeIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesPhysicalinterfacesRequest.getTelephonyProvidersEdgesPhysicalinterfaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSite-example.txt b/build/docs/getTelephonyProvidersEdgesSite-example.txt new file mode 100644 index 000000000..bd7993a10 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSite-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID + +// Get a Site by ID. +GetTelephonyProvidersEdgesSiteRequest.getTelephonyProvidersEdgesSite(siteId: siteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteRequest.getTelephonyProvidersEdgesSite was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSiteNumberplan-example.txt b/build/docs/getTelephonyProvidersEdgesSiteNumberplan-example.txt new file mode 100644 index 000000000..537e978a7 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSiteNumberplan-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let numberPlanId: String = "" // Number Plan ID + +// Get a Number Plan by ID. +GetTelephonyProvidersEdgesSiteNumberplanRequest.getTelephonyProvidersEdgesSiteNumberplan(siteId: siteId, numberPlanId: numberPlanId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteNumberplanRequest.getTelephonyProvidersEdgesSiteNumberplan was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSiteNumberplans-example.txt b/build/docs/getTelephonyProvidersEdgesSiteNumberplans-example.txt new file mode 100644 index 000000000..3cac43dd6 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSiteNumberplans-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID + +// Get the list of Number Plans for this Site. Only fetches the first 200 records. +GetTelephonyProvidersEdgesSiteNumberplansRequest.getTelephonyProvidersEdgesSiteNumberplans(siteId: siteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteNumberplansRequest.getTelephonyProvidersEdgesSiteNumberplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSiteNumberplansClassifications-example.txt b/build/docs/getTelephonyProvidersEdgesSiteNumberplansClassifications-example.txt new file mode 100644 index 000000000..06f0af358 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSiteNumberplansClassifications-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let classification: String = "" // Classification + +// Get a list of Classifications for this Site +GetTelephonyProvidersEdgesSiteNumberplansClassificationsRequest.getTelephonyProvidersEdgesSiteNumberplansClassifications(siteId: siteId, classification: classification) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteNumberplansClassificationsRequest.getTelephonyProvidersEdgesSiteNumberplansClassifications was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSiteOutboundroute-example.txt b/build/docs/getTelephonyProvidersEdgesSiteOutboundroute-example.txt new file mode 100644 index 000000000..7a03f476b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSiteOutboundroute-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let outboundRouteId: String = "" // Outbound route ID + +// Get an outbound route +GetTelephonyProvidersEdgesSiteOutboundrouteRequest.getTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteOutboundrouteRequest.getTelephonyProvidersEdgesSiteOutboundroute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSiteOutboundroutes-example.txt b/build/docs/getTelephonyProvidersEdgesSiteOutboundroutes-example.txt new file mode 100644 index 000000000..f137d61c0 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSiteOutboundroutes-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let name: String = "" // Name +let externalTrunkBasesIds: String = "" // externalTrunkBases.ids +let sortBy: String = "" // Sort by + +// Get outbound routes +GetTelephonyProvidersEdgesSiteOutboundroutesRequest.getTelephonyProvidersEdgesSiteOutboundroutes(siteId: siteId, pageSize: pageSize, pageNumber: pageNumber, name: name, externalTrunkBasesIds: externalTrunkBasesIds, sortBy: sortBy) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSiteOutboundroutesRequest.getTelephonyProvidersEdgesSiteOutboundroutes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesSites-example.txt b/build/docs/getTelephonyProvidersEdgesSites-example.txt new file mode 100644 index 000000000..28718569d --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesSites-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let name: String = "" // Name +let locationId: String = "" // Location Id +let managed: Bool = true // Filter by managed + +// Get the list of Sites. +GetTelephonyProvidersEdgesSitesRequest.getTelephonyProvidersEdgesSites(pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, name: name, locationId: locationId, managed: managed) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesSitesRequest.getTelephonyProvidersEdgesSites was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTimezones-example.txt b/build/docs/getTelephonyProvidersEdgesTimezones-example.txt new file mode 100644 index 000000000..92d82e13b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTimezones-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of Edge-compatible time zones +GetTelephonyProvidersEdgesTimezonesRequest.getTelephonyProvidersEdgesTimezones(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTimezonesRequest.getTelephonyProvidersEdgesTimezones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunk-example.txt b/build/docs/getTelephonyProvidersEdgesTrunk-example.txt new file mode 100644 index 000000000..ee48ac432 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkId: String = "" // Trunk ID + +// Get a Trunk by ID +GetTelephonyProvidersEdgesTrunkRequest.getTelephonyProvidersEdgesTrunk(trunkId: trunkId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkRequest.getTelephonyProvidersEdgesTrunk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkMetrics-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkMetrics-example.txt new file mode 100644 index 000000000..ae0c2d130 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkMetrics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkId: String = "" // Trunk Id + +// Get the trunk metrics. +GetTelephonyProvidersEdgesTrunkMetricsRequest.getTelephonyProvidersEdgesTrunkMetrics(trunkId: trunkId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkMetricsRequest.getTelephonyProvidersEdgesTrunkMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkbasesetting-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkbasesetting-example.txt new file mode 100644 index 000000000..c84a91595 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkbasesetting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkBaseSettingsId: String = "" // Trunk Base ID +let ignoreHidden: Bool = true // Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. + +// Get a Trunk Base Settings object by ID +GetTelephonyProvidersEdgesTrunkbasesettingRequest.getTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId, ignoreHidden: ignoreHidden) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkbasesettingRequest.getTelephonyProvidersEdgesTrunkbasesetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkbasesettings-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkbasesettings-example.txt new file mode 100644 index 000000000..0a586d9b0 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkbasesettings-example.txt @@ -0,0 +1,24 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Value by which to sort +let sortOrder: String = "" // Sort order +let recordingEnabled: Bool = true // Filter trunks by recording enabled +let ignoreHidden: Bool = true // Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. +let managed: Bool = true // Filter by managed +let expand: [String] = [""] // Fields to expand in the response, comma-separated +let name: String = "" // Name of the TrunkBase to filter by + +// Get Trunk Base Settings listing +GetTelephonyProvidersEdgesTrunkbasesettingsRequest.getTelephonyProvidersEdgesTrunkbasesettings(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, recordingEnabled: recordingEnabled, ignoreHidden: ignoreHidden, managed: managed, expand: expand, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkbasesettingsRequest.getTelephonyProvidersEdgesTrunkbasesettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases-example.txt new file mode 100644 index 000000000..258b4f74b --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let type: GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.ModelType_getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases = GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.ModelType_getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases.enummember // +let pageSize: Int = 0 // +let pageNumber: Int = 0 // + +// Get a list of available makes and models to create a new Trunk Base Settings +GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(type: type, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabasesRequest.getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsTemplate-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsTemplate-example.txt new file mode 100644 index 000000000..84ded9367 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkbasesettingsTemplate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkMetabaseId: String = "" // The id of a metabase object upon which to base this Trunk Base Settings + +// 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 +GetTelephonyProvidersEdgesTrunkbasesettingsTemplateRequest.getTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId: trunkMetabaseId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkbasesettingsTemplateRequest.getTelephonyProvidersEdgesTrunkbasesettingsTemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunks-example.txt b/build/docs/getTelephonyProvidersEdgesTrunks-example.txt new file mode 100644 index 000000000..802da09b8 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunks-example.txt @@ -0,0 +1,22 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageNumber: Int = 0 // Page number +let pageSize: Int = 0 // Page size +let sortBy: String = "" // Value by which to sort +let sortOrder: String = "" // Sort order +let edgeId: String = "" // Filter by Edge Ids +let trunkBaseId: String = "" // Filter by Trunk Base Ids +let trunkType: GetTelephonyProvidersEdgesTrunksRequest.TrunkType_getTelephonyProvidersEdgesTrunks = GetTelephonyProvidersEdgesTrunksRequest.TrunkType_getTelephonyProvidersEdgesTrunks.enummember // Filter by a Trunk type + +// Get the list of available trunks. +GetTelephonyProvidersEdgesTrunksRequest.getTelephonyProvidersEdgesTrunks(pageNumber: pageNumber, pageSize: pageSize, sortBy: sortBy, sortOrder: sortOrder, edgeId: edgeId, trunkBaseId: trunkBaseId, trunkType: trunkType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunksRequest.getTelephonyProvidersEdgesTrunks was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunksMetrics-example.txt b/build/docs/getTelephonyProvidersEdgesTrunksMetrics-example.txt new file mode 100644 index 000000000..395e9b998 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunksMetrics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkIds: String = "" // Comma separated list of Trunk Id's + +// Get the metrics for a list of trunks. +GetTelephonyProvidersEdgesTrunksMetricsRequest.getTelephonyProvidersEdgesTrunksMetrics(trunkIds: trunkIds) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunksMetricsRequest.getTelephonyProvidersEdgesTrunksMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonyProvidersEdgesTrunkswithrecording-example.txt b/build/docs/getTelephonyProvidersEdgesTrunkswithrecording-example.txt new file mode 100644 index 000000000..22e9e05e2 --- /dev/null +++ b/build/docs/getTelephonyProvidersEdgesTrunkswithrecording-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkType: GetTelephonyProvidersEdgesTrunkswithrecordingRequest.TrunkType_getTelephonyProvidersEdgesTrunkswithrecording = GetTelephonyProvidersEdgesTrunkswithrecordingRequest.TrunkType_getTelephonyProvidersEdgesTrunkswithrecording.enummember // The type of this trunk base. + +// Get Counts of trunks that have recording disabled or enabled +GetTelephonyProvidersEdgesTrunkswithrecordingRequest.getTelephonyProvidersEdgesTrunkswithrecording(trunkType: trunkType) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonyProvidersEdgesTrunkswithrecordingRequest.getTelephonyProvidersEdgesTrunkswithrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonySiptraces-example.txt b/build/docs/getTelephonySiptraces-example.txt new file mode 100644 index 000000000..6a51398d4 --- /dev/null +++ b/build/docs/getTelephonySiptraces-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dateStart: Date = new Date(...) // Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let dateEnd: Date = new Date(...) // End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z +let callId: String = "" // unique identification of the placed call +let toUser: String = "" // User to who the call was placed +let fromUser: String = "" // user who placed the call +let conversationId: String = "" // Unique identification of the conversation + +// Fetch SIP metadata +GetTelephonySiptracesRequest.getTelephonySiptraces(dateStart: dateStart, dateEnd: dateEnd, callId: callId, toUser: toUser, fromUser: fromUser, conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonySiptracesRequest.getTelephonySiptraces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTelephonySiptracesDownloadDownloadId-example.txt b/build/docs/getTelephonySiptracesDownloadDownloadId-example.txt new file mode 100644 index 000000000..49ffb490c --- /dev/null +++ b/build/docs/getTelephonySiptracesDownloadDownloadId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let downloadId: String = "" // unique id for the downloaded file in S3 + +// Get signed S3 URL for a pcap download +GetTelephonySiptracesDownloadDownloadIdRequest.getTelephonySiptracesDownloadDownloadId(downloadId: downloadId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTelephonySiptracesDownloadDownloadIdRequest.getTelephonySiptracesDownloadDownloadId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTextbotsBotsSearch-example.txt b/build/docs/getTextbotsBotsSearch-example.txt new file mode 100644 index 000000000..74ca81720 --- /dev/null +++ b/build/docs/getTextbotsBotsSearch-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let botType: [String] = [""] // Bot types +let botName: String = "" // Bot name +let botId: [String] = [""] // Bot IDs +let pageSize: Int = 0 // The maximum results to return + +// Find bots using the currently configured friendly name or ID. +GetTextbotsBotsSearchRequest.getTextbotsBotsSearch(botType: botType, botName: botName, botId: botId, pageSize: pageSize) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTextbotsBotsSearchRequest.getTextbotsBotsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTimezones-example.txt b/build/docs/getTimezones-example.txt new file mode 100644 index 000000000..c291e51e8 --- /dev/null +++ b/build/docs/getTimezones-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get time zones list +GetTimezonesRequest.getTimezones(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTimezonesRequest.getTimezones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getTokensMe-example.txt b/build/docs/getTokensMe-example.txt new file mode 100644 index 000000000..64f1cacfc --- /dev/null +++ b/build/docs/getTokensMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let preserveIdleTTL: Bool = true // preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset. + +// Fetch information about the current token +GetTokensMeRequest.getTokensMe(preserveIdleTTL: preserveIdleTTL) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetTokensMeRequest.getTokensMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsageQueryExecutionIdResults-example.txt b/build/docs/getUsageQueryExecutionIdResults-example.txt new file mode 100644 index 000000000..0bdda8016 --- /dev/null +++ b/build/docs/getUsageQueryExecutionIdResults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let executionId: String = "" // ID of the query execution + +// Get the results of a usage query +GetUsageQueryExecutionIdResultsRequest.getUsageQueryExecutionIdResults(executionId: executionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsageQueryExecutionIdResultsRequest.getUsageQueryExecutionIdResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsageSimplesearchExecutionIdResults-example.txt b/build/docs/getUsageSimplesearchExecutionIdResults-example.txt new file mode 100644 index 000000000..dc9401dd7 --- /dev/null +++ b/build/docs/getUsageSimplesearchExecutionIdResults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let executionId: String = "" // ID of the search execution + +// Get the results of a usage search +GetUsageSimplesearchExecutionIdResultsRequest.getUsageSimplesearchExecutionIdResults(executionId: executionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsageSimplesearchExecutionIdResultsRequest.getUsageSimplesearchExecutionIdResults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUser-example.txt b/build/docs/getUser-example.txt new file mode 100644 index 000000000..ed792b3dd --- /dev/null +++ b/build/docs/getUser-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let expand: [String] = [""] // Which fields, if any, to expand +let integrationPresenceSource: GetUserRequest.IntegrationPresenceSource_getUser = GetUserRequest.IntegrationPresenceSource_getUser.enummember // Gets an integration presence for a user instead of their default. +let state: GetUserRequest.State_getUser = GetUserRequest.State_getUser.enummember // Search for a user with this state + +// Get user. +GetUserRequest.getUser(userId: userId, expand: expand, integrationPresenceSource: integrationPresenceSource, state: state) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserRequest.getUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserAdjacents-example.txt b/build/docs/getUserAdjacents-example.txt new file mode 100644 index 000000000..0524d2970 --- /dev/null +++ b/build/docs/getUserAdjacents-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get adjacents +GetUserAdjacentsRequest.getUserAdjacents(userId: userId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserAdjacentsRequest.getUserAdjacents was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserCallforwarding-example.txt b/build/docs/getUserCallforwarding-example.txt new file mode 100644 index 000000000..61b90c6d1 --- /dev/null +++ b/build/docs/getUserCallforwarding-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get a user's CallForwarding +GetUserCallforwardingRequest.getUserCallforwarding(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserCallforwardingRequest.getUserCallforwarding was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserDirectreports-example.txt b/build/docs/getUserDirectreports-example.txt new file mode 100644 index 000000000..34097e688 --- /dev/null +++ b/build/docs/getUserDirectreports-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get direct reports +GetUserDirectreportsRequest.getUserDirectreports(userId: userId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserDirectreportsRequest.getUserDirectreports was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserFavorites-example.txt b/build/docs/getUserFavorites-example.txt new file mode 100644 index 000000000..ec646540e --- /dev/null +++ b/build/docs/getUserFavorites-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: String = "" // Sort order +let expand: [String] = [""] // Which fields, if any, to expand + +// Deprecated; will be revived with new contract +GetUserFavoritesRequest.getUserFavorites(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserFavoritesRequest.getUserFavorites was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserGeolocation-example.txt b/build/docs/getUserGeolocation-example.txt new file mode 100644 index 000000000..860bd0653 --- /dev/null +++ b/build/docs/getUserGeolocation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id +let clientId: String = "" // client Id + +// Get a user's Geolocation +GetUserGeolocationRequest.getUserGeolocation(userId: userId, clientId: clientId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserGeolocationRequest.getUserGeolocation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserGreetings-example.txt b/build/docs/getUserGreetings-example.txt new file mode 100644 index 000000000..00bd36039 --- /dev/null +++ b/build/docs/getUserGreetings-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get a list of the User's Greetings +GetUserGreetingsRequest.getUserGreetings(userId: userId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserGreetingsRequest.getUserGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserGreetingsDefaults-example.txt b/build/docs/getUserGreetingsDefaults-example.txt new file mode 100644 index 000000000..34ea13643 --- /dev/null +++ b/build/docs/getUserGreetingsDefaults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Grabs the list of Default Greetings given a User's ID +GetUserGreetingsDefaultsRequest.getUserGreetingsDefaults(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserGreetingsDefaultsRequest.getUserGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserOutofoffice-example.txt b/build/docs/getUserOutofoffice-example.txt new file mode 100644 index 000000000..342818c34 --- /dev/null +++ b/build/docs/getUserOutofoffice-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get a OutOfOffice +GetUserOutofofficeRequest.getUserOutofoffice(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserOutofofficeRequest.getUserOutofoffice was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserPresence-example.txt b/build/docs/getUserPresence-example.txt new file mode 100644 index 000000000..01ad6cc42 --- /dev/null +++ b/build/docs/getUserPresence-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id +let sourceId: String = "" // Presence source ID + +// Get a user's Presence +GetUserPresenceRequest.getUserPresence(userId: userId, sourceId: sourceId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserPresenceRequest.getUserPresence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserPresencesPurecloud-example.txt b/build/docs/getUserPresencesPurecloud-example.txt new file mode 100644 index 000000000..52b66ecbc --- /dev/null +++ b/build/docs/getUserPresencesPurecloud-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id + +// Get a user's Genesys Cloud presence. +GetUserPresencesPurecloudRequest.getUserPresencesPurecloud(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserPresencesPurecloudRequest.getUserPresencesPurecloud was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserProfile-example.txt b/build/docs/getUserProfile-example.txt new file mode 100644 index 000000000..db616448b --- /dev/null +++ b/build/docs/getUserProfile-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // userId +let expand: [String] = [""] // Which fields, if any, to expand +let integrationPresenceSource: GetUserProfileRequest.IntegrationPresenceSource_getUserProfile = GetUserProfileRequest.IntegrationPresenceSource_getUserProfile.enummember // Gets an integration presence for a user instead of their default. + +// Get user profile +GetUserProfileRequest.getUserProfile(userId: userId, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserProfileRequest.getUserProfile was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserProfileskills-example.txt b/build/docs/getUserProfileskills-example.txt new file mode 100644 index 000000000..bf06e9002 --- /dev/null +++ b/build/docs/getUserProfileskills-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// List profile skills for a user +GetUserProfileskillsRequest.getUserProfileskills(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserProfileskillsRequest.getUserProfileskills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserQueues-example.txt b/build/docs/getUserQueues-example.txt new file mode 100644 index 000000000..8e87e012b --- /dev/null +++ b/build/docs/getUserQueues-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let joined: Bool = true // Is joined to the queue +let divisionId: [String] = [""] // Division ID(s) + +// Get queues for user +GetUserQueuesRequest.getUserQueues(userId: userId, pageSize: pageSize, pageNumber: pageNumber, joined: joined, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserQueuesRequest.getUserQueues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserRoles-example.txt b/build/docs/getUserRoles-example.txt new file mode 100644 index 000000000..0e786e982 --- /dev/null +++ b/build/docs/getUserRoles-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // User ID + +// Returns a listing of roles and permissions for a user. +GetUserRolesRequest.getUserRoles(subjectId: subjectId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserRolesRequest.getUserRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserRoutinglanguages-example.txt b/build/docs/getUserRoutinglanguages-example.txt new file mode 100644 index 000000000..3bcebeee6 --- /dev/null +++ b/build/docs/getUserRoutinglanguages-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetUserRoutinglanguagesRequest.SortOrder_getUserRoutinglanguages = GetUserRoutinglanguagesRequest.SortOrder_getUserRoutinglanguages.enummember // Ascending or descending sort order + +// List routing language for user +GetUserRoutinglanguagesRequest.getUserRoutinglanguages(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserRoutinglanguagesRequest.getUserRoutinglanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserRoutingskills-example.txt b/build/docs/getUserRoutingskills-example.txt new file mode 100644 index 000000000..853ac73c6 --- /dev/null +++ b/build/docs/getUserRoutingskills-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetUserRoutingskillsRequest.SortOrder_getUserRoutingskills = GetUserRoutingskillsRequest.SortOrder_getUserRoutingskills.enummember // Ascending or descending sort order + +// List routing skills for user +GetUserRoutingskillsRequest.getUserRoutingskills(userId: userId, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserRoutingskillsRequest.getUserRoutingskills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserRoutingstatus-example.txt b/build/docs/getUserRoutingstatus-example.txt new file mode 100644 index 000000000..8dd405558 --- /dev/null +++ b/build/docs/getUserRoutingstatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Fetch the routing status of a user +GetUserRoutingstatusRequest.getUserRoutingstatus(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserRoutingstatusRequest.getUserRoutingstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserSkillgroups-example.txt b/build/docs/getUserSkillgroups-example.txt new file mode 100644 index 000000000..d7842a402 --- /dev/null +++ b/build/docs/getUserSkillgroups-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let after: String = "" // The cursor that points to the next page +let before: String = "" // The cursor that points to the previous page + +// Get skill groups for a user +GetUserSkillgroupsRequest.getUserSkillgroups(userId: userId, pageSize: pageSize, after: after, before: before) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserSkillgroupsRequest.getUserSkillgroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserState-example.txt b/build/docs/getUserState-example.txt new file mode 100644 index 000000000..a5f11b352 --- /dev/null +++ b/build/docs/getUserState-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get user state information. +GetUserStateRequest.getUserState(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserStateRequest.getUserState was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserStation-example.txt b/build/docs/getUserStation-example.txt new file mode 100644 index 000000000..018d414be --- /dev/null +++ b/build/docs/getUserStation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get station information for user +GetUserStationRequest.getUserStation(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserStationRequest.getUserStation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserSuperiors-example.txt b/build/docs/getUserSuperiors-example.txt new file mode 100644 index 000000000..b3eeff27a --- /dev/null +++ b/build/docs/getUserSuperiors-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let expand: [String] = [""] // Which fields, if any, to expand + +// Get superiors +GetUserSuperiorsRequest.getUserSuperiors(userId: userId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserSuperiorsRequest.getUserSuperiors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserTrustors-example.txt b/build/docs/getUserTrustors-example.txt new file mode 100644 index 000000000..b02b9ad49 --- /dev/null +++ b/build/docs/getUserTrustors-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// List the organizations that have authorized/trusted the user. +GetUserTrustorsRequest.getUserTrustors(userId: userId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserTrustorsRequest.getUserTrustors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserrecording-example.txt b/build/docs/getUserrecording-example.txt new file mode 100644 index 000000000..bb06aeb37 --- /dev/null +++ b/build/docs/getUserrecording-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recordingId: String = "" // User Recording ID +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a user recording. +GetUserrecordingRequest.getUserrecording(recordingId: recordingId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserrecordingRequest.getUserrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserrecordingMedia-example.txt b/build/docs/getUserrecordingMedia-example.txt new file mode 100644 index 000000000..3989e32e2 --- /dev/null +++ b/build/docs/getUserrecordingMedia-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recordingId: String = "" // User Recording ID +let formatId: GetUserrecordingMediaRequest.FormatId_getUserrecordingMedia = GetUserrecordingMediaRequest.FormatId_getUserrecordingMedia.enummember // The desired media format. +let async: Bool = true // When set to true, api will return 202 response until the recording is ready for download + +// Download a user recording. +GetUserrecordingMediaRequest.getUserrecordingMedia(recordingId: recordingId, formatId: formatId, async: async) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserrecordingMediaRequest.getUserrecordingMedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserrecordings-example.txt b/build/docs/getUserrecordings-example.txt new file mode 100644 index 000000000..092492f06 --- /dev/null +++ b/build/docs/getUserrecordings-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let expand: [String] = [""] // Which fields, if any, to expand. + +// Get a list of user recordings. +GetUserrecordingsRequest.getUserrecordings(pageSize: pageSize, pageNumber: pageNumber, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserrecordingsRequest.getUserrecordings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUserrecordingsSummary-example.txt b/build/docs/getUserrecordingsSummary-example.txt new file mode 100644 index 000000000..ae574f5ce --- /dev/null +++ b/build/docs/getUserrecordingsSummary-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get user recording summary +GetUserrecordingsSummaryRequest.getUserrecordingsSummary() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUserrecordingsSummaryRequest.getUserrecordingsSummary was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsers-example.txt b/build/docs/getUsers-example.txt new file mode 100644 index 000000000..a3175b9e7 --- /dev/null +++ b/build/docs/getUsers-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let _id: [String] = [""] // A list of user IDs to fetch by bulk +let jabberId: [String] = [""] // A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) +let sortOrder: GetUsersRequest.SortOrder_getUsers = GetUsersRequest.SortOrder_getUsers.enummember // Ascending or descending sort order +let expand: [String] = [""] // Which fields, if any, to expand +let integrationPresenceSource: GetUsersRequest.IntegrationPresenceSource_getUsers = GetUsersRequest.IntegrationPresenceSource_getUsers.enummember // 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 100. +let state: GetUsersRequest.State_getUsers = GetUsersRequest.State_getUsers.enummember // Only list users of this state + +// Get the list of available users. +GetUsersRequest.getUsers(pageSize: pageSize, pageNumber: pageNumber, _id: _id, jabberId: jabberId, sortOrder: sortOrder, expand: expand, integrationPresenceSource: integrationPresenceSource, state: state) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersRequest.getUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersDevelopmentActivities-example.txt b/build/docs/getUsersDevelopmentActivities-example.txt new file mode 100644 index 000000000..e32bd1c1c --- /dev/null +++ b/build/docs/getUsersDevelopmentActivities-example.txt @@ -0,0 +1,27 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: [String] = [""] // Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId. +let moduleId: String = "" // Specifies the ID of the learning module. +let interval: String = "" // 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 +let completionInterval: String = "" // 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 +let overdue: GetUsersDevelopmentActivitiesRequest.Overdue_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.Overdue_getUsersDevelopmentActivities.enummember // Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned +let pass: GetUsersDevelopmentActivitiesRequest.Pass_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.Pass_getUsersDevelopmentActivities.enummember // Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetUsersDevelopmentActivitiesRequest.SortOrder_getUsersDevelopmentActivities = GetUsersDevelopmentActivitiesRequest.SortOrder_getUsersDevelopmentActivities.enummember // Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) +let types: [String] = [""] // Specifies the activity types. +let statuses: [String] = [""] // Specifies the activity statuses to filter by +let relationship: [String] = [""] // 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. + +// Get list of Development Activities +GetUsersDevelopmentActivitiesRequest.getUsersDevelopmentActivities(userId: userId, moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pass: pass, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, types: types, statuses: statuses, relationship: relationship) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersDevelopmentActivitiesRequest.getUsersDevelopmentActivities was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersDevelopmentActivitiesMe-example.txt b/build/docs/getUsersDevelopmentActivitiesMe-example.txt new file mode 100644 index 000000000..762eb3860 --- /dev/null +++ b/build/docs/getUsersDevelopmentActivitiesMe-example.txt @@ -0,0 +1,26 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // Specifies the ID of the learning module. +let interval: String = "" // 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 +let completionInterval: String = "" // 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 +let overdue: GetUsersDevelopmentActivitiesMeRequest.Overdue_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.Overdue_getUsersDevelopmentActivitiesMe.enummember // Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned +let pass: GetUsersDevelopmentActivitiesMeRequest.Pass_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.Pass_getUsersDevelopmentActivitiesMe.enummember // Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortOrder: GetUsersDevelopmentActivitiesMeRequest.SortOrder_getUsersDevelopmentActivitiesMe = GetUsersDevelopmentActivitiesMeRequest.SortOrder_getUsersDevelopmentActivitiesMe.enummember // Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) +let types: [String] = [""] // Specifies the activity types. +let statuses: [String] = [""] // Specifies the activity statuses to filter by +let relationship: [String] = [""] // 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. + +// Get list of Development Activities for current user +GetUsersDevelopmentActivitiesMeRequest.getUsersDevelopmentActivitiesMe(moduleId: moduleId, interval: interval, completionInterval: completionInterval, overdue: overdue, pass: pass, pageSize: pageSize, pageNumber: pageNumber, sortOrder: sortOrder, types: types, statuses: statuses, relationship: relationship) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersDevelopmentActivitiesMeRequest.getUsersDevelopmentActivitiesMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersDevelopmentActivity-example.txt b/build/docs/getUsersDevelopmentActivity-example.txt new file mode 100644 index 000000000..8f403741e --- /dev/null +++ b/build/docs/getUsersDevelopmentActivity-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let activityId: String = "" // Specifies the activity ID, maps to either assignment or appointment ID +let type: GetUsersDevelopmentActivityRequest.ModelType_getUsersDevelopmentActivity = GetUsersDevelopmentActivityRequest.ModelType_getUsersDevelopmentActivity.enummember // Specifies the activity type. + +// Get a Development Activity +GetUsersDevelopmentActivityRequest.getUsersDevelopmentActivity(activityId: activityId, type: type) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersDevelopmentActivityRequest.getUsersDevelopmentActivity was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersMe-example.txt b/build/docs/getUsersMe-example.txt new file mode 100644 index 000000000..57c47c046 --- /dev/null +++ b/build/docs/getUsersMe-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: [String] = [""] // Which fields, if any, to expand. +let integrationPresenceSource: GetUsersMeRequest.IntegrationPresenceSource_getUsersMe = GetUsersMeRequest.IntegrationPresenceSource_getUsersMe.enummember // Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\". + +// Get current user details. +GetUsersMeRequest.getUsersMe(expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersMeRequest.getUsersMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersPresenceBulk-example.txt b/build/docs/getUsersPresenceBulk-example.txt new file mode 100644 index 000000000..585186df5 --- /dev/null +++ b/build/docs/getUsersPresenceBulk-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sourceId: String = "" // The requested presence source ID. +let _id: [String] = [""] // A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. + +// Get bulk user presences for a single presence source +GetUsersPresenceBulkRequest.getUsersPresenceBulk(sourceId: sourceId, _id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersPresenceBulkRequest.getUsersPresenceBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersPresencesPurecloudBulk-example.txt b/build/docs/getUsersPresencesPurecloudBulk-example.txt new file mode 100644 index 000000000..44ed2e801 --- /dev/null +++ b/build/docs/getUsersPresencesPurecloudBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let _id: [String] = [""] // A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. + +// Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source +GetUsersPresencesPurecloudBulkRequest.getUsersPresencesPurecloudBulk(_id: _id) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersPresencesPurecloudBulkRequest.getUsersPresencesPurecloudBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getUsersSearch-example.txt b/build/docs/getUsersSearch-example.txt new file mode 100644 index 000000000..43829c02c --- /dev/null +++ b/build/docs/getUsersSearch-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // expand +let integrationPresenceSource: GetUsersSearchRequest.IntegrationPresenceSource_getUsersSearch = GetUsersSearchRequest.IntegrationPresenceSource_getUsersSearch.enummember // integrationPresenceSource + +// Search users using the q64 value returned from a previous search +GetUsersSearchRequest.getUsersSearch(q64: q64, expand: expand, integrationPresenceSource: integrationPresenceSource) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetUsersSearchRequest.getUsersSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailGroupMailbox-example.txt b/build/docs/getVoicemailGroupMailbox-example.txt new file mode 100644 index 000000000..a955fa9da --- /dev/null +++ b/build/docs/getVoicemailGroupMailbox-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // groupId + +// Get the group's mailbox information +GetVoicemailGroupMailboxRequest.getVoicemailGroupMailbox(groupId: groupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailGroupMailboxRequest.getVoicemailGroupMailbox was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailGroupMessages-example.txt b/build/docs/getVoicemailGroupMessages-example.txt new file mode 100644 index 000000000..d7b38a1f7 --- /dev/null +++ b/build/docs/getVoicemailGroupMessages-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// List voicemail messages +GetVoicemailGroupMessagesRequest.getVoicemailGroupMessages(groupId: groupId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailGroupMessagesRequest.getVoicemailGroupMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailGroupPolicy-example.txt b/build/docs/getVoicemailGroupPolicy-example.txt new file mode 100644 index 000000000..e51078373 --- /dev/null +++ b/build/docs/getVoicemailGroupPolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID + +// Get a group's voicemail policy +GetVoicemailGroupPolicyRequest.getVoicemailGroupPolicy(groupId: groupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailGroupPolicyRequest.getVoicemailGroupPolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMailbox-example.txt b/build/docs/getVoicemailMailbox-example.txt new file mode 100644 index 000000000..45bc0a31a --- /dev/null +++ b/build/docs/getVoicemailMailbox-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the current user's mailbox information +GetVoicemailMailboxRequest.getVoicemailMailbox() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMailboxRequest.getVoicemailMailbox was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMeMailbox-example.txt b/build/docs/getVoicemailMeMailbox-example.txt new file mode 100644 index 000000000..93772cf95 --- /dev/null +++ b/build/docs/getVoicemailMeMailbox-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the current user's mailbox information +GetVoicemailMeMailboxRequest.getVoicemailMeMailbox() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMeMailboxRequest.getVoicemailMeMailbox was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMeMessages-example.txt b/build/docs/getVoicemailMeMessages-example.txt new file mode 100644 index 000000000..49a51d35d --- /dev/null +++ b/build/docs/getVoicemailMeMessages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// List voicemail messages +GetVoicemailMeMessagesRequest.getVoicemailMeMessages(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMeMessagesRequest.getVoicemailMeMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMePolicy-example.txt b/build/docs/getVoicemailMePolicy-example.txt new file mode 100644 index 000000000..bc7609c0b --- /dev/null +++ b/build/docs/getVoicemailMePolicy-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the current user's voicemail policy +GetVoicemailMePolicyRequest.getVoicemailMePolicy() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMePolicyRequest.getVoicemailMePolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMessage-example.txt b/build/docs/getVoicemailMessage-example.txt new file mode 100644 index 000000000..545d75f2e --- /dev/null +++ b/build/docs/getVoicemailMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // Message ID +let expand: [String] = [""] // If the caller is a known user, which fields, if any, to expand + +// Get a voicemail message +GetVoicemailMessageRequest.getVoicemailMessage(messageId: messageId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMessageRequest.getVoicemailMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMessageMedia-example.txt b/build/docs/getVoicemailMessageMedia-example.txt new file mode 100644 index 000000000..f73b376b4 --- /dev/null +++ b/build/docs/getVoicemailMessageMedia-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // Message ID +let formatId: GetVoicemailMessageMediaRequest.FormatId_getVoicemailMessageMedia = GetVoicemailMessageMediaRequest.FormatId_getVoicemailMessageMedia.enummember // The desired media format. + +// Get media playback URI for this voicemail message +GetVoicemailMessageMediaRequest.getVoicemailMessageMedia(messageId: messageId, formatId: formatId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMessageMediaRequest.getVoicemailMessageMedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailMessages-example.txt b/build/docs/getVoicemailMessages-example.txt new file mode 100644 index 000000000..2cee142f2 --- /dev/null +++ b/build/docs/getVoicemailMessages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ids: String = "" // An optional comma separated list of VoicemailMessage ids +let expand: [String] = [""] // If the caller is a known user, which fields, if any, to expand + +// List voicemail messages +GetVoicemailMessagesRequest.getVoicemailMessages(ids: ids, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailMessagesRequest.getVoicemailMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailPolicy-example.txt b/build/docs/getVoicemailPolicy-example.txt new file mode 100644 index 000000000..540d33be8 --- /dev/null +++ b/build/docs/getVoicemailPolicy-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a policy +GetVoicemailPolicyRequest.getVoicemailPolicy() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailPolicyRequest.getVoicemailPolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailQueueMessages-example.txt b/build/docs/getVoicemailQueueMessages-example.txt new file mode 100644 index 000000000..9a368a1d4 --- /dev/null +++ b/build/docs/getVoicemailQueueMessages-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// List voicemail messages +GetVoicemailQueueMessagesRequest.getVoicemailQueueMessages(queueId: queueId, pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailQueueMessagesRequest.getVoicemailQueueMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailSearch-example.txt b/build/docs/getVoicemailSearch-example.txt new file mode 100644 index 000000000..9c2238162 --- /dev/null +++ b/build/docs/getVoicemailSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let q64: String = "" // q64 +let expand: [String] = [""] // expand + +// Search voicemails using the q64 value returned from a previous search +GetVoicemailSearchRequest.getVoicemailSearch(q64: q64, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailSearchRequest.getVoicemailSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getVoicemailUserpolicy-example.txt b/build/docs/getVoicemailUserpolicy-example.txt new file mode 100644 index 000000000..2eb262dc1 --- /dev/null +++ b/build/docs/getVoicemailUserpolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID + +// Get a user's voicemail policy +GetVoicemailUserpolicyRequest.getVoicemailUserpolicy(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetVoicemailUserpolicyRequest.getVoicemailUserpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatDeployment-example.txt b/build/docs/getWebchatDeployment-example.txt new file mode 100644 index 000000000..7bfd1d88d --- /dev/null +++ b/build/docs/getWebchatDeployment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Deployment Id + +// Get a WebChat deployment +GetWebchatDeploymentRequest.getWebchatDeployment(deploymentId: deploymentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatDeploymentRequest.getWebchatDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatDeployments-example.txt b/build/docs/getWebchatDeployments-example.txt new file mode 100644 index 000000000..24405c69f --- /dev/null +++ b/build/docs/getWebchatDeployments-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// List WebChat deployments +GetWebchatDeploymentsRequest.getWebchatDeployments() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatDeploymentsRequest.getWebchatDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMediarequest-example.txt b/build/docs/getWebchatGuestConversationMediarequest-example.txt new file mode 100644 index 000000000..d27a3bc02 --- /dev/null +++ b/build/docs/getWebchatGuestConversationMediarequest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let mediaRequestId: String = "" // mediaRequestId + +// Get a media request in the conversation +GetWebchatGuestConversationMediarequestRequest.getWebchatGuestConversationMediarequest(conversationId: conversationId, mediaRequestId: mediaRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMediarequestRequest.getWebchatGuestConversationMediarequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMediarequests-example.txt b/build/docs/getWebchatGuestConversationMediarequests-example.txt new file mode 100644 index 000000000..eda2984a3 --- /dev/null +++ b/build/docs/getWebchatGuestConversationMediarequests-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId + +// Get all media requests to the guest in the conversation +GetWebchatGuestConversationMediarequestsRequest.getWebchatGuestConversationMediarequests(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMediarequestsRequest.getWebchatGuestConversationMediarequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMember-example.txt b/build/docs/getWebchatGuestConversationMember-example.txt new file mode 100644 index 000000000..4cb7218d3 --- /dev/null +++ b/build/docs/getWebchatGuestConversationMember-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let memberId: String = "" // memberId + +// Get a web chat conversation member +GetWebchatGuestConversationMemberRequest.getWebchatGuestConversationMember(conversationId: conversationId, memberId: memberId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMemberRequest.getWebchatGuestConversationMember was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMembers-example.txt b/build/docs/getWebchatGuestConversationMembers-example.txt new file mode 100644 index 000000000..9c8bcc9ec --- /dev/null +++ b/build/docs/getWebchatGuestConversationMembers-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let pageSize: Int = 0 // The number of entries to return per page, or omitted for the default. +let pageNumber: Int = 0 // The page number to return, or omitted for the first page. +let excludeDisconnectedMembers: Bool = true // If true, the results will not contain members who have a DISCONNECTED state. + +// Get the members of a chat conversation. +GetWebchatGuestConversationMembersRequest.getWebchatGuestConversationMembers(conversationId: conversationId, pageSize: pageSize, pageNumber: pageNumber, excludeDisconnectedMembers: excludeDisconnectedMembers) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMembersRequest.getWebchatGuestConversationMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMessage-example.txt b/build/docs/getWebchatGuestConversationMessage-example.txt new file mode 100644 index 000000000..4e4bb94d4 --- /dev/null +++ b/build/docs/getWebchatGuestConversationMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let messageId: String = "" // messageId + +// Get a web chat conversation message +GetWebchatGuestConversationMessageRequest.getWebchatGuestConversationMessage(conversationId: conversationId, messageId: messageId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMessageRequest.getWebchatGuestConversationMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatGuestConversationMessages-example.txt b/build/docs/getWebchatGuestConversationMessages-example.txt new file mode 100644 index 000000000..085981c9a --- /dev/null +++ b/build/docs/getWebchatGuestConversationMessages-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let after: String = "" // If available, get the messages chronologically after the id of this message +let before: String = "" // If available, get the messages chronologically before the id of this message +let sortOrder: GetWebchatGuestConversationMessagesRequest.SortOrder_getWebchatGuestConversationMessages = GetWebchatGuestConversationMessagesRequest.SortOrder_getWebchatGuestConversationMessages.enummember // Sort order +let maxResults: Int = 0 // Limit the returned number of messages, up to a maximum of 100 + +// Get the messages of a chat conversation. +GetWebchatGuestConversationMessagesRequest.getWebchatGuestConversationMessages(conversationId: conversationId, after: after, before: before, sortOrder: sortOrder, maxResults: maxResults) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatGuestConversationMessagesRequest.getWebchatGuestConversationMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebchatSettings-example.txt b/build/docs/getWebchatSettings-example.txt new file mode 100644 index 000000000..7c57844fb --- /dev/null +++ b/build/docs/getWebchatSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get WebChat deployment settings +GetWebchatSettingsRequest.getWebchatSettings() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebchatSettingsRequest.getWebchatSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsConfigurationVersion-example.txt b/build/docs/getWebdeploymentsConfigurationVersion-example.txt new file mode 100644 index 000000000..641268430 --- /dev/null +++ b/build/docs/getWebdeploymentsConfigurationVersion-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID +let versionId: String = "" // The version of the configuration to get + +// Get a configuration version +GetWebdeploymentsConfigurationVersionRequest.getWebdeploymentsConfigurationVersion(configurationId: configurationId, versionId: versionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsConfigurationVersionRequest.getWebdeploymentsConfigurationVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsConfigurationVersions-example.txt b/build/docs/getWebdeploymentsConfigurationVersions-example.txt new file mode 100644 index 000000000..432ea386b --- /dev/null +++ b/build/docs/getWebdeploymentsConfigurationVersions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID + +// Get the versions of a configuration +GetWebdeploymentsConfigurationVersionsRequest.getWebdeploymentsConfigurationVersions(configurationId: configurationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsConfigurationVersionsRequest.getWebdeploymentsConfigurationVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsConfigurationVersionsDraft-example.txt b/build/docs/getWebdeploymentsConfigurationVersionsDraft-example.txt new file mode 100644 index 000000000..238a744f8 --- /dev/null +++ b/build/docs/getWebdeploymentsConfigurationVersionsDraft-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID + +// Get the configuration draft +GetWebdeploymentsConfigurationVersionsDraftRequest.getWebdeploymentsConfigurationVersionsDraft(configurationId: configurationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsConfigurationVersionsDraftRequest.getWebdeploymentsConfigurationVersionsDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsConfigurations-example.txt b/build/docs/getWebdeploymentsConfigurations-example.txt new file mode 100644 index 000000000..ce9647c18 --- /dev/null +++ b/build/docs/getWebdeploymentsConfigurations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let showOnlyPublished: Bool = true // Get only configuration drafts with published versions + +// View configuration drafts +GetWebdeploymentsConfigurationsRequest.getWebdeploymentsConfigurations(showOnlyPublished: showOnlyPublished) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsConfigurationsRequest.getWebdeploymentsConfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsDeployment-example.txt b/build/docs/getWebdeploymentsDeployment-example.txt new file mode 100644 index 000000000..3ea1615bc --- /dev/null +++ b/build/docs/getWebdeploymentsDeployment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // The deployment ID +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. + +// Get a deployment +GetWebdeploymentsDeploymentRequest.getWebdeploymentsDeployment(deploymentId: deploymentId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsDeploymentRequest.getWebdeploymentsDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsDeploymentCobrowseSessionId-example.txt b/build/docs/getWebdeploymentsDeploymentCobrowseSessionId-example.txt new file mode 100644 index 000000000..9e0ee2aeb --- /dev/null +++ b/build/docs/getWebdeploymentsDeploymentCobrowseSessionId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // WebMessaging deployment ID +let sessionId: String = "" // Cobrowse session id or join code + +// Retrieves a cobrowse session +GetWebdeploymentsDeploymentCobrowseSessionIdRequest.getWebdeploymentsDeploymentCobrowseSessionId(deploymentId: deploymentId, sessionId: sessionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsDeploymentCobrowseSessionIdRequest.getWebdeploymentsDeploymentCobrowseSessionId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsDeploymentConfigurations-example.txt b/build/docs/getWebdeploymentsDeploymentConfigurations-example.txt new file mode 100644 index 000000000..e10075a8f --- /dev/null +++ b/build/docs/getWebdeploymentsDeploymentConfigurations-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // The deployment ID +let type: String = "" // Get active configuration on a deployment +let expand: [String] = [""] // Expand instructions for the return value + +// Get active configuration for a given deployment +GetWebdeploymentsDeploymentConfigurationsRequest.getWebdeploymentsDeploymentConfigurations(deploymentId: deploymentId, type: type, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsDeploymentConfigurationsRequest.getWebdeploymentsDeploymentConfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebdeploymentsDeployments-example.txt b/build/docs/getWebdeploymentsDeployments-example.txt new file mode 100644 index 000000000..a8b80e5ed --- /dev/null +++ b/build/docs/getWebdeploymentsDeployments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let expand: [String] = [""] // The specified entity attributes will be filled. Comma separated values expected. + +// Get deployments +GetWebdeploymentsDeploymentsRequest.getWebdeploymentsDeployments(expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebdeploymentsDeploymentsRequest.getWebdeploymentsDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWebmessagingMessages-example.txt b/build/docs/getWebmessagingMessages-example.txt new file mode 100644 index 000000000..9c0af914d --- /dev/null +++ b/build/docs/getWebmessagingMessages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number + +// Get the messages for a web messaging session. +GetWebmessagingMessagesRequest.getWebmessagingMessages(pageSize: pageSize, pageNumber: pageNumber) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWebmessagingMessagesRequest.getWebmessagingMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWidgetsDeployment-example.txt b/build/docs/getWidgetsDeployment-example.txt new file mode 100644 index 000000000..c77bf9a11 --- /dev/null +++ b/build/docs/getWidgetsDeployment-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Widget Config Id + +// Get a Widget deployment +GetWidgetsDeploymentRequest.getWidgetsDeployment(deploymentId: deploymentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWidgetsDeploymentRequest.getWidgetsDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWidgetsDeployments-example.txt b/build/docs/getWidgetsDeployments-example.txt new file mode 100644 index 000000000..f3e360c37 --- /dev/null +++ b/build/docs/getWidgetsDeployments-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// List Widget deployments +GetWidgetsDeploymentsRequest.getWidgetsDeployments() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWidgetsDeploymentsRequest.getWidgetsDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdherence-example.txt b/build/docs/getWorkforcemanagementAdherence-example.txt new file mode 100644 index 000000000..a364bf168 --- /dev/null +++ b/build/docs/getWorkforcemanagementAdherence-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: [String] = [""] // User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request + +// Get a list of UserScheduleAdherence records for the requested users +GetWorkforcemanagementAdherenceRequest.getWorkforcemanagementAdherence(userId: userId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdherenceRequest.getWorkforcemanagementAdherence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdherenceExplanation-example.txt b/build/docs/getWorkforcemanagementAdherenceExplanation-example.txt new file mode 100644 index 000000000..cd87abbe8 --- /dev/null +++ b/build/docs/getWorkforcemanagementAdherenceExplanation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let explanationId: String = "" // The ID of the explanation to update + +// Get an adherence explanation for the current user +GetWorkforcemanagementAdherenceExplanationRequest.getWorkforcemanagementAdherenceExplanation(explanationId: explanationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdherenceExplanationRequest.getWorkforcemanagementAdherenceExplanation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdherenceExplanationsJob-example.txt b/build/docs/getWorkforcemanagementAdherenceExplanationsJob-example.txt new file mode 100644 index 000000000..3598352f4 --- /dev/null +++ b/build/docs/getWorkforcemanagementAdherenceExplanationsJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The ID of the job + +// Query the status of an adherence explanation operation. Only the user who started the operation can query the status +GetWorkforcemanagementAdherenceExplanationsJobRequest.getWorkforcemanagementAdherenceExplanationsJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdherenceExplanationsJobRequest.getWorkforcemanagementAdherenceExplanationsJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdherenceHistoricalBulkJob-example.txt b/build/docs/getWorkforcemanagementAdherenceHistoricalBulkJob-example.txt new file mode 100644 index 000000000..9deedc513 --- /dev/null +++ b/build/docs/getWorkforcemanagementAdherenceHistoricalBulkJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // ID of the job to get + +// Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status +GetWorkforcemanagementAdherenceHistoricalBulkJobRequest.getWorkforcemanagementAdherenceHistoricalBulkJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdherenceHistoricalBulkJobRequest.getWorkforcemanagementAdherenceHistoricalBulkJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdherenceHistoricalJob-example.txt b/build/docs/getWorkforcemanagementAdherenceHistoricalJob-example.txt new file mode 100644 index 000000000..05471e5bd --- /dev/null +++ b/build/docs/getWorkforcemanagementAdherenceHistoricalJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Query the status of a historical adherence request operation. Only the user who started the operation can query the status +GetWorkforcemanagementAdherenceHistoricalJobRequest.getWorkforcemanagementAdherenceHistoricalJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdherenceHistoricalJobRequest.getWorkforcemanagementAdherenceHistoricalJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAdhocmodelingjob-example.txt b/build/docs/getWorkforcemanagementAdhocmodelingjob-example.txt new file mode 100644 index 000000000..458347edb --- /dev/null +++ b/build/docs/getWorkforcemanagementAdhocmodelingjob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The id of the modeling job + +// Get status of the modeling job +GetWorkforcemanagementAdhocmodelingjobRequest.getWorkforcemanagementAdhocmodelingjob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAdhocmodelingjobRequest.getWorkforcemanagementAdhocmodelingjob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAgentAdherenceExplanation-example.txt b/build/docs/getWorkforcemanagementAgentAdherenceExplanation-example.txt new file mode 100644 index 000000000..1e4e3644e --- /dev/null +++ b/build/docs/getWorkforcemanagementAgentAdherenceExplanation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent to query +let explanationId: String = "" // The ID of the explanation to update + +// Get an adherence explanation +GetWorkforcemanagementAgentAdherenceExplanationRequest.getWorkforcemanagementAgentAdherenceExplanation(agentId: agentId, explanationId: explanationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAgentAdherenceExplanationRequest.getWorkforcemanagementAgentAdherenceExplanation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAgentManagementunit-example.txt b/build/docs/getWorkforcemanagementAgentManagementunit-example.txt new file mode 100644 index 000000000..f70615a83 --- /dev/null +++ b/build/docs/getWorkforcemanagementAgentManagementunit-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent to look up + +// Get the management unit to which the agent belongs +GetWorkforcemanagementAgentManagementunitRequest.getWorkforcemanagementAgentManagementunit(agentId: agentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAgentManagementunitRequest.getWorkforcemanagementAgentManagementunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementAgentsMeManagementunit-example.txt b/build/docs/getWorkforcemanagementAgentsMeManagementunit-example.txt new file mode 100644 index 000000000..181dec46e --- /dev/null +++ b/build/docs/getWorkforcemanagementAgentsMeManagementunit-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get the management unit to which the currently logged in agent belongs +GetWorkforcemanagementAgentsMeManagementunitRequest.getWorkforcemanagementAgentsMeManagementunit() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementAgentsMeManagementunitRequest.getWorkforcemanagementAgentsMeManagementunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunit-example.txt b/build/docs/getWorkforcemanagementBusinessunit-example.txt new file mode 100644 index 000000000..6c0f9fe90 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let expand: [String] = [""] // Include to access additional data on the business unit + +// Get business unit +GetWorkforcemanagementBusinessunitRequest.getWorkforcemanagementBusinessunit(businessUnitId: businessUnitId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitRequest.getWorkforcemanagementBusinessunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitActivitycode-example.txt b/build/docs/getWorkforcemanagementBusinessunitActivitycode-example.txt new file mode 100644 index 000000000..e0078839d --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitActivitycode-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let activityCodeId: String = "" // The ID of the activity code to fetch + +// Get an activity code +GetWorkforcemanagementBusinessunitActivitycodeRequest.getWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitActivitycodeRequest.getWorkforcemanagementBusinessunitActivitycode was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitActivitycodes-example.txt b/build/docs/getWorkforcemanagementBusinessunitActivitycodes-example.txt new file mode 100644 index 000000000..a7cda7a36 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitActivitycodes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. + +// Get activity codes +GetWorkforcemanagementBusinessunitActivitycodesRequest.getWorkforcemanagementBusinessunitActivitycodes(businessUnitId: businessUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitActivitycodesRequest.getWorkforcemanagementBusinessunitActivitycodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitIntradayPlanninggroups-example.txt b/build/docs/getWorkforcemanagementBusinessunitIntradayPlanninggroups-example.txt new file mode 100644 index 000000000..7fc5924be --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitIntradayPlanninggroups-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let date: Date = new Date(...) // 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 + +// Get intraday planning groups for the given date +GetWorkforcemanagementBusinessunitIntradayPlanninggroupsRequest.getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId: businessUnitId, date: date) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitIntradayPlanninggroupsRequest.getWorkforcemanagementBusinessunitIntradayPlanninggroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitManagementunits-example.txt b/build/docs/getWorkforcemanagementBusinessunitManagementunits-example.txt new file mode 100644 index 000000000..c870f03ec --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitManagementunits-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let feature: GetWorkforcemanagementBusinessunitManagementunitsRequest.Feature_getWorkforcemanagementBusinessunitManagementunits = GetWorkforcemanagementBusinessunitManagementunitsRequest.Feature_getWorkforcemanagementBusinessunitManagementunits.enummember // If specified, the list of management units for which the user is authorized to use the requested feature will be returned +let divisionId: String = "" // If specified, the list of management units belonging to the specified division will be returned + +// Get all authorized management units in the business unit +GetWorkforcemanagementBusinessunitManagementunitsRequest.getWorkforcemanagementBusinessunitManagementunits(businessUnitId: businessUnitId, feature: feature, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitManagementunitsRequest.getWorkforcemanagementBusinessunitManagementunits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitPlanninggroup-example.txt b/build/docs/getWorkforcemanagementBusinessunitPlanninggroup-example.txt new file mode 100644 index 000000000..6472227e8 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitPlanninggroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let planningGroupId: String = "" // The ID of a planning group to fetch + +// Get a planning group +GetWorkforcemanagementBusinessunitPlanninggroupRequest.getWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitPlanninggroupRequest.getWorkforcemanagementBusinessunitPlanninggroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitPlanninggroups-example.txt b/build/docs/getWorkforcemanagementBusinessunitPlanninggroups-example.txt new file mode 100644 index 000000000..706ccc36f --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitPlanninggroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. + +// Gets list of planning groups +GetWorkforcemanagementBusinessunitPlanninggroupsRequest.getWorkforcemanagementBusinessunitPlanninggroups(businessUnitId: businessUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitPlanninggroupsRequest.getWorkforcemanagementBusinessunitPlanninggroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitSchedulingRun-example.txt b/build/docs/getWorkforcemanagementBusinessunitSchedulingRun-example.txt new file mode 100644 index 000000000..d943092b2 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitSchedulingRun-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let runId: String = "" // The ID of the schedule run + +// Get a scheduling run +GetWorkforcemanagementBusinessunitSchedulingRunRequest.getWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitSchedulingRunRequest.getWorkforcemanagementBusinessunitSchedulingRun was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitSchedulingRunResult-example.txt b/build/docs/getWorkforcemanagementBusinessunitSchedulingRunResult-example.txt new file mode 100644 index 000000000..ca8579697 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitSchedulingRunResult-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let runId: String = "" // The ID of the schedule run +let managementUnitIds: [String] = [""] // The IDs of the management units for which to fetch the reschedule results +let expand: [String] = [""] // The fields to expand. Omitting will return an empty response + +// Get the result of a rescheduling operation +GetWorkforcemanagementBusinessunitSchedulingRunResultRequest.getWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId: businessUnitId, runId: runId, managementUnitIds: managementUnitIds, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitSchedulingRunResultRequest.getWorkforcemanagementBusinessunitSchedulingRunResult was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitSchedulingRuns-example.txt b/build/docs/getWorkforcemanagementBusinessunitSchedulingRuns-example.txt new file mode 100644 index 000000000..48155648e --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitSchedulingRuns-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit + +// Get the list of scheduling runs +GetWorkforcemanagementBusinessunitSchedulingRunsRequest.getWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId: businessUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitSchedulingRunsRequest.getWorkforcemanagementBusinessunitSchedulingRuns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplate-example.txt b/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplate-example.txt new file mode 100644 index 000000000..d558b07b2 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplate-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let serviceGoalTemplateId: String = "" // The ID of a service goal template to fetch +let expand: [String] = [""] // Include to access additional data on the service goal template + +// Get a service goal template +GetWorkforcemanagementBusinessunitServicegoaltemplateRequest.getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitServicegoaltemplateRequest.getWorkforcemanagementBusinessunitServicegoaltemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplates-example.txt b/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplates-example.txt new file mode 100644 index 000000000..bb51c9e3c --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitServicegoaltemplates-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let expand: [String] = [""] // Include to access additional data on the service goal template + +// Gets list of service goal templates +GetWorkforcemanagementBusinessunitServicegoaltemplatesRequest.getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId: businessUnitId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitServicegoaltemplatesRequest.getWorkforcemanagementBusinessunitServicegoaltemplates was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekSchedule-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekSchedule-example.txt new file mode 100644 index 000000000..f5be3fce6 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekSchedule-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let expand: GetWorkforcemanagementBusinessunitWeekScheduleRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedule = GetWorkforcemanagementBusinessunitWeekScheduleRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedule.enummember // expand + +// 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 +GetWorkforcemanagementBusinessunitWeekScheduleRequest.getWorkforcemanagementBusinessunitWeekSchedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekScheduleRequest.getWorkforcemanagementBusinessunitWeekSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekScheduleGenerationresults-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleGenerationresults-example.txt new file mode 100644 index 000000000..9aa799349 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleGenerationresults-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule + +// Get the generation results for a generated schedule +GetWorkforcemanagementBusinessunitWeekScheduleGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekScheduleGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekScheduleGenerationresults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast-example.txt new file mode 100644 index 000000000..677f32c87 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let forceDownload: Bool = true // Whether to force the result to come via download url. For testing purposes only + +// Get the headcount forecast by planning group for the schedule +GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastRequest.getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, forceDownload: forceDownload) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecastRequest.getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent-example.txt new file mode 100644 index 000000000..421ed596b --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let agentId: String = "" // THe ID of the agent + +// Loads agent's schedule history. +GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgentRequest.getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, agentId: agentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgentRequest.getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekSchedules-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekSchedules-example.txt new file mode 100644 index 000000000..209b8df6e --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekSchedules-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: String = "" // First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules +let includeOnlyPublished: Bool = true // includeOnlyPublished +let expand: GetWorkforcemanagementBusinessunitWeekSchedulesRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedules = GetWorkforcemanagementBusinessunitWeekSchedulesRequest.Expand_getWorkforcemanagementBusinessunitWeekSchedules.enummember // expand + +// Get the list of week schedules for the specified week +GetWorkforcemanagementBusinessunitWeekSchedulesRequest.getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId: businessUnitId, weekId: weekId, includeOnlyPublished: includeOnlyPublished, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekSchedulesRequest.getWorkforcemanagementBusinessunitWeekSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt new file mode 100644 index 000000000..0b9259aca --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecast-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast +let expand: [String] = [""] // Include to access additional data on the forecast + +// Get a short term forecast +GetWorkforcemanagementBusinessunitWeekShorttermforecastRequest.getWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastRequest.getWorkforcemanagementBusinessunitWeekShorttermforecast was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastData-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastData-example.txt new file mode 100644 index 000000000..00446a5fb --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastData-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast +let weekNumber: Int = 0 // The week number to fetch (for multi-week forecasts) +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Get the result of a short term forecast calculation +GetWorkforcemanagementBusinessunitWeekShorttermforecastDataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, weekNumber: weekNumber, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastDataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastData was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults-example.txt new file mode 100644 index 000000000..9fe69a166 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast + +// Gets the forecast generation results +GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresultsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata-example.txt new file mode 100644 index 000000000..34549ae29 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Get the result of a long term forecast calculation +GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdataRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups-example.txt new file mode 100644 index 000000000..36f01fc6e --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast + +// Gets the forecast planning group snapshot +GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroupsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecasts-example.txt b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecasts-example.txt new file mode 100644 index 000000000..29e1ad421 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitWeekShorttermforecasts-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: String = "" // The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts + +// Get short term forecasts +GetWorkforcemanagementBusinessunitWeekShorttermforecastsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId: businessUnitId, weekDateId: weekDateId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitWeekShorttermforecastsRequest.getWorkforcemanagementBusinessunitWeekShorttermforecasts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunits-example.txt b/build/docs/getWorkforcemanagementBusinessunits-example.txt new file mode 100644 index 000000000..097a18740 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunits-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let feature: GetWorkforcemanagementBusinessunitsRequest.Feature_getWorkforcemanagementBusinessunits = GetWorkforcemanagementBusinessunitsRequest.Feature_getWorkforcemanagementBusinessunits.enummember // If specified, the list of business units for which the user is authorized to use the requested feature will be returned +let divisionId: String = "" // If specified, the list of business units belonging to the specified division will be returned + +// Get business units +GetWorkforcemanagementBusinessunitsRequest.getWorkforcemanagementBusinessunits(feature: feature, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitsRequest.getWorkforcemanagementBusinessunits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementBusinessunitsDivisionviews-example.txt b/build/docs/getWorkforcemanagementBusinessunitsDivisionviews-example.txt new file mode 100644 index 000000000..f82a8d005 --- /dev/null +++ b/build/docs/getWorkforcemanagementBusinessunitsDivisionviews-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: [String] = [""] // The divisionIds to filter by. If omitted, will return business units in all divisions + +// Get business units across divisions +GetWorkforcemanagementBusinessunitsDivisionviewsRequest.getWorkforcemanagementBusinessunitsDivisionviews(divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementBusinessunitsDivisionviewsRequest.getWorkforcemanagementBusinessunitsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementCalendarDataIcs-example.txt b/build/docs/getWorkforcemanagementCalendarDataIcs-example.txt new file mode 100644 index 000000000..5d112bbdd --- /dev/null +++ b/build/docs/getWorkforcemanagementCalendarDataIcs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let calendarId: String = "" // The id of the ics-formatted calendar + +// Get ics formatted calendar based on shareable link +GetWorkforcemanagementCalendarDataIcsRequest.getWorkforcemanagementCalendarDataIcs(calendarId: calendarId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementCalendarDataIcsRequest.getWorkforcemanagementCalendarDataIcs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementCalendarUrlIcs-example.txt b/build/docs/getWorkforcemanagementCalendarUrlIcs-example.txt new file mode 100644 index 000000000..c7abfe196 --- /dev/null +++ b/build/docs/getWorkforcemanagementCalendarUrlIcs-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get existing calendar link for the current user +GetWorkforcemanagementCalendarUrlIcsRequest.getWorkforcemanagementCalendarUrlIcs() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementCalendarUrlIcsRequest.getWorkforcemanagementCalendarUrlIcs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementHistoricaldataDeletejob-example.txt b/build/docs/getWorkforcemanagementHistoricaldataDeletejob-example.txt new file mode 100644 index 000000000..fa56c17db --- /dev/null +++ b/build/docs/getWorkforcemanagementHistoricaldataDeletejob-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Retrieves delete job status for historical data imports of the organization +GetWorkforcemanagementHistoricaldataDeletejobRequest.getWorkforcemanagementHistoricaldataDeletejob() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementHistoricaldataDeletejobRequest.getWorkforcemanagementHistoricaldataDeletejob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementHistoricaldataImportstatus-example.txt b/build/docs/getWorkforcemanagementHistoricaldataImportstatus-example.txt new file mode 100644 index 000000000..ce64f52fd --- /dev/null +++ b/build/docs/getWorkforcemanagementHistoricaldataImportstatus-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Retrieves status of the historical data imports of the organization +GetWorkforcemanagementHistoricaldataImportstatusRequest.getWorkforcemanagementHistoricaldataImportstatus() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementHistoricaldataImportstatusRequest.getWorkforcemanagementHistoricaldataImportstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementIntegrationsHris-example.txt b/build/docs/getWorkforcemanagementIntegrationsHris-example.txt new file mode 100644 index 000000000..d8831e0a8 --- /dev/null +++ b/build/docs/getWorkforcemanagementIntegrationsHris-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get integrations +GetWorkforcemanagementIntegrationsHrisRequest.getWorkforcemanagementIntegrationsHris() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementIntegrationsHrisRequest.getWorkforcemanagementIntegrationsHris was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementIntegrationsHrisTimeofftypesJob-example.txt b/build/docs/getWorkforcemanagementIntegrationsHrisTimeofftypesJob-example.txt new file mode 100644 index 000000000..17b326e10 --- /dev/null +++ b/build/docs/getWorkforcemanagementIntegrationsHrisTimeofftypesJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The ID of the job. + +// Query the results of time off types job +GetWorkforcemanagementIntegrationsHrisTimeofftypesJobRequest.getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementIntegrationsHrisTimeofftypesJobRequest.getWorkforcemanagementIntegrationsHrisTimeofftypesJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunit-example.txt b/build/docs/getWorkforcemanagementManagementunit-example.txt new file mode 100644 index 000000000..4987af54e --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let expand: [String] = [""] // + +// Get management unit +GetWorkforcemanagementManagementunitRequest.getWorkforcemanagementManagementunit(managementUnitId: managementUnitId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitRequest.getWorkforcemanagementManagementunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitActivitycodes-example.txt b/build/docs/getWorkforcemanagementManagementunitActivitycodes-example.txt new file mode 100644 index 000000000..7cf5dee8f --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitActivitycodes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. + +// Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes +GetWorkforcemanagementManagementunitActivitycodesRequest.getWorkforcemanagementManagementunitActivitycodes(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitActivitycodesRequest.getWorkforcemanagementManagementunitActivitycodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitAdherence-example.txt b/build/docs/getWorkforcemanagementManagementunitAdherence-example.txt new file mode 100644 index 000000000..e7ad5e5bd --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitAdherence-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Get a list of user schedule adherence records for the requested management unit +GetWorkforcemanagementManagementunitAdherenceRequest.getWorkforcemanagementManagementunitAdherence(managementUnitId: managementUnitId, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitAdherenceRequest.getWorkforcemanagementManagementunitAdherence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitAgent-example.txt b/build/docs/getWorkforcemanagementManagementunitAgent-example.txt new file mode 100644 index 000000000..78eefcbd6 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitAgent-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let agentId: String = "" // The agent id +let excludeCapabilities: Bool = true // Excludes all capabilities of the agent such as queues, languages, and skills + +// Get data for agent in the management unit +GetWorkforcemanagementManagementunitAgentRequest.getWorkforcemanagementManagementunitAgent(managementUnitId: managementUnitId, agentId: agentId, excludeCapabilities: excludeCapabilities) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitAgentRequest.getWorkforcemanagementManagementunitAgent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitAgentShifttrades-example.txt b/build/docs/getWorkforcemanagementManagementunitAgentShifttrades-example.txt new file mode 100644 index 000000000..0b1c50a6a --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitAgentShifttrades-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let agentId: String = "" // The agent id + +// Gets all the shift trades for a given agent +GetWorkforcemanagementManagementunitAgentShifttradesRequest.getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId: managementUnitId, agentId: agentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitAgentShifttradesRequest.getWorkforcemanagementManagementunitAgentShifttrades was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitShifttradesMatched-example.txt b/build/docs/getWorkforcemanagementManagementunitShifttradesMatched-example.txt new file mode 100644 index 000000000..723cb704e --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitShifttradesMatched-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. + +// Gets a summary of all shift trades in the matched state +GetWorkforcemanagementManagementunitShifttradesMatchedRequest.getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitShifttradesMatchedRequest.getWorkforcemanagementManagementunitShifttradesMatched was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitShifttradesUsers-example.txt b/build/docs/getWorkforcemanagementManagementunitShifttradesUsers-example.txt new file mode 100644 index 000000000..49fc67ee5 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitShifttradesUsers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. + +// Gets list of users available for whom you can send direct shift trade requests +GetWorkforcemanagementManagementunitShifttradesUsersRequest.getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitShifttradesUsersRequest.getWorkforcemanagementManagementunitShifttradesUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitTimeofflimit-example.txt b/build/docs/getWorkforcemanagementManagementunitTimeofflimit-example.txt new file mode 100644 index 000000000..859791227 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitTimeofflimit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let timeOffLimitId: String = "" // The ID of the time off limit to fetch + +// Gets a time off limit object +GetWorkforcemanagementManagementunitTimeofflimitRequest.getWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitTimeofflimitRequest.getWorkforcemanagementManagementunitTimeofflimit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitTimeofflimits-example.txt b/build/docs/getWorkforcemanagementManagementunitTimeofflimits-example.txt new file mode 100644 index 000000000..0a90278bb --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitTimeofflimits-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. + +// Gets a list of time off limit objects under management unit. +GetWorkforcemanagementManagementunitTimeofflimitsRequest.getWorkforcemanagementManagementunitTimeofflimits(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitTimeofflimitsRequest.getWorkforcemanagementManagementunitTimeofflimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitTimeoffplan-example.txt b/build/docs/getWorkforcemanagementManagementunitTimeoffplan-example.txt new file mode 100644 index 000000000..f8443a25e --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitTimeoffplan-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let timeOffPlanId: String = "" // The ID of the time off plan to fetch + +// Gets a time off plan +GetWorkforcemanagementManagementunitTimeoffplanRequest.getWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitTimeoffplanRequest.getWorkforcemanagementManagementunitTimeoffplan was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitTimeoffplans-example.txt b/build/docs/getWorkforcemanagementManagementunitTimeoffplans-example.txt new file mode 100644 index 000000000..f88ed2fd8 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitTimeoffplans-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit + +// Gets a list of time off plans +GetWorkforcemanagementManagementunitTimeoffplansRequest.getWorkforcemanagementManagementunitTimeoffplans(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitTimeoffplansRequest.getWorkforcemanagementManagementunitTimeoffplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequest-example.txt b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequest-example.txt new file mode 100644 index 000000000..93fcda9be --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequest-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let userId: String = "" // The userId to whom the Time Off Request applies. +let timeOffRequestId: String = "" // Time Off Request Id + +// Get a time off request +GetWorkforcemanagementManagementunitUserTimeoffrequestRequest.getWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitUserTimeoffrequestRequest.getWorkforcemanagementManagementunitUserTimeoffrequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits-example.txt b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits-example.txt new file mode 100644 index 000000000..565a12da2 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let userId: String = "" // The userId to whom the time off request applies. +let timeOffRequestId: String = "" // The ID of the time off request, which dates and activityCodeId determine limit values to retrieve + +// Retrieves time off limit, allocated and waitlisted values according to specific time off request +GetWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsRequest.getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimitsRequest.getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequests-example.txt b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequests-example.txt new file mode 100644 index 000000000..5a93e7315 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitUserTimeoffrequests-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let userId: String = "" // The userId to whom the Time Off Request applies. +let recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days + +// Get a list of time off requests for a given user +GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId, recentlyReviewed: recentlyReviewed) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitUsers-example.txt b/build/docs/getWorkforcemanagementManagementunitUsers-example.txt new file mode 100644 index 000000000..0c8d94b61 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitUsers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. + +// Get users in the management unit +GetWorkforcemanagementManagementunitUsersRequest.getWorkforcemanagementManagementunitUsers(managementUnitId: managementUnitId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitUsersRequest.getWorkforcemanagementManagementunitUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWeekSchedule-example.txt b/build/docs/getWorkforcemanagementManagementunitWeekSchedule-example.txt new file mode 100644 index 000000000..45d913e40 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWeekSchedule-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekId: String = "" // First day of schedule week in yyyy-MM-dd format. +let scheduleId: String = "" // The ID of the schedule to fetch +let expand: GetWorkforcemanagementManagementunitWeekScheduleRequest.Expand_getWorkforcemanagementManagementunitWeekSchedule = GetWorkforcemanagementManagementunitWeekScheduleRequest.Expand_getWorkforcemanagementManagementunitWeekSchedule.enummember // Which fields, if any, to expand +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Deprecated. Use the equivalent business unit resource instead. Get a week schedule +GetWorkforcemanagementManagementunitWeekScheduleRequest.getWorkforcemanagementManagementunitWeekSchedule(managementUnitId: managementUnitId, weekId: weekId, scheduleId: scheduleId, expand: expand, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWeekScheduleRequest.getWorkforcemanagementManagementunitWeekSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWeekSchedules-example.txt b/build/docs/getWorkforcemanagementManagementunitWeekSchedules-example.txt new file mode 100644 index 000000000..169ede2d2 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWeekSchedules-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekId: String = "" // First day of schedule week in yyyy-MM-dd format. +let includeOnlyPublished: Bool = true // Return only published schedules +let earliestWeekDate: String = "" // The start date of the earliest week to query in yyyy-MM-dd format +let latestWeekDate: String = "" // The start date of the latest week to query in yyyy-MM-dd format + +// Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit +GetWorkforcemanagementManagementunitWeekSchedulesRequest.getWorkforcemanagementManagementunitWeekSchedules(managementUnitId: managementUnitId, weekId: weekId, includeOnlyPublished: includeOnlyPublished, earliestWeekDate: earliestWeekDate, latestWeekDate: latestWeekDate) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWeekSchedulesRequest.getWorkforcemanagementManagementunitWeekSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWeekShifttrades-example.txt b/build/docs/getWorkforcemanagementManagementunitWeekShifttrades-example.txt new file mode 100644 index 000000000..01c72eb65 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWeekShifttrades-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let evaluateMatches: Bool = true // Whether to evaluate the matches for violations + +// Gets all the shift trades for a given week +GetWorkforcemanagementManagementunitWeekShifttradesRequest.getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId: managementUnitId, weekDateId: weekDateId, evaluateMatches: evaluateMatches) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWeekShifttradesRequest.getWorkforcemanagementManagementunitWeekShifttrades was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWorkplan-example.txt b/build/docs/getWorkforcemanagementManagementunitWorkplan-example.txt new file mode 100644 index 000000000..5c1e809ab --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWorkplan-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanId: String = "" // The ID of the work plan to fetch +let includeOnly: [String] = [""] // limit response to the specified fields + +// Get a work plan +GetWorkforcemanagementManagementunitWorkplanRequest.getWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId, includeOnly: includeOnly) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWorkplanRequest.getWorkforcemanagementManagementunitWorkplan was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWorkplanrotation-example.txt b/build/docs/getWorkforcemanagementManagementunitWorkplanrotation-example.txt new file mode 100644 index 000000000..678d4c2ac --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWorkplanrotation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanRotationId: String = "" // The ID of the work plan rotation to fetch + +// Get a work plan rotation +GetWorkforcemanagementManagementunitWorkplanrotationRequest.getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWorkplanrotationRequest.getWorkforcemanagementManagementunitWorkplanrotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWorkplanrotations-example.txt b/build/docs/getWorkforcemanagementManagementunitWorkplanrotations-example.txt new file mode 100644 index 000000000..682a48b13 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWorkplanrotations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let expand: [String] = [""] // + +// Get work plan rotations +GetWorkforcemanagementManagementunitWorkplanrotationsRequest.getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId: managementUnitId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWorkplanrotationsRequest.getWorkforcemanagementManagementunitWorkplanrotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitWorkplans-example.txt b/build/docs/getWorkforcemanagementManagementunitWorkplans-example.txt new file mode 100644 index 000000000..94fc8e513 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitWorkplans-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let expand: [String] = [""] // Include to access additional data on the work plans + +// Get work plans +GetWorkforcemanagementManagementunitWorkplansRequest.getWorkforcemanagementManagementunitWorkplans(managementUnitId: managementUnitId, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitWorkplansRequest.getWorkforcemanagementManagementunitWorkplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunits-example.txt b/build/docs/getWorkforcemanagementManagementunits-example.txt new file mode 100644 index 000000000..2d029a3e5 --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunits-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Deprecated, paging is not supported +let pageNumber: Int = 0 // Deprecated, paging is not supported +let expand: GetWorkforcemanagementManagementunitsRequest.Expand_getWorkforcemanagementManagementunits = GetWorkforcemanagementManagementunitsRequest.Expand_getWorkforcemanagementManagementunits.enummember // Deprecated, expand settings on the single MU route +let feature: GetWorkforcemanagementManagementunitsRequest.Feature_getWorkforcemanagementManagementunits = GetWorkforcemanagementManagementunitsRequest.Feature_getWorkforcemanagementManagementunits.enummember // If specified, the list of management units for which the user is authorized to use the requested feature will be returned +let divisionId: String = "" // If specified, the list of management units belonging to the specified division will be returned + +// Get management units +GetWorkforcemanagementManagementunitsRequest.getWorkforcemanagementManagementunits(pageSize: pageSize, pageNumber: pageNumber, expand: expand, feature: feature, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitsRequest.getWorkforcemanagementManagementunits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementManagementunitsDivisionviews-example.txt b/build/docs/getWorkforcemanagementManagementunitsDivisionviews-example.txt new file mode 100644 index 000000000..689dc9b5d --- /dev/null +++ b/build/docs/getWorkforcemanagementManagementunitsDivisionviews-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: [String] = [""] // The divisionIds to filter by. If omitted, will return all divisions + +// Get management units across divisions +GetWorkforcemanagementManagementunitsDivisionviewsRequest.getWorkforcemanagementManagementunitsDivisionviews(divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementManagementunitsDivisionviewsRequest.getWorkforcemanagementManagementunitsDivisionviews was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementNotifications-example.txt b/build/docs/getWorkforcemanagementNotifications-example.txt new file mode 100644 index 000000000..33d62d8c9 --- /dev/null +++ b/build/docs/getWorkforcemanagementNotifications-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Get a list of notifications for the current user +GetWorkforcemanagementNotificationsRequest.getWorkforcemanagementNotifications() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementNotificationsRequest.getWorkforcemanagementNotifications was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementSchedulingjob-example.txt b/build/docs/getWorkforcemanagementSchedulingjob-example.txt new file mode 100644 index 000000000..74ac77db6 --- /dev/null +++ b/build/docs/getWorkforcemanagementSchedulingjob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The id of the scheduling job + +// Get status of the scheduling job +GetWorkforcemanagementSchedulingjobRequest.getWorkforcemanagementSchedulingjob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementSchedulingjobRequest.getWorkforcemanagementSchedulingjob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementShifttrades-example.txt b/build/docs/getWorkforcemanagementShifttrades-example.txt new file mode 100644 index 000000000..db78ade2c --- /dev/null +++ b/build/docs/getWorkforcemanagementShifttrades-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Gets all of my shift trades +GetWorkforcemanagementShifttradesRequest.getWorkforcemanagementShifttrades() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementShifttradesRequest.getWorkforcemanagementShifttrades was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementShrinkageJob-example.txt b/build/docs/getWorkforcemanagementShrinkageJob-example.txt new file mode 100644 index 000000000..229cb15b6 --- /dev/null +++ b/build/docs/getWorkforcemanagementShrinkageJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId + +// Request to fetch the status of the historical shrinkage query +GetWorkforcemanagementShrinkageJobRequest.getWorkforcemanagementShrinkageJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementShrinkageJobRequest.getWorkforcemanagementShrinkageJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementTimeoffbalanceJob-example.txt b/build/docs/getWorkforcemanagementTimeoffbalanceJob-example.txt new file mode 100644 index 000000000..62bee88d0 --- /dev/null +++ b/build/docs/getWorkforcemanagementTimeoffbalanceJob-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // The ID of the job. + +// Query the results of time off types job +GetWorkforcemanagementTimeoffbalanceJobRequest.getWorkforcemanagementTimeoffbalanceJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementTimeoffbalanceJobRequest.getWorkforcemanagementTimeoffbalanceJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementTimeoffrequest-example.txt b/build/docs/getWorkforcemanagementTimeoffrequest-example.txt new file mode 100644 index 000000000..28097eddf --- /dev/null +++ b/build/docs/getWorkforcemanagementTimeoffrequest-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let timeOffRequestId: String = "" // The ID of the time off request + +// Get a time off request for the current user +GetWorkforcemanagementTimeoffrequestRequest.getWorkforcemanagementTimeoffrequest(timeOffRequestId: timeOffRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementTimeoffrequestRequest.getWorkforcemanagementTimeoffrequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementTimeoffrequestWaitlistpositions-example.txt b/build/docs/getWorkforcemanagementTimeoffrequestWaitlistpositions-example.txt new file mode 100644 index 000000000..f9ecf43fb --- /dev/null +++ b/build/docs/getWorkforcemanagementTimeoffrequestWaitlistpositions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let timeOffRequestId: String = "" // The ID of the time off request + +// Get the daily waitlist positions of a time off request for the current user +GetWorkforcemanagementTimeoffrequestWaitlistpositionsRequest.getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId: timeOffRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementTimeoffrequestWaitlistpositionsRequest.getWorkforcemanagementTimeoffrequestWaitlistpositions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/getWorkforcemanagementTimeoffrequests-example.txt b/build/docs/getWorkforcemanagementTimeoffrequests-example.txt new file mode 100644 index 000000000..934832339 --- /dev/null +++ b/build/docs/getWorkforcemanagementTimeoffrequests-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days + +// Get a list of time off requests for the current user +GetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests(recentlyReviewed: recentlyReviewed) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("GetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/headNotificationsChannel-example.txt b/build/docs/headNotificationsChannel-example.txt new file mode 100644 index 000000000..45c6c3087 --- /dev/null +++ b/build/docs/headNotificationsChannel-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let channelId: String = "" // Channel ID + +// Verify a channel still exists and is valid +HeadNotificationsChannelRequest.headNotificationsChannel(channelId: channelId) { (error) in + if let error = error { + dump(error) + } else { + print("HeadNotificationsChannelRequest.headNotificationsChannel was successful") + } +} \ No newline at end of file diff --git a/build/docs/headTokensMe-example.txt b/build/docs/headTokensMe-example.txt new file mode 100644 index 000000000..1b0ff2320 --- /dev/null +++ b/build/docs/headTokensMe-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Verify user token +HeadTokensMeRequest.headTokensMe() { (error) in + if let error = error { + dump(error) + } else { + print("HeadTokensMeRequest.headTokensMe was successful") + } +} \ No newline at end of file diff --git a/build/docs/index.md b/build/docs/index.md index b5e6a4f94..97f6bd4c1 100644 --- a/build/docs/index.md +++ b/build/docs/index.md @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '127.1.0' ``` Then install your project's dependencies: diff --git a/build/docs/patchAlertingAlert-example.txt b/build/docs/patchAlertingAlert-example.txt new file mode 100644 index 000000000..7d8ced51b --- /dev/null +++ b/build/docs/patchAlertingAlert-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID +let body: AlertRequest = new AlertRequest(...) // + +// Allows an entity to mute/snooze an alert or update the unread status of the alert. +PatchAlertingAlertRequest.patchAlertingAlert(alertId: alertId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAlertingAlertRequest.patchAlertingAlert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchAlertingAlertsBulk-example.txt b/build/docs/patchAlertingAlertsBulk-example.txt new file mode 100644 index 000000000..1fad64685 --- /dev/null +++ b/build/docs/patchAlertingAlertsBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CommonAlertBulkUpdateRequest = new CommonAlertBulkUpdateRequest(...) // + +// Bulk alert updates +PatchAlertingAlertsBulkRequest.patchAlertingAlertsBulk(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAlertingAlertsBulkRequest.patchAlertingAlertsBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchAlertingRulesBulk-example.txt b/build/docs/patchAlertingRulesBulk-example.txt new file mode 100644 index 000000000..8582af5a5 --- /dev/null +++ b/build/docs/patchAlertingRulesBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CommonRuleBulkUpdateNotificationsRequest = new CommonRuleBulkUpdateNotificationsRequest(...) // + +// Bulk update of notification lists +PatchAlertingRulesBulkRequest.patchAlertingRulesBulk(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAlertingRulesBulkRequest.patchAlertingRulesBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchAnalyticsReportingSettings-example.txt b/build/docs/patchAnalyticsReportingSettings-example.txt new file mode 100644 index 000000000..5f5666e9a --- /dev/null +++ b/build/docs/patchAnalyticsReportingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AnalyticsReportingSettings = new AnalyticsReportingSettings(...) // AnalyticsReportingSettingsRequest + +// Patch AnalyticsReportingSettings values for an organization +PatchAnalyticsReportingSettingsRequest.patchAnalyticsReportingSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAnalyticsReportingSettingsRequest.patchAnalyticsReportingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchAuthorizationRole-example.txt b/build/docs/patchAuthorizationRole-example.txt new file mode 100644 index 000000000..e1676620e --- /dev/null +++ b/build/docs/patchAuthorizationRole-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let body: DomainOrganizationRole = new DomainOrganizationRole(...) // Organization role + +// Patch Organization Role for needsUpdate Field +PatchAuthorizationRoleRequest.patchAuthorizationRole(roleId: roleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAuthorizationRoleRequest.patchAuthorizationRole was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchAuthorizationSettings-example.txt b/build/docs/patchAuthorizationSettings-example.txt new file mode 100644 index 000000000..79fa7f8dc --- /dev/null +++ b/build/docs/patchAuthorizationSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AuthorizationSettings = new AuthorizationSettings(...) // Authorization Settings + +// Change authorization settings +PatchAuthorizationSettingsRequest.patchAuthorizationSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchAuthorizationSettingsRequest.patchAuthorizationSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchChatSettings-example.txt b/build/docs/patchChatSettings-example.txt new file mode 100644 index 000000000..6d66da883 --- /dev/null +++ b/build/docs/patchChatSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ChatSettings = new ChatSettings(...) // Chat + +// Patch Chat Settings. +PatchChatSettingsRequest.patchChatSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchChatSettingsRequest.patchChatSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchChatsSettings-example.txt b/build/docs/patchChatsSettings-example.txt new file mode 100644 index 000000000..a359cc13d --- /dev/null +++ b/build/docs/patchChatsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ChatSettings = new ChatSettings(...) // Chat + +// Patch Chat Settings. +PatchChatsSettingsRequest.patchChatsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchChatsSettingsRequest.patchChatsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchCoachingAppointment-example.txt b/build/docs/patchCoachingAppointment-example.txt new file mode 100644 index 000000000..0c52e1e6c --- /dev/null +++ b/build/docs/patchCoachingAppointment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let body: UpdateCoachingAppointmentRequest = new UpdateCoachingAppointmentRequest(...) // The new version of the appointment + +// Update an existing appointment +PatchCoachingAppointmentRequest.patchCoachingAppointment(appointmentId: appointmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchCoachingAppointmentRequest.patchCoachingAppointment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchCoachingAppointmentAnnotation-example.txt b/build/docs/patchCoachingAppointmentAnnotation-example.txt new file mode 100644 index 000000000..1798fefdf --- /dev/null +++ b/build/docs/patchCoachingAppointmentAnnotation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let annotationId: String = "" // The ID of the annotation. +let body: CoachingAnnotation = new CoachingAnnotation(...) // The new version of the annotation + +// Update an existing annotation. +PatchCoachingAppointmentAnnotationRequest.patchCoachingAppointmentAnnotation(appointmentId: appointmentId, annotationId: annotationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchCoachingAppointmentAnnotationRequest.patchCoachingAppointmentAnnotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchCoachingAppointmentStatus-example.txt b/build/docs/patchCoachingAppointmentStatus-example.txt new file mode 100644 index 000000000..15450d33a --- /dev/null +++ b/build/docs/patchCoachingAppointmentStatus-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let body: CoachingAppointmentStatusRequest = new CoachingAppointmentStatusRequest(...) // Updated status of the coaching appointment + +// Update the status of a coaching appointment +PatchCoachingAppointmentStatusRequest.patchCoachingAppointmentStatus(appointmentId: appointmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchCoachingAppointmentStatusRequest.patchCoachingAppointmentStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchCoachingNotification-example.txt b/build/docs/patchCoachingNotification-example.txt new file mode 100644 index 000000000..527f3044a --- /dev/null +++ b/build/docs/patchCoachingNotification-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let notificationId: String = "" // The ID of the notification. +let body: CoachingNotification = new CoachingNotification(...) // Change the read state of a notification + +// Update an existing notification. +PatchCoachingNotificationRequest.patchCoachingNotification(notificationId: notificationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchCoachingNotificationRequest.patchCoachingNotification was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationParticipant-example.txt b/build/docs/patchConversationParticipant-example.txt new file mode 100644 index 000000000..8c87fb9da --- /dev/null +++ b/build/docs/patchConversationParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request + +// Update a participant. +PatchConversationParticipantRequest.patchConversationParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationParticipantRequest.patchConversationParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationParticipantAttributes-example.txt b/build/docs/patchConversationParticipantAttributes-example.txt new file mode 100644 index 000000000..8f40405b5 --- /dev/null +++ b/build/docs/patchConversationParticipantAttributes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes + +// Update the attributes on a conversation participant. +PatchConversationParticipantAttributesRequest.patchConversationParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationParticipantAttributesRequest.patchConversationParticipantAttributes was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationSecureattributes-example.txt b/build/docs/patchConversationSecureattributes-example.txt new file mode 100644 index 000000000..f4553cb5f --- /dev/null +++ b/build/docs/patchConversationSecureattributes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let body: ConversationSecureAttributes = new ConversationSecureAttributes(...) // Conversation Secure Attributes + +// Update the secure attributes on a conversation. +PatchConversationSecureattributesRequest.patchConversationSecureattributes(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationSecureattributesRequest.patchConversationSecureattributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsAftercallworkConversationIdParticipantCommunication-example.txt b/build/docs/patchConversationsAftercallworkConversationIdParticipantCommunication-example.txt new file mode 100644 index 000000000..d4c2b9e34 --- /dev/null +++ b/build/docs/patchConversationsAftercallworkConversationIdParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: AfterCallWorkUpdate = new AfterCallWorkUpdate(...) // AfterCallWorkUpdate + +// Update after-call work for this conversation communication. +PatchConversationsAftercallworkConversationIdParticipantCommunicationRequest.patchConversationsAftercallworkConversationIdParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsAftercallworkConversationIdParticipantCommunicationRequest.patchConversationsAftercallworkConversationIdParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCall-example.txt b/build/docs/patchConversationsCall-example.txt new file mode 100644 index 000000000..e1f856c14 --- /dev/null +++ b/build/docs/patchConversationsCall-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants +PatchConversationsCallRequest.patchConversationsCall(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallRequest.patchConversationsCall was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallParticipant-example.txt b/build/docs/patchConversationsCallParticipant-example.txt new file mode 100644 index 000000000..f4b6e8881 --- /dev/null +++ b/build/docs/patchConversationsCallParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant request + +// Update conversation participant +PatchConversationsCallParticipantRequest.patchConversationsCallParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsCallParticipantRequest.patchConversationsCallParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallParticipantAttributes-example.txt b/build/docs/patchConversationsCallParticipantAttributes-example.txt new file mode 100644 index 000000000..10161f234 --- /dev/null +++ b/build/docs/patchConversationsCallParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes + +// Update the attributes on a conversation participant. +PatchConversationsCallParticipantAttributesRequest.patchConversationsCallParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallParticipantAttributesRequest.patchConversationsCallParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallParticipantCommunication-example.txt b/build/docs/patchConversationsCallParticipantCommunication-example.txt new file mode 100644 index 000000000..1703f0f74 --- /dev/null +++ b/build/docs/patchConversationsCallParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsCallParticipantCommunicationRequest.patchConversationsCallParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallParticipantCommunicationRequest.patchConversationsCallParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallParticipantConsult-example.txt b/build/docs/patchConversationsCallParticipantConsult-example.txt new file mode 100644 index 000000000..901807220 --- /dev/null +++ b/build/docs/patchConversationsCallParticipantConsult-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ConsultTransferUpdate = new ConsultTransferUpdate(...) // new speak to + +// Change who can speak +PatchConversationsCallParticipantConsultRequest.patchConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallParticipantConsultRequest.patchConversationsCallParticipantConsult was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallback-example.txt b/build/docs/patchConversationsCallback-example.txt new file mode 100644 index 000000000..8cad6bea8 --- /dev/null +++ b/build/docs/patchConversationsCallback-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by disconnecting all of the participants +PatchConversationsCallbackRequest.patchConversationsCallback(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallbackRequest.patchConversationsCallback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallbackParticipant-example.txt b/build/docs/patchConversationsCallbackParticipant-example.txt new file mode 100644 index 000000000..7ccf5e99d --- /dev/null +++ b/build/docs/patchConversationsCallbackParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant +PatchConversationsCallbackParticipantRequest.patchConversationsCallbackParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsCallbackParticipantRequest.patchConversationsCallbackParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallbackParticipantAttributes-example.txt b/build/docs/patchConversationsCallbackParticipantAttributes-example.txt new file mode 100644 index 000000000..ab614d95f --- /dev/null +++ b/build/docs/patchConversationsCallbackParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // Attributes + +// Update the attributes on a conversation participant. +PatchConversationsCallbackParticipantAttributesRequest.patchConversationsCallbackParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallbackParticipantAttributesRequest.patchConversationsCallbackParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallbackParticipantCommunication-example.txt b/build/docs/patchConversationsCallbackParticipantCommunication-example.txt new file mode 100644 index 000000000..db8eb261a --- /dev/null +++ b/build/docs/patchConversationsCallbackParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsCallbackParticipantCommunicationRequest.patchConversationsCallbackParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallbackParticipantCommunicationRequest.patchConversationsCallbackParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCallbacks-example.txt b/build/docs/patchConversationsCallbacks-example.txt new file mode 100644 index 000000000..9cfe9f37d --- /dev/null +++ b/build/docs/patchConversationsCallbacks-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PatchCallbackRequest = new PatchCallbackRequest(...) // PatchCallbackRequest + +// Update a scheduled callback +PatchConversationsCallbacksRequest.patchConversationsCallbacks(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCallbacksRequest.patchConversationsCallbacks was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsChat-example.txt b/build/docs/patchConversationsChat-example.txt new file mode 100644 index 000000000..9908b9f3b --- /dev/null +++ b/build/docs/patchConversationsChat-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by disconnecting all of the participants +PatchConversationsChatRequest.patchConversationsChat(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsChatRequest.patchConversationsChat was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsChatParticipant-example.txt b/build/docs/patchConversationsChatParticipant-example.txt new file mode 100644 index 000000000..0d6f97d4c --- /dev/null +++ b/build/docs/patchConversationsChatParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request + +// Update conversation participant +PatchConversationsChatParticipantRequest.patchConversationsChatParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsChatParticipantRequest.patchConversationsChatParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsChatParticipantAttributes-example.txt b/build/docs/patchConversationsChatParticipantAttributes-example.txt new file mode 100644 index 000000000..260ddac8b --- /dev/null +++ b/build/docs/patchConversationsChatParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes + +// Update the attributes on a conversation participant. +PatchConversationsChatParticipantAttributesRequest.patchConversationsChatParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsChatParticipantAttributesRequest.patchConversationsChatParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsChatParticipantCommunication-example.txt b/build/docs/patchConversationsChatParticipantCommunication-example.txt new file mode 100644 index 000000000..6b42e72a3 --- /dev/null +++ b/build/docs/patchConversationsChatParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsChatParticipantCommunicationRequest.patchConversationsChatParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsChatParticipantCommunicationRequest.patchConversationsChatParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCobrowsesession-example.txt b/build/docs/patchConversationsCobrowsesession-example.txt new file mode 100644 index 000000000..7ea9812e0 --- /dev/null +++ b/build/docs/patchConversationsCobrowsesession-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by disconnecting all of the participants +PatchConversationsCobrowsesessionRequest.patchConversationsCobrowsesession(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCobrowsesessionRequest.patchConversationsCobrowsesession was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCobrowsesessionParticipant-example.txt b/build/docs/patchConversationsCobrowsesessionParticipant-example.txt new file mode 100644 index 000000000..0a77fb1de --- /dev/null +++ b/build/docs/patchConversationsCobrowsesessionParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // + +// Update conversation participant +PatchConversationsCobrowsesessionParticipantRequest.patchConversationsCobrowsesessionParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsCobrowsesessionParticipantRequest.patchConversationsCobrowsesessionParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCobrowsesessionParticipantAttributes-example.txt b/build/docs/patchConversationsCobrowsesessionParticipantAttributes-example.txt new file mode 100644 index 000000000..66be2738b --- /dev/null +++ b/build/docs/patchConversationsCobrowsesessionParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // + +// Update the attributes on a conversation participant. +PatchConversationsCobrowsesessionParticipantAttributesRequest.patchConversationsCobrowsesessionParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCobrowsesessionParticipantAttributesRequest.patchConversationsCobrowsesessionParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsCobrowsesessionParticipantCommunication-example.txt b/build/docs/patchConversationsCobrowsesessionParticipantCommunication-example.txt new file mode 100644 index 000000000..275edc96c --- /dev/null +++ b/build/docs/patchConversationsCobrowsesessionParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsCobrowsesessionParticipantCommunicationRequest.patchConversationsCobrowsesessionParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsCobrowsesessionParticipantCommunicationRequest.patchConversationsCobrowsesessionParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsEmail-example.txt b/build/docs/patchConversationsEmail-example.txt new file mode 100644 index 000000000..c5bc1c853 --- /dev/null +++ b/build/docs/patchConversationsEmail-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by disconnecting all of the participants +PatchConversationsEmailRequest.patchConversationsEmail(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsEmailRequest.patchConversationsEmail was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsEmailMessagesDraft-example.txt b/build/docs/patchConversationsEmailMessagesDraft-example.txt new file mode 100644 index 000000000..e9743d859 --- /dev/null +++ b/build/docs/patchConversationsEmailMessagesDraft-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let autoFill: Bool = true // autoFill +let discard: Bool = true // discard +let body: DraftManipulationRequest = new DraftManipulationRequest(...) // Draft Manipulation Request + +// Reset conversation draft to its initial state and/or auto-fill draft content +PatchConversationsEmailMessagesDraftRequest.patchConversationsEmailMessagesDraft(conversationId: conversationId, autoFill: autoFill, discard: discard, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsEmailMessagesDraftRequest.patchConversationsEmailMessagesDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsEmailParticipant-example.txt b/build/docs/patchConversationsEmailParticipant-example.txt new file mode 100644 index 000000000..0d93e8aff --- /dev/null +++ b/build/docs/patchConversationsEmailParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Update request + +// Update conversation participant +PatchConversationsEmailParticipantRequest.patchConversationsEmailParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsEmailParticipantRequest.patchConversationsEmailParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsEmailParticipantAttributes-example.txt b/build/docs/patchConversationsEmailParticipantAttributes-example.txt new file mode 100644 index 000000000..eb0aa64ef --- /dev/null +++ b/build/docs/patchConversationsEmailParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // Participant attributes + +// Update the attributes on a conversation participant. +PatchConversationsEmailParticipantAttributesRequest.patchConversationsEmailParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsEmailParticipantAttributesRequest.patchConversationsEmailParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsEmailParticipantCommunication-example.txt b/build/docs/patchConversationsEmailParticipantCommunication-example.txt new file mode 100644 index 000000000..3a867366d --- /dev/null +++ b/build/docs/patchConversationsEmailParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsEmailParticipantCommunicationRequest.patchConversationsEmailParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsEmailParticipantCommunicationRequest.patchConversationsEmailParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessage-example.txt b/build/docs/patchConversationsMessage-example.txt new file mode 100644 index 000000000..3908a3e83 --- /dev/null +++ b/build/docs/patchConversationsMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Update a conversation by disconnecting all of the participants +PatchConversationsMessageRequest.patchConversationsMessage(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessageRequest.patchConversationsMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessageParticipant-example.txt b/build/docs/patchConversationsMessageParticipant-example.txt new file mode 100644 index 000000000..246c324fd --- /dev/null +++ b/build/docs/patchConversationsMessageParticipant-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // + +// Update conversation participant +PatchConversationsMessageParticipantRequest.patchConversationsMessageParticipant(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsMessageParticipantRequest.patchConversationsMessageParticipant was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessageParticipantAttributes-example.txt b/build/docs/patchConversationsMessageParticipantAttributes-example.txt new file mode 100644 index 000000000..75eacfb9e --- /dev/null +++ b/build/docs/patchConversationsMessageParticipantAttributes-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ParticipantAttributes = new ParticipantAttributes(...) // + +// Update the attributes on a conversation participant. +PatchConversationsMessageParticipantAttributesRequest.patchConversationsMessageParticipantAttributes(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessageParticipantAttributesRequest.patchConversationsMessageParticipantAttributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessageParticipantCommunication-example.txt b/build/docs/patchConversationsMessageParticipantCommunication-example.txt new file mode 100644 index 000000000..45a7268ad --- /dev/null +++ b/build/docs/patchConversationsMessageParticipantCommunication-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: MediaParticipantRequest = new MediaParticipantRequest(...) // Participant + +// Update conversation participant's communication by disconnecting it. +PatchConversationsMessageParticipantCommunicationRequest.patchConversationsMessageParticipantCommunication(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessageParticipantCommunicationRequest.patchConversationsMessageParticipantCommunication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingIntegrationsFacebookIntegrationId-example.txt b/build/docs/patchConversationsMessagingIntegrationsFacebookIntegrationId-example.txt new file mode 100644 index 000000000..4f48632ba --- /dev/null +++ b/build/docs/patchConversationsMessagingIntegrationsFacebookIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: FacebookIntegrationUpdateRequest = new FacebookIntegrationUpdateRequest(...) // FacebookIntegrationUpdateRequest + +// Update Facebook messaging integration +PatchConversationsMessagingIntegrationsFacebookIntegrationIdRequest.patchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingIntegrationsFacebookIntegrationIdRequest.patchConversationsMessagingIntegrationsFacebookIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingIntegrationsInstagramIntegrationId-example.txt b/build/docs/patchConversationsMessagingIntegrationsInstagramIntegrationId-example.txt new file mode 100644 index 000000000..b2bfff5af --- /dev/null +++ b/build/docs/patchConversationsMessagingIntegrationsInstagramIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: InstagramIntegrationUpdateRequest = new InstagramIntegrationUpdateRequest(...) // InstagramIntegrationUpdateRequest + +// Update Instagram messaging integration +PatchConversationsMessagingIntegrationsInstagramIntegrationIdRequest.patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingIntegrationsInstagramIntegrationIdRequest.patchConversationsMessagingIntegrationsInstagramIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingIntegrationsOpenIntegrationId-example.txt b/build/docs/patchConversationsMessagingIntegrationsOpenIntegrationId-example.txt new file mode 100644 index 000000000..6356422e7 --- /dev/null +++ b/build/docs/patchConversationsMessagingIntegrationsOpenIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: OpenIntegrationUpdateRequest = new OpenIntegrationUpdateRequest(...) // OpenIntegrationUpdateRequest + +// Update an Open messaging integration +PatchConversationsMessagingIntegrationsOpenIntegrationIdRequest.patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingIntegrationsOpenIntegrationIdRequest.patchConversationsMessagingIntegrationsOpenIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingIntegrationsTwitterIntegrationId-example.txt b/build/docs/patchConversationsMessagingIntegrationsTwitterIntegrationId-example.txt new file mode 100644 index 000000000..17cdd85fa --- /dev/null +++ b/build/docs/patchConversationsMessagingIntegrationsTwitterIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: TwitterIntegrationRequest = new TwitterIntegrationRequest(...) // TwitterIntegrationRequest + +// Update Twitter messaging integration +PatchConversationsMessagingIntegrationsTwitterIntegrationIdRequest.patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingIntegrationsTwitterIntegrationIdRequest.patchConversationsMessagingIntegrationsTwitterIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt b/build/docs/patchConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt new file mode 100644 index 000000000..717d6679d --- /dev/null +++ b/build/docs/patchConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: WhatsAppIntegrationUpdateRequest = new WhatsAppIntegrationUpdateRequest(...) // WhatsAppIntegrationUpdateRequest + +// Update or activate a WhatsApp messaging integration +PatchConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.patchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingIntegrationsWhatsappIntegrationIdRequest.patchConversationsMessagingIntegrationsWhatsappIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingSetting-example.txt b/build/docs/patchConversationsMessagingSetting-example.txt new file mode 100644 index 000000000..5f9fe0140 --- /dev/null +++ b/build/docs/patchConversationsMessagingSetting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Setting ID +let body: MessagingSettingPatchRequest = new MessagingSettingPatchRequest(...) // MessagingSetting + +// Update a messaging setting +PatchConversationsMessagingSettingRequest.patchConversationsMessagingSetting(messageSettingId: messageSettingId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingSettingRequest.patchConversationsMessagingSetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/patchConversationsMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..ea2e084e1 --- /dev/null +++ b/build/docs/patchConversationsMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID +let body: SupportedContent = new SupportedContent(...) // SupportedContent + +// Update a supported content profile +PatchConversationsMessagingSupportedcontentSupportedContentIdRequest.patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchConversationsMessagingSupportedcontentSupportedContentIdRequest.patchConversationsMessagingSupportedcontentSupportedContentId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchConversationsSettings-example.txt b/build/docs/patchConversationsSettings-example.txt new file mode 100644 index 000000000..e36a49f20 --- /dev/null +++ b/build/docs/patchConversationsSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Settings = new Settings(...) // Settings + +// Update Settings +PatchConversationsSettingsRequest.patchConversationsSettings(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchConversationsSettingsRequest.patchConversationsSettings was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchEmailsSettings-example.txt b/build/docs/patchEmailsSettings-example.txt new file mode 100644 index 000000000..c9a3d68cf --- /dev/null +++ b/build/docs/patchEmailsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EmailSettings = new EmailSettings(...) // + +// Patch email Contact Center settings +PatchEmailsSettingsRequest.patchEmailsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchEmailsSettingsRequest.patchEmailsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchEmployeeperformanceExternalmetricsDefinition-example.txt b/build/docs/patchEmployeeperformanceExternalmetricsDefinition-example.txt new file mode 100644 index 000000000..36b8d3410 --- /dev/null +++ b/build/docs/patchEmployeeperformanceExternalmetricsDefinition-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let metricId: String = "" // Specifies the metric definition ID +let body: ExternalMetricDefinitionUpdateRequest = new ExternalMetricDefinitionUpdateRequest(...) // The External Metric Definition parameters to be updated + +// Update External Metric Definition +PatchEmployeeperformanceExternalmetricsDefinitionRequest.patchEmployeeperformanceExternalmetricsDefinition(metricId: metricId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchEmployeeperformanceExternalmetricsDefinitionRequest.patchEmployeeperformanceExternalmetricsDefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchExternalcontactsContactIdentifiers-example.txt b/build/docs/patchExternalcontactsContactIdentifiers-example.txt new file mode 100644 index 000000000..6e20c0e05 --- /dev/null +++ b/build/docs/patchExternalcontactsContactIdentifiers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID +let body: IdentifierClaimRequest = new IdentifierClaimRequest(...) // ClaimRequest + +// Claim or release identifiers for a contact +PatchExternalcontactsContactIdentifiersRequest.patchExternalcontactsContactIdentifiers(contactId: contactId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchExternalcontactsContactIdentifiersRequest.patchExternalcontactsContactIdentifiers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchGeolocationsSettings-example.txt b/build/docs/patchGeolocationsSettings-example.txt new file mode 100644 index 000000000..079311ebd --- /dev/null +++ b/build/docs/patchGeolocationsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GeolocationSettings = new GeolocationSettings(...) // Geolocation settings + +// Patch a organization's GeolocationSettings +PatchGeolocationsSettingsRequest.patchGeolocationsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchGeolocationsSettingsRequest.patchGeolocationsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchIntegration-example.txt b/build/docs/patchIntegration-example.txt new file mode 100644 index 000000000..28692112e --- /dev/null +++ b/build/docs/patchIntegration-example.txt @@ -0,0 +1,23 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration Id +let pageSize: Int = 0 // The total page size requested +let pageNumber: Int = 0 // The page number requested +let sortBy: String = "" // variable name requested to sort by +let expand: [String] = [""] // variable name requested by expand list +let nextPage: String = "" // next page token +let previousPage: String = "" // Previous page token +let body: Integration = new Integration(...) // Integration Update + +// Update an integration. +PatchIntegrationRequest.patchIntegration(integrationId: integrationId, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, expand: expand, nextPage: nextPage, previousPage: previousPage, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchIntegrationRequest.patchIntegration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchIntegrationsAction-example.txt b/build/docs/patchIntegrationsAction-example.txt new file mode 100644 index 000000000..226d476b6 --- /dev/null +++ b/build/docs/patchIntegrationsAction-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: UpdateActionInput = new UpdateActionInput(...) // Input used to patch the Action. + +// Patch an Action +PatchIntegrationsActionRequest.patchIntegrationsAction(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchIntegrationsActionRequest.patchIntegrationsAction was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchIntegrationsActionDraft-example.txt b/build/docs/patchIntegrationsActionDraft-example.txt new file mode 100644 index 000000000..516680dd5 --- /dev/null +++ b/build/docs/patchIntegrationsActionDraft-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: UpdateDraftInput = new UpdateDraftInput(...) // Input used to patch the Action Draft. + +// Update an existing Draft +PatchIntegrationsActionDraftRequest.patchIntegrationsActionDraft(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchIntegrationsActionDraftRequest.patchIntegrationsActionDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchJourneyActionmap-example.txt b/build/docs/patchJourneyActionmap-example.txt new file mode 100644 index 000000000..ba22637d1 --- /dev/null +++ b/build/docs/patchJourneyActionmap-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionMapId: String = "" // ID of the action map. +let body: PatchActionMap = new PatchActionMap(...) // + +// Update single action map. +PatchJourneyActionmapRequest.patchJourneyActionmap(actionMapId: actionMapId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchJourneyActionmapRequest.patchJourneyActionmap was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchJourneyActiontarget-example.txt b/build/docs/patchJourneyActiontarget-example.txt new file mode 100644 index 000000000..3486a0a40 --- /dev/null +++ b/build/docs/patchJourneyActiontarget-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionTargetId: String = "" // ID of the action target. +let body: PatchActionTarget = new PatchActionTarget(...) // + +// Update a single action target. +PatchJourneyActiontargetRequest.patchJourneyActiontarget(actionTargetId: actionTargetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchJourneyActiontargetRequest.patchJourneyActiontarget was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchJourneyActiontemplate-example.txt b/build/docs/patchJourneyActiontemplate-example.txt new file mode 100644 index 000000000..b09c6852a --- /dev/null +++ b/build/docs/patchJourneyActiontemplate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionTemplateId: String = "" // ID of the action template. +let body: PatchActionTemplate = new PatchActionTemplate(...) // + +// Update a single action template. +PatchJourneyActiontemplateRequest.patchJourneyActiontemplate(actionTemplateId: actionTemplateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchJourneyActiontemplateRequest.patchJourneyActiontemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchJourneyOutcome-example.txt b/build/docs/patchJourneyOutcome-example.txt new file mode 100644 index 000000000..2ceb4e0a0 --- /dev/null +++ b/build/docs/patchJourneyOutcome-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let outcomeId: String = "" // ID of the outcome. +let body: PatchOutcome = new PatchOutcome(...) // + +// Update an outcome. +PatchJourneyOutcomeRequest.patchJourneyOutcome(outcomeId: outcomeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchJourneyOutcomeRequest.patchJourneyOutcome was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchJourneySegment-example.txt b/build/docs/patchJourneySegment-example.txt new file mode 100644 index 000000000..9f55392db --- /dev/null +++ b/build/docs/patchJourneySegment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let segmentId: String = "" // ID of the segment. +let body: PatchSegment = new PatchSegment(...) // + +// Update a segment. +PatchJourneySegmentRequest.patchJourneySegment(segmentId: segmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchJourneySegmentRequest.patchJourneySegment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeGuestSessionDocumentsSearchSearchId-example.txt b/build/docs/patchKnowledgeGuestSessionDocumentsSearchSearchId-example.txt new file mode 100644 index 000000000..1c6ef6561 --- /dev/null +++ b/build/docs/patchKnowledgeGuestSessionDocumentsSearchSearchId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let searchId: String = "" // Search Result ID +let body: SearchUpdateRequest = new SearchUpdateRequest(...) // + +// Update search result. +PatchKnowledgeGuestSessionDocumentsSearchSearchIdRequest.patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId: sessionId, searchId: searchId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchKnowledgeGuestSessionDocumentsSearchSearchIdRequest.patchKnowledgeGuestSessionDocumentsSearchSearchId was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebase-example.txt b/build/docs/patchKnowledgeKnowledgebase-example.txt new file mode 100644 index 000000000..6348e3d1b --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebase-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: KnowledgeBaseUpdateRequest = new KnowledgeBaseUpdateRequest(...) // + +// Update knowledge base +PatchKnowledgeKnowledgebaseRequest.patchKnowledgeKnowledgebase(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseRequest.patchKnowledgeKnowledgebase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseCategory-example.txt b/build/docs/patchKnowledgeKnowledgebaseCategory-example.txt new file mode 100644 index 000000000..cf8c5ce46 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseCategory-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let categoryId: String = "" // Category ID +let body: CategoryUpdateRequest = new CategoryUpdateRequest(...) // + +// Update category +PatchKnowledgeKnowledgebaseCategoryRequest.patchKnowledgeKnowledgebaseCategory(knowledgeBaseId: knowledgeBaseId, categoryId: categoryId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseCategoryRequest.patchKnowledgeKnowledgebaseCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseDocument-example.txt b/build/docs/patchKnowledgeKnowledgebaseDocument-example.txt new file mode 100644 index 000000000..7b5f2c715 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseDocument-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let body: KnowledgeDocumentReq = new KnowledgeDocumentReq(...) // + +// Update document. +PatchKnowledgeKnowledgebaseDocumentRequest.patchKnowledgeKnowledgebaseDocument(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseDocumentRequest.patchKnowledgeKnowledgebaseDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseDocumentVariation-example.txt b/build/docs/patchKnowledgeKnowledgebaseDocumentVariation-example.txt new file mode 100644 index 000000000..6be319227 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseDocumentVariation-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentVariationId: String = "" // Globally unique identifier for a document variation. +let documentId: String = "" // Globally unique identifier for a document. +let knowledgeBaseId: String = "" // Globally unique identifier for a knowledge base. +let body: DocumentVariation = new DocumentVariation(...) // + +// Update a variation for a document. +PatchKnowledgeKnowledgebaseDocumentVariationRequest.patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId: documentVariationId, documentId: documentId, knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseDocumentVariationRequest.patchKnowledgeKnowledgebaseDocumentVariation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseDocumentsSearchSearchId-example.txt b/build/docs/patchKnowledgeKnowledgebaseDocumentsSearchSearchId-example.txt new file mode 100644 index 000000000..778c43cc6 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseDocumentsSearchSearchId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // The ID of knowledge base containing the documents to query. +let searchId: String = "" // Search Result ID +let body: SearchUpdateRequest = new SearchUpdateRequest(...) // + +// Update search result. +PatchKnowledgeKnowledgebaseDocumentsSearchSearchIdRequest.patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId: knowledgeBaseId, searchId: searchId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchKnowledgeKnowledgebaseDocumentsSearchSearchIdRequest.patchKnowledgeKnowledgebaseDocumentsSearchSearchId was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseImportJob-example.txt b/build/docs/patchKnowledgeKnowledgebaseImportJob-example.txt new file mode 100644 index 000000000..fbfa6fe00 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseImportJob-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let importJobId: String = "" // Import job ID +let body: ImportStatusRequest = new ImportStatusRequest(...) // + +// Start import job +PatchKnowledgeKnowledgebaseImportJobRequest.patchKnowledgeKnowledgebaseImportJob(knowledgeBaseId: knowledgeBaseId, importJobId: importJobId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseImportJobRequest.patchKnowledgeKnowledgebaseImportJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseLabel-example.txt b/build/docs/patchKnowledgeKnowledgebaseLabel-example.txt new file mode 100644 index 000000000..7223875a3 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseLabel-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let labelId: String = "" // Label ID +let body: LabelUpdateRequest = new LabelUpdateRequest(...) // + +// Update label +PatchKnowledgeKnowledgebaseLabelRequest.patchKnowledgeKnowledgebaseLabel(knowledgeBaseId: knowledgeBaseId, labelId: labelId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseLabelRequest.patchKnowledgeKnowledgebaseLabel was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseLanguageCategory-example.txt b/build/docs/patchKnowledgeKnowledgebaseLanguageCategory-example.txt new file mode 100644 index 000000000..0a6342b3c --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseLanguageCategory-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let categoryId: String = "" // Category ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PatchKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageCategory = PatchKnowledgeKnowledgebaseLanguageCategoryRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageCategory.enummember // Language code, format: iso2-LOCALE +let body: KnowledgeCategoryRequest = new KnowledgeCategoryRequest(...) // + +// Update category +PatchKnowledgeKnowledgebaseLanguageCategoryRequest.patchKnowledgeKnowledgebaseLanguageCategory(categoryId: categoryId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseLanguageCategoryRequest.patchKnowledgeKnowledgebaseLanguageCategory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseLanguageDocument-example.txt b/build/docs/patchKnowledgeKnowledgebaseLanguageDocument-example.txt new file mode 100644 index 000000000..cde7e4927 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseLanguageDocument-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocument = PatchKnowledgeKnowledgebaseLanguageDocumentRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocument.enummember // Language code, format: iso2-LOCALE +let body: KnowledgeDocumentRequest = new KnowledgeDocumentRequest(...) // + +// Update document +PatchKnowledgeKnowledgebaseLanguageDocumentRequest.patchKnowledgeKnowledgebaseLanguageDocument(documentId: documentId, knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseLanguageDocumentRequest.patchKnowledgeKnowledgebaseLanguageDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseLanguageDocuments-example.txt b/build/docs/patchKnowledgeKnowledgebaseLanguageDocuments-example.txt new file mode 100644 index 000000000..05ef65857 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseLanguageDocuments-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocuments = PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE +let body: [KnowledgeDocumentBulkRequest] = [new KnowledgeDocumentBulkRequest(...)] // + +// Update documents collection +PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseLanguageDocumentsRequest.patchKnowledgeKnowledgebaseLanguageDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt b/build/docs/patchKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt new file mode 100644 index 000000000..ba0bf45af --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseLanguageDocumentsImport-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocumentsImport = PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.LanguageCode_patchKnowledgeKnowledgebaseLanguageDocumentsImport.enummember // Language code, format: iso2-LOCALE +let importId: String = "" // Import ID +let body: ImportStatusRequest = new ImportStatusRequest(...) // + +// Start import operation +PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, importId: importId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseLanguageDocumentsImportRequest.patchKnowledgeKnowledgebaseLanguageDocumentsImport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt b/build/docs/patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt new file mode 100644 index 000000000..7fc721998 --- /dev/null +++ b/build/docs/patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let groupId: String = "" // The ID of the group to be updated. +let phraseGroupId: String = "" // The ID of the phraseGroup to be updated. +let body: UnansweredPhraseGroupPatchRequestBody = new UnansweredPhraseGroupPatchRequestBody(...) // Request body of the update unanswered group endpoint. + +// Update a Knowledge base unanswered phrase group +PatchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId: knowledgeBaseId, groupId: groupId, phraseGroupId: phraseGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchKnowledgeKnowledgebaseUnansweredGroupPhrasegroupRequest.patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchLanguageunderstandingDomain-example.txt b/build/docs/patchLanguageunderstandingDomain-example.txt new file mode 100644 index 000000000..0f59d7302 --- /dev/null +++ b/build/docs/patchLanguageunderstandingDomain-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let body: NluDomain = new NluDomain(...) // The updated NLU Domain. + +// Update an NLU Domain. +PatchLanguageunderstandingDomainRequest.patchLanguageunderstandingDomain(domainId: domainId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchLanguageunderstandingDomainRequest.patchLanguageunderstandingDomain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchLanguageunderstandingMinerDraft-example.txt b/build/docs/patchLanguageunderstandingMinerDraft-example.txt new file mode 100644 index 000000000..651b9ec45 --- /dev/null +++ b/build/docs/patchLanguageunderstandingMinerDraft-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let draftId: String = "" // Draft ID +let body: DraftRequest = new DraftRequest(...) // + +// Save information for the draft. Either topic draft or intent draft should be sent. +PatchLanguageunderstandingMinerDraftRequest.patchLanguageunderstandingMinerDraft(minerId: minerId, draftId: draftId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchLanguageunderstandingMinerDraftRequest.patchLanguageunderstandingMinerDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchLearningAssignment-example.txt b/build/docs/patchLearningAssignment-example.txt new file mode 100644 index 000000000..6a395b3c9 --- /dev/null +++ b/build/docs/patchLearningAssignment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The ID of Learning Assignment +let body: LearningAssignmentUpdate = new LearningAssignmentUpdate(...) // The Learning Assignment to be updated + +// Update Learning Assignment +PatchLearningAssignmentRequest.patchLearningAssignment(assignmentId: assignmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchLearningAssignmentRequest.patchLearningAssignment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchLearningAssignmentReschedule-example.txt b/build/docs/patchLearningAssignmentReschedule-example.txt new file mode 100644 index 000000000..ebeaad9dc --- /dev/null +++ b/build/docs/patchLearningAssignmentReschedule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The ID of Learning Assignment +let body: LearningAssignmentReschedule = new LearningAssignmentReschedule(...) // The Learning assignment reschedule model + +// Reschedule Learning Assignment +PatchLearningAssignmentRescheduleRequest.patchLearningAssignmentReschedule(assignmentId: assignmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchLearningAssignmentRescheduleRequest.patchLearningAssignmentReschedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchLocation-example.txt b/build/docs/patchLocation-example.txt new file mode 100644 index 000000000..30e671bed --- /dev/null +++ b/build/docs/patchLocation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let locationId: String = "" // Location ID +let body: LocationUpdateDefinition = new LocationUpdateDefinition(...) // Location + +// Update a location +PatchLocationRequest.patchLocation(locationId: locationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchLocationRequest.patchLocation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchMessagingSetting-example.txt b/build/docs/patchMessagingSetting-example.txt new file mode 100644 index 000000000..462848730 --- /dev/null +++ b/build/docs/patchMessagingSetting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageSettingId: String = "" // Message Settings ID +let body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting + +// Update a messaging setting +PatchMessagingSettingRequest.patchMessagingSetting(messageSettingId: messageSettingId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchMessagingSettingRequest.patchMessagingSetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchMessagingSupportedcontentSupportedContentId-example.txt b/build/docs/patchMessagingSupportedcontentSupportedContentId-example.txt new file mode 100644 index 000000000..f4c2afd75 --- /dev/null +++ b/build/docs/patchMessagingSupportedcontentSupportedContentId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let supportedContentId: String = "" // Supported Content ID +let body: SupportedContent = new SupportedContent(...) // SupportedContent + +// Update a supported content profile +PatchMessagingSupportedcontentSupportedContentIdRequest.patchMessagingSupportedcontentSupportedContentId(supportedContentId: supportedContentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchMessagingSupportedcontentSupportedContentIdRequest.patchMessagingSupportedcontentSupportedContentId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchOrganizationsAuthenticationSettings-example.txt b/build/docs/patchOrganizationsAuthenticationSettings-example.txt new file mode 100644 index 000000000..8c2bc4aec --- /dev/null +++ b/build/docs/patchOrganizationsAuthenticationSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OrgAuthSettings = new OrgAuthSettings(...) // Org settings + +// Update the organization's settings +PatchOrganizationsAuthenticationSettingsRequest.patchOrganizationsAuthenticationSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchOrganizationsAuthenticationSettingsRequest.patchOrganizationsAuthenticationSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchOrganizationsFeature-example.txt b/build/docs/patchOrganizationsFeature-example.txt new file mode 100644 index 000000000..611ba8c40 --- /dev/null +++ b/build/docs/patchOrganizationsFeature-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let featureName: PatchOrganizationsFeatureRequest.FeatureName_patchOrganizationsFeature = PatchOrganizationsFeatureRequest.FeatureName_patchOrganizationsFeature.enummember // Organization feature +let enabled: FeatureState = new FeatureState(...) // New state of feature + +// Update organization +PatchOrganizationsFeatureRequest.patchOrganizationsFeature(featureName: featureName, enabled: enabled) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchOrganizationsFeatureRequest.patchOrganizationsFeature was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchOutboundDnclistCustomexclusioncolumns-example.txt b/build/docs/patchOutboundDnclistCustomexclusioncolumns-example.txt new file mode 100644 index 000000000..f34100997 --- /dev/null +++ b/build/docs/patchOutboundDnclistCustomexclusioncolumns-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: DncPatchCustomExclusionColumnsRequest = new DncPatchCustomExclusionColumnsRequest(...) // DNC Custom exclusion column entries + +// Add entries to or delete entries from a DNC list. +PatchOutboundDnclistCustomexclusioncolumnsRequest.patchOutboundDnclistCustomexclusioncolumns(dncListId: dncListId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchOutboundDnclistCustomexclusioncolumnsRequest.patchOutboundDnclistCustomexclusioncolumns was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchOutboundDnclistEmailaddresses-example.txt b/build/docs/patchOutboundDnclistEmailaddresses-example.txt new file mode 100644 index 000000000..95e95a6bc --- /dev/null +++ b/build/docs/patchOutboundDnclistEmailaddresses-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: DncPatchEmailsRequest = new DncPatchEmailsRequest(...) // DNC Emails + +// Add emails to or Delete emails from a DNC list. +PatchOutboundDnclistEmailaddressesRequest.patchOutboundDnclistEmailaddresses(dncListId: dncListId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchOutboundDnclistEmailaddressesRequest.patchOutboundDnclistEmailaddresses was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchOutboundDnclistPhonenumbers-example.txt b/build/docs/patchOutboundDnclistPhonenumbers-example.txt new file mode 100644 index 000000000..4cd04e95f --- /dev/null +++ b/build/docs/patchOutboundDnclistPhonenumbers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: DncPatchPhoneNumbersRequest = new DncPatchPhoneNumbersRequest(...) // DNC Phone Numbers + +// Add numbers to or delete numbers from a DNC list. +PatchOutboundDnclistPhonenumbersRequest.patchOutboundDnclistPhonenumbers(dncListId: dncListId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchOutboundDnclistPhonenumbersRequest.patchOutboundDnclistPhonenumbers was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchOutboundSettings-example.txt b/build/docs/patchOutboundSettings-example.txt new file mode 100644 index 000000000..13e34df54 --- /dev/null +++ b/build/docs/patchOutboundSettings-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OutboundSettings = new OutboundSettings(...) // outboundSettings + +// Update the outbound settings for this organization +PatchOutboundSettingsRequest.patchOutboundSettings(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchOutboundSettingsRequest.patchOutboundSettings was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchQualityFormsSurvey-example.txt b/build/docs/patchQualityFormsSurvey-example.txt new file mode 100644 index 000000000..e8b29a41d --- /dev/null +++ b/build/docs/patchQualityFormsSurvey-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let body: SurveyForm = new SurveyForm(...) // Survey form + +// 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. +PatchQualityFormsSurveyRequest.patchQualityFormsSurvey(formId: formId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchQualityFormsSurveyRequest.patchQualityFormsSurvey was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRecordingCrossplatformMediaretentionpolicy-example.txt b/build/docs/patchRecordingCrossplatformMediaretentionpolicy-example.txt new file mode 100644 index 000000000..6b48609ce --- /dev/null +++ b/build/docs/patchRecordingCrossplatformMediaretentionpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID +let body: CrossPlatformPolicyUpdate = new CrossPlatformPolicyUpdate(...) // Policy + +// Patch a media retention policy +PatchRecordingCrossplatformMediaretentionpolicyRequest.patchRecordingCrossplatformMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRecordingCrossplatformMediaretentionpolicyRequest.patchRecordingCrossplatformMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRecordingMediaretentionpolicy-example.txt b/build/docs/patchRecordingMediaretentionpolicy-example.txt new file mode 100644 index 000000000..0dc0168bc --- /dev/null +++ b/build/docs/patchRecordingMediaretentionpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID +let body: PolicyUpdate = new PolicyUpdate(...) // Policy + +// Patch a media retention policy +PatchRecordingMediaretentionpolicyRequest.patchRecordingMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRecordingMediaretentionpolicyRequest.patchRecordingMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRecordingsScreensession-example.txt b/build/docs/patchRecordingsScreensession-example.txt new file mode 100644 index 000000000..ea4b9fcd9 --- /dev/null +++ b/build/docs/patchRecordingsScreensession-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recordingSessionId: String = "" // Screen recording session ID +let body: ScreenRecordingSessionRequest = new ScreenRecordingSessionRequest(...) // + +// Update a screen recording session +PatchRecordingsScreensessionRequest.patchRecordingsScreensession(recordingSessionId: recordingSessionId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchRecordingsScreensessionRequest.patchRecordingsScreensession was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingConversation-example.txt b/build/docs/patchRoutingConversation-example.txt new file mode 100644 index 000000000..9b16744f0 --- /dev/null +++ b/build/docs/patchRoutingConversation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let body: RoutingConversationAttributesRequest = new RoutingConversationAttributesRequest(...) // Conversation Attributes + +// Update attributes of an in-queue conversation +PatchRoutingConversationRequest.patchRoutingConversation(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingConversationRequest.patchRoutingConversation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingEmailDomain-example.txt b/build/docs/patchRoutingEmailDomain-example.txt new file mode 100644 index 000000000..c931eb3b8 --- /dev/null +++ b/build/docs/patchRoutingEmailDomain-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID +let body: InboundDomainPatchRequest = new InboundDomainPatchRequest(...) // Domain settings + +// Update domain settings +PatchRoutingEmailDomainRequest.patchRoutingEmailDomain(domainId: domainId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingEmailDomainRequest.patchRoutingEmailDomain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingEmailDomainValidate-example.txt b/build/docs/patchRoutingEmailDomainValidate-example.txt new file mode 100644 index 000000000..08ab3a0ce --- /dev/null +++ b/build/docs/patchRoutingEmailDomainValidate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID +let body: InboundDomainPatchRequest = new InboundDomainPatchRequest(...) // Domain settings + +// Validate domain settings +PatchRoutingEmailDomainValidateRequest.patchRoutingEmailDomainValidate(domainId: domainId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingEmailDomainValidateRequest.patchRoutingEmailDomainValidate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingPredictor-example.txt b/build/docs/patchRoutingPredictor-example.txt new file mode 100644 index 000000000..c473cef37 --- /dev/null +++ b/build/docs/patchRoutingPredictor-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let predictorId: String = "" // Predictor ID +let body: PatchPredictorRequest = new PatchPredictorRequest(...) // + +// Update single predictor. +PatchRoutingPredictorRequest.patchRoutingPredictor(predictorId: predictorId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingPredictorRequest.patchRoutingPredictor was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingQueueMember-example.txt b/build/docs/patchRoutingQueueMember-example.txt new file mode 100644 index 000000000..f6bcadaf8 --- /dev/null +++ b/build/docs/patchRoutingQueueMember-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let memberId: String = "" // Member ID +let body: QueueMember = new QueueMember(...) // Queue Member + +// Update the ring number OR joined status for a queue member. +PatchRoutingQueueMemberRequest.patchRoutingQueueMember(queueId: queueId, memberId: memberId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchRoutingQueueMemberRequest.patchRoutingQueueMember was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingQueueMembers-example.txt b/build/docs/patchRoutingQueueMembers-example.txt new file mode 100644 index 000000000..531d107b1 --- /dev/null +++ b/build/docs/patchRoutingQueueMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: [QueueMember] = [new QueueMember(...)] // Queue Members + +// Join or unjoin a set of users for a queue +PatchRoutingQueueMembersRequest.patchRoutingQueueMembers(queueId: queueId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingQueueMembersRequest.patchRoutingQueueMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingQueueUser-example.txt b/build/docs/patchRoutingQueueUser-example.txt new file mode 100644 index 000000000..ff1ac5cd9 --- /dev/null +++ b/build/docs/patchRoutingQueueUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let memberId: String = "" // Member ID +let body: QueueMember = new QueueMember(...) // Queue Member + +// DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue. +PatchRoutingQueueUserRequest.patchRoutingQueueUser(queueId: queueId, memberId: memberId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchRoutingQueueUserRequest.patchRoutingQueueUser was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingQueueUsers-example.txt b/build/docs/patchRoutingQueueUsers-example.txt new file mode 100644 index 000000000..ad6e7f81e --- /dev/null +++ b/build/docs/patchRoutingQueueUsers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: [QueueMember] = [new QueueMember(...)] // Queue Members + +// DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue. +PatchRoutingQueueUsersRequest.patchRoutingQueueUsers(queueId: queueId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingQueueUsersRequest.patchRoutingQueueUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingSettingsContactcenter-example.txt b/build/docs/patchRoutingSettingsContactcenter-example.txt new file mode 100644 index 000000000..e23f7abbf --- /dev/null +++ b/build/docs/patchRoutingSettingsContactcenter-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ContactCenterSettings = new ContactCenterSettings(...) // Contact Center Settings + +// Update Contact Center Settings +PatchRoutingSettingsContactcenterRequest.patchRoutingSettingsContactcenter(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchRoutingSettingsContactcenterRequest.patchRoutingSettingsContactcenter was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchRoutingSkillgroup-example.txt b/build/docs/patchRoutingSkillgroup-example.txt new file mode 100644 index 000000000..69977276c --- /dev/null +++ b/build/docs/patchRoutingSkillgroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID +let body: SkillGroup = new SkillGroup(...) // Update skill groups + +// Update skill group definition +PatchRoutingSkillgroupRequest.patchRoutingSkillgroup(skillGroupId: skillGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchRoutingSkillgroupRequest.patchRoutingSkillgroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchScimGroup-example.txt b/build/docs/patchScimGroup-example.txt new file mode 100644 index 000000000..8fe114556 --- /dev/null +++ b/build/docs/patchScimGroup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/groups. +let body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a group. +let ifMatch: String = "" // 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\". + +// Modify a group +PatchScimGroupRequest.patchScimGroup(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchScimGroupRequest.patchScimGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchScimUser-example.txt b/build/docs/patchScimUser-example.txt new file mode 100644 index 000000000..8c040f249 --- /dev/null +++ b/build/docs/patchScimUser-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/users. +let body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a user. +let ifMatch: String = "" // 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\". + +// Modify a user +PatchScimUserRequest.patchScimUser(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchScimUserRequest.patchScimUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchScimV2Group-example.txt b/build/docs/patchScimV2Group-example.txt new file mode 100644 index 000000000..79b86ceb2 --- /dev/null +++ b/build/docs/patchScimV2Group-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/v2/groups. +let body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a group. +let ifMatch: String = "" // 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\". + +// Modify a group +PatchScimV2GroupRequest.patchScimV2Group(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchScimV2GroupRequest.patchScimV2Group was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchScimV2User-example.txt b/build/docs/patchScimV2User-example.txt new file mode 100644 index 000000000..57f2f00ce --- /dev/null +++ b/build/docs/patchScimV2User-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/v2/users. +let body: ScimV2PatchRequest = new ScimV2PatchRequest(...) // The information used to modify a user. +let ifMatch: String = "" // 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\". + +// Modify a user +PatchScimV2UserRequest.patchScimV2User(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchScimV2UserRequest.patchScimV2User was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchSpeechandtextanalyticsSettings-example.txt b/build/docs/patchSpeechandtextanalyticsSettings-example.txt new file mode 100644 index 000000000..af6e04691 --- /dev/null +++ b/build/docs/patchSpeechandtextanalyticsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SpeechTextAnalyticsSettingsRequest = new SpeechTextAnalyticsSettingsRequest(...) // Speech And Text Analytics Settings + +// Patch Speech And Text Analytics Settings +PatchSpeechandtextanalyticsSettingsRequest.patchSpeechandtextanalyticsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchSpeechandtextanalyticsSettingsRequest.patchSpeechandtextanalyticsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchTeam-example.txt b/build/docs/patchTeam-example.txt new file mode 100644 index 000000000..9ffbd61e8 --- /dev/null +++ b/build/docs/patchTeam-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID +let body: Team = new Team(...) // Team + +// Update team +PatchTeamRequest.patchTeam(teamId: teamId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchTeamRequest.patchTeam was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUser-example.txt b/build/docs/patchUser-example.txt new file mode 100644 index 000000000..4b496e0d6 --- /dev/null +++ b/build/docs/patchUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: UpdateUser = new UpdateUser(...) // User + +// Update user +PatchUserRequest.patchUser(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserRequest.patchUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserCallforwarding-example.txt b/build/docs/patchUserCallforwarding-example.txt new file mode 100644 index 000000000..7bc47f77e --- /dev/null +++ b/build/docs/patchUserCallforwarding-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: CallForwarding = new CallForwarding(...) // Call forwarding + +// Patch a user's CallForwarding +PatchUserCallforwardingRequest.patchUserCallforwarding(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserCallforwardingRequest.patchUserCallforwarding was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserGeolocation-example.txt b/build/docs/patchUserGeolocation-example.txt new file mode 100644 index 000000000..02667a6d7 --- /dev/null +++ b/build/docs/patchUserGeolocation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id +let clientId: String = "" // client Id +let body: Geolocation = new Geolocation(...) // Geolocation + +// Patch a user's Geolocation +PatchUserGeolocationRequest.patchUserGeolocation(userId: userId, clientId: clientId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserGeolocationRequest.patchUserGeolocation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserPresence-example.txt b/build/docs/patchUserPresence-example.txt new file mode 100644 index 000000000..10f73ff23 --- /dev/null +++ b/build/docs/patchUserPresence-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id +let sourceId: String = "" // Presence source ID +let body: UserPresence = new UserPresence(...) // User presence + +// Patch a user's Presence +PatchUserPresenceRequest.patchUserPresence(userId: userId, sourceId: sourceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserPresenceRequest.patchUserPresence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserPresencesPurecloud-example.txt b/build/docs/patchUserPresencesPurecloud-example.txt new file mode 100644 index 000000000..024f3c3bd --- /dev/null +++ b/build/docs/patchUserPresencesPurecloud-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user Id +let body: UserPresence = new UserPresence(...) // User presence + +// Patch a Genesys Cloud user's presence +PatchUserPresencesPurecloudRequest.patchUserPresencesPurecloud(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserPresencesPurecloudRequest.patchUserPresencesPurecloud was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserQueue-example.txt b/build/docs/patchUserQueue-example.txt new file mode 100644 index 000000000..1717d7e33 --- /dev/null +++ b/build/docs/patchUserQueue-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let userId: String = "" // User ID +let body: UserQueue = new UserQueue(...) // Queue Member + +// Join or unjoin a queue for a user +PatchUserQueueRequest.patchUserQueue(queueId: queueId, userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserQueueRequest.patchUserQueue was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserQueues-example.txt b/build/docs/patchUserQueues-example.txt new file mode 100644 index 000000000..5c897df37 --- /dev/null +++ b/build/docs/patchUserQueues-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: [UserQueue] = [new UserQueue(...)] // User Queues +let divisionId: [String] = [""] // Division ID(s) + +// Join or unjoin a set of queues for a user +PatchUserQueuesRequest.patchUserQueues(userId: userId, body: body, divisionId: divisionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserQueuesRequest.patchUserQueues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserRoutinglanguage-example.txt b/build/docs/patchUserRoutinglanguage-example.txt new file mode 100644 index 000000000..d29264de0 --- /dev/null +++ b/build/docs/patchUserRoutinglanguage-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let languageId: String = "" // languageId +let body: UserRoutingLanguage = new UserRoutingLanguage(...) // Language + +// Update routing language proficiency or state. +PatchUserRoutinglanguageRequest.patchUserRoutinglanguage(userId: userId, languageId: languageId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserRoutinglanguageRequest.patchUserRoutinglanguage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserRoutinglanguagesBulk-example.txt b/build/docs/patchUserRoutinglanguagesBulk-example.txt new file mode 100644 index 000000000..c04186820 --- /dev/null +++ b/build/docs/patchUserRoutinglanguagesBulk-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: [UserRoutingLanguagePost] = [new UserRoutingLanguagePost(...)] // Language + +// Add bulk routing language to user. Max limit 50 languages +PatchUserRoutinglanguagesBulkRequest.patchUserRoutinglanguagesBulk(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserRoutinglanguagesBulkRequest.patchUserRoutinglanguagesBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUserRoutingskillsBulk-example.txt b/build/docs/patchUserRoutingskillsBulk-example.txt new file mode 100644 index 000000000..68ca726d4 --- /dev/null +++ b/build/docs/patchUserRoutingskillsBulk-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: [UserRoutingSkillPost] = [new UserRoutingSkillPost(...)] // Skill + +// Bulk add routing skills to user +PatchUserRoutingskillsBulkRequest.patchUserRoutingskillsBulk(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUserRoutingskillsBulkRequest.patchUserRoutingskillsBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchUsersBulk-example.txt b/build/docs/patchUsersBulk-example.txt new file mode 100644 index 000000000..4627058a3 --- /dev/null +++ b/build/docs/patchUsersBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [PatchUser] = [new PatchUser(...)] // Users + +// Update bulk acd autoanswer on users +PatchUsersBulkRequest.patchUsersBulk(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchUsersBulkRequest.patchUsersBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchVoicemailGroupPolicy-example.txt b/build/docs/patchVoicemailGroupPolicy-example.txt new file mode 100644 index 000000000..b8ac4063a --- /dev/null +++ b/build/docs/patchVoicemailGroupPolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let body: VoicemailGroupPolicy = new VoicemailGroupPolicy(...) // The group's voicemail policy + +// Update a group's voicemail policy +PatchVoicemailGroupPolicyRequest.patchVoicemailGroupPolicy(groupId: groupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchVoicemailGroupPolicyRequest.patchVoicemailGroupPolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchVoicemailMePolicy-example.txt b/build/docs/patchVoicemailMePolicy-example.txt new file mode 100644 index 000000000..c70f73ac9 --- /dev/null +++ b/build/docs/patchVoicemailMePolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy + +// Update the current user's voicemail policy +PatchVoicemailMePolicyRequest.patchVoicemailMePolicy(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchVoicemailMePolicyRequest.patchVoicemailMePolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchVoicemailMessage-example.txt b/build/docs/patchVoicemailMessage-example.txt new file mode 100644 index 000000000..26b365a87 --- /dev/null +++ b/build/docs/patchVoicemailMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // Message ID +let body: VoicemailMessage = new VoicemailMessage(...) // VoicemailMessage + +// Update a voicemail message +PatchVoicemailMessageRequest.patchVoicemailMessage(messageId: messageId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchVoicemailMessageRequest.patchVoicemailMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchVoicemailUserpolicy-example.txt b/build/docs/patchVoicemailUserpolicy-example.txt new file mode 100644 index 000000000..dd9c1959b --- /dev/null +++ b/build/docs/patchVoicemailUserpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy + +// Update a user's voicemail policy +PatchVoicemailUserpolicyRequest.patchVoicemailUserpolicy(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchVoicemailUserpolicyRequest.patchVoicemailUserpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWebchatGuestConversationMediarequest-example.txt b/build/docs/patchWebchatGuestConversationMediarequest-example.txt new file mode 100644 index 000000000..f21a22293 --- /dev/null +++ b/build/docs/patchWebchatGuestConversationMediarequest-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let mediaRequestId: String = "" // mediaRequestId +let body: WebChatGuestMediaRequest = new WebChatGuestMediaRequest(...) // Request + +// Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED +PatchWebchatGuestConversationMediarequestRequest.patchWebchatGuestConversationMediarequest(conversationId: conversationId, mediaRequestId: mediaRequestId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWebchatGuestConversationMediarequestRequest.patchWebchatGuestConversationMediarequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementAgentAdherenceExplanation-example.txt b/build/docs/patchWorkforcemanagementAgentAdherenceExplanation-example.txt new file mode 100644 index 000000000..aaf353535 --- /dev/null +++ b/build/docs/patchWorkforcemanagementAgentAdherenceExplanation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent to query +let explanationId: String = "" // The ID of the explanation to update +let body: UpdateAdherenceExplanationStatusRequest = new UpdateAdherenceExplanationStatusRequest(...) // The request body + +// Update an adherence explanation +PatchWorkforcemanagementAgentAdherenceExplanationRequest.patchWorkforcemanagementAgentAdherenceExplanation(agentId: agentId, explanationId: explanationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementAgentAdherenceExplanationRequest.patchWorkforcemanagementAgentAdherenceExplanation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementBusinessunit-example.txt b/build/docs/patchWorkforcemanagementBusinessunit-example.txt new file mode 100644 index 000000000..84183b9a9 --- /dev/null +++ b/build/docs/patchWorkforcemanagementBusinessunit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let body: UpdateBusinessUnitRequest = new UpdateBusinessUnitRequest(...) // body + +// Update business unit +PatchWorkforcemanagementBusinessunitRequest.patchWorkforcemanagementBusinessunit(businessUnitId: businessUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementBusinessunitRequest.patchWorkforcemanagementBusinessunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementBusinessunitActivitycode-example.txt b/build/docs/patchWorkforcemanagementBusinessunitActivitycode-example.txt new file mode 100644 index 000000000..7285a3e54 --- /dev/null +++ b/build/docs/patchWorkforcemanagementBusinessunitActivitycode-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let activityCodeId: String = "" // The ID of the activity code to update +let body: UpdateActivityCodeRequest = new UpdateActivityCodeRequest(...) // body + +// Update an activity code +PatchWorkforcemanagementBusinessunitActivitycodeRequest.patchWorkforcemanagementBusinessunitActivitycode(businessUnitId: businessUnitId, activityCodeId: activityCodeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementBusinessunitActivitycodeRequest.patchWorkforcemanagementBusinessunitActivitycode was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementBusinessunitPlanninggroup-example.txt b/build/docs/patchWorkforcemanagementBusinessunitPlanninggroup-example.txt new file mode 100644 index 000000000..10872a5a2 --- /dev/null +++ b/build/docs/patchWorkforcemanagementBusinessunitPlanninggroup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let planningGroupId: String = "" // The ID of a planning group to update +let body: UpdatePlanningGroupRequest = new UpdatePlanningGroupRequest(...) // body + +// Updates the planning group +PatchWorkforcemanagementBusinessunitPlanninggroupRequest.patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: businessUnitId, planningGroupId: planningGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementBusinessunitPlanninggroupRequest.patchWorkforcemanagementBusinessunitPlanninggroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementBusinessunitSchedulingRun-example.txt b/build/docs/patchWorkforcemanagementBusinessunitSchedulingRun-example.txt new file mode 100644 index 000000000..8b681db3f --- /dev/null +++ b/build/docs/patchWorkforcemanagementBusinessunitSchedulingRun-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let runId: String = "" // The ID of the schedule run +let body: PatchBuScheduleRunRequest = new PatchBuScheduleRunRequest(...) // body + +// Mark a schedule run as applied +PatchWorkforcemanagementBusinessunitSchedulingRunRequest.patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId: businessUnitId, runId: runId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PatchWorkforcemanagementBusinessunitSchedulingRunRequest.patchWorkforcemanagementBusinessunitSchedulingRun was successful") + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementBusinessunitServicegoaltemplate-example.txt b/build/docs/patchWorkforcemanagementBusinessunitServicegoaltemplate-example.txt new file mode 100644 index 000000000..8351a5248 --- /dev/null +++ b/build/docs/patchWorkforcemanagementBusinessunitServicegoaltemplate-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let serviceGoalTemplateId: String = "" // The ID of a service goal template to update +let body: UpdateServiceGoalTemplate = new UpdateServiceGoalTemplate(...) // body + +// Updates a service goal template +PatchWorkforcemanagementBusinessunitServicegoaltemplateRequest.patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId: businessUnitId, serviceGoalTemplateId: serviceGoalTemplateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementBusinessunitServicegoaltemplateRequest.patchWorkforcemanagementBusinessunitServicegoaltemplate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunit-example.txt b/build/docs/patchWorkforcemanagementManagementunit-example.txt new file mode 100644 index 000000000..629f2cc24 --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: UpdateManagementUnitRequest = new UpdateManagementUnitRequest(...) // body + +// Update the requested management unit +PatchWorkforcemanagementManagementunitRequest.patchWorkforcemanagementManagementunit(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitRequest.patchWorkforcemanagementManagementunit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitTimeofflimit-example.txt b/build/docs/patchWorkforcemanagementManagementunitTimeofflimit-example.txt new file mode 100644 index 000000000..b0e9a14e6 --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitTimeofflimit-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let timeOffLimitId: String = "" // The id of time off limit object to update +let body: UpdateTimeOffLimitRequest = new UpdateTimeOffLimitRequest(...) // body + +// Updates a time off limit object. +PatchWorkforcemanagementManagementunitTimeofflimitRequest.patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitTimeofflimitRequest.patchWorkforcemanagementManagementunitTimeofflimit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitTimeoffplan-example.txt b/build/docs/patchWorkforcemanagementManagementunitTimeoffplan-example.txt new file mode 100644 index 000000000..f1527086a --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitTimeoffplan-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let timeOffPlanId: String = "" // The ID of the time off plan to update +let body: UpdateTimeOffPlanRequest = new UpdateTimeOffPlanRequest(...) // body + +// Updates a time off plan +PatchWorkforcemanagementManagementunitTimeoffplanRequest.patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId: managementUnitId, timeOffPlanId: timeOffPlanId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitTimeoffplanRequest.patchWorkforcemanagementManagementunitTimeoffplan was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus-example.txt b/build/docs/patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus-example.txt new file mode 100644 index 000000000..5c67ac4b8 --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let timeOffRequestId: String = "" // The ID of the time off request. +let userId: String = "" // The ID of user to whom the time off request belongs. +let body: SetTimeOffIntegrationStatusRequest = new SetTimeOffIntegrationStatusRequest(...) // body + +// Set integration status for a time off request. +PatchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusRequest.patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId: managementUnitId, timeOffRequestId: timeOffRequestId, userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatusRequest.patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitUserTimeoffrequest-example.txt b/build/docs/patchWorkforcemanagementManagementunitUserTimeoffrequest-example.txt new file mode 100644 index 000000000..1988fc1dd --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitUserTimeoffrequest-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let userId: String = "" // The id of the user the requested time off request belongs to +let timeOffRequestId: String = "" // The id of the time off request to update +let body: AdminTimeOffRequestPatch = new AdminTimeOffRequestPatch(...) // body + +// Update a time off request +PatchWorkforcemanagementManagementunitUserTimeoffrequestRequest.patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitUserTimeoffrequestRequest.patchWorkforcemanagementManagementunitUserTimeoffrequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitWeekShifttrade-example.txt b/build/docs/patchWorkforcemanagementManagementunitWeekShifttrade-example.txt new file mode 100644 index 000000000..5fdbaaee3 --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitWeekShifttrade-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let tradeId: String = "" // The ID of the shift trade to update +let body: PatchShiftTradeRequest = new PatchShiftTradeRequest(...) // body + +// Updates a shift trade. This route can only be called by the initiating agent +PatchWorkforcemanagementManagementunitWeekShifttradeRequest.patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId: managementUnitId, weekDateId: weekDateId, tradeId: tradeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitWeekShifttradeRequest.patchWorkforcemanagementManagementunitWeekShifttrade was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitWorkplan-example.txt b/build/docs/patchWorkforcemanagementManagementunitWorkplan-example.txt new file mode 100644 index 000000000..a3597feaf --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitWorkplan-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanId: String = "" // The ID of the work plan to update +let validationMode: PatchWorkforcemanagementManagementunitWorkplanRequest.ValidationMode_patchWorkforcemanagementManagementunitWorkplan = PatchWorkforcemanagementManagementunitWorkplanRequest.ValidationMode_patchWorkforcemanagementManagementunitWorkplan.enummember // Allows to update work plan even if validation result is invalid +let body: WorkPlan = new WorkPlan(...) // body + +// Update a work plan +PatchWorkforcemanagementManagementunitWorkplanRequest.patchWorkforcemanagementManagementunitWorkplan(managementUnitId: managementUnitId, workPlanId: workPlanId, validationMode: validationMode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitWorkplanRequest.patchWorkforcemanagementManagementunitWorkplan was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementManagementunitWorkplanrotation-example.txt b/build/docs/patchWorkforcemanagementManagementunitWorkplanrotation-example.txt new file mode 100644 index 000000000..f2cc52028 --- /dev/null +++ b/build/docs/patchWorkforcemanagementManagementunitWorkplanrotation-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanRotationId: String = "" // The ID of the work plan rotation to update +let body: UpdateWorkPlanRotationRequest = new UpdateWorkPlanRotationRequest(...) // body + +// Update a work plan rotation +PatchWorkforcemanagementManagementunitWorkplanrotationRequest.patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementManagementunitWorkplanrotationRequest.patchWorkforcemanagementManagementunitWorkplanrotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/patchWorkforcemanagementTimeoffrequest-example.txt b/build/docs/patchWorkforcemanagementTimeoffrequest-example.txt new file mode 100644 index 000000000..d7ff9263d --- /dev/null +++ b/build/docs/patchWorkforcemanagementTimeoffrequest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let timeOffRequestId: String = "" // The ID of the time off request +let body: AgentTimeOffRequestPatch = new AgentTimeOffRequestPatch(...) // body + +// Update a time off request for the current user +PatchWorkforcemanagementTimeoffrequestRequest.patchWorkforcemanagementTimeoffrequest(timeOffRequestId: timeOffRequestId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PatchWorkforcemanagementTimeoffrequestRequest.patchWorkforcemanagementTimeoffrequest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAlertingAlertsQuery-example.txt b/build/docs/postAlertingAlertsQuery-example.txt new file mode 100644 index 000000000..17f4d2741 --- /dev/null +++ b/build/docs/postAlertingAlertsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GetAlertQuery = new GetAlertQuery(...) // + +// Gets a paged list of alerts. The max page size is 50 +PostAlertingAlertsQueryRequest.postAlertingAlertsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAlertingAlertsQueryRequest.postAlertingAlertsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAlertingInteractionstatsRules-example.txt b/build/docs/postAlertingInteractionstatsRules-example.txt new file mode 100644 index 000000000..4480fd854 --- /dev/null +++ b/build/docs/postAlertingInteractionstatsRules-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: InteractionStatsRule = new InteractionStatsRule(...) // AlertingRule +let expand: [String] = [""] // Which fields, if any, to expand + +// Create an interaction stats rule. +PostAlertingInteractionstatsRulesRequest.postAlertingInteractionstatsRules(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAlertingInteractionstatsRulesRequest.postAlertingInteractionstatsRules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAlertingRules-example.txt b/build/docs/postAlertingRules-example.txt new file mode 100644 index 000000000..9fc8d01a7 --- /dev/null +++ b/build/docs/postAlertingRules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CommonRule = new CommonRule(...) // rule to be created + +// Create a Rule. +PostAlertingRulesRequest.postAlertingRules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAlertingRulesRequest.postAlertingRules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAlertingRulesBulkRemove-example.txt b/build/docs/postAlertingRulesBulkRemove-example.txt new file mode 100644 index 000000000..58b35ab9e --- /dev/null +++ b/build/docs/postAlertingRulesBulkRemove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CommonRuleBulkDeleteRequest = new CommonRuleBulkDeleteRequest(...) // + +// Bulk remove rules +PostAlertingRulesBulkRemoveRequest.postAlertingRulesBulkRemove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAlertingRulesBulkRemoveRequest.postAlertingRulesBulkRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAlertingRulesQuery-example.txt b/build/docs/postAlertingRulesQuery-example.txt new file mode 100644 index 000000000..75b09a178 --- /dev/null +++ b/build/docs/postAlertingRulesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GetRulesQuery = new GetRulesQuery(...) // + +// Get a paged list of rules. The max size of the page is 50 items. +PostAlertingRulesQueryRequest.postAlertingRulesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAlertingRulesQueryRequest.postAlertingRulesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsActionsAggregatesQuery-example.txt b/build/docs/postAnalyticsActionsAggregatesQuery-example.txt new file mode 100644 index 000000000..0559da432 --- /dev/null +++ b/build/docs/postAnalyticsActionsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ActionAggregationQuery = new ActionAggregationQuery(...) // query + +// Query for action aggregates +PostAnalyticsActionsAggregatesQueryRequest.postAnalyticsActionsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsActionsAggregatesQueryRequest.postAnalyticsActionsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsBotsAggregatesQuery-example.txt b/build/docs/postAnalyticsBotsAggregatesQuery-example.txt new file mode 100644 index 000000000..31467f5f7 --- /dev/null +++ b/build/docs/postAnalyticsBotsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BotAggregationQuery = new BotAggregationQuery(...) // query + +// Query for bot aggregates +PostAnalyticsBotsAggregatesQueryRequest.postAnalyticsBotsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsBotsAggregatesQueryRequest.postAnalyticsBotsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsConversationDetailsProperties-example.txt b/build/docs/postAnalyticsConversationDetailsProperties-example.txt new file mode 100644 index 000000000..59f3cf9cf --- /dev/null +++ b/build/docs/postAnalyticsConversationDetailsProperties-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: PropertyIndexRequest = new PropertyIndexRequest(...) // request + +// Index conversation properties +PostAnalyticsConversationDetailsPropertiesRequest.postAnalyticsConversationDetailsProperties(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsConversationDetailsPropertiesRequest.postAnalyticsConversationDetailsProperties was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsConversationsAggregatesQuery-example.txt b/build/docs/postAnalyticsConversationsAggregatesQuery-example.txt new file mode 100644 index 000000000..5e753333f --- /dev/null +++ b/build/docs/postAnalyticsConversationsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationAggregationQuery = new ConversationAggregationQuery(...) // query + +// Query for conversation aggregates +PostAnalyticsConversationsAggregatesQueryRequest.postAnalyticsConversationsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsConversationsAggregatesQueryRequest.postAnalyticsConversationsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsConversationsDetailsJobs-example.txt b/build/docs/postAnalyticsConversationsDetailsJobs-example.txt new file mode 100644 index 000000000..e88623f3e --- /dev/null +++ b/build/docs/postAnalyticsConversationsDetailsJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AsyncConversationQuery = new AsyncConversationQuery(...) // query + +// Query for conversation details asynchronously +PostAnalyticsConversationsDetailsJobsRequest.postAnalyticsConversationsDetailsJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsConversationsDetailsJobsRequest.postAnalyticsConversationsDetailsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsConversationsDetailsQuery-example.txt b/build/docs/postAnalyticsConversationsDetailsQuery-example.txt new file mode 100644 index 000000000..f4a32b34f --- /dev/null +++ b/build/docs/postAnalyticsConversationsDetailsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationQuery = new ConversationQuery(...) // query + +// Query for conversation details +PostAnalyticsConversationsDetailsQueryRequest.postAnalyticsConversationsDetailsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsConversationsDetailsQueryRequest.postAnalyticsConversationsDetailsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsConversationsTranscriptsQuery-example.txt b/build/docs/postAnalyticsConversationsTranscriptsQuery-example.txt new file mode 100644 index 000000000..a071e656b --- /dev/null +++ b/build/docs/postAnalyticsConversationsTranscriptsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TranscriptConversationDetailSearchRequest = new TranscriptConversationDetailSearchRequest(...) // Search request options + +// Search resources. +PostAnalyticsConversationsTranscriptsQueryRequest.postAnalyticsConversationsTranscriptsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsConversationsTranscriptsQueryRequest.postAnalyticsConversationsTranscriptsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsEvaluationsAggregatesQuery-example.txt b/build/docs/postAnalyticsEvaluationsAggregatesQuery-example.txt new file mode 100644 index 000000000..0599ca287 --- /dev/null +++ b/build/docs/postAnalyticsEvaluationsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EvaluationAggregationQuery = new EvaluationAggregationQuery(...) // query + +// Query for evaluation aggregates +PostAnalyticsEvaluationsAggregatesQueryRequest.postAnalyticsEvaluationsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsEvaluationsAggregatesQueryRequest.postAnalyticsEvaluationsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsFlowsAggregatesQuery-example.txt b/build/docs/postAnalyticsFlowsAggregatesQuery-example.txt new file mode 100644 index 000000000..126182953 --- /dev/null +++ b/build/docs/postAnalyticsFlowsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FlowAggregationQuery = new FlowAggregationQuery(...) // query + +// Query for flow aggregates +PostAnalyticsFlowsAggregatesQueryRequest.postAnalyticsFlowsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsFlowsAggregatesQueryRequest.postAnalyticsFlowsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsFlowsObservationsQuery-example.txt b/build/docs/postAnalyticsFlowsObservationsQuery-example.txt new file mode 100644 index 000000000..66c1e78ec --- /dev/null +++ b/build/docs/postAnalyticsFlowsObservationsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FlowObservationQuery = new FlowObservationQuery(...) // query + +// Query for flow observations +PostAnalyticsFlowsObservationsQueryRequest.postAnalyticsFlowsObservationsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsFlowsObservationsQueryRequest.postAnalyticsFlowsObservationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsJourneysAggregatesQuery-example.txt b/build/docs/postAnalyticsJourneysAggregatesQuery-example.txt new file mode 100644 index 000000000..f9e722c93 --- /dev/null +++ b/build/docs/postAnalyticsJourneysAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: JourneyAggregationQuery = new JourneyAggregationQuery(...) // query + +// Query for journey aggregates +PostAnalyticsJourneysAggregatesQueryRequest.postAnalyticsJourneysAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsJourneysAggregatesQueryRequest.postAnalyticsJourneysAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsQueuesObservationsQuery-example.txt b/build/docs/postAnalyticsQueuesObservationsQuery-example.txt new file mode 100644 index 000000000..9aa04b3c3 --- /dev/null +++ b/build/docs/postAnalyticsQueuesObservationsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: QueueObservationQuery = new QueueObservationQuery(...) // query + +// Query for queue observations +PostAnalyticsQueuesObservationsQueryRequest.postAnalyticsQueuesObservationsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsQueuesObservationsQueryRequest.postAnalyticsQueuesObservationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsReportingExports-example.txt b/build/docs/postAnalyticsReportingExports-example.txt new file mode 100644 index 000000000..ad2d66965 --- /dev/null +++ b/build/docs/postAnalyticsReportingExports-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ReportingExportJobRequest = new ReportingExportJobRequest(...) // ReportingExportJobRequest + +// Generate a view export request +PostAnalyticsReportingExportsRequest.postAnalyticsReportingExports(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsReportingExportsRequest.postAnalyticsReportingExports was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsReportingScheduleRunreport-example.txt b/build/docs/postAnalyticsReportingScheduleRunreport-example.txt new file mode 100644 index 000000000..d1be8ed80 --- /dev/null +++ b/build/docs/postAnalyticsReportingScheduleRunreport-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID + +// Place a scheduled report immediately into the reporting queue +PostAnalyticsReportingScheduleRunreportRequest.postAnalyticsReportingScheduleRunreport(scheduleId: scheduleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsReportingScheduleRunreportRequest.postAnalyticsReportingScheduleRunreport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsReportingSchedules-example.txt b/build/docs/postAnalyticsReportingSchedules-example.txt new file mode 100644 index 000000000..81a6bab22 --- /dev/null +++ b/build/docs/postAnalyticsReportingSchedules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ReportSchedule = new ReportSchedule(...) // ReportSchedule + +// Create a scheduled report job +PostAnalyticsReportingSchedulesRequest.postAnalyticsReportingSchedules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsReportingSchedulesRequest.postAnalyticsReportingSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsSurveysAggregatesQuery-example.txt b/build/docs/postAnalyticsSurveysAggregatesQuery-example.txt new file mode 100644 index 000000000..9602e632d --- /dev/null +++ b/build/docs/postAnalyticsSurveysAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SurveyAggregationQuery = new SurveyAggregationQuery(...) // query + +// Query for survey aggregates +PostAnalyticsSurveysAggregatesQueryRequest.postAnalyticsSurveysAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsSurveysAggregatesQueryRequest.postAnalyticsSurveysAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsTranscriptsAggregatesQuery-example.txt b/build/docs/postAnalyticsTranscriptsAggregatesQuery-example.txt new file mode 100644 index 000000000..f5470006b --- /dev/null +++ b/build/docs/postAnalyticsTranscriptsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TranscriptAggregationQuery = new TranscriptAggregationQuery(...) // query + +// Query for transcript aggregates +PostAnalyticsTranscriptsAggregatesQueryRequest.postAnalyticsTranscriptsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsTranscriptsAggregatesQueryRequest.postAnalyticsTranscriptsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsUsersAggregatesQuery-example.txt b/build/docs/postAnalyticsUsersAggregatesQuery-example.txt new file mode 100644 index 000000000..8373f426c --- /dev/null +++ b/build/docs/postAnalyticsUsersAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserAggregationQuery = new UserAggregationQuery(...) // query + +// Query for user aggregates +PostAnalyticsUsersAggregatesQueryRequest.postAnalyticsUsersAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsUsersAggregatesQueryRequest.postAnalyticsUsersAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsUsersDetailsJobs-example.txt b/build/docs/postAnalyticsUsersDetailsJobs-example.txt new file mode 100644 index 000000000..75a8b0265 --- /dev/null +++ b/build/docs/postAnalyticsUsersDetailsJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AsyncUserDetailsQuery = new AsyncUserDetailsQuery(...) // query + +// Query for user details asynchronously +PostAnalyticsUsersDetailsJobsRequest.postAnalyticsUsersDetailsJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsUsersDetailsJobsRequest.postAnalyticsUsersDetailsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsUsersDetailsQuery-example.txt b/build/docs/postAnalyticsUsersDetailsQuery-example.txt new file mode 100644 index 000000000..c5451cd5d --- /dev/null +++ b/build/docs/postAnalyticsUsersDetailsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserDetailsQuery = new UserDetailsQuery(...) // query + +// Query for user details +PostAnalyticsUsersDetailsQueryRequest.postAnalyticsUsersDetailsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsUsersDetailsQueryRequest.postAnalyticsUsersDetailsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAnalyticsUsersObservationsQuery-example.txt b/build/docs/postAnalyticsUsersObservationsQuery-example.txt new file mode 100644 index 000000000..dc4717a9c --- /dev/null +++ b/build/docs/postAnalyticsUsersObservationsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserObservationQuery = new UserObservationQuery(...) // query + +// Query for user observations +PostAnalyticsUsersObservationsQueryRequest.postAnalyticsUsersObservationsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAnalyticsUsersObservationsQueryRequest.postAnalyticsUsersObservationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectDependencytrackingBuild-example.txt b/build/docs/postArchitectDependencytrackingBuild-example.txt new file mode 100644 index 000000000..3d9012757 --- /dev/null +++ b/build/docs/postArchitectDependencytrackingBuild-example.txt @@ -0,0 +1,14 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Rebuild Dependency Tracking data for an organization +PostArchitectDependencytrackingBuildRequest.postArchitectDependencytrackingBuild() { (error) in + if let error = error { + dump(error) + } else { + print("PostArchitectDependencytrackingBuildRequest.postArchitectDependencytrackingBuild was successful") + } +} \ No newline at end of file diff --git a/build/docs/postArchitectEmergencygroups-example.txt b/build/docs/postArchitectEmergencygroups-example.txt new file mode 100644 index 000000000..5ca4cbf7e --- /dev/null +++ b/build/docs/postArchitectEmergencygroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EmergencyGroup = new EmergencyGroup(...) // + +// Creates a new emergency group +PostArchitectEmergencygroupsRequest.postArchitectEmergencygroups(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectEmergencygroupsRequest.postArchitectEmergencygroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectIvrs-example.txt b/build/docs/postArchitectIvrs-example.txt new file mode 100644 index 000000000..a9d09e767 --- /dev/null +++ b/build/docs/postArchitectIvrs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: IVR = new IVR(...) // + +// Create IVR config. +PostArchitectIvrsRequest.postArchitectIvrs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectIvrsRequest.postArchitectIvrs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectPromptHistory-example.txt b/build/docs/postArchitectPromptHistory-example.txt new file mode 100644 index 000000000..3874290f7 --- /dev/null +++ b/build/docs/postArchitectPromptHistory-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID + +// Generate prompt history +PostArchitectPromptHistoryRequest.postArchitectPromptHistory(promptId: promptId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectPromptHistoryRequest.postArchitectPromptHistory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectPromptResources-example.txt b/build/docs/postArchitectPromptResources-example.txt new file mode 100644 index 000000000..854fdb2bb --- /dev/null +++ b/build/docs/postArchitectPromptResources-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let body: PromptAssetCreate = new PromptAssetCreate(...) // + +// Create a new user prompt resource +PostArchitectPromptResourcesRequest.postArchitectPromptResources(promptId: promptId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectPromptResourcesRequest.postArchitectPromptResources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectPrompts-example.txt b/build/docs/postArchitectPrompts-example.txt new file mode 100644 index 000000000..1db6ba2d5 --- /dev/null +++ b/build/docs/postArchitectPrompts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Prompt = new Prompt(...) // + +// Create a new user prompt +PostArchitectPromptsRequest.postArchitectPrompts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectPromptsRequest.postArchitectPrompts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectSchedulegroups-example.txt b/build/docs/postArchitectSchedulegroups-example.txt new file mode 100644 index 000000000..e90ce11d5 --- /dev/null +++ b/build/docs/postArchitectSchedulegroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ScheduleGroup = new ScheduleGroup(...) // + +// Creates a new schedule group +PostArchitectSchedulegroupsRequest.postArchitectSchedulegroups(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectSchedulegroupsRequest.postArchitectSchedulegroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectSchedules-example.txt b/build/docs/postArchitectSchedules-example.txt new file mode 100644 index 000000000..3cdc2f900 --- /dev/null +++ b/build/docs/postArchitectSchedules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Schedule = new Schedule(...) // + +// Create a new schedule. +PostArchitectSchedulesRequest.postArchitectSchedules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectSchedulesRequest.postArchitectSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectSystempromptHistory-example.txt b/build/docs/postArchitectSystempromptHistory-example.txt new file mode 100644 index 000000000..60166fe90 --- /dev/null +++ b/build/docs/postArchitectSystempromptHistory-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // promptId + +// Generate system prompt history +PostArchitectSystempromptHistoryRequest.postArchitectSystempromptHistory(promptId: promptId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectSystempromptHistoryRequest.postArchitectSystempromptHistory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postArchitectSystempromptResources-example.txt b/build/docs/postArchitectSystempromptResources-example.txt new file mode 100644 index 000000000..58bd1778c --- /dev/null +++ b/build/docs/postArchitectSystempromptResources-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let body: SystemPromptAsset = new SystemPromptAsset(...) // + +// Create system prompt resource override. +PostArchitectSystempromptResourcesRequest.postArchitectSystempromptResources(promptId: promptId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostArchitectSystempromptResourcesRequest.postArchitectSystempromptResources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuditsQuery-example.txt b/build/docs/postAuditsQuery-example.txt new file mode 100644 index 000000000..f4cb417e7 --- /dev/null +++ b/build/docs/postAuditsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AuditQueryRequest = new AuditQueryRequest(...) // query + +// Create audit query execution +PostAuditsQueryRequest.postAuditsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuditsQueryRequest.postAuditsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuditsQueryRealtime-example.txt b/build/docs/postAuditsQueryRealtime-example.txt new file mode 100644 index 000000000..6d1d0126d --- /dev/null +++ b/build/docs/postAuditsQueryRealtime-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AuditRealtimeQueryRequest = new AuditRealtimeQueryRequest(...) // query +let expand: [String] = [""] // Which fields, if any, to expand + +// This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. +PostAuditsQueryRealtimeRequest.postAuditsQueryRealtime(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuditsQueryRealtimeRequest.postAuditsQueryRealtime was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationDivisionObject-example.txt b/build/docs/postAuthorizationDivisionObject-example.txt new file mode 100644 index 000000000..e34b20aee --- /dev/null +++ b/build/docs/postAuthorizationDivisionObject-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let objectType: PostAuthorizationDivisionObjectRequest.ObjectType_postAuthorizationDivisionObject = PostAuthorizationDivisionObjectRequest.ObjectType_postAuthorizationDivisionObject.enummember // The type of the objects. Must be one of the valid object types +let body: [String] = [""] // Object Id List + +// Assign a list of objects to a division +PostAuthorizationDivisionObjectRequest.postAuthorizationDivisionObject(divisionId: divisionId, objectType: objectType, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationDivisionObjectRequest.postAuthorizationDivisionObject was successful") + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationDivisionRestore-example.txt b/build/docs/postAuthorizationDivisionRestore-example.txt new file mode 100644 index 000000000..4d1664a42 --- /dev/null +++ b/build/docs/postAuthorizationDivisionRestore-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let body: AuthzDivision = new AuthzDivision(...) // Recreated division data + +// Recreate a previously deleted division. +PostAuthorizationDivisionRestoreRequest.postAuthorizationDivisionRestore(divisionId: divisionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuthorizationDivisionRestoreRequest.postAuthorizationDivisionRestore was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationDivisions-example.txt b/build/docs/postAuthorizationDivisions-example.txt new file mode 100644 index 000000000..fcd6fba78 --- /dev/null +++ b/build/docs/postAuthorizationDivisions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AuthzDivision = new AuthzDivision(...) // Division + +// Create a division. +PostAuthorizationDivisionsRequest.postAuthorizationDivisions(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuthorizationDivisionsRequest.postAuthorizationDivisions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationRole-example.txt b/build/docs/postAuthorizationRole-example.txt new file mode 100644 index 000000000..48f01ff90 --- /dev/null +++ b/build/docs/postAuthorizationRole-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let body: SubjectDivisions = new SubjectDivisions(...) // Subjects and Divisions +let subjectType: String = "" // what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) + +// Bulk-grant subjects and divisions with an organization role. +PostAuthorizationRoleRequest.postAuthorizationRole(roleId: roleId, body: body, subjectType: subjectType) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationRoleRequest.postAuthorizationRole was successful") + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationRoleComparedefaultRightRoleId-example.txt b/build/docs/postAuthorizationRoleComparedefaultRightRoleId-example.txt new file mode 100644 index 000000000..5a2d14876 --- /dev/null +++ b/build/docs/postAuthorizationRoleComparedefaultRightRoleId-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let leftRoleId: String = "" // Left Role ID +let rightRoleId: String = "" // Right Role id +let body: DomainOrganizationRole = new DomainOrganizationRole(...) // Organization role + +// Get an unsaved org role to default role comparison +PostAuthorizationRoleComparedefaultRightRoleIdRequest.postAuthorizationRoleComparedefaultRightRoleId(leftRoleId: leftRoleId, rightRoleId: rightRoleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuthorizationRoleComparedefaultRightRoleIdRequest.postAuthorizationRoleComparedefaultRightRoleId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationRoles-example.txt b/build/docs/postAuthorizationRoles-example.txt new file mode 100644 index 000000000..1d2c7131f --- /dev/null +++ b/build/docs/postAuthorizationRoles-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DomainOrganizationRoleCreate = new DomainOrganizationRoleCreate(...) // Organization role + +// Create an organization role. +PostAuthorizationRolesRequest.postAuthorizationRoles(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuthorizationRolesRequest.postAuthorizationRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationRolesDefault-example.txt b/build/docs/postAuthorizationRolesDefault-example.txt new file mode 100644 index 000000000..89de5e333 --- /dev/null +++ b/build/docs/postAuthorizationRolesDefault-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let force: Bool = true // Restore default roles + +// Restores all default roles +PostAuthorizationRolesDefaultRequest.postAuthorizationRolesDefault(force: force) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostAuthorizationRolesDefaultRequest.postAuthorizationRolesDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationSubjectBulkadd-example.txt b/build/docs/postAuthorizationSubjectBulkadd-example.txt new file mode 100644 index 000000000..700944b7f --- /dev/null +++ b/build/docs/postAuthorizationSubjectBulkadd-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs +let subjectType: String = "" // what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) + +// Bulk-grant roles and divisions to a subject. +PostAuthorizationSubjectBulkaddRequest.postAuthorizationSubjectBulkadd(subjectId: subjectId, body: body, subjectType: subjectType) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationSubjectBulkaddRequest.postAuthorizationSubjectBulkadd was successful") + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationSubjectBulkremove-example.txt b/build/docs/postAuthorizationSubjectBulkremove-example.txt new file mode 100644 index 000000000..14616e86d --- /dev/null +++ b/build/docs/postAuthorizationSubjectBulkremove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs + +// Bulk-remove grants from a subject. +PostAuthorizationSubjectBulkremoveRequest.postAuthorizationSubjectBulkremove(subjectId: subjectId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationSubjectBulkremoveRequest.postAuthorizationSubjectBulkremove was successful") + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationSubjectBulkreplace-example.txt b/build/docs/postAuthorizationSubjectBulkreplace-example.txt new file mode 100644 index 000000000..ddaa0c666 --- /dev/null +++ b/build/docs/postAuthorizationSubjectBulkreplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let body: RoleDivisionGrants = new RoleDivisionGrants(...) // Pairs of role and division IDs +let subjectType: String = "" // what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) + +// Replace subject's roles and divisions with the exact list supplied in the request. +PostAuthorizationSubjectBulkreplaceRequest.postAuthorizationSubjectBulkreplace(subjectId: subjectId, body: body, subjectType: subjectType) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationSubjectBulkreplaceRequest.postAuthorizationSubjectBulkreplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postAuthorizationSubjectDivisionRole-example.txt b/build/docs/postAuthorizationSubjectDivisionRole-example.txt new file mode 100644 index 000000000..1978e2f9f --- /dev/null +++ b/build/docs/postAuthorizationSubjectDivisionRole-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // Subject ID (user or group) +let divisionId: String = "" // the id of the division to which to make the grant +let roleId: String = "" // the id of the role to grant +let subjectType: String = "" // 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) + +// Make a grant of a role in a division +PostAuthorizationSubjectDivisionRoleRequest.postAuthorizationSubjectDivisionRole(subjectId: subjectId, divisionId: divisionId, roleId: roleId, subjectType: subjectType) { (error) in + if let error = error { + dump(error) + } else { + print("PostAuthorizationSubjectDivisionRoleRequest.postAuthorizationSubjectDivisionRole was successful") + } +} \ No newline at end of file diff --git a/build/docs/postCarrierservicesIntegrationsEmergencylocationsMe-example.txt b/build/docs/postCarrierservicesIntegrationsEmergencylocationsMe-example.txt new file mode 100644 index 000000000..0ee5c0427 --- /dev/null +++ b/build/docs/postCarrierservicesIntegrationsEmergencylocationsMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EmergencyLocation = new EmergencyLocation(...) // + +// Set current location for the logged in user +PostCarrierservicesIntegrationsEmergencylocationsMeRequest.postCarrierservicesIntegrationsEmergencylocationsMe(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCarrierservicesIntegrationsEmergencylocationsMeRequest.postCarrierservicesIntegrationsEmergencylocationsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCertificateDetails-example.txt b/build/docs/postCertificateDetails-example.txt new file mode 100644 index 000000000..9da6373fb --- /dev/null +++ b/build/docs/postCertificateDetails-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Certificate = new Certificate(...) // Certificate + +// Returns the information about an X509 PEM encoded certificate or certificate chain. +PostCertificateDetailsRequest.postCertificateDetails(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCertificateDetailsRequest.postCertificateDetails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCoachingAppointmentAnnotations-example.txt b/build/docs/postCoachingAppointmentAnnotations-example.txt new file mode 100644 index 000000000..bf867d9a4 --- /dev/null +++ b/build/docs/postCoachingAppointmentAnnotations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let body: CoachingAnnotationCreateRequest = new CoachingAnnotationCreateRequest(...) // The annotation to add + +// Create a new annotation. +PostCoachingAppointmentAnnotationsRequest.postCoachingAppointmentAnnotations(appointmentId: appointmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCoachingAppointmentAnnotationsRequest.postCoachingAppointmentAnnotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCoachingAppointmentConversations-example.txt b/build/docs/postCoachingAppointmentConversations-example.txt new file mode 100644 index 000000000..7935b2b79 --- /dev/null +++ b/build/docs/postCoachingAppointmentConversations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let appointmentId: String = "" // The ID of the coaching appointment. +let body: AddConversationRequest = new AddConversationRequest(...) // body + +// Add a conversation to an appointment +PostCoachingAppointmentConversationsRequest.postCoachingAppointmentConversations(appointmentId: appointmentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCoachingAppointmentConversationsRequest.postCoachingAppointmentConversations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCoachingAppointments-example.txt b/build/docs/postCoachingAppointments-example.txt new file mode 100644 index 000000000..f965f7705 --- /dev/null +++ b/build/docs/postCoachingAppointments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateCoachingAppointmentRequest = new CreateCoachingAppointmentRequest(...) // The appointment to add + +// Create a new appointment +PostCoachingAppointmentsRequest.postCoachingAppointments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCoachingAppointmentsRequest.postCoachingAppointments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCoachingAppointmentsAggregatesQuery-example.txt b/build/docs/postCoachingAppointmentsAggregatesQuery-example.txt new file mode 100644 index 000000000..b5a018924 --- /dev/null +++ b/build/docs/postCoachingAppointmentsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CoachingAppointmentAggregateRequest = new CoachingAppointmentAggregateRequest(...) // Aggregate Request + +// Retrieve aggregated appointment data +PostCoachingAppointmentsAggregatesQueryRequest.postCoachingAppointmentsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCoachingAppointmentsAggregatesQueryRequest.postCoachingAppointmentsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postCoachingScheduleslotsQuery-example.txt b/build/docs/postCoachingScheduleslotsQuery-example.txt new file mode 100644 index 000000000..ce1edc183 --- /dev/null +++ b/build/docs/postCoachingScheduleslotsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CoachingSlotsRequest = new CoachingSlotsRequest(...) // The slot search request + +// Get list of possible slots where a coaching appointment can be scheduled. +PostCoachingScheduleslotsQueryRequest.postCoachingScheduleslotsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostCoachingScheduleslotsQueryRequest.postCoachingScheduleslotsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementAuditquery-example.txt b/build/docs/postContentmanagementAuditquery-example.txt new file mode 100644 index 000000000..f164be1ad --- /dev/null +++ b/build/docs/postContentmanagementAuditquery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ContentQueryRequest = new ContentQueryRequest(...) // Allows for a filtered query returning facet information + +// Query audits +PostContentmanagementAuditqueryRequest.postContentmanagementAuditquery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementAuditqueryRequest.postContentmanagementAuditquery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementDocument-example.txt b/build/docs/postContentmanagementDocument-example.txt new file mode 100644 index 000000000..0cf9089f9 --- /dev/null +++ b/build/docs/postContentmanagementDocument-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let body: DocumentUpdate = new DocumentUpdate(...) // Document +let expand: PostContentmanagementDocumentRequest.Expand_postContentmanagementDocument = PostContentmanagementDocumentRequest.Expand_postContentmanagementDocument.enummember // Expand some document fields +let _override: Bool = true // Override any lock on the document + +// Update a document. +PostContentmanagementDocumentRequest.postContentmanagementDocument(documentId: documentId, body: body, expand: expand, _override: _override) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementDocumentRequest.postContentmanagementDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementDocumentContent-example.txt b/build/docs/postContentmanagementDocumentContent-example.txt new file mode 100644 index 000000000..56ae6f97d --- /dev/null +++ b/build/docs/postContentmanagementDocumentContent-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let body: ReplaceRequest = new ReplaceRequest(...) // Replace Request +let _override: Bool = true // Override any lock on the document + +// Replace the contents of a document. +PostContentmanagementDocumentContentRequest.postContentmanagementDocumentContent(documentId: documentId, body: body, _override: _override) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementDocumentContentRequest.postContentmanagementDocumentContent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementDocuments-example.txt b/build/docs/postContentmanagementDocuments-example.txt new file mode 100644 index 000000000..a6bbdf62f --- /dev/null +++ b/build/docs/postContentmanagementDocuments-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DocumentUpload = new DocumentUpload(...) // Document +let copySource: String = "" // Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. +let moveSource: String = "" // Move a document to a new workspace. Provide a document ID as the move source. +let _override: Bool = true // Override any lock on the source document + +// Add a document. +PostContentmanagementDocumentsRequest.postContentmanagementDocuments(body: body, copySource: copySource, moveSource: moveSource, _override: _override) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementDocumentsRequest.postContentmanagementDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementQuery-example.txt b/build/docs/postContentmanagementQuery-example.txt new file mode 100644 index 000000000..b3c062af4 --- /dev/null +++ b/build/docs/postContentmanagementQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: QueryRequest = new QueryRequest(...) // Allows for a filtered query returning facet information +let expand: PostContentmanagementQueryRequest.Expand_postContentmanagementQuery = PostContentmanagementQueryRequest.Expand_postContentmanagementQuery.enummember // Expand some document fields + +// Query content +PostContentmanagementQueryRequest.postContentmanagementQuery(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementQueryRequest.postContentmanagementQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementShares-example.txt b/build/docs/postContentmanagementShares-example.txt new file mode 100644 index 000000000..8df4879c0 --- /dev/null +++ b/build/docs/postContentmanagementShares-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateShareRequest = new CreateShareRequest(...) // CreateShareRequest - entity id and type and a single member or list of members are required + +// Creates a new share or updates an existing share if the entity has already been shared +PostContentmanagementSharesRequest.postContentmanagementShares(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementSharesRequest.postContentmanagementShares was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementWorkspaceTagvalues-example.txt b/build/docs/postContentmanagementWorkspaceTagvalues-example.txt new file mode 100644 index 000000000..00bf22d40 --- /dev/null +++ b/build/docs/postContentmanagementWorkspaceTagvalues-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let body: TagValue = new TagValue(...) // tag + +// Create a workspace tag +PostContentmanagementWorkspaceTagvaluesRequest.postContentmanagementWorkspaceTagvalues(workspaceId: workspaceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementWorkspaceTagvaluesRequest.postContentmanagementWorkspaceTagvalues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementWorkspaceTagvaluesQuery-example.txt b/build/docs/postContentmanagementWorkspaceTagvaluesQuery-example.txt new file mode 100644 index 000000000..6b37c790f --- /dev/null +++ b/build/docs/postContentmanagementWorkspaceTagvaluesQuery-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let body: TagQueryRequest = new TagQueryRequest(...) // query +let expand: [String] = [""] // Which fields, if any, to expand. + +// Perform a prefix query on tags in the workspace +PostContentmanagementWorkspaceTagvaluesQueryRequest.postContentmanagementWorkspaceTagvaluesQuery(workspaceId: workspaceId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementWorkspaceTagvaluesQueryRequest.postContentmanagementWorkspaceTagvaluesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postContentmanagementWorkspaces-example.txt b/build/docs/postContentmanagementWorkspaces-example.txt new file mode 100644 index 000000000..1c3fe2fed --- /dev/null +++ b/build/docs/postContentmanagementWorkspaces-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WorkspaceCreate = new WorkspaceCreate(...) // Workspace + +// Create a group workspace +PostContentmanagementWorkspacesRequest.postContentmanagementWorkspaces(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostContentmanagementWorkspacesRequest.postContentmanagementWorkspaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationAssign-example.txt b/build/docs/postConversationAssign-example.txt new file mode 100644 index 000000000..17b610dbe --- /dev/null +++ b/build/docs/postConversationAssign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let body: ConversationUser = new ConversationUser(...) // Targeted user + +// Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages. +PostConversationAssignRequest.postConversationAssign(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationAssignRequest.postConversationAssign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationCobrowse-example.txt b/build/docs/postConversationCobrowse-example.txt new file mode 100644 index 000000000..ecd029414 --- /dev/null +++ b/build/docs/postConversationCobrowse-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID + +// Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission. +PostConversationCobrowseRequest.postConversationCobrowse(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationCobrowseRequest.postConversationCobrowse was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationDisconnect-example.txt b/build/docs/postConversationDisconnect-example.txt new file mode 100644 index 000000000..c04a5b68d --- /dev/null +++ b/build/docs/postConversationDisconnect-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID + +// 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. +PostConversationDisconnectRequest.postConversationDisconnect(conversationId: conversationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationDisconnectRequest.postConversationDisconnect was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationParticipantCallbacks-example.txt b/build/docs/postConversationParticipantCallbacks-example.txt new file mode 100644 index 000000000..ba7ed21d5 --- /dev/null +++ b/build/docs/postConversationParticipantCallbacks-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: CreateCallbackOnConversationCommand = new CreateCallbackOnConversationCommand(...) // + +// Create a new callback for the specified participant on the conversation. +PostConversationParticipantCallbacksRequest.postConversationParticipantCallbacks(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationParticipantCallbacksRequest.postConversationParticipantCallbacks was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationParticipantDigits-example.txt b/build/docs/postConversationParticipantDigits-example.txt new file mode 100644 index 000000000..edd525891 --- /dev/null +++ b/build/docs/postConversationParticipantDigits-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: Digits = new Digits(...) // Digits + +// Sends DTMF to the participant +PostConversationParticipantDigitsRequest.postConversationParticipantDigits(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationParticipantDigitsRequest.postConversationParticipantDigits was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationParticipantReplace-example.txt b/build/docs/postConversationParticipantReplace-example.txt new file mode 100644 index 000000000..56ca7e214 --- /dev/null +++ b/build/docs/postConversationParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationParticipantReplaceRequest.postConversationParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationParticipantReplaceRequest.postConversationParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationParticipantSecureivrsessions-example.txt b/build/docs/postConversationParticipantSecureivrsessions-example.txt new file mode 100644 index 000000000..5ae313e0b --- /dev/null +++ b/build/docs/postConversationParticipantSecureivrsessions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID +let body: CreateSecureSession = new CreateSecureSession(...) // + +// Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. +PostConversationParticipantSecureivrsessionsRequest.postConversationParticipantSecureivrsessions(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationParticipantSecureivrsessionsRequest.postConversationParticipantSecureivrsessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationRecordingAnnotations-example.txt b/build/docs/postConversationRecordingAnnotations-example.txt new file mode 100644 index 000000000..d01385a6c --- /dev/null +++ b/build/docs/postConversationRecordingAnnotations-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let body: Annotation = new Annotation(...) // annotation + +// Create annotation +PostConversationRecordingAnnotationsRequest.postConversationRecordingAnnotations(conversationId: conversationId, recordingId: recordingId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationRecordingAnnotationsRequest.postConversationRecordingAnnotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCall-example.txt b/build/docs/postConversationsCall-example.txt new file mode 100644 index 000000000..f0222de31 --- /dev/null +++ b/build/docs/postConversationsCall-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: CallCommand = new CallCommand(...) // Conversation + +// Place a new call as part of a callback conversation. +PostConversationsCallRequest.postConversationsCall(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallRequest.postConversationsCall was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipantCoach-example.txt b/build/docs/postConversationsCallParticipantCoach-example.txt new file mode 100644 index 000000000..badd81608 --- /dev/null +++ b/build/docs/postConversationsCallParticipantCoach-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. +PostConversationsCallParticipantCoachRequest.postConversationsCallParticipantCoach(conversationId: conversationId, participantId: participantId) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallParticipantCoachRequest.postConversationsCallParticipantCoach was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsCallParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..dbe1826bc --- /dev/null +++ b/build/docs/postConversationsCallParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsCallParticipantCommunicationWrapupRequest.postConversationsCallParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallParticipantCommunicationWrapupRequest.postConversationsCallParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipantConsult-example.txt b/build/docs/postConversationsCallParticipantConsult-example.txt new file mode 100644 index 000000000..2a1496ac3 --- /dev/null +++ b/build/docs/postConversationsCallParticipantConsult-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: ConsultTransfer = new ConsultTransfer(...) // Destination address & initial speak to + +// Initiate and update consult transfer +PostConversationsCallParticipantConsultRequest.postConversationsCallParticipantConsult(conversationId: conversationId, participantId: participantId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallParticipantConsultRequest.postConversationsCallParticipantConsult was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipantMonitor-example.txt b/build/docs/postConversationsCallParticipantMonitor-example.txt new file mode 100644 index 000000000..ba0edd771 --- /dev/null +++ b/build/docs/postConversationsCallParticipantMonitor-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId + +// Listen in on the conversation from the point of view of a given participant. +PostConversationsCallParticipantMonitorRequest.postConversationsCallParticipantMonitor(conversationId: conversationId, participantId: participantId) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallParticipantMonitorRequest.postConversationsCallParticipantMonitor was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipantReplace-example.txt b/build/docs/postConversationsCallParticipantReplace-example.txt new file mode 100644 index 000000000..819e83673 --- /dev/null +++ b/build/docs/postConversationsCallParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationsCallParticipantReplaceRequest.postConversationsCallParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallParticipantReplaceRequest.postConversationsCallParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallParticipants-example.txt b/build/docs/postConversationsCallParticipants-example.txt new file mode 100644 index 000000000..b41732346 --- /dev/null +++ b/build/docs/postConversationsCallParticipants-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Conversation = new Conversation(...) // Conversation + +// Add participants to a conversation +PostConversationsCallParticipantsRequest.postConversationsCallParticipants(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallParticipantsRequest.postConversationsCallParticipants was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallbackParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsCallbackParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..0969f09db --- /dev/null +++ b/build/docs/postConversationsCallbackParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsCallbackParticipantCommunicationWrapupRequest.postConversationsCallbackParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallbackParticipantCommunicationWrapupRequest.postConversationsCallbackParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallbackParticipantReplace-example.txt b/build/docs/postConversationsCallbackParticipantReplace-example.txt new file mode 100644 index 000000000..023c68dbf --- /dev/null +++ b/build/docs/postConversationsCallbackParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationsCallbackParticipantReplaceRequest.postConversationsCallbackParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallbackParticipantReplaceRequest.postConversationsCallbackParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallbacks-example.txt b/build/docs/postConversationsCallbacks-example.txt new file mode 100644 index 000000000..caaadcde1 --- /dev/null +++ b/build/docs/postConversationsCallbacks-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateCallbackCommand = new CreateCallbackCommand(...) // Callback + +// Create a Callback +PostConversationsCallbacksRequest.postConversationsCallbacks(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallbacksRequest.postConversationsCallbacks was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallbacksBulkDisconnect-example.txt b/build/docs/postConversationsCallbacksBulkDisconnect-example.txt new file mode 100644 index 000000000..a16f68079 --- /dev/null +++ b/build/docs/postConversationsCallbacksBulkDisconnect-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkCallbackDisconnectRequest = new BulkCallbackDisconnectRequest(...) // BulkCallbackDisconnectRequest + +// Disconnect multiple scheduled callbacks +PostConversationsCallbacksBulkDisconnectRequest.postConversationsCallbacksBulkDisconnect(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCallbacksBulkDisconnectRequest.postConversationsCallbacksBulkDisconnect was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCallbacksBulkUpdate-example.txt b/build/docs/postConversationsCallbacksBulkUpdate-example.txt new file mode 100644 index 000000000..772abe4df --- /dev/null +++ b/build/docs/postConversationsCallbacksBulkUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkCallbackPatchRequest = new BulkCallbackPatchRequest(...) // BulkCallbackPatchRequest + +// Update multiple scheduled callbacks +PostConversationsCallbacksBulkUpdateRequest.postConversationsCallbacksBulkUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallbacksBulkUpdateRequest.postConversationsCallbacksBulkUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCalls-example.txt b/build/docs/postConversationsCalls-example.txt new file mode 100644 index 000000000..4771af509 --- /dev/null +++ b/build/docs/postConversationsCalls-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateCallRequest = new CreateCallRequest(...) // Call request + +// Create a call conversation +PostConversationsCallsRequest.postConversationsCalls(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsCallsRequest.postConversationsCalls was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsChatCommunicationMessages-example.txt b/build/docs/postConversationsChatCommunicationMessages-example.txt new file mode 100644 index 000000000..f8f967f3b --- /dev/null +++ b/build/docs/postConversationsChatCommunicationMessages-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId +let body: CreateWebChatMessageRequest = new CreateWebChatMessageRequest(...) // Message + +// Send a message on behalf of a communication in a chat conversation. +PostConversationsChatCommunicationMessagesRequest.postConversationsChatCommunicationMessages(conversationId: conversationId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsChatCommunicationMessagesRequest.postConversationsChatCommunicationMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsChatCommunicationTyping-example.txt b/build/docs/postConversationsChatCommunicationTyping-example.txt new file mode 100644 index 000000000..59af4fe3b --- /dev/null +++ b/build/docs/postConversationsChatCommunicationTyping-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId + +// Send a typing-indicator on behalf of a communication in a chat conversation. +PostConversationsChatCommunicationTypingRequest.postConversationsChatCommunicationTyping(conversationId: conversationId, communicationId: communicationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsChatCommunicationTypingRequest.postConversationsChatCommunicationTyping was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsChatParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsChatParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..10f2dfbe3 --- /dev/null +++ b/build/docs/postConversationsChatParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsChatParticipantCommunicationWrapupRequest.postConversationsChatParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsChatParticipantCommunicationWrapupRequest.postConversationsChatParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsChatParticipantReplace-example.txt b/build/docs/postConversationsChatParticipantReplace-example.txt new file mode 100644 index 000000000..152bce6ae --- /dev/null +++ b/build/docs/postConversationsChatParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationsChatParticipantReplaceRequest.postConversationsChatParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsChatParticipantReplaceRequest.postConversationsChatParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsChats-example.txt b/build/docs/postConversationsChats-example.txt new file mode 100644 index 000000000..89347c750 --- /dev/null +++ b/build/docs/postConversationsChats-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateWebChatRequest = new CreateWebChatRequest(...) // Create web chat request + +// Create a web chat conversation +PostConversationsChatsRequest.postConversationsChats(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsChatsRequest.postConversationsChats was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..8eea0f089 --- /dev/null +++ b/build/docs/postConversationsCobrowsesessionParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsCobrowsesessionParticipantCommunicationWrapupRequest.postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCobrowsesessionParticipantCommunicationWrapupRequest.postConversationsCobrowsesessionParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsCobrowsesessionParticipantReplace-example.txt b/build/docs/postConversationsCobrowsesessionParticipantReplace-example.txt new file mode 100644 index 000000000..ff555532b --- /dev/null +++ b/build/docs/postConversationsCobrowsesessionParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // + +// Replace this participant with the specified user and/or address +PostConversationsCobrowsesessionParticipantReplaceRequest.postConversationsCobrowsesessionParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsCobrowsesessionParticipantReplaceRequest.postConversationsCobrowsesessionParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailInboundmessages-example.txt b/build/docs/postConversationsEmailInboundmessages-example.txt new file mode 100644 index 000000000..3af388379 --- /dev/null +++ b/build/docs/postConversationsEmailInboundmessages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: InboundMessageRequest = new InboundMessageRequest(...) // Send external email reply + +// 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. +PostConversationsEmailInboundmessagesRequest.postConversationsEmailInboundmessages(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsEmailInboundmessagesRequest.postConversationsEmailInboundmessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailMessages-example.txt b/build/docs/postConversationsEmailMessages-example.txt new file mode 100644 index 000000000..96ec635f2 --- /dev/null +++ b/build/docs/postConversationsEmailMessages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: EmailMessage = new EmailMessage(...) // Reply + +// Send an email reply +PostConversationsEmailMessagesRequest.postConversationsEmailMessages(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsEmailMessagesRequest.postConversationsEmailMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailMessagesDraftAttachmentsCopy-example.txt b/build/docs/postConversationsEmailMessagesDraftAttachmentsCopy-example.txt new file mode 100644 index 000000000..109d1b810 --- /dev/null +++ b/build/docs/postConversationsEmailMessagesDraftAttachmentsCopy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: CopyAttachmentsRequest = new CopyAttachmentsRequest(...) // Copy Attachment Request + +// Copy attachments from an email message to the current draft. +PostConversationsEmailMessagesDraftAttachmentsCopyRequest.postConversationsEmailMessagesDraftAttachmentsCopy(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsEmailMessagesDraftAttachmentsCopyRequest.postConversationsEmailMessagesDraftAttachmentsCopy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsEmailParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..84c1b071c --- /dev/null +++ b/build/docs/postConversationsEmailParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsEmailParticipantCommunicationWrapupRequest.postConversationsEmailParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsEmailParticipantCommunicationWrapupRequest.postConversationsEmailParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailParticipantReplace-example.txt b/build/docs/postConversationsEmailParticipantReplace-example.txt new file mode 100644 index 000000000..fbdc41b3d --- /dev/null +++ b/build/docs/postConversationsEmailParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationsEmailParticipantReplaceRequest.postConversationsEmailParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsEmailParticipantReplaceRequest.postConversationsEmailParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmails-example.txt b/build/docs/postConversationsEmails-example.txt new file mode 100644 index 000000000..c87b55dc2 --- /dev/null +++ b/build/docs/postConversationsEmails-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateEmailRequest = new CreateEmailRequest(...) // Create email request + +// Create an email conversation +PostConversationsEmailsRequest.postConversationsEmails(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsEmailsRequest.postConversationsEmails was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsEmailsAgentless-example.txt b/build/docs/postConversationsEmailsAgentless-example.txt new file mode 100644 index 000000000..0176016c6 --- /dev/null +++ b/build/docs/postConversationsEmailsAgentless-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AgentlessEmailSendRequestDto = new AgentlessEmailSendRequestDto(...) // Create agentless email request + +// Create an email conversation, per API +PostConversationsEmailsAgentlessRequest.postConversationsEmailsAgentless(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsEmailsAgentlessRequest.postConversationsEmailsAgentless was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsFaxes-example.txt b/build/docs/postConversationsFaxes-example.txt new file mode 100644 index 000000000..962268117 --- /dev/null +++ b/build/docs/postConversationsFaxes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FaxSendRequest = new FaxSendRequest(...) // Fax + +// Create Fax Conversation +PostConversationsFaxesRequest.postConversationsFaxes(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsFaxesRequest.postConversationsFaxes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsKeyconfigurations-example.txt b/build/docs/postConversationsKeyconfigurations-example.txt new file mode 100644 index 000000000..74949a331 --- /dev/null +++ b/build/docs/postConversationsKeyconfigurations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption Configuration + +// Setup configurations for encryption key creation +PostConversationsKeyconfigurationsRequest.postConversationsKeyconfigurations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsKeyconfigurationsRequest.postConversationsKeyconfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsKeyconfigurationsValidate-example.txt b/build/docs/postConversationsKeyconfigurationsValidate-example.txt new file mode 100644 index 000000000..320798ace --- /dev/null +++ b/build/docs/postConversationsKeyconfigurationsValidate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption Configuration + +// Validate encryption key configurations without saving it +PostConversationsKeyconfigurationsValidateRequest.postConversationsKeyconfigurationsValidate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsKeyconfigurationsValidateRequest.postConversationsKeyconfigurationsValidate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageCommunicationMessages-example.txt b/build/docs/postConversationsMessageCommunicationMessages-example.txt new file mode 100644 index 000000000..9c40a109b --- /dev/null +++ b/build/docs/postConversationsMessageCommunicationMessages-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId +let body: AdditionalMessage = new AdditionalMessage(...) // Message +let useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers) + +// Send message +PostConversationsMessageCommunicationMessagesRequest.postConversationsMessageCommunicationMessages(conversationId: conversationId, communicationId: communicationId, body: body, useNormalizedMessage: useNormalizedMessage) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageCommunicationMessagesRequest.postConversationsMessageCommunicationMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageCommunicationMessagesMedia-example.txt b/build/docs/postConversationsMessageCommunicationMessagesMedia-example.txt new file mode 100644 index 000000000..665c61e4e --- /dev/null +++ b/build/docs/postConversationsMessageCommunicationMessagesMedia-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId + +// Create media +PostConversationsMessageCommunicationMessagesMediaRequest.postConversationsMessageCommunicationMessagesMedia(conversationId: conversationId, communicationId: communicationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageCommunicationMessagesMediaRequest.postConversationsMessageCommunicationMessagesMedia was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageCommunicationTyping-example.txt b/build/docs/postConversationsMessageCommunicationTyping-example.txt new file mode 100644 index 000000000..3e0f9d395 --- /dev/null +++ b/build/docs/postConversationsMessageCommunicationTyping-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let communicationId: String = "" // communicationId +let body: MessageTypingEventRequest = new MessageTypingEventRequest(...) // MessageTypingEvent + +// Send message typing event +PostConversationsMessageCommunicationTypingRequest.postConversationsMessageCommunicationTyping(conversationId: conversationId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsMessageCommunicationTypingRequest.postConversationsMessageCommunicationTyping was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageInboundOpenEvent-example.txt b/build/docs/postConversationsMessageInboundOpenEvent-example.txt new file mode 100644 index 000000000..691e3985a --- /dev/null +++ b/build/docs/postConversationsMessageInboundOpenEvent-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // integrationId +let body: OpenInboundNormalizedEvent = new OpenInboundNormalizedEvent(...) // NormalizedMessage + +// Send an inbound Open Event Message +PostConversationsMessageInboundOpenEventRequest.postConversationsMessageInboundOpenEvent(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageInboundOpenEventRequest.postConversationsMessageInboundOpenEvent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageInboundOpenMessage-example.txt b/build/docs/postConversationsMessageInboundOpenMessage-example.txt new file mode 100644 index 000000000..b0c6b851c --- /dev/null +++ b/build/docs/postConversationsMessageInboundOpenMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // integrationId +let body: OpenInboundNormalizedMessage = new OpenInboundNormalizedMessage(...) // NormalizedMessage + +// Send inbound Open Message +PostConversationsMessageInboundOpenMessageRequest.postConversationsMessageInboundOpenMessage(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageInboundOpenMessageRequest.postConversationsMessageInboundOpenMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageInboundOpenReceipt-example.txt b/build/docs/postConversationsMessageInboundOpenReceipt-example.txt new file mode 100644 index 000000000..ae96fa5f4 --- /dev/null +++ b/build/docs/postConversationsMessageInboundOpenReceipt-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // integrationId +let body: OpenInboundNormalizedReceipt = new OpenInboundNormalizedReceipt(...) // NormalizedMessage + +// Send an inbound Open Receipt Message +PostConversationsMessageInboundOpenReceiptRequest.postConversationsMessageInboundOpenReceipt(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageInboundOpenReceiptRequest.postConversationsMessageInboundOpenReceipt was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageMessagesBulk-example.txt b/build/docs/postConversationsMessageMessagesBulk-example.txt new file mode 100644 index 000000000..f83f144db --- /dev/null +++ b/build/docs/postConversationsMessageMessagesBulk-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // +let useNormalizedMessage: Bool = true // If true, response removes deprecated fields (textBody, media, stickers) +let body: [String] = [""] // messageIds + +// Get messages in batch +PostConversationsMessageMessagesBulkRequest.postConversationsMessageMessagesBulk(conversationId: conversationId, useNormalizedMessage: useNormalizedMessage, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessageMessagesBulkRequest.postConversationsMessageMessagesBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsMessageParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..889b780a9 --- /dev/null +++ b/build/docs/postConversationsMessageParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsMessageParticipantCommunicationWrapupRequest.postConversationsMessageParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsMessageParticipantCommunicationWrapupRequest.postConversationsMessageParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessageParticipantReplace-example.txt b/build/docs/postConversationsMessageParticipantReplace-example.txt new file mode 100644 index 000000000..c9502fdc2 --- /dev/null +++ b/build/docs/postConversationsMessageParticipantReplace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let body: TransferRequest = new TransferRequest(...) // Transfer request + +// Replace this participant with the specified user and/or address +PostConversationsMessageParticipantReplaceRequest.postConversationsMessageParticipantReplace(conversationId: conversationId, participantId: participantId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsMessageParticipantReplaceRequest.postConversationsMessageParticipantReplace was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessages-example.txt b/build/docs/postConversationsMessages-example.txt new file mode 100644 index 000000000..0f3beedcd --- /dev/null +++ b/build/docs/postConversationsMessages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateOutboundMessagingConversationRequest = new CreateOutboundMessagingConversationRequest(...) // Create outbound messaging conversation + +// Create an outbound messaging conversation. +PostConversationsMessagesRequest.postConversationsMessages(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagesRequest.postConversationsMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagesAgentless-example.txt b/build/docs/postConversationsMessagesAgentless-example.txt new file mode 100644 index 000000000..ad741c1bf --- /dev/null +++ b/build/docs/postConversationsMessagesAgentless-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SendAgentlessOutboundMessageRequest = new SendAgentlessOutboundMessageRequest(...) // Create agentless outbound messaging request + +// Send an agentless outbound message +PostConversationsMessagesAgentlessRequest.postConversationsMessagesAgentless(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagesAgentlessRequest.postConversationsMessagesAgentless was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagesInboundOpen-example.txt b/build/docs/postConversationsMessagesInboundOpen-example.txt new file mode 100644 index 000000000..7a0568234 --- /dev/null +++ b/build/docs/postConversationsMessagesInboundOpen-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OpenNormalizedMessage = new OpenNormalizedMessage(...) // NormalizedMessage + +// Send an inbound Open Message +PostConversationsMessagesInboundOpenRequest.postConversationsMessagesInboundOpen(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagesInboundOpenRequest.postConversationsMessagesInboundOpen was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsFacebook-example.txt b/build/docs/postConversationsMessagingIntegrationsFacebook-example.txt new file mode 100644 index 000000000..6a3661a85 --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsFacebook-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FacebookIntegrationRequest = new FacebookIntegrationRequest(...) // FacebookIntegrationRequest + +// Create a Facebook Integration +PostConversationsMessagingIntegrationsFacebookRequest.postConversationsMessagingIntegrationsFacebook(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsFacebookRequest.postConversationsMessagingIntegrationsFacebook was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsInstagram-example.txt b/build/docs/postConversationsMessagingIntegrationsInstagram-example.txt new file mode 100644 index 000000000..c69174ffc --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsInstagram-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: InstagramIntegrationRequest = new InstagramIntegrationRequest(...) // InstagramIntegrationRequest + +// Create Instagram Integration +PostConversationsMessagingIntegrationsInstagramRequest.postConversationsMessagingIntegrationsInstagram(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsInstagramRequest.postConversationsMessagingIntegrationsInstagram was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsLine-example.txt b/build/docs/postConversationsMessagingIntegrationsLine-example.txt new file mode 100644 index 000000000..9307bed8b --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsLine-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LineIntegrationRequest = new LineIntegrationRequest(...) // LineIntegrationRequest + +// Create a LINE messenger Integration +PostConversationsMessagingIntegrationsLineRequest.postConversationsMessagingIntegrationsLine(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsLineRequest.postConversationsMessagingIntegrationsLine was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsOpen-example.txt b/build/docs/postConversationsMessagingIntegrationsOpen-example.txt new file mode 100644 index 000000000..09c6d0519 --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsOpen-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OpenIntegrationRequest = new OpenIntegrationRequest(...) // OpenIntegrationRequest + +// Create an Open messaging integration +PostConversationsMessagingIntegrationsOpenRequest.postConversationsMessagingIntegrationsOpen(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsOpenRequest.postConversationsMessagingIntegrationsOpen was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsTwitter-example.txt b/build/docs/postConversationsMessagingIntegrationsTwitter-example.txt new file mode 100644 index 000000000..98d946311 --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsTwitter-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TwitterIntegrationRequest = new TwitterIntegrationRequest(...) // TwitterIntegrationRequest + +// Create a Twitter Integration +PostConversationsMessagingIntegrationsTwitterRequest.postConversationsMessagingIntegrationsTwitter(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsTwitterRequest.postConversationsMessagingIntegrationsTwitter was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingIntegrationsWhatsapp-example.txt b/build/docs/postConversationsMessagingIntegrationsWhatsapp-example.txt new file mode 100644 index 000000000..54ceba241 --- /dev/null +++ b/build/docs/postConversationsMessagingIntegrationsWhatsapp-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WhatsAppIntegrationRequest = new WhatsAppIntegrationRequest(...) // WhatsAppIntegrationRequest + +// Create a WhatsApp Integration +PostConversationsMessagingIntegrationsWhatsappRequest.postConversationsMessagingIntegrationsWhatsapp(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingIntegrationsWhatsappRequest.postConversationsMessagingIntegrationsWhatsapp was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingSettings-example.txt b/build/docs/postConversationsMessagingSettings-example.txt new file mode 100644 index 000000000..5bcc01229 --- /dev/null +++ b/build/docs/postConversationsMessagingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting + +// Create a messaging setting +PostConversationsMessagingSettingsRequest.postConversationsMessagingSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingSettingsRequest.postConversationsMessagingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsMessagingSupportedcontent-example.txt b/build/docs/postConversationsMessagingSupportedcontent-example.txt new file mode 100644 index 000000000..48376ba6f --- /dev/null +++ b/build/docs/postConversationsMessagingSupportedcontent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SupportedContent = new SupportedContent(...) // SupportedContent + +// Create a Supported Content profile +PostConversationsMessagingSupportedcontentRequest.postConversationsMessagingSupportedcontent(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsMessagingSupportedcontentRequest.postConversationsMessagingSupportedcontent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsParticipantsAttributesSearch-example.txt b/build/docs/postConversationsParticipantsAttributesSearch-example.txt new file mode 100644 index 000000000..16cdb1381 --- /dev/null +++ b/build/docs/postConversationsParticipantsAttributesSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationParticipantSearchRequest = new ConversationParticipantSearchRequest(...) // Search request options + +// Search conversations +PostConversationsParticipantsAttributesSearchRequest.postConversationsParticipantsAttributesSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostConversationsParticipantsAttributesSearchRequest.postConversationsParticipantsAttributesSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postConversationsScreenshareParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsScreenshareParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..a09c6ffc8 --- /dev/null +++ b/build/docs/postConversationsScreenshareParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsScreenshareParticipantCommunicationWrapupRequest.postConversationsScreenshareParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsScreenshareParticipantCommunicationWrapupRequest.postConversationsScreenshareParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsSocialParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsSocialParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..259eda9b9 --- /dev/null +++ b/build/docs/postConversationsSocialParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsSocialParticipantCommunicationWrapupRequest.postConversationsSocialParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsSocialParticipantCommunicationWrapupRequest.postConversationsSocialParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postConversationsVideoParticipantCommunicationWrapup-example.txt b/build/docs/postConversationsVideoParticipantCommunicationWrapup-example.txt new file mode 100644 index 000000000..53462e3f7 --- /dev/null +++ b/build/docs/postConversationsVideoParticipantCommunicationWrapup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: WrapupInput = new WrapupInput(...) // Wrap-up + +// Apply wrap-up for this conversation communication +PostConversationsVideoParticipantCommunicationWrapupRequest.postConversationsVideoParticipantCommunicationWrapup(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostConversationsVideoParticipantCommunicationWrapupRequest.postConversationsVideoParticipantCommunicationWrapup was successful") + } +} \ No newline at end of file diff --git a/build/docs/postDocumentationGknSearch-example.txt b/build/docs/postDocumentationGknSearch-example.txt new file mode 100644 index 000000000..f49c84552 --- /dev/null +++ b/build/docs/postDocumentationGknSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GKNDocumentationSearchRequest = new GKNDocumentationSearchRequest(...) // Search request options + +// Search gkn documentation +PostDocumentationGknSearchRequest.postDocumentationGknSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostDocumentationGknSearchRequest.postDocumentationGknSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postDocumentationSearch-example.txt b/build/docs/postDocumentationSearch-example.txt new file mode 100644 index 000000000..72b03c6e2 --- /dev/null +++ b/build/docs/postDocumentationSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DocumentationSearchRequest = new DocumentationSearchRequest(...) // Search request options + +// Search documentation +PostDocumentationSearchRequest.postDocumentationSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostDocumentationSearchRequest.postDocumentationSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postEmployeeperformanceExternalmetricsData-example.txt b/build/docs/postEmployeeperformanceExternalmetricsData-example.txt new file mode 100644 index 000000000..182b623e2 --- /dev/null +++ b/build/docs/postEmployeeperformanceExternalmetricsData-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ExternalMetricDataWriteRequest = new ExternalMetricDataWriteRequest(...) // The External Metric Data to be added + +// Write External Metric Data +PostEmployeeperformanceExternalmetricsDataRequest.postEmployeeperformanceExternalmetricsData(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostEmployeeperformanceExternalmetricsDataRequest.postEmployeeperformanceExternalmetricsData was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postEmployeeperformanceExternalmetricsDefinitions-example.txt b/build/docs/postEmployeeperformanceExternalmetricsDefinitions-example.txt new file mode 100644 index 000000000..58cf62fd2 --- /dev/null +++ b/build/docs/postEmployeeperformanceExternalmetricsDefinitions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ExternalMetricDefinitionCreateRequest = new ExternalMetricDefinitionCreateRequest(...) // The External Metric Definition to be created + +// Create External Metric Definition +PostEmployeeperformanceExternalmetricsDefinitionsRequest.postEmployeeperformanceExternalmetricsDefinitions(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostEmployeeperformanceExternalmetricsDefinitionsRequest.postEmployeeperformanceExternalmetricsDefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postEventsConversations-example.txt b/build/docs/postEventsConversations-example.txt new file mode 100644 index 000000000..1d5b51b5b --- /dev/null +++ b/build/docs/postEventsConversations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BatchConversationEventRequest = new BatchConversationEventRequest(...) // batchRequest + +// Publish Conversation Batch Events +PostEventsConversationsRequest.postEventsConversations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostEventsConversationsRequest.postEventsConversations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postEventsUsersPresence-example.txt b/build/docs/postEventsUsersPresence-example.txt new file mode 100644 index 000000000..1ac742726 --- /dev/null +++ b/build/docs/postEventsUsersPresence-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BatchUserPresenceEventRequest = new BatchUserPresenceEventRequest(...) // batchRequest + +// Publish User Presence Status Batch Events +PostEventsUsersPresenceRequest.postEventsUsersPresence(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostEventsUsersPresenceRequest.postEventsUsersPresence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postEventsUsersRoutingstatus-example.txt b/build/docs/postEventsUsersRoutingstatus-example.txt new file mode 100644 index 000000000..74780950b --- /dev/null +++ b/build/docs/postEventsUsersRoutingstatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BatchUserRoutingStatusEventRequest = new BatchUserRoutingStatusEventRequest(...) // batchRequest + +// Publish Agent Routing Status Batch Events +PostEventsUsersRoutingstatusRequest.postEventsUsersRoutingstatus(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostEventsUsersRoutingstatusRequest.postEventsUsersRoutingstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkContacts-example.txt b/build/docs/postExternalcontactsBulkContacts-example.txt new file mode 100644 index 000000000..faa82e75b --- /dev/null +++ b/build/docs/postExternalcontactsBulkContacts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids + +// Bulk fetch contacts +PostExternalcontactsBulkContactsRequest.postExternalcontactsBulkContacts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkContactsRequest.postExternalcontactsBulkContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkContactsAdd-example.txt b/build/docs/postExternalcontactsBulkContactsAdd-example.txt new file mode 100644 index 000000000..ea51e75e1 --- /dev/null +++ b/build/docs/postExternalcontactsBulkContactsAdd-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkContactsRequest = new BulkContactsRequest(...) // Contacts + +// Bulk add contacts +PostExternalcontactsBulkContactsAddRequest.postExternalcontactsBulkContactsAdd(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkContactsAddRequest.postExternalcontactsBulkContactsAdd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkContactsRemove-example.txt b/build/docs/postExternalcontactsBulkContactsRemove-example.txt new file mode 100644 index 000000000..c52c60b54 --- /dev/null +++ b/build/docs/postExternalcontactsBulkContactsRemove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids + +// Bulk remove contacts +PostExternalcontactsBulkContactsRemoveRequest.postExternalcontactsBulkContactsRemove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkContactsRemoveRequest.postExternalcontactsBulkContactsRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkContactsUnresolved-example.txt b/build/docs/postExternalcontactsBulkContactsUnresolved-example.txt new file mode 100644 index 000000000..6c18deba9 --- /dev/null +++ b/build/docs/postExternalcontactsBulkContactsUnresolved-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Contact ids + +// Bulk fetch unresolved ancestor contacts +PostExternalcontactsBulkContactsUnresolvedRequest.postExternalcontactsBulkContactsUnresolved(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkContactsUnresolvedRequest.postExternalcontactsBulkContactsUnresolved was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkContactsUpdate-example.txt b/build/docs/postExternalcontactsBulkContactsUpdate-example.txt new file mode 100644 index 000000000..6efaa2081 --- /dev/null +++ b/build/docs/postExternalcontactsBulkContactsUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkContactsRequest = new BulkContactsRequest(...) // Contacts + +// Bulk update contacts +PostExternalcontactsBulkContactsUpdateRequest.postExternalcontactsBulkContactsUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkContactsUpdateRequest.postExternalcontactsBulkContactsUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkNotes-example.txt b/build/docs/postExternalcontactsBulkNotes-example.txt new file mode 100644 index 000000000..f470a33eb --- /dev/null +++ b/build/docs/postExternalcontactsBulkNotes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Note ids + +// Bulk fetch notes +PostExternalcontactsBulkNotesRequest.postExternalcontactsBulkNotes(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkNotesRequest.postExternalcontactsBulkNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkNotesAdd-example.txt b/build/docs/postExternalcontactsBulkNotesAdd-example.txt new file mode 100644 index 000000000..d673d8a7f --- /dev/null +++ b/build/docs/postExternalcontactsBulkNotesAdd-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkNotesRequest = new BulkNotesRequest(...) // Notes + +// Bulk add notes +PostExternalcontactsBulkNotesAddRequest.postExternalcontactsBulkNotesAdd(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkNotesAddRequest.postExternalcontactsBulkNotesAdd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkNotesRemove-example.txt b/build/docs/postExternalcontactsBulkNotesRemove-example.txt new file mode 100644 index 000000000..c36a8b9fc --- /dev/null +++ b/build/docs/postExternalcontactsBulkNotesRemove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Note ids + +// Bulk remove notes +PostExternalcontactsBulkNotesRemoveRequest.postExternalcontactsBulkNotesRemove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkNotesRemoveRequest.postExternalcontactsBulkNotesRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkNotesUpdate-example.txt b/build/docs/postExternalcontactsBulkNotesUpdate-example.txt new file mode 100644 index 000000000..53c1390cc --- /dev/null +++ b/build/docs/postExternalcontactsBulkNotesUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkNotesRequest = new BulkNotesRequest(...) // Notes + +// Bulk update notes +PostExternalcontactsBulkNotesUpdateRequest.postExternalcontactsBulkNotesUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkNotesUpdateRequest.postExternalcontactsBulkNotesUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkOrganizations-example.txt b/build/docs/postExternalcontactsBulkOrganizations-example.txt new file mode 100644 index 000000000..97354ccd0 --- /dev/null +++ b/build/docs/postExternalcontactsBulkOrganizations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Organizations ids + +// Bulk fetch organizations +PostExternalcontactsBulkOrganizationsRequest.postExternalcontactsBulkOrganizations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkOrganizationsRequest.postExternalcontactsBulkOrganizations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkOrganizationsAdd-example.txt b/build/docs/postExternalcontactsBulkOrganizationsAdd-example.txt new file mode 100644 index 000000000..55a2a6472 --- /dev/null +++ b/build/docs/postExternalcontactsBulkOrganizationsAdd-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkOrganizationsRequest = new BulkOrganizationsRequest(...) // Organizations + +// Bulk add organizations +PostExternalcontactsBulkOrganizationsAddRequest.postExternalcontactsBulkOrganizationsAdd(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkOrganizationsAddRequest.postExternalcontactsBulkOrganizationsAdd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkOrganizationsRemove-example.txt b/build/docs/postExternalcontactsBulkOrganizationsRemove-example.txt new file mode 100644 index 000000000..ae70f21fc --- /dev/null +++ b/build/docs/postExternalcontactsBulkOrganizationsRemove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Organization ids + +// Bulk remove organizations +PostExternalcontactsBulkOrganizationsRemoveRequest.postExternalcontactsBulkOrganizationsRemove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkOrganizationsRemoveRequest.postExternalcontactsBulkOrganizationsRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkOrganizationsUpdate-example.txt b/build/docs/postExternalcontactsBulkOrganizationsUpdate-example.txt new file mode 100644 index 000000000..ee5537ee6 --- /dev/null +++ b/build/docs/postExternalcontactsBulkOrganizationsUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkOrganizationsRequest = new BulkOrganizationsRequest(...) // Organizations + +// Bulk update organizations +PostExternalcontactsBulkOrganizationsUpdateRequest.postExternalcontactsBulkOrganizationsUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkOrganizationsUpdateRequest.postExternalcontactsBulkOrganizationsUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkRelationships-example.txt b/build/docs/postExternalcontactsBulkRelationships-example.txt new file mode 100644 index 000000000..5f7fc9d67 --- /dev/null +++ b/build/docs/postExternalcontactsBulkRelationships-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Relationships ids + +// Bulk fetch relationships +PostExternalcontactsBulkRelationshipsRequest.postExternalcontactsBulkRelationships(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkRelationshipsRequest.postExternalcontactsBulkRelationships was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkRelationshipsAdd-example.txt b/build/docs/postExternalcontactsBulkRelationshipsAdd-example.txt new file mode 100644 index 000000000..96df9e9a8 --- /dev/null +++ b/build/docs/postExternalcontactsBulkRelationshipsAdd-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkRelationshipsRequest = new BulkRelationshipsRequest(...) // Relationships + +// Bulk add relationships +PostExternalcontactsBulkRelationshipsAddRequest.postExternalcontactsBulkRelationshipsAdd(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkRelationshipsAddRequest.postExternalcontactsBulkRelationshipsAdd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkRelationshipsRemove-example.txt b/build/docs/postExternalcontactsBulkRelationshipsRemove-example.txt new file mode 100644 index 000000000..7f274c56c --- /dev/null +++ b/build/docs/postExternalcontactsBulkRelationshipsRemove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkIdsRequest = new BulkIdsRequest(...) // Relationships ids + +// Bulk remove relationships +PostExternalcontactsBulkRelationshipsRemoveRequest.postExternalcontactsBulkRelationshipsRemove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkRelationshipsRemoveRequest.postExternalcontactsBulkRelationshipsRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsBulkRelationshipsUpdate-example.txt b/build/docs/postExternalcontactsBulkRelationshipsUpdate-example.txt new file mode 100644 index 000000000..3bceebc9a --- /dev/null +++ b/build/docs/postExternalcontactsBulkRelationshipsUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BulkRelationshipsRequest = new BulkRelationshipsRequest(...) // Relationships + +// Bulk update relationships +PostExternalcontactsBulkRelationshipsUpdateRequest.postExternalcontactsBulkRelationshipsUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsBulkRelationshipsUpdateRequest.postExternalcontactsBulkRelationshipsUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsContactNotes-example.txt b/build/docs/postExternalcontactsContactNotes-example.txt new file mode 100644 index 000000000..1c59379b2 --- /dev/null +++ b/build/docs/postExternalcontactsContactNotes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact Id +let body: Note = new Note(...) // ExternalContact + +// Create a note for an external contact +PostExternalcontactsContactNotesRequest.postExternalcontactsContactNotes(contactId: contactId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsContactNotesRequest.postExternalcontactsContactNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsContactPromotion-example.txt b/build/docs/postExternalcontactsContactPromotion-example.txt new file mode 100644 index 000000000..6d4c1242a --- /dev/null +++ b/build/docs/postExternalcontactsContactPromotion-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID + +// Promote an observed contact (ephemeral or identified) to a curated contact +PostExternalcontactsContactPromotionRequest.postExternalcontactsContactPromotion(contactId: contactId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsContactPromotionRequest.postExternalcontactsContactPromotion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsContacts-example.txt b/build/docs/postExternalcontactsContacts-example.txt new file mode 100644 index 000000000..ab237d7ed --- /dev/null +++ b/build/docs/postExternalcontactsContacts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ExternalContact = new ExternalContact(...) // ExternalContact + +// Create an external contact +PostExternalcontactsContactsRequest.postExternalcontactsContacts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsContactsRequest.postExternalcontactsContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsContactsSchemas-example.txt b/build/docs/postExternalcontactsContactsSchemas-example.txt new file mode 100644 index 000000000..299b4fc40 --- /dev/null +++ b/build/docs/postExternalcontactsContactsSchemas-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DataSchema = new DataSchema(...) // Schema + +// Create a schema +PostExternalcontactsContactsSchemasRequest.postExternalcontactsContactsSchemas(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsContactsSchemasRequest.postExternalcontactsContactsSchemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsIdentifierlookup-example.txt b/build/docs/postExternalcontactsIdentifierlookup-example.txt new file mode 100644 index 000000000..d8247a901 --- /dev/null +++ b/build/docs/postExternalcontactsIdentifierlookup-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let identifier: ContactIdentifier = new ContactIdentifier(...) // + +// Fetch a contact using an identifier type and value. +PostExternalcontactsIdentifierlookupRequest.postExternalcontactsIdentifierlookup(identifier: identifier) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsIdentifierlookupRequest.postExternalcontactsIdentifierlookup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsMergeContacts-example.txt b/build/docs/postExternalcontactsMergeContacts-example.txt new file mode 100644 index 000000000..7c3823c21 --- /dev/null +++ b/build/docs/postExternalcontactsMergeContacts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MergeRequest = new MergeRequest(...) // MergeRequest + +// Merge two contacts into a new contact record +PostExternalcontactsMergeContactsRequest.postExternalcontactsMergeContacts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsMergeContactsRequest.postExternalcontactsMergeContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsOrganizationNotes-example.txt b/build/docs/postExternalcontactsOrganizationNotes-example.txt new file mode 100644 index 000000000..eeb261db1 --- /dev/null +++ b/build/docs/postExternalcontactsOrganizationNotes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization Id +let body: Note = new Note(...) // ExternalContact + +// Create a note for an external organization +PostExternalcontactsOrganizationNotesRequest.postExternalcontactsOrganizationNotes(externalOrganizationId: externalOrganizationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsOrganizationNotesRequest.postExternalcontactsOrganizationNotes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsOrganizations-example.txt b/build/docs/postExternalcontactsOrganizations-example.txt new file mode 100644 index 000000000..e90643108 --- /dev/null +++ b/build/docs/postExternalcontactsOrganizations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ExternalOrganization = new ExternalOrganization(...) // ExternalOrganization + +// Create an external organization +PostExternalcontactsOrganizationsRequest.postExternalcontactsOrganizations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsOrganizationsRequest.postExternalcontactsOrganizations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsOrganizationsSchemas-example.txt b/build/docs/postExternalcontactsOrganizationsSchemas-example.txt new file mode 100644 index 000000000..d34dedf62 --- /dev/null +++ b/build/docs/postExternalcontactsOrganizationsSchemas-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DataSchema = new DataSchema(...) // Schema + +// Create a schema +PostExternalcontactsOrganizationsSchemasRequest.postExternalcontactsOrganizationsSchemas(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsOrganizationsSchemasRequest.postExternalcontactsOrganizationsSchemas was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postExternalcontactsRelationships-example.txt b/build/docs/postExternalcontactsRelationships-example.txt new file mode 100644 index 000000000..8d3836fc1 --- /dev/null +++ b/build/docs/postExternalcontactsRelationships-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Relationship = new Relationship(...) // Relationship + +// Create a relationship +PostExternalcontactsRelationshipsRequest.postExternalcontactsRelationships(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostExternalcontactsRelationshipsRequest.postExternalcontactsRelationships was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowHistory-example.txt b/build/docs/postFlowHistory-example.txt new file mode 100644 index 000000000..5a1e48eef --- /dev/null +++ b/build/docs/postFlowHistory-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID + +// Generate flow history +PostFlowHistoryRequest.postFlowHistory(flowId: flowId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowHistoryRequest.postFlowHistory was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowVersions-example.txt b/build/docs/postFlowVersions-example.txt new file mode 100644 index 000000000..2abeff862 --- /dev/null +++ b/build/docs/postFlowVersions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let body: [String:JSON] = new JSON(...) // + +// Create flow version +PostFlowVersionsRequest.postFlowVersions(flowId: flowId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowVersionsRequest.postFlowVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlows-example.txt b/build/docs/postFlows-example.txt new file mode 100644 index 000000000..0ed67cbb4 --- /dev/null +++ b/build/docs/postFlows-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Flow = new Flow(...) // +let language: String = "" // Language + +// Create flow +PostFlowsRequest.postFlows(body: body, language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsRequest.postFlows was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsCheckin-example.txt b/build/docs/postFlowsActionsCheckin-example.txt new file mode 100644 index 000000000..d17930cfc --- /dev/null +++ b/build/docs/postFlowsActionsCheckin-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID + +// Check-in flow +PostFlowsActionsCheckinRequest.postFlowsActionsCheckin(flow: flow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsCheckinRequest.postFlowsActionsCheckin was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsCheckout-example.txt b/build/docs/postFlowsActionsCheckout-example.txt new file mode 100644 index 000000000..cf9e5e4cc --- /dev/null +++ b/build/docs/postFlowsActionsCheckout-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID + +// Check-out flow +PostFlowsActionsCheckoutRequest.postFlowsActionsCheckout(flow: flow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsCheckoutRequest.postFlowsActionsCheckout was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsDeactivate-example.txt b/build/docs/postFlowsActionsDeactivate-example.txt new file mode 100644 index 000000000..dc310193b --- /dev/null +++ b/build/docs/postFlowsActionsDeactivate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID + +// Deactivate flow +PostFlowsActionsDeactivateRequest.postFlowsActionsDeactivate(flow: flow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsDeactivateRequest.postFlowsActionsDeactivate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsPublish-example.txt b/build/docs/postFlowsActionsPublish-example.txt new file mode 100644 index 000000000..c1591e4d8 --- /dev/null +++ b/build/docs/postFlowsActionsPublish-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID +let version: String = "" // version + +// Publish flow +PostFlowsActionsPublishRequest.postFlowsActionsPublish(flow: flow, version: version) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsPublishRequest.postFlowsActionsPublish was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsRevert-example.txt b/build/docs/postFlowsActionsRevert-example.txt new file mode 100644 index 000000000..66cb872fc --- /dev/null +++ b/build/docs/postFlowsActionsRevert-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID + +// Revert flow +PostFlowsActionsRevertRequest.postFlowsActionsRevert(flow: flow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsRevertRequest.postFlowsActionsRevert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsActionsUnlock-example.txt b/build/docs/postFlowsActionsUnlock-example.txt new file mode 100644 index 000000000..2a2765d6d --- /dev/null +++ b/build/docs/postFlowsActionsUnlock-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flow: String = "" // Flow ID + +// Unlock flow +PostFlowsActionsUnlockRequest.postFlowsActionsUnlock(flow: flow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsActionsUnlockRequest.postFlowsActionsUnlock was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsDatatableExportJobs-example.txt b/build/docs/postFlowsDatatableExportJobs-example.txt new file mode 100644 index 000000000..e611de694 --- /dev/null +++ b/build/docs/postFlowsDatatableExportJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable + +// Begin an export process for exporting all rows from a datatable +PostFlowsDatatableExportJobsRequest.postFlowsDatatableExportJobs(datatableId: datatableId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsDatatableExportJobsRequest.postFlowsDatatableExportJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsDatatableImportJobs-example.txt b/build/docs/postFlowsDatatableImportJobs-example.txt new file mode 100644 index 000000000..dbdf247fe --- /dev/null +++ b/build/docs/postFlowsDatatableImportJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let body: DataTableImportJob = new DataTableImportJob(...) // import job information + +// Begin an import process for importing rows into a datatable +PostFlowsDatatableImportJobsRequest.postFlowsDatatableImportJobs(datatableId: datatableId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsDatatableImportJobsRequest.postFlowsDatatableImportJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsDatatableRows-example.txt b/build/docs/postFlowsDatatableRows-example.txt new file mode 100644 index 000000000..431ae2b61 --- /dev/null +++ b/build/docs/postFlowsDatatableRows-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let dataTableRow: [String:JSON] = new JSON(...) // + +// Create a new row entry for the datatable. +PostFlowsDatatableRowsRequest.postFlowsDatatableRows(datatableId: datatableId, dataTableRow: dataTableRow) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsDatatableRowsRequest.postFlowsDatatableRows was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsDatatables-example.txt b/build/docs/postFlowsDatatables-example.txt new file mode 100644 index 000000000..c9b2048d2 --- /dev/null +++ b/build/docs/postFlowsDatatables-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DataTable = new DataTable(...) // datatable json-schema + +// Create a new datatable with the specified json-schema definition +PostFlowsDatatablesRequest.postFlowsDatatables(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsDatatablesRequest.postFlowsDatatables was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsExecutions-example.txt b/build/docs/postFlowsExecutions-example.txt new file mode 100644 index 000000000..881847360 --- /dev/null +++ b/build/docs/postFlowsExecutions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowLaunchRequest: FlowExecutionLaunchRequest = new FlowExecutionLaunchRequest(...) // + +// Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. +PostFlowsExecutionsRequest.postFlowsExecutions(flowLaunchRequest: flowLaunchRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsExecutionsRequest.postFlowsExecutions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsJobs-example.txt b/build/docs/postFlowsJobs-example.txt new file mode 100644 index 000000000..9a66d2ed4 --- /dev/null +++ b/build/docs/postFlowsJobs-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job. +PostFlowsJobsRequest.postFlowsJobs() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsJobsRequest.postFlowsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsMilestones-example.txt b/build/docs/postFlowsMilestones-example.txt new file mode 100644 index 000000000..f1848e362 --- /dev/null +++ b/build/docs/postFlowsMilestones-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FlowMilestone = new FlowMilestone(...) // + +// Create a flow milestone +PostFlowsMilestonesRequest.postFlowsMilestones(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsMilestonesRequest.postFlowsMilestones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postFlowsOutcomes-example.txt b/build/docs/postFlowsOutcomes-example.txt new file mode 100644 index 000000000..446d46a1b --- /dev/null +++ b/build/docs/postFlowsOutcomes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: FlowOutcome = new FlowOutcome(...) // + +// Create a flow outcome +PostFlowsOutcomesRequest.postFlowsOutcomes(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostFlowsOutcomesRequest.postFlowsOutcomes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileActivate-example.txt b/build/docs/postGamificationProfileActivate-example.txt new file mode 100644 index 000000000..8c0627bd4 --- /dev/null +++ b/build/docs/postGamificationProfileActivate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId + +// Activate a performance profile +PostGamificationProfileActivateRequest.postGamificationProfileActivate(profileId: profileId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileActivateRequest.postGamificationProfileActivate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileDeactivate-example.txt b/build/docs/postGamificationProfileDeactivate-example.txt new file mode 100644 index 000000000..51ce76538 --- /dev/null +++ b/build/docs/postGamificationProfileDeactivate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId + +// Deactivate a performance profile +PostGamificationProfileDeactivateRequest.postGamificationProfileDeactivate(profileId: profileId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileDeactivateRequest.postGamificationProfileDeactivate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileMembers-example.txt b/build/docs/postGamificationProfileMembers-example.txt new file mode 100644 index 000000000..5acfb0c87 --- /dev/null +++ b/build/docs/postGamificationProfileMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Profile Id +let body: AssignUsers = new AssignUsers(...) // assignUsers + +// Assign members to a given performance profile +PostGamificationProfileMembersRequest.postGamificationProfileMembers(profileId: profileId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileMembersRequest.postGamificationProfileMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileMembersValidate-example.txt b/build/docs/postGamificationProfileMembersValidate-example.txt new file mode 100644 index 000000000..2e72a20c7 --- /dev/null +++ b/build/docs/postGamificationProfileMembersValidate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Profile Id +let body: ValidateAssignUsers = new ValidateAssignUsers(...) // memberAssignments + +// Validate member assignment +PostGamificationProfileMembersValidateRequest.postGamificationProfileMembersValidate(profileId: profileId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileMembersValidateRequest.postGamificationProfileMembersValidate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileMetricLink-example.txt b/build/docs/postGamificationProfileMetricLink-example.txt new file mode 100644 index 000000000..201c9f8e3 --- /dev/null +++ b/build/docs/postGamificationProfileMetricLink-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sourceProfileId: String = "" // Source Performance Profile Id +let sourceMetricId: String = "" // Source Metric Id +let body: TargetPerformanceProfile = new TargetPerformanceProfile(...) // linkedMetric + +// Creates a linked metric +PostGamificationProfileMetricLinkRequest.postGamificationProfileMetricLink(sourceProfileId: sourceProfileId, sourceMetricId: sourceMetricId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileMetricLinkRequest.postGamificationProfileMetricLink was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfileMetrics-example.txt b/build/docs/postGamificationProfileMetrics-example.txt new file mode 100644 index 000000000..807c1aca9 --- /dev/null +++ b/build/docs/postGamificationProfileMetrics-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Performance Profile Id +let body: CreateMetric = new CreateMetric(...) // Metric + +// Creates a gamified metric with a given metric definition and metric objective under in a performance profile +PostGamificationProfileMetricsRequest.postGamificationProfileMetrics(profileId: profileId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfileMetricsRequest.postGamificationProfileMetrics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfiles-example.txt b/build/docs/postGamificationProfiles-example.txt new file mode 100644 index 000000000..022098b62 --- /dev/null +++ b/build/docs/postGamificationProfiles-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreatePerformanceProfile = new CreatePerformanceProfile(...) // performanceProfile +let copyMetrics: Bool = true // Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. + +// Create a new custom performance profile +PostGamificationProfilesRequest.postGamificationProfiles(body: body, copyMetrics: copyMetrics) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfilesRequest.postGamificationProfiles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfilesUserQuery-example.txt b/build/docs/postGamificationProfilesUserQuery-example.txt new file mode 100644 index 000000000..50bc01d9b --- /dev/null +++ b/build/docs/postGamificationProfilesUserQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. +let body: UserProfilesInDateRangeRequest = new UserProfilesInDateRangeRequest(...) // The date range of work day. + +// Query performance profiles in date range for a user +PostGamificationProfilesUserQueryRequest.postGamificationProfilesUserQuery(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfilesUserQueryRequest.postGamificationProfilesUserQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGamificationProfilesUsersMeQuery-example.txt b/build/docs/postGamificationProfilesUsersMeQuery-example.txt new file mode 100644 index 000000000..38aaad086 --- /dev/null +++ b/build/docs/postGamificationProfilesUsersMeQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserProfilesInDateRangeRequest = new UserProfilesInDateRangeRequest(...) // The date range of work day. + +// Query performance profiles in date range for the current user +PostGamificationProfilesUsersMeQueryRequest.postGamificationProfilesUsersMeQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGamificationProfilesUsersMeQueryRequest.postGamificationProfilesUsersMeQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGdprRequests-example.txt b/build/docs/postGdprRequests-example.txt new file mode 100644 index 000000000..135cf36a2 --- /dev/null +++ b/build/docs/postGdprRequests-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GDPRRequest = new GDPRRequest(...) // GDPR request +let deleteConfirmed: Bool = true // Confirm delete + +// Submit a new GDPR request +PostGdprRequestsRequest.postGdprRequests(body: body, deleteConfirmed: deleteConfirmed) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGdprRequestsRequest.postGdprRequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGreetings-example.txt b/build/docs/postGreetings-example.txt new file mode 100644 index 000000000..bfb485e0d --- /dev/null +++ b/build/docs/postGreetings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Greeting = new Greeting(...) // The Greeting to create + +// Create a Greeting for an Organization +PostGreetingsRequest.postGreetings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGreetingsRequest.postGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGroupGreetings-example.txt b/build/docs/postGroupGreetings-example.txt new file mode 100644 index 000000000..2003bf3ba --- /dev/null +++ b/build/docs/postGroupGreetings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let body: Greeting = new Greeting(...) // The Greeting to create + +// Creates a Greeting for a Group +PostGroupGreetingsRequest.postGroupGreetings(groupId: groupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGroupGreetingsRequest.postGroupGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGroupMembers-example.txt b/build/docs/postGroupMembers-example.txt new file mode 100644 index 000000000..e471486e7 --- /dev/null +++ b/build/docs/postGroupMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let body: GroupMembersUpdate = new GroupMembersUpdate(...) // Add members + +// Add members +PostGroupMembersRequest.postGroupMembers(groupId: groupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGroupMembersRequest.postGroupMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGroups-example.txt b/build/docs/postGroups-example.txt new file mode 100644 index 000000000..62bfe5dfe --- /dev/null +++ b/build/docs/postGroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GroupCreate = new GroupCreate(...) // Group + +// Create a group +PostGroupsRequest.postGroups(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGroupsRequest.postGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postGroupsSearch-example.txt b/build/docs/postGroupsSearch-example.txt new file mode 100644 index 000000000..5f6f5bdd0 --- /dev/null +++ b/build/docs/postGroupsSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GroupSearchRequest = new GroupSearchRequest(...) // Search request options + +// Search groups +PostGroupsSearchRequest.postGroupsSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostGroupsSearchRequest.postGroupsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postInfrastructureascodeJobs-example.txt b/build/docs/postInfrastructureascodeJobs-example.txt new file mode 100644 index 000000000..37916b877 --- /dev/null +++ b/build/docs/postInfrastructureascodeJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AcceleratorInput = new AcceleratorInput(...) // + +// Create a Job +PostInfrastructureascodeJobsRequest.postInfrastructureascodeJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostInfrastructureascodeJobsRequest.postInfrastructureascodeJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrations-example.txt b/build/docs/postIntegrations-example.txt new file mode 100644 index 000000000..1abc53560 --- /dev/null +++ b/build/docs/postIntegrations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateIntegrationRequest = new CreateIntegrationRequest(...) // Integration + +// Create an integration. +PostIntegrationsRequest.postIntegrations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsRequest.postIntegrations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionDraft-example.txt b/build/docs/postIntegrationsActionDraft-example.txt new file mode 100644 index 000000000..0b9d9588a --- /dev/null +++ b/build/docs/postIntegrationsActionDraft-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId + +// Create a new Draft from existing Action +PostIntegrationsActionDraftRequest.postIntegrationsActionDraft(actionId: actionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionDraftRequest.postIntegrationsActionDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionDraftPublish-example.txt b/build/docs/postIntegrationsActionDraftPublish-example.txt new file mode 100644 index 000000000..f2ab2852a --- /dev/null +++ b/build/docs/postIntegrationsActionDraftPublish-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: PublishDraftInput = new PublishDraftInput(...) // Input used to patch the Action. + +// Publish a Draft and make it the active Action configuration +PostIntegrationsActionDraftPublishRequest.postIntegrationsActionDraftPublish(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionDraftPublishRequest.postIntegrationsActionDraftPublish was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionDraftTest-example.txt b/build/docs/postIntegrationsActionDraftTest-example.txt new file mode 100644 index 000000000..a0cec08f0 --- /dev/null +++ b/build/docs/postIntegrationsActionDraftTest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution. + +// Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging. +PostIntegrationsActionDraftTestRequest.postIntegrationsActionDraftTest(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionDraftTestRequest.postIntegrationsActionDraftTest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionExecute-example.txt b/build/docs/postIntegrationsActionExecute-example.txt new file mode 100644 index 000000000..82cebd00a --- /dev/null +++ b/build/docs/postIntegrationsActionExecute-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution. + +// Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error. +PostIntegrationsActionExecuteRequest.postIntegrationsActionExecute(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionExecuteRequest.postIntegrationsActionExecute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionTest-example.txt b/build/docs/postIntegrationsActionTest-example.txt new file mode 100644 index 000000000..a3cbf722d --- /dev/null +++ b/build/docs/postIntegrationsActionTest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let actionId: String = "" // actionId +let body: [String:JSON] = new JSON(...) // Map of parameters used for variable substitution. + +// Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging. +PostIntegrationsActionTestRequest.postIntegrationsActionTest(actionId: actionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionTestRequest.postIntegrationsActionTest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActions-example.txt b/build/docs/postIntegrationsActions-example.txt new file mode 100644 index 000000000..c26c403b8 --- /dev/null +++ b/build/docs/postIntegrationsActions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PostActionInput = new PostActionInput(...) // Input used to create Action. + +// Create a new Action +PostIntegrationsActionsRequest.postIntegrationsActions(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionsRequest.postIntegrationsActions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsActionsDrafts-example.txt b/build/docs/postIntegrationsActionsDrafts-example.txt new file mode 100644 index 000000000..7da4df5f9 --- /dev/null +++ b/build/docs/postIntegrationsActionsDrafts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PostActionInput = new PostActionInput(...) // Input used to create Action Draft. + +// Create a new Draft +PostIntegrationsActionsDraftsRequest.postIntegrationsActionsDrafts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsActionsDraftsRequest.postIntegrationsActionsDrafts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postIntegrationsCredentials-example.txt b/build/docs/postIntegrationsCredentials-example.txt new file mode 100644 index 000000000..c8b35aa32 --- /dev/null +++ b/build/docs/postIntegrationsCredentials-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Credential = new Credential(...) // Credential + +// Create a set of credentials +PostIntegrationsCredentialsRequest.postIntegrationsCredentials(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostIntegrationsCredentialsRequest.postIntegrationsCredentials was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneyActionmaps-example.txt b/build/docs/postJourneyActionmaps-example.txt new file mode 100644 index 000000000..f6a8b7c4c --- /dev/null +++ b/build/docs/postJourneyActionmaps-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ActionMap = new ActionMap(...) // + +// Create an action map. +PostJourneyActionmapsRequest.postJourneyActionmaps(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneyActionmapsRequest.postJourneyActionmaps was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneyActionmapsEstimatesJobs-example.txt b/build/docs/postJourneyActionmapsEstimatesJobs-example.txt new file mode 100644 index 000000000..19db0a865 --- /dev/null +++ b/build/docs/postJourneyActionmapsEstimatesJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ActionMapEstimateRequest = new ActionMapEstimateRequest(...) // audience estimator request + +// Query for estimates +PostJourneyActionmapsEstimatesJobsRequest.postJourneyActionmapsEstimatesJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneyActionmapsEstimatesJobsRequest.postJourneyActionmapsEstimatesJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneyActiontemplates-example.txt b/build/docs/postJourneyActiontemplates-example.txt new file mode 100644 index 000000000..aa4460c7a --- /dev/null +++ b/build/docs/postJourneyActiontemplates-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ActionTemplate = new ActionTemplate(...) // + +// Create a single action template. +PostJourneyActiontemplatesRequest.postJourneyActiontemplates(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneyActiontemplatesRequest.postJourneyActiontemplates was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneyOutcomes-example.txt b/build/docs/postJourneyOutcomes-example.txt new file mode 100644 index 000000000..cc346c6b8 --- /dev/null +++ b/build/docs/postJourneyOutcomes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Outcome = new Outcome(...) // + +// Create an outcome. +PostJourneyOutcomesRequest.postJourneyOutcomes(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneyOutcomesRequest.postJourneyOutcomes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneyOutcomesPredictors-example.txt b/build/docs/postJourneyOutcomesPredictors-example.txt new file mode 100644 index 000000000..4a7bec22b --- /dev/null +++ b/build/docs/postJourneyOutcomesPredictors-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OutcomePredictorRequest = new OutcomePredictorRequest(...) // + +// Create an outcome predictor. +PostJourneyOutcomesPredictorsRequest.postJourneyOutcomesPredictors(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneyOutcomesPredictorsRequest.postJourneyOutcomesPredictors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postJourneySegments-example.txt b/build/docs/postJourneySegments-example.txt new file mode 100644 index 000000000..533c2e859 --- /dev/null +++ b/build/docs/postJourneySegments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: JourneySegment = new JourneySegment(...) // + +// Create a segment. +PostJourneySegmentsRequest.postJourneySegments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostJourneySegmentsRequest.postJourneySegments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeDocumentuploads-example.txt b/build/docs/postKnowledgeDocumentuploads-example.txt new file mode 100644 index 000000000..f412cdc28 --- /dev/null +++ b/build/docs/postKnowledgeDocumentuploads-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UploadUrlRequest = new UploadUrlRequest(...) // query + +// Creates a presigned URL for uploading a knowledge import file with a set of documents +PostKnowledgeDocumentuploadsRequest.postKnowledgeDocumentuploads(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeDocumentuploadsRequest.postKnowledgeDocumentuploads was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeGuestSessionDocumentFeedback-example.txt b/build/docs/postKnowledgeGuestSessionDocumentFeedback-example.txt new file mode 100644 index 000000000..5f6cbd1a2 --- /dev/null +++ b/build/docs/postKnowledgeGuestSessionDocumentFeedback-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let documentId: String = "" // Document ID. +let body: KnowledgeGuestDocumentFeedback = new KnowledgeGuestDocumentFeedback(...) // + +// Give feedback on a document +PostKnowledgeGuestSessionDocumentFeedbackRequest.postKnowledgeGuestSessionDocumentFeedback(sessionId: sessionId, documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeGuestSessionDocumentFeedbackRequest.postKnowledgeGuestSessionDocumentFeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeGuestSessionDocumentsSearch-example.txt b/build/docs/postKnowledgeGuestSessionDocumentsSearch-example.txt new file mode 100644 index 000000000..8ed7a8eb4 --- /dev/null +++ b/build/docs/postKnowledgeGuestSessionDocumentsSearch-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let expand: [String] = [""] // Fields, if any, to expand for each document in the search result matching the query. +let body: KnowledgeDocumentGuestSearchRequest = new KnowledgeDocumentGuestSearchRequest(...) // + +// Search the documents in a guest session. +PostKnowledgeGuestSessionDocumentsSearchRequest.postKnowledgeGuestSessionDocumentsSearch(sessionId: sessionId, expand: expand, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeGuestSessionDocumentsSearchRequest.postKnowledgeGuestSessionDocumentsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeGuestSessionDocumentsSearchSuggestions-example.txt b/build/docs/postKnowledgeGuestSessionDocumentsSearchSuggestions-example.txt new file mode 100644 index 000000000..a6568ba06 --- /dev/null +++ b/build/docs/postKnowledgeGuestSessionDocumentsSearchSuggestions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // Knowledge guest session ID. +let body: KnowledgeGuestDocumentSuggestionRequest = new KnowledgeGuestDocumentSuggestionRequest(...) // + +// Query the knowledge documents to provide suggestions for auto completion. +PostKnowledgeGuestSessionDocumentsSearchSuggestionsRequest.postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId: sessionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeGuestSessionDocumentsSearchSuggestionsRequest.postKnowledgeGuestSessionDocumentsSearchSuggestions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeGuestSessions-example.txt b/build/docs/postKnowledgeGuestSessions-example.txt new file mode 100644 index 000000000..37b413ca6 --- /dev/null +++ b/build/docs/postKnowledgeGuestSessions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: KnowledgeGuestSession = new KnowledgeGuestSession(...) // + +// Create guest session +PostKnowledgeGuestSessionsRequest.postKnowledgeGuestSessions(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeGuestSessionsRequest.postKnowledgeGuestSessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseCategories-example.txt b/build/docs/postKnowledgeKnowledgebaseCategories-example.txt new file mode 100644 index 000000000..938d470da --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseCategories-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: CategoryCreateRequest = new CategoryCreateRequest(...) // + +// Create new category +PostKnowledgeKnowledgebaseCategoriesRequest.postKnowledgeKnowledgebaseCategories(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseCategoriesRequest.postKnowledgeKnowledgebaseCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentFeedback-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentFeedback-example.txt new file mode 100644 index 000000000..24cf88ea9 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentFeedback-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let body: KnowledgeDocumentFeedback = new KnowledgeDocumentFeedback(...) // + +// Give feedback on a document +PostKnowledgeKnowledgebaseDocumentFeedbackRequest.postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentFeedbackRequest.postKnowledgeKnowledgebaseDocumentFeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentVariations-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentVariations-example.txt new file mode 100644 index 000000000..4a63e07fe --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentVariations-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let body: DocumentVariation = new DocumentVariation(...) // + +// Create a variation for a document. +PostKnowledgeKnowledgebaseDocumentVariationsRequest.postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentVariationsRequest.postKnowledgeKnowledgebaseDocumentVariations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentVersions-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentVersions-example.txt new file mode 100644 index 000000000..df98ba2e6 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentVersions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Globally unique identifier for the knowledge base. +let documentId: String = "" // Globally unique identifier for the document. +let body: KnowledgeDocumentVersion = new KnowledgeDocumentVersion(...) // + +// Creates or restores a document version. +PostKnowledgeKnowledgebaseDocumentVersionsRequest.postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentVersionsRequest.postKnowledgeKnowledgebaseDocumentVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentViews-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentViews-example.txt new file mode 100644 index 000000000..2476bca01 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentViews-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID. +let documentId: String = "" // Document ID. +let body: KnowledgeDocumentView = new KnowledgeDocumentView(...) // + +// Create view for a document. +PostKnowledgeKnowledgebaseDocumentViewsRequest.postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId: knowledgeBaseId, documentId: documentId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostKnowledgeKnowledgebaseDocumentViewsRequest.postKnowledgeKnowledgebaseDocumentViews was successful") + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocuments-example.txt b/build/docs/postKnowledgeKnowledgebaseDocuments-example.txt new file mode 100644 index 000000000..8ce023290 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocuments-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: KnowledgeDocumentReq = new KnowledgeDocumentReq(...) // + +// Create document. +PostKnowledgeKnowledgebaseDocumentsRequest.postKnowledgeKnowledgebaseDocuments(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentsRequest.postKnowledgeKnowledgebaseDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentsSearch-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentsSearch-example.txt new file mode 100644 index 000000000..7af75a89b --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentsSearch-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // The ID of knowledge base containing the documents to query. +let expand: [String] = [""] // Fields, if any, to expand for each document in the search result matching the query. +let body: KnowledgeDocumentSearchRequest = new KnowledgeDocumentSearchRequest(...) // + +// Search the documents in a knowledge base. +PostKnowledgeKnowledgebaseDocumentsSearchRequest.postKnowledgeKnowledgebaseDocumentsSearch(knowledgeBaseId: knowledgeBaseId, expand: expand, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentsSearchRequest.postKnowledgeKnowledgebaseDocumentsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseDocumentsSearchSuggestions-example.txt b/build/docs/postKnowledgeKnowledgebaseDocumentsSearchSuggestions-example.txt new file mode 100644 index 000000000..70e843efd --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseDocumentsSearchSuggestions-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // The ID of knowledge base containing the documents to query. +let body: KnowledgeDocumentSuggestionRequest = new KnowledgeDocumentSuggestionRequest(...) // + +// Query the knowledge documents to provide suggestions for auto completion. +PostKnowledgeKnowledgebaseDocumentsSearchSuggestionsRequest.postKnowledgeKnowledgebaseDocumentsSearchSuggestions(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseDocumentsSearchSuggestionsRequest.postKnowledgeKnowledgebaseDocumentsSearchSuggestions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseExportJobs-example.txt b/build/docs/postKnowledgeKnowledgebaseExportJobs-example.txt new file mode 100644 index 000000000..e813843f3 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseExportJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: KnowledgeExportJobRequest = new KnowledgeExportJobRequest(...) // + +// Create export job +PostKnowledgeKnowledgebaseExportJobsRequest.postKnowledgeKnowledgebaseExportJobs(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseExportJobsRequest.postKnowledgeKnowledgebaseExportJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseImportJobs-example.txt b/build/docs/postKnowledgeKnowledgebaseImportJobs-example.txt new file mode 100644 index 000000000..9f6289ec9 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseImportJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: KnowledgeImportJobRequest = new KnowledgeImportJobRequest(...) // + +// Create import job +PostKnowledgeKnowledgebaseImportJobsRequest.postKnowledgeKnowledgebaseImportJobs(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseImportJobsRequest.postKnowledgeKnowledgebaseImportJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLabels-example.txt b/build/docs/postKnowledgeKnowledgebaseLabels-example.txt new file mode 100644 index 000000000..b26d97219 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLabels-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: LabelCreateRequest = new LabelCreateRequest(...) // + +// Create new label +PostKnowledgeKnowledgebaseLabelsRequest.postKnowledgeKnowledgebaseLabels(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLabelsRequest.postKnowledgeKnowledgebaseLabels was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLanguageCategories-example.txt b/build/docs/postKnowledgeKnowledgebaseLanguageCategories-example.txt new file mode 100644 index 000000000..6a2c10900 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLanguageCategories-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PostKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageCategories = PostKnowledgeKnowledgebaseLanguageCategoriesRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageCategories.enummember // Language code, format: iso2-LOCALE +let body: KnowledgeCategoryRequest = new KnowledgeCategoryRequest(...) // + +// Create new category +PostKnowledgeKnowledgebaseLanguageCategoriesRequest.postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLanguageCategoriesRequest.postKnowledgeKnowledgebaseLanguageCategories was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLanguageDocuments-example.txt b/build/docs/postKnowledgeKnowledgebaseLanguageDocuments-example.txt new file mode 100644 index 000000000..dd5cf5349 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLanguageDocuments-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PostKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocuments = PostKnowledgeKnowledgebaseLanguageDocumentsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocuments.enummember // Language code, format: iso2-LOCALE +let body: KnowledgeDocumentRequest = new KnowledgeDocumentRequest(...) // + +// Create document +PostKnowledgeKnowledgebaseLanguageDocumentsRequest.postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLanguageDocumentsRequest.postKnowledgeKnowledgebaseLanguageDocuments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLanguageDocumentsImports-example.txt b/build/docs/postKnowledgeKnowledgebaseLanguageDocumentsImports-example.txt new file mode 100644 index 000000000..d3ecddc4e --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLanguageDocumentsImports-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocumentsImports = PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageDocumentsImports.enummember // Language code, format: iso2-LOCALE +let body: KnowledgeImport = new KnowledgeImport(...) // + +// Create import operation +PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLanguageDocumentsImportsRequest.postKnowledgeKnowledgebaseLanguageDocumentsImports was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLanguageTrainingPromote-example.txt b/build/docs/postKnowledgeKnowledgebaseLanguageTrainingPromote-example.txt new file mode 100644 index 000000000..8acd96930 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLanguageTrainingPromote-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainingPromote = PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainingPromote.enummember // Language code, format: iso2-LOCALE +let trainingId: String = "" // Training ID + +// Promote trained documents from draft state to active. +PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode, trainingId: trainingId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLanguageTrainingPromoteRequest.postKnowledgeKnowledgebaseLanguageTrainingPromote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseLanguageTrainings-example.txt b/build/docs/postKnowledgeKnowledgebaseLanguageTrainings-example.txt new file mode 100644 index 000000000..210190e98 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseLanguageTrainings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let languageCode: PostKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainings = PostKnowledgeKnowledgebaseLanguageTrainingsRequest.LanguageCode_postKnowledgeKnowledgebaseLanguageTrainings.enummember // Language code, format: iso2-LOCALE + +// Trigger training +PostKnowledgeKnowledgebaseLanguageTrainingsRequest.postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId: knowledgeBaseId, languageCode: languageCode) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseLanguageTrainingsRequest.postKnowledgeKnowledgebaseLanguageTrainings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebaseSearch-example.txt b/build/docs/postKnowledgeKnowledgebaseSearch-example.txt new file mode 100644 index 000000000..bb85086f4 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebaseSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let knowledgeBaseId: String = "" // Knowledge base ID +let body: KnowledgeSearchRequest = new KnowledgeSearchRequest(...) // + +// Search Documents +PostKnowledgeKnowledgebaseSearchRequest.postKnowledgeKnowledgebaseSearch(knowledgeBaseId: knowledgeBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebaseSearchRequest.postKnowledgeKnowledgebaseSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postKnowledgeKnowledgebases-example.txt b/build/docs/postKnowledgeKnowledgebases-example.txt new file mode 100644 index 000000000..27b8b6923 --- /dev/null +++ b/build/docs/postKnowledgeKnowledgebases-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: KnowledgeBaseCreateRequest = new KnowledgeBaseCreateRequest(...) // + +// Create new knowledge base +PostKnowledgeKnowledgebasesRequest.postKnowledgeKnowledgebases(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostKnowledgeKnowledgebasesRequest.postKnowledgeKnowledgebases was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguages-example.txt b/build/docs/postLanguages-example.txt new file mode 100644 index 000000000..36f77a3ab --- /dev/null +++ b/build/docs/postLanguages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Language = new Language(...) // Language + +// Create Language (Deprecated) +PostLanguagesRequest.postLanguages(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguagesRequest.postLanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomainFeedback-example.txt b/build/docs/postLanguageunderstandingDomainFeedback-example.txt new file mode 100644 index 000000000..19c73ee7e --- /dev/null +++ b/build/docs/postLanguageunderstandingDomainFeedback-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let body: NluFeedbackRequest = new NluFeedbackRequest(...) // The Feedback to create. + +// Create feedback for the NLU Domain Version. +PostLanguageunderstandingDomainFeedbackRequest.postLanguageunderstandingDomainFeedback(domainId: domainId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainFeedbackRequest.postLanguageunderstandingDomainFeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomainVersionDetect-example.txt b/build/docs/postLanguageunderstandingDomainVersionDetect-example.txt new file mode 100644 index 000000000..805325d25 --- /dev/null +++ b/build/docs/postLanguageunderstandingDomainVersionDetect-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. +let body: NluDetectionRequest = new NluDetectionRequest(...) // The input data to perform detection on. + +// Detect intent, entities, etc. in the submitted text using the specified NLU domain version. +PostLanguageunderstandingDomainVersionDetectRequest.postLanguageunderstandingDomainVersionDetect(domainId: domainId, domainVersionId: domainVersionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainVersionDetectRequest.postLanguageunderstandingDomainVersionDetect was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomainVersionPublish-example.txt b/build/docs/postLanguageunderstandingDomainVersionPublish-example.txt new file mode 100644 index 000000000..f48d9b4a6 --- /dev/null +++ b/build/docs/postLanguageunderstandingDomainVersionPublish-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. + +// Publish the draft NLU Domain Version. +PostLanguageunderstandingDomainVersionPublishRequest.postLanguageunderstandingDomainVersionPublish(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainVersionPublishRequest.postLanguageunderstandingDomainVersionPublish was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomainVersionTrain-example.txt b/build/docs/postLanguageunderstandingDomainVersionTrain-example.txt new file mode 100644 index 000000000..a52c4dd2f --- /dev/null +++ b/build/docs/postLanguageunderstandingDomainVersionTrain-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. + +// Train the draft NLU Domain Version. +PostLanguageunderstandingDomainVersionTrainRequest.postLanguageunderstandingDomainVersionTrain(domainId: domainId, domainVersionId: domainVersionId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainVersionTrainRequest.postLanguageunderstandingDomainVersionTrain was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomainVersions-example.txt b/build/docs/postLanguageunderstandingDomainVersions-example.txt new file mode 100644 index 000000000..9e33b8340 --- /dev/null +++ b/build/docs/postLanguageunderstandingDomainVersions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let body: NluDomainVersion = new NluDomainVersion(...) // The NLU Domain Version to create. +let includeUtterances: Bool = true // Whether utterances for intent definition should be included when marshalling response. + +// Create an NLU Domain Version. +PostLanguageunderstandingDomainVersionsRequest.postLanguageunderstandingDomainVersions(domainId: domainId, body: body, includeUtterances: includeUtterances) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainVersionsRequest.postLanguageunderstandingDomainVersions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingDomains-example.txt b/build/docs/postLanguageunderstandingDomains-example.txt new file mode 100644 index 000000000..b70036e8d --- /dev/null +++ b/build/docs/postLanguageunderstandingDomains-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: NluDomain = new NluDomain(...) // The NLU Domain to create. + +// Create an NLU Domain. +PostLanguageunderstandingDomainsRequest.postLanguageunderstandingDomains(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingDomainsRequest.postLanguageunderstandingDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingMinerDrafts-example.txt b/build/docs/postLanguageunderstandingMinerDrafts-example.txt new file mode 100644 index 000000000..59757bae1 --- /dev/null +++ b/build/docs/postLanguageunderstandingMinerDrafts-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let body: Draft = new Draft(...) // Details for creating draft resource + +// Create a new draft resource. +PostLanguageunderstandingMinerDraftsRequest.postLanguageunderstandingMinerDrafts(minerId: minerId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingMinerDraftsRequest.postLanguageunderstandingMinerDrafts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingMinerExecute-example.txt b/build/docs/postLanguageunderstandingMinerExecute-example.txt new file mode 100644 index 000000000..69b8c98e5 --- /dev/null +++ b/build/docs/postLanguageunderstandingMinerExecute-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let body: MinerExecuteRequest = new MinerExecuteRequest(...) // + +// Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file. +PostLanguageunderstandingMinerExecuteRequest.postLanguageunderstandingMinerExecute(minerId: minerId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingMinerExecuteRequest.postLanguageunderstandingMinerExecute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingMinerUploads-example.txt b/build/docs/postLanguageunderstandingMinerUploads-example.txt new file mode 100644 index 000000000..2d56cfe56 --- /dev/null +++ b/build/docs/postLanguageunderstandingMinerUploads-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let minerId: String = "" // Miner ID +let body: JSON = new JSON(...) // query + +// Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner +PostLanguageunderstandingMinerUploadsRequest.postLanguageunderstandingMinerUploads(minerId: minerId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingMinerUploadsRequest.postLanguageunderstandingMinerUploads was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLanguageunderstandingMiners-example.txt b/build/docs/postLanguageunderstandingMiners-example.txt new file mode 100644 index 000000000..a8aae4515 --- /dev/null +++ b/build/docs/postLanguageunderstandingMiners-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Miner = new Miner(...) // Details for creating a new miner resource. + +// Create a unique miner. +PostLanguageunderstandingMinersRequest.postLanguageunderstandingMiners(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLanguageunderstandingMinersRequest.postLanguageunderstandingMiners was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssessmentsScoring-example.txt b/build/docs/postLearningAssessmentsScoring-example.txt new file mode 100644 index 000000000..25e5eb538 --- /dev/null +++ b/build/docs/postLearningAssessmentsScoring-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningAssessmentScoringRequest = new LearningAssessmentScoringRequest(...) // Assessment form and answers to score + +// Score learning assessment for preview +PostLearningAssessmentsScoringRequest.postLearningAssessmentsScoring(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssessmentsScoringRequest.postLearningAssessmentsScoring was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignmentReassign-example.txt b/build/docs/postLearningAssignmentReassign-example.txt new file mode 100644 index 000000000..fc5d14997 --- /dev/null +++ b/build/docs/postLearningAssignmentReassign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The Learning Assignment ID + +// Reassign Learning Assignment +PostLearningAssignmentReassignRequest.postLearningAssignmentReassign(assignmentId: assignmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentReassignRequest.postLearningAssignmentReassign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignmentReset-example.txt b/build/docs/postLearningAssignmentReset-example.txt new file mode 100644 index 000000000..7e832fda5 --- /dev/null +++ b/build/docs/postLearningAssignmentReset-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignmentId: String = "" // The Learning Assignment ID + +// Reset Learning Assignment +PostLearningAssignmentResetRequest.postLearningAssignmentReset(assignmentId: assignmentId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentResetRequest.postLearningAssignmentReset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignments-example.txt b/build/docs/postLearningAssignments-example.txt new file mode 100644 index 000000000..fa55a0e50 --- /dev/null +++ b/build/docs/postLearningAssignments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningAssignmentCreate = new LearningAssignmentCreate(...) // The Learning Assignment to be created + +// Create Learning Assignment +PostLearningAssignmentsRequest.postLearningAssignments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentsRequest.postLearningAssignments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignmentsAggregatesQuery-example.txt b/build/docs/postLearningAssignmentsAggregatesQuery-example.txt new file mode 100644 index 000000000..5e1faefcf --- /dev/null +++ b/build/docs/postLearningAssignmentsAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningAssignmentAggregateParam = new LearningAssignmentAggregateParam(...) // Aggregate Request + +// Retrieve aggregated assignment data +PostLearningAssignmentsAggregatesQueryRequest.postLearningAssignmentsAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentsAggregatesQueryRequest.postLearningAssignmentsAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignmentsBulkadd-example.txt b/build/docs/postLearningAssignmentsBulkadd-example.txt new file mode 100644 index 000000000..099c729b2 --- /dev/null +++ b/build/docs/postLearningAssignmentsBulkadd-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [LearningAssignmentItem] = [new LearningAssignmentItem(...)] // The learning assignments to be created + +// Add multiple learning assignments +PostLearningAssignmentsBulkaddRequest.postLearningAssignmentsBulkadd(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentsBulkaddRequest.postLearningAssignmentsBulkadd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningAssignmentsBulkremove-example.txt b/build/docs/postLearningAssignmentsBulkremove-example.txt new file mode 100644 index 000000000..88e4c9647 --- /dev/null +++ b/build/docs/postLearningAssignmentsBulkremove-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [String] = [""] // The IDs of the learning assignments to be removed + +// Remove multiple Learning Assignments +PostLearningAssignmentsBulkremoveRequest.postLearningAssignmentsBulkremove(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningAssignmentsBulkremoveRequest.postLearningAssignmentsBulkremove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningModuleJobs-example.txt b/build/docs/postLearningModuleJobs-example.txt new file mode 100644 index 000000000..2405254c0 --- /dev/null +++ b/build/docs/postLearningModuleJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let body: LearningModuleJobRequest = new LearningModuleJobRequest(...) // The learning module job request + +// Starts a specified operation on learning module +PostLearningModuleJobsRequest.postLearningModuleJobs(moduleId: moduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningModuleJobsRequest.postLearningModuleJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningModulePublish-example.txt b/build/docs/postLearningModulePublish-example.txt new file mode 100644 index 000000000..073f0567d --- /dev/null +++ b/build/docs/postLearningModulePublish-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let body: LearningModulePublishRequest = new LearningModulePublishRequest(...) // The request body + +// Publish a Learning module +PostLearningModulePublishRequest.postLearningModulePublish(moduleId: moduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningModulePublishRequest.postLearningModulePublish was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningModules-example.txt b/build/docs/postLearningModules-example.txt new file mode 100644 index 000000000..2786900c1 --- /dev/null +++ b/build/docs/postLearningModules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningModuleRequest = new LearningModuleRequest(...) // The learning module to be created + +// Create a new learning module +PostLearningModulesRequest.postLearningModules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningModulesRequest.postLearningModules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningRulesQuery-example.txt b/build/docs/postLearningRulesQuery-example.txt new file mode 100644 index 000000000..43c5aa6e3 --- /dev/null +++ b/build/docs/postLearningRulesQuery-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let body: LearningAssignmentUserQuery = new LearningAssignmentUserQuery(...) // The learning module rule to fetch users + +// Get users for learning module rule +PostLearningRulesQueryRequest.postLearningRulesQuery(pageSize: pageSize, pageNumber: pageNumber, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningRulesQueryRequest.postLearningRulesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLearningScheduleslotsQuery-example.txt b/build/docs/postLearningScheduleslotsQuery-example.txt new file mode 100644 index 000000000..91382c5c7 --- /dev/null +++ b/build/docs/postLearningScheduleslotsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningScheduleSlotsQueryRequest = new LearningScheduleSlotsQueryRequest(...) // The slot search request + +// Get list of possible slots where a learning activity can be scheduled. +PostLearningScheduleslotsQueryRequest.postLearningScheduleslotsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLearningScheduleslotsQueryRequest.postLearningScheduleslotsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLicenseInfer-example.txt b/build/docs/postLicenseInfer-example.txt new file mode 100644 index 000000000..5ac43176b --- /dev/null +++ b/build/docs/postLicenseInfer-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [String] = [""] // The roleIds to use while inferring licenses + +// Get a list of licenses inferred based on a list of roleIds +PostLicenseInferRequest.postLicenseInfer(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLicenseInferRequest.postLicenseInfer was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLicenseOrganization-example.txt b/build/docs/postLicenseOrganization-example.txt new file mode 100644 index 000000000..ca16de63a --- /dev/null +++ b/build/docs/postLicenseOrganization-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LicenseBatchAssignmentRequest = new LicenseBatchAssignmentRequest(...) // The license assignments to update. + +// Update the organization's license assignments in a batch. +PostLicenseOrganizationRequest.postLicenseOrganization(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLicenseOrganizationRequest.postLicenseOrganization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLicenseToggle-example.txt b/build/docs/postLicenseToggle-example.txt new file mode 100644 index 000000000..8f8c6edd8 --- /dev/null +++ b/build/docs/postLicenseToggle-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let featureName: String = "" // featureName + +// Deprecated. No alternative required - this endpoint has no effect +PostLicenseToggleRequest.postLicenseToggle(featureName: featureName) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLicenseToggleRequest.postLicenseToggle was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLicenseUsers-example.txt b/build/docs/postLicenseUsers-example.txt new file mode 100644 index 000000000..519f78c5f --- /dev/null +++ b/build/docs/postLicenseUsers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [String] = [""] // The user IDs to fetch. + +// Fetch user licenses in a batch. +PostLicenseUsersRequest.postLicenseUsers(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLicenseUsersRequest.postLicenseUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLocations-example.txt b/build/docs/postLocations-example.txt new file mode 100644 index 000000000..4b107396b --- /dev/null +++ b/build/docs/postLocations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LocationCreateDefinition = new LocationCreateDefinition(...) // Location + +// Create a location +PostLocationsRequest.postLocations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLocationsRequest.postLocations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postLocationsSearch-example.txt b/build/docs/postLocationsSearch-example.txt new file mode 100644 index 000000000..b223a94d2 --- /dev/null +++ b/build/docs/postLocationsSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LocationSearchRequest = new LocationSearchRequest(...) // Search request options + +// Search locations +PostLocationsSearchRequest.postLocationsSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostLocationsSearchRequest.postLocationsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postMessagingSettings-example.txt b/build/docs/postMessagingSettings-example.txt new file mode 100644 index 000000000..31da4501f --- /dev/null +++ b/build/docs/postMessagingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MessagingSettingRequest = new MessagingSettingRequest(...) // MessagingSetting + +// Create a messaging setting +PostMessagingSettingsRequest.postMessagingSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostMessagingSettingsRequest.postMessagingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postMessagingSupportedcontent-example.txt b/build/docs/postMessagingSupportedcontent-example.txt new file mode 100644 index 000000000..943958e47 --- /dev/null +++ b/build/docs/postMessagingSupportedcontent-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SupportedContent = new SupportedContent(...) // SupportedContent + +// Create a Supported Content profile +PostMessagingSupportedcontentRequest.postMessagingSupportedcontent(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostMessagingSupportedcontentRequest.postMessagingSupportedcontent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postMobiledevices-example.txt b/build/docs/postMobiledevices-example.txt new file mode 100644 index 000000000..b05285b18 --- /dev/null +++ b/build/docs/postMobiledevices-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserDevice = new UserDevice(...) // Device + +// Create User device +PostMobiledevicesRequest.postMobiledevices(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostMobiledevicesRequest.postMobiledevices was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postNotificationsChannelSubscriptions-example.txt b/build/docs/postNotificationsChannelSubscriptions-example.txt new file mode 100644 index 000000000..cc0f028a4 --- /dev/null +++ b/build/docs/postNotificationsChannelSubscriptions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let channelId: String = "" // Channel ID +let body: [ChannelTopic] = [new ChannelTopic(...)] // Body +let ignoreErrors: Bool = true // Optionally prevent throwing of errors for failed permissions checks. + +// Add a list of subscriptions to the existing list of subscriptions +PostNotificationsChannelSubscriptionsRequest.postNotificationsChannelSubscriptions(channelId: channelId, body: body, ignoreErrors: ignoreErrors) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostNotificationsChannelSubscriptionsRequest.postNotificationsChannelSubscriptions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postNotificationsChannels-example.txt b/build/docs/postNotificationsChannels-example.txt new file mode 100644 index 000000000..45da05800 --- /dev/null +++ b/build/docs/postNotificationsChannels-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Create a new channel +PostNotificationsChannelsRequest.postNotificationsChannels() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostNotificationsChannelsRequest.postNotificationsChannels was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOauthClientSecret-example.txt b/build/docs/postOauthClientSecret-example.txt new file mode 100644 index 000000000..8cd567ee5 --- /dev/null +++ b/build/docs/postOauthClientSecret-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID + +// Regenerate Client Secret +PostOauthClientSecretRequest.postOauthClientSecret(clientId: clientId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOauthClientSecretRequest.postOauthClientSecret was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOauthClientUsageQuery-example.txt b/build/docs/postOauthClientUsageQuery-example.txt new file mode 100644 index 000000000..5c60aac23 --- /dev/null +++ b/build/docs/postOauthClientUsageQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID +let body: ApiUsageClientQuery = new ApiUsageClientQuery(...) // Query + +// Query for OAuth client API usage +PostOauthClientUsageQueryRequest.postOauthClientUsageQuery(clientId: clientId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOauthClientUsageQueryRequest.postOauthClientUsageQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOauthClients-example.txt b/build/docs/postOauthClients-example.txt new file mode 100644 index 000000000..1f63c5a47 --- /dev/null +++ b/build/docs/postOauthClients-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OAuthClientRequest = new OAuthClientRequest(...) // Client + +// Create OAuth client +PostOauthClientsRequest.postOauthClients(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOauthClientsRequest.postOauthClients was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationPairings-example.txt b/build/docs/postOrgauthorizationPairings-example.txt new file mode 100644 index 000000000..b3ec8dcb4 --- /dev/null +++ b/build/docs/postOrgauthorizationPairings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TrustRequestCreate = new TrustRequestCreate(...) // Pairing Info + +// A pairing id is created by the trustee and given to the trustor to create a trust. +PostOrgauthorizationPairingsRequest.postOrgauthorizationPairings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationPairingsRequest.postOrgauthorizationPairings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrusteeGroups-example.txt b/build/docs/postOrgauthorizationTrusteeGroups-example.txt new file mode 100644 index 000000000..071c04385 --- /dev/null +++ b/build/docs/postOrgauthorizationTrusteeGroups-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let body: TrustMemberCreate = new TrustMemberCreate(...) // Trust + +// Add a group to the trust. +PostOrgauthorizationTrusteeGroupsRequest.postOrgauthorizationTrusteeGroups(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrusteeGroupsRequest.postOrgauthorizationTrusteeGroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrusteeUsers-example.txt b/build/docs/postOrgauthorizationTrusteeUsers-example.txt new file mode 100644 index 000000000..b8b304fe3 --- /dev/null +++ b/build/docs/postOrgauthorizationTrusteeUsers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let body: TrustMemberCreate = new TrustMemberCreate(...) // Trust + +// Add a user to the trust. +PostOrgauthorizationTrusteeUsersRequest.postOrgauthorizationTrusteeUsers(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrusteeUsersRequest.postOrgauthorizationTrusteeUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrustees-example.txt b/build/docs/postOrgauthorizationTrustees-example.txt new file mode 100644 index 000000000..fa77cea19 --- /dev/null +++ b/build/docs/postOrgauthorizationTrustees-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TrustCreate = new TrustCreate(...) // Trust + +// Create a new organization authorization trust. This is required to grant other organizations access to your organization. +PostOrgauthorizationTrusteesRequest.postOrgauthorizationTrustees(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrusteesRequest.postOrgauthorizationTrustees was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrusteesAudits-example.txt b/build/docs/postOrgauthorizationTrusteesAudits-example.txt new file mode 100644 index 000000000..01e6ccf50 --- /dev/null +++ b/build/docs/postOrgauthorizationTrusteesAudits-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TrusteeAuditQueryRequest = new TrusteeAuditQueryRequest(...) // Values to scope the request. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order + +// Get Org Trustee Audits +PostOrgauthorizationTrusteesAuditsRequest.postOrgauthorizationTrusteesAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrusteesAuditsRequest.postOrgauthorizationTrusteesAudits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrusteesDefault-example.txt b/build/docs/postOrgauthorizationTrusteesDefault-example.txt new file mode 100644 index 000000000..e8bccff2e --- /dev/null +++ b/build/docs/postOrgauthorizationTrusteesDefault-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let assignDefaultRole: Bool = true // Assign Admin role to default pairing with Customer Care +let autoExpire: Bool = true // Automatically expire pairing after 30 days + +// Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization. +PostOrgauthorizationTrusteesDefaultRequest.postOrgauthorizationTrusteesDefault(assignDefaultRole: assignDefaultRole, autoExpire: autoExpire) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrusteesDefaultRequest.postOrgauthorizationTrusteesDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOrgauthorizationTrustorAudits-example.txt b/build/docs/postOrgauthorizationTrustorAudits-example.txt new file mode 100644 index 000000000..47f8ceb4f --- /dev/null +++ b/build/docs/postOrgauthorizationTrustorAudits-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TrustorAuditQueryRequest = new TrustorAuditQueryRequest(...) // Values to scope the request. +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order + +// Get Org Trustor Audits +PostOrgauthorizationTrustorAuditsRequest.postOrgauthorizationTrustorAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOrgauthorizationTrustorAuditsRequest.postOrgauthorizationTrustorAudits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundAttemptlimits-example.txt b/build/docs/postOutboundAttemptlimits-example.txt new file mode 100644 index 000000000..72a33f71b --- /dev/null +++ b/build/docs/postOutboundAttemptlimits-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AttemptLimits = new AttemptLimits(...) // AttemptLimits + +// Create attempt limits +PostOutboundAttemptlimitsRequest.postOutboundAttemptlimits(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundAttemptlimitsRequest.postOutboundAttemptlimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundAudits-example.txt b/build/docs/postOutboundAudits-example.txt new file mode 100644 index 000000000..99c12df3c --- /dev/null +++ b/build/docs/postOutboundAudits-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DialerAuditRequest = new DialerAuditRequest(...) // AuditSearch +let pageSize: Int = 0 // Page size +let pageNumber: Int = 0 // Page number +let sortBy: String = "" // Sort by +let sortOrder: String = "" // Sort order +let facetsOnly: Bool = true // Facets only + +// Retrieves audits for dialer. +PostOutboundAuditsRequest.postOutboundAudits(body: body, pageSize: pageSize, pageNumber: pageNumber, sortBy: sortBy, sortOrder: sortOrder, facetsOnly: facetsOnly) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundAuditsRequest.postOutboundAudits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCallabletimesets-example.txt b/build/docs/postOutboundCallabletimesets-example.txt new file mode 100644 index 000000000..b3674c50c --- /dev/null +++ b/build/docs/postOutboundCallabletimesets-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CallableTimeSet = new CallableTimeSet(...) // DialerCallableTimeSet + +// Create callable time set +PostOutboundCallabletimesetsRequest.postOutboundCallabletimesets(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCallabletimesetsRequest.postOutboundCallabletimesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCallanalysisresponsesets-example.txt b/build/docs/postOutboundCallanalysisresponsesets-example.txt new file mode 100644 index 000000000..1a3d524bc --- /dev/null +++ b/build/docs/postOutboundCallanalysisresponsesets-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ResponseSet = new ResponseSet(...) // ResponseSet + +// Create a dialer call analysis response set. +PostOutboundCallanalysisresponsesetsRequest.postOutboundCallanalysisresponsesets(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCallanalysisresponsesetsRequest.postOutboundCallanalysisresponsesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCampaignAgentownedmappingpreview-example.txt b/build/docs/postOutboundCampaignAgentownedmappingpreview-example.txt new file mode 100644 index 000000000..f7d4bc1bb --- /dev/null +++ b/build/docs/postOutboundCampaignAgentownedmappingpreview-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID + +// Initiate request for a preview of how agents will be mapped to this campaign's contact list. +PostOutboundCampaignAgentownedmappingpreviewRequest.postOutboundCampaignAgentownedmappingpreview(campaignId: campaignId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCampaignAgentownedmappingpreviewRequest.postOutboundCampaignAgentownedmappingpreview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCampaignCallbackSchedule-example.txt b/build/docs/postOutboundCampaignCallbackSchedule-example.txt new file mode 100644 index 000000000..df1f288fe --- /dev/null +++ b/build/docs/postOutboundCampaignCallbackSchedule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID +let body: ContactCallbackRequest = new ContactCallbackRequest(...) // ContactCallbackRequest + +// Schedule a Callback for a Dialer Campaign (Deprecated) +PostOutboundCampaignCallbackScheduleRequest.postOutboundCampaignCallbackSchedule(campaignId: campaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCampaignCallbackScheduleRequest.postOutboundCampaignCallbackSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCampaignrules-example.txt b/build/docs/postOutboundCampaignrules-example.txt new file mode 100644 index 000000000..72309768a --- /dev/null +++ b/build/docs/postOutboundCampaignrules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CampaignRule = new CampaignRule(...) // CampaignRule + +// Create Campaign Rule +PostOutboundCampaignrulesRequest.postOutboundCampaignrules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCampaignrulesRequest.postOutboundCampaignrules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCampaigns-example.txt b/build/docs/postOutboundCampaigns-example.txt new file mode 100644 index 000000000..c80e4d303 --- /dev/null +++ b/build/docs/postOutboundCampaigns-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Campaign = new Campaign(...) // Campaign + +// Create a campaign. +PostOutboundCampaignsRequest.postOutboundCampaigns(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCampaignsRequest.postOutboundCampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundCampaignsProgress-example.txt b/build/docs/postOutboundCampaignsProgress-example.txt new file mode 100644 index 000000000..66753d1dc --- /dev/null +++ b/build/docs/postOutboundCampaignsProgress-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [String] = [""] // Campaign IDs + +// Get progress for a list of campaigns +PostOutboundCampaignsProgressRequest.postOutboundCampaignsProgress(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundCampaignsProgressRequest.postOutboundCampaignsProgress was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistClear-example.txt b/build/docs/postOutboundContactlistClear-example.txt new file mode 100644 index 000000000..f86b3be05 --- /dev/null +++ b/build/docs/postOutboundContactlistClear-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID + +// 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. +PostOutboundContactlistClearRequest.postOutboundContactlistClear(contactListId: contactListId) { (error) in + if let error = error { + dump(error) + } else { + print("PostOutboundContactlistClearRequest.postOutboundContactlistClear was successful") + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistContacts-example.txt b/build/docs/postOutboundContactlistContacts-example.txt new file mode 100644 index 000000000..f59a4950b --- /dev/null +++ b/build/docs/postOutboundContactlistContacts-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let body: [WritableDialerContact] = [new WritableDialerContact(...)] // Contact +let priority: Bool = true // Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. +let clearSystemData: Bool = true // 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. +let doNotQueue: Bool = true // 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. + +// Add contacts to a contact list. +PostOutboundContactlistContactsRequest.postOutboundContactlistContacts(contactListId: contactListId, body: body, priority: priority, clearSystemData: clearSystemData, doNotQueue: doNotQueue) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistContactsRequest.postOutboundContactlistContacts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistContactsBulk-example.txt b/build/docs/postOutboundContactlistContactsBulk-example.txt new file mode 100644 index 000000000..61ef133d0 --- /dev/null +++ b/build/docs/postOutboundContactlistContactsBulk-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let body: [String] = [""] // ContactIds to get. + +// Get contacts from a contact list. +PostOutboundContactlistContactsBulkRequest.postOutboundContactlistContactsBulk(contactListId: contactListId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistContactsBulkRequest.postOutboundContactlistContactsBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistExport-example.txt b/build/docs/postOutboundContactlistExport-example.txt new file mode 100644 index 000000000..a2f59bbd2 --- /dev/null +++ b/build/docs/postOutboundContactlistExport-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID + +// Initiate the export of a contact list. +PostOutboundContactlistExportRequest.postOutboundContactlistExport(contactListId: contactListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistExportRequest.postOutboundContactlistExport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistfilters-example.txt b/build/docs/postOutboundContactlistfilters-example.txt new file mode 100644 index 000000000..c3b86bce5 --- /dev/null +++ b/build/docs/postOutboundContactlistfilters-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ContactListFilter = new ContactListFilter(...) // ContactListFilter + +// Create Contact List Filter +PostOutboundContactlistfiltersRequest.postOutboundContactlistfilters(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistfiltersRequest.postOutboundContactlistfilters was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlistfiltersPreview-example.txt b/build/docs/postOutboundContactlistfiltersPreview-example.txt new file mode 100644 index 000000000..cdbfcd1f9 --- /dev/null +++ b/build/docs/postOutboundContactlistfiltersPreview-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ContactListFilter = new ContactListFilter(...) // ContactListFilter + +// Get a preview of the output of a contact list filter +PostOutboundContactlistfiltersPreviewRequest.postOutboundContactlistfiltersPreview(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistfiltersPreviewRequest.postOutboundContactlistfiltersPreview was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundContactlists-example.txt b/build/docs/postOutboundContactlists-example.txt new file mode 100644 index 000000000..7c919c1d4 --- /dev/null +++ b/build/docs/postOutboundContactlists-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ContactList = new ContactList(...) // ContactList + +// Create a contact List. +PostOutboundContactlistsRequest.postOutboundContactlists(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundContactlistsRequest.postOutboundContactlists was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundConversationDnc-example.txt b/build/docs/postOutboundConversationDnc-example.txt new file mode 100644 index 000000000..ca3bd2543 --- /dev/null +++ b/build/docs/postOutboundConversationDnc-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID + +// Add phone numbers to a Dialer DNC list. +PostOutboundConversationDncRequest.postOutboundConversationDnc(conversationId: conversationId) { (error) in + if let error = error { + dump(error) + } else { + print("PostOutboundConversationDncRequest.postOutboundConversationDnc was successful") + } +} \ No newline at end of file diff --git a/build/docs/postOutboundDigitalrulesets-example.txt b/build/docs/postOutboundDigitalrulesets-example.txt new file mode 100644 index 000000000..f7962816c --- /dev/null +++ b/build/docs/postOutboundDigitalrulesets-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DigitalRuleSet = new DigitalRuleSet(...) // Digital Rule Set + +// Create an Outbound Digital Rule Set +PostOutboundDigitalrulesetsRequest.postOutboundDigitalrulesets(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundDigitalrulesetsRequest.postOutboundDigitalrulesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundDnclistEmailaddresses-example.txt b/build/docs/postOutboundDnclistEmailaddresses-example.txt new file mode 100644 index 000000000..9a5fd2f3f --- /dev/null +++ b/build/docs/postOutboundDnclistEmailaddresses-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: [String] = [""] // DNC email addresses + +// Add email addresses to a DNC list. +PostOutboundDnclistEmailaddressesRequest.postOutboundDnclistEmailaddresses(dncListId: dncListId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostOutboundDnclistEmailaddressesRequest.postOutboundDnclistEmailaddresses was successful") + } +} \ No newline at end of file diff --git a/build/docs/postOutboundDnclistExport-example.txt b/build/docs/postOutboundDnclistExport-example.txt new file mode 100644 index 000000000..68c623a6d --- /dev/null +++ b/build/docs/postOutboundDnclistExport-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID + +// Initiate the export of a dnc list. +PostOutboundDnclistExportRequest.postOutboundDnclistExport(dncListId: dncListId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundDnclistExportRequest.postOutboundDnclistExport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundDnclistPhonenumbers-example.txt b/build/docs/postOutboundDnclistPhonenumbers-example.txt new file mode 100644 index 000000000..706c7701f --- /dev/null +++ b/build/docs/postOutboundDnclistPhonenumbers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: [String] = [""] // DNC Phone Numbers +let expirationDateTime: String = "" // Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format + +// Add phone numbers to a DNC list. +PostOutboundDnclistPhonenumbersRequest.postOutboundDnclistPhonenumbers(dncListId: dncListId, body: body, expirationDateTime: expirationDateTime) { (error) in + if let error = error { + dump(error) + } else { + print("PostOutboundDnclistPhonenumbersRequest.postOutboundDnclistPhonenumbers was successful") + } +} \ No newline at end of file diff --git a/build/docs/postOutboundDnclists-example.txt b/build/docs/postOutboundDnclists-example.txt new file mode 100644 index 000000000..29ca1d421 --- /dev/null +++ b/build/docs/postOutboundDnclists-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DncListCreate = new DncListCreate(...) // DncList + +// Create dialer DNC list +PostOutboundDnclistsRequest.postOutboundDnclists(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundDnclistsRequest.postOutboundDnclists was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundMessagingcampaigns-example.txt b/build/docs/postOutboundMessagingcampaigns-example.txt new file mode 100644 index 000000000..446f58362 --- /dev/null +++ b/build/docs/postOutboundMessagingcampaigns-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MessagingCampaign = new MessagingCampaign(...) // Messaging Campaign + +// Create a Messaging Campaign +PostOutboundMessagingcampaignsRequest.postOutboundMessagingcampaigns(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundMessagingcampaignsRequest.postOutboundMessagingcampaigns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundMessagingcampaignsProgress-example.txt b/build/docs/postOutboundMessagingcampaignsProgress-example.txt new file mode 100644 index 000000000..e6a685b74 --- /dev/null +++ b/build/docs/postOutboundMessagingcampaignsProgress-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [String] = [""] // Messaging Campaign IDs + +// Get progress for a list of messaging campaigns +PostOutboundMessagingcampaignsProgressRequest.postOutboundMessagingcampaignsProgress(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundMessagingcampaignsProgressRequest.postOutboundMessagingcampaignsProgress was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundRulesets-example.txt b/build/docs/postOutboundRulesets-example.txt new file mode 100644 index 000000000..fa6f8bd99 --- /dev/null +++ b/build/docs/postOutboundRulesets-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RuleSet = new RuleSet(...) // RuleSet + +// Create a Rule Set. +PostOutboundRulesetsRequest.postOutboundRulesets(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundRulesetsRequest.postOutboundRulesets was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postOutboundSequences-example.txt b/build/docs/postOutboundSequences-example.txt new file mode 100644 index 000000000..b2ae0544d --- /dev/null +++ b/build/docs/postOutboundSequences-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CampaignSequence = new CampaignSequence(...) // Organization + +// Create a new campaign sequence. +PostOutboundSequencesRequest.postOutboundSequences(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostOutboundSequencesRequest.postOutboundSequences was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postPresenceSources-example.txt b/build/docs/postPresenceSources-example.txt new file mode 100644 index 000000000..2612ae73a --- /dev/null +++ b/build/docs/postPresenceSources-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Source = new Source(...) // The Presence Source to create + +// Create a Presence Source +PostPresenceSourcesRequest.postPresenceSources(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostPresenceSourcesRequest.postPresenceSources was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postPresencedefinitions-example.txt b/build/docs/postPresencedefinitions-example.txt new file mode 100644 index 000000000..73824c690 --- /dev/null +++ b/build/docs/postPresencedefinitions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OrganizationPresence = new OrganizationPresence(...) // The Presence Definition to create + +// Create a Presence Definition +PostPresencedefinitionsRequest.postPresencedefinitions(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostPresencedefinitionsRequest.postPresencedefinitions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postProcessautomationTriggerTest-example.txt b/build/docs/postProcessautomationTriggerTest-example.txt new file mode 100644 index 000000000..b6bdda2e8 --- /dev/null +++ b/build/docs/postProcessautomationTriggerTest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let triggerId: String = "" // triggerId +let body: String = "" // eventBody + +// Test the matching of a Trigger based on provided event body +PostProcessautomationTriggerTestRequest.postProcessautomationTriggerTest(triggerId: triggerId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostProcessautomationTriggerTestRequest.postProcessautomationTriggerTest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postProcessautomationTriggers-example.txt b/build/docs/postProcessautomationTriggers-example.txt new file mode 100644 index 000000000..106b5798c --- /dev/null +++ b/build/docs/postProcessautomationTriggers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateTriggerRequest = new CreateTriggerRequest(...) // Input used to create a Trigger. + +// Create a Trigger +PostProcessautomationTriggersRequest.postProcessautomationTriggers(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostProcessautomationTriggersRequest.postProcessautomationTriggers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postProcessautomationTriggersTopicTest-example.txt b/build/docs/postProcessautomationTriggersTopicTest-example.txt new file mode 100644 index 000000000..651e4ee90 --- /dev/null +++ b/build/docs/postProcessautomationTriggersTopicTest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let topicName: String = "" // topicName +let body: String = "" // eventBody + +// Test the matching of all organization Triggers on given topic using provided event body +PostProcessautomationTriggersTopicTestRequest.postProcessautomationTriggersTopicTest(topicName: topicName, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostProcessautomationTriggersTopicTestRequest.postProcessautomationTriggersTopicTest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityCalibrations-example.txt b/build/docs/postQualityCalibrations-example.txt new file mode 100644 index 000000000..b3e28df82 --- /dev/null +++ b/build/docs/postQualityCalibrations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CalibrationCreate = new CalibrationCreate(...) // calibration +let expand: String = "" // calibratorId + +// Create a calibration +PostQualityCalibrationsRequest.postQualityCalibrations(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityCalibrationsRequest.postQualityCalibrations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityConversationEvaluations-example.txt b/build/docs/postQualityConversationEvaluations-example.txt new file mode 100644 index 000000000..a48fcea8b --- /dev/null +++ b/build/docs/postQualityConversationEvaluations-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: Evaluation = new Evaluation(...) // evaluation +let expand: String = "" // evaluatorId + +// Create an evaluation +PostQualityConversationEvaluationsRequest.postQualityConversationEvaluations(conversationId: conversationId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityConversationEvaluationsRequest.postQualityConversationEvaluations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityConversationsAuditsQuery-example.txt b/build/docs/postQualityConversationsAuditsQuery-example.txt new file mode 100644 index 000000000..3d92f9fa4 --- /dev/null +++ b/build/docs/postQualityConversationsAuditsQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: QMAuditQueryRequest = new QMAuditQueryRequest(...) // query + +// Create audit query execution +PostQualityConversationsAuditsQueryRequest.postQualityConversationsAuditsQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityConversationsAuditsQueryRequest.postQualityConversationsAuditsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityEvaluationsAggregatesQueryMe-example.txt b/build/docs/postQualityEvaluationsAggregatesQueryMe-example.txt new file mode 100644 index 000000000..9f629b31b --- /dev/null +++ b/build/docs/postQualityEvaluationsAggregatesQueryMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EvaluationAggregationQueryMe = new EvaluationAggregationQueryMe(...) // query + +// Query for evaluation aggregates for the current user +PostQualityEvaluationsAggregatesQueryMeRequest.postQualityEvaluationsAggregatesQueryMe(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityEvaluationsAggregatesQueryMeRequest.postQualityEvaluationsAggregatesQueryMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityEvaluationsScoring-example.txt b/build/docs/postQualityEvaluationsScoring-example.txt new file mode 100644 index 000000000..f780b1369 --- /dev/null +++ b/build/docs/postQualityEvaluationsScoring-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EvaluationFormAndScoringSet = new EvaluationFormAndScoringSet(...) // evaluationAndScoringSet + +// Score evaluation +PostQualityEvaluationsScoringRequest.postQualityEvaluationsScoring(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityEvaluationsScoringRequest.postQualityEvaluationsScoring was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityForms-example.txt b/build/docs/postQualityForms-example.txt new file mode 100644 index 000000000..a2bc960ec --- /dev/null +++ b/build/docs/postQualityForms-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EvaluationForm = new EvaluationForm(...) // Evaluation form + +// Create an evaluation form. +PostQualityFormsRequest.postQualityForms(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityFormsRequest.postQualityForms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityFormsEvaluations-example.txt b/build/docs/postQualityFormsEvaluations-example.txt new file mode 100644 index 000000000..1f518beda --- /dev/null +++ b/build/docs/postQualityFormsEvaluations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EvaluationForm = new EvaluationForm(...) // Evaluation form + +// Create an evaluation form. +PostQualityFormsEvaluationsRequest.postQualityFormsEvaluations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityFormsEvaluationsRequest.postQualityFormsEvaluations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityFormsSurveys-example.txt b/build/docs/postQualityFormsSurveys-example.txt new file mode 100644 index 000000000..af6872e28 --- /dev/null +++ b/build/docs/postQualityFormsSurveys-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SurveyForm = new SurveyForm(...) // Survey form + +// Create a survey form. +PostQualityFormsSurveysRequest.postQualityFormsSurveys(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityFormsSurveysRequest.postQualityFormsSurveys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityPublishedforms-example.txt b/build/docs/postQualityPublishedforms-example.txt new file mode 100644 index 000000000..04e1b47e4 --- /dev/null +++ b/build/docs/postQualityPublishedforms-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PublishForm = new PublishForm(...) // Publish request containing id of form to publish + +// Publish an evaluation form. +PostQualityPublishedformsRequest.postQualityPublishedforms(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityPublishedformsRequest.postQualityPublishedforms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityPublishedformsEvaluations-example.txt b/build/docs/postQualityPublishedformsEvaluations-example.txt new file mode 100644 index 000000000..377b9c5ca --- /dev/null +++ b/build/docs/postQualityPublishedformsEvaluations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PublishForm = new PublishForm(...) // Publish request containing id of form to publish + +// Publish an evaluation form. +PostQualityPublishedformsEvaluationsRequest.postQualityPublishedformsEvaluations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityPublishedformsEvaluationsRequest.postQualityPublishedformsEvaluations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualityPublishedformsSurveys-example.txt b/build/docs/postQualityPublishedformsSurveys-example.txt new file mode 100644 index 000000000..7d402e1c6 --- /dev/null +++ b/build/docs/postQualityPublishedformsSurveys-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PublishForm = new PublishForm(...) // Survey form + +// Publish a survey form. +PostQualityPublishedformsSurveysRequest.postQualityPublishedformsSurveys(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualityPublishedformsSurveysRequest.postQualityPublishedformsSurveys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postQualitySurveysScoring-example.txt b/build/docs/postQualitySurveysScoring-example.txt new file mode 100644 index 000000000..fe23a292f --- /dev/null +++ b/build/docs/postQualitySurveysScoring-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SurveyFormAndScoringSet = new SurveyFormAndScoringSet(...) // surveyAndScoringSet + +// Score survey +PostQualitySurveysScoringRequest.postQualitySurveysScoring(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostQualitySurveysScoringRequest.postQualitySurveysScoring was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingBatchrequests-example.txt b/build/docs/postRecordingBatchrequests-example.txt new file mode 100644 index 000000000..073a1b62c --- /dev/null +++ b/build/docs/postRecordingBatchrequests-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BatchDownloadJobSubmission = new BatchDownloadJobSubmission(...) // Job submission criteria + +// Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. +PostRecordingBatchrequestsRequest.postRecordingBatchrequests(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingBatchrequestsRequest.postRecordingBatchrequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingCrossplatformMediaretentionpolicies-example.txt b/build/docs/postRecordingCrossplatformMediaretentionpolicies-example.txt new file mode 100644 index 000000000..13d73f339 --- /dev/null +++ b/build/docs/postRecordingCrossplatformMediaretentionpolicies-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CrossPlatformPolicyCreate = new CrossPlatformPolicyCreate(...) // Policy + +// Create media retention policy +PostRecordingCrossplatformMediaretentionpoliciesRequest.postRecordingCrossplatformMediaretentionpolicies(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingCrossplatformMediaretentionpoliciesRequest.postRecordingCrossplatformMediaretentionpolicies was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingJobs-example.txt b/build/docs/postRecordingJobs-example.txt new file mode 100644 index 000000000..f2ae853b6 --- /dev/null +++ b/build/docs/postRecordingJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RecordingJobsQuery = new RecordingJobsQuery(...) // query + +// Create a recording bulk job. +PostRecordingJobsRequest.postRecordingJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingJobsRequest.postRecordingJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingKeyconfigurations-example.txt b/build/docs/postRecordingKeyconfigurations-example.txt new file mode 100644 index 000000000..584e160d4 --- /dev/null +++ b/build/docs/postRecordingKeyconfigurations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption Configuration + +// Setup configurations for encryption key creation +PostRecordingKeyconfigurationsRequest.postRecordingKeyconfigurations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingKeyconfigurationsRequest.postRecordingKeyconfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingKeyconfigurationsValidate-example.txt b/build/docs/postRecordingKeyconfigurationsValidate-example.txt new file mode 100644 index 000000000..f1db064af --- /dev/null +++ b/build/docs/postRecordingKeyconfigurationsValidate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption Configuration + +// Validate encryption key configurations without saving it +PostRecordingKeyconfigurationsValidateRequest.postRecordingKeyconfigurationsValidate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingKeyconfigurationsValidateRequest.postRecordingKeyconfigurationsValidate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingLocalkeys-example.txt b/build/docs/postRecordingLocalkeys-example.txt new file mode 100644 index 000000000..4da335efb --- /dev/null +++ b/build/docs/postRecordingLocalkeys-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LocalEncryptionKeyRequest = new LocalEncryptionKeyRequest(...) // Local Encryption body + +// create a local key management recording key +PostRecordingLocalkeysRequest.postRecordingLocalkeys(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingLocalkeysRequest.postRecordingLocalkeys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingMediaretentionpolicies-example.txt b/build/docs/postRecordingMediaretentionpolicies-example.txt new file mode 100644 index 000000000..92a3daa36 --- /dev/null +++ b/build/docs/postRecordingMediaretentionpolicies-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PolicyCreate = new PolicyCreate(...) // Policy + +// Create media retention policy +PostRecordingMediaretentionpoliciesRequest.postRecordingMediaretentionpolicies(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingMediaretentionpoliciesRequest.postRecordingMediaretentionpolicies was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingRecordingkeys-example.txt b/build/docs/postRecordingRecordingkeys-example.txt new file mode 100644 index 000000000..304957f46 --- /dev/null +++ b/build/docs/postRecordingRecordingkeys-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Create encryption key +PostRecordingRecordingkeysRequest.postRecordingRecordingkeys() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingRecordingkeysRequest.postRecordingRecordingkeys was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingUploadsReports-example.txt b/build/docs/postRecordingUploadsReports-example.txt new file mode 100644 index 000000000..44419160e --- /dev/null +++ b/build/docs/postRecordingUploadsReports-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RecordingUploadReportRequest = new RecordingUploadReportRequest(...) // Report parameters + +// Creates a recording upload status report +PostRecordingUploadsReportsRequest.postRecordingUploadsReports(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingUploadsReportsRequest.postRecordingUploadsReports was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingsDeletionprotection-example.txt b/build/docs/postRecordingsDeletionprotection-example.txt new file mode 100644 index 000000000..efe1fd55c --- /dev/null +++ b/build/docs/postRecordingsDeletionprotection-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationDeletionProtectionQuery = new ConversationDeletionProtectionQuery(...) // conversationIds + +// Get a list of conversations with protected recordings +PostRecordingsDeletionprotectionRequest.postRecordingsDeletionprotection(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRecordingsDeletionprotectionRequest.postRecordingsDeletionprotection was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRecordingsScreensessionsAcknowledge-example.txt b/build/docs/postRecordingsScreensessionsAcknowledge-example.txt new file mode 100644 index 000000000..0f4ed35cb --- /dev/null +++ b/build/docs/postRecordingsScreensessionsAcknowledge-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AcknowledgeScreenRecordingRequest = new AcknowledgeScreenRecordingRequest(...) // AcknowledgeScreenRecordingRequest + +// Acknowledge a screen recording. +PostRecordingsScreensessionsAcknowledgeRequest.postRecordingsScreensessionsAcknowledge(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostRecordingsScreensessionsAcknowledgeRequest.postRecordingsScreensessionsAcknowledge was successful") + } +} \ No newline at end of file diff --git a/build/docs/postRecordingsScreensessionsMetadata-example.txt b/build/docs/postRecordingsScreensessionsMetadata-example.txt new file mode 100644 index 000000000..5a6a3316b --- /dev/null +++ b/build/docs/postRecordingsScreensessionsMetadata-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ScreenRecordingMetaDataRequest = new ScreenRecordingMetaDataRequest(...) // ScreenRecordingMetaDataRequest + +// Provide meta-data a screen recording. +PostRecordingsScreensessionsMetadataRequest.postRecordingsScreensessionsMetadata(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostRecordingsScreensessionsMetadataRequest.postRecordingsScreensessionsMetadata was successful") + } +} \ No newline at end of file diff --git a/build/docs/postResponsemanagementLibraries-example.txt b/build/docs/postResponsemanagementLibraries-example.txt new file mode 100644 index 000000000..b87178b44 --- /dev/null +++ b/build/docs/postResponsemanagementLibraries-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Library = new Library(...) // Library + +// Create a response library. +PostResponsemanagementLibrariesRequest.postResponsemanagementLibraries(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostResponsemanagementLibrariesRequest.postResponsemanagementLibraries was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postResponsemanagementResponseassetsSearch-example.txt b/build/docs/postResponsemanagementResponseassetsSearch-example.txt new file mode 100644 index 000000000..b5d3318d5 --- /dev/null +++ b/build/docs/postResponsemanagementResponseassetsSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ResponseAssetSearchRequest = new ResponseAssetSearchRequest(...) // request +let expand: [String] = [""] // Which fields, if any, to expand + +// Search response assets +PostResponsemanagementResponseassetsSearchRequest.postResponsemanagementResponseassetsSearch(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostResponsemanagementResponseassetsSearchRequest.postResponsemanagementResponseassetsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postResponsemanagementResponseassetsUploads-example.txt b/build/docs/postResponsemanagementResponseassetsUploads-example.txt new file mode 100644 index 000000000..4a3882242 --- /dev/null +++ b/build/docs/postResponsemanagementResponseassetsUploads-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateResponseAssetRequest = new CreateResponseAssetRequest(...) // request + +// Creates pre-signed url for uploading response asset +PostResponsemanagementResponseassetsUploadsRequest.postResponsemanagementResponseassetsUploads(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostResponsemanagementResponseassetsUploadsRequest.postResponsemanagementResponseassetsUploads was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postResponsemanagementResponses-example.txt b/build/docs/postResponsemanagementResponses-example.txt new file mode 100644 index 000000000..d95752a22 --- /dev/null +++ b/build/docs/postResponsemanagementResponses-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ModelResponse = new ModelResponse(...) // Response +let expand: PostResponsemanagementResponsesRequest.Expand_postResponsemanagementResponses = PostResponsemanagementResponsesRequest.Expand_postResponsemanagementResponses.enummember // Expand instructions for the return value. + +// Create a response. +PostResponsemanagementResponsesRequest.postResponsemanagementResponses(body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostResponsemanagementResponsesRequest.postResponsemanagementResponses was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postResponsemanagementResponsesQuery-example.txt b/build/docs/postResponsemanagementResponsesQuery-example.txt new file mode 100644 index 000000000..7beb175bb --- /dev/null +++ b/build/docs/postResponsemanagementResponsesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ResponseQueryRequest = new ResponseQueryRequest(...) // Response + +// Query responses +PostResponsemanagementResponsesQueryRequest.postResponsemanagementResponsesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostResponsemanagementResponsesQueryRequest.postResponsemanagementResponsesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingAssessments-example.txt b/build/docs/postRoutingAssessments-example.txt new file mode 100644 index 000000000..628963abf --- /dev/null +++ b/build/docs/postRoutingAssessments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateBenefitAssessmentRequest = new CreateBenefitAssessmentRequest(...) // + +// Create a benefit assessment. +PostRoutingAssessmentsRequest.postRoutingAssessments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingAssessmentsRequest.postRoutingAssessments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingAssessmentsJobs-example.txt b/build/docs/postRoutingAssessmentsJobs-example.txt new file mode 100644 index 000000000..b09a0286a --- /dev/null +++ b/build/docs/postRoutingAssessmentsJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateBenefitAssessmentJobRequest = new CreateBenefitAssessmentJobRequest(...) // + +// Create a benefit assessment job. +PostRoutingAssessmentsJobsRequest.postRoutingAssessmentsJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingAssessmentsJobsRequest.postRoutingAssessmentsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingEmailDomainRoutes-example.txt b/build/docs/postRoutingEmailDomainRoutes-example.txt new file mode 100644 index 000000000..c0eff6fa7 --- /dev/null +++ b/build/docs/postRoutingEmailDomainRoutes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainName: String = "" // email domain +let body: InboundRoute = new InboundRoute(...) // Route + +// Create a route +PostRoutingEmailDomainRoutesRequest.postRoutingEmailDomainRoutes(domainName: domainName, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingEmailDomainRoutesRequest.postRoutingEmailDomainRoutes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingEmailDomainTestconnection-example.txt b/build/docs/postRoutingEmailDomainTestconnection-example.txt new file mode 100644 index 000000000..400ecbed8 --- /dev/null +++ b/build/docs/postRoutingEmailDomainTestconnection-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID +let body: TestMessage = new TestMessage(...) // TestMessage + +// Tests the custom SMTP server integration connection set on this domain +PostRoutingEmailDomainTestconnectionRequest.postRoutingEmailDomainTestconnection(domainId: domainId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingEmailDomainTestconnectionRequest.postRoutingEmailDomainTestconnection was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingEmailDomains-example.txt b/build/docs/postRoutingEmailDomains-example.txt new file mode 100644 index 000000000..d467c4b24 --- /dev/null +++ b/build/docs/postRoutingEmailDomains-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: InboundDomain = new InboundDomain(...) // Domain + +// Create a domain +PostRoutingEmailDomainsRequest.postRoutingEmailDomains(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingEmailDomainsRequest.postRoutingEmailDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingEmailOutboundDomains-example.txt b/build/docs/postRoutingEmailOutboundDomains-example.txt new file mode 100644 index 000000000..bdb1fdebc --- /dev/null +++ b/build/docs/postRoutingEmailOutboundDomains-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OutboundDomain = new OutboundDomain(...) // Domain + +// Create a domain +PostRoutingEmailOutboundDomainsRequest.postRoutingEmailOutboundDomains(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingEmailOutboundDomainsRequest.postRoutingEmailOutboundDomains was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingEmailOutboundDomainsSimulated-example.txt b/build/docs/postRoutingEmailOutboundDomainsSimulated-example.txt new file mode 100644 index 000000000..8f1bd413b --- /dev/null +++ b/build/docs/postRoutingEmailOutboundDomainsSimulated-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OutboundDomain = new OutboundDomain(...) // Domain + +// Create a simulated domain +PostRoutingEmailOutboundDomainsSimulatedRequest.postRoutingEmailOutboundDomainsSimulated(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingEmailOutboundDomainsSimulatedRequest.postRoutingEmailOutboundDomainsSimulated was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingLanguages-example.txt b/build/docs/postRoutingLanguages-example.txt new file mode 100644 index 000000000..3483d5ffb --- /dev/null +++ b/build/docs/postRoutingLanguages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Language = new Language(...) // Language + +// Create Language +PostRoutingLanguagesRequest.postRoutingLanguages(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingLanguagesRequest.postRoutingLanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingPredictors-example.txt b/build/docs/postRoutingPredictors-example.txt new file mode 100644 index 000000000..24d1f2fee --- /dev/null +++ b/build/docs/postRoutingPredictors-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreatePredictorRequest = new CreatePredictorRequest(...) // + +// Create a predictor. +PostRoutingPredictorsRequest.postRoutingPredictors(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingPredictorsRequest.postRoutingPredictors was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingQueueMembers-example.txt b/build/docs/postRoutingQueueMembers-example.txt new file mode 100644 index 000000000..b66135e88 --- /dev/null +++ b/build/docs/postRoutingQueueMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: [WritableEntity] = [new WritableEntity(...)] // Queue Members +let delete: Bool = true // True to delete queue members + +// Bulk add or delete up to 100 queue members +PostRoutingQueueMembersRequest.postRoutingQueueMembers(queueId: queueId, body: body, delete: delete) { (error) in + if let error = error { + dump(error) + } else { + print("PostRoutingQueueMembersRequest.postRoutingQueueMembers was successful") + } +} \ No newline at end of file diff --git a/build/docs/postRoutingQueueUsers-example.txt b/build/docs/postRoutingQueueUsers-example.txt new file mode 100644 index 000000000..d8b74cd52 --- /dev/null +++ b/build/docs/postRoutingQueueUsers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: [WritableEntity] = [new WritableEntity(...)] // Queue Members +let delete: Bool = true // True to delete queue members + +// DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members. +PostRoutingQueueUsersRequest.postRoutingQueueUsers(queueId: queueId, body: body, delete: delete) { (error) in + if let error = error { + dump(error) + } else { + print("PostRoutingQueueUsersRequest.postRoutingQueueUsers was successful") + } +} \ No newline at end of file diff --git a/build/docs/postRoutingQueueWrapupcodes-example.txt b/build/docs/postRoutingQueueWrapupcodes-example.txt new file mode 100644 index 000000000..4b6bc9d3e --- /dev/null +++ b/build/docs/postRoutingQueueWrapupcodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: [WrapUpCodeReference] = [new WrapUpCodeReference(...)] // List of wrapup codes + +// Add up to 100 wrap-up codes to a queue +PostRoutingQueueWrapupcodesRequest.postRoutingQueueWrapupcodes(queueId: queueId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingQueueWrapupcodesRequest.postRoutingQueueWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingQueues-example.txt b/build/docs/postRoutingQueues-example.txt new file mode 100644 index 000000000..eea4737f9 --- /dev/null +++ b/build/docs/postRoutingQueues-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateQueueRequest = new CreateQueueRequest(...) // Queue + +// Create a queue +PostRoutingQueuesRequest.postRoutingQueues(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingQueuesRequest.postRoutingQueues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingSkillgroupMembersDivisions-example.txt b/build/docs/postRoutingSkillgroupMembersDivisions-example.txt new file mode 100644 index 000000000..362e92446 --- /dev/null +++ b/build/docs/postRoutingSkillgroupMembersDivisions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let skillGroupId: String = "" // Skill Group ID +let body: SkillGroupMemberDivisions = new SkillGroupMemberDivisions(...) // + +// Add or remove member divisions for this skill group. +PostRoutingSkillgroupMembersDivisionsRequest.postRoutingSkillgroupMembersDivisions(skillGroupId: skillGroupId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostRoutingSkillgroupMembersDivisionsRequest.postRoutingSkillgroupMembersDivisions was successful") + } +} \ No newline at end of file diff --git a/build/docs/postRoutingSkillgroups-example.txt b/build/docs/postRoutingSkillgroups-example.txt new file mode 100644 index 000000000..360689d22 --- /dev/null +++ b/build/docs/postRoutingSkillgroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SkillGroupWithMemberDivisions = new SkillGroupWithMemberDivisions(...) // Create skill group + +// Create a skill group +PostRoutingSkillgroupsRequest.postRoutingSkillgroups(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingSkillgroupsRequest.postRoutingSkillgroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingSkills-example.txt b/build/docs/postRoutingSkills-example.txt new file mode 100644 index 000000000..ca70c7d64 --- /dev/null +++ b/build/docs/postRoutingSkills-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RoutingSkill = new RoutingSkill(...) // Skill + +// Create Skill +PostRoutingSkillsRequest.postRoutingSkills(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingSkillsRequest.postRoutingSkills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingSmsAddresses-example.txt b/build/docs/postRoutingSmsAddresses-example.txt new file mode 100644 index 000000000..ccf078427 --- /dev/null +++ b/build/docs/postRoutingSmsAddresses-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SmsAddressProvision = new SmsAddressProvision(...) // SmsAddress + +// Provision an Address for SMS +PostRoutingSmsAddressesRequest.postRoutingSmsAddresses(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingSmsAddressesRequest.postRoutingSmsAddresses was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingSmsPhonenumbers-example.txt b/build/docs/postRoutingSmsPhonenumbers-example.txt new file mode 100644 index 000000000..1c77a19fb --- /dev/null +++ b/build/docs/postRoutingSmsPhonenumbers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SmsPhoneNumberProvision = new SmsPhoneNumberProvision(...) // SmsPhoneNumber + +// Provision a phone number for SMS +PostRoutingSmsPhonenumbersRequest.postRoutingSmsPhonenumbers(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingSmsPhonenumbersRequest.postRoutingSmsPhonenumbers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postRoutingWrapupcodes-example.txt b/build/docs/postRoutingWrapupcodes-example.txt new file mode 100644 index 000000000..7faffa787 --- /dev/null +++ b/build/docs/postRoutingWrapupcodes-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WrapupCodeRequest = new WrapupCodeRequest(...) // WrapupCode + +// Create a wrap-up code +PostRoutingWrapupcodesRequest.postRoutingWrapupcodes(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostRoutingWrapupcodesRequest.postRoutingWrapupcodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postScimUsers-example.txt b/build/docs/postScimUsers-example.txt new file mode 100644 index 000000000..d40274a83 --- /dev/null +++ b/build/docs/postScimUsers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ScimV2CreateUser = new ScimV2CreateUser(...) // The information used to create a user. + +// Create a user +PostScimUsersRequest.postScimUsers(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostScimUsersRequest.postScimUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postScimV2Users-example.txt b/build/docs/postScimV2Users-example.txt new file mode 100644 index 000000000..c95290579 --- /dev/null +++ b/build/docs/postScimV2Users-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ScimV2CreateUser = new ScimV2CreateUser(...) // The information used to create a user. + +// Create a user +PostScimV2UsersRequest.postScimV2Users(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostScimV2UsersRequest.postScimV2Users was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postScriptExport-example.txt b/build/docs/postScriptExport-example.txt new file mode 100644 index 000000000..b484a33be --- /dev/null +++ b/build/docs/postScriptExport-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptId: String = "" // Script ID +let body: ExportScriptRequest = new ExportScriptRequest(...) // + +// Export a script via download service. +PostScriptExportRequest.postScriptExport(scriptId: scriptId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostScriptExportRequest.postScriptExport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postScriptsPublished-example.txt b/build/docs/postScriptsPublished-example.txt new file mode 100644 index 000000000..feb69394e --- /dev/null +++ b/build/docs/postScriptsPublished-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scriptDataVersion: String = "" // Advanced usage - controls the data version of the script +let body: PublishScriptRequestData = new PublishScriptRequestData(...) // body + +// Publish a script. +PostScriptsPublishedRequest.postScriptsPublished(scriptDataVersion: scriptDataVersion, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostScriptsPublishedRequest.postScriptsPublished was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSearch-example.txt b/build/docs/postSearch-example.txt new file mode 100644 index 000000000..cd1ec26e6 --- /dev/null +++ b/build/docs/postSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SearchRequest = new SearchRequest(...) // Search request options +let profile: Bool = true // profile + +// Search resources. +PostSearchRequest.postSearch(body: body, profile: profile) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSearchRequest.postSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSearchSuggest-example.txt b/build/docs/postSearchSuggest-example.txt new file mode 100644 index 000000000..db0ca5b11 --- /dev/null +++ b/build/docs/postSearchSuggest-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SuggestSearchRequest = new SuggestSearchRequest(...) // Search request options +let profile: Bool = true // profile + +// Suggest resources. +PostSearchSuggestRequest.postSearchSuggest(body: body, profile: profile) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSearchSuggestRequest.postSearchSuggest was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsDictionaryfeedback-example.txt b/build/docs/postSpeechandtextanalyticsDictionaryfeedback-example.txt new file mode 100644 index 000000000..ff004f56c --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsDictionaryfeedback-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DictionaryFeedback = new DictionaryFeedback(...) // The DictionaryFeedback to create + +// Create a Speech & Text Analytics DictionaryFeedback +PostSpeechandtextanalyticsDictionaryfeedbackRequest.postSpeechandtextanalyticsDictionaryfeedback(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsDictionaryfeedbackRequest.postSpeechandtextanalyticsDictionaryfeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsPrograms-example.txt b/build/docs/postSpeechandtextanalyticsPrograms-example.txt new file mode 100644 index 000000000..6cbb62386 --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsPrograms-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ProgramRequest = new ProgramRequest(...) // The program to create + +// Create new Speech & Text Analytics program +PostSpeechandtextanalyticsProgramsRequest.postSpeechandtextanalyticsPrograms(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsProgramsRequest.postSpeechandtextanalyticsPrograms was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsProgramsGeneralJobs-example.txt b/build/docs/postSpeechandtextanalyticsProgramsGeneralJobs-example.txt new file mode 100644 index 000000000..16a148dde --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsProgramsGeneralJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GeneralProgramJobRequest = new GeneralProgramJobRequest(...) // The general programs job to create + +// Create new Speech & Text Analytics general program job +PostSpeechandtextanalyticsProgramsGeneralJobsRequest.postSpeechandtextanalyticsProgramsGeneralJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsProgramsGeneralJobsRequest.postSpeechandtextanalyticsProgramsGeneralJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsProgramsPublishjobs-example.txt b/build/docs/postSpeechandtextanalyticsProgramsPublishjobs-example.txt new file mode 100644 index 000000000..297c55bbf --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsProgramsPublishjobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ProgramJobRequest = new ProgramJobRequest(...) // The publish programs job to create + +// Create new Speech & Text Analytics publish programs job +PostSpeechandtextanalyticsProgramsPublishjobsRequest.postSpeechandtextanalyticsProgramsPublishjobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsProgramsPublishjobsRequest.postSpeechandtextanalyticsProgramsPublishjobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsSentimentfeedback-example.txt b/build/docs/postSpeechandtextanalyticsSentimentfeedback-example.txt new file mode 100644 index 000000000..c059b0eb1 --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsSentimentfeedback-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SentimentFeedback = new SentimentFeedback(...) // The SentimentFeedback to create + +// Create a Speech & Text Analytics SentimentFeedback +PostSpeechandtextanalyticsSentimentfeedbackRequest.postSpeechandtextanalyticsSentimentfeedback(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsSentimentfeedbackRequest.postSpeechandtextanalyticsSentimentfeedback was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsTopics-example.txt b/build/docs/postSpeechandtextanalyticsTopics-example.txt new file mode 100644 index 000000000..9e39b4d29 --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsTopics-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TopicRequest = new TopicRequest(...) // The topic to create + +// Create new Speech & Text Analytics topic +PostSpeechandtextanalyticsTopicsRequest.postSpeechandtextanalyticsTopics(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsTopicsRequest.postSpeechandtextanalyticsTopics was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsTopicsPublishjobs-example.txt b/build/docs/postSpeechandtextanalyticsTopicsPublishjobs-example.txt new file mode 100644 index 000000000..25ded5720 --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsTopicsPublishjobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TopicJobRequest = new TopicJobRequest(...) // The publish topics job to create + +// Create new Speech & Text Analytics publish topics job +PostSpeechandtextanalyticsTopicsPublishjobsRequest.postSpeechandtextanalyticsTopicsPublishjobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsTopicsPublishjobsRequest.postSpeechandtextanalyticsTopicsPublishjobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postSpeechandtextanalyticsTranscriptsSearch-example.txt b/build/docs/postSpeechandtextanalyticsTranscriptsSearch-example.txt new file mode 100644 index 000000000..7817cb1cc --- /dev/null +++ b/build/docs/postSpeechandtextanalyticsTranscriptsSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TranscriptSearchRequest = new TranscriptSearchRequest(...) // Search request options + +// Search resources. +PostSpeechandtextanalyticsTranscriptsSearchRequest.postSpeechandtextanalyticsTranscriptsSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostSpeechandtextanalyticsTranscriptsSearchRequest.postSpeechandtextanalyticsTranscriptsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTeamMembers-example.txt b/build/docs/postTeamMembers-example.txt new file mode 100644 index 000000000..eba1c20f1 --- /dev/null +++ b/build/docs/postTeamMembers-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // Team ID +let body: TeamMembers = new TeamMembers(...) // TeamMembers + +// Add team members +PostTeamMembersRequest.postTeamMembers(teamId: teamId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTeamMembersRequest.postTeamMembers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTeams-example.txt b/build/docs/postTeams-example.txt new file mode 100644 index 000000000..a078d5da6 --- /dev/null +++ b/build/docs/postTeams-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Team = new Team(...) // Team + +// Create a team +PostTeamsRequest.postTeams(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTeamsRequest.postTeams was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTeamsSearch-example.txt b/build/docs/postTeamsSearch-example.txt new file mode 100644 index 000000000..88e331de8 --- /dev/null +++ b/build/docs/postTeamsSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TeamSearchRequest = new TeamSearchRequest(...) // Search request options + +// Search resources. +PostTeamsSearchRequest.postTeamsSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTeamsSearchRequest.postTeamsSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeDiagnosticNslookup-example.txt b/build/docs/postTelephonyProvidersEdgeDiagnosticNslookup-example.txt new file mode 100644 index 000000000..d06c8f60b --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeDiagnosticNslookup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id +let body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic + +// Nslookup request command to collect networking-related information from an Edge for a target IP or host. +PostTelephonyProvidersEdgeDiagnosticNslookupRequest.postTelephonyProvidersEdgeDiagnosticNslookup(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeDiagnosticNslookupRequest.postTelephonyProvidersEdgeDiagnosticNslookup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeDiagnosticPing-example.txt b/build/docs/postTelephonyProvidersEdgeDiagnosticPing-example.txt new file mode 100644 index 000000000..f5a2ed621 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeDiagnosticPing-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id +let body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic + +// Ping Request command to collect networking-related information from an Edge for a target IP or host. +PostTelephonyProvidersEdgeDiagnosticPingRequest.postTelephonyProvidersEdgeDiagnosticPing(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeDiagnosticPingRequest.postTelephonyProvidersEdgeDiagnosticPing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeDiagnosticRoute-example.txt b/build/docs/postTelephonyProvidersEdgeDiagnosticRoute-example.txt new file mode 100644 index 000000000..3634d479e --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeDiagnosticRoute-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id +let body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic + +// Route request command to collect networking-related information from an Edge for a target IP or host. +PostTelephonyProvidersEdgeDiagnosticRouteRequest.postTelephonyProvidersEdgeDiagnosticRoute(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeDiagnosticRouteRequest.postTelephonyProvidersEdgeDiagnosticRoute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeDiagnosticTracepath-example.txt b/build/docs/postTelephonyProvidersEdgeDiagnosticTracepath-example.txt new file mode 100644 index 000000000..1a2ff3571 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeDiagnosticTracepath-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id +let body: EdgeNetworkDiagnosticRequest = new EdgeNetworkDiagnosticRequest(...) // request payload to get network diagnostic + +// Tracepath request command to collect networking-related information from an Edge for a target IP or host. +PostTelephonyProvidersEdgeDiagnosticTracepathRequest.postTelephonyProvidersEdgeDiagnosticTracepath(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeDiagnosticTracepathRequest.postTelephonyProvidersEdgeDiagnosticTracepath was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeLogicalinterfaces-example.txt b/build/docs/postTelephonyProvidersEdgeLogicalinterfaces-example.txt new file mode 100644 index 000000000..5db890a0b --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeLogicalinterfaces-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: DomainLogicalInterface = new DomainLogicalInterface(...) // Logical interface + +// Create an edge logical interface. +PostTelephonyProvidersEdgeLogicalinterfacesRequest.postTelephonyProvidersEdgeLogicalinterfaces(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeLogicalinterfacesRequest.postTelephonyProvidersEdgeLogicalinterfaces was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeLogsJobUpload-example.txt b/build/docs/postTelephonyProvidersEdgeLogsJobUpload-example.txt new file mode 100644 index 000000000..cc80b8e64 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeLogsJobUpload-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let jobId: String = "" // Job ID +let body: EdgeLogsJobUploadRequest = new EdgeLogsJobUploadRequest(...) // Log upload request + +// Request that the specified fileIds be uploaded from the Edge. +PostTelephonyProvidersEdgeLogsJobUploadRequest.postTelephonyProvidersEdgeLogsJobUpload(edgeId: edgeId, jobId: jobId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostTelephonyProvidersEdgeLogsJobUploadRequest.postTelephonyProvidersEdgeLogsJobUpload was successful") + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeLogsJobs-example.txt b/build/docs/postTelephonyProvidersEdgeLogsJobs-example.txt new file mode 100644 index 000000000..5403d3b92 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeLogsJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: EdgeLogsJobRequest = new EdgeLogsJobRequest(...) // EdgeLogsJobRequest + +// Create a job to upload a list of Edge logs. +PostTelephonyProvidersEdgeLogsJobsRequest.postTelephonyProvidersEdgeLogsJobs(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeLogsJobsRequest.postTelephonyProvidersEdgeLogsJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeReboot-example.txt b/build/docs/postTelephonyProvidersEdgeReboot-example.txt new file mode 100644 index 000000000..126bc49b8 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeReboot-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: EdgeRebootParameters = new EdgeRebootParameters(...) // Parameters for the edge reboot + +// Reboot an Edge +PostTelephonyProvidersEdgeRebootRequest.postTelephonyProvidersEdgeReboot(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeRebootRequest.postTelephonyProvidersEdgeReboot was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeSoftwareupdate-example.txt b/build/docs/postTelephonyProvidersEdgeSoftwareupdate-example.txt new file mode 100644 index 000000000..86f9232c3 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeSoftwareupdate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: DomainEdgeSoftwareUpdateDto = new DomainEdgeSoftwareUpdateDto(...) // Software update request + +// Starts a software update for this edge. +PostTelephonyProvidersEdgeSoftwareupdateRequest.postTelephonyProvidersEdgeSoftwareupdate(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeSoftwareupdateRequest.postTelephonyProvidersEdgeSoftwareupdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeStatuscode-example.txt b/build/docs/postTelephonyProvidersEdgeStatuscode-example.txt new file mode 100644 index 000000000..cc4b90503 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeStatuscode-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: EdgeServiceStateRequest = new EdgeServiceStateRequest(...) // Edge Service State + +// Take an Edge in or out of service +PostTelephonyProvidersEdgeStatuscodeRequest.postTelephonyProvidersEdgeStatuscode(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeStatuscodeRequest.postTelephonyProvidersEdgeStatuscode was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgeUnpair-example.txt b/build/docs/postTelephonyProvidersEdgeUnpair-example.txt new file mode 100644 index 000000000..fc06c9b4c --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgeUnpair-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge Id + +// Unpair an Edge +PostTelephonyProvidersEdgeUnpairRequest.postTelephonyProvidersEdgeUnpair(edgeId: edgeId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgeUnpairRequest.postTelephonyProvidersEdgeUnpair was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdges-example.txt b/build/docs/postTelephonyProvidersEdges-example.txt new file mode 100644 index 000000000..3dff74aec --- /dev/null +++ b/build/docs/postTelephonyProvidersEdges-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Edge = new Edge(...) // Edge + +// Create an edge. +PostTelephonyProvidersEdgesRequest.postTelephonyProvidersEdges(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesRequest.postTelephonyProvidersEdges was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesAddressvalidation-example.txt b/build/docs/postTelephonyProvidersEdgesAddressvalidation-example.txt new file mode 100644 index 000000000..886676c9b --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesAddressvalidation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ValidateAddressRequest = new ValidateAddressRequest(...) // Address + +// Validates a street address +PostTelephonyProvidersEdgesAddressvalidationRequest.postTelephonyProvidersEdgesAddressvalidation(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesAddressvalidationRequest.postTelephonyProvidersEdgesAddressvalidation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesCertificateauthorities-example.txt b/build/docs/postTelephonyProvidersEdgesCertificateauthorities-example.txt new file mode 100644 index 000000000..57ad7f772 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesCertificateauthorities-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DomainCertificateAuthority = new DomainCertificateAuthority(...) // CertificateAuthority + +// Create a certificate authority. +PostTelephonyProvidersEdgesCertificateauthoritiesRequest.postTelephonyProvidersEdgesCertificateauthorities(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesCertificateauthoritiesRequest.postTelephonyProvidersEdgesCertificateauthorities was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesDidpools-example.txt b/build/docs/postTelephonyProvidersEdgesDidpools-example.txt new file mode 100644 index 000000000..e2ce6527d --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesDidpools-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DIDPool = new DIDPool(...) // DID pool + +// Create a new DID pool +PostTelephonyProvidersEdgesDidpoolsRequest.postTelephonyProvidersEdgesDidpools(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesDidpoolsRequest.postTelephonyProvidersEdgesDidpools was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesEdgegroups-example.txt b/build/docs/postTelephonyProvidersEdgesEdgegroups-example.txt new file mode 100644 index 000000000..313f0bc2c --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesEdgegroups-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EdgeGroup = new EdgeGroup(...) // EdgeGroup + +// Create an edge group. +PostTelephonyProvidersEdgesEdgegroupsRequest.postTelephonyProvidersEdgesEdgegroups(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesEdgegroupsRequest.postTelephonyProvidersEdgesEdgegroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesExtensionpools-example.txt b/build/docs/postTelephonyProvidersEdgesExtensionpools-example.txt new file mode 100644 index 000000000..d45f15e87 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesExtensionpools-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ExtensionPool = new ExtensionPool(...) // ExtensionPool + +// Create a new extension pool +PostTelephonyProvidersEdgesExtensionpoolsRequest.postTelephonyProvidersEdgesExtensionpools(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesExtensionpoolsRequest.postTelephonyProvidersEdgesExtensionpools was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesPhoneReboot-example.txt b/build/docs/postTelephonyProvidersEdgesPhoneReboot-example.txt new file mode 100644 index 000000000..a6ba42b0f --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesPhoneReboot-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneId: String = "" // Phone Id + +// Reboot a Phone +PostTelephonyProvidersEdgesPhoneRebootRequest.postTelephonyProvidersEdgesPhoneReboot(phoneId: phoneId) { (error) in + if let error = error { + dump(error) + } else { + print("PostTelephonyProvidersEdgesPhoneRebootRequest.postTelephonyProvidersEdgesPhoneReboot was successful") + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesPhonebasesettings-example.txt b/build/docs/postTelephonyProvidersEdgesPhonebasesettings-example.txt new file mode 100644 index 000000000..f0b5c9350 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesPhonebasesettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PhoneBase = new PhoneBase(...) // Phone base settings + +// Create a new Phone Base Settings object +PostTelephonyProvidersEdgesPhonebasesettingsRequest.postTelephonyProvidersEdgesPhonebasesettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesPhonebasesettingsRequest.postTelephonyProvidersEdgesPhonebasesettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesPhones-example.txt b/build/docs/postTelephonyProvidersEdgesPhones-example.txt new file mode 100644 index 000000000..cda1c869a --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesPhones-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Phone = new Phone(...) // Phone + +// Create a new Phone +PostTelephonyProvidersEdgesPhonesRequest.postTelephonyProvidersEdgesPhones(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesPhonesRequest.postTelephonyProvidersEdgesPhones was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesPhonesReboot-example.txt b/build/docs/postTelephonyProvidersEdgesPhonesReboot-example.txt new file mode 100644 index 000000000..06d4ce65e --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesPhonesReboot-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PhonesReboot = new PhonesReboot(...) // Phones + +// Reboot Multiple Phones +PostTelephonyProvidersEdgesPhonesRebootRequest.postTelephonyProvidersEdgesPhonesReboot(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostTelephonyProvidersEdgesPhonesRebootRequest.postTelephonyProvidersEdgesPhonesReboot was successful") + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesSiteOutboundroutes-example.txt b/build/docs/postTelephonyProvidersEdgesSiteOutboundroutes-example.txt new file mode 100644 index 000000000..baad73c16 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesSiteOutboundroutes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let body: OutboundRouteBase = new OutboundRouteBase(...) // OutboundRoute + +// Create outbound route +PostTelephonyProvidersEdgesSiteOutboundroutesRequest.postTelephonyProvidersEdgesSiteOutboundroutes(siteId: siteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesSiteOutboundroutesRequest.postTelephonyProvidersEdgesSiteOutboundroutes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesSites-example.txt b/build/docs/postTelephonyProvidersEdgesSites-example.txt new file mode 100644 index 000000000..8d6b6392c --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesSites-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Site = new Site(...) // Site + +// Create a Site. +PostTelephonyProvidersEdgesSitesRequest.postTelephonyProvidersEdgesSites(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesSitesRequest.postTelephonyProvidersEdgesSites was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonyProvidersEdgesTrunkbasesettings-example.txt b/build/docs/postTelephonyProvidersEdgesTrunkbasesettings-example.txt new file mode 100644 index 000000000..6d0931959 --- /dev/null +++ b/build/docs/postTelephonyProvidersEdgesTrunkbasesettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TrunkBase = new TrunkBase(...) // Trunk base settings + +// Create a Trunk Base Settings object +PostTelephonyProvidersEdgesTrunkbasesettingsRequest.postTelephonyProvidersEdgesTrunkbasesettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonyProvidersEdgesTrunkbasesettingsRequest.postTelephonyProvidersEdgesTrunkbasesettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTelephonySiptracesDownload-example.txt b/build/docs/postTelephonySiptracesDownload-example.txt new file mode 100644 index 000000000..426d08ff7 --- /dev/null +++ b/build/docs/postTelephonySiptracesDownload-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sIPSearchPublicRequest: SIPSearchPublicRequest = new SIPSearchPublicRequest(...) // + +// Request a download of a pcap file to S3 +PostTelephonySiptracesDownloadRequest.postTelephonySiptracesDownload(sIPSearchPublicRequest: sIPSearchPublicRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTelephonySiptracesDownloadRequest.postTelephonySiptracesDownload was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTextbotsBotflowsSessionTurns-example.txt b/build/docs/postTextbotsBotflowsSessionTurns-example.txt new file mode 100644 index 000000000..388c7c6ce --- /dev/null +++ b/build/docs/postTextbotsBotflowsSessionTurns-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sessionId: String = "" // The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions' +let turnRequest: TextBotFlowTurnRequest = new TextBotFlowTurnRequest(...) // + +// Issue a bot flow turn event +PostTextbotsBotflowsSessionTurnsRequest.postTextbotsBotflowsSessionTurns(sessionId: sessionId, turnRequest: turnRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTextbotsBotflowsSessionTurnsRequest.postTextbotsBotflowsSessionTurns was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTextbotsBotflowsSessions-example.txt b/build/docs/postTextbotsBotflowsSessions-example.txt new file mode 100644 index 000000000..75e2002b7 --- /dev/null +++ b/build/docs/postTextbotsBotflowsSessions-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let launchRequest: TextBotFlowLaunchRequest = new TextBotFlowLaunchRequest(...) // + +// Create an execution instance of a bot flow definition. +PostTextbotsBotflowsSessionsRequest.postTextbotsBotflowsSessions(launchRequest: launchRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTextbotsBotflowsSessionsRequest.postTextbotsBotflowsSessions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postTextbotsBotsExecute-example.txt b/build/docs/postTextbotsBotsExecute-example.txt new file mode 100644 index 000000000..d0a68da6a --- /dev/null +++ b/build/docs/postTextbotsBotsExecute-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let postTextRequest: PostTextRequest = new PostTextRequest(...) // + +// Send an intent to a bot to start a dialog/interact with it via text +PostTextbotsBotsExecuteRequest.postTextbotsBotsExecute(postTextRequest: postTextRequest) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostTextbotsBotsExecuteRequest.postTextbotsBotsExecute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUploadsLearningCoverart-example.txt b/build/docs/postUploadsLearningCoverart-example.txt new file mode 100644 index 000000000..63952ca12 --- /dev/null +++ b/build/docs/postUploadsLearningCoverart-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: LearningCoverArtUploadUrlRequest = new LearningCoverArtUploadUrlRequest(...) // query + +// Generates pre-signed URL to upload cover art for learning modules +PostUploadsLearningCoverartRequest.postUploadsLearningCoverart(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUploadsLearningCoverartRequest.postUploadsLearningCoverart was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUploadsPublicassetsImages-example.txt b/build/docs/postUploadsPublicassetsImages-example.txt new file mode 100644 index 000000000..5c1a486f7 --- /dev/null +++ b/build/docs/postUploadsPublicassetsImages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UploadUrlRequest = new UploadUrlRequest(...) // query + +// Creates presigned url for uploading a public asset image +PostUploadsPublicassetsImagesRequest.postUploadsPublicassetsImages(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUploadsPublicassetsImagesRequest.postUploadsPublicassetsImages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUploadsRecordings-example.txt b/build/docs/postUploadsRecordings-example.txt new file mode 100644 index 000000000..986b07610 --- /dev/null +++ b/build/docs/postUploadsRecordings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UploadUrlRequest = new UploadUrlRequest(...) // query + +// Creates presigned url for uploading a recording file +PostUploadsRecordingsRequest.postUploadsRecordings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUploadsRecordingsRequest.postUploadsRecordings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUploadsWorkforcemanagementHistoricaldataCsv-example.txt b/build/docs/postUploadsWorkforcemanagementHistoricaldataCsv-example.txt new file mode 100644 index 000000000..7da44f068 --- /dev/null +++ b/build/docs/postUploadsWorkforcemanagementHistoricaldataCsv-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UploadUrlRequest = new UploadUrlRequest(...) // query + +// Creates presigned url for uploading WFM historical data file. Requires data in csv format. +PostUploadsWorkforcemanagementHistoricaldataCsvRequest.postUploadsWorkforcemanagementHistoricaldataCsv(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUploadsWorkforcemanagementHistoricaldataCsvRequest.postUploadsWorkforcemanagementHistoricaldataCsv was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsageQuery-example.txt b/build/docs/postUsageQuery-example.txt new file mode 100644 index 000000000..64d9f9420 --- /dev/null +++ b/build/docs/postUsageQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ApiUsageOrganizationQuery = new ApiUsageOrganizationQuery(...) // Query + +// Query organization API Usage - +PostUsageQueryRequest.postUsageQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsageQueryRequest.postUsageQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsageSimplesearch-example.txt b/build/docs/postUsageSimplesearch-example.txt new file mode 100644 index 000000000..9b8042a11 --- /dev/null +++ b/build/docs/postUsageSimplesearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ApiUsageSimpleSearch = new ApiUsageSimpleSearch(...) // SimpleSearch + +// Search organization API Usage - +PostUsageSimplesearchRequest.postUsageSimplesearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsageSimplesearchRequest.postUsageSimplesearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUserExternalid-example.txt b/build/docs/postUserExternalid-example.txt new file mode 100644 index 000000000..7d2ecd00d --- /dev/null +++ b/build/docs/postUserExternalid-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: UserExternalIdentifier = new UserExternalIdentifier(...) // + +// Create mapping between external identifier and user. Limit 100 per entity. +PostUserExternalidRequest.postUserExternalid(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUserExternalidRequest.postUserExternalid was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUserGreetings-example.txt b/build/docs/postUserGreetings-example.txt new file mode 100644 index 000000000..70e729c8c --- /dev/null +++ b/build/docs/postUserGreetings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: Greeting = new Greeting(...) // The Greeting to create + +// Creates a Greeting for a User +PostUserGreetingsRequest.postUserGreetings(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUserGreetingsRequest.postUserGreetings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUserInvite-example.txt b/build/docs/postUserInvite-example.txt new file mode 100644 index 000000000..b8a8dc737 --- /dev/null +++ b/build/docs/postUserInvite-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let force: Bool = true // Resend the invitation even if one is already outstanding + +// Send an activation email to the user +PostUserInviteRequest.postUserInvite(userId: userId, force: force) { (error) in + if let error = error { + dump(error) + } else { + print("PostUserInviteRequest.postUserInvite was successful") + } +} \ No newline at end of file diff --git a/build/docs/postUserPassword-example.txt b/build/docs/postUserPassword-example.txt new file mode 100644 index 000000000..417edab8f --- /dev/null +++ b/build/docs/postUserPassword-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: ChangePasswordRequest = new ChangePasswordRequest(...) // Password + +// Change a users password +PostUserPasswordRequest.postUserPassword(userId: userId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostUserPasswordRequest.postUserPassword was successful") + } +} \ No newline at end of file diff --git a/build/docs/postUserRoutinglanguages-example.txt b/build/docs/postUserRoutinglanguages-example.txt new file mode 100644 index 000000000..d70bb24a1 --- /dev/null +++ b/build/docs/postUserRoutinglanguages-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: UserRoutingLanguagePost = new UserRoutingLanguagePost(...) // Language + +// Add routing language to user +PostUserRoutinglanguagesRequest.postUserRoutinglanguages(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUserRoutinglanguagesRequest.postUserRoutinglanguages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUserRoutingskills-example.txt b/build/docs/postUserRoutingskills-example.txt new file mode 100644 index 000000000..51d6d891e --- /dev/null +++ b/build/docs/postUserRoutingskills-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: UserRoutingSkillPost = new UserRoutingSkillPost(...) // Skill + +// Add routing skill to user +PostUserRoutingskillsRequest.postUserRoutingskills(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUserRoutingskillsRequest.postUserRoutingskills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsers-example.txt b/build/docs/postUsers-example.txt new file mode 100644 index 000000000..ccd2a1f65 --- /dev/null +++ b/build/docs/postUsers-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateUser = new CreateUser(...) // User + +// Create user +PostUsersRequest.postUsers(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsersRequest.postUsers was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsersDevelopmentActivitiesAggregatesQuery-example.txt b/build/docs/postUsersDevelopmentActivitiesAggregatesQuery-example.txt new file mode 100644 index 000000000..cbfaa697c --- /dev/null +++ b/build/docs/postUsersDevelopmentActivitiesAggregatesQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DevelopmentActivityAggregateParam = new DevelopmentActivityAggregateParam(...) // Aggregate Request + +// Retrieve aggregated development activity data +PostUsersDevelopmentActivitiesAggregatesQueryRequest.postUsersDevelopmentActivitiesAggregatesQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsersDevelopmentActivitiesAggregatesQueryRequest.postUsersDevelopmentActivitiesAggregatesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsersMePassword-example.txt b/build/docs/postUsersMePassword-example.txt new file mode 100644 index 000000000..5bf9bbccc --- /dev/null +++ b/build/docs/postUsersMePassword-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ChangeMyPasswordRequest = new ChangeMyPasswordRequest(...) // Password + +// Change your password +PostUsersMePasswordRequest.postUsersMePassword(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostUsersMePasswordRequest.postUsersMePassword was successful") + } +} \ No newline at end of file diff --git a/build/docs/postUsersSearch-example.txt b/build/docs/postUsersSearch-example.txt new file mode 100644 index 000000000..f48f3932c --- /dev/null +++ b/build/docs/postUsersSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserSearchRequest = new UserSearchRequest(...) // Search request options + +// Search users +PostUsersSearchRequest.postUsersSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsersSearchRequest.postUsersSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postUsersSearchTeamsAssign-example.txt b/build/docs/postUsersSearchTeamsAssign-example.txt new file mode 100644 index 000000000..a0993e2a9 --- /dev/null +++ b/build/docs/postUsersSearchTeamsAssign-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UserSearchRequest = new UserSearchRequest(...) // Search request options + +// Search users assigned to teams +PostUsersSearchTeamsAssignRequest.postUsersSearchTeamsAssign(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostUsersSearchTeamsAssignRequest.postUsersSearchTeamsAssign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postVoicemailMessages-example.txt b/build/docs/postVoicemailMessages-example.txt new file mode 100644 index 000000000..bf4290b8a --- /dev/null +++ b/build/docs/postVoicemailMessages-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CopyVoicemailMessage = new CopyVoicemailMessage(...) // + +// Copy a voicemail message to a user or group +PostVoicemailMessagesRequest.postVoicemailMessages(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostVoicemailMessagesRequest.postVoicemailMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postVoicemailSearch-example.txt b/build/docs/postVoicemailSearch-example.txt new file mode 100644 index 000000000..6f61b5cca --- /dev/null +++ b/build/docs/postVoicemailSearch-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: VoicemailSearchRequest = new VoicemailSearchRequest(...) // Search request options + +// Search voicemails +PostVoicemailSearchRequest.postVoicemailSearch(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostVoicemailSearchRequest.postVoicemailSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebchatDeployments-example.txt b/build/docs/postWebchatDeployments-example.txt new file mode 100644 index 000000000..b38da4c20 --- /dev/null +++ b/build/docs/postWebchatDeployments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WebChatDeployment = new WebChatDeployment(...) // Deployment + +// Create WebChat deployment +PostWebchatDeploymentsRequest.postWebchatDeployments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebchatDeploymentsRequest.postWebchatDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebchatGuestConversationMemberMessages-example.txt b/build/docs/postWebchatGuestConversationMemberMessages-example.txt new file mode 100644 index 000000000..f6955c0b8 --- /dev/null +++ b/build/docs/postWebchatGuestConversationMemberMessages-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let memberId: String = "" // memberId +let body: CreateWebChatMessageRequest = new CreateWebChatMessageRequest(...) // Message + +// Send a message in a chat conversation. +PostWebchatGuestConversationMemberMessagesRequest.postWebchatGuestConversationMemberMessages(conversationId: conversationId, memberId: memberId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebchatGuestConversationMemberMessagesRequest.postWebchatGuestConversationMemberMessages was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebchatGuestConversationMemberTyping-example.txt b/build/docs/postWebchatGuestConversationMemberTyping-example.txt new file mode 100644 index 000000000..b95082dfb --- /dev/null +++ b/build/docs/postWebchatGuestConversationMemberTyping-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let memberId: String = "" // memberId + +// Send a typing-indicator in a chat conversation. +PostWebchatGuestConversationMemberTypingRequest.postWebchatGuestConversationMemberTyping(conversationId: conversationId, memberId: memberId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebchatGuestConversationMemberTypingRequest.postWebchatGuestConversationMemberTyping was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebchatGuestConversations-example.txt b/build/docs/postWebchatGuestConversations-example.txt new file mode 100644 index 000000000..6598c76d3 --- /dev/null +++ b/build/docs/postWebchatGuestConversations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateWebChatConversationRequest = new CreateWebChatConversationRequest(...) // CreateConversationRequest + +// Create an ACD chat conversation from an external customer. +PostWebchatGuestConversationsRequest.postWebchatGuestConversations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebchatGuestConversationsRequest.postWebchatGuestConversations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebdeploymentsConfigurationVersionsDraftPublish-example.txt b/build/docs/postWebdeploymentsConfigurationVersionsDraftPublish-example.txt new file mode 100644 index 000000000..d30c1007d --- /dev/null +++ b/build/docs/postWebdeploymentsConfigurationVersionsDraftPublish-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID + +// Publish the configuration draft and create a new version +PostWebdeploymentsConfigurationVersionsDraftPublishRequest.postWebdeploymentsConfigurationVersionsDraftPublish(configurationId: configurationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebdeploymentsConfigurationVersionsDraftPublishRequest.postWebdeploymentsConfigurationVersionsDraftPublish was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebdeploymentsConfigurations-example.txt b/build/docs/postWebdeploymentsConfigurations-example.txt new file mode 100644 index 000000000..cc515f539 --- /dev/null +++ b/build/docs/postWebdeploymentsConfigurations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationVersion: WebDeploymentConfigurationVersion = new WebDeploymentConfigurationVersion(...) // + +// Create a configuration draft +PostWebdeploymentsConfigurationsRequest.postWebdeploymentsConfigurations(configurationVersion: configurationVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebdeploymentsConfigurationsRequest.postWebdeploymentsConfigurations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebdeploymentsDeployments-example.txt b/build/docs/postWebdeploymentsDeployments-example.txt new file mode 100644 index 000000000..42f512dd8 --- /dev/null +++ b/build/docs/postWebdeploymentsDeployments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deployment: WebDeployment = new WebDeployment(...) // + +// Create a deployment +PostWebdeploymentsDeploymentsRequest.postWebdeploymentsDeployments(deployment: deployment) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebdeploymentsDeploymentsRequest.postWebdeploymentsDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebdeploymentsTokenOauthcodegrantjwtexchange-example.txt b/build/docs/postWebdeploymentsTokenOauthcodegrantjwtexchange-example.txt new file mode 100644 index 000000000..706785098 --- /dev/null +++ b/build/docs/postWebdeploymentsTokenOauthcodegrantjwtexchange-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WebDeploymentsOAuthExchangeRequest = new WebDeploymentsOAuthExchangeRequest(...) // webDeploymentsOAuthExchangeRequest + +// Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments. +PostWebdeploymentsTokenOauthcodegrantjwtexchangeRequest.postWebdeploymentsTokenOauthcodegrantjwtexchange(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebdeploymentsTokenOauthcodegrantjwtexchangeRequest.postWebdeploymentsTokenOauthcodegrantjwtexchange was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWebdeploymentsTokenRefresh-example.txt b/build/docs/postWebdeploymentsTokenRefresh-example.txt new file mode 100644 index 000000000..531465daa --- /dev/null +++ b/build/docs/postWebdeploymentsTokenRefresh-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WebDeploymentsRefreshJWTRequest = new WebDeploymentsRefreshJWTRequest(...) // + +// Refresh a JWT. +PostWebdeploymentsTokenRefreshRequest.postWebdeploymentsTokenRefresh(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWebdeploymentsTokenRefreshRequest.postWebdeploymentsTokenRefresh was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWidgetsDeployments-example.txt b/build/docs/postWidgetsDeployments-example.txt new file mode 100644 index 000000000..6cbdd05e7 --- /dev/null +++ b/build/docs/postWidgetsDeployments-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WidgetDeployment = new WidgetDeployment(...) // Deployment + +// Create Widget deployment +PostWidgetsDeploymentsRequest.postWidgetsDeployments(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWidgetsDeploymentsRequest.postWidgetsDeployments was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAdherenceExplanations-example.txt b/build/docs/postWorkforcemanagementAdherenceExplanations-example.txt new file mode 100644 index 000000000..73304cf4c --- /dev/null +++ b/build/docs/postWorkforcemanagementAdherenceExplanations-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AddAdherenceExplanationAgentRequest = new AddAdherenceExplanationAgentRequest(...) // The request body + +// Submit an adherence explanation for the current user +PostWorkforcemanagementAdherenceExplanationsRequest.postWorkforcemanagementAdherenceExplanations(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAdherenceExplanationsRequest.postWorkforcemanagementAdherenceExplanations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAdherenceExplanationsQuery-example.txt b/build/docs/postWorkforcemanagementAdherenceExplanationsQuery-example.txt new file mode 100644 index 000000000..d5564d792 --- /dev/null +++ b/build/docs/postWorkforcemanagementAdherenceExplanationsQuery-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AgentQueryAdherenceExplanationsRequest = new AgentQueryAdherenceExplanationsRequest(...) // The request body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Query adherence explanations for the current user +PostWorkforcemanagementAdherenceExplanationsQueryRequest.postWorkforcemanagementAdherenceExplanationsQuery(body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAdherenceExplanationsQueryRequest.postWorkforcemanagementAdherenceExplanationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAdherenceHistorical-example.txt b/build/docs/postWorkforcemanagementAdherenceHistorical-example.txt new file mode 100644 index 000000000..e8902e4cf --- /dev/null +++ b/build/docs/postWorkforcemanagementAdherenceHistorical-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WfmHistoricalAdherenceQueryForUsers = new WfmHistoricalAdherenceQueryForUsers(...) // body + +// Deprecated. Use bulk routes instead (/adherence/historical/bulk) +PostWorkforcemanagementAdherenceHistoricalRequest.postWorkforcemanagementAdherenceHistorical(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAdherenceHistoricalRequest.postWorkforcemanagementAdherenceHistorical was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAdherenceHistoricalBulk-example.txt b/build/docs/postWorkforcemanagementAdherenceHistoricalBulk-example.txt new file mode 100644 index 000000000..00025c1eb --- /dev/null +++ b/build/docs/postWorkforcemanagementAdherenceHistoricalBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WfmHistoricalAdherenceBulkQuery = new WfmHistoricalAdherenceBulkQuery(...) // body + +// Request a historical adherence report in bulk +PostWorkforcemanagementAdherenceHistoricalBulkRequest.postWorkforcemanagementAdherenceHistoricalBulk(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAdherenceHistoricalBulkRequest.postWorkforcemanagementAdherenceHistoricalBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgentAdherenceExplanations-example.txt b/build/docs/postWorkforcemanagementAgentAdherenceExplanations-example.txt new file mode 100644 index 000000000..d3956534b --- /dev/null +++ b/build/docs/postWorkforcemanagementAgentAdherenceExplanations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent to query +let body: AddAdherenceExplanationAdminRequest = new AddAdherenceExplanationAdminRequest(...) // The request body + +// Add an adherence explanation for the requested user +PostWorkforcemanagementAgentAdherenceExplanationsRequest.postWorkforcemanagementAgentAdherenceExplanations(agentId: agentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentAdherenceExplanationsRequest.postWorkforcemanagementAgentAdherenceExplanations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgentAdherenceExplanationsQuery-example.txt b/build/docs/postWorkforcemanagementAgentAdherenceExplanationsQuery-example.txt new file mode 100644 index 000000000..519c13529 --- /dev/null +++ b/build/docs/postWorkforcemanagementAgentAdherenceExplanationsQuery-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent to query +let body: AgentQueryAdherenceExplanationsRequest = new AgentQueryAdherenceExplanationsRequest(...) // The request body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Query adherence explanations for the given agent across a specified range +PostWorkforcemanagementAgentAdherenceExplanationsQueryRequest.postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId: agentId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentAdherenceExplanationsQueryRequest.postWorkforcemanagementAgentAdherenceExplanationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgents-example.txt b/build/docs/postWorkforcemanagementAgents-example.txt new file mode 100644 index 000000000..c6a560972 --- /dev/null +++ b/build/docs/postWorkforcemanagementAgents-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MoveAgentsRequest = new MoveAgentsRequest(...) // body + +// Move agents in and out of management unit +PostWorkforcemanagementAgentsRequest.postWorkforcemanagementAgents(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentsRequest.postWorkforcemanagementAgents was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgentsIntegrationsHrisQuery-example.txt b/build/docs/postWorkforcemanagementAgentsIntegrationsHrisQuery-example.txt new file mode 100644 index 000000000..4b7592144 --- /dev/null +++ b/build/docs/postWorkforcemanagementAgentsIntegrationsHrisQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: QueryAgentsIntegrationsRequest = new QueryAgentsIntegrationsRequest(...) // body + +// Query integrations for agents +PostWorkforcemanagementAgentsIntegrationsHrisQueryRequest.postWorkforcemanagementAgentsIntegrationsHrisQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentsIntegrationsHrisQueryRequest.postWorkforcemanagementAgentsIntegrationsHrisQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgentsMePossibleworkshifts-example.txt b/build/docs/postWorkforcemanagementAgentsMePossibleworkshifts-example.txt new file mode 100644 index 000000000..439dfb6c1 --- /dev/null +++ b/build/docs/postWorkforcemanagementAgentsMePossibleworkshifts-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AgentPossibleWorkShiftsRequest = new AgentPossibleWorkShiftsRequest(...) // body + +// Get agent possible work shifts for requested time frame +PostWorkforcemanagementAgentsMePossibleworkshiftsRequest.postWorkforcemanagementAgentsMePossibleworkshifts(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentsMePossibleworkshiftsRequest.postWorkforcemanagementAgentsMePossibleworkshifts was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementAgentschedulesMine-example.txt b/build/docs/postWorkforcemanagementAgentschedulesMine-example.txt new file mode 100644 index 000000000..7d3608299 --- /dev/null +++ b/build/docs/postWorkforcemanagementAgentschedulesMine-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: BuGetCurrentAgentScheduleRequest = new BuGetCurrentAgentScheduleRequest(...) // body + +// Get published schedule for the current user +PostWorkforcemanagementAgentschedulesMineRequest.postWorkforcemanagementAgentschedulesMine(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementAgentschedulesMineRequest.postWorkforcemanagementAgentschedulesMine was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitActivitycodes-example.txt b/build/docs/postWorkforcemanagementBusinessunitActivitycodes-example.txt new file mode 100644 index 000000000..b3a8c8931 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitActivitycodes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit, or 'mine' for the business unit of the logged-in user. +let body: CreateActivityCodeRequest = new CreateActivityCodeRequest(...) // body + +// Create a new activity code +PostWorkforcemanagementBusinessunitActivitycodesRequest.postWorkforcemanagementBusinessunitActivitycodes(businessUnitId: businessUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitActivitycodesRequest.postWorkforcemanagementBusinessunitActivitycodes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitAdherenceExplanationsQuery-example.txt b/build/docs/postWorkforcemanagementBusinessunitAdherenceExplanationsQuery-example.txt new file mode 100644 index 000000000..7bb83371b --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitAdherenceExplanationsQuery-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let body: BuQueryAdherenceExplanationsRequest = new BuQueryAdherenceExplanationsRequest(...) // The request body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Query adherence explanations across an entire business unit for the requested period +PostWorkforcemanagementBusinessunitAdherenceExplanationsQueryRequest.postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId: businessUnitId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitAdherenceExplanationsQueryRequest.postWorkforcemanagementBusinessunitAdherenceExplanationsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitAgentschedulesSearch-example.txt b/build/docs/postWorkforcemanagementBusinessunitAgentschedulesSearch-example.txt new file mode 100644 index 000000000..4cd468090 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitAgentschedulesSearch-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes +let body: BuSearchAgentSchedulesRequest = new BuSearchAgentSchedulesRequest(...) // body + +// Search published schedules +PostWorkforcemanagementBusinessunitAgentschedulesSearchRequest.postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId: businessUnitId, forceAsync: forceAsync, forceDownloadService: forceDownloadService, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitAgentschedulesSearchRequest.postWorkforcemanagementBusinessunitAgentschedulesSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitIntraday-example.txt b/build/docs/postWorkforcemanagementBusinessunitIntraday-example.txt new file mode 100644 index 000000000..6f3d5a17d --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitIntraday-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let body: IntradayPlanningGroupRequest = new IntradayPlanningGroupRequest(...) // body + +// Get intraday data for the given date for the requested planningGroupIds +PostWorkforcemanagementBusinessunitIntradayRequest.postWorkforcemanagementBusinessunitIntraday(businessUnitId: businessUnitId, forceAsync: forceAsync, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitIntradayRequest.postWorkforcemanagementBusinessunitIntraday was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitPlanninggroups-example.txt b/build/docs/postWorkforcemanagementBusinessunitPlanninggroups-example.txt new file mode 100644 index 000000000..c5b78b55e --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitPlanninggroups-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let body: CreatePlanningGroupRequest = new CreatePlanningGroupRequest(...) // body + +// Adds a new planning group +PostWorkforcemanagementBusinessunitPlanninggroupsRequest.postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId: businessUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitPlanninggroupsRequest.postWorkforcemanagementBusinessunitPlanninggroups was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitServicegoaltemplates-example.txt b/build/docs/postWorkforcemanagementBusinessunitServicegoaltemplates-example.txt new file mode 100644 index 000000000..211aa0ccc --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitServicegoaltemplates-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit. +let body: CreateServiceGoalTemplate = new CreateServiceGoalTemplate(...) // body + +// Adds a new service goal template +PostWorkforcemanagementBusinessunitServicegoaltemplatesRequest.postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId: businessUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitServicegoaltemplatesRequest.postWorkforcemanagementBusinessunitServicegoaltemplates was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery-example.txt new file mode 100644 index 000000000..24aca7697 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery-example.txt @@ -0,0 +1,21 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let body: BuQueryAgentSchedulesRequest = new BuQueryAgentSchedulesRequest(...) // body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes + +// Loads agent schedule data from the schedule. Used in combination with the metadata route +PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryRequest.postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body, forceAsync: forceAsync, forceDownloadService: forceDownloadService) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQueryRequest.postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekScheduleCopy-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleCopy-example.txt new file mode 100644 index 000000000..0c37c7f23 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleCopy-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule to copy +let body: BuCopyScheduleRequest = new BuCopyScheduleRequest(...) // body + +// Copy a schedule +PostWorkforcemanagementBusinessunitWeekScheduleCopyRequest.postWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekScheduleCopyRequest.postWorkforcemanagementBusinessunitWeekScheduleCopy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekScheduleReschedule-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleReschedule-example.txt new file mode 100644 index 000000000..4ef9a2400 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleReschedule-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let body: BuRescheduleRequest = new BuRescheduleRequest(...) // body + +// Start a rescheduling run +PostWorkforcemanagementBusinessunitWeekScheduleRescheduleRequest.postWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekScheduleRescheduleRequest.postWorkforcemanagementBusinessunitWeekScheduleReschedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdate-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdate-example.txt new file mode 100644 index 000000000..ec977a777 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdate-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let body: ProcessScheduleUpdateUploadRequest = new ProcessScheduleUpdateUploadRequest(...) // body + +// Starts processing a schedule update +PostWorkforcemanagementBusinessunitWeekScheduleUpdateRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekScheduleUpdateRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl-example.txt new file mode 100644 index 000000000..3e7d104f5 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let scheduleId: String = "" // The ID of the schedule +let body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body + +// Creates a signed upload URL for updating a schedule +PostWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId: businessUnitId, weekId: weekId, scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurlRequest.postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekSchedules-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekSchedules-example.txt new file mode 100644 index 000000000..f2df5f7dc --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekSchedules-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: BuCreateBlankScheduleRequest = new BuCreateBlankScheduleRequest(...) // body + +// Create a blank schedule +PostWorkforcemanagementBusinessunitWeekSchedulesRequest.postWorkforcemanagementBusinessunitWeekSchedules(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekSchedulesRequest.postWorkforcemanagementBusinessunitWeekSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesGenerate-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesGenerate-example.txt new file mode 100644 index 000000000..43e0d3f57 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesGenerate-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: BuGenerateScheduleRequest = new BuGenerateScheduleRequest(...) // body + +// Generate a schedule +PostWorkforcemanagementBusinessunitWeekSchedulesGenerateRequest.postWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekSchedulesGenerateRequest.postWorkforcemanagementBusinessunitWeekSchedulesGenerate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImport-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImport-example.txt new file mode 100644 index 000000000..ae03f6c6d --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImport-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: WfmProcessUploadRequest = new WfmProcessUploadRequest(...) // + +// Starts processing a schedule import +PostWorkforcemanagementBusinessunitWeekSchedulesImportRequest.postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekSchedulesImportRequest.postWorkforcemanagementBusinessunitWeekSchedulesImport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl-example.txt new file mode 100644 index 000000000..df1d1dffe --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit +let weekId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body + +// Creates a signed upload URL for importing a schedule +PostWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId: businessUnitId, weekId: weekId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekSchedulesImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastCopy-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastCopy-example.txt new file mode 100644 index 000000000..d31f32f84 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastCopy-example.txt @@ -0,0 +1,20 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let forecastId: String = "" // The ID of the forecast to copy +let body: CopyBuForecastRequest = new CopyBuForecastRequest(...) // body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes + +// Copy a short term forecast +PostWorkforcemanagementBusinessunitWeekShorttermforecastCopyRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId: businessUnitId, weekDateId: weekDateId, forecastId: forecastId, body: body, forceAsync: forceAsync) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekShorttermforecastCopyRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastCopy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate-example.txt new file mode 100644 index 000000000..3f4b9e0d8 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // 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 +let body: GenerateBuForecastRequest = new GenerateBuForecastRequest(...) // body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes + +// Generate a short term forecast +PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body, forceAsync: forceAsync) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerateRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImport-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImport-example.txt new file mode 100644 index 000000000..743bbdba4 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImport-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: WfmProcessUploadRequest = new WfmProcessUploadRequest(...) // body + +// Starts importing the uploaded short term forecast +PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImport was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl-example.txt b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl-example.txt new file mode 100644 index 000000000..4f62a9fc9 --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let businessUnitId: String = "" // The ID of the business unit to which the forecast belongs +let weekDateId: Date = new Date(...) // First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd +let body: UploadUrlRequestBody = new UploadUrlRequestBody(...) // body + +// Creates a signed upload URL for importing a short term forecast +PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId: businessUnitId, weekDateId: weekDateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurlRequest.postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementBusinessunits-example.txt b/build/docs/postWorkforcemanagementBusinessunits-example.txt new file mode 100644 index 000000000..daf3f982c --- /dev/null +++ b/build/docs/postWorkforcemanagementBusinessunits-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateBusinessUnitRequest = new CreateBusinessUnitRequest(...) // body + +// Add a new business unit +PostWorkforcemanagementBusinessunitsRequest.postWorkforcemanagementBusinessunits(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementBusinessunitsRequest.postWorkforcemanagementBusinessunits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementCalendarUrlIcs-example.txt b/build/docs/postWorkforcemanagementCalendarUrlIcs-example.txt new file mode 100644 index 000000000..7a048f0bb --- /dev/null +++ b/build/docs/postWorkforcemanagementCalendarUrlIcs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let language: String = en-US // A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize default activity code names in the ics-formatted calendar + +// Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned +PostWorkforcemanagementCalendarUrlIcsRequest.postWorkforcemanagementCalendarUrlIcs(language: language) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementCalendarUrlIcsRequest.postWorkforcemanagementCalendarUrlIcs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementHistoricaldataDeletejob-example.txt b/build/docs/postWorkforcemanagementHistoricaldataDeletejob-example.txt new file mode 100644 index 000000000..ffc0d2cd5 --- /dev/null +++ b/build/docs/postWorkforcemanagementHistoricaldataDeletejob-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + + +// Delete the entries of the historical data imports in the organization +PostWorkforcemanagementHistoricaldataDeletejobRequest.postWorkforcemanagementHistoricaldataDeletejob() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementHistoricaldataDeletejobRequest.postWorkforcemanagementHistoricaldataDeletejob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementHistoricaldataValidate-example.txt b/build/docs/postWorkforcemanagementHistoricaldataValidate-example.txt new file mode 100644 index 000000000..e73d80239 --- /dev/null +++ b/build/docs/postWorkforcemanagementHistoricaldataValidate-example.txt @@ -0,0 +1,15 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ValidationServiceRequest = new ValidationServiceRequest(...) // body + +// Trigger validation process for historical import +PostWorkforcemanagementHistoricaldataValidateRequest.postWorkforcemanagementHistoricaldataValidate(body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PostWorkforcemanagementHistoricaldataValidateRequest.postWorkforcemanagementHistoricaldataValidate was successful") + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementIntegrationsHriTimeofftypesJobs-example.txt b/build/docs/postWorkforcemanagementIntegrationsHriTimeofftypesJobs-example.txt new file mode 100644 index 000000000..2583f28b7 --- /dev/null +++ b/build/docs/postWorkforcemanagementIntegrationsHriTimeofftypesJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let hrisIntegrationId: String = "" // The ID of the HRIS integration for which time off types are queried. + +// Get list of time off types configured in integration +PostWorkforcemanagementIntegrationsHriTimeofftypesJobsRequest.postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId: hrisIntegrationId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementIntegrationsHriTimeofftypesJobsRequest.postWorkforcemanagementIntegrationsHriTimeofftypesJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitAgentschedulesSearch-example.txt b/build/docs/postWorkforcemanagementManagementunitAgentschedulesSearch-example.txt new file mode 100644 index 000000000..267037c18 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitAgentschedulesSearch-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes +let forceDownloadService: Bool = true // Force the result of this operation to be sent via download service. For testing/app development purposes +let body: BuSearchAgentSchedulesRequest = new BuSearchAgentSchedulesRequest(...) // body + +// Query published schedules for given given time range for set of users +PostWorkforcemanagementManagementunitAgentschedulesSearchRequest.postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId: managementUnitId, forceAsync: forceAsync, forceDownloadService: forceDownloadService, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitAgentschedulesSearchRequest.postWorkforcemanagementManagementunitAgentschedulesSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitHistoricaladherencequery-example.txt b/build/docs/postWorkforcemanagementManagementunitHistoricaladherencequery-example.txt new file mode 100644 index 000000000..f97d8ea26 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitHistoricaladherencequery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let body: WfmHistoricalAdherenceQuery = new WfmHistoricalAdherenceQuery(...) // body + +// Request a historical adherence report +PostWorkforcemanagementManagementunitHistoricaladherencequeryRequest.postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitHistoricaladherencequeryRequest.postWorkforcemanagementManagementunitHistoricaladherencequery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitMove-example.txt b/build/docs/postWorkforcemanagementManagementunitMove-example.txt new file mode 100644 index 000000000..85d489c3d --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitMove-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: MoveManagementUnitRequest = new MoveManagementUnitRequest(...) // body + +// Move the requested management unit to a new business unit +PostWorkforcemanagementManagementunitMoveRequest.postWorkforcemanagementManagementunitMove(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitMoveRequest.postWorkforcemanagementManagementunitMove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitSchedulesSearch-example.txt b/build/docs/postWorkforcemanagementManagementunitSchedulesSearch-example.txt new file mode 100644 index 000000000..60911d421 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitSchedulesSearch-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: UserListScheduleRequestBody = new UserListScheduleRequestBody(...) // body + +// Query published schedules for given given time range for set of users +PostWorkforcemanagementManagementunitSchedulesSearchRequest.postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitSchedulesSearchRequest.postWorkforcemanagementManagementunitSchedulesSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitShrinkageJobs-example.txt b/build/docs/postWorkforcemanagementManagementunitShrinkageJobs-example.txt new file mode 100644 index 000000000..c07e0eef1 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitShrinkageJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let body: WfmHistoricalShrinkageRequest = new WfmHistoricalShrinkageRequest(...) // body + +// Request a historical shrinkage report +PostWorkforcemanagementManagementunitShrinkageJobsRequest.postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitShrinkageJobsRequest.postWorkforcemanagementManagementunitShrinkageJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeofflimits-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeofflimits-example.txt new file mode 100644 index 000000000..d92a35120 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeofflimits-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let body: CreateTimeOffLimitRequest = new CreateTimeOffLimitRequest(...) // body + +// Creates a new time off limit object under management unit. +PostWorkforcemanagementManagementunitTimeofflimitsRequest.postWorkforcemanagementManagementunitTimeofflimits(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeofflimitsRequest.postWorkforcemanagementManagementunitTimeofflimits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeofflimitsValuesQuery-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeofflimitsValuesQuery-example.txt new file mode 100644 index 000000000..f1943215f --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeofflimitsValuesQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let body: QueryTimeOffLimitValuesRequest = new QueryTimeOffLimitValuesRequest(...) // body + +// Retrieves time off limit related values based on a given set of filters. +PostWorkforcemanagementManagementunitTimeofflimitsValuesQueryRequest.postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeofflimitsValuesQueryRequest.postWorkforcemanagementManagementunitTimeofflimitsValuesQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeoffplans-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeoffplans-example.txt new file mode 100644 index 000000000..30e406596 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeoffplans-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let body: CreateTimeOffPlanRequest = new CreateTimeOffPlanRequest(...) // body + +// Creates a new time off plan +PostWorkforcemanagementManagementunitTimeoffplansRequest.postWorkforcemanagementManagementunitTimeoffplans(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeoffplansRequest.postWorkforcemanagementManagementunitTimeoffplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeoffrequests-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeoffrequests-example.txt new file mode 100644 index 000000000..b3b6391e9 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeoffrequests-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: CreateAdminTimeOffRequest = new CreateAdminTimeOffRequest(...) // body + +// Create a new time off request +PostWorkforcemanagementManagementunitTimeoffrequestsRequest.postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeoffrequestsRequest.postWorkforcemanagementManagementunitTimeoffrequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery-example.txt new file mode 100644 index 000000000..d01d8919d --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let body: QueryTimeOffIntegrationStatusRequest = new QueryTimeOffIntegrationStatusRequest(...) // body + +// Retrieves integration statuses for a list of time off requests +PostWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsQuery-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsQuery-example.txt new file mode 100644 index 000000000..9c879fbf2 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: TimeOffRequestQueryBody = new TimeOffRequestQueryBody(...) // body + +// Fetches time off requests matching the conditions specified in the request body +PostWorkforcemanagementManagementunitTimeoffrequestsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeoffrequestsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery-example.txt b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery-example.txt new file mode 100644 index 000000000..a3aacb2de --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let body: QueryWaitlistPositionsRequest = new QueryWaitlistPositionsRequest(...) // body + +// Retrieves daily waitlist position for a list of time off requests +PostWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQueryRequest.postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitUserTimeoffbalanceJobs-example.txt b/build/docs/postWorkforcemanagementManagementunitUserTimeoffbalanceJobs-example.txt new file mode 100644 index 000000000..33015b463 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitUserTimeoffbalanceJobs-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let userId: String = "" // The ID of the user +let body: TimeOffBalanceRequest = new TimeOffBalanceRequest(...) // The request body + +// Query time off balances for a given user for specified activity code and dates +PostWorkforcemanagementManagementunitUserTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(managementUnitId: managementUnitId, userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitUserTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffbalanceJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs-example.txt b/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs-example.txt new file mode 100644 index 000000000..c6f088b42 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let userId: String = "" // The userId to whom the time off request applies. +let timeOffRequestId: String = "" // The time off request id. + +// Query time off balances for dates spanned by a given time off request +PostWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(managementUnitId: managementUnitId, userId: userId, timeOffRequestId: timeOffRequestId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobsRequest.postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate-example.txt b/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate-example.txt new file mode 100644 index 000000000..ef9d4929b --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit +let userId: String = "" // The id of the user for whom the time off request estimate is requested +let body: EstimateAvailableTimeOffRequest = new EstimateAvailableTimeOffRequest(...) // body + +// Estimates available time off for an agent +PostWorkforcemanagementManagementunitUserTimeoffrequestsEstimateRequest.postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId: managementUnitId, userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitUserTimeoffrequestsEstimateRequest.postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWeekShifttradeMatch-example.txt b/build/docs/postWorkforcemanagementManagementunitWeekShifttradeMatch-example.txt new file mode 100644 index 000000000..fe0b7ba65 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWeekShifttradeMatch-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let tradeId: String = "" // The ID of the shift trade to update +let body: MatchShiftTradeRequest = new MatchShiftTradeRequest(...) // body + +// Matches a shift trade. This route can only be called by the receiving agent +PostWorkforcemanagementManagementunitWeekShifttradeMatchRequest.postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId: managementUnitId, weekDateId: weekDateId, tradeId: tradeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWeekShifttradeMatchRequest.postWorkforcemanagementManagementunitWeekShifttradeMatch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWeekShifttrades-example.txt b/build/docs/postWorkforcemanagementManagementunitWeekShifttrades-example.txt new file mode 100644 index 000000000..95141e016 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWeekShifttrades-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let body: AddShiftTradeRequest = new AddShiftTradeRequest(...) // body + +// Adds a shift trade +PostWorkforcemanagementManagementunitWeekShifttradesRequest.postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWeekShifttradesRequest.postWorkforcemanagementManagementunitWeekShifttrades was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWeekShifttradesSearch-example.txt b/build/docs/postWorkforcemanagementManagementunitWeekShifttradesSearch-example.txt new file mode 100644 index 000000000..a9919fd4e --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWeekShifttradesSearch-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let body: SearchShiftTradesRequest = new SearchShiftTradesRequest(...) // body + +// Searches for potential shift trade matches for the current agent +PostWorkforcemanagementManagementunitWeekShifttradesSearchRequest.postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWeekShifttradesSearchRequest.postWorkforcemanagementManagementunitWeekShifttradesSearch was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWeekShifttradesStateBulk-example.txt b/build/docs/postWorkforcemanagementManagementunitWeekShifttradesStateBulk-example.txt new file mode 100644 index 000000000..bfc118226 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWeekShifttradesStateBulk-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let weekDateId: Date = new Date(...) // 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 +let body: BulkShiftTradeStateUpdateRequest = new BulkShiftTradeStateUpdateRequest(...) // body +let forceAsync: Bool = true // Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes + +// Updates the state of a batch of shift trades +PostWorkforcemanagementManagementunitWeekShifttradesStateBulkRequest.postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId: managementUnitId, weekDateId: weekDateId, body: body, forceAsync: forceAsync) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWeekShifttradesStateBulkRequest.postWorkforcemanagementManagementunitWeekShifttradesStateBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWorkplanCopy-example.txt b/build/docs/postWorkforcemanagementManagementunitWorkplanCopy-example.txt new file mode 100644 index 000000000..a695571e4 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWorkplanCopy-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanId: String = "" // The ID of the work plan to create a copy +let body: CopyWorkPlan = new CopyWorkPlan(...) // body + +// Create a copy of work plan +PostWorkforcemanagementManagementunitWorkplanCopyRequest.postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId: managementUnitId, workPlanId: workPlanId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWorkplanCopyRequest.postWorkforcemanagementManagementunitWorkplanCopy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWorkplanValidate-example.txt b/build/docs/postWorkforcemanagementManagementunitWorkplanValidate-example.txt new file mode 100644 index 000000000..bdc5c7ae0 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWorkplanValidate-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanId: String = "" // The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. +let expand: [String] = [""] // +let body: WorkPlanValidationRequest = new WorkPlanValidationRequest(...) // body + +// Validate Work Plan +PostWorkforcemanagementManagementunitWorkplanValidateRequest.postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId: managementUnitId, workPlanId: workPlanId, expand: expand, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWorkplanValidateRequest.postWorkforcemanagementManagementunitWorkplanValidate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWorkplanrotationCopy-example.txt b/build/docs/postWorkforcemanagementManagementunitWorkplanrotationCopy-example.txt new file mode 100644 index 000000000..0980db85e --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWorkplanrotationCopy-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let workPlanRotationId: String = "" // The ID of the work plan rotation to create a copy +let body: CopyWorkPlanRotationRequest = new CopyWorkPlanRotationRequest(...) // body + +// Create a copy of work plan rotation +PostWorkforcemanagementManagementunitWorkplanrotationCopyRequest.postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId: managementUnitId, workPlanRotationId: workPlanRotationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWorkplanrotationCopyRequest.postWorkforcemanagementManagementunitWorkplanrotationCopy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWorkplanrotations-example.txt b/build/docs/postWorkforcemanagementManagementunitWorkplanrotations-example.txt new file mode 100644 index 000000000..0ada7df71 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWorkplanrotations-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let body: AddWorkPlanRotationRequest = new AddWorkPlanRotationRequest(...) // body + +// Create a new work plan rotation +PostWorkforcemanagementManagementunitWorkplanrotationsRequest.postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId: managementUnitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWorkplanrotationsRequest.postWorkforcemanagementManagementunitWorkplanrotations was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunitWorkplans-example.txt b/build/docs/postWorkforcemanagementManagementunitWorkplans-example.txt new file mode 100644 index 000000000..2083936be --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunitWorkplans-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. +let validationMode: PostWorkforcemanagementManagementunitWorkplansRequest.ValidationMode_postWorkforcemanagementManagementunitWorkplans = PostWorkforcemanagementManagementunitWorkplansRequest.ValidationMode_postWorkforcemanagementManagementunitWorkplans.enummember // Allows to create work plan even if the validation result is invalid +let body: CreateWorkPlan = new CreateWorkPlan(...) // body + +// Create a new work plan +PostWorkforcemanagementManagementunitWorkplansRequest.postWorkforcemanagementManagementunitWorkplans(managementUnitId: managementUnitId, validationMode: validationMode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitWorkplansRequest.postWorkforcemanagementManagementunitWorkplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementManagementunits-example.txt b/build/docs/postWorkforcemanagementManagementunits-example.txt new file mode 100644 index 000000000..316141d98 --- /dev/null +++ b/build/docs/postWorkforcemanagementManagementunits-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateManagementUnitApiRequest = new CreateManagementUnitApiRequest(...) // body + +// Add a management unit +PostWorkforcemanagementManagementunitsRequest.postWorkforcemanagementManagementunits(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementManagementunitsRequest.postWorkforcemanagementManagementunits was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementNotificationsUpdate-example.txt b/build/docs/postWorkforcemanagementNotificationsUpdate-example.txt new file mode 100644 index 000000000..a9ab70bee --- /dev/null +++ b/build/docs/postWorkforcemanagementNotificationsUpdate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UpdateNotificationsRequest = new UpdateNotificationsRequest(...) // body + +// Mark a list of notifications as read or unread +PostWorkforcemanagementNotificationsUpdateRequest.postWorkforcemanagementNotificationsUpdate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementNotificationsUpdateRequest.postWorkforcemanagementNotificationsUpdate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementSchedules-example.txt b/build/docs/postWorkforcemanagementSchedules-example.txt new file mode 100644 index 000000000..6d6dbd1e2 --- /dev/null +++ b/build/docs/postWorkforcemanagementSchedules-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CurrentUserScheduleRequestBody = new CurrentUserScheduleRequestBody(...) // body + +// Get published schedule for the current user +PostWorkforcemanagementSchedulesRequest.postWorkforcemanagementSchedules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementSchedulesRequest.postWorkforcemanagementSchedules was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTeamAdherenceHistorical-example.txt b/build/docs/postWorkforcemanagementTeamAdherenceHistorical-example.txt new file mode 100644 index 000000000..9f84b3869 --- /dev/null +++ b/build/docs/postWorkforcemanagementTeamAdherenceHistorical-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // The ID of the team +let body: WfmHistoricalAdherenceQueryForTeams = new WfmHistoricalAdherenceQueryForTeams(...) // body + +// Request a teams historical adherence report +PostWorkforcemanagementTeamAdherenceHistoricalRequest.postWorkforcemanagementTeamAdherenceHistorical(teamId: teamId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTeamAdherenceHistoricalRequest.postWorkforcemanagementTeamAdherenceHistorical was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTeamShrinkageJobs-example.txt b/build/docs/postWorkforcemanagementTeamShrinkageJobs-example.txt new file mode 100644 index 000000000..aa92f5d74 --- /dev/null +++ b/build/docs/postWorkforcemanagementTeamShrinkageJobs-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let teamId: String = "" // The ID of the team +let body: WfmHistoricalShrinkageTeamsRequest = new WfmHistoricalShrinkageTeamsRequest(...) // body + +// Request a historical shrinkage report +PostWorkforcemanagementTeamShrinkageJobsRequest.postWorkforcemanagementTeamShrinkageJobs(teamId: teamId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTeamShrinkageJobsRequest.postWorkforcemanagementTeamShrinkageJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTimeoffbalanceJobs-example.txt b/build/docs/postWorkforcemanagementTimeoffbalanceJobs-example.txt new file mode 100644 index 000000000..4c37aaaa0 --- /dev/null +++ b/build/docs/postWorkforcemanagementTimeoffbalanceJobs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TimeOffBalanceRequest = new TimeOffBalanceRequest(...) // The request body + +// Query time off balances for the current user for specified activity code and dates +PostWorkforcemanagementTimeoffbalanceJobsRequest.postWorkforcemanagementTimeoffbalanceJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTimeoffbalanceJobsRequest.postWorkforcemanagementTimeoffbalanceJobs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTimeofflimitsAvailableQuery-example.txt b/build/docs/postWorkforcemanagementTimeofflimitsAvailableQuery-example.txt new file mode 100644 index 000000000..bc739cd6d --- /dev/null +++ b/build/docs/postWorkforcemanagementTimeofflimitsAvailableQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: AvailableTimeOffRequest = new AvailableTimeOffRequest(...) // body + +// Queries available time off for the current user +PostWorkforcemanagementTimeofflimitsAvailableQueryRequest.postWorkforcemanagementTimeofflimitsAvailableQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTimeofflimitsAvailableQueryRequest.postWorkforcemanagementTimeofflimitsAvailableQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTimeoffrequests-example.txt b/build/docs/postWorkforcemanagementTimeoffrequests-example.txt new file mode 100644 index 000000000..75979b440 --- /dev/null +++ b/build/docs/postWorkforcemanagementTimeoffrequests-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CreateAgentTimeOffRequest = new CreateAgentTimeOffRequest(...) // body + +// Create a time off request for the current user +PostWorkforcemanagementTimeoffrequestsRequest.postWorkforcemanagementTimeoffrequests(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTimeoffrequestsRequest.postWorkforcemanagementTimeoffrequests was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTimeoffrequestsEstimate-example.txt b/build/docs/postWorkforcemanagementTimeoffrequestsEstimate-example.txt new file mode 100644 index 000000000..c5093b2eb --- /dev/null +++ b/build/docs/postWorkforcemanagementTimeoffrequestsEstimate-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EstimateAvailableTimeOffRequest = new EstimateAvailableTimeOffRequest(...) // body + +// Estimates available time off for current user +PostWorkforcemanagementTimeoffrequestsEstimateRequest.postWorkforcemanagementTimeoffrequestsEstimate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTimeoffrequestsEstimateRequest.postWorkforcemanagementTimeoffrequestsEstimate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery-example.txt b/build/docs/postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery-example.txt new file mode 100644 index 000000000..fb95818cf --- /dev/null +++ b/build/docs/postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CurrentUserTimeOffIntegrationStatusRequest = new CurrentUserTimeOffIntegrationStatusRequest(...) // body + +// Retrieves integration statuses for a list of current user time off requests +PostWorkforcemanagementTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PostWorkforcemanagementTimeoffrequestsIntegrationstatusQueryRequest.postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAlertingAlert-example.txt b/build/docs/putAlertingAlert-example.txt new file mode 100644 index 000000000..da9f67c30 --- /dev/null +++ b/build/docs/putAlertingAlert-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID +let body: AlertingUnreadStatus = new AlertingUnreadStatus(...) // + +// Update an alert read status +PutAlertingAlertRequest.putAlertingAlert(alertId: alertId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAlertingAlertRequest.putAlertingAlert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAlertingInteractionstatsAlert-example.txt b/build/docs/putAlertingInteractionstatsAlert-example.txt new file mode 100644 index 000000000..63248daf2 --- /dev/null +++ b/build/docs/putAlertingInteractionstatsAlert-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let alertId: String = "" // Alert ID +let body: UnreadStatus = new UnreadStatus(...) // InteractionStatsAlert +let expand: [String] = [""] // Which fields, if any, to expand + +// Update an interaction stats alert read status +PutAlertingInteractionstatsAlertRequest.putAlertingInteractionstatsAlert(alertId: alertId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAlertingInteractionstatsAlertRequest.putAlertingInteractionstatsAlert was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAlertingInteractionstatsRule-example.txt b/build/docs/putAlertingInteractionstatsRule-example.txt new file mode 100644 index 000000000..00a7a6df5 --- /dev/null +++ b/build/docs/putAlertingInteractionstatsRule-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule ID +let body: InteractionStatsRule = new InteractionStatsRule(...) // AlertingRule +let expand: [String] = [""] // Which fields, if any, to expand + +// Update an interaction stats rule +PutAlertingInteractionstatsRuleRequest.putAlertingInteractionstatsRule(ruleId: ruleId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAlertingInteractionstatsRuleRequest.putAlertingInteractionstatsRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAlertingRule-example.txt b/build/docs/putAlertingRule-example.txt new file mode 100644 index 000000000..6f72b1104 --- /dev/null +++ b/build/docs/putAlertingRule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleId: String = "" // Rule Id +let body: ModifiableRuleProperties = new ModifiableRuleProperties(...) // rule to be updated + +// Update a rule +PutAlertingRuleRequest.putAlertingRule(ruleId: ruleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAlertingRuleRequest.putAlertingRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAnalyticsDataretentionSettings-example.txt b/build/docs/putAnalyticsDataretentionSettings-example.txt new file mode 100644 index 000000000..6f6eecf80 --- /dev/null +++ b/build/docs/putAnalyticsDataretentionSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: UpdateAnalyticsDataRetentionRequest = new UpdateAnalyticsDataRetentionRequest(...) // retentionDays + +// Update analytics data retention setting +PutAnalyticsDataretentionSettingsRequest.putAnalyticsDataretentionSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAnalyticsDataretentionSettingsRequest.putAnalyticsDataretentionSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAnalyticsReportingSchedule-example.txt b/build/docs/putAnalyticsReportingSchedule-example.txt new file mode 100644 index 000000000..e36282948 --- /dev/null +++ b/build/docs/putAnalyticsReportingSchedule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID +let body: ReportSchedule = new ReportSchedule(...) // ReportSchedule + +// Update a scheduled report job. +PutAnalyticsReportingScheduleRequest.putAnalyticsReportingSchedule(scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAnalyticsReportingScheduleRequest.putAnalyticsReportingSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectEmergencygroup-example.txt b/build/docs/putArchitectEmergencygroup-example.txt new file mode 100644 index 000000000..318a49025 --- /dev/null +++ b/build/docs/putArchitectEmergencygroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emergencyGroupId: String = "" // Emergency group ID +let body: EmergencyGroup = new EmergencyGroup(...) // + +// Updates a emergency group by ID +PutArchitectEmergencygroupRequest.putArchitectEmergencygroup(emergencyGroupId: emergencyGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectEmergencygroupRequest.putArchitectEmergencygroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectIvr-example.txt b/build/docs/putArchitectIvr-example.txt new file mode 100644 index 000000000..52aeb9362 --- /dev/null +++ b/build/docs/putArchitectIvr-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ivrId: String = "" // IVR id +let body: IVR = new IVR(...) // + +// Update an IVR Config. +PutArchitectIvrRequest.putArchitectIvr(ivrId: ivrId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectIvrRequest.putArchitectIvr was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectPrompt-example.txt b/build/docs/putArchitectPrompt-example.txt new file mode 100644 index 000000000..09018b4c3 --- /dev/null +++ b/build/docs/putArchitectPrompt-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let body: Prompt = new Prompt(...) // + +// Update specified user prompt +PutArchitectPromptRequest.putArchitectPrompt(promptId: promptId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectPromptRequest.putArchitectPrompt was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectPromptResource-example.txt b/build/docs/putArchitectPromptResource-example.txt new file mode 100644 index 000000000..c45cdb071 --- /dev/null +++ b/build/docs/putArchitectPromptResource-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language +let body: PromptAsset = new PromptAsset(...) // + +// Update specified user prompt resource +PutArchitectPromptResourceRequest.putArchitectPromptResource(promptId: promptId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectPromptResourceRequest.putArchitectPromptResource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectSchedule-example.txt b/build/docs/putArchitectSchedule-example.txt new file mode 100644 index 000000000..b85559387 --- /dev/null +++ b/build/docs/putArchitectSchedule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleId: String = "" // Schedule ID +let body: Schedule = new Schedule(...) // + +// Update schedule by ID +PutArchitectScheduleRequest.putArchitectSchedule(scheduleId: scheduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectScheduleRequest.putArchitectSchedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectSchedulegroup-example.txt b/build/docs/putArchitectSchedulegroup-example.txt new file mode 100644 index 000000000..58a692eba --- /dev/null +++ b/build/docs/putArchitectSchedulegroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let scheduleGroupId: String = "" // Schedule group ID +let body: ScheduleGroup = new ScheduleGroup(...) // + +// Updates a schedule group by ID +PutArchitectSchedulegroupRequest.putArchitectSchedulegroup(scheduleGroupId: scheduleGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectSchedulegroupRequest.putArchitectSchedulegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putArchitectSystempromptResource-example.txt b/build/docs/putArchitectSystempromptResource-example.txt new file mode 100644 index 000000000..df52247ae --- /dev/null +++ b/build/docs/putArchitectSystempromptResource-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let promptId: String = "" // Prompt ID +let languageCode: String = "" // Language +let body: SystemPromptAsset = new SystemPromptAsset(...) // + +// Updates a system prompt resource override. +PutArchitectSystempromptResourceRequest.putArchitectSystempromptResource(promptId: promptId, languageCode: languageCode, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutArchitectSystempromptResourceRequest.putArchitectSystempromptResource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAuthorizationDivision-example.txt b/build/docs/putAuthorizationDivision-example.txt new file mode 100644 index 000000000..5804a6bbf --- /dev/null +++ b/build/docs/putAuthorizationDivision-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let divisionId: String = "" // Division ID +let body: AuthzDivision = new AuthzDivision(...) // Updated division data + +// Update a division. +PutAuthorizationDivisionRequest.putAuthorizationDivision(divisionId: divisionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAuthorizationDivisionRequest.putAuthorizationDivision was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAuthorizationRole-example.txt b/build/docs/putAuthorizationRole-example.txt new file mode 100644 index 000000000..473469d35 --- /dev/null +++ b/build/docs/putAuthorizationRole-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let body: DomainOrganizationRoleUpdate = new DomainOrganizationRoleUpdate(...) // Organization role + +// Update an organization role. +PutAuthorizationRoleRequest.putAuthorizationRole(roleId: roleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAuthorizationRoleRequest.putAuthorizationRole was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAuthorizationRoleUsersAdd-example.txt b/build/docs/putAuthorizationRoleUsersAdd-example.txt new file mode 100644 index 000000000..3b6b15c68 --- /dev/null +++ b/build/docs/putAuthorizationRoleUsersAdd-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let body: [String] = [""] // List of user IDs + +// Sets the users for the role +PutAuthorizationRoleUsersAddRequest.putAuthorizationRoleUsersAdd(roleId: roleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAuthorizationRoleUsersAddRequest.putAuthorizationRoleUsersAdd was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAuthorizationRoleUsersRemove-example.txt b/build/docs/putAuthorizationRoleUsersRemove-example.txt new file mode 100644 index 000000000..dc5f2015c --- /dev/null +++ b/build/docs/putAuthorizationRoleUsersRemove-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let roleId: String = "" // Role ID +let body: [String] = [""] // List of user IDs + +// Removes the users from the role +PutAuthorizationRoleUsersRemoveRequest.putAuthorizationRoleUsersRemove(roleId: roleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAuthorizationRoleUsersRemoveRequest.putAuthorizationRoleUsersRemove was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putAuthorizationRolesDefault-example.txt b/build/docs/putAuthorizationRolesDefault-example.txt new file mode 100644 index 000000000..127a13f77 --- /dev/null +++ b/build/docs/putAuthorizationRolesDefault-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [DomainOrganizationRole] = [new DomainOrganizationRole(...)] // Organization roles list + +// Restore specified default roles +PutAuthorizationRolesDefaultRequest.putAuthorizationRolesDefault(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutAuthorizationRolesDefaultRequest.putAuthorizationRolesDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putChatSettings-example.txt b/build/docs/putChatSettings-example.txt new file mode 100644 index 000000000..abb6d3a23 --- /dev/null +++ b/build/docs/putChatSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ChatSettings = new ChatSettings(...) // Chat + +// Update Chat Settings. +PutChatSettingsRequest.putChatSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutChatSettingsRequest.putChatSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putChatsSettings-example.txt b/build/docs/putChatsSettings-example.txt new file mode 100644 index 000000000..1adf6eb08 --- /dev/null +++ b/build/docs/putChatsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ChatSettings = new ChatSettings(...) // Chat + +// Update Chat Settings. +PutChatsSettingsRequest.putChatsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutChatsSettingsRequest.putChatsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putContentmanagementWorkspace-example.txt b/build/docs/putContentmanagementWorkspace-example.txt new file mode 100644 index 000000000..e027fac6e --- /dev/null +++ b/build/docs/putContentmanagementWorkspace-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let body: Workspace = new Workspace(...) // Workspace + +// Update a workspace +PutContentmanagementWorkspaceRequest.putContentmanagementWorkspace(workspaceId: workspaceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutContentmanagementWorkspaceRequest.putContentmanagementWorkspace was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putContentmanagementWorkspaceMember-example.txt b/build/docs/putContentmanagementWorkspaceMember-example.txt new file mode 100644 index 000000000..74726ced9 --- /dev/null +++ b/build/docs/putContentmanagementWorkspaceMember-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let memberId: String = "" // Member ID +let body: WorkspaceMember = new WorkspaceMember(...) // Workspace Member + +// Add a member to a workspace +PutContentmanagementWorkspaceMemberRequest.putContentmanagementWorkspaceMember(workspaceId: workspaceId, memberId: memberId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutContentmanagementWorkspaceMemberRequest.putContentmanagementWorkspaceMember was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putContentmanagementWorkspaceTagvalue-example.txt b/build/docs/putContentmanagementWorkspaceTagvalue-example.txt new file mode 100644 index 000000000..2174fd698 --- /dev/null +++ b/build/docs/putContentmanagementWorkspaceTagvalue-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let workspaceId: String = "" // Workspace ID +let tagId: String = "" // Tag ID +let body: TagValue = new TagValue(...) // Workspace + +// Update a workspace tag. Will update all documents with the new tag value. +PutContentmanagementWorkspaceTagvalueRequest.putContentmanagementWorkspaceTagvalue(workspaceId: workspaceId, tagId: tagId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutContentmanagementWorkspaceTagvalueRequest.putContentmanagementWorkspaceTagvalue was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationParticipantFlaggedreason-example.txt b/build/docs/putConversationParticipantFlaggedreason-example.txt new file mode 100644 index 000000000..337266ae8 --- /dev/null +++ b/build/docs/putConversationParticipantFlaggedreason-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let participantId: String = "" // participant ID + +// Set flagged reason on conversation participant to indicate bad conversation quality. +PutConversationParticipantFlaggedreasonRequest.putConversationParticipantFlaggedreason(conversationId: conversationId, participantId: participantId) { (error) in + if let error = error { + dump(error) + } else { + print("PutConversationParticipantFlaggedreasonRequest.putConversationParticipantFlaggedreason was successful") + } +} \ No newline at end of file diff --git a/build/docs/putConversationRecording-example.txt b/build/docs/putConversationRecording-example.txt new file mode 100644 index 000000000..1183ca831 --- /dev/null +++ b/build/docs/putConversationRecording-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let body: Recording = new Recording(...) // recording +let clearExport: Bool = true // Whether to clear the pending export for the recording + +// Updates the retention records on a recording. +PutConversationRecordingRequest.putConversationRecording(conversationId: conversationId, recordingId: recordingId, body: body, clearExport: clearExport) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationRecordingRequest.putConversationRecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationRecordingAnnotation-example.txt b/build/docs/putConversationRecordingAnnotation-example.txt new file mode 100644 index 000000000..6d600a219 --- /dev/null +++ b/build/docs/putConversationRecordingAnnotation-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let recordingId: String = "" // Recording ID +let annotationId: String = "" // Annotation ID +let body: Annotation = new Annotation(...) // annotation + +// Update annotation +PutConversationRecordingAnnotationRequest.putConversationRecordingAnnotation(conversationId: conversationId, recordingId: recordingId, annotationId: annotationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationRecordingAnnotationRequest.putConversationRecordingAnnotation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationSecureattributes-example.txt b/build/docs/putConversationSecureattributes-example.txt new file mode 100644 index 000000000..ce1fadd35 --- /dev/null +++ b/build/docs/putConversationSecureattributes-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let body: ConversationSecureAttributes = new ConversationSecureAttributes(...) // Conversation Secure Attributes + +// Set the secure attributes on a conversation. +PutConversationSecureattributesRequest.putConversationSecureattributes(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationSecureattributesRequest.putConversationSecureattributes was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationTags-example.txt b/build/docs/putConversationTags-example.txt new file mode 100644 index 000000000..942f59f5f --- /dev/null +++ b/build/docs/putConversationTags-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversation ID +let body: ConversationTagsUpdate = new ConversationTagsUpdate(...) // Conversation Tags + +// Update the tags on a conversation. +PutConversationTagsRequest.putConversationTags(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationTagsRequest.putConversationTags was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsCallParticipantCommunicationUuidata-example.txt b/build/docs/putConversationsCallParticipantCommunicationUuidata-example.txt new file mode 100644 index 000000000..cb7f25358 --- /dev/null +++ b/build/docs/putConversationsCallParticipantCommunicationUuidata-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let participantId: String = "" // participantId +let communicationId: String = "" // communicationId +let body: SetUuiDataRequest = new SetUuiDataRequest(...) // UUIData Request + +// Set uuiData to be sent on future commands. +PutConversationsCallParticipantCommunicationUuidataRequest.putConversationsCallParticipantCommunicationUuidata(conversationId: conversationId, participantId: participantId, communicationId: communicationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsCallParticipantCommunicationUuidataRequest.putConversationsCallParticipantCommunicationUuidata was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsCallRecordingstate-example.txt b/build/docs/putConversationsCallRecordingstate-example.txt new file mode 100644 index 000000000..c65d23fdb --- /dev/null +++ b/build/docs/putConversationsCallRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsCallRecordingstateRequest.putConversationsCallRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsCallRecordingstateRequest.putConversationsCallRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsCallbackRecordingstate-example.txt b/build/docs/putConversationsCallbackRecordingstate-example.txt new file mode 100644 index 000000000..abe2b141b --- /dev/null +++ b/build/docs/putConversationsCallbackRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsCallbackRecordingstateRequest.putConversationsCallbackRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsCallbackRecordingstateRequest.putConversationsCallbackRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsChatRecordingstate-example.txt b/build/docs/putConversationsChatRecordingstate-example.txt new file mode 100644 index 000000000..e9bc89737 --- /dev/null +++ b/build/docs/putConversationsChatRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsChatRecordingstateRequest.putConversationsChatRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsChatRecordingstateRequest.putConversationsChatRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsCobrowsesessionRecordingstate-example.txt b/build/docs/putConversationsCobrowsesessionRecordingstate-example.txt new file mode 100644 index 000000000..23f7369e5 --- /dev/null +++ b/build/docs/putConversationsCobrowsesessionRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsCobrowsesessionRecordingstateRequest.putConversationsCobrowsesessionRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsCobrowsesessionRecordingstateRequest.putConversationsCobrowsesessionRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsEmailMessagesDraft-example.txt b/build/docs/putConversationsEmailMessagesDraft-example.txt new file mode 100644 index 000000000..153d18eb2 --- /dev/null +++ b/build/docs/putConversationsEmailMessagesDraft-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: EmailMessage = new EmailMessage(...) // Draft + +// Update conversation draft reply +PutConversationsEmailMessagesDraftRequest.putConversationsEmailMessagesDraft(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsEmailMessagesDraftRequest.putConversationsEmailMessagesDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsEmailRecordingstate-example.txt b/build/docs/putConversationsEmailRecordingstate-example.txt new file mode 100644 index 000000000..c101a37a3 --- /dev/null +++ b/build/docs/putConversationsEmailRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsEmailRecordingstateRequest.putConversationsEmailRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsEmailRecordingstateRequest.putConversationsEmailRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsKeyconfiguration-example.txt b/build/docs/putConversationsKeyconfiguration-example.txt new file mode 100644 index 000000000..14aefc690 --- /dev/null +++ b/build/docs/putConversationsKeyconfiguration-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let keyconfigurationsId: String = "" // Key Configurations Id +let body: ConversationEncryptionConfiguration = new ConversationEncryptionConfiguration(...) // Encryption key configuration metadata + +// Update the encryption key configurations +PutConversationsKeyconfigurationRequest.putConversationsKeyconfiguration(keyconfigurationsId: keyconfigurationsId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsKeyconfigurationRequest.putConversationsKeyconfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsMessageRecordingstate-example.txt b/build/docs/putConversationsMessageRecordingstate-example.txt new file mode 100644 index 000000000..8bc5ad1ba --- /dev/null +++ b/build/docs/putConversationsMessageRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsMessageRecordingstateRequest.putConversationsMessageRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsMessageRecordingstateRequest.putConversationsMessageRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsMessagingIntegrationsLineIntegrationId-example.txt b/build/docs/putConversationsMessagingIntegrationsLineIntegrationId-example.txt new file mode 100644 index 000000000..b8e6ea452 --- /dev/null +++ b/build/docs/putConversationsMessagingIntegrationsLineIntegrationId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration ID +let body: LineIntegrationRequest = new LineIntegrationRequest(...) // LineIntegrationRequest + +// Update a LINE messenger integration +PutConversationsMessagingIntegrationsLineIntegrationIdRequest.putConversationsMessagingIntegrationsLineIntegrationId(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsMessagingIntegrationsLineIntegrationIdRequest.putConversationsMessagingIntegrationsLineIntegrationId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsMessagingSettingsDefault-example.txt b/build/docs/putConversationsMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..059e5c0ad --- /dev/null +++ b/build/docs/putConversationsMessagingSettingsDefault-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MessagingSettingDefaultRequest = new MessagingSettingDefaultRequest(...) // MessagingSetting + +// Set the organization's default setting that may be applied to to integrations without settings +PutConversationsMessagingSettingsDefaultRequest.putConversationsMessagingSettingsDefault(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsMessagingSettingsDefaultRequest.putConversationsMessagingSettingsDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsMessagingSupportedcontentDefault-example.txt b/build/docs/putConversationsMessagingSupportedcontentDefault-example.txt new file mode 100644 index 000000000..fe6b64be2 --- /dev/null +++ b/build/docs/putConversationsMessagingSupportedcontentDefault-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SupportedContentReference = new SupportedContentReference(...) // SupportedContent + +// Set the organization's default supported content profile that may be assigned to an integration when it is created. +PutConversationsMessagingSupportedcontentDefaultRequest.putConversationsMessagingSupportedcontentDefault(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsMessagingSupportedcontentDefaultRequest.putConversationsMessagingSupportedcontentDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsMessagingThreadingtimeline-example.txt b/build/docs/putConversationsMessagingThreadingtimeline-example.txt new file mode 100644 index 000000000..63916c4b2 --- /dev/null +++ b/build/docs/putConversationsMessagingThreadingtimeline-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ConversationThreadingWindow = new ConversationThreadingWindow(...) // ConversationThreadingWindowRequest + +// Update conversation threading window timeline for each messaging type +PutConversationsMessagingThreadingtimelineRequest.putConversationsMessagingThreadingtimeline(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsMessagingThreadingtimelineRequest.putConversationsMessagingThreadingtimeline was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsScreenshareRecordingstate-example.txt b/build/docs/putConversationsScreenshareRecordingstate-example.txt new file mode 100644 index 000000000..4b977289c --- /dev/null +++ b/build/docs/putConversationsScreenshareRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsScreenshareRecordingstateRequest.putConversationsScreenshareRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsScreenshareRecordingstateRequest.putConversationsScreenshareRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsSocialRecordingstate-example.txt b/build/docs/putConversationsSocialRecordingstate-example.txt new file mode 100644 index 000000000..64f8afd41 --- /dev/null +++ b/build/docs/putConversationsSocialRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsSocialRecordingstateRequest.putConversationsSocialRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsSocialRecordingstateRequest.putConversationsSocialRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putConversationsVideoRecordingstate-example.txt b/build/docs/putConversationsVideoRecordingstate-example.txt new file mode 100644 index 000000000..1360553ca --- /dev/null +++ b/build/docs/putConversationsVideoRecordingstate-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let body: SetRecordingState = new SetRecordingState(...) // SetRecordingState + +// Update a conversation by setting its recording state +PutConversationsVideoRecordingstateRequest.putConversationsVideoRecordingstate(conversationId: conversationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutConversationsVideoRecordingstateRequest.putConversationsVideoRecordingstate was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsContact-example.txt b/build/docs/putExternalcontactsContact-example.txt new file mode 100644 index 000000000..a1a0e657e --- /dev/null +++ b/build/docs/putExternalcontactsContact-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact ID +let body: ExternalContact = new ExternalContact(...) // ExternalContact + +// Update an external contact +PutExternalcontactsContactRequest.putExternalcontactsContact(contactId: contactId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsContactRequest.putExternalcontactsContact was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsContactNote-example.txt b/build/docs/putExternalcontactsContactNote-example.txt new file mode 100644 index 000000000..25ff0c7b1 --- /dev/null +++ b/build/docs/putExternalcontactsContactNote-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactId: String = "" // ExternalContact Id +let noteId: String = "" // Note Id +let body: Note = new Note(...) // Note + +// Update a note for an external contact +PutExternalcontactsContactNoteRequest.putExternalcontactsContactNote(contactId: contactId, noteId: noteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsContactNoteRequest.putExternalcontactsContactNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsContactsSchema-example.txt b/build/docs/putExternalcontactsContactsSchema-example.txt new file mode 100644 index 000000000..5f7803107 --- /dev/null +++ b/build/docs/putExternalcontactsContactsSchema-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID +let body: DataSchema = new DataSchema(...) // Data Schema + +// Update a schema +PutExternalcontactsContactsSchemaRequest.putExternalcontactsContactsSchema(schemaId: schemaId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsContactsSchemaRequest.putExternalcontactsContactsSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsConversation-example.txt b/build/docs/putExternalcontactsConversation-example.txt new file mode 100644 index 000000000..5d7295e9f --- /dev/null +++ b/build/docs/putExternalcontactsConversation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // Conversation ID +let body: ConversationAssociation = new ConversationAssociation(...) // ConversationAssociation + +// Associate/disassociate an external contact with a conversation +PutExternalcontactsConversationRequest.putExternalcontactsConversation(conversationId: conversationId, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PutExternalcontactsConversationRequest.putExternalcontactsConversation was successful") + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsOrganization-example.txt b/build/docs/putExternalcontactsOrganization-example.txt new file mode 100644 index 000000000..7e1fd5013 --- /dev/null +++ b/build/docs/putExternalcontactsOrganization-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID +let body: ExternalOrganization = new ExternalOrganization(...) // ExternalOrganization + +// Update an external organization +PutExternalcontactsOrganizationRequest.putExternalcontactsOrganization(externalOrganizationId: externalOrganizationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsOrganizationRequest.putExternalcontactsOrganization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsOrganizationNote-example.txt b/build/docs/putExternalcontactsOrganizationNote-example.txt new file mode 100644 index 000000000..55aec4026 --- /dev/null +++ b/build/docs/putExternalcontactsOrganizationNote-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization Id +let noteId: String = "" // Note Id +let body: Note = new Note(...) // Note + +// Update a note for an external organization +PutExternalcontactsOrganizationNoteRequest.putExternalcontactsOrganizationNote(externalOrganizationId: externalOrganizationId, noteId: noteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsOrganizationNoteRequest.putExternalcontactsOrganizationNote was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsOrganizationTrustorTrustorId-example.txt b/build/docs/putExternalcontactsOrganizationTrustorTrustorId-example.txt new file mode 100644 index 000000000..fb5d095c4 --- /dev/null +++ b/build/docs/putExternalcontactsOrganizationTrustorTrustorId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let externalOrganizationId: String = "" // External Organization ID +let trustorId: String = "" // Trustor ID + +// Links a Trustor with an External Organization +PutExternalcontactsOrganizationTrustorTrustorIdRequest.putExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId: externalOrganizationId, trustorId: trustorId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsOrganizationTrustorTrustorIdRequest.putExternalcontactsOrganizationTrustorTrustorId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsOrganizationsSchema-example.txt b/build/docs/putExternalcontactsOrganizationsSchema-example.txt new file mode 100644 index 000000000..a29cbfafd --- /dev/null +++ b/build/docs/putExternalcontactsOrganizationsSchema-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let schemaId: String = "" // Schema ID +let body: DataSchema = new DataSchema(...) // Data Schema + +// Update a schema +PutExternalcontactsOrganizationsSchemaRequest.putExternalcontactsOrganizationsSchema(schemaId: schemaId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsOrganizationsSchemaRequest.putExternalcontactsOrganizationsSchema was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putExternalcontactsRelationship-example.txt b/build/docs/putExternalcontactsRelationship-example.txt new file mode 100644 index 000000000..78a77fdf4 --- /dev/null +++ b/build/docs/putExternalcontactsRelationship-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let relationshipId: String = "" // Relationship Id +let body: Relationship = new Relationship(...) // Relationship + +// Update a relationship +PutExternalcontactsRelationshipRequest.putExternalcontactsRelationship(relationshipId: relationshipId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutExternalcontactsRelationshipRequest.putExternalcontactsRelationship was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFaxDocument-example.txt b/build/docs/putFaxDocument-example.txt new file mode 100644 index 000000000..17200ba42 --- /dev/null +++ b/build/docs/putFaxDocument-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let documentId: String = "" // Document ID +let body: FaxDocument = new FaxDocument(...) // Document + +// Update a fax document. +PutFaxDocumentRequest.putFaxDocument(documentId: documentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFaxDocumentRequest.putFaxDocument was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFlow-example.txt b/build/docs/putFlow-example.txt new file mode 100644 index 000000000..9ad70088e --- /dev/null +++ b/build/docs/putFlow-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowId: String = "" // Flow ID +let body: Flow = new Flow(...) // + +// Update flow +PutFlowRequest.putFlow(flowId: flowId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFlowRequest.putFlow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFlowsDatatable-example.txt b/build/docs/putFlowsDatatable-example.txt new file mode 100644 index 000000000..33768403f --- /dev/null +++ b/build/docs/putFlowsDatatable-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let body: DataTable = new DataTable(...) // datatable json-schema +let expand: PutFlowsDatatableRequest.Expand_putFlowsDatatable = PutFlowsDatatableRequest.Expand_putFlowsDatatable.enummember // Expand instructions for the result + +// Updates a specific datatable by id +PutFlowsDatatableRequest.putFlowsDatatable(datatableId: datatableId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFlowsDatatableRequest.putFlowsDatatable was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFlowsDatatableRow-example.txt b/build/docs/putFlowsDatatableRow-example.txt new file mode 100644 index 000000000..dc8d7a235 --- /dev/null +++ b/build/docs/putFlowsDatatableRow-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let datatableId: String = "" // id of datatable +let rowId: String = "" // the key for the row +let body: [String:JSON] = new JSON(...) // datatable row + +// Update a row entry +PutFlowsDatatableRowRequest.putFlowsDatatableRow(datatableId: datatableId, rowId: rowId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFlowsDatatableRowRequest.putFlowsDatatableRow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFlowsMilestone-example.txt b/build/docs/putFlowsMilestone-example.txt new file mode 100644 index 000000000..b2e5955b9 --- /dev/null +++ b/build/docs/putFlowsMilestone-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let milestoneId: String = "" // flow milestone ID +let body: FlowMilestone = new FlowMilestone(...) // + +// Updates a flow milestone +PutFlowsMilestoneRequest.putFlowsMilestone(milestoneId: milestoneId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFlowsMilestoneRequest.putFlowsMilestone was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putFlowsOutcome-example.txt b/build/docs/putFlowsOutcome-example.txt new file mode 100644 index 000000000..d839a475e --- /dev/null +++ b/build/docs/putFlowsOutcome-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let flowOutcomeId: String = "" // flow outcome ID +let body: FlowOutcome = new FlowOutcome(...) // + +// Updates a flow outcome +PutFlowsOutcomeRequest.putFlowsOutcome(flowOutcomeId: flowOutcomeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutFlowsOutcomeRequest.putFlowsOutcome was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGamificationProfile-example.txt b/build/docs/putGamificationProfile-example.txt new file mode 100644 index 000000000..f599428f8 --- /dev/null +++ b/build/docs/putGamificationProfile-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // performanceProfileId +let body: PerformanceProfile = new PerformanceProfile(...) // performanceProfile + +// Updates a performance profile +PutGamificationProfileRequest.putGamificationProfile(profileId: profileId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGamificationProfileRequest.putGamificationProfile was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGamificationProfileMetric-example.txt b/build/docs/putGamificationProfileMetric-example.txt new file mode 100644 index 000000000..954bd70cb --- /dev/null +++ b/build/docs/putGamificationProfileMetric-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let profileId: String = "" // Performance Profile Id +let metricId: String = "" // Metric Id +let body: CreateMetric = new CreateMetric(...) // Metric + +// Updates a metric in performance profile +PutGamificationProfileMetricRequest.putGamificationProfileMetric(profileId: profileId, metricId: metricId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGamificationProfileMetricRequest.putGamificationProfileMetric was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGamificationStatus-example.txt b/build/docs/putGamificationStatus-example.txt new file mode 100644 index 000000000..8fa1d7667 --- /dev/null +++ b/build/docs/putGamificationStatus-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let status: GamificationStatus = new GamificationStatus(...) // Gamification status + +// Update gamification activation status +PutGamificationStatusRequest.putGamificationStatus(status: status) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGamificationStatusRequest.putGamificationStatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGreeting-example.txt b/build/docs/putGreeting-example.txt new file mode 100644 index 000000000..bae2dfa85 --- /dev/null +++ b/build/docs/putGreeting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let greetingId: String = "" // Greeting ID +let body: Greeting = new Greeting(...) // The updated Greeting + +// Updates the Greeting with the given GreetingId +PutGreetingRequest.putGreeting(greetingId: greetingId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGreetingRequest.putGreeting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGreetingsDefaults-example.txt b/build/docs/putGreetingsDefaults-example.txt new file mode 100644 index 000000000..d5afa8d26 --- /dev/null +++ b/build/docs/putGreetingsDefaults-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList + +// Update an Organization's DefaultGreetingList +PutGreetingsDefaultsRequest.putGreetingsDefaults(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGreetingsDefaultsRequest.putGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGroup-example.txt b/build/docs/putGroup-example.txt new file mode 100644 index 000000000..a05881b77 --- /dev/null +++ b/build/docs/putGroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let body: GroupUpdate = new GroupUpdate(...) // Group + +// Update group +PutGroupRequest.putGroup(groupId: groupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGroupRequest.putGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putGroupGreetingsDefaults-example.txt b/build/docs/putGroupGreetingsDefaults-example.txt new file mode 100644 index 000000000..2d142283b --- /dev/null +++ b/build/docs/putGroupGreetingsDefaults-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // Group ID +let body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList + +// Updates the DefaultGreetingList of the specified Group +PutGroupGreetingsDefaultsRequest.putGroupGreetingsDefaults(groupId: groupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutGroupGreetingsDefaultsRequest.putGroupGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersAdfs-example.txt b/build/docs/putIdentityprovidersAdfs-example.txt new file mode 100644 index 000000000..ef3680b8f --- /dev/null +++ b/build/docs/putIdentityprovidersAdfs-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: ADFS = new ADFS(...) // Provider + +// Update/Create ADFS Identity Provider +PutIdentityprovidersAdfsRequest.putIdentityprovidersAdfs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersAdfsRequest.putIdentityprovidersAdfs was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersCic-example.txt b/build/docs/putIdentityprovidersCic-example.txt new file mode 100644 index 000000000..93f29f18c --- /dev/null +++ b/build/docs/putIdentityprovidersCic-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: CustomerInteractionCenter = new CustomerInteractionCenter(...) // Provider + +// Update/Create Customer Interaction Center (CIC) Identity Provider +PutIdentityprovidersCicRequest.putIdentityprovidersCic(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersCicRequest.putIdentityprovidersCic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersGeneric-example.txt b/build/docs/putIdentityprovidersGeneric-example.txt new file mode 100644 index 000000000..7d1a1a16b --- /dev/null +++ b/build/docs/putIdentityprovidersGeneric-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GenericSAML = new GenericSAML(...) // Provider + +// Update/Create Generic SAML Identity Provider +PutIdentityprovidersGenericRequest.putIdentityprovidersGeneric(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersGenericRequest.putIdentityprovidersGeneric was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersGsuite-example.txt b/build/docs/putIdentityprovidersGsuite-example.txt new file mode 100644 index 000000000..4183372ce --- /dev/null +++ b/build/docs/putIdentityprovidersGsuite-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: GSuite = new GSuite(...) // Provider + +// Update/Create G Suite Identity Provider +PutIdentityprovidersGsuiteRequest.putIdentityprovidersGsuite(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersGsuiteRequest.putIdentityprovidersGsuite was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersIdentitynow-example.txt b/build/docs/putIdentityprovidersIdentitynow-example.txt new file mode 100644 index 000000000..8ad9c5a9f --- /dev/null +++ b/build/docs/putIdentityprovidersIdentitynow-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: IdentityNow = new IdentityNow(...) // Provider + +// Update/Create IdentityNow Provider +PutIdentityprovidersIdentitynowRequest.putIdentityprovidersIdentitynow(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersIdentitynowRequest.putIdentityprovidersIdentitynow was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersOkta-example.txt b/build/docs/putIdentityprovidersOkta-example.txt new file mode 100644 index 000000000..1792f8e72 --- /dev/null +++ b/build/docs/putIdentityprovidersOkta-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Okta = new Okta(...) // Provider + +// Update/Create Okta Identity Provider +PutIdentityprovidersOktaRequest.putIdentityprovidersOkta(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersOktaRequest.putIdentityprovidersOkta was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersOnelogin-example.txt b/build/docs/putIdentityprovidersOnelogin-example.txt new file mode 100644 index 000000000..1671275fc --- /dev/null +++ b/build/docs/putIdentityprovidersOnelogin-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OneLogin = new OneLogin(...) // Provider + +// Update/Create OneLogin Identity Provider +PutIdentityprovidersOneloginRequest.putIdentityprovidersOnelogin(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersOneloginRequest.putIdentityprovidersOnelogin was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersPing-example.txt b/build/docs/putIdentityprovidersPing-example.txt new file mode 100644 index 000000000..33ad968a3 --- /dev/null +++ b/build/docs/putIdentityprovidersPing-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PingIdentity = new PingIdentity(...) // Provider + +// Update/Create Ping Identity Provider +PutIdentityprovidersPingRequest.putIdentityprovidersPing(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersPingRequest.putIdentityprovidersPing was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersPurecloud-example.txt b/build/docs/putIdentityprovidersPurecloud-example.txt new file mode 100644 index 000000000..8bd19630f --- /dev/null +++ b/build/docs/putIdentityprovidersPurecloud-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PureCloud = new PureCloud(...) // Provider + +// Update/Create PureCloud Identity Provider +PutIdentityprovidersPurecloudRequest.putIdentityprovidersPurecloud(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersPurecloudRequest.putIdentityprovidersPurecloud was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersPureengage-example.txt b/build/docs/putIdentityprovidersPureengage-example.txt new file mode 100644 index 000000000..b5aa905cc --- /dev/null +++ b/build/docs/putIdentityprovidersPureengage-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PureEngage = new PureEngage(...) // Provider + +// Update/Create PureEngage Identity Provider +PutIdentityprovidersPureengageRequest.putIdentityprovidersPureengage(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersPureengageRequest.putIdentityprovidersPureengage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIdentityprovidersSalesforce-example.txt b/build/docs/putIdentityprovidersSalesforce-example.txt new file mode 100644 index 000000000..59c7113e4 --- /dev/null +++ b/build/docs/putIdentityprovidersSalesforce-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Salesforce = new Salesforce(...) // Provider + +// Update/Create Salesforce Identity Provider +PutIdentityprovidersSalesforceRequest.putIdentityprovidersSalesforce(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIdentityprovidersSalesforceRequest.putIdentityprovidersSalesforce was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIntegrationConfigCurrent-example.txt b/build/docs/putIntegrationConfigCurrent-example.txt new file mode 100644 index 000000000..80b444f20 --- /dev/null +++ b/build/docs/putIntegrationConfigCurrent-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // Integration Id +let body: IntegrationConfiguration = new IntegrationConfiguration(...) // Integration Configuration + +// Update integration configuration. +PutIntegrationConfigCurrentRequest.putIntegrationConfigCurrent(integrationId: integrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIntegrationConfigCurrentRequest.putIntegrationConfigCurrent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIntegrationsBotconnectorIntegrationIdBots-example.txt b/build/docs/putIntegrationsBotconnectorIntegrationIdBots-example.txt new file mode 100644 index 000000000..d8252a00f --- /dev/null +++ b/build/docs/putIntegrationsBotconnectorIntegrationIdBots-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let integrationId: String = "" // The integration ID for this group of bots +let botList: BotList = new BotList(...) // + +// Set a list of botConnector bots plus versions for this integration +PutIntegrationsBotconnectorIntegrationIdBotsRequest.putIntegrationsBotconnectorIntegrationIdBots(integrationId: integrationId, botList: botList) { (error) in + if let error = error { + dump(error) + } else { + print("PutIntegrationsBotconnectorIntegrationIdBotsRequest.putIntegrationsBotconnectorIntegrationIdBots was successful") + } +} \ No newline at end of file diff --git a/build/docs/putIntegrationsCredential-example.txt b/build/docs/putIntegrationsCredential-example.txt new file mode 100644 index 000000000..c6ed09ec6 --- /dev/null +++ b/build/docs/putIntegrationsCredential-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let credentialId: String = "" // Credential ID +let body: Credential = new Credential(...) // Credential + +// Update a set of credentials +PutIntegrationsCredentialRequest.putIntegrationsCredential(credentialId: credentialId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIntegrationsCredentialRequest.putIntegrationsCredential was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIntegrationsSpeechTtsSettings-example.txt b/build/docs/putIntegrationsSpeechTtsSettings-example.txt new file mode 100644 index 000000000..3ac5e0c65 --- /dev/null +++ b/build/docs/putIntegrationsSpeechTtsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TtsSettings = new TtsSettings(...) // Updated TtsSettings + +// Update TTS settings for an org +PutIntegrationsSpeechTtsSettingsRequest.putIntegrationsSpeechTtsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIntegrationsSpeechTtsSettingsRequest.putIntegrationsSpeechTtsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putIntegrationsUnifiedcommunicationThirdpartypresences-example.txt b/build/docs/putIntegrationsUnifiedcommunicationThirdpartypresences-example.txt new file mode 100644 index 000000000..70ed7a8ac --- /dev/null +++ b/build/docs/putIntegrationsUnifiedcommunicationThirdpartypresences-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ucIntegrationId: String = "" // UC Integration ID +let body: [UCThirdPartyPresence] = [new UCThirdPartyPresence(...)] // List of User presences + +// Bulk integration presence ingestion +PutIntegrationsUnifiedcommunicationThirdpartypresencesRequest.putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId: ucIntegrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutIntegrationsUnifiedcommunicationThirdpartypresencesRequest.putIntegrationsUnifiedcommunicationThirdpartypresences was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putLanguageunderstandingDomainVersion-example.txt b/build/docs/putLanguageunderstandingDomainVersion-example.txt new file mode 100644 index 000000000..6a85f47a8 --- /dev/null +++ b/build/docs/putLanguageunderstandingDomainVersion-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // ID of the NLU domain. +let domainVersionId: String = "" // ID of the NLU domain version. +let body: NluDomainVersion = new NluDomainVersion(...) // The updated NLU Domain Version. + +// Update an NLU Domain Version. +PutLanguageunderstandingDomainVersionRequest.putLanguageunderstandingDomainVersion(domainId: domainId, domainVersionId: domainVersionId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutLanguageunderstandingDomainVersionRequest.putLanguageunderstandingDomainVersion was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putLearningModule-example.txt b/build/docs/putLearningModule-example.txt new file mode 100644 index 000000000..574568426 --- /dev/null +++ b/build/docs/putLearningModule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let body: LearningModuleRequest = new LearningModuleRequest(...) // The learning module to be updated + +// Update a learning module +PutLearningModuleRequest.putLearningModule(moduleId: moduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutLearningModuleRequest.putLearningModule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putLearningModuleRule-example.txt b/build/docs/putLearningModuleRule-example.txt new file mode 100644 index 000000000..789f48098 --- /dev/null +++ b/build/docs/putLearningModuleRule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let moduleId: String = "" // The ID of the learning module +let body: LearningModuleRule = new LearningModuleRule(...) // The learning module rule to be updated + +// Update a learning module rule +PutLearningModuleRuleRequest.putLearningModuleRule(moduleId: moduleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutLearningModuleRuleRequest.putLearningModuleRule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putMessagingSettingsDefault-example.txt b/build/docs/putMessagingSettingsDefault-example.txt new file mode 100644 index 000000000..dcf858530 --- /dev/null +++ b/build/docs/putMessagingSettingsDefault-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: MessagingSettingDefaultRequest = new MessagingSettingDefaultRequest(...) // Messaging Setting ID + +// Set the organization's default settings that may be applied to an integration when it is created. +PutMessagingSettingsDefaultRequest.putMessagingSettingsDefault(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutMessagingSettingsDefaultRequest.putMessagingSettingsDefault was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putMobiledevice-example.txt b/build/docs/putMobiledevice-example.txt new file mode 100644 index 000000000..e0fbda75f --- /dev/null +++ b/build/docs/putMobiledevice-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deviceId: String = "" // Device ID +let body: UserDevice = new UserDevice(...) // Device + +// Update device +PutMobiledeviceRequest.putMobiledevice(deviceId: deviceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutMobiledeviceRequest.putMobiledevice was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putNotificationsChannelSubscriptions-example.txt b/build/docs/putNotificationsChannelSubscriptions-example.txt new file mode 100644 index 000000000..21c96c686 --- /dev/null +++ b/build/docs/putNotificationsChannelSubscriptions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let channelId: String = "" // Channel ID +let body: [ChannelTopic] = [new ChannelTopic(...)] // Body +let ignoreErrors: Bool = true // Optionally prevent throwing of errors for failed permissions checks. + +// Replace the current list of subscriptions with a new list. +PutNotificationsChannelSubscriptionsRequest.putNotificationsChannelSubscriptions(channelId: channelId, body: body, ignoreErrors: ignoreErrors) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutNotificationsChannelSubscriptionsRequest.putNotificationsChannelSubscriptions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOauthClient-example.txt b/build/docs/putOauthClient-example.txt new file mode 100644 index 000000000..cb5d653be --- /dev/null +++ b/build/docs/putOauthClient-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let clientId: String = "" // Client ID +let body: OAuthClientRequest = new OAuthClientRequest(...) // Client + +// Update OAuth Client +PutOauthClientRequest.putOauthClient(clientId: clientId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOauthClientRequest.putOauthClient was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrganizationsEmbeddedintegration-example.txt b/build/docs/putOrganizationsEmbeddedintegration-example.txt new file mode 100644 index 000000000..331554864 --- /dev/null +++ b/build/docs/putOrganizationsEmbeddedintegration-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: EmbeddedIntegration = new EmbeddedIntegration(...) // Whitelist settings + +// Update the list of domains that will be allowed to embed PureCloud applications +PutOrganizationsEmbeddedintegrationRequest.putOrganizationsEmbeddedintegration(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrganizationsEmbeddedintegrationRequest.putOrganizationsEmbeddedintegration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrganizationsIpaddressauthentication-example.txt b/build/docs/putOrganizationsIpaddressauthentication-example.txt new file mode 100644 index 000000000..39aaacc13 --- /dev/null +++ b/build/docs/putOrganizationsIpaddressauthentication-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: IpAddressAuthentication = new IpAddressAuthentication(...) // IP address Whitelist settings + +// Update organization IP address whitelist settings +PutOrganizationsIpaddressauthenticationRequest.putOrganizationsIpaddressauthentication(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrganizationsIpaddressauthenticationRequest.putOrganizationsIpaddressauthentication was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrganizationsMe-example.txt b/build/docs/putOrganizationsMe-example.txt new file mode 100644 index 000000000..2d1661070 --- /dev/null +++ b/build/docs/putOrganizationsMe-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Organization = new Organization(...) // Organization + +// Update organization. +PutOrganizationsMeRequest.putOrganizationsMe(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrganizationsMeRequest.putOrganizationsMe was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrganizationsWhitelist-example.txt b/build/docs/putOrganizationsWhitelist-example.txt new file mode 100644 index 000000000..4d15c5a06 --- /dev/null +++ b/build/docs/putOrganizationsWhitelist-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: OrgWhitelistSettings = new OrgWhitelistSettings(...) // Whitelist settings + +// This route is deprecated, please use /api/v2/organizations/authentication/settings instead +PutOrganizationsWhitelistRequest.putOrganizationsWhitelist(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrganizationsWhitelistRequest.putOrganizationsWhitelist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrustee-example.txt b/build/docs/putOrgauthorizationTrustee-example.txt new file mode 100644 index 000000000..3cbe7c1be --- /dev/null +++ b/build/docs/putOrgauthorizationTrustee-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let body: TrustUpdate = new TrustUpdate(...) // Client + +// Update Org Trust +PutOrgauthorizationTrusteeRequest.putOrgauthorizationTrustee(trusteeOrgId: trusteeOrgId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrusteeRequest.putOrgauthorizationTrustee was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrusteeGroupRoledivisions-example.txt b/build/docs/putOrgauthorizationTrusteeGroupRoledivisions-example.txt new file mode 100644 index 000000000..ab91c0165 --- /dev/null +++ b/build/docs/putOrgauthorizationTrusteeGroupRoledivisions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id +let body: RoleDivisionGrants = new RoleDivisionGrants(...) // Set of roles with corresponding divisions to apply + +// Update Trustee Group Roles +PutOrgauthorizationTrusteeGroupRoledivisionsRequest.putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrusteeGroupRoledivisionsRequest.putOrgauthorizationTrusteeGroupRoledivisions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrusteeGroupRoles-example.txt b/build/docs/putOrgauthorizationTrusteeGroupRoles-example.txt new file mode 100644 index 000000000..1c6d5e17c --- /dev/null +++ b/build/docs/putOrgauthorizationTrusteeGroupRoles-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeGroupId: String = "" // Trustee Group Id +let body: [String] = [""] // List of roles + +// Update Trustee Group Roles +PutOrgauthorizationTrusteeGroupRolesRequest.putOrgauthorizationTrusteeGroupRoles(trusteeOrgId: trusteeOrgId, trusteeGroupId: trusteeGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrusteeGroupRolesRequest.putOrgauthorizationTrusteeGroupRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrusteeUserRoledivisions-example.txt b/build/docs/putOrgauthorizationTrusteeUserRoledivisions-example.txt new file mode 100644 index 000000000..f86df3e19 --- /dev/null +++ b/build/docs/putOrgauthorizationTrusteeUserRoledivisions-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id +let body: RoleDivisionGrants = new RoleDivisionGrants(...) // Set of roles with corresponding divisions to apply + +// Update Trustee User Roles +PutOrgauthorizationTrusteeUserRoledivisionsRequest.putOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrusteeUserRoledivisionsRequest.putOrgauthorizationTrusteeUserRoledivisions was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrusteeUserRoles-example.txt b/build/docs/putOrgauthorizationTrusteeUserRoles-example.txt new file mode 100644 index 000000000..a5ecf1b56 --- /dev/null +++ b/build/docs/putOrgauthorizationTrusteeUserRoles-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trusteeOrgId: String = "" // Trustee Organization Id +let trusteeUserId: String = "" // Trustee User Id +let body: [String] = [""] // List of roles + +// Update Trustee User Roles +PutOrgauthorizationTrusteeUserRolesRequest.putOrgauthorizationTrusteeUserRoles(trusteeOrgId: trusteeOrgId, trusteeUserId: trusteeUserId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrusteeUserRolesRequest.putOrgauthorizationTrusteeUserRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrustorCloneduser-example.txt b/build/docs/putOrgauthorizationTrustorCloneduser-example.txt new file mode 100644 index 000000000..34954d57b --- /dev/null +++ b/build/docs/putOrgauthorizationTrustorCloneduser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Creates a clone of the trustee user in the trustor org. +PutOrgauthorizationTrustorCloneduserRequest.putOrgauthorizationTrustorCloneduser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrustorCloneduserRequest.putOrgauthorizationTrustorCloneduser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrustorGroup-example.txt b/build/docs/putOrgauthorizationTrustorGroup-example.txt new file mode 100644 index 000000000..d485a5441 --- /dev/null +++ b/build/docs/putOrgauthorizationTrustorGroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trustorGroupId: String = "" // Trustor Group Id + +// Add a Trustee Group to the trust. +PutOrgauthorizationTrustorGroupRequest.putOrgauthorizationTrustorGroup(trustorOrgId: trustorOrgId, trustorGroupId: trustorGroupId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrustorGroupRequest.putOrgauthorizationTrustorGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrgauthorizationTrustorUser-example.txt b/build/docs/putOrgauthorizationTrustorUser-example.txt new file mode 100644 index 000000000..496127f7f --- /dev/null +++ b/build/docs/putOrgauthorizationTrustorUser-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trustorOrgId: String = "" // Trustor Organization Id +let trusteeUserId: String = "" // Trustee User Id + +// Add a Trustee user to the trust. +PutOrgauthorizationTrustorUserRequest.putOrgauthorizationTrustorUser(trustorOrgId: trustorOrgId, trusteeUserId: trusteeUserId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrgauthorizationTrustorUserRequest.putOrgauthorizationTrustorUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOrphanrecording-example.txt b/build/docs/putOrphanrecording-example.txt new file mode 100644 index 000000000..5d2d70004 --- /dev/null +++ b/build/docs/putOrphanrecording-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let orphanId: String = "" // Orphan ID +let body: OrphanUpdateRequest = new OrphanUpdateRequest(...) // + +// Updates an orphan recording to a regular recording with retention values +PutOrphanrecordingRequest.putOrphanrecording(orphanId: orphanId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOrphanrecordingRequest.putOrphanrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundAttemptlimit-example.txt b/build/docs/putOutboundAttemptlimit-example.txt new file mode 100644 index 000000000..27093c368 --- /dev/null +++ b/build/docs/putOutboundAttemptlimit-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let attemptLimitsId: String = "" // Attempt limits ID +let body: AttemptLimits = new AttemptLimits(...) // AttemptLimits + +// Update attempt limits +PutOutboundAttemptlimitRequest.putOutboundAttemptlimit(attemptLimitsId: attemptLimitsId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundAttemptlimitRequest.putOutboundAttemptlimit was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundCallabletimeset-example.txt b/build/docs/putOutboundCallabletimeset-example.txt new file mode 100644 index 000000000..24abc98f6 --- /dev/null +++ b/build/docs/putOutboundCallabletimeset-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callableTimeSetId: String = "" // Callable Time Set ID +let body: CallableTimeSet = new CallableTimeSet(...) // DialerCallableTimeSet + +// Update callable time set +PutOutboundCallabletimesetRequest.putOutboundCallabletimeset(callableTimeSetId: callableTimeSetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundCallabletimesetRequest.putOutboundCallabletimeset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundCallanalysisresponseset-example.txt b/build/docs/putOutboundCallanalysisresponseset-example.txt new file mode 100644 index 000000000..933dcf1d9 --- /dev/null +++ b/build/docs/putOutboundCallanalysisresponseset-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let callAnalysisSetId: String = "" // Call Analysis Response Set ID +let body: ResponseSet = new ResponseSet(...) // ResponseSet + +// Update a dialer call analysis response set. +PutOutboundCallanalysisresponsesetRequest.putOutboundCallanalysisresponseset(callAnalysisSetId: callAnalysisSetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundCallanalysisresponsesetRequest.putOutboundCallanalysisresponseset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundCampaign-example.txt b/build/docs/putOutboundCampaign-example.txt new file mode 100644 index 000000000..436d5e171 --- /dev/null +++ b/build/docs/putOutboundCampaign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID +let body: Campaign = new Campaign(...) // Campaign + +// Update a campaign. +PutOutboundCampaignRequest.putOutboundCampaign(campaignId: campaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundCampaignRequest.putOutboundCampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundCampaignAgent-example.txt b/build/docs/putOutboundCampaignAgent-example.txt new file mode 100644 index 000000000..f95aff257 --- /dev/null +++ b/build/docs/putOutboundCampaignAgent-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID +let userId: String = "" // Agent's user ID +let body: Agent = new Agent(...) // agent + +// Send notification that an agent's state changed +PutOutboundCampaignAgentRequest.putOutboundCampaignAgent(campaignId: campaignId, userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundCampaignAgentRequest.putOutboundCampaignAgent was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundCampaignrule-example.txt b/build/docs/putOutboundCampaignrule-example.txt new file mode 100644 index 000000000..06ca5ac50 --- /dev/null +++ b/build/docs/putOutboundCampaignrule-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignRuleId: String = "" // Campaign Rule ID +let body: CampaignRule = new CampaignRule(...) // CampaignRule + +// Update Campaign Rule +PutOutboundCampaignruleRequest.putOutboundCampaignrule(campaignRuleId: campaignRuleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundCampaignruleRequest.putOutboundCampaignrule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundContactlist-example.txt b/build/docs/putOutboundContactlist-example.txt new file mode 100644 index 000000000..7f317a9a3 --- /dev/null +++ b/build/docs/putOutboundContactlist-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // ContactList ID +let body: ContactList = new ContactList(...) // ContactList + +// Update a contact list. +PutOutboundContactlistRequest.putOutboundContactlist(contactListId: contactListId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundContactlistRequest.putOutboundContactlist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundContactlistContact-example.txt b/build/docs/putOutboundContactlistContact-example.txt new file mode 100644 index 000000000..e05dba503 --- /dev/null +++ b/build/docs/putOutboundContactlistContact-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListId: String = "" // Contact List ID +let contactId: String = "" // Contact ID +let body: DialerContact = new DialerContact(...) // Contact + +// Update a contact. +PutOutboundContactlistContactRequest.putOutboundContactlistContact(contactListId: contactListId, contactId: contactId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundContactlistContactRequest.putOutboundContactlistContact was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundContactlistfilter-example.txt b/build/docs/putOutboundContactlistfilter-example.txt new file mode 100644 index 000000000..a4e9c541d --- /dev/null +++ b/build/docs/putOutboundContactlistfilter-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let contactListFilterId: String = "" // Contact List Filter ID +let body: ContactListFilter = new ContactListFilter(...) // ContactListFilter + +// Update Contact List Filter +PutOutboundContactlistfilterRequest.putOutboundContactlistfilter(contactListFilterId: contactListFilterId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundContactlistfilterRequest.putOutboundContactlistfilter was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundDigitalruleset-example.txt b/build/docs/putOutboundDigitalruleset-example.txt new file mode 100644 index 000000000..0ad31f819 --- /dev/null +++ b/build/docs/putOutboundDigitalruleset-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let digitalRuleSetId: String = "" // The Digital Rule Set ID +let body: DigitalRuleSet = new DigitalRuleSet(...) // Digital Rule Set + +// Update an Outbound Digital Rule Set +PutOutboundDigitalrulesetRequest.putOutboundDigitalruleset(digitalRuleSetId: digitalRuleSetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundDigitalrulesetRequest.putOutboundDigitalruleset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundDnclist-example.txt b/build/docs/putOutboundDnclist-example.txt new file mode 100644 index 000000000..b6fa6082d --- /dev/null +++ b/build/docs/putOutboundDnclist-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dncListId: String = "" // DncList ID +let body: DncList = new DncList(...) // DncList + +// Update dialer DNC list +PutOutboundDnclistRequest.putOutboundDnclist(dncListId: dncListId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundDnclistRequest.putOutboundDnclist was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundMessagingcampaign-example.txt b/build/docs/putOutboundMessagingcampaign-example.txt new file mode 100644 index 000000000..d8d01b16e --- /dev/null +++ b/build/docs/putOutboundMessagingcampaign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // The Messaging Campaign ID +let body: MessagingCampaign = new MessagingCampaign(...) // MessagingCampaign + +// Update an Outbound Messaging Campaign +PutOutboundMessagingcampaignRequest.putOutboundMessagingcampaign(messagingCampaignId: messagingCampaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundMessagingcampaignRequest.putOutboundMessagingcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundRuleset-example.txt b/build/docs/putOutboundRuleset-example.txt new file mode 100644 index 000000000..a9608a0a4 --- /dev/null +++ b/build/docs/putOutboundRuleset-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let ruleSetId: String = "" // Rule Set ID +let body: RuleSet = new RuleSet(...) // RuleSet + +// Update a Rule Set. +PutOutboundRulesetRequest.putOutboundRuleset(ruleSetId: ruleSetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundRulesetRequest.putOutboundRuleset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundSchedulesCampaign-example.txt b/build/docs/putOutboundSchedulesCampaign-example.txt new file mode 100644 index 000000000..d8827d4c4 --- /dev/null +++ b/build/docs/putOutboundSchedulesCampaign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let campaignId: String = "" // Campaign ID +let body: CampaignSchedule = new CampaignSchedule(...) // CampaignSchedule + +// Update a new campaign schedule. +PutOutboundSchedulesCampaignRequest.putOutboundSchedulesCampaign(campaignId: campaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundSchedulesCampaignRequest.putOutboundSchedulesCampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundSchedulesEmailcampaign-example.txt b/build/docs/putOutboundSchedulesEmailcampaign-example.txt new file mode 100644 index 000000000..db9f6c729 --- /dev/null +++ b/build/docs/putOutboundSchedulesEmailcampaign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let emailCampaignId: String = "" // Email Campaign ID +let body: EmailCampaignSchedule = new EmailCampaignSchedule(...) // EmailCampaignSchedule + +// Update an email campaign schedule. +PutOutboundSchedulesEmailcampaignRequest.putOutboundSchedulesEmailcampaign(emailCampaignId: emailCampaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundSchedulesEmailcampaignRequest.putOutboundSchedulesEmailcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundSchedulesMessagingcampaign-example.txt b/build/docs/putOutboundSchedulesMessagingcampaign-example.txt new file mode 100644 index 000000000..00a60daa1 --- /dev/null +++ b/build/docs/putOutboundSchedulesMessagingcampaign-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messagingCampaignId: String = "" // Messaging Campaign ID +let body: MessagingCampaignSchedule = new MessagingCampaignSchedule(...) // MessagingCampaignSchedule + +// Update a new messaging campaign schedule. +PutOutboundSchedulesMessagingcampaignRequest.putOutboundSchedulesMessagingcampaign(messagingCampaignId: messagingCampaignId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundSchedulesMessagingcampaignRequest.putOutboundSchedulesMessagingcampaign was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundSchedulesSequence-example.txt b/build/docs/putOutboundSchedulesSequence-example.txt new file mode 100644 index 000000000..80bfd6b0c --- /dev/null +++ b/build/docs/putOutboundSchedulesSequence-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Sequence ID +let body: SequenceSchedule = new SequenceSchedule(...) // SequenceSchedule + +// Update a new sequence schedule. +PutOutboundSchedulesSequenceRequest.putOutboundSchedulesSequence(sequenceId: sequenceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundSchedulesSequenceRequest.putOutboundSchedulesSequence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundSequence-example.txt b/build/docs/putOutboundSequence-example.txt new file mode 100644 index 000000000..67da3bf4a --- /dev/null +++ b/build/docs/putOutboundSequence-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sequenceId: String = "" // Campaign Sequence ID +let body: CampaignSequence = new CampaignSequence(...) // Organization + +// Update a new campaign sequence. +PutOutboundSequenceRequest.putOutboundSequence(sequenceId: sequenceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundSequenceRequest.putOutboundSequence was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putOutboundWrapupcodemappings-example.txt b/build/docs/putOutboundWrapupcodemappings-example.txt new file mode 100644 index 000000000..2c263397c --- /dev/null +++ b/build/docs/putOutboundWrapupcodemappings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WrapUpCodeMapping = new WrapUpCodeMapping(...) // wrapUpCodeMapping + +// Update the Dialer wrap up code mapping. +PutOutboundWrapupcodemappingsRequest.putOutboundWrapupcodemappings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutOutboundWrapupcodemappingsRequest.putOutboundWrapupcodemappings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putPresenceSettings-example.txt b/build/docs/putPresenceSettings-example.txt new file mode 100644 index 000000000..0ec00f518 --- /dev/null +++ b/build/docs/putPresenceSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: PresenceSettings = new PresenceSettings(...) // Presence Settings + +// Update the presence settings +PutPresenceSettingsRequest.putPresenceSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutPresenceSettingsRequest.putPresenceSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putPresenceSource-example.txt b/build/docs/putPresenceSource-example.txt new file mode 100644 index 000000000..6fc6152d8 --- /dev/null +++ b/build/docs/putPresenceSource-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let sourceId: String = "" // Presence Source ID +let body: Source = new Source(...) // The updated Presence Source + +// Update a Presence Source +PutPresenceSourceRequest.putPresenceSource(sourceId: sourceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutPresenceSourceRequest.putPresenceSource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putPresenceUserPrimarysource-example.txt b/build/docs/putPresenceUserPrimarysource-example.txt new file mode 100644 index 000000000..b0f1144da --- /dev/null +++ b/build/docs/putPresenceUserPrimarysource-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // user ID +let body: UserPrimarySource = new UserPrimarySource(...) // Primary Source + +// Update a user's Primary Presence Source +PutPresenceUserPrimarysourceRequest.putPresenceUserPrimarysource(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutPresenceUserPrimarysourceRequest.putPresenceUserPrimarysource was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putPresencedefinition-example.txt b/build/docs/putPresencedefinition-example.txt new file mode 100644 index 000000000..e9b985170 --- /dev/null +++ b/build/docs/putPresencedefinition-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let presenceId: String = "" // Organization Presence ID +let body: OrganizationPresence = new OrganizationPresence(...) // The OrganizationPresence to update + +// Update a Presence Definition +PutPresencedefinitionRequest.putPresencedefinition(presenceId: presenceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutPresencedefinitionRequest.putPresencedefinition was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putProcessautomationTrigger-example.txt b/build/docs/putProcessautomationTrigger-example.txt new file mode 100644 index 000000000..eb530843d --- /dev/null +++ b/build/docs/putProcessautomationTrigger-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let triggerId: String = "" // triggerId +let body: UpdateTriggerRequest = new UpdateTriggerRequest(...) // Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName) + +// Update a Trigger +PutProcessautomationTriggerRequest.putProcessautomationTrigger(triggerId: triggerId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutProcessautomationTriggerRequest.putProcessautomationTrigger was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualityCalibration-example.txt b/build/docs/putQualityCalibration-example.txt new file mode 100644 index 000000000..bea0f9a69 --- /dev/null +++ b/build/docs/putQualityCalibration-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let calibrationId: String = "" // Calibration ID +let body: Calibration = new Calibration(...) // Calibration + +// Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex +PutQualityCalibrationRequest.putQualityCalibration(calibrationId: calibrationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualityCalibrationRequest.putQualityCalibration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualityConversationEvaluation-example.txt b/build/docs/putQualityConversationEvaluation-example.txt new file mode 100644 index 000000000..0461619de --- /dev/null +++ b/build/docs/putQualityConversationEvaluation-example.txt @@ -0,0 +1,19 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let conversationId: String = "" // conversationId +let evaluationId: String = "" // evaluationId +let body: Evaluation = new Evaluation(...) // evaluation +let expand: String = "" // evaluatorId, evaluationForm, assignee, evaluator + +// Update an evaluation +PutQualityConversationEvaluationRequest.putQualityConversationEvaluation(conversationId: conversationId, evaluationId: evaluationId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualityConversationEvaluationRequest.putQualityConversationEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualityForm-example.txt b/build/docs/putQualityForm-example.txt new file mode 100644 index 000000000..9ac9cc206 --- /dev/null +++ b/build/docs/putQualityForm-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let body: EvaluationForm = new EvaluationForm(...) // Evaluation form + +// Update an evaluation form. +PutQualityFormRequest.putQualityForm(formId: formId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualityFormRequest.putQualityForm was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualityFormsEvaluation-example.txt b/build/docs/putQualityFormsEvaluation-example.txt new file mode 100644 index 000000000..7fb11c275 --- /dev/null +++ b/build/docs/putQualityFormsEvaluation-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let body: EvaluationForm = new EvaluationForm(...) // Evaluation form + +// Update an evaluation form. +PutQualityFormsEvaluationRequest.putQualityFormsEvaluation(formId: formId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualityFormsEvaluationRequest.putQualityFormsEvaluation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualityFormsSurvey-example.txt b/build/docs/putQualityFormsSurvey-example.txt new file mode 100644 index 000000000..01de24c2c --- /dev/null +++ b/build/docs/putQualityFormsSurvey-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let formId: String = "" // Form ID +let body: SurveyForm = new SurveyForm(...) // Survey form + +// Update a survey form. +PutQualityFormsSurveyRequest.putQualityFormsSurvey(formId: formId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualityFormsSurveyRequest.putQualityFormsSurvey was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putQualitySurveysScorable-example.txt b/build/docs/putQualitySurveysScorable-example.txt new file mode 100644 index 000000000..ac9545977 --- /dev/null +++ b/build/docs/putQualitySurveysScorable-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let customerSurveyUrl: String = "" // customerSurveyUrl +let body: ScorableSurvey = new ScorableSurvey(...) // survey + +// Update a survey as an end-customer, for the purposes of scoring it. +PutQualitySurveysScorableRequest.putQualitySurveysScorable(customerSurveyUrl: customerSurveyUrl, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutQualitySurveysScorableRequest.putQualitySurveysScorable was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingCrossplatformMediaretentionpolicy-example.txt b/build/docs/putRecordingCrossplatformMediaretentionpolicy-example.txt new file mode 100644 index 000000000..c9395a7fe --- /dev/null +++ b/build/docs/putRecordingCrossplatformMediaretentionpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID +let body: CrossPlatformPolicy = new CrossPlatformPolicy(...) // Policy + +// Update a media retention policy +PutRecordingCrossplatformMediaretentionpolicyRequest.putRecordingCrossplatformMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingCrossplatformMediaretentionpolicyRequest.putRecordingCrossplatformMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingJob-example.txt b/build/docs/putRecordingJob-example.txt new file mode 100644 index 000000000..1fea589d9 --- /dev/null +++ b/build/docs/putRecordingJob-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let jobId: String = "" // jobId +let body: ExecuteRecordingJobsQuery = new ExecuteRecordingJobsQuery(...) // query + +// Execute the recording bulk job. +PutRecordingJobRequest.putRecordingJob(jobId: jobId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingJobRequest.putRecordingJob was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingKeyconfiguration-example.txt b/build/docs/putRecordingKeyconfiguration-example.txt new file mode 100644 index 000000000..b502191a5 --- /dev/null +++ b/build/docs/putRecordingKeyconfiguration-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let keyConfigurationId: String = "" // Key Configurations Id +let body: RecordingEncryptionConfiguration = new RecordingEncryptionConfiguration(...) // Encryption key configuration metadata + +// Update the encryption key configurations +PutRecordingKeyconfigurationRequest.putRecordingKeyconfiguration(keyConfigurationId: keyConfigurationId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingKeyconfigurationRequest.putRecordingKeyconfiguration was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingMediaretentionpolicy-example.txt b/build/docs/putRecordingMediaretentionpolicy-example.txt new file mode 100644 index 000000000..add8b47a8 --- /dev/null +++ b/build/docs/putRecordingMediaretentionpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let policyId: String = "" // Policy ID +let body: Policy = new Policy(...) // Policy + +// Update a media retention policy +PutRecordingMediaretentionpolicyRequest.putRecordingMediaretentionpolicy(policyId: policyId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingMediaretentionpolicyRequest.putRecordingMediaretentionpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingRecordingkeysRotationschedule-example.txt b/build/docs/putRecordingRecordingkeysRotationschedule-example.txt new file mode 100644 index 000000000..c0ed32866 --- /dev/null +++ b/build/docs/putRecordingRecordingkeysRotationschedule-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: KeyRotationSchedule = new KeyRotationSchedule(...) // KeyRotationSchedule + +// Update key rotation schedule +PutRecordingRecordingkeysRotationscheduleRequest.putRecordingRecordingkeysRotationschedule(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingRecordingkeysRotationscheduleRequest.putRecordingRecordingkeysRotationschedule was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingSettings-example.txt b/build/docs/putRecordingSettings-example.txt new file mode 100644 index 000000000..31bb7c0f9 --- /dev/null +++ b/build/docs/putRecordingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RecordingSettings = new RecordingSettings(...) // Recording settings + +// Update the Recording Settings for the Organization +PutRecordingSettingsRequest.putRecordingSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRecordingSettingsRequest.putRecordingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRecordingsDeletionprotection-example.txt b/build/docs/putRecordingsDeletionprotection-example.txt new file mode 100644 index 000000000..dc5d4c9e5 --- /dev/null +++ b/build/docs/putRecordingsDeletionprotection-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let protect: Bool = true // Check for apply, uncheck for revoke (each action requires the respective permission) +let body: ConversationDeletionProtectionQuery = new ConversationDeletionProtectionQuery(...) // + +// Apply or revoke recording protection for conversations +PutRecordingsDeletionprotectionRequest.putRecordingsDeletionprotection(protect: protect, body: body) { (error) in + if let error = error { + dump(error) + } else { + print("PutRecordingsDeletionprotectionRequest.putRecordingsDeletionprotection was successful") + } +} \ No newline at end of file diff --git a/build/docs/putResponsemanagementLibrary-example.txt b/build/docs/putResponsemanagementLibrary-example.txt new file mode 100644 index 000000000..2144cbe88 --- /dev/null +++ b/build/docs/putResponsemanagementLibrary-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let libraryId: String = "" // Library ID +let body: Library = new Library(...) // Library + +// Update an existing response library. +PutResponsemanagementLibraryRequest.putResponsemanagementLibrary(libraryId: libraryId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutResponsemanagementLibraryRequest.putResponsemanagementLibrary was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putResponsemanagementResponse-example.txt b/build/docs/putResponsemanagementResponse-example.txt new file mode 100644 index 000000000..98f07e1db --- /dev/null +++ b/build/docs/putResponsemanagementResponse-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseId: String = "" // Response ID +let body: ModelResponse = new ModelResponse(...) // Response +let expand: PutResponsemanagementResponseRequest.Expand_putResponsemanagementResponse = PutResponsemanagementResponseRequest.Expand_putResponsemanagementResponse.enummember // Expand instructions for the return value. + +// Update an existing response. +PutResponsemanagementResponseRequest.putResponsemanagementResponse(responseId: responseId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutResponsemanagementResponseRequest.putResponsemanagementResponse was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putResponsemanagementResponseasset-example.txt b/build/docs/putResponsemanagementResponseasset-example.txt new file mode 100644 index 000000000..827c58672 --- /dev/null +++ b/build/docs/putResponsemanagementResponseasset-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let responseAssetId: String = "" // Asset Id +let body: ResponseAssetRequest = new ResponseAssetRequest(...) // request + +// Update response asset +PutResponsemanagementResponseassetRequest.putResponsemanagementResponseasset(responseAssetId: responseAssetId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutResponsemanagementResponseassetRequest.putResponsemanagementResponseasset was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingEmailDomainRoute-example.txt b/build/docs/putRoutingEmailDomainRoute-example.txt new file mode 100644 index 000000000..98e45b34b --- /dev/null +++ b/build/docs/putRoutingEmailDomainRoute-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainName: String = "" // email domain +let routeId: String = "" // route ID +let body: InboundRoute = new InboundRoute(...) // Route + +// Update a route +PutRoutingEmailDomainRouteRequest.putRoutingEmailDomainRoute(domainName: domainName, routeId: routeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingEmailDomainRouteRequest.putRoutingEmailDomainRoute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingEmailOutboundDomainActivation-example.txt b/build/docs/putRoutingEmailOutboundDomainActivation-example.txt new file mode 100644 index 000000000..4a251c220 --- /dev/null +++ b/build/docs/putRoutingEmailOutboundDomainActivation-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let domainId: String = "" // domain ID + +// Request an activation status (cname + dkim) update of an outbound domain +PutRoutingEmailOutboundDomainActivationRequest.putRoutingEmailOutboundDomainActivation(domainId: domainId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingEmailOutboundDomainActivationRequest.putRoutingEmailOutboundDomainActivation was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingMessageRecipient-example.txt b/build/docs/putRoutingMessageRecipient-example.txt new file mode 100644 index 000000000..c3ea57e75 --- /dev/null +++ b/build/docs/putRoutingMessageRecipient-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recipientId: String = "" // Recipient ID +let body: RecipientRequest = new RecipientRequest(...) // Recipient + +// Update a recipient +PutRoutingMessageRecipientRequest.putRoutingMessageRecipient(recipientId: recipientId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingMessageRecipientRequest.putRoutingMessageRecipient was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingQueue-example.txt b/build/docs/putRoutingQueue-example.txt new file mode 100644 index 000000000..8feea59d9 --- /dev/null +++ b/build/docs/putRoutingQueue-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let queueId: String = "" // Queue ID +let body: QueueRequest = new QueueRequest(...) // Queue + +// Update a queue +PutRoutingQueueRequest.putRoutingQueue(queueId: queueId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingQueueRequest.putRoutingQueue was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingSettings-example.txt b/build/docs/putRoutingSettings-example.txt new file mode 100644 index 000000000..e8230d173 --- /dev/null +++ b/build/docs/putRoutingSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: RoutingSettings = new RoutingSettings(...) // Organization Settings + +// Update an organization's routing settings +PutRoutingSettingsRequest.putRoutingSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingSettingsRequest.putRoutingSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingSettingsTranscription-example.txt b/build/docs/putRoutingSettingsTranscription-example.txt new file mode 100644 index 000000000..e5dac105b --- /dev/null +++ b/build/docs/putRoutingSettingsTranscription-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: TranscriptionSettings = new TranscriptionSettings(...) // Organization Settings + +// Update Transcription Settings +PutRoutingSettingsTranscriptionRequest.putRoutingSettingsTranscription(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingSettingsTranscriptionRequest.putRoutingSettingsTranscription was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingSmsPhonenumber-example.txt b/build/docs/putRoutingSmsPhonenumber-example.txt new file mode 100644 index 000000000..b4a59bd54 --- /dev/null +++ b/build/docs/putRoutingSmsPhonenumber-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let addressId: String = "" // Address ID +let body: SmsPhoneNumber = new SmsPhoneNumber(...) // SmsPhoneNumber + +// Update a phone number provisioned for SMS. +PutRoutingSmsPhonenumberRequest.putRoutingSmsPhonenumber(addressId: addressId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingSmsPhonenumberRequest.putRoutingSmsPhonenumber was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingUserUtilization-example.txt b/build/docs/putRoutingUserUtilization-example.txt new file mode 100644 index 000000000..b872a4e27 --- /dev/null +++ b/build/docs/putRoutingUserUtilization-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: Utilization = new Utilization(...) // utilization + +// Update the user's max utilization settings. Include only those media types requiring custom configuration. +PutRoutingUserUtilizationRequest.putRoutingUserUtilization(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingUserUtilizationRequest.putRoutingUserUtilization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingUtilization-example.txt b/build/docs/putRoutingUtilization-example.txt new file mode 100644 index 000000000..80e1736f3 --- /dev/null +++ b/build/docs/putRoutingUtilization-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: Utilization = new Utilization(...) // utilization + +// Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. +PutRoutingUtilizationRequest.putRoutingUtilization(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingUtilizationRequest.putRoutingUtilization was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putRoutingWrapupcode-example.txt b/build/docs/putRoutingWrapupcode-example.txt new file mode 100644 index 000000000..105cb8446 --- /dev/null +++ b/build/docs/putRoutingWrapupcode-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let codeId: String = "" // Wrapup Code ID +let body: WrapupCodeRequest = new WrapupCodeRequest(...) // WrapupCode + +// Update wrap-up code +PutRoutingWrapupcodeRequest.putRoutingWrapupcode(codeId: codeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutRoutingWrapupcodeRequest.putRoutingWrapupcode was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putScimGroup-example.txt b/build/docs/putScimGroup-example.txt new file mode 100644 index 000000000..32ea50456 --- /dev/null +++ b/build/docs/putScimGroup-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/groups. +let body: ScimV2Group = new ScimV2Group(...) // The information used to replace a group. +let ifMatch: String = "" // 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\". + +// Replace a group +PutScimGroupRequest.putScimGroup(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutScimGroupRequest.putScimGroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putScimUser-example.txt b/build/docs/putScimUser-example.txt new file mode 100644 index 000000000..1ca8a5795 --- /dev/null +++ b/build/docs/putScimUser-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/users. +let body: ScimV2User = new ScimV2User(...) // The information used to replace a user. +let ifMatch: String = "" // 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\". + +// Replace a user +PutScimUserRequest.putScimUser(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutScimUserRequest.putScimUser was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putScimV2Group-example.txt b/build/docs/putScimV2Group-example.txt new file mode 100644 index 000000000..adb01602e --- /dev/null +++ b/build/docs/putScimV2Group-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let groupId: String = "" // The ID of a group. Returned with GET /api/v2/scim/v2/groups. +let body: ScimV2Group = new ScimV2Group(...) // The information used to replace a group. +let ifMatch: String = "" // 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\". + +// Replace a group +PutScimV2GroupRequest.putScimV2Group(groupId: groupId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutScimV2GroupRequest.putScimV2Group was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putScimV2User-example.txt b/build/docs/putScimV2User-example.txt new file mode 100644 index 000000000..9f43df691 --- /dev/null +++ b/build/docs/putScimV2User-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // The ID of a user. Returned with GET /api/v2/scim/v2/users. +let body: ScimV2User = new ScimV2User(...) // The information used to replace a user. +let ifMatch: String = "" // 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\". + +// Replace a user +PutScimV2UserRequest.putScimV2User(userId: userId, body: body, ifMatch: ifMatch) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutScimV2UserRequest.putScimV2User was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt b/build/docs/putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt new file mode 100644 index 000000000..e9ec23dbf --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let dictionaryFeedbackId: String = "" // The Id of the Dictionary Feedback +let body: DictionaryFeedback = new DictionaryFeedback(...) // + +// Update existing Speech & Text Analytics dictionary feedback by id +PutSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: dictionaryFeedbackId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdRequest.putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsProgram-example.txt b/build/docs/putSpeechandtextanalyticsProgram-example.txt new file mode 100644 index 000000000..703ce73b6 --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsProgram-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program +let body: ProgramRequest = new ProgramRequest(...) // The program to update + +// Update existing Speech & Text Analytics program +PutSpeechandtextanalyticsProgramRequest.putSpeechandtextanalyticsProgram(programId: programId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsProgramRequest.putSpeechandtextanalyticsProgram was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsProgramMappings-example.txt b/build/docs/putSpeechandtextanalyticsProgramMappings-example.txt new file mode 100644 index 000000000..289fba2f4 --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsProgramMappings-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program +let body: ProgramMappingsRequest = new ProgramMappingsRequest(...) // The program to set mappings for + +// Set Speech & Text Analytics program mappings to queues and flows +PutSpeechandtextanalyticsProgramMappingsRequest.putSpeechandtextanalyticsProgramMappings(programId: programId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsProgramMappingsRequest.putSpeechandtextanalyticsProgramMappings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsProgramTranscriptionengines-example.txt b/build/docs/putSpeechandtextanalyticsProgramTranscriptionengines-example.txt new file mode 100644 index 000000000..692714014 --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsProgramTranscriptionengines-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let programId: String = "" // The id of the program +let body: TranscriptionEnginesRequest = new TranscriptionEnginesRequest(...) // Program transcription engine setting + +// Update transcription engine settings of a program +PutSpeechandtextanalyticsProgramTranscriptionenginesRequest.putSpeechandtextanalyticsProgramTranscriptionengines(programId: programId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsProgramTranscriptionenginesRequest.putSpeechandtextanalyticsProgramTranscriptionengines was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsSettings-example.txt b/build/docs/putSpeechandtextanalyticsSettings-example.txt new file mode 100644 index 000000000..5edc3f211 --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: SpeechTextAnalyticsSettingsRequest = new SpeechTextAnalyticsSettingsRequest(...) // Speech And Text Analytics Settings + +// Update Speech And Text Analytics Settings +PutSpeechandtextanalyticsSettingsRequest.putSpeechandtextanalyticsSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsSettingsRequest.putSpeechandtextanalyticsSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putSpeechandtextanalyticsTopic-example.txt b/build/docs/putSpeechandtextanalyticsTopic-example.txt new file mode 100644 index 000000000..f2ad1c9c2 --- /dev/null +++ b/build/docs/putSpeechandtextanalyticsTopic-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let topicId: String = "" // The id of the topic +let body: TopicRequest = new TopicRequest(...) // The topic to update + +// Update existing Speech & Text Analytics topic +PutSpeechandtextanalyticsTopicRequest.putSpeechandtextanalyticsTopic(topicId: topicId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutSpeechandtextanalyticsTopicRequest.putSpeechandtextanalyticsTopic was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdge-example.txt b/build/docs/putTelephonyProvidersEdge-example.txt new file mode 100644 index 000000000..494b4c3ab --- /dev/null +++ b/build/docs/putTelephonyProvidersEdge-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let body: Edge = new Edge(...) // Edge + +// Update a edge. +PutTelephonyProvidersEdgeRequest.putTelephonyProvidersEdge(edgeId: edgeId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgeRequest.putTelephonyProvidersEdge was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgeLogicalinterface-example.txt b/build/docs/putTelephonyProvidersEdgeLogicalinterface-example.txt new file mode 100644 index 000000000..b33f70780 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgeLogicalinterface-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeId: String = "" // Edge ID +let interfaceId: String = "" // Interface ID +let body: DomainLogicalInterface = new DomainLogicalInterface(...) // Logical interface + +// Update an edge logical interface. +PutTelephonyProvidersEdgeLogicalinterfaceRequest.putTelephonyProvidersEdgeLogicalinterface(edgeId: edgeId, interfaceId: interfaceId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgeLogicalinterfaceRequest.putTelephonyProvidersEdgeLogicalinterface was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesCertificateauthority-example.txt b/build/docs/putTelephonyProvidersEdgesCertificateauthority-example.txt new file mode 100644 index 000000000..3569e8c02 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesCertificateauthority-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let certificateId: String = "" // Certificate ID +let body: DomainCertificateAuthority = new DomainCertificateAuthority(...) // Certificate authority + +// Update a certificate authority. +PutTelephonyProvidersEdgesCertificateauthorityRequest.putTelephonyProvidersEdgesCertificateauthority(certificateId: certificateId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesCertificateauthorityRequest.putTelephonyProvidersEdgesCertificateauthority was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesDidpool-example.txt b/build/docs/putTelephonyProvidersEdgesDidpool-example.txt new file mode 100644 index 000000000..d757ba849 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesDidpool-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let didPoolId: String = "" // DID pool ID +let body: DIDPool = new DIDPool(...) // DID pool + +// Update a DID Pool by ID. +PutTelephonyProvidersEdgesDidpoolRequest.putTelephonyProvidersEdgesDidpool(didPoolId: didPoolId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesDidpoolRequest.putTelephonyProvidersEdgesDidpool was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesEdgegroup-example.txt b/build/docs/putTelephonyProvidersEdgesEdgegroup-example.txt new file mode 100644 index 000000000..a69e34761 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesEdgegroup-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgeGroupId: String = "" // Edge group ID +let body: EdgeGroup = new EdgeGroup(...) // EdgeGroup + +// Update an edge group. +PutTelephonyProvidersEdgesEdgegroupRequest.putTelephonyProvidersEdgesEdgegroup(edgeGroupId: edgeGroupId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesEdgegroupRequest.putTelephonyProvidersEdgesEdgegroup was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt b/build/docs/putTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt new file mode 100644 index 000000000..0055212cd --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesEdgegroupEdgetrunkbase-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let edgegroupId: String = "" // Edge Group ID +let edgetrunkbaseId: String = "" // Edge Trunk Base ID +let body: EdgeTrunkBase = new EdgeTrunkBase(...) // EdgeTrunkBase + +// Update the edge trunk base associated with the edge group +PutTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId: edgegroupId, edgetrunkbaseId: edgetrunkbaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesEdgegroupEdgetrunkbaseRequest.putTelephonyProvidersEdgesEdgegroupEdgetrunkbase was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesExtensionpool-example.txt b/build/docs/putTelephonyProvidersEdgesExtensionpool-example.txt new file mode 100644 index 000000000..d656b671c --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesExtensionpool-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let extensionPoolId: String = "" // Extension pool ID +let body: ExtensionPool = new ExtensionPool(...) // ExtensionPool + +// Update an extension pool by ID +PutTelephonyProvidersEdgesExtensionpoolRequest.putTelephonyProvidersEdgesExtensionpool(extensionPoolId: extensionPoolId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesExtensionpoolRequest.putTelephonyProvidersEdgesExtensionpool was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesPhone-example.txt b/build/docs/putTelephonyProvidersEdgesPhone-example.txt new file mode 100644 index 000000000..eeac4e3af --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesPhone-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneId: String = "" // Phone ID +let body: Phone = new Phone(...) // Phone + +// Update a Phone by ID +PutTelephonyProvidersEdgesPhoneRequest.putTelephonyProvidersEdgesPhone(phoneId: phoneId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesPhoneRequest.putTelephonyProvidersEdgesPhone was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesPhonebasesetting-example.txt b/build/docs/putTelephonyProvidersEdgesPhonebasesetting-example.txt new file mode 100644 index 000000000..82f1224ce --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesPhonebasesetting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let phoneBaseId: String = "" // Phone base ID +let body: PhoneBase = new PhoneBase(...) // Phone base settings + +// Update a Phone Base Settings by ID +PutTelephonyProvidersEdgesPhonebasesettingRequest.putTelephonyProvidersEdgesPhonebasesetting(phoneBaseId: phoneBaseId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesPhonebasesettingRequest.putTelephonyProvidersEdgesPhonebasesetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesSite-example.txt b/build/docs/putTelephonyProvidersEdgesSite-example.txt new file mode 100644 index 000000000..cbb27c943 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesSite-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let body: Site = new Site(...) // Site + +// Update a Site by ID. +PutTelephonyProvidersEdgesSiteRequest.putTelephonyProvidersEdgesSite(siteId: siteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesSiteRequest.putTelephonyProvidersEdgesSite was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesSiteNumberplans-example.txt b/build/docs/putTelephonyProvidersEdgesSiteNumberplans-example.txt new file mode 100644 index 000000000..0d324a9e0 --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesSiteNumberplans-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let body: [NumberPlan] = [new NumberPlan(...)] // List of number plans + +// Update the list of Number Plans. A user can update maximum 200 number plans at a time. +PutTelephonyProvidersEdgesSiteNumberplansRequest.putTelephonyProvidersEdgesSiteNumberplans(siteId: siteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesSiteNumberplansRequest.putTelephonyProvidersEdgesSiteNumberplans was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesSiteOutboundroute-example.txt b/build/docs/putTelephonyProvidersEdgesSiteOutboundroute-example.txt new file mode 100644 index 000000000..32af69a1a --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesSiteOutboundroute-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let siteId: String = "" // Site ID +let outboundRouteId: String = "" // Outbound route ID +let body: OutboundRouteBase = new OutboundRouteBase(...) // OutboundRoute + +// Update outbound route +PutTelephonyProvidersEdgesSiteOutboundrouteRequest.putTelephonyProvidersEdgesSiteOutboundroute(siteId: siteId, outboundRouteId: outboundRouteId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesSiteOutboundrouteRequest.putTelephonyProvidersEdgesSiteOutboundroute was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putTelephonyProvidersEdgesTrunkbasesetting-example.txt b/build/docs/putTelephonyProvidersEdgesTrunkbasesetting-example.txt new file mode 100644 index 000000000..2fa54d95c --- /dev/null +++ b/build/docs/putTelephonyProvidersEdgesTrunkbasesetting-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let trunkBaseSettingsId: String = "" // Trunk Base ID +let body: TrunkBase = new TrunkBase(...) // Trunk base settings + +// Update a Trunk Base Settings object by ID +PutTelephonyProvidersEdgesTrunkbasesettingRequest.putTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId: trunkBaseSettingsId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutTelephonyProvidersEdgesTrunkbasesettingRequest.putTelephonyProvidersEdgesTrunkbasesetting was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserCallforwarding-example.txt b/build/docs/putUserCallforwarding-example.txt new file mode 100644 index 000000000..00bd1b3d9 --- /dev/null +++ b/build/docs/putUserCallforwarding-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: CallForwarding = new CallForwarding(...) // Call forwarding + +// Update a user's CallForwarding +PutUserCallforwardingRequest.putUserCallforwarding(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserCallforwardingRequest.putUserCallforwarding was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserGreetingsDefaults-example.txt b/build/docs/putUserGreetingsDefaults-example.txt new file mode 100644 index 000000000..93319c147 --- /dev/null +++ b/build/docs/putUserGreetingsDefaults-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: DefaultGreetingList = new DefaultGreetingList(...) // The updated defaultGreetingList + +// Updates the DefaultGreetingList of the specified User +PutUserGreetingsDefaultsRequest.putUserGreetingsDefaults(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserGreetingsDefaultsRequest.putUserGreetingsDefaults was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserOutofoffice-example.txt b/build/docs/putUserOutofoffice-example.txt new file mode 100644 index 000000000..c9addc277 --- /dev/null +++ b/build/docs/putUserOutofoffice-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: OutOfOffice = new OutOfOffice(...) // The updated OutOffOffice + +// Update an OutOfOffice +PutUserOutofofficeRequest.putUserOutofoffice(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserOutofofficeRequest.putUserOutofoffice was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserProfileskills-example.txt b/build/docs/putUserProfileskills-example.txt new file mode 100644 index 000000000..8fb38dff4 --- /dev/null +++ b/build/docs/putUserProfileskills-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: [String] = [""] // Skills + +// Update profile skills for a user +PutUserProfileskillsRequest.putUserProfileskills(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserProfileskillsRequest.putUserProfileskills was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserRoles-example.txt b/build/docs/putUserRoles-example.txt new file mode 100644 index 000000000..5be8b5a2a --- /dev/null +++ b/build/docs/putUserRoles-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let subjectId: String = "" // User ID +let body: [String] = [""] // List of roles + +// Sets the user's roles +PutUserRolesRequest.putUserRoles(subjectId: subjectId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserRolesRequest.putUserRoles was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserRoutingskill-example.txt b/build/docs/putUserRoutingskill-example.txt new file mode 100644 index 000000000..cb8009f6a --- /dev/null +++ b/build/docs/putUserRoutingskill-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let skillId: String = "" // skillId +let body: UserRoutingSkill = new UserRoutingSkill(...) // Skill + +// Update routing skill proficiency or state. +PutUserRoutingskillRequest.putUserRoutingskill(userId: userId, skillId: skillId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserRoutingskillRequest.putUserRoutingskill was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserRoutingskillsBulk-example.txt b/build/docs/putUserRoutingskillsBulk-example.txt new file mode 100644 index 000000000..b4e8c426a --- /dev/null +++ b/build/docs/putUserRoutingskillsBulk-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: [UserRoutingSkillPost] = [new UserRoutingSkillPost(...)] // Skill + +// Replace all routing skills assigned to a user +PutUserRoutingskillsBulkRequest.putUserRoutingskillsBulk(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserRoutingskillsBulkRequest.putUserRoutingskillsBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserRoutingstatus-example.txt b/build/docs/putUserRoutingstatus-example.txt new file mode 100644 index 000000000..099eced16 --- /dev/null +++ b/build/docs/putUserRoutingstatus-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: RoutingStatus = new RoutingStatus(...) // Routing Status + +// Update the routing status of a user +PutUserRoutingstatusRequest.putUserRoutingstatus(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserRoutingstatusRequest.putUserRoutingstatus was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserState-example.txt b/build/docs/putUserState-example.txt new file mode 100644 index 000000000..e8d6edf47 --- /dev/null +++ b/build/docs/putUserState-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: UserState = new UserState(...) // User + +// Update user state information. +PutUserStateRequest.putUserState(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserStateRequest.putUserState was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUserStationAssociatedstationStationId-example.txt b/build/docs/putUserStationAssociatedstationStationId-example.txt new file mode 100644 index 000000000..b88b72a13 --- /dev/null +++ b/build/docs/putUserStationAssociatedstationStationId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let stationId: String = "" // stationId + +// Set associated station +PutUserStationAssociatedstationStationIdRequest.putUserStationAssociatedstationStationId(userId: userId, stationId: stationId) { (error) in + if let error = error { + dump(error) + } else { + print("PutUserStationAssociatedstationStationIdRequest.putUserStationAssociatedstationStationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/putUserStationDefaultstationStationId-example.txt b/build/docs/putUserStationDefaultstationStationId-example.txt new file mode 100644 index 000000000..67955b479 --- /dev/null +++ b/build/docs/putUserStationDefaultstationStationId-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let stationId: String = "" // stationId + +// Set default station +PutUserStationDefaultstationStationIdRequest.putUserStationDefaultstationStationId(userId: userId, stationId: stationId) { (error) in + if let error = error { + dump(error) + } else { + print("PutUserStationDefaultstationStationIdRequest.putUserStationDefaultstationStationId was successful") + } +} \ No newline at end of file diff --git a/build/docs/putUserrecording-example.txt b/build/docs/putUserrecording-example.txt new file mode 100644 index 000000000..61ebeedd5 --- /dev/null +++ b/build/docs/putUserrecording-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let recordingId: String = "" // User Recording ID +let body: UserRecording = new UserRecording(...) // UserRecording +let expand: [String] = [""] // Which fields, if any, to expand. + +// Update a user recording. +PutUserrecordingRequest.putUserrecording(recordingId: recordingId, body: body, expand: expand) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUserrecordingRequest.putUserrecording was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putUsersPresencesBulk-example.txt b/build/docs/putUsersPresencesBulk-example.txt new file mode 100644 index 000000000..d9a089bbf --- /dev/null +++ b/build/docs/putUsersPresencesBulk-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: [UserPresence] = [new UserPresence(...)] // List of User presences + +// Update bulk user Presences +PutUsersPresencesBulkRequest.putUsersPresencesBulk(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutUsersPresencesBulkRequest.putUsersPresencesBulk was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putVoicemailMessage-example.txt b/build/docs/putVoicemailMessage-example.txt new file mode 100644 index 000000000..a133cba37 --- /dev/null +++ b/build/docs/putVoicemailMessage-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let messageId: String = "" // Message ID +let body: VoicemailMessage = new VoicemailMessage(...) // VoicemailMessage + +// Update a voicemail message +PutVoicemailMessageRequest.putVoicemailMessage(messageId: messageId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutVoicemailMessageRequest.putVoicemailMessage was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putVoicemailPolicy-example.txt b/build/docs/putVoicemailPolicy-example.txt new file mode 100644 index 000000000..c88f1babf --- /dev/null +++ b/build/docs/putVoicemailPolicy-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: VoicemailOrganizationPolicy = new VoicemailOrganizationPolicy(...) // Policy + +// Update a policy +PutVoicemailPolicyRequest.putVoicemailPolicy(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutVoicemailPolicyRequest.putVoicemailPolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putVoicemailUserpolicy-example.txt b/build/docs/putVoicemailUserpolicy-example.txt new file mode 100644 index 000000000..a5a506f67 --- /dev/null +++ b/build/docs/putVoicemailUserpolicy-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let userId: String = "" // User ID +let body: VoicemailUserPolicy = new VoicemailUserPolicy(...) // The user's voicemail policy + +// Update a user's voicemail policy +PutVoicemailUserpolicyRequest.putVoicemailUserpolicy(userId: userId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutVoicemailUserpolicyRequest.putVoicemailUserpolicy was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWebchatDeployment-example.txt b/build/docs/putWebchatDeployment-example.txt new file mode 100644 index 000000000..dc8839c51 --- /dev/null +++ b/build/docs/putWebchatDeployment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Deployment Id +let body: WebChatDeployment = new WebChatDeployment(...) // Deployment + +// Update a WebChat deployment +PutWebchatDeploymentRequest.putWebchatDeployment(deploymentId: deploymentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWebchatDeploymentRequest.putWebchatDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWebchatSettings-example.txt b/build/docs/putWebchatSettings-example.txt new file mode 100644 index 000000000..d3e30cd22 --- /dev/null +++ b/build/docs/putWebchatSettings-example.txt @@ -0,0 +1,16 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let body: WebChatSettings = new WebChatSettings(...) // webChatSettings + +// Update WebChat deployment settings +PutWebchatSettingsRequest.putWebchatSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWebchatSettingsRequest.putWebchatSettings was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWebdeploymentsConfigurationVersionsDraft-example.txt b/build/docs/putWebdeploymentsConfigurationVersionsDraft-example.txt new file mode 100644 index 000000000..9e4238adf --- /dev/null +++ b/build/docs/putWebdeploymentsConfigurationVersionsDraft-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let configurationId: String = "" // The configuration version ID +let configurationVersion: WebDeploymentConfigurationVersion = new WebDeploymentConfigurationVersion(...) // + +// Update the configuration draft +PutWebdeploymentsConfigurationVersionsDraftRequest.putWebdeploymentsConfigurationVersionsDraft(configurationId: configurationId, configurationVersion: configurationVersion) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWebdeploymentsConfigurationVersionsDraftRequest.putWebdeploymentsConfigurationVersionsDraft was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWebdeploymentsDeployment-example.txt b/build/docs/putWebdeploymentsDeployment-example.txt new file mode 100644 index 000000000..00cb95a34 --- /dev/null +++ b/build/docs/putWebdeploymentsDeployment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // The deployment ID +let deployment: WebDeployment = new WebDeployment(...) // + +// Update a deployment +PutWebdeploymentsDeploymentRequest.putWebdeploymentsDeployment(deploymentId: deploymentId, deployment: deployment) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWebdeploymentsDeploymentRequest.putWebdeploymentsDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWidgetsDeployment-example.txt b/build/docs/putWidgetsDeployment-example.txt new file mode 100644 index 000000000..199246a12 --- /dev/null +++ b/build/docs/putWidgetsDeployment-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let deploymentId: String = "" // Widget Config Id +let body: WidgetDeployment = new WidgetDeployment(...) // Deployment + +// Update a Widget deployment +PutWidgetsDeploymentRequest.putWidgetsDeployment(deploymentId: deploymentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWidgetsDeploymentRequest.putWidgetsDeployment was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWorkforcemanagementAgentIntegrationsHris-example.txt b/build/docs/putWorkforcemanagementAgentIntegrationsHris-example.txt new file mode 100644 index 000000000..c0475b8d2 --- /dev/null +++ b/build/docs/putWorkforcemanagementAgentIntegrationsHris-example.txt @@ -0,0 +1,17 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let agentId: String = "" // The ID of the agent +let body: AgentIntegrationsRequest = new AgentIntegrationsRequest(...) // body + +// Update integrations for agent +PutWorkforcemanagementAgentIntegrationsHrisRequest.putWorkforcemanagementAgentIntegrationsHris(agentId: agentId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWorkforcemanagementAgentIntegrationsHrisRequest.putWorkforcemanagementAgentIntegrationsHris was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/putWorkforcemanagementManagementunitTimeofflimitValues-example.txt b/build/docs/putWorkforcemanagementManagementunitTimeofflimitValues-example.txt new file mode 100644 index 000000000..b458c17ca --- /dev/null +++ b/build/docs/putWorkforcemanagementManagementunitTimeofflimitValues-example.txt @@ -0,0 +1,18 @@ +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "" // expected format: "https://api.[base path]" +PureCloudPlatformClientV2API.accessToken = "your_access_token" + +let managementUnitId: String = "" // The ID of the management unit. +let timeOffLimitId: String = "" // The ID of the time off limit object to set values for +let body: SetTimeOffLimitValuesRequest = new SetTimeOffLimitValuesRequest(...) // body + +// Sets daily values for a date range of time off limit object +PutWorkforcemanagementManagementunitTimeofflimitValuesRequest.putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId: managementUnitId, timeOffLimitId: timeOffLimitId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("PutWorkforcemanagementManagementunitTimeofflimitValuesRequest.putWorkforcemanagementManagementunitTimeofflimitValues was successful") + dump(response) + } +} \ No newline at end of file diff --git a/build/docs/releaseNotes.md b/build/docs/releaseNotes.md index b610f7b94..84b48ac33 100644 --- a/build/docs/releaseNotes.md +++ b/build/docs/releaseNotes.md @@ -1,93 +1,12 @@ Platform API version: 7379 -# Major Changes (2 changes) -**OutcomeEventScore** (1 change) -* Model OutcomeEventScore was removed +# Major Changes (0 changes) -**OutcomeScoresResult** (1 change) -* Property outcomeScores was changed from OutcomeEventScore[] to OutcomeScore[] - - -# Minor Changes (24 changes) - -**/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}** (4 changes) - -* Path was added -* Operation GET was added -* Operation PUT was added -* Operation DELETE was added - -**/api/v2/speechandtextanalytics/dictionaryfeedback** (3 changes) - -* Path was added -* Operation GET was added -* Operation POST was added - -**ConversationAggregateQueryPredicate** (1 change) - -* Enum value activeRouting was added to property dimension - -**ConversationAggregationQuery** (1 change) - -* Enum value activeRouting was added to property groupBy - -**AnalyticsConversationSegment** (2 changes) - -* Enum value dndEndpoint was added to property disconnectType -* Enum value dndTransfer was added to property disconnectType - -**FlowAggregateQueryPredicate** (1 change) - -* Enum value activeRouting was added to property dimension - -**FlowAggregationQuery** (1 change) - -* Enum value activeRouting was added to property groupBy - -**TranscriptAggregateQueryPredicate** (2 changes) - -* Enum value conversationDuration was added to property dimension -* Enum value handleTime was added to property dimension - -**TranscriptAggregationQuery** (1 change) - -* Enum value tOtherAudio was added to property metrics - -**TranscriptAggregationView** (1 change) - -* Enum value tOtherAudio was added to property target - -**EventLog** (1 change) - -* Enum value IMPORT_TEMPLATE was added to property category - -**OutcomeScore** (1 change) - -* Model was added - -**DictionaryFeedback** (1 change) - -* Model was added - -**DictionaryFeedbackExamplePhrase** (1 change) - -* Model was added - -**DictionaryFeedbackEntityListing** (1 change) - -* Model was added - -**ListedDictionaryFeedback** (1 change) - -* Model was added - -**MetadataProperty** (1 change) - -* Optional property sensitive was added +# Minor Changes (0 changes) # Point Changes (0 changes) diff --git a/releaseNotes.md b/releaseNotes.md index b610f7b94..84b48ac33 100644 --- a/releaseNotes.md +++ b/releaseNotes.md @@ -1,93 +1,12 @@ Platform API version: 7379 -# Major Changes (2 changes) -**OutcomeEventScore** (1 change) -* Model OutcomeEventScore was removed +# Major Changes (0 changes) -**OutcomeScoresResult** (1 change) -* Property outcomeScores was changed from OutcomeEventScore[] to OutcomeScore[] - - -# Minor Changes (24 changes) - -**/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}** (4 changes) - -* Path was added -* Operation GET was added -* Operation PUT was added -* Operation DELETE was added - -**/api/v2/speechandtextanalytics/dictionaryfeedback** (3 changes) - -* Path was added -* Operation GET was added -* Operation POST was added - -**ConversationAggregateQueryPredicate** (1 change) - -* Enum value activeRouting was added to property dimension - -**ConversationAggregationQuery** (1 change) - -* Enum value activeRouting was added to property groupBy - -**AnalyticsConversationSegment** (2 changes) - -* Enum value dndEndpoint was added to property disconnectType -* Enum value dndTransfer was added to property disconnectType - -**FlowAggregateQueryPredicate** (1 change) - -* Enum value activeRouting was added to property dimension - -**FlowAggregationQuery** (1 change) - -* Enum value activeRouting was added to property groupBy - -**TranscriptAggregateQueryPredicate** (2 changes) - -* Enum value conversationDuration was added to property dimension -* Enum value handleTime was added to property dimension - -**TranscriptAggregationQuery** (1 change) - -* Enum value tOtherAudio was added to property metrics - -**TranscriptAggregationView** (1 change) - -* Enum value tOtherAudio was added to property target - -**EventLog** (1 change) - -* Enum value IMPORT_TEMPLATE was added to property category - -**OutcomeScore** (1 change) - -* Model was added - -**DictionaryFeedback** (1 change) - -* Model was added - -**DictionaryFeedbackExamplePhrase** (1 change) - -* Model was added - -**DictionaryFeedbackEntityListing** (1 change) - -* Model was added - -**ListedDictionaryFeedback** (1 change) - -* Model was added - -**MetadataProperty** (1 change) - -* Optional property sensitive was added +# Minor Changes (0 changes) # Point Changes (0 changes) diff --git a/version.json b/version.json index 64d28a148..3569286f6 100644 --- a/version.json +++ b/version.json @@ -1,9 +1,9 @@ { "major": 127, - "minor": 0, + "minor": 1, "point": 0, "prerelease": "", "apiVersion": 0, - "display": "127.0.0", - "displayFull": "127.0.0" + "display": "127.1.0", + "displayFull": "127.1.0" } \ No newline at end of file