RubyGems - purecloud - Versions diffs - 0.54.1 → 0.55.1 - Mend

purecloud 0.54.1 → 0.55.1

Files changed (286) hide show

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

data/doc_out/ForecastDimensions.html.md ADDED

@@ -0,0 +1,15 @@
+---
+title: ForecastDimensions
+---
+## PureCloud::ForecastDimensions
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **language** | [**Language**](Language.html) | The language of the forecast | [optional] |
+| **media** | **String** | The media of the forecast | [optional] |
+| **queue** | [**Queue**](Queue.html) | The queue of the forecast | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastEntry.html.md ADDED

@@ -0,0 +1,15 @@
+---
+title: ForecastEntry
+---
+## PureCloud::ForecastEntry
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** | The metric of the entry | [optional] |
+| **dimensions** | [**ForecastDimensions**](ForecastDimensions.html) | The dimensions of the entry | [optional] |
+| **values** | **Array&lt;Float&gt;** | The forecasted values | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastFilterAttributes.html.md ADDED

@@ -0,0 +1,15 @@
+---
+title: ForecastFilterAttributes
+---
+## PureCloud::ForecastFilterAttributes
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **languages** | **Array&lt;String&gt;** |  | [optional] |
+| **queue_ids** | **Array&lt;String&gt;** |  | [optional] |
+| **media_types** | **Array&lt;String&gt;** |  | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastMetadata.html.md ADDED

@@ -0,0 +1,22 @@
+---
+title: ForecastMetadata
+---
+## PureCloud::ForecastMetadata
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **number_of_periods** | **Integer** | The number of periods to be forecasted for | |
+| **period_frequency** | **String** | The frequency of the period | |
+| **description** | **String** | The description of the forecast to be created | |
+| **metrics** | **Array&lt;String&gt;** | The metrics the forecast is for | |
+| **last_modified_date** | **DateTime** | The last modified date time of this object. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **last_modified_by** | [**User**](User.html) | The person who last modified this object | [optional] |
+| **status** | **String** | The status of the creation of the forecast | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastMetadataEntityListing.html.md ADDED

@@ -0,0 +1,22 @@
+---
+title: ForecastMetadataEntityListing
+---
+## PureCloud::ForecastMetadataEntityListing
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array&lt;ForecastMetadata&gt;**](ForecastMetadata.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastModification.html.md ADDED

@@ -0,0 +1,27 @@
+---
+title: ForecastModification
+---
+## PureCloud::ForecastModification
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **forecast_id** | **String** | The id of the associated forecast | |
+| **priority** | **Integer** | The priority in which the modification is applied | |
+| **metric** | **String** | The metric the modification is appied to | |
+| **modification_type** | **String** | The type of modification | |
+| **modification_value** | **Float** | The value of the modification | |
+| **start_date** | **DateTime** | The start of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **end_date** | **DateTime** | The end of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **attributes** | [**ForecastFilterAttributes**](ForecastFilterAttributes.html) | The filters for the modification | |
+| **enabled** | **BOOLEAN** | Determined if the modification is currently applied | [default to false]|
+| **last_modified_date** | **DateTime** | The last time the modification was changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **last_modified_by** | [**User**](User.html) | The last user to change the modification | |
+| **notes** | **String** | Any notes associated with the modification | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastModificationCreation.html.md ADDED

@@ -0,0 +1,25 @@
+---
+title: ForecastModificationCreation
+---
+## PureCloud::ForecastModificationCreation
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **forecast_id** | **String** | The id of the associated forecast | |
+| **priority** | **Integer** | The priority in which the modification is applied | |
+| **metric** | **String** | The metric the modification is appied to | |
+| **modification_type** | **String** | The type of modification | |
+| **modification_value** | **Float** | The value of the modification | |
+| **start_date** | **DateTime** | The start of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **end_date** | **DateTime** | The end of the modified time period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
+| **attributes** | [**ForecastFilterAttributes**](ForecastFilterAttributes.html) | The filters for the modification | |
+| **enabled** | **BOOLEAN** | Determined if the modification is currently applied | [default to false]|
+| **notes** | **String** | Any notes associated with the modification | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}

data/doc_out/ForecastSearchCriteria.html.md ADDED

@@ -0,0 +1,20 @@
+---
+title: ForecastSearchCriteria
+---
+## PureCloud::ForecastSearchCriteria
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **end_value** | **String** | The end value of the range. This field is used for range search types. | [optional] |
+| **values** | **Array&lt;String&gt;** | A list of values for the search to match against | [optional] |
+| **start_value** | **String** | The start value of the range. This field is used for range search types. | [optional] |
+| **fields** | **Array&lt;String&gt;** | Field names to search against | [optional] |
+| **value** | **String** | A value for the search to match against | [optional] |
+| **operator** | **String** | How to apply this search criteria against other criteria | [optional] |
+| **group** | [**Array&lt;ForecastSearchCriteria&gt;**](ForecastSearchCriteria.html) | Groups multiple conditions | [optional] |
+| **type** | **String** | Search Type | |
+{: class="table table-striped"}

data/doc_out/ForecastSearchRequest.html.md ADDED

