purecloud 0.54.1 → 0.55.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/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AggregationQuery.html.md +1 -0
- data/doc_out/AnalyticsParticipant.html.md +2 -0
- data/doc_out/AnalyticsQueryClause.html.md +2 -2
- data/doc_out/AnalyticsQueryFilter.html.md +1 -1
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuthorizationApi.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +65 -0
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +2 -2
- data/doc_out/DomainOrganizationRoleCreate.html.md +2 -2
- data/doc_out/DomainOrganizationRoleUpdate.html.md +23 -0
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FieldConfig.html.md +20 -0
- data/doc_out/FieldList.html.md +21 -0
- data/doc_out/Forecast.html.md +16 -0
- data/doc_out/ForecastCreation.html.md +17 -0
- data/doc_out/ForecastCreationCompletion.html.md +14 -0
- data/doc_out/ForecastDimensions.html.md +15 -0
- data/doc_out/ForecastEntry.html.md +15 -0
- data/doc_out/ForecastFilterAttributes.html.md +15 -0
- data/doc_out/ForecastMetadata.html.md +22 -0
- data/doc_out/ForecastMetadataEntityListing.html.md +22 -0
- data/doc_out/ForecastModification.html.md +27 -0
- data/doc_out/ForecastModificationCreation.html.md +25 -0
- data/doc_out/ForecastSearchCriteria.html.md +20 -0
- data/doc_out/ForecastSearchRequest.html.md +20 -0
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +57 -0
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +4 -4
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/ObservationQuery.html.md +1 -1
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrganizationApi.html.md +57 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PagingSpec.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/Phone.html.md +1 -0
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneStatus.html.md +1 -0
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PropertyIndexRequest.html.md +2 -2
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/Section.html.md +16 -0
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +2 -2
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +22 -0
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserAgentInfo.html.md +15 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +57 -0
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/WorkforceManagementApi.html.md +463 -0
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMember.html.md +1 -1
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +18 -0
- data/lib/purecloud/api/conversations_api.rb +74 -0
- data/lib/purecloud/api/groups_api.rb +64 -0
- data/lib/purecloud/api/organization_api.rb +64 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -3
- data/lib/purecloud/api/users_api.rb +64 -0
- data/lib/purecloud/api/workforce_management_api.rb +493 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +11 -11
- data/lib/purecloud/models/agent_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/aggregation_query.rb +12 -1
- data/lib/purecloud/models/analytics_participant.rb +21 -1
- data/lib/purecloud/models/analytics_query_clause.rb +1 -0
- data/lib/purecloud/models/analytics_query_filter.rb +1 -0
- data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +21 -21
- data/lib/purecloud/models/attribute_entity_listing.rb +21 -21
- data/lib/purecloud/models/calibration_entity_listing.rb +21 -21
- data/lib/purecloud/models/call_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/campaign_entity_listing.rb +21 -21
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +21 -21
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +21 -21
- data/lib/purecloud/models/channel_entity_listing.rb +21 -21
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/command_status_entity_listing.rb +21 -21
- data/lib/purecloud/models/contact_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/customer_interaction_center.rb +11 -11
- data/lib/purecloud/models/did_entity_listing.rb +21 -21
- data/lib/purecloud/models/did_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/dnc_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_audit_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +21 -21
- data/lib/purecloud/models/domain_organization_role.rb +14 -13
- data/lib/purecloud/models/domain_organization_role_create.rb +14 -13
- data/lib/purecloud/models/domain_organization_role_update.rb +279 -0
- data/lib/purecloud/models/edge_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_group_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_line_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_message_listing.rb +21 -21
- data/lib/purecloud/models/encryption_key_entity_listing.rb +21 -21
- data/lib/purecloud/models/endpoint_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/fax_document_entity_listing.rb +21 -21
- data/lib/purecloud/models/field_config.rb +248 -0
- data/lib/purecloud/models/field_list.rb +255 -0
- data/lib/purecloud/models/forecast.rb +201 -0
- data/lib/purecloud/models/forecast_creation.rb +221 -0
- data/lib/purecloud/models/forecast_creation_completion.rb +186 -0
- data/lib/purecloud/models/forecast_dimensions.rb +197 -0
- data/lib/purecloud/models/forecast_entry.rb +199 -0
- data/lib/purecloud/models/forecast_filter_attributes.rb +191 -0
- data/lib/purecloud/models/forecast_metadata.rb +284 -0
- data/lib/purecloud/models/forecast_metadata_entity_listing.rb +257 -0
- data/lib/purecloud/models/forecast_modification.rb +339 -0
- data/lib/purecloud/models/forecast_modification_creation.rb +317 -0
- data/lib/purecloud/models/forecast_search_criteria.rb +267 -0
- data/lib/purecloud/models/forecast_search_request.rb +259 -0
- data/lib/purecloud/models/group_entity_listing.rb +21 -21
- data/lib/purecloud/models/heart_beat_alert_container.rb +21 -21
- data/lib/purecloud/models/heart_beat_rule_container.rb +21 -21
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/inbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/interaction_stats_alert_container.rb +21 -21
- data/lib/purecloud/models/interaction_stats_rule_container.rb +21 -21
- data/lib/purecloud/models/json_node.rb +44 -44
- data/lib/purecloud/models/keyword_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/language_entity_listing.rb +21 -21
- data/lib/purecloud/models/library_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_entity_listing.rb +21 -21
- data/lib/purecloud/models/logical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +21 -21
- data/lib/purecloud/models/okta.rb +11 -11
- data/lib/purecloud/models/one_login.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +21 -21
- data/lib/purecloud/models/organization_role_entity_listing.rb +21 -21
- data/lib/purecloud/models/orphan_recording_listing.rb +21 -21
- data/lib/purecloud/models/outbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/permission_collection_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone.rb +12 -1
- data/lib/purecloud/models/phone_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_status.rb +12 -1
- data/lib/purecloud/models/physical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/policy_entity_listing.rb +21 -21
- data/lib/purecloud/models/property_index_request.rb +9 -9
- data/lib/purecloud/models/quality_audit_page.rb +21 -21
- data/lib/purecloud/models/queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/queue_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +21 -21
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +21 -21
- data/lib/purecloud/models/report_schedule_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_entity_list.rb +21 -21
- data/lib/purecloud/models/response_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/rule_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/salesforce.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +21 -21
- data/lib/purecloud/models/schema_reference_entity_listing.rb +21 -21
- data/lib/purecloud/models/screen_recording_session_listing.rb +21 -21
- data/lib/purecloud/models/section.rb +197 -0
- data/lib/purecloud/models/security_profile_entity_listing.rb +21 -21
- data/lib/purecloud/models/share_entity_listing.rb +21 -21
- data/lib/purecloud/models/site_entity_listing.rb +21 -21
- data/lib/purecloud/models/skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/social_expression.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +21 -21
- data/lib/purecloud/models/tag_value_entity_listing.rb +21 -21
- data/lib/purecloud/models/time_zone_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_base_entity_listing.rb +257 -0
- data/lib/purecloud/models/trunk_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_agent_info.rb +188 -0
- data/lib/purecloud/models/user_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_recording_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/users_entity_listing.rb +21 -21
- data/lib/purecloud/models/workspace.rb +1 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +21 -21
- data/lib/purecloud/models/workspace_member.rb +1 -0
- data/lib/purecloud/models/workspace_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +21 -21
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +38 -2
@@ -11,11 +11,11 @@ title: LineEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: LogicalInterfaceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OAuthClientEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OAuthProviderEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,7 +7,7 @@ title: ObservationQuery
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters |
|
10
|
+
| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters | |
|
11
11
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
data/doc_out/Okta.html.md
CHANGED
@@ -10,8 +10,8 @@ title: Okta
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
|
-
| **sso_target_uri** | **String** | | [optional] |
|
14
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
|
+
| **sso_target_uri** | **String** | | [optional] |
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
data/doc_out/OneLogin.html.md
CHANGED
@@ -10,8 +10,8 @@ title: OneLogin
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
|
-
| **sso_target_uri** | **String** | | [optional] |
|
14
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
|
+
| **sso_target_uri** | **String** | | [optional] |
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
17
17
|
{: class="table table-striped"}
|
@@ -8,9 +8,66 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
|[**get_fieldconfig**](OrganizationApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
|
11
12
|
|[**get_me**](OrganizationApi.html#get_me) | **GET** /api/v2/organizations/me | Get organization.|
|
12
13
|
{: class="table table-striped"}
|
13
14
|
|
15
|
+
<a name="get_fieldconfig"></a>
|
16
|
+
|
17
|
+
## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
|
18
|
+
|
19
|
+
Fetch field config for an entity type
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
### Example
|
24
|
+
~~~ruby
|
25
|
+
# load the gem
|
26
|
+
require 'purecloud'
|
27
|
+
# setup authorization
|
28
|
+
@secret = ENV['PURECLOUD_SECRET']
|
29
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
30
|
+
environment = "mypurecloud.com"
|
31
|
+
|
32
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
33
|
+
|
34
|
+
PureCloud.configure do |config|
|
35
|
+
config.access_token = @authToken
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = PureCloud::OrganizationApi.new
|
39
|
+
|
40
|
+
type = "type_example" # String | Field type
|
41
|
+
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Fetch field config for an entity type
|
45
|
+
result = api_instance.get_fieldconfig(type)
|
46
|
+
p result
|
47
|
+
rescue PureCloud::ApiError => e
|
48
|
+
puts "Exception when calling OrganizationApi->get_fieldconfig: #{e}"
|
49
|
+
end
|
50
|
+
~~~
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**type** | **String**| Field type |
|
57
|
+
{: class="table table-striped"}
|
58
|
+
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
[**FieldConfig**](FieldConfig.html)
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: application/json
|
67
|
+
- **Accept**: application/json
|
68
|
+
|
69
|
+
|
70
|
+
|
14
71
|
<a name="get_me"></a>
|
15
72
|
|
16
73
|
## -[**Organization**](Organization.html) get_me
|
@@ -11,11 +11,11 @@ title: OrganizationPresenceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OrganizationRoleEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OrphanRecordingListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OutboundRouteEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/doc_out/PagingSpec.html.md
CHANGED
@@ -7,8 +7,8 @@ title: PagingSpec
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **page_size** | **Integer** | How many results per page |
|
11
|
-
| **page_number** | **Integer** | How many pages in |
|
10
|
+
| **page_size** | **Integer** | How many results per page | |
|
11
|
+
| **page_number** | **Integer** | How many pages in | |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -11,11 +11,11 @@ title: PermissionCollectionEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/doc_out/Phone.html.md
CHANGED
@@ -25,6 +25,7 @@ title: Phone
|
|
25
25
|
| **lines** | [**Array<Line>**](Line.html) | Lines | |
|
26
26
|
| **status** | [**PhoneStatus**](PhoneStatus.html) | The status of the phone and lines from the primary Edge. | [optional] |
|
27
27
|
| **secondary_status** | [**PhoneStatus**](PhoneStatus.html) | The status of the phone and lines from the secondary Edge. | [optional] |
|
28
|
+
| **user_agent_info** | [**UserAgentInfo**](UserAgentInfo.html) | User Agent Information for this phone. This includes model, firmware version, and manufacturer. | [optional] |
|
28
29
|
| **properties** | **Hash<String, Object>** | | [optional] |
|
29
30
|
| **capabilities** | [**PhoneCapabilities**](PhoneCapabilities.html) | | [optional] |
|
30
31
|
| **web_rtc_user** | [**UriReference**](UriReference.html) | This is the user associated with a WebRTC type phone. It is required for all WebRTC phones. | [optional] |
|
@@ -11,11 +11,11 @@ title: PhoneBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhoneEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhoneMetaBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/doc_out/PhoneStatus.html.md
CHANGED
@@ -11,6 +11,7 @@ title: PhoneStatus
|
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **operational_status** | **String** | The Operational Status of this phone | [optional] |
|
13
13
|
| **edges_status** | **String** | The status of the primary or secondary Edges assigned to the phone lines. | [optional] |
|
14
|
+
| **event_creation_time** | **String** | Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London | [optional] |
|
14
15
|
| **provision** | [**ProvisionInfo**](ProvisionInfo.html) | Provision information for this phone | [optional] |
|
15
16
|
| **line_statuses** | [**Array<LineStatus>**](LineStatus.html) | A list of LineStatus information for each of the lines of this phone | [optional] |
|
16
17
|
| **phone_assignment_to_edge_type** | **String** | The phone status's edge assignment type. | [optional] |
|
@@ -11,11 +11,11 @@ title: PhysicalInterfaceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PolicyEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,8 +7,8 @@ title: PropertyIndexRequest
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **session_id** | **String** | Attach properties to a segment in the indicated session
|
11
|
-
| **
|
10
|
+
| **session_id** | **String** | Attach properties to a segment in the indicated session | |
|
11
|
+
| **target_date** | **DateTime** | Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
12
12
|
| **properties** | [**Array<AnalyticsProperty>**](AnalyticsProperty.html) | The list of properties to index | |
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
@@ -11,11 +11,11 @@ title: QualityAuditPage
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: QueueEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: QueueMemberEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ReportMetaDataEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ReportRunEntryEntityDomainListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ReportScheduleEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: ResponseEntityList
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|