purecloudplatformclientv2 75.1.0 → 79.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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +1 -1
- data/docs/AnalyticsApi.md +66 -2
- data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
- data/docs/AnalyticsConversationQueryResponse.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/ArchitectApi.md +345 -0
- data/docs/AuditApi.md +3 -1
- data/docs/AuditLogMessage.md +1 -1
- data/docs/AuthorizationApi.md +154 -9
- data/docs/AvailableTopic.md +3 -1
- data/docs/BuAgentScheduleActivity.md +18 -0
- data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
- data/docs/BuAgentScheduleSearchResponse.md +15 -0
- data/docs/BuAgentScheduleShift.md +18 -0
- data/docs/BuAgentSchedulesSearchResponse.md +15 -0
- data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
- data/docs/BuFullDayTimeOffMarker.md +18 -0
- data/docs/BuScheduleReference.md +15 -0
- data/docs/Call.md +1 -1
- data/docs/CallBasic.md +1 -1
- data/docs/CallMediaParticipant.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -1
- data/docs/CampaignProgress.md +2 -1
- data/docs/ChatMediaParticipant.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -1
- data/docs/ConversationsApi.md +71 -1
- data/docs/CopyAttachmentsRequest.md +14 -0
- data/docs/CreateManagementUnitApiRequest.md +3 -2
- data/docs/CreateManagementUnitSettingsRequest.md +1 -1
- data/docs/CreateWorkPlanShift.md +1 -1
- data/docs/DataTableExportJob.md +22 -0
- data/docs/DataTableImportJob.md +25 -0
- data/docs/DivsPermittedEntityListing.md +23 -0
- data/docs/EmailMediaParticipant.md +1 -1
- data/docs/EntityListing.md +17 -0
- data/docs/ErrorBody.md +2 -2
- data/docs/ErrorInfo.md +14 -0
- data/docs/Evaluation.md +1 -0
- data/docs/EvaluationQuestionGroupScore.md +4 -0
- data/docs/EvaluationScoringSet.md +1 -0
- data/docs/FacebookIntegrationRequest.md +2 -2
- data/docs/GDPRJourneyCustomer.md +2 -2
- data/docs/InboundDomain.md +2 -0
- data/docs/Library.md +4 -3
- data/docs/LicenseApi.md +66 -0
- data/docs/MailFromResult.md +15 -0
- data/docs/ManagementUnit.md +2 -2
- data/docs/ManagementUnitSettingsRequest.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -1
- data/docs/MessagingApi.md +0 -936
- data/docs/MessagingTemplate.md +15 -0
- data/docs/Organization.md +1 -0
- data/docs/QualityApi.md +5 -6
- data/docs/Record.md +15 -0
- data/docs/ReportingExportMetadataJobListing.md +22 -0
- data/docs/ReportingExportMetadataJobResponse.md +22 -0
- data/docs/Response.md +2 -0
- data/docs/RoutingApi.md +385 -0
- data/docs/RoutingSettings.md +13 -0
- data/docs/SCIMApi.md +397 -23
- data/docs/ScimUserExtensions.md +14 -0
- data/docs/ScimUserRole.md +13 -0
- data/docs/ScimUserRoutingLanguage.md +14 -0
- data/docs/ScimUserRoutingSkill.md +14 -0
- data/docs/ScimV2CreateUser.md +2 -1
- data/docs/ScimV2SchemaAttribute.md +24 -0
- data/docs/ScimV2SchemaDefinition.md +17 -0
- data/docs/ScimV2SchemaListResponse.md +17 -0
- data/docs/ScimV2User.md +2 -1
- data/docs/ShortTermForecast.md +2 -2
- data/docs/ShortTermForecastListItemResponse.md +2 -2
- data/docs/ShortTermForecastReference.md +2 -2
- data/docs/TimeOffRequestLookup.md +3 -3
- data/docs/TimeOffRequestResponse.md +3 -3
- data/docs/UserScheduleAdherence.md +1 -1
- data/docs/UsersApi.md +358 -10
- data/docs/ViewFilter.md +4 -10
- data/docs/WeekSchedule.md +1 -1
- data/docs/WeekScheduleListItemResponse.md +1 -1
- data/docs/WeekScheduleReference.md +1 -1
- data/docs/WorkPlanShift.md +1 -1
- data/docs/WorkforceManagementApi.md +40 -41
- data/lib/purecloudplatformclientv2.rb +27 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
- data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
- data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
- data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
- data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
- data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
- data/lib/purecloudplatformclientv2/models/call.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
- data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
- data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
- data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
- data/lib/purecloudplatformclientv2/models/library.rb +44 -2
- data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
- data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
- data/lib/purecloudplatformclientv2/models/record.rb +269 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
- data/lib/purecloudplatformclientv2/models/response.rb +67 -1
- data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
- data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
- data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +56 -2
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: MailFromResult
|
3
|
+
---
|
4
|
+
## PureCloud::MailFromResult
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **status** | **String** | The verification status. | [optional] |
|
11
|
+
| **records** | [**Array<Record>**](Record.html) | The list of DNS records that pertain that need to exist for verification. | [optional] |
|
12
|
+
| **mail_from_domain** | **String** | The custom MAIL FROM domain. | |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
data/docs/ManagementUnit.md
CHANGED
@@ -10,8 +10,8 @@ title: ManagementUnit
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
13
|
-
| **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
|
14
|
-
| **time_zone** | **String** | The time zone for the management unit in standard Olson format | [optional] |
|
13
|
+
| **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes. Moving to Business Unit | [optional] |
|
14
|
+
| **time_zone** | **String** | The time zone for the management unit in standard Olson format. Moving to Business Unit | [optional] |
|
15
15
|
| **settings** | [**ManagementUnitSettingsResponse**](ManagementUnitSettingsResponse.html) | The configuration settings for this management unit | [optional] |
|
16
16
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for this management unit. Deprecated, use settings.metadata | [optional] |
|
17
17
|
| **version** | **Integer** | The version of the underlying entity. Deprecated, use field from settings.metadata instead | [optional] |
|
@@ -8,7 +8,7 @@ title: ManagementUnitSettingsRequest
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
|
11
|
-
| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
|
11
|
+
| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit. Moving to Business Unit | [optional] |
|
12
12
|
| **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
|
13
13
|
| **scheduling** | [**SchedulingSettingsRequest**](SchedulingSettingsRequest.html) | Scheduling settings for this management unit | [optional] |
|
14
14
|
| **shift_trading** | [**ShiftTradeSettings**](ShiftTradeSettings.html) | Shift trade settings for this management unit | [optional] |
|
@@ -24,7 +24,7 @@ title: MessageMediaParticipant
|
|
24
24
|
| **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
|
26
26
|
| **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
|
27
|
-
| **error_info** | [**
|
27
|
+
| **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
data/docs/MessagingApi.md
CHANGED
@@ -8,682 +8,9 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
[**delete_messaging_integrations_facebook_integration_id**](MessagingApi.html#delete_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
12
|
-
[**delete_messaging_integrations_line_integration_id**](MessagingApi.html#delete_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
13
|
-
[**delete_messaging_integrations_twitter_integration_id**](MessagingApi.html#delete_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
14
|
-
[**get_messaging_integrations**](MessagingApi.html#get_messaging_integrations) | Get a list of Integrations
|
15
|
-
[**get_messaging_integrations_facebook**](MessagingApi.html#get_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
16
|
-
[**get_messaging_integrations_facebook_integration_id**](MessagingApi.html#get_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
17
|
-
[**get_messaging_integrations_line**](MessagingApi.html#get_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
18
|
-
[**get_messaging_integrations_line_integration_id**](MessagingApi.html#get_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
19
|
-
[**get_messaging_integrations_twitter**](MessagingApi.html#get_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
20
|
-
[**get_messaging_integrations_twitter_integration_id**](MessagingApi.html#get_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
21
11
|
[**get_messaging_sticker**](MessagingApi.html#get_messaging_sticker) | Get a list of Messaging Stickers
|
22
|
-
[**post_messaging_integrations_facebook**](MessagingApi.html#post_messaging_integrations_facebook) | Create a Facebook Integration
|
23
|
-
[**post_messaging_integrations_line**](MessagingApi.html#post_messaging_integrations_line) | Create a LINE messenger Integration
|
24
|
-
[**post_messaging_integrations_twitter**](MessagingApi.html#post_messaging_integrations_twitter) | Create a Twitter Integration
|
25
|
-
[**put_messaging_integrations_line_integration_id**](MessagingApi.html#put_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
26
12
|
{: class="table table-striped"}
|
27
13
|
|
28
|
-
<a name="delete_messaging_integrations_facebook_integration_id"></a>
|
29
|
-
|
30
|
-
## delete_messaging_integrations_facebook_integration_id(integration_id)
|
31
|
-
|
32
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
33
|
-
|
34
|
-
Delete a Facebook messaging integration
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
Wraps DELETE /api/v2/messaging/integrations/facebook/{integrationId}
|
39
|
-
|
40
|
-
Requires ANY permissions:
|
41
|
-
|
42
|
-
* messaging:integration:delete
|
43
|
-
|
44
|
-
|
45
|
-
### Example
|
46
|
-
```{"language":"ruby"}
|
47
|
-
# load the gem
|
48
|
-
require 'purecloudplatformclientv2'
|
49
|
-
# setup authorization
|
50
|
-
@secret = ENV['PURECLOUD_SECRET']
|
51
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
52
|
-
environment = "mypurecloud.com"
|
53
|
-
|
54
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
55
|
-
|
56
|
-
PureCloud.configure do |config|
|
57
|
-
config.access_token = @authToken
|
58
|
-
end
|
59
|
-
|
60
|
-
api_instance = PureCloud::MessagingApi.new
|
61
|
-
|
62
|
-
integration_id = "integration_id_example" # String | Integration ID
|
63
|
-
|
64
|
-
|
65
|
-
begin
|
66
|
-
#Delete a Facebook messaging integration
|
67
|
-
api_instance.delete_messaging_integrations_facebook_integration_id(integration_id)
|
68
|
-
rescue PureCloud::ApiError => e
|
69
|
-
puts "Exception when calling MessagingApi->delete_messaging_integrations_facebook_integration_id: #{e}"
|
70
|
-
end
|
71
|
-
```
|
72
|
-
|
73
|
-
### Parameters
|
74
|
-
|
75
|
-
Name | Type | Description | Notes
|
76
|
-
------------- | ------------- | ------------- | -------------
|
77
|
-
**integration_id** | **String**| Integration ID | |
|
78
|
-
{: class="table table-striped"}
|
79
|
-
|
80
|
-
|
81
|
-
### Return type
|
82
|
-
|
83
|
-
nil (empty response body)
|
84
|
-
|
85
|
-
### HTTP request headers
|
86
|
-
|
87
|
-
- **Content-Type**: application/json
|
88
|
-
- **Accept**: application/json
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
<a name="delete_messaging_integrations_line_integration_id"></a>
|
93
|
-
|
94
|
-
## delete_messaging_integrations_line_integration_id(integration_id)
|
95
|
-
|
96
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
97
|
-
|
98
|
-
Delete a LINE messenger integration
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
Wraps DELETE /api/v2/messaging/integrations/line/{integrationId}
|
103
|
-
|
104
|
-
Requires ANY permissions:
|
105
|
-
|
106
|
-
* messaging:integration:delete
|
107
|
-
|
108
|
-
|
109
|
-
### Example
|
110
|
-
```{"language":"ruby"}
|
111
|
-
# load the gem
|
112
|
-
require 'purecloudplatformclientv2'
|
113
|
-
# setup authorization
|
114
|
-
@secret = ENV['PURECLOUD_SECRET']
|
115
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
116
|
-
environment = "mypurecloud.com"
|
117
|
-
|
118
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
119
|
-
|
120
|
-
PureCloud.configure do |config|
|
121
|
-
config.access_token = @authToken
|
122
|
-
end
|
123
|
-
|
124
|
-
api_instance = PureCloud::MessagingApi.new
|
125
|
-
|
126
|
-
integration_id = "integration_id_example" # String | Integration ID
|
127
|
-
|
128
|
-
|
129
|
-
begin
|
130
|
-
#Delete a LINE messenger integration
|
131
|
-
api_instance.delete_messaging_integrations_line_integration_id(integration_id)
|
132
|
-
rescue PureCloud::ApiError => e
|
133
|
-
puts "Exception when calling MessagingApi->delete_messaging_integrations_line_integration_id: #{e}"
|
134
|
-
end
|
135
|
-
```
|
136
|
-
|
137
|
-
### Parameters
|
138
|
-
|
139
|
-
Name | Type | Description | Notes
|
140
|
-
------------- | ------------- | ------------- | -------------
|
141
|
-
**integration_id** | **String**| Integration ID | |
|
142
|
-
{: class="table table-striped"}
|
143
|
-
|
144
|
-
|
145
|
-
### Return type
|
146
|
-
|
147
|
-
nil (empty response body)
|
148
|
-
|
149
|
-
### HTTP request headers
|
150
|
-
|
151
|
-
- **Content-Type**: application/json
|
152
|
-
- **Accept**: application/json
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
<a name="delete_messaging_integrations_twitter_integration_id"></a>
|
157
|
-
|
158
|
-
## delete_messaging_integrations_twitter_integration_id(integration_id)
|
159
|
-
|
160
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
161
|
-
|
162
|
-
Delete a Twitter messaging integration
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
Wraps DELETE /api/v2/messaging/integrations/twitter/{integrationId}
|
167
|
-
|
168
|
-
Requires ANY permissions:
|
169
|
-
|
170
|
-
* messaging:integration:delete
|
171
|
-
|
172
|
-
|
173
|
-
### Example
|
174
|
-
```{"language":"ruby"}
|
175
|
-
# load the gem
|
176
|
-
require 'purecloudplatformclientv2'
|
177
|
-
# setup authorization
|
178
|
-
@secret = ENV['PURECLOUD_SECRET']
|
179
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
180
|
-
environment = "mypurecloud.com"
|
181
|
-
|
182
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
183
|
-
|
184
|
-
PureCloud.configure do |config|
|
185
|
-
config.access_token = @authToken
|
186
|
-
end
|
187
|
-
|
188
|
-
api_instance = PureCloud::MessagingApi.new
|
189
|
-
|
190
|
-
integration_id = "integration_id_example" # String | Integration ID
|
191
|
-
|
192
|
-
|
193
|
-
begin
|
194
|
-
#Delete a Twitter messaging integration
|
195
|
-
api_instance.delete_messaging_integrations_twitter_integration_id(integration_id)
|
196
|
-
rescue PureCloud::ApiError => e
|
197
|
-
puts "Exception when calling MessagingApi->delete_messaging_integrations_twitter_integration_id: #{e}"
|
198
|
-
end
|
199
|
-
```
|
200
|
-
|
201
|
-
### Parameters
|
202
|
-
|
203
|
-
Name | Type | Description | Notes
|
204
|
-
------------- | ------------- | ------------- | -------------
|
205
|
-
**integration_id** | **String**| Integration ID | |
|
206
|
-
{: class="table table-striped"}
|
207
|
-
|
208
|
-
|
209
|
-
### Return type
|
210
|
-
|
211
|
-
nil (empty response body)
|
212
|
-
|
213
|
-
### HTTP request headers
|
214
|
-
|
215
|
-
- **Content-Type**: application/json
|
216
|
-
- **Accept**: application/json
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
<a name="get_messaging_integrations"></a>
|
221
|
-
|
222
|
-
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_messaging_integrations(opts)
|
223
|
-
|
224
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
225
|
-
|
226
|
-
Get a list of Integrations
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
Wraps GET /api/v2/messaging/integrations
|
231
|
-
|
232
|
-
Requires ANY permissions:
|
233
|
-
|
234
|
-
* messaging:integration:view
|
235
|
-
|
236
|
-
|
237
|
-
### Example
|
238
|
-
```{"language":"ruby"}
|
239
|
-
# load the gem
|
240
|
-
require 'purecloudplatformclientv2'
|
241
|
-
# setup authorization
|
242
|
-
@secret = ENV['PURECLOUD_SECRET']
|
243
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
244
|
-
environment = "mypurecloud.com"
|
245
|
-
|
246
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
247
|
-
|
248
|
-
PureCloud.configure do |config|
|
249
|
-
config.access_token = @authToken
|
250
|
-
end
|
251
|
-
|
252
|
-
api_instance = PureCloud::MessagingApi.new
|
253
|
-
|
254
|
-
opts = {
|
255
|
-
page_size: 25, # Integer | Page size
|
256
|
-
page_number: 1 # Integer | Page number
|
257
|
-
}
|
258
|
-
|
259
|
-
begin
|
260
|
-
#Get a list of Integrations
|
261
|
-
result = api_instance.get_messaging_integrations(opts)
|
262
|
-
p result
|
263
|
-
rescue PureCloud::ApiError => e
|
264
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations: #{e}"
|
265
|
-
end
|
266
|
-
```
|
267
|
-
|
268
|
-
### Parameters
|
269
|
-
|
270
|
-
Name | Type | Description | Notes
|
271
|
-
------------- | ------------- | ------------- | -------------
|
272
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
273
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
274
|
-
{: class="table table-striped"}
|
275
|
-
|
276
|
-
|
277
|
-
### Return type
|
278
|
-
|
279
|
-
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
280
|
-
|
281
|
-
### HTTP request headers
|
282
|
-
|
283
|
-
- **Content-Type**: application/json
|
284
|
-
- **Accept**: application/json
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
<a name="get_messaging_integrations_facebook"></a>
|
289
|
-
|
290
|
-
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_messaging_integrations_facebook(opts)
|
291
|
-
|
292
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
293
|
-
|
294
|
-
Get a list of Facebook Integrations
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
Wraps GET /api/v2/messaging/integrations/facebook
|
299
|
-
|
300
|
-
Requires ANY permissions:
|
301
|
-
|
302
|
-
* messaging:integration:view
|
303
|
-
|
304
|
-
|
305
|
-
### Example
|
306
|
-
```{"language":"ruby"}
|
307
|
-
# load the gem
|
308
|
-
require 'purecloudplatformclientv2'
|
309
|
-
# setup authorization
|
310
|
-
@secret = ENV['PURECLOUD_SECRET']
|
311
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
312
|
-
environment = "mypurecloud.com"
|
313
|
-
|
314
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
315
|
-
|
316
|
-
PureCloud.configure do |config|
|
317
|
-
config.access_token = @authToken
|
318
|
-
end
|
319
|
-
|
320
|
-
api_instance = PureCloud::MessagingApi.new
|
321
|
-
|
322
|
-
opts = {
|
323
|
-
page_size: 25, # Integer | Page size
|
324
|
-
page_number: 1 # Integer | Page number
|
325
|
-
}
|
326
|
-
|
327
|
-
begin
|
328
|
-
#Get a list of Facebook Integrations
|
329
|
-
result = api_instance.get_messaging_integrations_facebook(opts)
|
330
|
-
p result
|
331
|
-
rescue PureCloud::ApiError => e
|
332
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_facebook: #{e}"
|
333
|
-
end
|
334
|
-
```
|
335
|
-
|
336
|
-
### Parameters
|
337
|
-
|
338
|
-
Name | Type | Description | Notes
|
339
|
-
------------- | ------------- | ------------- | -------------
|
340
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
341
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
342
|
-
{: class="table table-striped"}
|
343
|
-
|
344
|
-
|
345
|
-
### Return type
|
346
|
-
|
347
|
-
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
348
|
-
|
349
|
-
### HTTP request headers
|
350
|
-
|
351
|
-
- **Content-Type**: application/json
|
352
|
-
- **Accept**: application/json
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
<a name="get_messaging_integrations_facebook_integration_id"></a>
|
357
|
-
|
358
|
-
## [**FacebookIntegration**](FacebookIntegration.html) get_messaging_integrations_facebook_integration_id(integration_id)
|
359
|
-
|
360
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
361
|
-
|
362
|
-
Get a Facebook messaging integration
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
Wraps GET /api/v2/messaging/integrations/facebook/{integrationId}
|
367
|
-
|
368
|
-
Requires ANY permissions:
|
369
|
-
|
370
|
-
* messaging:integration:view
|
371
|
-
|
372
|
-
|
373
|
-
### Example
|
374
|
-
```{"language":"ruby"}
|
375
|
-
# load the gem
|
376
|
-
require 'purecloudplatformclientv2'
|
377
|
-
# setup authorization
|
378
|
-
@secret = ENV['PURECLOUD_SECRET']
|
379
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
380
|
-
environment = "mypurecloud.com"
|
381
|
-
|
382
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
383
|
-
|
384
|
-
PureCloud.configure do |config|
|
385
|
-
config.access_token = @authToken
|
386
|
-
end
|
387
|
-
|
388
|
-
api_instance = PureCloud::MessagingApi.new
|
389
|
-
|
390
|
-
integration_id = "integration_id_example" # String | Integration ID
|
391
|
-
|
392
|
-
|
393
|
-
begin
|
394
|
-
#Get a Facebook messaging integration
|
395
|
-
result = api_instance.get_messaging_integrations_facebook_integration_id(integration_id)
|
396
|
-
p result
|
397
|
-
rescue PureCloud::ApiError => e
|
398
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_facebook_integration_id: #{e}"
|
399
|
-
end
|
400
|
-
```
|
401
|
-
|
402
|
-
### Parameters
|
403
|
-
|
404
|
-
Name | Type | Description | Notes
|
405
|
-
------------- | ------------- | ------------- | -------------
|
406
|
-
**integration_id** | **String**| Integration ID | |
|
407
|
-
{: class="table table-striped"}
|
408
|
-
|
409
|
-
|
410
|
-
### Return type
|
411
|
-
|
412
|
-
[**FacebookIntegration**](FacebookIntegration.html)
|
413
|
-
|
414
|
-
### HTTP request headers
|
415
|
-
|
416
|
-
- **Content-Type**: application/json
|
417
|
-
- **Accept**: application/json
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
<a name="get_messaging_integrations_line"></a>
|
422
|
-
|
423
|
-
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_messaging_integrations_line(opts)
|
424
|
-
|
425
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
426
|
-
|
427
|
-
Get a list of LINE messenger Integrations
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
Wraps GET /api/v2/messaging/integrations/line
|
432
|
-
|
433
|
-
Requires ANY permissions:
|
434
|
-
|
435
|
-
* messaging:integration:view
|
436
|
-
|
437
|
-
|
438
|
-
### Example
|
439
|
-
```{"language":"ruby"}
|
440
|
-
# load the gem
|
441
|
-
require 'purecloudplatformclientv2'
|
442
|
-
# setup authorization
|
443
|
-
@secret = ENV['PURECLOUD_SECRET']
|
444
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
445
|
-
environment = "mypurecloud.com"
|
446
|
-
|
447
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
448
|
-
|
449
|
-
PureCloud.configure do |config|
|
450
|
-
config.access_token = @authToken
|
451
|
-
end
|
452
|
-
|
453
|
-
api_instance = PureCloud::MessagingApi.new
|
454
|
-
|
455
|
-
opts = {
|
456
|
-
page_size: 25, # Integer | Page size
|
457
|
-
page_number: 1 # Integer | Page number
|
458
|
-
}
|
459
|
-
|
460
|
-
begin
|
461
|
-
#Get a list of LINE messenger Integrations
|
462
|
-
result = api_instance.get_messaging_integrations_line(opts)
|
463
|
-
p result
|
464
|
-
rescue PureCloud::ApiError => e
|
465
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_line: #{e}"
|
466
|
-
end
|
467
|
-
```
|
468
|
-
|
469
|
-
### Parameters
|
470
|
-
|
471
|
-
Name | Type | Description | Notes
|
472
|
-
------------- | ------------- | ------------- | -------------
|
473
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
474
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
475
|
-
{: class="table table-striped"}
|
476
|
-
|
477
|
-
|
478
|
-
### Return type
|
479
|
-
|
480
|
-
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
481
|
-
|
482
|
-
### HTTP request headers
|
483
|
-
|
484
|
-
- **Content-Type**: application/json
|
485
|
-
- **Accept**: application/json
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
<a name="get_messaging_integrations_line_integration_id"></a>
|
490
|
-
|
491
|
-
## [**LineIntegration**](LineIntegration.html) get_messaging_integrations_line_integration_id(integration_id)
|
492
|
-
|
493
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
494
|
-
|
495
|
-
Get a LINE messenger integration
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
Wraps GET /api/v2/messaging/integrations/line/{integrationId}
|
500
|
-
|
501
|
-
Requires ANY permissions:
|
502
|
-
|
503
|
-
* messaging:integration:view
|
504
|
-
|
505
|
-
|
506
|
-
### Example
|
507
|
-
```{"language":"ruby"}
|
508
|
-
# load the gem
|
509
|
-
require 'purecloudplatformclientv2'
|
510
|
-
# setup authorization
|
511
|
-
@secret = ENV['PURECLOUD_SECRET']
|
512
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
513
|
-
environment = "mypurecloud.com"
|
514
|
-
|
515
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
516
|
-
|
517
|
-
PureCloud.configure do |config|
|
518
|
-
config.access_token = @authToken
|
519
|
-
end
|
520
|
-
|
521
|
-
api_instance = PureCloud::MessagingApi.new
|
522
|
-
|
523
|
-
integration_id = "integration_id_example" # String | Integration ID
|
524
|
-
|
525
|
-
|
526
|
-
begin
|
527
|
-
#Get a LINE messenger integration
|
528
|
-
result = api_instance.get_messaging_integrations_line_integration_id(integration_id)
|
529
|
-
p result
|
530
|
-
rescue PureCloud::ApiError => e
|
531
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_line_integration_id: #{e}"
|
532
|
-
end
|
533
|
-
```
|
534
|
-
|
535
|
-
### Parameters
|
536
|
-
|
537
|
-
Name | Type | Description | Notes
|
538
|
-
------------- | ------------- | ------------- | -------------
|
539
|
-
**integration_id** | **String**| Integration ID | |
|
540
|
-
{: class="table table-striped"}
|
541
|
-
|
542
|
-
|
543
|
-
### Return type
|
544
|
-
|
545
|
-
[**LineIntegration**](LineIntegration.html)
|
546
|
-
|
547
|
-
### HTTP request headers
|
548
|
-
|
549
|
-
- **Content-Type**: application/json
|
550
|
-
- **Accept**: application/json
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
<a name="get_messaging_integrations_twitter"></a>
|
555
|
-
|
556
|
-
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_messaging_integrations_twitter(opts)
|
557
|
-
|
558
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
559
|
-
|
560
|
-
Get a list of Twitter Integrations
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
Wraps GET /api/v2/messaging/integrations/twitter
|
565
|
-
|
566
|
-
Requires ANY permissions:
|
567
|
-
|
568
|
-
* messaging:integration:view
|
569
|
-
|
570
|
-
|
571
|
-
### Example
|
572
|
-
```{"language":"ruby"}
|
573
|
-
# load the gem
|
574
|
-
require 'purecloudplatformclientv2'
|
575
|
-
# setup authorization
|
576
|
-
@secret = ENV['PURECLOUD_SECRET']
|
577
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
578
|
-
environment = "mypurecloud.com"
|
579
|
-
|
580
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
581
|
-
|
582
|
-
PureCloud.configure do |config|
|
583
|
-
config.access_token = @authToken
|
584
|
-
end
|
585
|
-
|
586
|
-
api_instance = PureCloud::MessagingApi.new
|
587
|
-
|
588
|
-
opts = {
|
589
|
-
page_size: 25, # Integer | Page size
|
590
|
-
page_number: 1 # Integer | Page number
|
591
|
-
}
|
592
|
-
|
593
|
-
begin
|
594
|
-
#Get a list of Twitter Integrations
|
595
|
-
result = api_instance.get_messaging_integrations_twitter(opts)
|
596
|
-
p result
|
597
|
-
rescue PureCloud::ApiError => e
|
598
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_twitter: #{e}"
|
599
|
-
end
|
600
|
-
```
|
601
|
-
|
602
|
-
### Parameters
|
603
|
-
|
604
|
-
Name | Type | Description | Notes
|
605
|
-
------------- | ------------- | ------------- | -------------
|
606
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
607
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
608
|
-
{: class="table table-striped"}
|
609
|
-
|
610
|
-
|
611
|
-
### Return type
|
612
|
-
|
613
|
-
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
614
|
-
|
615
|
-
### HTTP request headers
|
616
|
-
|
617
|
-
- **Content-Type**: application/json
|
618
|
-
- **Accept**: application/json
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
<a name="get_messaging_integrations_twitter_integration_id"></a>
|
623
|
-
|
624
|
-
## [**TwitterIntegration**](TwitterIntegration.html) get_messaging_integrations_twitter_integration_id(integration_id)
|
625
|
-
|
626
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
627
|
-
|
628
|
-
Get a Twitter messaging integration
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
Wraps GET /api/v2/messaging/integrations/twitter/{integrationId}
|
633
|
-
|
634
|
-
Requires ANY permissions:
|
635
|
-
|
636
|
-
* messaging:integration:view
|
637
|
-
|
638
|
-
|
639
|
-
### Example
|
640
|
-
```{"language":"ruby"}
|
641
|
-
# load the gem
|
642
|
-
require 'purecloudplatformclientv2'
|
643
|
-
# setup authorization
|
644
|
-
@secret = ENV['PURECLOUD_SECRET']
|
645
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
646
|
-
environment = "mypurecloud.com"
|
647
|
-
|
648
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
649
|
-
|
650
|
-
PureCloud.configure do |config|
|
651
|
-
config.access_token = @authToken
|
652
|
-
end
|
653
|
-
|
654
|
-
api_instance = PureCloud::MessagingApi.new
|
655
|
-
|
656
|
-
integration_id = "integration_id_example" # String | Integration ID
|
657
|
-
|
658
|
-
|
659
|
-
begin
|
660
|
-
#Get a Twitter messaging integration
|
661
|
-
result = api_instance.get_messaging_integrations_twitter_integration_id(integration_id)
|
662
|
-
p result
|
663
|
-
rescue PureCloud::ApiError => e
|
664
|
-
puts "Exception when calling MessagingApi->get_messaging_integrations_twitter_integration_id: #{e}"
|
665
|
-
end
|
666
|
-
```
|
667
|
-
|
668
|
-
### Parameters
|
669
|
-
|
670
|
-
Name | Type | Description | Notes
|
671
|
-
------------- | ------------- | ------------- | -------------
|
672
|
-
**integration_id** | **String**| Integration ID | |
|
673
|
-
{: class="table table-striped"}
|
674
|
-
|
675
|
-
|
676
|
-
### Return type
|
677
|
-
|
678
|
-
[**TwitterIntegration**](TwitterIntegration.html)
|
679
|
-
|
680
|
-
### HTTP request headers
|
681
|
-
|
682
|
-
- **Content-Type**: application/json
|
683
|
-
- **Accept**: application/json
|
684
|
-
|
685
|
-
|
686
|
-
|
687
14
|
<a name="get_messaging_sticker"></a>
|
688
15
|
|
689
16
|
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_messaging_sticker(messenger_type, opts)
|
@@ -755,266 +82,3 @@ Name | Type | Description | Notes
|
|
755
82
|
|
756
83
|
|
757
84
|
|
758
|
-
<a name="post_messaging_integrations_facebook"></a>
|
759
|
-
|
760
|
-
## [**FacebookIntegration**](FacebookIntegration.html) post_messaging_integrations_facebook(body)
|
761
|
-
|
762
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
763
|
-
|
764
|
-
Create a Facebook Integration
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
Wraps POST /api/v2/messaging/integrations/facebook
|
769
|
-
|
770
|
-
Requires ANY permissions:
|
771
|
-
|
772
|
-
* messaging:integration:add
|
773
|
-
|
774
|
-
|
775
|
-
### Example
|
776
|
-
```{"language":"ruby"}
|
777
|
-
# load the gem
|
778
|
-
require 'purecloudplatformclientv2'
|
779
|
-
# setup authorization
|
780
|
-
@secret = ENV['PURECLOUD_SECRET']
|
781
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
782
|
-
environment = "mypurecloud.com"
|
783
|
-
|
784
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
785
|
-
|
786
|
-
PureCloud.configure do |config|
|
787
|
-
config.access_token = @authToken
|
788
|
-
end
|
789
|
-
|
790
|
-
api_instance = PureCloud::MessagingApi.new
|
791
|
-
|
792
|
-
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
793
|
-
|
794
|
-
|
795
|
-
begin
|
796
|
-
#Create a Facebook Integration
|
797
|
-
result = api_instance.post_messaging_integrations_facebook(body)
|
798
|
-
p result
|
799
|
-
rescue PureCloud::ApiError => e
|
800
|
-
puts "Exception when calling MessagingApi->post_messaging_integrations_facebook: #{e}"
|
801
|
-
end
|
802
|
-
```
|
803
|
-
|
804
|
-
### Parameters
|
805
|
-
|
806
|
-
Name | Type | Description | Notes
|
807
|
-
------------- | ------------- | ------------- | -------------
|
808
|
-
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
809
|
-
{: class="table table-striped"}
|
810
|
-
|
811
|
-
|
812
|
-
### Return type
|
813
|
-
|
814
|
-
[**FacebookIntegration**](FacebookIntegration.html)
|
815
|
-
|
816
|
-
### HTTP request headers
|
817
|
-
|
818
|
-
- **Content-Type**: application/json
|
819
|
-
- **Accept**: application/json
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
<a name="post_messaging_integrations_line"></a>
|
824
|
-
|
825
|
-
## [**LineIntegration**](LineIntegration.html) post_messaging_integrations_line(body)
|
826
|
-
|
827
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
828
|
-
|
829
|
-
Create a LINE messenger Integration
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
Wraps POST /api/v2/messaging/integrations/line
|
834
|
-
|
835
|
-
Requires ANY permissions:
|
836
|
-
|
837
|
-
* messaging:integration:add
|
838
|
-
|
839
|
-
|
840
|
-
### Example
|
841
|
-
```{"language":"ruby"}
|
842
|
-
# load the gem
|
843
|
-
require 'purecloudplatformclientv2'
|
844
|
-
# setup authorization
|
845
|
-
@secret = ENV['PURECLOUD_SECRET']
|
846
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
847
|
-
environment = "mypurecloud.com"
|
848
|
-
|
849
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
850
|
-
|
851
|
-
PureCloud.configure do |config|
|
852
|
-
config.access_token = @authToken
|
853
|
-
end
|
854
|
-
|
855
|
-
api_instance = PureCloud::MessagingApi.new
|
856
|
-
|
857
|
-
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
858
|
-
|
859
|
-
|
860
|
-
begin
|
861
|
-
#Create a LINE messenger Integration
|
862
|
-
result = api_instance.post_messaging_integrations_line(body)
|
863
|
-
p result
|
864
|
-
rescue PureCloud::ApiError => e
|
865
|
-
puts "Exception when calling MessagingApi->post_messaging_integrations_line: #{e}"
|
866
|
-
end
|
867
|
-
```
|
868
|
-
|
869
|
-
### Parameters
|
870
|
-
|
871
|
-
Name | Type | Description | Notes
|
872
|
-
------------- | ------------- | ------------- | -------------
|
873
|
-
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
874
|
-
{: class="table table-striped"}
|
875
|
-
|
876
|
-
|
877
|
-
### Return type
|
878
|
-
|
879
|
-
[**LineIntegration**](LineIntegration.html)
|
880
|
-
|
881
|
-
### HTTP request headers
|
882
|
-
|
883
|
-
- **Content-Type**: application/json
|
884
|
-
- **Accept**: application/json
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
<a name="post_messaging_integrations_twitter"></a>
|
889
|
-
|
890
|
-
## [**TwitterIntegration**](TwitterIntegration.html) post_messaging_integrations_twitter(body)
|
891
|
-
|
892
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
893
|
-
|
894
|
-
Create a Twitter Integration
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
Wraps POST /api/v2/messaging/integrations/twitter
|
899
|
-
|
900
|
-
Requires ANY permissions:
|
901
|
-
|
902
|
-
* messaging:integration:add
|
903
|
-
|
904
|
-
|
905
|
-
### Example
|
906
|
-
```{"language":"ruby"}
|
907
|
-
# load the gem
|
908
|
-
require 'purecloudplatformclientv2'
|
909
|
-
# setup authorization
|
910
|
-
@secret = ENV['PURECLOUD_SECRET']
|
911
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
912
|
-
environment = "mypurecloud.com"
|
913
|
-
|
914
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
915
|
-
|
916
|
-
PureCloud.configure do |config|
|
917
|
-
config.access_token = @authToken
|
918
|
-
end
|
919
|
-
|
920
|
-
api_instance = PureCloud::MessagingApi.new
|
921
|
-
|
922
|
-
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
923
|
-
|
924
|
-
|
925
|
-
begin
|
926
|
-
#Create a Twitter Integration
|
927
|
-
result = api_instance.post_messaging_integrations_twitter(body)
|
928
|
-
p result
|
929
|
-
rescue PureCloud::ApiError => e
|
930
|
-
puts "Exception when calling MessagingApi->post_messaging_integrations_twitter: #{e}"
|
931
|
-
end
|
932
|
-
```
|
933
|
-
|
934
|
-
### Parameters
|
935
|
-
|
936
|
-
Name | Type | Description | Notes
|
937
|
-
------------- | ------------- | ------------- | -------------
|
938
|
-
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
939
|
-
{: class="table table-striped"}
|
940
|
-
|
941
|
-
|
942
|
-
### Return type
|
943
|
-
|
944
|
-
[**TwitterIntegration**](TwitterIntegration.html)
|
945
|
-
|
946
|
-
### HTTP request headers
|
947
|
-
|
948
|
-
- **Content-Type**: application/json
|
949
|
-
- **Accept**: application/json
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
<a name="put_messaging_integrations_line_integration_id"></a>
|
954
|
-
|
955
|
-
## [**LineIntegration**](LineIntegration.html) put_messaging_integrations_line_integration_id(integration_id, body)
|
956
|
-
|
957
|
-
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
958
|
-
|
959
|
-
Update a LINE messenger integration
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
Wraps PUT /api/v2/messaging/integrations/line/{integrationId}
|
964
|
-
|
965
|
-
Requires ANY permissions:
|
966
|
-
|
967
|
-
* messaging:integration:edit
|
968
|
-
|
969
|
-
|
970
|
-
### Example
|
971
|
-
```{"language":"ruby"}
|
972
|
-
# load the gem
|
973
|
-
require 'purecloudplatformclientv2'
|
974
|
-
# setup authorization
|
975
|
-
@secret = ENV['PURECLOUD_SECRET']
|
976
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
977
|
-
environment = "mypurecloud.com"
|
978
|
-
|
979
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
980
|
-
|
981
|
-
PureCloud.configure do |config|
|
982
|
-
config.access_token = @authToken
|
983
|
-
end
|
984
|
-
|
985
|
-
api_instance = PureCloud::MessagingApi.new
|
986
|
-
|
987
|
-
integration_id = "integration_id_example" # String | Integration ID
|
988
|
-
|
989
|
-
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
990
|
-
|
991
|
-
|
992
|
-
begin
|
993
|
-
#Update a LINE messenger integration
|
994
|
-
result = api_instance.put_messaging_integrations_line_integration_id(integration_id, body)
|
995
|
-
p result
|
996
|
-
rescue PureCloud::ApiError => e
|
997
|
-
puts "Exception when calling MessagingApi->put_messaging_integrations_line_integration_id: #{e}"
|
998
|
-
end
|
999
|
-
```
|
1000
|
-
|
1001
|
-
### Parameters
|
1002
|
-
|
1003
|
-
Name | Type | Description | Notes
|
1004
|
-
------------- | ------------- | ------------- | -------------
|
1005
|
-
**integration_id** | **String**| Integration ID | |
|
1006
|
-
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
1007
|
-
{: class="table table-striped"}
|
1008
|
-
|
1009
|
-
|
1010
|
-
### Return type
|
1011
|
-
|
1012
|
-
[**LineIntegration**](LineIntegration.html)
|
1013
|
-
|
1014
|
-
### HTTP request headers
|
1015
|
-
|
1016
|
-
- **Content-Type**: application/json
|
1017
|
-
- **Accept**: application/json
|
1018
|
-
|
1019
|
-
|
1020
|
-
|