purecloudplatformclientv2 85.0.1 → 86.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/Call.md +1 -0
  5. data/docs/CallBasic.md +1 -0
  6. data/docs/Callback.md +1 -0
  7. data/docs/CallbackBasic.md +1 -0
  8. data/docs/Cobrowsesession.md +1 -0
  9. data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
  10. data/docs/ContextIntent.md +13 -0
  11. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  12. data/docs/ConversationChat.md +1 -0
  13. data/docs/ConversationEventTopicCallback.md +1 -0
  14. data/docs/Coretype.md +23 -0
  15. data/docs/CoretypeListing.md +15 -0
  16. data/docs/DataExtensionsApi.md +198 -0
  17. data/docs/DataSchemaListing.md +15 -0
  18. data/docs/DetectedDialogAct.md +14 -0
  19. data/docs/DetectedIntent.md +15 -0
  20. data/docs/DetectedNamedEntity.md +16 -0
  21. data/docs/DetectedNamedEntityValue.md +14 -0
  22. data/docs/DialogflowAgent.md +3 -2
  23. data/docs/Edge.md +1 -1
  24. data/docs/Email.md +1 -0
  25. data/docs/EntityListing.md +1 -5
  26. data/docs/ExternalContactsApi.md +1001 -144
  27. data/docs/FlowDivisionView.md +2 -0
  28. data/docs/IntentDefinition.md +15 -0
  29. data/docs/IntentFeedback.md +16 -0
  30. data/docs/ItemValidationLimits.md +14 -0
  31. data/docs/Items.md +14 -0
  32. data/docs/LanguageUnderstandingApi.md +1160 -0
  33. data/docs/MaxLength.md +14 -0
  34. data/docs/Message.md +1 -0
  35. data/docs/MinLength.md +14 -0
  36. data/docs/NamedEntityAnnotation.md +13 -0
  37. data/docs/NamedEntityTypeBinding.md +14 -0
  38. data/docs/NamedEntityTypeDefinition.md +15 -0
  39. data/docs/NamedEntityTypeItem.md +14 -0
  40. data/docs/NamedEntityTypeMechanism.md +15 -0
  41. data/docs/NluConfusionMatrixColumn.md +14 -0
  42. data/docs/NluConfusionMatrixRow.md +14 -0
  43. data/docs/NluDetectionContext.md +14 -0
  44. data/docs/NluDetectionInput.md +13 -0
  45. data/docs/NluDetectionOutput.md +14 -0
  46. data/docs/NluDetectionRequest.md +14 -0
  47. data/docs/NluDetectionResponse.md +15 -0
  48. data/docs/NluDomain.md +19 -0
  49. data/docs/NluDomainListing.md +22 -0
  50. data/docs/NluDomainVersion.md +24 -0
  51. data/docs/NluDomainVersionListing.md +22 -0
  52. data/docs/NluDomainVersionQualityReport.md +15 -0
  53. data/docs/NluDomainVersionTrainingResponse.md +14 -0
  54. data/docs/NluFeedbackListing.md +22 -0
  55. data/docs/NluFeedbackRequest.md +15 -0
  56. data/docs/NluFeedbackResponse.md +18 -0
  57. data/docs/NluQualityReportSummary.md +13 -0
  58. data/docs/NluQualityReportSummaryMetric.md +14 -0
  59. data/docs/NluUtterance.md +13 -0
  60. data/docs/NluUtteranceSegment.md +14 -0
  61. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  62. data/docs/QueueConversationEventTopicCallback.md +1 -0
  63. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  64. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  65. data/docs/ReportingExportJobRequest.md +1 -0
  66. data/docs/ReportingExportJobResponse.md +2 -0
  67. data/docs/RoutingApi.md +65 -0
  68. data/docs/SCIMApi.md +12 -12
  69. data/docs/Schema.md +17 -0
  70. data/docs/SchemaQuantityLimits.md +26 -0
  71. data/docs/ScimV2EnterpriseUser.md +1 -0
  72. data/docs/Screenshare.md +1 -0
  73. data/docs/SocialExpression.md +1 -0
  74. data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
  75. data/docs/TimeOffRequestListing.md +13 -0
  76. data/docs/UploadUrlRequest.md +15 -0
  77. data/docs/UploadUrlResponse.md +14 -0
  78. data/docs/UploadsApi.md +78 -0
  79. data/docs/ValidationLimits.md +18 -0
  80. data/docs/Video.md +1 -0
  81. data/docs/WorkforceManagementApi.md +297 -448
  82. data/lib/purecloudplatformclientv2.rb +50 -57
  83. data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
  84. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
  85. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
  86. data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
  87. data/lib/purecloudplatformclientv2/api/scim_api.rb +8 -8
  88. data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
  89. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
  90. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  91. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  92. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
  93. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  94. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  95. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  96. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  97. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  98. data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → context_entity.rb} +14 -9
  99. data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_intent.rb} +14 -10
  100. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
  101. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  103. data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → coretype.rb} +97 -102
  104. data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → coretype_listing.rb} +34 -11
  105. data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
  106. data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
  107. data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
  108. data/lib/purecloudplatformclientv2/models/detected_named_entity.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
  110. data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
  111. data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
  112. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  113. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  114. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
  115. data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → intent_definition.rb} +30 -19
  116. data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → intent_feedback.rb} +71 -18
  117. data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → item_validation_limits.rb} +18 -45
  118. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → items.rb} +33 -10
  119. data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
  120. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  121. data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
  122. data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → named_entity_annotation.rb} +14 -10
  123. data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
  124. data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
  125. data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
  126. data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
  127. data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
  128. data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
  129. data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
  130. data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → nlu_detection_input.rb} +14 -10
  131. data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
  132. data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
  133. data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
  134. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
  135. data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → nlu_domain_listing.rb} +156 -53
  136. data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → nlu_domain_version.rb} +132 -87
  137. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
  138. data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
  139. data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → nlu_domain_version_training_response.rb} +33 -16
  140. data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → nlu_feedback_listing.rb} +158 -46
  141. data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
  142. data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
  143. data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
  144. data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
  145. data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
  147. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
  148. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  149. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  150. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  151. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
  152. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
  153. data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
  154. data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
  155. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
  156. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  157. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
  158. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  159. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
  160. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
  161. data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → upload_url_request.rb} +23 -26
  162. data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
  163. data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → validation_limits.rb} +76 -38
  164. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  165. data/lib/purecloudplatformclientv2/version.rb +1 -1
  166. metadata +102 -116
  167. data/docs/AsyncWeekScheduleResponse.md +0 -16
  168. data/docs/CopyShortTermForecastRequest.md +0 -14
  169. data/docs/CopyWeekScheduleRequest.md +0 -14
  170. data/docs/CreateQueueMediaAssociationRequest.md +0 -15
  171. data/docs/CreateServiceGoalGroupRequest.md +0 -15
  172. data/docs/ForecastGenerationResult.md +0 -13
  173. data/docs/ForecastGenerationRouteGroupResult.md +0 -14
  174. data/docs/ForecastResultResponse.md +0 -14
  175. data/docs/ForecastTimeSeriesResult.md +0 -14
  176. data/docs/GenerateShortTermForecastRequest.md +0 -13
  177. data/docs/GenerateShortTermForecastResponse.md +0 -16
  178. data/docs/GenerateWeekScheduleRequest.md +0 -14
  179. data/docs/GenerateWeekScheduleResponse.md +0 -15
  180. data/docs/ImportShortTermForecastRequest.md +0 -16
  181. data/docs/ImportWeekScheduleRequest.md +0 -17
  182. data/docs/IntradayDataGroup.md +0 -19
  183. data/docs/IntradayForecastData.md +0 -15
  184. data/docs/IntradayHistoricalAgentData.md +0 -14
  185. data/docs/IntradayHistoricalQueueData.md +0 -20
  186. data/docs/IntradayMetric.md +0 -14
  187. data/docs/IntradayPerformancePredictionAgentData.md +0 -13
  188. data/docs/IntradayPerformancePredictionQueueData.md +0 -15
  189. data/docs/IntradayQueryDataCommand.md +0 -17
  190. data/docs/IntradayQueue.md +0 -15
  191. data/docs/IntradayResponse.md +0 -20
  192. data/docs/IntradayScheduleData.md +0 -14
  193. data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
  194. data/docs/ListWrapperWfmForecastModification.md +0 -13
  195. data/docs/QueueMediaAssociation.md +0 -16
  196. data/docs/RescheduleRequest.md +0 -20
  197. data/docs/RescheduleResult.md +0 -13
  198. data/docs/ReschedulingOptionsResponse.md +0 -22
  199. data/docs/RouteGroup.md +0 -18
  200. data/docs/RouteGroupAttributes.md +0 -16
  201. data/docs/RouteGroupList.md +0 -14
  202. data/docs/SchedulingRunListResponse.md +0 -13
  203. data/docs/SchedulingRunResponse.md +0 -28
  204. data/docs/ServiceGoalGroup.md +0 -18
  205. data/docs/ServiceGoalGroupGoals.md +0 -15
  206. data/docs/ServiceGoalGroupList.md +0 -14
  207. data/docs/ShortTermForecast.md +0 -22
  208. data/docs/ShortTermForecastListItemResponse.md +0 -18
  209. data/docs/ShortTermForecastListResponse.md +0 -13
  210. data/docs/ShortTermForecastResponse.md +0 -15
  211. data/docs/TimeOffRequestEntityList.md +0 -13
  212. data/docs/TimeOffRequestLookupList.md +0 -13
  213. data/docs/UnscheduledAgentWarning.md +0 -14
  214. data/docs/UpdateWeekScheduleRequest.md +0 -21
  215. data/docs/UserSchedulesPartialUploadRequest.md +0 -13
  216. data/docs/WfmAbandonRate.md +0 -14
  217. data/docs/WfmAverageSpeedOfAnswer.md +0 -14
  218. data/docs/WfmForecastModification.md +0 -20
  219. data/docs/WfmForecastModificationAttributes.md +0 -16
  220. data/docs/WfmIntradayQueueListing.md +0 -14
  221. data/docs/WfmServiceLevel.md +0 -15
  222. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
  223. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
  224. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
  225. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +0 -294
  226. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
  227. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
  228. data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
  229. data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
  230. data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +0 -384
  231. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +0 -202
  232. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
  233. data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
  234. data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
  235. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +0 -283
  236. data/lib/purecloudplatformclientv2/models/reschedule_request.rb +0 -418
  237. data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
  238. data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
  239. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +0 -307
  240. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
  241. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +0 -203
  242. data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +0 -242
  243. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +0 -438
  244. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: DetectedNamedEntityValue