@@ -0,0 +1,20 @@
+---
+title: ForecastSearchRequest
+---
+## PureCloud::ForecastSearchRequest
+## Properties
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **sort_order** | **String** | The sort order for results | [optional] |
+| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
+| **page_size** | **Integer** | The number of results per page | [optional] |
+| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
+| **return_fields** | **Array&lt;String&gt;** | A List of strings containing the resource field paths that you want to return | [optional] |
+| **expand** | **Array&lt;String&gt;** | Provides more details about a specified resource | [optional] |
+| **types** | **Array&lt;String&gt;** | Resource type | |
+| **query** | [**Array&lt;ForecastSearchCriteria&gt;**](ForecastSearchCriteria.html) |  | [optional] |
+{: class="table table-striped"}

data/doc_out/GroupEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: GroupEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/GroupsApi.html.md CHANGED

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 |[**delete_group_id**](GroupsApi.html#delete_group_id) | **DELETE** /api/v2/groups/{groupId} | Delete group|
 |[**delete_group_id_members**](GroupsApi.html#delete_group_id_members) | **DELETE** /api/v2/groups/{groupId}/members | Remove members|
+|[**get_fieldconfig**](GroupsApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
 |[**get_group_id**](GroupsApi.html#get_group_id) | **GET** /api/v2/groups/{groupId} | Get group|
 |[**get_group_id_members**](GroupsApi.html#get_group_id_members) | **GET** /api/v2/groups/{groupId}/members | Get group members|
 |[**get_groups**](GroupsApi.html#get_groups) | **GET** /api/v2/groups | Get a group list|
@@ -134,6 +135,62 @@ nil (empty response body)
+<a name="get_fieldconfig"></a>
+## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
+Fetch field config for an entity type
+### Example
+~~~ruby
+# load the gem
+require 'purecloud'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+api_instance = PureCloud::GroupsApi.new
+type = "type_example" # String | Field type
+begin
+  #Fetch field config for an entity type
+  result = api_instance.get_fieldconfig(type)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling GroupsApi->get_fieldconfig: #{e}"
+end
+~~~
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**| Field type |
+{: class="table table-striped"}
+### Return type
+[**FieldConfig**](FieldConfig.html)
+### HTTP request headers
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 <a name="get_group_id"></a>
 ## -[**Group**](Group.html) get_group_id(group_id)

data/doc_out/HeartBeatAlertContainer.html.md CHANGED

@@ -11,11 +11,11 @@ title: HeartBeatAlertContainer
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/HeartBeatRuleContainer.html.md CHANGED

@@ -11,11 +11,11 @@ title: HeartBeatRuleContainer
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/InboundDomainEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: InboundDomainEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/InboundRouteEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: InboundRouteEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/InteractionStatsAlertContainer.html.md CHANGED

@@ -11,11 +11,11 @@ title: InteractionStatsAlertContainer
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/InteractionStatsRuleContainer.html.md CHANGED

@@ -11,11 +11,11 @@ title: InteractionStatsRuleContainer
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/JsonNode.html.md CHANGED

@@ -7,8 +7,6 @@ title: JsonNode
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **array** | **BOOLEAN** |  | [optional] [default to false]|
-| **null** | **BOOLEAN** |  | [optional] [default to false]|
 | **node_type** | **String** |  | [optional] |
 | **object** | **BOOLEAN** |  | [optional] [default to false]|
 | **boolean** | **BOOLEAN** |  | [optional] [default to false]|
@@ -17,9 +15,9 @@ title: JsonNode
 | **value_node** | **BOOLEAN** |  | [optional] [default to false]|
 | **container_node** | **BOOLEAN** |  | [optional] [default to false]|
 | **missing_node** | **BOOLEAN** |  | [optional] [default to false]|
+| **binary** | **BOOLEAN** |  | [optional] [default to false]|
 | **pojo** | **BOOLEAN** |  | [optional] [default to false]|
 | **integral_number** | **BOOLEAN** |  | [optional] [default to false]|
-| **floating_point_number** | **BOOLEAN** |  | [optional] [default to false]|
 | **short** | **BOOLEAN** |  | [optional] [default to false]|
 | **int** | **BOOLEAN** |  | [optional] [default to false]|
 | **long** | **BOOLEAN** |  | [optional] [default to false]|
@@ -27,7 +25,9 @@ title: JsonNode
 | **big_decimal** | **BOOLEAN** |  | [optional] [default to false]|
 | **big_integer** | **BOOLEAN** |  | [optional] [default to false]|
 | **textual** | **BOOLEAN** |  | [optional] [default to false]|
-| **binary** | **BOOLEAN** |  | [optional] [default to false]|
+| **floating_point_number** | **BOOLEAN** |  | [optional] [default to false]|
+| **array** | **BOOLEAN** |  | [optional] [default to false]|
+| **null** | **BOOLEAN** |  | [optional] [default to false]|
 {: class="table table-striped"}

data/doc_out/KeywordSetEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: KeywordSetEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/LanguageEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: LanguageEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/LibraryEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: LibraryEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/doc_out/LineBaseEntityListing.html.md CHANGED

@@ -11,11 +11,11 @@ title: LineBaseEntityListing
 | **page_size** | **Integer** |  | [optional] |
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
-| **last_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}