purecloud 0.63.1 → 0.64.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/ADFS.html.md +1 -1
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AnalyticsConversationSegment.html.md +3 -3
- data/doc_out/AnalyticsSession.html.md +2 -2
- data/doc_out/AttributesApi.html.md +29 -29
- data/doc_out/AuditMessage.html.md +1 -1
- data/doc_out/Call.html.md +4 -4
- data/doc_out/CallForwarding.html.md +1 -1
- data/doc_out/CallMediaParticipant.html.md +6 -6
- data/doc_out/Callback.html.md +2 -2
- data/doc_out/CallbackMediaParticipant.html.md +4 -4
- data/doc_out/Campaign.html.md +1 -1
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignRule.html.md +2 -2
- data/doc_out/CampaignRuleActionEntities.html.md +1 -1
- data/doc_out/CampaignSequence.html.md +1 -1
- data/doc_out/CertificateDetails.html.md +3 -3
- data/doc_out/ChatMediaParticipant.html.md +3 -3
- data/doc_out/CobrowseMediaParticipant.html.md +3 -3
- data/doc_out/Condition.html.md +1 -1
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentQueryRequest.html.md +1 -1
- data/doc_out/ContentSortItem.html.md +1 -1
- data/doc_out/ConversationChat.html.md +1 -1
- data/doc_out/ConversationsApi.html.md +58 -58
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/Document.html.md +1 -1
- data/doc_out/DocumentAudit.html.md +1 -1
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DomainCapabilities.html.md +4 -4
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +3 -3
- data/doc_out/DomainNetworkAddress.html.md +1 -1
- data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
- data/doc_out/DomainNetworkRoute.html.md +1 -1
- data/doc_out/DomainOrganizationRole.html.md +3 -3
- data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
- data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
- data/doc_out/DomainPermission.html.md +1 -1
- data/doc_out/DomainPermissionPolicy.html.md +1 -1
- data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
- data/doc_out/Edge.html.md +2 -2
- data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeLogsJobRequest.html.md +1 -1
- data/doc_out/Email.html.md +1 -1
- data/doc_out/EmailMediaParticipant.html.md +3 -3
- data/doc_out/Endpoint.html.md +1 -1
- data/doc_out/Evaluation.html.md +4 -4
- data/doc_out/EvaluationForm.html.md +1 -1
- data/doc_out/EvaluationScoringSet.html.md +1 -1
- data/doc_out/FaxDocument.html.md +1 -1
- data/doc_out/FieldList.html.md +3 -3
- data/doc_out/Geolocation.html.md +1 -1
- data/doc_out/GeolocationSettings.html.md +1 -1
- data/doc_out/GreetingsApi.html.md +50 -50
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupUpdate.html.md +1 -1
- data/doc_out/GroupsApi.html.md +68 -68
- data/doc_out/HeartBeatRule.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +22 -22
- data/doc_out/InboundDomain.html.md +1 -1
- data/doc_out/InitiateScreenRecording.html.md +1 -1
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsRule.html.md +2 -2
- data/doc_out/JsonNode.html.md +20 -20
- data/doc_out/LineStatus.html.md +1 -1
- data/doc_out/LocationDefinition.html.md +1 -1
- data/doc_out/MediaParticipantRequest.html.md +5 -5
- data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
- data/doc_out/OAuthProvider.html.md +1 -1
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrgMediaUtilization.html.md +1 -1
- data/doc_out/Organization.html.md +1 -1
- data/doc_out/OrganizationPresence.html.md +2 -2
- data/doc_out/OutOfOffice.html.md +1 -1
- data/doc_out/OutboundRoute.html.md +2 -2
- data/doc_out/Parameter.html.md +1 -1
- data/doc_out/Participant.html.md +2 -2
- data/doc_out/PhoneCapabilities.html.md +5 -5
- data/doc_out/PhoneNumberStatus.html.md +1 -1
- data/doc_out/Policy.html.md +1 -1
- data/doc_out/PolicyActions.html.md +3 -3
- data/doc_out/PolicyCreate.html.md +1 -1
- data/doc_out/PresenceApi.html.md +33 -33
- data/doc_out/PureCloud.html.md +1 -1
- data/doc_out/QueryRequest.html.md +1 -1
- data/doc_out/QuestionGroup.html.md +4 -4
- data/doc_out/QuestionGroupScore.html.md +1 -1
- data/doc_out/QuestionScore.html.md +2 -2
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/RecordingApi.html.md +70 -70
- data/doc_out/ReportSchedule.html.md +1 -1
- data/doc_out/ResourcePermissionPolicy.html.md +1 -1
- data/doc_out/RoutingStatusRule.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/Screenshare.html.md +1 -1
- data/doc_out/ScriptsApi.html.md +72 -72
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/SortItem.html.md +1 -1
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TimeAllowed.html.md +1 -1
- data/doc_out/TimeOffRequest.html.md +2 -2
- data/doc_out/TimeOffRequestPatch.html.md +1 -1
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +1 -1
- data/doc_out/TrunkBase.html.md +1 -1
- data/doc_out/UnreadStatus.html.md +1 -1
- data/doc_out/UserPresence.html.md +1 -1
- data/doc_out/UserPresenceRule.html.md +2 -2
- data/doc_out/UserQueue.html.md +1 -1
- data/doc_out/UserRecording.html.md +1 -1
- data/doc_out/UserRecordingsApi.html.md +47 -47
- data/doc_out/UserScheduleAdherence.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +1 -1
- data/doc_out/Video.html.md +3 -3
- data/doc_out/VoicemailGroupPolicy.html.md +2 -2
- data/doc_out/VoicemailMessage.html.md +2 -2
- data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
- data/doc_out/VoicemailUserPolicy.html.md +1 -1
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/Wrapup.html.md +1 -1
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud/api/attributes_api.rb +39 -39
- data/lib/purecloud/api/conversations_api.rb +58 -58
- data/lib/purecloud/api/greetings_api.rb +67 -67
- data/lib/purecloud/api/groups_api.rb +104 -104
- data/lib/purecloud/api/identity_provider_api.rb +33 -33
- data/lib/purecloud/api/presence_api.rb +46 -46
- data/lib/purecloud/api/recording_api.rb +76 -76
- data/lib/purecloud/api/scripts_api.rb +87 -87
- data/lib/purecloud/api/user_recordings_api.rb +64 -64
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +2 -0
- data/lib/purecloud/models/aggregation_query.rb +2 -0
- data/lib/purecloud/models/analytics_conversation_segment.rb +6 -0
- data/lib/purecloud/models/analytics_session.rb +4 -0
- data/lib/purecloud/models/audit_message.rb +2 -0
- data/lib/purecloud/models/call.rb +8 -0
- data/lib/purecloud/models/call_forwarding.rb +2 -0
- data/lib/purecloud/models/call_media_participant.rb +12 -0
- data/lib/purecloud/models/callback.rb +4 -0
- data/lib/purecloud/models/callback_media_participant.rb +8 -0
- data/lib/purecloud/models/campaign.rb +2 -0
- data/lib/purecloud/models/campaign_interaction.rb +2 -0
- data/lib/purecloud/models/campaign_rule.rb +4 -0
- data/lib/purecloud/models/campaign_rule_action_entities.rb +2 -0
- data/lib/purecloud/models/campaign_sequence.rb +2 -0
- data/lib/purecloud/models/certificate_details.rb +6 -0
- data/lib/purecloud/models/chat_media_participant.rb +6 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +6 -0
- data/lib/purecloud/models/condition.rb +2 -0
- data/lib/purecloud/models/contact_sort.rb +2 -0
- data/lib/purecloud/models/content_query_request.rb +2 -0
- data/lib/purecloud/models/content_sort_item.rb +2 -0
- data/lib/purecloud/models/conversation_chat.rb +2 -0
- data/lib/purecloud/models/customer_interaction_center.rb +2 -0
- data/lib/purecloud/models/dialer_contact.rb +2 -0
- data/lib/purecloud/models/document.rb +2 -0
- data/lib/purecloud/models/document_audit.rb +2 -0
- data/lib/purecloud/models/document_update.rb +2 -0
- data/lib/purecloud/models/domain_capabilities.rb +8 -0
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +4 -0
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +4 -0
- data/lib/purecloud/models/domain_logical_interface.rb +6 -0
- data/lib/purecloud/models/domain_network_address.rb +2 -0
- data/lib/purecloud/models/domain_network_command_response.rb +2 -0
- data/lib/purecloud/models/domain_network_route.rb +2 -0
- data/lib/purecloud/models/domain_organization_role.rb +17 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +17 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +17 -11
- data/lib/purecloud/models/domain_permission.rb +2 -0
- data/lib/purecloud/models/domain_permission_policy.rb +2 -0
- data/lib/purecloud/models/domain_physical_capabilities.rb +4 -0
- data/lib/purecloud/models/edge.rb +4 -0
- data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
- data/lib/purecloud/models/edge_group.rb +2 -0
- data/lib/purecloud/models/edge_logs_job_request.rb +2 -0
- data/lib/purecloud/models/email.rb +2 -0
- data/lib/purecloud/models/email_media_participant.rb +6 -0
- data/lib/purecloud/models/endpoint.rb +2 -0
- data/lib/purecloud/models/evaluation.rb +8 -0
- data/lib/purecloud/models/evaluation_form.rb +2 -0
- data/lib/purecloud/models/evaluation_scoring_set.rb +2 -0
- data/lib/purecloud/models/fax_document.rb +2 -0
- data/lib/purecloud/models/field_list.rb +6 -0
- data/lib/purecloud/models/geolocation.rb +2 -0
- data/lib/purecloud/models/geolocation_settings.rb +2 -0
- data/lib/purecloud/models/group.rb +2 -0
- data/lib/purecloud/models/group_update.rb +2 -0
- data/lib/purecloud/models/heart_beat_rule.rb +4 -0
- data/lib/purecloud/models/inbound_domain.rb +2 -0
- data/lib/purecloud/models/initiate_screen_recording.rb +2 -0
- data/lib/purecloud/models/interaction_stats_alert.rb +2 -0
- data/lib/purecloud/models/interaction_stats_rule.rb +4 -0
- data/lib/purecloud/models/json_node.rb +64 -24
- data/lib/purecloud/models/line_status.rb +2 -0
- data/lib/purecloud/models/location_definition.rb +2 -0
- data/lib/purecloud/models/media_participant_request.rb +10 -0
- data/lib/purecloud/models/metered_evaluation_assignment.rb +2 -0
- data/lib/purecloud/models/o_auth_provider.rb +2 -0
- data/lib/purecloud/models/okta.rb +2 -0
- data/lib/purecloud/models/one_login.rb +2 -0
- data/lib/purecloud/models/org_media_utilization.rb +2 -0
- data/lib/purecloud/models/organization.rb +2 -0
- data/lib/purecloud/models/organization_presence.rb +4 -0
- data/lib/purecloud/models/out_of_office.rb +2 -0
- data/lib/purecloud/models/outbound_route.rb +4 -0
- data/lib/purecloud/models/parameter.rb +2 -0
- data/lib/purecloud/models/participant.rb +4 -0
- data/lib/purecloud/models/phone_capabilities.rb +10 -0
- data/lib/purecloud/models/phone_number_status.rb +2 -0
- data/lib/purecloud/models/policy.rb +2 -0
- data/lib/purecloud/models/policy_actions.rb +6 -0
- data/lib/purecloud/models/policy_create.rb +2 -0
- data/lib/purecloud/models/pure_cloud.rb +2 -0
- data/lib/purecloud/models/query_request.rb +2 -0
- data/lib/purecloud/models/question_group.rb +8 -0
- data/lib/purecloud/models/question_group_score.rb +2 -0
- data/lib/purecloud/models/question_score.rb +4 -0
- data/lib/purecloud/models/queue_member.rb +2 -0
- data/lib/purecloud/models/report_schedule.rb +2 -0
- data/lib/purecloud/models/resource_permission_policy.rb +2 -0
- data/lib/purecloud/models/routing_status_rule.rb +4 -0
- data/lib/purecloud/models/salesforce.rb +2 -0
- data/lib/purecloud/models/screenshare.rb +2 -0
- data/lib/purecloud/models/site.rb +2 -0
- data/lib/purecloud/models/social_expression.rb +2 -0
- data/lib/purecloud/models/sort_item.rb +2 -0
- data/lib/purecloud/models/tag_value.rb +2 -0
- data/lib/purecloud/models/time_allowed.rb +2 -0
- data/lib/purecloud/models/time_off_request.rb +4 -0
- data/lib/purecloud/models/time_off_request_patch.rb +2 -0
- data/lib/purecloud/models/transfer_request.rb +2 -0
- data/lib/purecloud/models/trunk.rb +2 -0
- data/lib/purecloud/models/trunk_base.rb +2 -0
- data/lib/purecloud/models/unread_status.rb +2 -0
- data/lib/purecloud/models/user_presence.rb +2 -0
- data/lib/purecloud/models/user_presence_rule.rb +4 -0
- data/lib/purecloud/models/user_queue.rb +2 -0
- data/lib/purecloud/models/user_recording.rb +2 -0
- data/lib/purecloud/models/user_schedule_adherence.rb +2 -0
- data/lib/purecloud/models/validate_address_response.rb +2 -0
- data/lib/purecloud/models/video.rb +6 -0
- data/lib/purecloud/models/voicemail_group_policy.rb +4 -0
- data/lib/purecloud/models/voicemail_message.rb +4 -0
- data/lib/purecloud/models/voicemail_organization_policy.rb +8 -0
- data/lib/purecloud/models/voicemail_user_policy.rb +2 -0
- data/lib/purecloud/models/workspace.rb +2 -0
- data/lib/purecloud/models/wrapup.rb +2 -0
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +2 -2
data/doc_out/PresenceApi.html.md
CHANGED
@@ -9,12 +9,12 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
11
|
|[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete a Presence Definition|
|
12
|
-
|[**get**](PresenceApi.html#get) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
|
13
12
|
|[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get a Presence Definition|
|
13
|
+
|[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
|
14
14
|
|[**get_systempresences**](PresenceApi.html#get_systempresences) | **GET** /api/v2/systempresences | Get the list of SystemPresences|
|
15
15
|
|[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | **GET** /api/v2/users/{userId}/presences/{sourceId} | Get a user's Presence|
|
16
16
|
|[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | **PATCH** /api/v2/users/{userId}/presences/{sourceId} | Patch a user's Presence|
|
17
|
-
|[**
|
17
|
+
|[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
|
18
18
|
|[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update a Presence Definition|
|
19
19
|
{: class="table table-striped"}
|
20
20
|
|
@@ -73,11 +73,11 @@ nil (empty response body)
|
|
73
73
|
|
74
74
|
|
75
75
|
|
76
|
-
<a name="
|
76
|
+
<a name="get_presence_id"></a>
|
77
77
|
|
78
|
-
## -[**
|
78
|
+
## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts)
|
79
79
|
|
80
|
-
Get
|
80
|
+
Get a Presence Definition
|
81
81
|
|
82
82
|
|
83
83
|
|
@@ -98,19 +98,18 @@ end
|
|
98
98
|
|
99
99
|
api_instance = PureCloud::PresenceApi.new
|
100
100
|
|
101
|
+
presence_id = "presence_id_example" # String | Organization Presence ID
|
102
|
+
|
101
103
|
opts = {
|
102
|
-
|
103
|
-
page_size: 25, # Integer | Page size
|
104
|
-
deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL
|
105
|
-
locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything.
|
104
|
+
locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
106
105
|
}
|
107
106
|
|
108
107
|
begin
|
109
|
-
#Get
|
110
|
-
result = api_instance.
|
108
|
+
#Get a Presence Definition
|
109
|
+
result = api_instance.get_presence_id(presence_id, opts)
|
111
110
|
p result
|
112
111
|
rescue PureCloud::ApiError => e
|
113
|
-
puts "Exception when calling PresenceApi->
|
112
|
+
puts "Exception when calling PresenceApi->get_presence_id: #{e}"
|
114
113
|
end
|
115
114
|
~~~
|
116
115
|
|
@@ -118,16 +117,14 @@ end
|
|
118
117
|
|
119
118
|
Name | Type | Description | Notes
|
120
119
|
------------- | ------------- | ------------- | -------------
|
121
|
-
**
|
122
|
-
**
|
123
|
-
**deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false]
|
124
|
-
**locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional]
|
120
|
+
**presence_id** | **String**| Organization Presence ID |
|
121
|
+
**locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional]
|
125
122
|
{: class="table table-striped"}
|
126
123
|
|
127
124
|
|
128
125
|
### Return type
|
129
126
|
|
130
|
-
[**
|
127
|
+
[**OrganizationPresence**](OrganizationPresence.html)
|
131
128
|
|
132
129
|
### HTTP request headers
|
133
130
|
|
@@ -136,11 +133,11 @@ Name | Type | Description | Notes
|
|
136
133
|
|
137
134
|
|
138
135
|
|
139
|
-
<a name="
|
136
|
+
<a name="get_presencedefinitions"></a>
|
140
137
|
|
141
|
-
## -[**
|
138
|
+
## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts)
|
142
139
|
|
143
|
-
Get
|
140
|
+
Get an Organization's list of Presence Definitions
|
144
141
|
|
145
142
|
|
146
143
|
|
@@ -161,18 +158,19 @@ end
|
|
161
158
|
|
162
159
|
api_instance = PureCloud::PresenceApi.new
|
163
160
|
|
164
|
-
presence_id = "presence_id_example" # String | Organization Presence ID
|
165
|
-
|
166
161
|
opts = {
|
167
|
-
|
162
|
+
page_number: 1, # Integer | Page number
|
163
|
+
page_size: 25, # Integer | Page size
|
164
|
+
deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL
|
165
|
+
locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything.
|
168
166
|
}
|
169
167
|
|
170
168
|
begin
|
171
|
-
#Get
|
172
|
-
result = api_instance.
|
169
|
+
#Get an Organization's list of Presence Definitions
|
170
|
+
result = api_instance.get_presencedefinitions(opts)
|
173
171
|
p result
|
174
172
|
rescue PureCloud::ApiError => e
|
175
|
-
puts "Exception when calling PresenceApi->
|
173
|
+
puts "Exception when calling PresenceApi->get_presencedefinitions: #{e}"
|
176
174
|
end
|
177
175
|
~~~
|
178
176
|
|
@@ -180,14 +178,16 @@ end
|
|
180
178
|
|
181
179
|
Name | Type | Description | Notes
|
182
180
|
------------- | ------------- | ------------- | -------------
|
183
|
-
**
|
184
|
-
**
|
181
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
182
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
183
|
+
**deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false]
|
184
|
+
**locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional]
|
185
185
|
{: class="table table-striped"}
|
186
186
|
|
187
187
|
|
188
188
|
### Return type
|
189
189
|
|
190
|
-
[**
|
190
|
+
[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html)
|
191
191
|
|
192
192
|
### HTTP request headers
|
193
193
|
|
@@ -367,9 +367,9 @@ Name | Type | Description | Notes
|
|
367
367
|
|
368
368
|
|
369
369
|
|
370
|
-
<a name="
|
370
|
+
<a name="post_presencedefinitions"></a>
|
371
371
|
|
372
|
-
## -[**OrganizationPresence**](OrganizationPresence.html)
|
372
|
+
## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body)
|
373
373
|
|
374
374
|
Create a Presence Definition
|
375
375
|
|
@@ -397,10 +397,10 @@ body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Presence
|
|
397
397
|
|
398
398
|
begin
|
399
399
|
#Create a Presence Definition
|
400
|
-
result = api_instance.
|
400
|
+
result = api_instance.post_presencedefinitions(body)
|
401
401
|
p result
|
402
402
|
rescue PureCloud::ApiError => e
|
403
|
-
puts "Exception when calling PresenceApi->
|
403
|
+
puts "Exception when calling PresenceApi->post_presencedefinitions: #{e}"
|
404
404
|
end
|
405
405
|
~~~
|
406
406
|
|
data/doc_out/PureCloud.html.md
CHANGED
@@ -9,7 +9,7 @@ title: PureCloud
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **disabled** | **BOOLEAN** | | [optional] |
|
12
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
13
13
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
@@ -14,7 +14,7 @@ title: QueryRequest
|
|
14
14
|
| **sort** | [**Array<SortItem>**](SortItem.html) | | [optional] |
|
15
15
|
| **filters** | [**Array<ContentFilterItem>**](ContentFilterItem.html) | | [optional] |
|
16
16
|
| **attribute_filters** | [**Array<AttributeFilterItem>**](AttributeFilterItem.html) | | [optional] |
|
17
|
-
| **include_shares** | **BOOLEAN** | | [optional] |
|
17
|
+
| **include_shares** | **BOOLEAN** | | [optional] [default to false]|
|
18
18
|
{: class="table table-striped"}
|
19
19
|
|
20
20
|
|
@@ -10,11 +10,11 @@ title: QuestionGroup
|
|
10
10
|
| **id** | **String** | | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **type** | **String** | | [optional] |
|
13
|
-
| **default_answers_to_highest** | **BOOLEAN** | | [optional] |
|
14
|
-
| **default_answers_to_na** | **BOOLEAN** | | [optional] |
|
15
|
-
| **na_enabled** | **BOOLEAN** | | [optional] |
|
13
|
+
| **default_answers_to_highest** | **BOOLEAN** | | [optional] [default to false]|
|
14
|
+
| **default_answers_to_na** | **BOOLEAN** | | [optional] [default to false]|
|
15
|
+
| **na_enabled** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **weight** | **Float** | | [optional] |
|
17
|
-
| **manual_weight** | **BOOLEAN** | | [optional] |
|
17
|
+
| **manual_weight** | **BOOLEAN** | | [optional] [default to false]|
|
18
18
|
| **questions** | **Array<Hash<String, Object>>** | | [optional] |
|
19
19
|
| **visibility_condition** | [**VisibilityCondition**](VisibilityCondition.html) | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -16,7 +16,7 @@ title: QuestionGroupScore
|
|
16
16
|
| **max_total_score_unweighted** | **Float** | | [optional] |
|
17
17
|
| **total_critical_score_unweighted** | **Float** | | [optional] |
|
18
18
|
| **max_total_critical_score_unweighted** | **Float** | | [optional] |
|
19
|
-
| **marked_na** | **BOOLEAN** | | [optional] |
|
19
|
+
| **marked_na** | **BOOLEAN** | | [optional] [default to false]|
|
20
20
|
| **question_scores** | [**Array<QuestionScore>**](QuestionScore.html) | | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -10,8 +10,8 @@ title: QuestionScore
|
|
10
10
|
| **question_id** | **String** | | [optional] |
|
11
11
|
| **answer_id** | **String** | | [optional] |
|
12
12
|
| **score** | **Integer** | | [optional] |
|
13
|
-
| **marked_na** | **BOOLEAN** | | [optional] |
|
14
|
-
| **failed_kill_question** | **BOOLEAN** | | [optional] |
|
13
|
+
| **marked_na** | **BOOLEAN** | | [optional] [default to false]|
|
14
|
+
| **failed_kill_question** | **BOOLEAN** | | [optional] [default to false]|
|
15
15
|
| **comments** | **String** | | [optional] |
|
16
16
|
{: class="table table-striped"}
|
17
17
|
|
data/doc_out/QueueMember.html.md
CHANGED
@@ -11,7 +11,7 @@ title: QueueMember
|
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **user** | [**User**](User.html) | | [optional] |
|
13
13
|
| **ring_number** | **Integer** | | [optional] |
|
14
|
-
| **joined** | **BOOLEAN** | | [optional] |
|
14
|
+
| **joined** | **BOOLEAN** | | [optional] [default to false]|
|
15
15
|
| **member_by** | **String** | | [optional] |
|
16
16
|
| **routing_status** | [**RoutingStatus**](RoutingStatus.html) | | [optional] |
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -12,7 +12,6 @@ Method | HTTP request | Description
|
|
12
12
|
|[**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | **DELETE** /api/v2/recording/mediaretentionpolicies | Delete media retention policies|
|
13
13
|
|[**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | **DELETE** /api/v2/recording/mediaretentionpolicies/{policyId} | Delete a media retention policy|
|
14
14
|
|[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} | Deletes a single orphan recording|
|
15
|
-
|[**get**](RecordingApi.html#get) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
|
16
15
|
|[**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | **GET** /api/v2/conversations/{conversationId}/recordings | Get all of a Conversation's Recordings.|
|
17
16
|
|[**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Gets a specific recording.|
|
18
17
|
|[**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Get annotations for recording|
|
@@ -23,6 +22,7 @@ Method | HTTP request | Description
|
|
23
22
|
|[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
|
24
23
|
|[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
|
25
24
|
|[**get_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | **GET** /api/v2/orphanrecordings/{orphanId}/media | Gets the media of a single orphan recording|
|
25
|
+
|[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
|
26
26
|
|[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
|
27
27
|
|[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
|
28
28
|
|[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
|
@@ -272,75 +272,6 @@ Name | Type | Description | Notes
|
|
272
272
|
|
273
273
|
|
274
274
|
|
275
|
-
<a name="get"></a>
|
276
|
-
|
277
|
-
## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get(opts)
|
278
|
-
|
279
|
-
Gets all orphan recordings
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
### Example
|
284
|
-
~~~ruby
|
285
|
-
# load the gem
|
286
|
-
require 'purecloud'
|
287
|
-
# setup authorization
|
288
|
-
@secret = ENV['PURECLOUD_SECRET']
|
289
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
290
|
-
environment = "mypurecloud.com"
|
291
|
-
|
292
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
293
|
-
|
294
|
-
PureCloud.configure do |config|
|
295
|
-
config.access_token = @authToken
|
296
|
-
end
|
297
|
-
|
298
|
-
api_instance = PureCloud::RecordingApi.new
|
299
|
-
|
300
|
-
opts = {
|
301
|
-
page_size: 25, # Integer | The total page size requested
|
302
|
-
page_number: 1, # Integer | The page number requested
|
303
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
304
|
-
expand: nil, # Array<Object> | variable name requested by expand list
|
305
|
-
next_page: "next_page_example", # String | next page token
|
306
|
-
previous_page: "previous_page_example", # String | Previous page token
|
307
|
-
has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
|
308
|
-
}
|
309
|
-
|
310
|
-
begin
|
311
|
-
#Gets all orphan recordings
|
312
|
-
result = api_instance.get(opts)
|
313
|
-
p result
|
314
|
-
rescue PureCloud::ApiError => e
|
315
|
-
puts "Exception when calling RecordingApi->get: #{e}"
|
316
|
-
end
|
317
|
-
~~~
|
318
|
-
|
319
|
-
### Parameters
|
320
|
-
|
321
|
-
Name | Type | Description | Notes
|
322
|
-
------------- | ------------- | ------------- | -------------
|
323
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25]
|
324
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1]
|
325
|
-
**sort_by** | **String**| variable name requested to sort by | [optional]
|
326
|
-
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional]
|
327
|
-
**next_page** | **String**| next page token | [optional]
|
328
|
-
**previous_page** | **String**| Previous page token | [optional]
|
329
|
-
**has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false]
|
330
|
-
{: class="table table-striped"}
|
331
|
-
|
332
|
-
|
333
|
-
### Return type
|
334
|
-
|
335
|
-
[**OrphanRecordingListing**](OrphanRecordingListing.html)
|
336
|
-
|
337
|
-
### HTTP request headers
|
338
|
-
|
339
|
-
- **Content-Type**: application/json
|
340
|
-
- **Accept**: application/json
|
341
|
-
|
342
|
-
|
343
|
-
|
344
275
|
<a name="get_conversation_id_recordings"></a>
|
345
276
|
|
346
277
|
## -[**Array<Recording>**](Recording.html) get_conversation_id_recordings(conversation_id, opts)
|
@@ -948,6 +879,75 @@ Name | Type | Description | Notes
|
|
948
879
|
|
949
880
|
|
950
881
|
|
882
|
+
<a name="get_orphanrecordings"></a>
|
883
|
+
|
884
|
+
## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(opts)
|
885
|
+
|
886
|
+
Gets all orphan recordings
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
### Example
|
891
|
+
~~~ruby
|
892
|
+
# load the gem
|
893
|
+
require 'purecloud'
|
894
|
+
# setup authorization
|
895
|
+
@secret = ENV['PURECLOUD_SECRET']
|
896
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
897
|
+
environment = "mypurecloud.com"
|
898
|
+
|
899
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
900
|
+
|
901
|
+
PureCloud.configure do |config|
|
902
|
+
config.access_token = @authToken
|
903
|
+
end
|
904
|
+
|
905
|
+
api_instance = PureCloud::RecordingApi.new
|
906
|
+
|
907
|
+
opts = {
|
908
|
+
page_size: 25, # Integer | The total page size requested
|
909
|
+
page_number: 1, # Integer | The page number requested
|
910
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
911
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
912
|
+
next_page: "next_page_example", # String | next page token
|
913
|
+
previous_page: "previous_page_example", # String | Previous page token
|
914
|
+
has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
|
915
|
+
}
|
916
|
+
|
917
|
+
begin
|
918
|
+
#Gets all orphan recordings
|
919
|
+
result = api_instance.get_orphanrecordings(opts)
|
920
|
+
p result
|
921
|
+
rescue PureCloud::ApiError => e
|
922
|
+
puts "Exception when calling RecordingApi->get_orphanrecordings: #{e}"
|
923
|
+
end
|
924
|
+
~~~
|
925
|
+
|
926
|
+
### Parameters
|
927
|
+
|
928
|
+
Name | Type | Description | Notes
|
929
|
+
------------- | ------------- | ------------- | -------------
|
930
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25]
|
931
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1]
|
932
|
+
**sort_by** | **String**| variable name requested to sort by | [optional]
|
933
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional]
|
934
|
+
**next_page** | **String**| next page token | [optional]
|
935
|
+
**previous_page** | **String**| Previous page token | [optional]
|
936
|
+
**has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false]
|
937
|
+
{: class="table table-striped"}
|
938
|
+
|
939
|
+
|
940
|
+
### Return type
|
941
|
+
|
942
|
+
[**OrphanRecordingListing**](OrphanRecordingListing.html)
|
943
|
+
|
944
|
+
### HTTP request headers
|
945
|
+
|
946
|
+
- **Content-Type**: application/json
|
947
|
+
- **Accept**: application/json
|
948
|
+
|
949
|
+
|
950
|
+
|
951
951
|
<a name="get_recordingkeys"></a>
|
952
952
|
|
953
953
|
## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recordingkeys(opts)
|
@@ -19,7 +19,7 @@ title: ReportSchedule
|
|
19
19
|
| **interval** | **String** | Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
20
20
|
| **report_format** | **String** | | [optional] |
|
21
21
|
| **locale** | **String** | | [optional] |
|
22
|
-
| **enabled** | **BOOLEAN** | | [optional] |
|
22
|
+
| **enabled** | **BOOLEAN** | | [optional] [default to false]|
|
23
23
|
| **report_id** | **String** | Report ID | |
|
24
24
|
| **parameters** | **Hash<String, Object>** | | [optional] |
|
25
25
|
| **last_run** | [**ReportRunEntry**](ReportRunEntry.html) | | [optional] |
|
@@ -13,7 +13,7 @@ title: ResourcePermissionPolicy
|
|
13
13
|
| **policy_name** | **String** | | [optional] |
|
14
14
|
| **policy_description** | **String** | | [optional] |
|
15
15
|
| **action_set_key** | **String** | | [optional] |
|
16
|
-
| **allow_conditions** | **BOOLEAN** | | [optional] |
|
16
|
+
| **allow_conditions** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **resource_condition_node** | [**ResourceConditionNode**](ResourceConditionNode.html) | | [optional] |
|
18
18
|
| **named_resources** | **Array<String>** | | [optional] |
|
19
19
|
| **resource_condition** | **String** | | [optional] |
|
@@ -12,8 +12,8 @@ title: RoutingStatusRule
|
|
12
12
|
| **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
|
13
13
|
| **routing_status** | **String** | The routing status on which to alert. | |
|
14
14
|
| **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent's routing status. | |
|
15
|
-
| **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
|
16
|
-
| **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
|
15
|
+
| **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
|
16
|
+
| **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
|
17
17
|
| **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
|
18
18
|
| **alert_types** | **Array<String>** | A collection of notification methods. | |
|
19
19
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
data/doc_out/Salesforce.html.md
CHANGED
@@ -12,7 +12,7 @@ title: Salesforce
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
-
| **disabled** | **BOOLEAN** | | [optional] |
|
15
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
data/doc_out/Screenshare.html.md
CHANGED
@@ -10,7 +10,7 @@ title: Screenshare
|
|
10
10
|
| **state** | **String** | The connection state of this communication. | [optional] |
|
11
11
|
| **id** | **String** | A globally unique identifier for this communication. | [optional] |
|
12
12
|
| **context** | **String** | The room id context (xmpp jid) for the conference session. | [optional] |
|
13
|
-
| **sharing** | **BOOLEAN** | Indicates whether this participant is sharing their screen. | [optional] |
|
13
|
+
| **sharing** | **BOOLEAN** | Indicates whether this participant is sharing their screen. | [optional] [default to false]|
|
14
14
|
| **peer_count** | **Integer** | The number of peer participants from the perspective of the participant in the conference. | [optional] |
|
15
15
|
| **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
|
16
16
|
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
data/doc_out/ScriptsApi.html.md
CHANGED
@@ -8,7 +8,6 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
|[**get**](ScriptsApi.html#get) | **GET** /api/v2/scripts | Get the list of scripts|
|
12
11
|
|[**get_published**](ScriptsApi.html#get_published) | **GET** /api/v2/scripts/published | Get the published scripts.|
|
13
12
|
|[**get_published_script_id**](ScriptsApi.html#get_published_script_id) | **GET** /api/v2/scripts/published/{scriptId} | Get the published script.|
|
14
13
|
|[**get_published_script_id_pages**](ScriptsApi.html#get_published_script_id_pages) | **GET** /api/v2/scripts/published/{scriptId}/pages | Get the list of published pages|
|
@@ -17,79 +16,9 @@ Method | HTTP request | Description
|
|
17
16
|
|[**get_script_id**](ScriptsApi.html#get_script_id) | **GET** /api/v2/scripts/{scriptId} | Get a script|
|
18
17
|
|[**get_script_id_pages**](ScriptsApi.html#get_script_id_pages) | **GET** /api/v2/scripts/{scriptId}/pages | Get the list of pages|
|
19
18
|
|[**get_script_id_pages_page_id**](ScriptsApi.html#get_script_id_pages_page_id) | **GET** /api/v2/scripts/{scriptId}/pages/{pageId} | Get a page|
|
19
|
+
|[**get_scripts**](ScriptsApi.html#get_scripts) | **GET** /api/v2/scripts | Get the list of scripts|
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
22
|
-
<a name="get"></a>
|
23
|
-
|
24
|
-
## -[**ScriptEntityListing**](ScriptEntityListing.html) get(opts)
|
25
|
-
|
26
|
-
Get the list of scripts
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
### Example
|
31
|
-
~~~ruby
|
32
|
-
# load the gem
|
33
|
-
require 'purecloud'
|
34
|
-
# setup authorization
|
35
|
-
@secret = ENV['PURECLOUD_SECRET']
|
36
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
37
|
-
environment = "mypurecloud.com"
|
38
|
-
|
39
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
40
|
-
|
41
|
-
PureCloud.configure do |config|
|
42
|
-
config.access_token = @authToken
|
43
|
-
end
|
44
|
-
|
45
|
-
api_instance = PureCloud::ScriptsApi.new
|
46
|
-
|
47
|
-
opts = {
|
48
|
-
page_size: 25, # Integer | Page size
|
49
|
-
page_number: 1, # Integer | Page number
|
50
|
-
expand: "expand_example", # String | Expand
|
51
|
-
name: "name_example", # String | Name filter
|
52
|
-
feature: "feature_example", # String | Feature filter
|
53
|
-
flow_id: "flow_id_example", # String | Secure flow id filter
|
54
|
-
sort_by: "sort_by_example", # String | SortBy
|
55
|
-
sort_order: "sort_order_example" # String | SortOrder
|
56
|
-
}
|
57
|
-
|
58
|
-
begin
|
59
|
-
#Get the list of scripts
|
60
|
-
result = api_instance.get(opts)
|
61
|
-
p result
|
62
|
-
rescue PureCloud::ApiError => e
|
63
|
-
puts "Exception when calling ScriptsApi->get: #{e}"
|
64
|
-
end
|
65
|
-
~~~
|
66
|
-
|
67
|
-
### Parameters
|
68
|
-
|
69
|
-
Name | Type | Description | Notes
|
70
|
-
------------- | ------------- | ------------- | -------------
|
71
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
72
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
73
|
-
**expand** | **String**| Expand | [optional]
|
74
|
-
**name** | **String**| Name filter | [optional]
|
75
|
-
**feature** | **String**| Feature filter | [optional]
|
76
|
-
**flow_id** | **String**| Secure flow id filter | [optional]
|
77
|
-
**sort_by** | **String**| SortBy | [optional]
|
78
|
-
**sort_order** | **String**| SortOrder | [optional]
|
79
|
-
{: class="table table-striped"}
|
80
|
-
|
81
|
-
|
82
|
-
### Return type
|
83
|
-
|
84
|
-
[**ScriptEntityListing**](ScriptEntityListing.html)
|
85
|
-
|
86
|
-
### HTTP request headers
|
87
|
-
|
88
|
-
- **Content-Type**: application/json
|
89
|
-
- **Accept**: application/json
|
90
|
-
|
91
|
-
|
92
|
-
|
93
22
|
<a name="get_published"></a>
|
94
23
|
|
95
24
|
## -[**ScriptEntityListing**](ScriptEntityListing.html) get_published(opts)
|
@@ -555,3 +484,74 @@ Name | Type | Description | Notes
|
|
555
484
|
|
556
485
|
|
557
486
|
|
487
|
+
<a name="get_scripts"></a>
|
488
|
+
|
489
|
+
## -[**ScriptEntityListing**](ScriptEntityListing.html) get_scripts(opts)
|
490
|
+
|
491
|
+
Get the list of scripts
|
492
|
+
|
493
|
+
|
494
|
+
|
495
|
+
### Example
|
496
|
+
~~~ruby
|
497
|
+
# load the gem
|
498
|
+
require 'purecloud'
|
499
|
+
# setup authorization
|
500
|
+
@secret = ENV['PURECLOUD_SECRET']
|
501
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
502
|
+
environment = "mypurecloud.com"
|
503
|
+
|
504
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
505
|
+
|
506
|
+
PureCloud.configure do |config|
|
507
|
+
config.access_token = @authToken
|
508
|
+
end
|
509
|
+
|
510
|
+
api_instance = PureCloud::ScriptsApi.new
|
511
|
+
|
512
|
+
opts = {
|
513
|
+
page_size: 25, # Integer | Page size
|
514
|
+
page_number: 1, # Integer | Page number
|
515
|
+
expand: "expand_example", # String | Expand
|
516
|
+
name: "name_example", # String | Name filter
|
517
|
+
feature: "feature_example", # String | Feature filter
|
518
|
+
flow_id: "flow_id_example", # String | Secure flow id filter
|
519
|
+
sort_by: "sort_by_example", # String | SortBy
|
520
|
+
sort_order: "sort_order_example" # String | SortOrder
|
521
|
+
}
|
522
|
+
|
523
|
+
begin
|
524
|
+
#Get the list of scripts
|
525
|
+
result = api_instance.get_scripts(opts)
|
526
|
+
p result
|
527
|
+
rescue PureCloud::ApiError => e
|
528
|
+
puts "Exception when calling ScriptsApi->get_scripts: #{e}"
|
529
|
+
end
|
530
|
+
~~~
|
531
|
+
|
532
|
+
### Parameters
|
533
|
+
|
534
|
+
Name | Type | Description | Notes
|
535
|
+
------------- | ------------- | ------------- | -------------
|
536
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
537
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
538
|
+
**expand** | **String**| Expand | [optional]
|
539
|
+
**name** | **String**| Name filter | [optional]
|
540
|
+
**feature** | **String**| Feature filter | [optional]
|
541
|
+
**flow_id** | **String**| Secure flow id filter | [optional]
|
542
|
+
**sort_by** | **String**| SortBy | [optional]
|
543
|
+
**sort_order** | **String**| SortOrder | [optional]
|
544
|
+
{: class="table table-striped"}
|
545
|
+
|
546
|
+
|
547
|
+
### Return type
|
548
|
+
|
549
|
+
[**ScriptEntityListing**](ScriptEntityListing.html)
|
550
|
+
|
551
|
+
### HTTP request headers
|
552
|
+
|
553
|
+
- **Content-Type**: application/json
|
554
|
+
- **Accept**: application/json
|
555
|
+
|
556
|
+
|
557
|
+
|