3
+ ---
4
+ ## PureCloud::DetectedNamedEntityValue
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **raw** | **String** | The raw value of the detected named entity. | [optional] |
11
+ | **resolved** | **String** | The resolved value of the detected named entity. | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -10,8 +10,9 @@ title: DialogflowAgent
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **project** | [**DialogflowProject**](DialogflowProject.html) | The project this Dialogflow agent belongs to | [optional] |
13
- | **languages** | **Array<String>** | The target languages of the Dialogflow agent | [optional] |
14
- | **intents** | [**Array<DialogflowIntent>**](DialogflowIntent.html) | An array of Intents associated with this bot alias | [optional] |
13
+ | **languages** | **Array<String>** | The supported languages of the Dialogflow agent | [optional] |
14
+ | **intents** | [**Array<DialogflowIntent>**](DialogflowIntent.html) | An array of Intents associated with this agent | [optional] |
15
+ | **environments** | **Array<String>** | Available environments for this agent | [optional] |
15
16
  | **self_uri** | **String** | The URI for this object | [optional] |
16
17
  {: class="table table-striped"}
17
18
 
@@ -36,7 +36,7 @@ title: Edge
36
36
  | **status_code** | **String** | The current status of the Edge. | [optional] |
37
37
  | **edge_group** | [**EdgeGroup**](EdgeGroup.html) | | [optional] |
38
38
  | **site** | [**Site**](Site.html) | The Site to which the Edge is assigned. | [optional] |
39
- | **software_status** | [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) | | [optional] |
39
+ | **software_status** | [**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) | Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge. | [optional] |
40
40
  | **online_status** | **String** | | [optional] |
41
41
  | **serial_number** | **String** | | [optional] |
42
42
  | **physical_edge** | **BOOLEAN** | | [optional] |
@@ -28,6 +28,7 @@ title: Email
28
28
  | **message_id** | **String** | A globally unique identifier for the stored content of this communication. | [optional] |
29
29
  | **draft_attachments** | [**Array<Attachment>**](Attachment.html) | A list of uploaded attachments on the email draft. | [optional] |
30
30
  | **spam** | **BOOLEAN** | Indicates if the inbound email was marked as spam. | [optional] |
31
+ | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
31
32
  {: class="table table-striped"}
32
33
 
33
34
 
@@ -7,11 +7,7 @@ title: EntityListing
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<DataTableImportJob>**](DataTableImportJob.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
- | **page_count** | **Integer** | | [optional] |
10
+ | **entities** | **Array<Object>** | | [optional] |
15
11
  {: class="table table-striped"}
16
12
 
17
13
 
@@ -10,6 +10,7 @@ Method | Description
10
10
  ------------- | ------------- | -------------
11
11
  [**delete_externalcontacts_contact**](ExternalContactsApi.html#delete_externalcontacts_contact) | Delete an external contact
12
12
  [**delete_externalcontacts_contact_note**](ExternalContactsApi.html#delete_externalcontacts_contact_note) | Delete a note for an external contact
13
+ [**delete_externalcontacts_contacts_schema**](ExternalContactsApi.html#delete_externalcontacts_contacts_schema) | Delete a schema
13
14
  [**delete_externalcontacts_organization**](ExternalContactsApi.html#delete_externalcontacts_organization) | Delete an external organization
14
15
  [**delete_externalcontacts_organization_note**](ExternalContactsApi.html#delete_externalcontacts_organization_note) | Delete a note for an external organization
15
16
  [**delete_externalcontacts_organization_trustor**](ExternalContactsApi.html#delete_externalcontacts_organization_trustor) | Unlink the Trustor for this External Organization
@@ -18,25 +19,37 @@ Method | Description
18
19
  [**get_externalcontacts_contact_note**](ExternalContactsApi.html#get_externalcontacts_contact_note) | Fetch a note for an external contact
19
20
  [**get_externalcontacts_contact_notes**](ExternalContactsApi.html#get_externalcontacts_contact_notes) | List notes for an external contact
20
21
  [**get_externalcontacts_contacts**](ExternalContactsApi.html#get_externalcontacts_contacts) | Search for external contacts
22
+ [**get_externalcontacts_contacts_schema**](ExternalContactsApi.html#get_externalcontacts_contacts_schema) | Get a schema
23
+ [**get_externalcontacts_contacts_schema_version**](ExternalContactsApi.html#get_externalcontacts_contacts_schema_version) | Get a specific version of a schema
24
+ [**get_externalcontacts_contacts_schema_versions**](ExternalContactsApi.html#get_externalcontacts_contacts_schema_versions) | Get all versions of an external contact's schema
25
+ [**get_externalcontacts_contacts_schemas**](ExternalContactsApi.html#get_externalcontacts_contacts_schemas) | Get a list of schemas.
21
26
  [**get_externalcontacts_organization**](ExternalContactsApi.html#get_externalcontacts_organization) | Fetch an external organization
22
27
  [**get_externalcontacts_organization_contacts**](ExternalContactsApi.html#get_externalcontacts_organization_contacts) | Search for external contacts in an external organization
23
28
  [**get_externalcontacts_organization_note**](ExternalContactsApi.html#get_externalcontacts_organization_note) | Fetch a note for an external organization
24
29
  [**get_externalcontacts_organization_notes**](ExternalContactsApi.html#get_externalcontacts_organization_notes) | List notes for an external organization
25
30
  [**get_externalcontacts_organization_relationships**](ExternalContactsApi.html#get_externalcontacts_organization_relationships) | Fetch a relationship for an external organization
26
31
  [**get_externalcontacts_organizations**](ExternalContactsApi.html#get_externalcontacts_organizations) | Search for external organizations
32
+ [**get_externalcontacts_organizations_schema**](ExternalContactsApi.html#get_externalcontacts_organizations_schema) | Get a schema
33
+ [**get_externalcontacts_organizations_schema_version**](ExternalContactsApi.html#get_externalcontacts_organizations_schema_version) | Get a specific version of a schema
34
+ [**get_externalcontacts_organizations_schema_versions**](ExternalContactsApi.html#get_externalcontacts_organizations_schema_versions) | Get all versions of an external organization's schema
35
+ [**get_externalcontacts_organizations_schemas**](ExternalContactsApi.html#get_externalcontacts_organizations_schemas) | Get a list of schemas.
27
36
  [**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
28
37
  [**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
29
38
  [**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
30
39
  [**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
40
+ [**post_externalcontacts_contacts_schemas**](ExternalContactsApi.html#post_externalcontacts_contacts_schemas) | Create a schema
31
41
  [**post_externalcontacts_organization_notes**](ExternalContactsApi.html#post_externalcontacts_organization_notes) | Create a note for an external organization
32
42
  [**post_externalcontacts_organizations**](ExternalContactsApi.html#post_externalcontacts_organizations) | Create an external organization
43
+ [**post_externalcontacts_organizations_schemas**](ExternalContactsApi.html#post_externalcontacts_organizations_schemas) | Create a schema
33
44
  [**post_externalcontacts_relationships**](ExternalContactsApi.html#post_externalcontacts_relationships) | Create a relationship
34
45
  [**put_externalcontacts_contact**](ExternalContactsApi.html#put_externalcontacts_contact) | Update an external contact
35
46
  [**put_externalcontacts_contact_note**](ExternalContactsApi.html#put_externalcontacts_contact_note) | Update a note for an external contact
47
+ [**put_externalcontacts_contacts_schema**](ExternalContactsApi.html#put_externalcontacts_contacts_schema) | Update a schema
36
48
  [**put_externalcontacts_conversation**](ExternalContactsApi.html#put_externalcontacts_conversation) | Associate an external contact with a conversation
37
49
  [**put_externalcontacts_organization**](ExternalContactsApi.html#put_externalcontacts_organization) | Update an external organization
38
50
  [**put_externalcontacts_organization_note**](ExternalContactsApi.html#put_externalcontacts_organization_note) | Update a note for an external organization
39
51
  [**put_externalcontacts_organization_trustor_trustor_id**](ExternalContactsApi.html#put_externalcontacts_organization_trustor_trustor_id) | Links a Trustor with an External Organization
52
+ [**put_externalcontacts_organizations_schema**](ExternalContactsApi.html#put_externalcontacts_organizations_schema) | Update a schema
40
53
  [**put_externalcontacts_relationship**](ExternalContactsApi.html#put_externalcontacts_relationship) | Update a relationship
41
54
  {: class="table table-striped"}
42
55
 
@@ -173,6 +186,70 @@ Name | Type | Description | Notes
173
186
 
174
187
 
175
188
 
189
+ <a name="delete_externalcontacts_contacts_schema"></a>
190
+
191
+ ## delete_externalcontacts_contacts_schema(schema_id)
192
+
193
+
194
+
195
+ Delete a schema
196
+
197
+
198
+
199
+ Wraps DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId}
200
+
201
+ Requires ANY permissions:
202
+
203
+ * externalContacts:customFields:edit
204
+
205
+
206
+ ### Example
207
+ ```{"language":"ruby"}
208
+ # load the gem
209
+ require 'purecloudplatformclientv2'
210
+ # setup authorization
211
+ @secret = ENV['PURECLOUD_SECRET']
212
+ @id = ENV['PURECLOUD_CLIENT_ID']
213
+ environment = "mypurecloud.com"
214
+
215
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
216
+
217
+ PureCloud.configure do |config|
218
+ config.access_token = @authToken
219
+ end
220
+
221
+ api_instance = PureCloud::ExternalContactsApi.new
222
+
223
+ schema_id = "schema_id_example" # String | Schema ID
224
+
225
+
226
+ begin
227
+ #Delete a schema
228
+ api_instance.delete_externalcontacts_contacts_schema(schema_id)
229
+ rescue PureCloud::ApiError => e
230
+ puts "Exception when calling ExternalContactsApi->delete_externalcontacts_contacts_schema: #{e}"
231
+ end
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+ Name | Type | Description | Notes
237
+ ------------- | ------------- | ------------- | -------------
238
+ **schema_id** | **String**| Schema ID | |
239
+ {: class="table table-striped"}
240
+
241
+
242
+ ### Return type
243
+
244
+ nil (empty response body)
245
+
246
+ ### HTTP request headers
247
+
248
+ - **Content-Type**: application/json
249
+ - **Accept**: application/json
250
+
251
+
252
+
176
253
  <a name="delete_externalcontacts_organization"></a>
177
254
 
178
255
  ## [**Empty**](Empty.html) delete_externalcontacts_organization(external_organization_id)
@@ -726,22 +803,21 @@ Name | Type | Description | Notes
726
803
 
727
804
 
728
805
 
729
- <a name="get_externalcontacts_organization"></a>
806
+ <a name="get_externalcontacts_contacts_schema"></a>
730
807
 
731
- ## [**ExternalOrganization**](ExternalOrganization.html) get_externalcontacts_organization(external_organization_id, opts)
808
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_contacts_schema(schema_id)
732
809
 
733
810
 
734
811
 
735
- Fetch an external organization
812
+ Get a schema
736
813
 
737
814
 
738
815
 
739
- Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}
816
+ Wraps GET /api/v2/externalcontacts/contacts/schemas/{schemaId}
740
817
 
741
818
  Requires ANY permissions:
742
819
 
743
- * relate:externalOrganization:view
744
- * externalContacts:externalOrganization:view
820
+ * externalContacts:customFields:view
745
821
 
746
822
 
747
823
  ### Example
@@ -761,19 +837,15 @@ end
761
837
 
762
838
  api_instance = PureCloud::ExternalContactsApi.new
763
839
 
764
- external_organization_id = "external_organization_id_example" # String | External Organization ID
840
+ schema_id = "schema_id_example" # String | Schema ID
765
841
 
766
- opts = {
767
- expand: "expand_example", # String | which fields, if any, to expand (externalDataSources)
768
- include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
769
- }
770
842
 
771
843
  begin
772
- #Fetch an external organization
773
- result = api_instance.get_externalcontacts_organization(external_organization_id, opts)
844
+ #Get a schema
845
+ result = api_instance.get_externalcontacts_contacts_schema(schema_id)
774
846
  p result
775
847
  rescue PureCloud::ApiError => e
776
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization: #{e}"
848
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema: #{e}"
777
849
  end
778
850
  ```
779
851
 
@@ -781,15 +853,13 @@ end
781
853
 
782
854
  Name | Type | Description | Notes
783
855
  ------------- | ------------- | ------------- | -------------
784
- **external_organization_id** | **String**| External Organization ID | |
785
- **expand** | **String**| which fields, if any, to expand (externalDataSources) | [optional] <br />**Values**: externalDataSources |
786
- **include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
856
+ **schema_id** | **String**| Schema ID | |
787
857
  {: class="table table-striped"}
788
858
 
789
859
 
790
860
  ### Return type
791
861
 
792
- [**ExternalOrganization**](ExternalOrganization.html)
862
+ [**DataSchema**](DataSchema.html)
793
863
 
794
864
  ### HTTP request headers
795
865
 
@@ -798,21 +868,21 @@ Name | Type | Description | Notes
798
868
 
799
869
 
800
870
 
801
- <a name="get_externalcontacts_organization_contacts"></a>
871
+ <a name="get_externalcontacts_contacts_schema_version"></a>
802
872
 
803
- ## [**ContactListing**](ContactListing.html) get_externalcontacts_organization_contacts(external_organization_id, opts)
873
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_contacts_schema_version(schema_id, version_id)
804
874
 
805
875
 
806
876
 
807
- Search for external contacts in an external organization
877
+ Get a specific version of a schema
808
878
 
809
879
 
810
880
 
811
- Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts
881
+ Wraps GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}
812
882
 
813
883
  Requires ANY permissions:
814
884
 
815
- * externalContacts:contact:view
885
+ * externalContacts:customFields:view
816
886
 
817
887
 
818
888
  ### Example
@@ -832,22 +902,17 @@ end
832
902
 
833
903
  api_instance = PureCloud::ExternalContactsApi.new
834
904
 
835
- external_organization_id = "external_organization_id_example" # String | External Organization ID
905
+ schema_id = "schema_id_example" # String | Schema ID
906
+
907
+ version_id = "version_id_example" # String | Schema version
836
908
 
837
- opts = {
838
- page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
839
- page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
840
- q: "q_example", # String | User supplied search keywords (no special syntax is currently supported)
841
- sort_order: "sort_order_example", # String | Sort order
842
- expand: ["expand_example"] # Array<String> | which fields, if any, to expand
843
- }
844
909
 
845
910
  begin
846
- #Search for external contacts in an external organization
847
- result = api_instance.get_externalcontacts_organization_contacts(external_organization_id, opts)
911
+ #Get a specific version of a schema
912
+ result = api_instance.get_externalcontacts_contacts_schema_version(schema_id, version_id)
848
913
  p result
849
914
  rescue PureCloud::ApiError => e
850
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_contacts: #{e}"
915
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema_version: #{e}"
851
916
  end
852
917
  ```
853
918
 
@@ -855,18 +920,14 @@ end
855
920
 
856
921
  Name | Type | Description | Notes
857
922
  ------------- | ------------- | ------------- | -------------
858
- **external_organization_id** | **String**| External Organization ID | |
859
- **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
860
- **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
861
- **q** | **String**| User supplied search keywords (no special syntax is currently supported) | [optional] |
862
- **sort_order** | **String**| Sort order | [optional] |
863
- **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: externalOrganization, externalDataSources |
923
+ **schema_id** | **String**| Schema ID | |
924
+ **version_id** | **String**| Schema version | |
864
925
  {: class="table table-striped"}
865
926
 
866
927
 
867
928
  ### Return type
868
929
 
869
- [**ContactListing**](ContactListing.html)
930
+ [**DataSchema**](DataSchema.html)
870
931
 
871
932
  ### HTTP request headers
872
933
 
@@ -875,21 +936,21 @@ Name | Type | Description | Notes
875
936
 
876
937
 
877
938
 
878
- <a name="get_externalcontacts_organization_note"></a>
939
+ <a name="get_externalcontacts_contacts_schema_versions"></a>
879
940
 
880
- ## [**Note**](Note.html) get_externalcontacts_organization_note(external_organization_id, note_id, opts)
941
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_contacts_schema_versions(schema_id)
881
942
 
882
943
 
883
944
 
884
- Fetch a note for an external organization
945
+ Get all versions of an external contact's schema
885
946
 
886
947
 
887
948
 
888
- Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
949
+ Wraps GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions
889
950
 
890
951
  Requires ANY permissions:
891
952
 
892
- * externalContacts:externalOrganization:view
953
+ * externalContacts:customFields:view
893
954
 
894
955
 
895
956
  ### Example
@@ -909,20 +970,15 @@ end
909
970
 
910
971
  api_instance = PureCloud::ExternalContactsApi.new
911
972
 
912
- external_organization_id = "external_organization_id_example" # String | External Organization Id
913
-
914
- note_id = "note_id_example" # String | Note Id
973
+ schema_id = "schema_id_example" # String | Schema ID
915
974
 
916
- opts = {
917
- expand: ["expand_example"] # Array<String> | which fields, if any, to expand
918
- }
919
975
 
920
976
  begin
921
- #Fetch a note for an external organization
922
- result = api_instance.get_externalcontacts_organization_note(external_organization_id, note_id, opts)
977
+ #Get all versions of an external contact's schema
978
+ result = api_instance.get_externalcontacts_contacts_schema_versions(schema_id)
923
979
  p result
924
980
  rescue PureCloud::ApiError => e
925
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_note: #{e}"
981
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema_versions: #{e}"
926
982
  end
927
983
  ```
928
984
 
@@ -930,15 +986,13 @@ end
930
986
 
931
987
  Name | Type | Description | Notes
932
988
  ------------- | ------------- | ------------- | -------------
933
- **external_organization_id** | **String**| External Organization Id | |
934
- **note_id** | **String**| Note Id | |
935
- **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: author, externalDataSources |
989
+ **schema_id** | **String**| Schema ID | |
936
990
  {: class="table table-striped"}
937
991
 
938
992
 
939
993
  ### Return type
940
994
 
941
- [**Note**](Note.html)
995
+ [**DataSchema**](DataSchema.html)
942
996
 
943
997
  ### HTTP request headers
944
998
 
@@ -947,22 +1001,21 @@ Name | Type | Description | Notes
947
1001
 
948
1002
 
949
1003
 
950
- <a name="get_externalcontacts_organization_notes"></a>
1004
+ <a name="get_externalcontacts_contacts_schemas"></a>
951
1005
 
952
- ## [**NoteListing**](NoteListing.html) get_externalcontacts_organization_notes(external_organization_id, opts)
1006
+ ## [**DataSchemaListing**](DataSchemaListing.html) get_externalcontacts_contacts_schemas
953
1007
 
954
1008
 
955
1009
 
956
- List notes for an external organization
1010
+ Get a list of schemas.
957
1011
 
958
1012
 
959
1013
 
960
- Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
1014
+ Wraps GET /api/v2/externalcontacts/contacts/schemas
961
1015
 
962
1016
  Requires ANY permissions:
963
1017
 
964
- * relate:externalOrganization:view
965
- * externalContacts:externalOrganization:view
1018
+ * externalContacts:customFields:view
966
1019
 
967
1020
 
968
1021
  ### Example
@@ -982,39 +1035,23 @@ end
982
1035
 
983
1036
  api_instance = PureCloud::ExternalContactsApi.new
984
1037
 
985
- external_organization_id = "external_organization_id_example" # String | External Organization Id
986
-
987
- opts = {
988
- page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
989
- page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
990
- sort_order: "sort_order_example", # String | Sort order
991
- expand: ["expand_example"] # Array<String> | which fields, if any, to expand
992
- }
993
-
994
1038
  begin
995
- #List notes for an external organization
996
- result = api_instance.get_externalcontacts_organization_notes(external_organization_id, opts)
1039
+ #Get a list of schemas.
1040
+ result = api_instance.get_externalcontacts_contacts_schemas
997
1041
  p result
998
1042
  rescue PureCloud::ApiError => e
999
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_notes: #{e}"
1043
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schemas: #{e}"
1000
1044
  end
1001
1045
  ```
1002
1046
 
1003
1047
  ### Parameters
1004
-
1005
- Name | Type | Description | Notes
1006
- ------------- | ------------- | ------------- | -------------
1007
- **external_organization_id** | **String**| External Organization Id | |
1008
- **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1009
- **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1010
- **sort_order** | **String**| Sort order | [optional] |
1011
- **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: author, externalDataSources |
1048
+ This endpoint does not need any parameter.
1012
1049
  {: class="table table-striped"}
1013
1050
 
1014
1051
 
1015
1052
  ### Return type
1016
1053
 
1017
- [**NoteListing**](NoteListing.html)
1054
+ [**DataSchemaListing**](DataSchemaListing.html)
1018
1055
 
1019
1056
  ### HTTP request headers
1020
1057
 
@@ -1023,17 +1060,17 @@ Name | Type | Description | Notes
1023
1060
 
1024
1061
 
1025
1062
 
1026
- <a name="get_externalcontacts_organization_relationships"></a>
1063
+ <a name="get_externalcontacts_organization"></a>
1027
1064
 
1028
- ## [**RelationshipListing**](RelationshipListing.html) get_externalcontacts_organization_relationships(external_organization_id, opts)
1065
+ ## [**ExternalOrganization**](ExternalOrganization.html) get_externalcontacts_organization(external_organization_id, opts)
1029
1066
 
1030
1067
 
1031
1068
 
1032
- Fetch a relationship for an external organization
1069
+ Fetch an external organization
1033
1070
 
1034
1071
 
1035
1072
 
1036
- Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships
1073
+ Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}
1037
1074
 
1038
1075
  Requires ANY permissions:
1039
1076
 
@@ -1061,18 +1098,16 @@ api_instance = PureCloud::ExternalContactsApi.new
1061
1098
  external_organization_id = "external_organization_id_example" # String | External Organization ID
1062
1099
 
1063
1100
  opts = {
1064
- page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1065
- page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1066
- expand: "expand_example", # String | which fields, if any, to expand
1067
- sort_order: "sort_order_example" # String | Sort order
1101
+ expand: "expand_example", # String | which fields, if any, to expand (externalDataSources)
1102
+ include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
1068
1103
  }
1069
1104
 
1070
1105
  begin
1071
- #Fetch a relationship for an external organization
1072
- result = api_instance.get_externalcontacts_organization_relationships(external_organization_id, opts)
1106
+ #Fetch an external organization
1107
+ result = api_instance.get_externalcontacts_organization(external_organization_id, opts)
1073
1108
  p result
1074
1109
  rescue PureCloud::ApiError => e
1075
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_relationships: #{e}"
1110
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization: #{e}"
1076
1111
  end
1077
1112
  ```
1078
1113
 
@@ -1081,16 +1116,14 @@ end
1081
1116
  Name | Type | Description | Notes
1082
1117
  ------------- | ------------- | ------------- | -------------
1083
1118
  **external_organization_id** | **String**| External Organization ID | |
1084
- **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1085
- **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1086
- **expand** | **String**| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1087
- **sort_order** | **String**| Sort order | [optional] |
1119
+ **expand** | **String**| which fields, if any, to expand (externalDataSources) | [optional] <br />**Values**: externalDataSources |
1120
+ **include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
1088
1121
  {: class="table table-striped"}
1089
1122
 
1090
1123
 
1091
1124
  ### Return type
1092
1125
 
1093
- [**RelationshipListing**](RelationshipListing.html)
1126
+ [**ExternalOrganization**](ExternalOrganization.html)
1094
1127
 
1095
1128
  ### HTTP request headers
1096
1129
 
@@ -1099,22 +1132,21 @@ Name | Type | Description | Notes
1099
1132
 
1100
1133
 
1101
1134
 
1102
- <a name="get_externalcontacts_organizations"></a>
1135
+ <a name="get_externalcontacts_organization_contacts"></a>
1103
1136
 
1104
- ## [**ExternalOrganizationListing**](ExternalOrganizationListing.html) get_externalcontacts_organizations(opts)
1137
+ ## [**ContactListing**](ContactListing.html) get_externalcontacts_organization_contacts(external_organization_id, opts)
1105
1138
 
1106
1139
 
1107
1140
 
1108
- Search for external organizations
1141
+ Search for external contacts in an external organization
1109
1142
 
1110
1143
 
1111
1144
 
1112
- Wraps GET /api/v2/externalcontacts/organizations
1145
+ Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts
1113
1146
 
1114
1147
  Requires ANY permissions:
1115
1148
 
1116
- * relate:externalOrganization:view
1117
- * externalContacts:externalOrganization:view
1149
+ * externalContacts:contact:view
1118
1150
 
1119
1151
 
1120
1152
  ### Example
@@ -1134,22 +1166,22 @@ end
1134
1166
 
1135
1167
  api_instance = PureCloud::ExternalContactsApi.new
1136
1168
 
1169
+ external_organization_id = "external_organization_id_example" # String | External Organization ID
1170
+
1137
1171
  opts = {
1138
1172
  page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1139
1173
  page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1140
- q: "q_example", # String | Search query
1141
- trustor_id: ["trustor_id_example"], # Array<String> | Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
1174
+ q: "q_example", # String | User supplied search keywords (no special syntax is currently supported)
1142
1175
  sort_order: "sort_order_example", # String | Sort order
1143
- expand: ["expand_example"], # Array<String> | which fields, if any, to expand
1144
- include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
1176
+ expand: ["expand_example"] # Array<String> | which fields, if any, to expand
1145
1177
  }
1146
1178
 
1147
1179
  begin
1148
- #Search for external organizations
1149
- result = api_instance.get_externalcontacts_organizations(opts)
1180
+ #Search for external contacts in an external organization
1181
+ result = api_instance.get_externalcontacts_organization_contacts(external_organization_id, opts)
1150
1182
  p result
1151
1183
  rescue PureCloud::ApiError => e
1152
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations: #{e}"
1184
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_contacts: #{e}"
1153
1185
  end
1154
1186
  ```
1155
1187
 
@@ -1157,19 +1189,18 @@ end
1157
1189
 
1158
1190
  Name | Type | Description | Notes
1159
1191
  ------------- | ------------- | ------------- | -------------
1192
+ **external_organization_id** | **String**| External Organization ID | |
1160
1193
  **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1161
1194
  **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1162
- **q** | **String**| Search query | [optional] |
1163
- **trustor_id** | [**Array&lt;String&gt;**](String.html)| Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested | [optional] |
1195
+ **q** | **String**| User supplied search keywords (no special syntax is currently supported) | [optional] |
1164
1196
  **sort_order** | **String**| Sort order | [optional] |
1165
- **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1166
- **include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
1197
+ **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: externalOrganization, externalDataSources |
1167
1198
  {: class="table table-striped"}
1168
1199
 
1169
1200
 
1170
1201
  ### Return type
1171
1202
 
1172
- [**ExternalOrganizationListing**](ExternalOrganizationListing.html)
1203
+ [**ContactListing**](ContactListing.html)
1173
1204
 
1174
1205
  ### HTTP request headers
1175
1206
 
@@ -1178,17 +1209,17 @@ Name | Type | Description | Notes
1178
1209
 
1179
1210
 
1180
1211
 
1181
- <a name="get_externalcontacts_relationship"></a>
1212
+ <a name="get_externalcontacts_organization_note"></a>
1182
1213
 
1183
- ## [**Relationship**](Relationship.html) get_externalcontacts_relationship(relationship_id, opts)
1214
+ ## [**Note**](Note.html) get_externalcontacts_organization_note(external_organization_id, note_id, opts)
1184
1215
 
1185
1216
 
1186
1217
 
1187
- Fetch a relationship
1218
+ Fetch a note for an external organization
1188
1219
 
1189
1220
 
1190
1221
 
1191
- Wraps GET /api/v2/externalcontacts/relationships/{relationshipId}
1222
+ Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
1192
1223
 
1193
1224
  Requires ANY permissions:
1194
1225
 
@@ -1212,18 +1243,20 @@ end
1212
1243
 
1213
1244
  api_instance = PureCloud::ExternalContactsApi.new
1214
1245
 
1215
- relationship_id = "relationship_id_example" # String | Relationship Id
1246
+ external_organization_id = "external_organization_id_example" # String | External Organization Id
1247
+
1248
+ note_id = "note_id_example" # String | Note Id
1216
1249
 
1217
1250
  opts = {
1218
- expand: "expand_example" # String | which fields, if any, to expand
1251
+ expand: ["expand_example"] # Array<String> | which fields, if any, to expand
1219
1252
  }
1220
1253
 
1221
1254
  begin
1222
- #Fetch a relationship
1223
- result = api_instance.get_externalcontacts_relationship(relationship_id, opts)
1255
+ #Fetch a note for an external organization
1256
+ result = api_instance.get_externalcontacts_organization_note(external_organization_id, note_id, opts)
1224
1257
  p result
1225
1258
  rescue PureCloud::ApiError => e
1226
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_relationship: #{e}"
1259
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_note: #{e}"
1227
1260
  end
1228
1261
  ```
1229
1262
 
@@ -1231,14 +1264,15 @@ end
1231
1264
 
1232
1265
  Name | Type | Description | Notes
1233
1266
  ------------- | ------------- | ------------- | -------------
1234
- **relationship_id** | **String**| Relationship Id | |
1235
- **expand** | **String**| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1267
+ **external_organization_id** | **String**| External Organization Id | |
1268
+ **note_id** | **String**| Note Id | |
1269
+ **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: author, externalDataSources |
1236
1270
  {: class="table table-striped"}
1237
1271
 
1238
1272
 
1239
1273
  ### Return type
1240
1274
 
1241
- [**Relationship**](Relationship.html)
1275
+ [**Note**](Note.html)
1242
1276
 
1243
1277
  ### HTTP request headers
1244
1278
 
@@ -1247,21 +1281,22 @@ Name | Type | Description | Notes
1247
1281
 
1248
1282
 
1249
1283
 
1250
- <a name="get_externalcontacts_reversewhitepageslookup"></a>
1284
+ <a name="get_externalcontacts_organization_notes"></a>
1251
1285
 
1252
- ## [**ReverseWhitepagesLookupResult**](ReverseWhitepagesLookupResult.html) get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
1286
+ ## [**NoteListing**](NoteListing.html) get_externalcontacts_organization_notes(external_organization_id, opts)
1253
1287
 
1254
1288
 
1255
1289
 
1256
- Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1290
+ List notes for an external organization
1257
1291
 
1258
1292
 
1259
1293
 
1260
- Wraps GET /api/v2/externalcontacts/reversewhitepageslookup
1294
+ Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
1261
1295
 
1262
1296
  Requires ANY permissions:
1263
1297
 
1264
- * externalContacts:contact:view
1298
+ * relate:externalOrganization:view
1299
+ * externalContacts:externalOrganization:view
1265
1300
 
1266
1301
 
1267
1302
  ### Example
@@ -1281,18 +1316,21 @@ end
1281
1316
 
1282
1317
  api_instance = PureCloud::ExternalContactsApi.new
1283
1318
 
1284
- lookup_val = "lookup_val_example" # String | User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
1319
+ external_organization_id = "external_organization_id_example" # String | External Organization Id
1285
1320
 
1286
1321
  opts = {
1287
- expand: ["expand_example"] # Array<String> | which field, if any, to expand
1322
+ page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1323
+ page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1324
+ sort_order: "sort_order_example", # String | Sort order
1325
+ expand: ["expand_example"] # Array<String> | which fields, if any, to expand
1288
1326
  }
1289
1327
 
1290
1328
  begin
1291
- #Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1292
- result = api_instance.get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
1329
+ #List notes for an external organization
1330
+ result = api_instance.get_externalcontacts_organization_notes(external_organization_id, opts)
1293
1331
  p result
1294
1332
  rescue PureCloud::ApiError => e
1295
- puts "Exception when calling ExternalContactsApi->get_externalcontacts_reversewhitepageslookup: #{e}"
1333
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_notes: #{e}"
1296
1334
  end
1297
1335
  ```
1298
1336
 
@@ -1300,8 +1338,561 @@ end
1300
1338
 
1301
1339
  Name | Type | Description | Notes
1302
1340
  ------------- | ------------- | ------------- | -------------
1303
- **lookup_val** | **String**| User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names) | |
1304
- **expand** | [**Array&lt;String&gt;**](String.html)| which field, if any, to expand | [optional] <br />**Values**: contacts.externalOrganization, externalDataSources |
1341
+ **external_organization_id** | **String**| External Organization Id | |
1342
+ **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1343
+ **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1344
+ **sort_order** | **String**| Sort order | [optional] |
1345
+ **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: author, externalDataSources |
1346
+ {: class="table table-striped"}
1347
+
1348
+
1349
+ ### Return type
1350
+
1351
+ [**NoteListing**](NoteListing.html)
1352
+
1353
+ ### HTTP request headers
1354
+
1355
+ - **Content-Type**: application/json
1356
+ - **Accept**: application/json
1357
+
1358
+
1359
+
1360
+ <a name="get_externalcontacts_organization_relationships"></a>
1361
+
1362
+ ## [**RelationshipListing**](RelationshipListing.html) get_externalcontacts_organization_relationships(external_organization_id, opts)
1363
+
1364
+
1365
+
1366
+ Fetch a relationship for an external organization
1367
+
1368
+
1369
+
1370
+ Wraps GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships
1371
+
1372
+ Requires ANY permissions:
1373
+
1374
+ * relate:externalOrganization:view
1375
+ * externalContacts:externalOrganization:view
1376
+
1377
+
1378
+ ### Example
1379
+ ```{"language":"ruby"}
1380
+ # load the gem
1381
+ require 'purecloudplatformclientv2'
1382
+ # setup authorization
1383
+ @secret = ENV['PURECLOUD_SECRET']
1384
+ @id = ENV['PURECLOUD_CLIENT_ID']
1385
+ environment = "mypurecloud.com"
1386
+
1387
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1388
+
1389
+ PureCloud.configure do |config|
1390
+ config.access_token = @authToken
1391
+ end
1392
+
1393
+ api_instance = PureCloud::ExternalContactsApi.new
1394
+
1395
+ external_organization_id = "external_organization_id_example" # String | External Organization ID
1396
+
1397
+ opts = {
1398
+ page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1399
+ page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1400
+ expand: "expand_example", # String | which fields, if any, to expand
1401
+ sort_order: "sort_order_example" # String | Sort order
1402
+ }
1403
+
1404
+ begin
1405
+ #Fetch a relationship for an external organization
1406
+ result = api_instance.get_externalcontacts_organization_relationships(external_organization_id, opts)
1407
+ p result
1408
+ rescue PureCloud::ApiError => e
1409
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organization_relationships: #{e}"
1410
+ end
1411
+ ```
1412
+
1413
+ ### Parameters
1414
+
1415
+ Name | Type | Description | Notes
1416
+ ------------- | ------------- | ------------- | -------------
1417
+ **external_organization_id** | **String**| External Organization ID | |
1418
+ **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1419
+ **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1420
+ **expand** | **String**| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1421
+ **sort_order** | **String**| Sort order | [optional] |
1422
+ {: class="table table-striped"}
1423
+
1424
+
1425
+ ### Return type
1426
+
1427
+ [**RelationshipListing**](RelationshipListing.html)
1428
+
1429
+ ### HTTP request headers
1430
+
1431
+ - **Content-Type**: application/json
1432
+ - **Accept**: application/json
1433
+
1434
+
1435
+
1436
+ <a name="get_externalcontacts_organizations"></a>
1437
+
1438
+ ## [**ExternalOrganizationListing**](ExternalOrganizationListing.html) get_externalcontacts_organizations(opts)
1439
+
1440
+
1441
+
1442
+ Search for external organizations
1443
+
1444
+
1445
+
1446
+ Wraps GET /api/v2/externalcontacts/organizations
1447
+
1448
+ Requires ANY permissions:
1449
+
1450
+ * relate:externalOrganization:view
1451
+ * externalContacts:externalOrganization:view
1452
+
1453
+
1454
+ ### Example
1455
+ ```{"language":"ruby"}
1456
+ # load the gem
1457
+ require 'purecloudplatformclientv2'
1458
+ # setup authorization
1459
+ @secret = ENV['PURECLOUD_SECRET']
1460
+ @id = ENV['PURECLOUD_CLIENT_ID']
1461
+ environment = "mypurecloud.com"
1462
+
1463
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1464
+
1465
+ PureCloud.configure do |config|
1466
+ config.access_token = @authToken
1467
+ end
1468
+
1469
+ api_instance = PureCloud::ExternalContactsApi.new
1470
+
1471
+ opts = {
1472
+ page_size: 20, # Integer | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1473
+ page_number: 1, # Integer | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
1474
+ q: "q_example", # String | Search query
1475
+ trustor_id: ["trustor_id_example"], # Array<String> | Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
1476
+ sort_order: "sort_order_example", # String | Sort order
1477
+ expand: ["expand_example"], # Array<String> | which fields, if any, to expand
1478
+ include_trustors: true # BOOLEAN | (true or false) whether or not to include trustor information embedded in the externalOrganization
1479
+ }
1480
+
1481
+ begin
1482
+ #Search for external organizations
1483
+ result = api_instance.get_externalcontacts_organizations(opts)
1484
+ p result
1485
+ rescue PureCloud::ApiError => e
1486
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations: #{e}"
1487
+ end
1488
+ ```
1489
+
1490
+ ### Parameters
1491
+
1492
+ Name | Type | Description | Notes
1493
+ ------------- | ------------- | ------------- | -------------
1494
+ **page_size** | **Integer**| Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 20] |
1495
+ **page_number** | **Integer**| Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) | [optional] [default to 1] |
1496
+ **q** | **String**| Search query | [optional] |
1497
+ **trustor_id** | [**Array&lt;String&gt;**](String.html)| Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested | [optional] |
1498
+ **sort_order** | **String**| Sort order | [optional] |
1499
+ **expand** | [**Array&lt;String&gt;**](String.html)| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1500
+ **include_trustors** | **BOOLEAN**| (true or false) whether or not to include trustor information embedded in the externalOrganization | [optional] |
1501
+ {: class="table table-striped"}
1502
+
1503
+
1504
+ ### Return type
1505
+
1506
+ [**ExternalOrganizationListing**](ExternalOrganizationListing.html)
1507
+
1508
+ ### HTTP request headers
1509
+
1510
+ - **Content-Type**: application/json
1511
+ - **Accept**: application/json
1512
+
1513
+
1514
+
1515
+ <a name="get_externalcontacts_organizations_schema"></a>
1516
+
1517
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_organizations_schema(schema_id)
1518
+
1519
+
1520
+
1521
+ Get a schema
1522
+
1523
+
1524
+
1525
+ Wraps GET /api/v2/externalcontacts/organizations/schemas/{schemaId}
1526
+
1527
+ Requires ANY permissions:
1528
+
1529
+ * externalContacts:customFields:view
1530
+
1531
+
1532
+ ### Example
1533
+ ```{"language":"ruby"}
1534
+ # load the gem
1535
+ require 'purecloudplatformclientv2'
1536
+ # setup authorization
1537
+ @secret = ENV['PURECLOUD_SECRET']
1538
+ @id = ENV['PURECLOUD_CLIENT_ID']
1539
+ environment = "mypurecloud.com"
1540
+
1541
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1542
+
1543
+ PureCloud.configure do |config|
1544
+ config.access_token = @authToken
1545
+ end
1546
+
1547
+ api_instance = PureCloud::ExternalContactsApi.new
1548
+
1549
+ schema_id = "schema_id_example" # String | Schema ID
1550
+
1551
+
1552
+ begin
1553
+ #Get a schema
1554
+ result = api_instance.get_externalcontacts_organizations_schema(schema_id)
1555
+ p result
1556
+ rescue PureCloud::ApiError => e
1557
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema: #{e}"
1558
+ end
1559
+ ```
1560
+
1561
+ ### Parameters
1562
+
1563
+ Name | Type | Description | Notes
1564
+ ------------- | ------------- | ------------- | -------------
1565
+ **schema_id** | **String**| Schema ID | |
1566
+ {: class="table table-striped"}
1567
+
1568
+
1569
+ ### Return type
1570
+
1571
+ [**DataSchema**](DataSchema.html)
1572
+
1573
+ ### HTTP request headers
1574
+
1575
+ - **Content-Type**: application/json
1576
+ - **Accept**: application/json
1577
+
1578
+
1579
+
1580
+ <a name="get_externalcontacts_organizations_schema_version"></a>
1581
+
1582
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_organizations_schema_version(schema_id, version_id)
1583
+
1584
+
1585
+
1586
+ Get a specific version of a schema
1587
+
1588
+
1589
+
1590
+ Wraps GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}
1591
+
1592
+ Requires ANY permissions:
1593
+
1594
+ * externalContacts:customFields:view
1595
+
1596
+
1597
+ ### Example
1598
+ ```{"language":"ruby"}
1599
+ # load the gem
1600
+ require 'purecloudplatformclientv2'
1601
+ # setup authorization
1602
+ @secret = ENV['PURECLOUD_SECRET']
1603
+ @id = ENV['PURECLOUD_CLIENT_ID']
1604
+ environment = "mypurecloud.com"
1605
+
1606
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1607
+
1608
+ PureCloud.configure do |config|
1609
+ config.access_token = @authToken
1610
+ end
1611
+
1612
+ api_instance = PureCloud::ExternalContactsApi.new
1613
+
1614
+ schema_id = "schema_id_example" # String | Schema ID
1615
+
1616
+ version_id = "version_id_example" # String | Schema version
1617
+
1618
+
1619
+ begin
1620
+ #Get a specific version of a schema
1621
+ result = api_instance.get_externalcontacts_organizations_schema_version(schema_id, version_id)
1622
+ p result
1623
+ rescue PureCloud::ApiError => e
1624
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema_version: #{e}"
1625
+ end
1626
+ ```
1627
+
1628
+ ### Parameters
1629
+
1630
+ Name | Type | Description | Notes
1631
+ ------------- | ------------- | ------------- | -------------
1632
+ **schema_id** | **String**| Schema ID | |
1633
+ **version_id** | **String**| Schema version | |
1634
+ {: class="table table-striped"}
1635
+
1636
+
1637
+ ### Return type
1638
+
1639
+ [**DataSchema**](DataSchema.html)
1640
+
1641
+ ### HTTP request headers
1642
+
1643
+ - **Content-Type**: application/json
1644
+ - **Accept**: application/json
1645
+
1646
+
1647
+
1648
+ <a name="get_externalcontacts_organizations_schema_versions"></a>
1649
+
1650
+ ## [**DataSchema**](DataSchema.html) get_externalcontacts_organizations_schema_versions(schema_id)
1651
+
1652
+
1653
+
1654
+ Get all versions of an external organization's schema
1655
+
1656
+
1657
+
1658
+ Wraps GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions
1659
+
1660
+ Requires ANY permissions:
1661
+
1662
+ * externalContacts:customFields:view
1663
+
1664
+
1665
+ ### Example
1666
+ ```{"language":"ruby"}
1667
+ # load the gem
1668
+ require 'purecloudplatformclientv2'
1669
+ # setup authorization
1670
+ @secret = ENV['PURECLOUD_SECRET']
1671
+ @id = ENV['PURECLOUD_CLIENT_ID']
1672
+ environment = "mypurecloud.com"
1673
+
1674
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1675
+
1676
+ PureCloud.configure do |config|
1677
+ config.access_token = @authToken
1678
+ end
1679
+
1680
+ api_instance = PureCloud::ExternalContactsApi.new
1681
+
1682
+ schema_id = "schema_id_example" # String | Schema ID
1683
+
1684
+
1685
+ begin
1686
+ #Get all versions of an external organization's schema
1687
+ result = api_instance.get_externalcontacts_organizations_schema_versions(schema_id)
1688
+ p result
1689
+ rescue PureCloud::ApiError => e
1690
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema_versions: #{e}"
1691
+ end
1692
+ ```
1693
+
1694
+ ### Parameters
1695
+
1696
+ Name | Type | Description | Notes
1697
+ ------------- | ------------- | ------------- | -------------
1698
+ **schema_id** | **String**| Schema ID | |
1699
+ {: class="table table-striped"}
1700
+
1701
+
1702
+ ### Return type
1703
+
1704
+ [**DataSchema**](DataSchema.html)
1705
+
1706
+ ### HTTP request headers
1707
+
1708
+ - **Content-Type**: application/json
1709
+ - **Accept**: application/json
1710
+
1711
+
1712
+
1713
+ <a name="get_externalcontacts_organizations_schemas"></a>
1714
+
1715
+ ## [**DataSchemaListing**](DataSchemaListing.html) get_externalcontacts_organizations_schemas
1716
+
1717
+
1718
+
1719
+ Get a list of schemas.
1720
+
1721
+
1722
+
1723
+ Wraps GET /api/v2/externalcontacts/organizations/schemas
1724
+
1725
+ Requires ANY permissions:
1726
+
1727
+ * externalContacts:customFields:view
1728
+
1729
+
1730
+ ### Example
1731
+ ```{"language":"ruby"}
1732
+ # load the gem
1733
+ require 'purecloudplatformclientv2'
1734
+ # setup authorization
1735
+ @secret = ENV['PURECLOUD_SECRET']
1736
+ @id = ENV['PURECLOUD_CLIENT_ID']
1737
+ environment = "mypurecloud.com"
1738
+
1739
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1740
+
1741
+ PureCloud.configure do |config|
1742
+ config.access_token = @authToken
1743
+ end
1744
+
1745
+ api_instance = PureCloud::ExternalContactsApi.new
1746
+
1747
+ begin
1748
+ #Get a list of schemas.
1749
+ result = api_instance.get_externalcontacts_organizations_schemas
1750
+ p result
1751
+ rescue PureCloud::ApiError => e
1752
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schemas: #{e}"
1753
+ end
1754
+ ```
1755
+
1756
+ ### Parameters
1757
+ This endpoint does not need any parameter.
1758
+ {: class="table table-striped"}
1759
+
1760
+
1761
+ ### Return type
1762
+
1763
+ [**DataSchemaListing**](DataSchemaListing.html)
1764
+
1765
+ ### HTTP request headers
1766
+
1767
+ - **Content-Type**: application/json
1768
+ - **Accept**: application/json
1769
+
1770
+
1771
+
1772
+ <a name="get_externalcontacts_relationship"></a>
1773
+
1774
+ ## [**Relationship**](Relationship.html) get_externalcontacts_relationship(relationship_id, opts)
1775
+
1776
+
1777
+
1778
+ Fetch a relationship
1779
+
1780
+
1781
+
1782
+ Wraps GET /api/v2/externalcontacts/relationships/{relationshipId}
1783
+
1784
+ Requires ANY permissions:
1785
+
1786
+ * externalContacts:externalOrganization:view
1787
+
1788
+
1789
+ ### Example
1790
+ ```{"language":"ruby"}
1791
+ # load the gem
1792
+ require 'purecloudplatformclientv2'
1793
+ # setup authorization
1794
+ @secret = ENV['PURECLOUD_SECRET']
1795
+ @id = ENV['PURECLOUD_CLIENT_ID']
1796
+ environment = "mypurecloud.com"
1797
+
1798
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1799
+
1800
+ PureCloud.configure do |config|
1801
+ config.access_token = @authToken
1802
+ end
1803
+
1804
+ api_instance = PureCloud::ExternalContactsApi.new
1805
+
1806
+ relationship_id = "relationship_id_example" # String | Relationship Id
1807
+
1808
+ opts = {
1809
+ expand: "expand_example" # String | which fields, if any, to expand
1810
+ }
1811
+
1812
+ begin
1813
+ #Fetch a relationship
1814
+ result = api_instance.get_externalcontacts_relationship(relationship_id, opts)
1815
+ p result
1816
+ rescue PureCloud::ApiError => e
1817
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_relationship: #{e}"
1818
+ end
1819
+ ```
1820
+
1821
+ ### Parameters
1822
+
1823
+ Name | Type | Description | Notes
1824
+ ------------- | ------------- | ------------- | -------------
1825
+ **relationship_id** | **String**| Relationship Id | |
1826
+ **expand** | **String**| which fields, if any, to expand | [optional] <br />**Values**: externalDataSources |
1827
+ {: class="table table-striped"}
1828
+
1829
+
1830
+ ### Return type
1831
+
1832
+ [**Relationship**](Relationship.html)
1833
+
1834
+ ### HTTP request headers
1835
+
1836
+ - **Content-Type**: application/json
1837
+ - **Accept**: application/json
1838
+
1839
+
1840
+
1841
+ <a name="get_externalcontacts_reversewhitepageslookup"></a>
1842
+
1843
+ ## [**ReverseWhitepagesLookupResult**](ReverseWhitepagesLookupResult.html) get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
1844
+
1845
+
1846
+
1847
+ Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1848
+
1849
+
1850
+
1851
+ Wraps GET /api/v2/externalcontacts/reversewhitepageslookup
1852
+
1853
+ Requires ANY permissions:
1854
+
1855
+ * externalContacts:contact:view
1856
+
1857
+
1858
+ ### Example
1859
+ ```{"language":"ruby"}
1860
+ # load the gem
1861
+ require 'purecloudplatformclientv2'
1862
+ # setup authorization
1863
+ @secret = ENV['PURECLOUD_SECRET']
1864
+ @id = ENV['PURECLOUD_CLIENT_ID']
1865
+ environment = "mypurecloud.com"
1866
+
1867
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1868
+
1869
+ PureCloud.configure do |config|
1870
+ config.access_token = @authToken
1871
+ end
1872
+
1873
+ api_instance = PureCloud::ExternalContactsApi.new
1874
+
1875
+ lookup_val = "lookup_val_example" # String | User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)
1876
+
1877
+ opts = {
1878
+ expand: ["expand_example"] # Array<String> | which field, if any, to expand
1879
+ }
1880
+
1881
+ begin
1882
+ #Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
1883
+ result = api_instance.get_externalcontacts_reversewhitepageslookup(lookup_val, opts)
1884
+ p result
1885
+ rescue PureCloud::ApiError => e
1886
+ puts "Exception when calling ExternalContactsApi->get_externalcontacts_reversewhitepageslookup: #{e}"
1887
+ end
1888
+ ```
1889
+
1890
+ ### Parameters
1891
+
1892
+ Name | Type | Description | Notes
1893
+ ------------- | ------------- | ------------- | -------------
1894
+ **lookup_val** | **String**| User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names) | |
1895
+ **expand** | [**Array&lt;String&gt;**](String.html)| which field, if any, to expand | [optional] <br />**Values**: contacts.externalOrganization, externalDataSources |
1305
1896
  {: class="table table-striped"}
1306
1897
 
1307
1898
 
@@ -1449,6 +2040,71 @@ Name | Type | Description | Notes
1449
2040
 
1450
2041
 
1451
2042
 
2043
+ <a name="post_externalcontacts_contacts_schemas"></a>
2044
+
2045
+ ## [**DataSchema**](DataSchema.html) post_externalcontacts_contacts_schemas(body)
2046
+
2047
+
2048
+
2049
+ Create a schema
2050
+
2051
+
2052
+
2053
+ Wraps POST /api/v2/externalcontacts/contacts/schemas
2054
+
2055
+ Requires ANY permissions:
2056
+
2057
+ * externalContacts:customFields:add
2058
+
2059
+
2060
+ ### Example
2061
+ ```{"language":"ruby"}
2062
+ # load the gem
2063
+ require 'purecloudplatformclientv2'
2064
+ # setup authorization
2065
+ @secret = ENV['PURECLOUD_SECRET']
2066
+ @id = ENV['PURECLOUD_CLIENT_ID']
2067
+ environment = "mypurecloud.com"
2068
+
2069
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2070
+
2071
+ PureCloud.configure do |config|
2072
+ config.access_token = @authToken
2073
+ end
2074
+
2075
+ api_instance = PureCloud::ExternalContactsApi.new
2076
+
2077
+ body = PureCloud::DataSchema.new # DataSchema | Schema
2078
+
2079
+
2080
+ begin
2081
+ #Create a schema
2082
+ result = api_instance.post_externalcontacts_contacts_schemas(body)
2083
+ p result
2084
+ rescue PureCloud::ApiError => e
2085
+ puts "Exception when calling ExternalContactsApi->post_externalcontacts_contacts_schemas: #{e}"
2086
+ end
2087
+ ```
2088
+
2089
+ ### Parameters
2090
+
2091
+ Name | Type | Description | Notes
2092
+ ------------- | ------------- | ------------- | -------------
2093
+ **body** | [**DataSchema**](DataSchema.html)| Schema | |
2094
+ {: class="table table-striped"}
2095
+
2096
+
2097
+ ### Return type
2098
+
2099
+ [**DataSchema**](DataSchema.html)
2100
+
2101
+ ### HTTP request headers
2102
+
2103
+ - **Content-Type**: application/json
2104
+ - **Accept**: application/json
2105
+
2106
+
2107
+
1452
2108
  <a name="post_externalcontacts_organization_notes"></a>
1453
2109
 
1454
2110
  ## [**Note**](Note.html) post_externalcontacts_organization_notes(external_organization_id, body)
@@ -1584,6 +2240,71 @@ Name | Type | Description | Notes
1584
2240
 
1585
2241
 
1586
2242
 
2243
+ <a name="post_externalcontacts_organizations_schemas"></a>
2244
+
2245
+ ## [**DataSchema**](DataSchema.html) post_externalcontacts_organizations_schemas(body)
2246
+
2247
+
2248
+
2249
+ Create a schema
2250
+
2251
+
2252
+
2253
+ Wraps POST /api/v2/externalcontacts/organizations/schemas
2254
+
2255
+ Requires ANY permissions:
2256
+
2257
+ * externalContacts:customFields:add
2258
+
2259
+
2260
+ ### Example
2261
+ ```{"language":"ruby"}
2262
+ # load the gem
2263
+ require 'purecloudplatformclientv2'
2264
+ # setup authorization
2265
+ @secret = ENV['PURECLOUD_SECRET']
2266
+ @id = ENV['PURECLOUD_CLIENT_ID']
2267
+ environment = "mypurecloud.com"
2268
+
2269
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2270
+
2271
+ PureCloud.configure do |config|
2272
+ config.access_token = @authToken
2273
+ end
2274
+
2275
+ api_instance = PureCloud::ExternalContactsApi.new
2276
+
2277
+ body = PureCloud::DataSchema.new # DataSchema | Schema
2278
+
2279
+
2280
+ begin
2281
+ #Create a schema
2282
+ result = api_instance.post_externalcontacts_organizations_schemas(body)
2283
+ p result
2284
+ rescue PureCloud::ApiError => e
2285
+ puts "Exception when calling ExternalContactsApi->post_externalcontacts_organizations_schemas: #{e}"
2286
+ end
2287
+ ```
2288
+
2289
+ ### Parameters
2290
+
2291
+ Name | Type | Description | Notes
2292
+ ------------- | ------------- | ------------- | -------------
2293
+ **body** | [**DataSchema**](DataSchema.html)| Schema | |
2294
+ {: class="table table-striped"}
2295
+
2296
+
2297
+ ### Return type
2298
+
2299
+ [**DataSchema**](DataSchema.html)
2300
+
2301
+ ### HTTP request headers
2302
+
2303
+ - **Content-Type**: application/json
2304
+ - **Accept**: application/json
2305
+
2306
+
2307
+
1587
2308
  <a name="post_externalcontacts_relationships"></a>
1588
2309
 
1589
2310
  ## [**Relationship**](Relationship.html) post_externalcontacts_relationships(body)
@@ -1788,6 +2509,74 @@ Name | Type | Description | Notes
1788
2509
 
1789
2510
 
1790
2511
 
2512
+ <a name="put_externalcontacts_contacts_schema"></a>
2513
+
2514
+ ## [**DataSchema**](DataSchema.html) put_externalcontacts_contacts_schema(schema_id, body)
2515
+
2516
+
2517
+
2518
+ Update a schema
2519
+
2520
+
2521
+
2522
+ Wraps PUT /api/v2/externalcontacts/contacts/schemas/{schemaId}
2523
+
2524
+ Requires ANY permissions:
2525
+
2526
+ * externalContacts:customFields:edit
2527
+
2528
+
2529
+ ### Example
2530
+ ```{"language":"ruby"}
2531
+ # load the gem
2532
+ require 'purecloudplatformclientv2'
2533
+ # setup authorization
2534
+ @secret = ENV['PURECLOUD_SECRET']
2535
+ @id = ENV['PURECLOUD_CLIENT_ID']
2536
+ environment = "mypurecloud.com"
2537
+
2538
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2539
+
2540
+ PureCloud.configure do |config|
2541
+ config.access_token = @authToken
2542
+ end
2543
+
2544
+ api_instance = PureCloud::ExternalContactsApi.new
2545
+
2546
+ schema_id = "schema_id_example" # String | Schema ID
2547
+
2548
+ body = PureCloud::DataSchema.new # DataSchema | Data Schema
2549
+
2550
+
2551
+ begin
2552
+ #Update a schema
2553
+ result = api_instance.put_externalcontacts_contacts_schema(schema_id, body)
2554
+ p result
2555
+ rescue PureCloud::ApiError => e
2556
+ puts "Exception when calling ExternalContactsApi->put_externalcontacts_contacts_schema: #{e}"
2557
+ end
2558
+ ```
2559
+
2560
+ ### Parameters
2561
+
2562
+ Name | Type | Description | Notes
2563
+ ------------- | ------------- | ------------- | -------------
2564
+ **schema_id** | **String**| Schema ID | |
2565
+ **body** | [**DataSchema**](DataSchema.html)| Data Schema | |
2566
+ {: class="table table-striped"}
2567
+
2568
+
2569
+ ### Return type
2570
+
2571
+ [**DataSchema**](DataSchema.html)
2572
+
2573
+ ### HTTP request headers
2574
+
2575
+ - **Content-Type**: application/json
2576
+ - **Accept**: application/json
2577
+
2578
+
2579
+
1791
2580
  <a name="put_externalcontacts_conversation"></a>
1792
2581
 
1793
2582
  ## put_externalcontacts_conversation(conversation_id, body)
@@ -2063,6 +2852,74 @@ Name | Type | Description | Notes
2063
2852
 
2064
2853
 
2065
2854
 
2855
+ <a name="put_externalcontacts_organizations_schema"></a>
2856
+
2857
+ ## [**DataSchema**](DataSchema.html) put_externalcontacts_organizations_schema(schema_id, body)
2858
+
2859
+
2860
+
2861
+ Update a schema
2862
+
2863
+
2864
+
2865
+ Wraps PUT /api/v2/externalcontacts/organizations/schemas/{schemaId}
2866
+
2867
+ Requires ANY permissions:
2868
+
2869
+ * externalContacts:customFields:edit
2870
+
2871
+
2872
+ ### Example
2873
+ ```{"language":"ruby"}
2874
+ # load the gem
2875
+ require 'purecloudplatformclientv2'
2876
+ # setup authorization
2877
+ @secret = ENV['PURECLOUD_SECRET']
2878
+ @id = ENV['PURECLOUD_CLIENT_ID']
2879
+ environment = "mypurecloud.com"
2880
+
2881
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2882
+
2883
+ PureCloud.configure do |config|
2884
+ config.access_token = @authToken
2885
+ end
2886
+
2887
+ api_instance = PureCloud::ExternalContactsApi.new
2888
+
2889
+ schema_id = "schema_id_example" # String | Schema ID
2890
+
2891
+ body = PureCloud::DataSchema.new # DataSchema | Data Schema
2892
+
2893
+
2894
+ begin
2895
+ #Update a schema
2896
+ result = api_instance.put_externalcontacts_organizations_schema(schema_id, body)
2897
+ p result
2898
+ rescue PureCloud::ApiError => e
2899
+ puts "Exception when calling ExternalContactsApi->put_externalcontacts_organizations_schema: #{e}"
2900
+ end
2901
+ ```
2902
+
2903
+ ### Parameters
2904
+
2905
+ Name | Type | Description | Notes
2906
+ ------------- | ------------- | ------------- | -------------
2907
+ **schema_id** | **String**| Schema ID | |
2908
+ **body** | [**DataSchema**](DataSchema.html)| Data Schema | |
2909
+ {: class="table table-striped"}
2910
+
2911
+
2912
+ ### Return type
2913
+
2914
+ [**DataSchema**](DataSchema.html)
2915
+
2916
+ ### HTTP request headers
2917
+
2918
+ - **Content-Type**: application/json
2919
+ - **Accept**: application/json
2920
+
2921
+
2922
+
2066
2923
  <a name="put_externalcontacts_relationship"></a>
2067
2924
 
2068
2925
  ## [**Relationship**](Relationship.html) put_externalcontacts_relationship(relationship_id, body)