purecloudplatformclientv2 32.0.0 → 33.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AdminTimeOffRequestPatch.md +19 -0
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuthorizationApi.md +6 -6
- data/docs/AuthzDivision.md +18 -0
- data/docs/AvailableTopic.md +1 -1
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/Campaign.md +1 -0
- data/docs/CampaignDiagnostics.md +1 -0
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/CertificateDetails.md +1 -1
- data/docs/Channel.md +1 -1
- data/docs/ChannelTopic.md +1 -1
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactColumnTimeZone.md +2 -0
- data/docs/ContactList.md +3 -1
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ContactPhoneNumberColumn.md +1 -1
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerAction.md +1 -1
- data/docs/DialerContact.md +1 -0
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/Digits.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/DomainPermission.md +1 -0
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EndpointEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalContact.md +1 -1
- data/docs/ExternalOrganization.md +1 -1
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/Flow.md +1 -0
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +2 -2
- data/docs/IVREntityListing.md +2 -2
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/IntegrationsApi.md +16 -16
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +3 -3
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/OutboundSettings.md +2 -0
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityApi.md +18 -18
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/RecipientListing.md +2 -2
- data/docs/RecordingApi.md +4 -4
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +2 -2
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeOffRequestList.md +1 -1
- data/docs/{TimeOffRequest.md → TimeOffRequestResponse.md} +15 -15
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSchedule.md +3 -0
- data/docs/UserScheduleActivity.md +1 -0
- data/docs/UserScheduleFullDayTimeOffMarker.md +2 -1
- data/docs/UserScheduleShift.md +3 -0
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/ViewFilter.md +1 -0
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WorkforceManagementApi.md +89 -19
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/docs/{Entity.md → WritableEntity.md} +2 -2
- data/lib/purecloudplatformclientv2.rb +4 -12
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/groups_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/quality_api.rb +18 -18
- data/lib/purecloudplatformclientv2/api/recording_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +110 -17
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{platform.rb → admin_time_off_request_patch.rb} +165 -20
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{paged_listing_entity.rb → authz_division.rb} +69 -34
- data/lib/purecloudplatformclientv2/models/available_topic.rb +0 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_participant.rb +44 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign.rb +27 -1
- data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +30 -4
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/channel.rb +0 -1
- data/lib/purecloudplatformclientv2/models/channel_topic.rb +0 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +68 -2
- data/lib/purecloudplatformclientv2/models/contact_list.rb +54 -2
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_phone_number_column.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialer_action.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dialer_contact.rb +29 -1
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/digits.rb +1 -6
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_permission.rb +29 -4
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/external_contact.rb +1 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +1 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow.rb +26 -1
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/json_node.rb +53 -53
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_settings.rb +67 -1
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_off_request_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request.rb → time_off_request_response.rb} +51 -80
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_schedule.rb +87 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +30 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +31 -5
- data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +82 -4
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/view_filter.rb +32 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{entity.rb → writable_entity.rb} +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +11 -27
- data/docs/AppFoundryApi.md +0 -229
- data/docs/AppFoundryListing.md +0 -36
- data/docs/AppFoundryListingCategory.md +0 -14
- data/docs/AppFoundryListingRegistryInfo.md +0 -14
- data/docs/LocalizedField.md +0 -12
- data/docs/MarketingInfo.md +0 -14
- data/docs/PagedListingEntity.md +0 -17
- data/docs/Platform.md +0 -14
- data/docs/PricingOption.md +0 -14
- data/docs/SmartCase.md +0 -14
- data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +0 -360
- data/lib/purecloudplatformclientv2/models/app_foundry_listing.rb +0 -815
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +0 -231
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +0 -231
- data/lib/purecloudplatformclientv2/models/localized_field.rb +0 -177
- data/lib/purecloudplatformclientv2/models/marketing_info.rb +0 -229
- data/lib/purecloudplatformclientv2/models/pricing_option.rb +0 -234
- data/lib/purecloudplatformclientv2/models/smart_case.rb +0 -229
data/docs/AppFoundryApi.md
DELETED
|
@@ -1,229 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: AppFoundryApi
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
## PureCloud::AppFoundryApi
|
|
6
|
-
|
|
7
|
-
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
-
|
|
9
|
-
Method | Description
|
|
10
|
-
------------- | ------------- | -------------
|
|
11
|
-
[**get_appfoundry_platform_name_categories**](AppFoundryApi.html#get_appfoundry_platform_name_categories) | Return a structured hierarchy of available listing categories
|
|
12
|
-
[**get_appfoundry_platform_name_category**](AppFoundryApi.html#get_appfoundry_platform_name_category) | Get listings that are part of the specified root category or a contained subcategory
|
|
13
|
-
[**get_appfoundry_platform_name_category_sub_category_name**](AppFoundryApi.html#get_appfoundry_platform_name_category_sub_category_name) | Get listings that are part of the specified subcategory
|
|
14
|
-
{: class="table table-striped"}
|
|
15
|
-
|
|
16
|
-
<a name="get_appfoundry_platform_name_categories"></a>
|
|
17
|
-
|
|
18
|
-
## -[**Array<AppFoundryListingCategory>**](AppFoundryListingCategory.html) get_appfoundry_platform_name_categories(platform_name)
|
|
19
|
-
|
|
20
|
-
Return a structured hierarchy of available listing categories
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
Wraps GET /api/v2/appfoundry/{platformName}/categories
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
### Example
|
|
28
|
-
~~~ruby
|
|
29
|
-
# load the gem
|
|
30
|
-
require 'purecloudplatformclientv2'
|
|
31
|
-
# setup authorization
|
|
32
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
33
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
34
|
-
environment = "mypurecloud.com"
|
|
35
|
-
|
|
36
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
37
|
-
|
|
38
|
-
PureCloud.configure do |config|
|
|
39
|
-
config.access_token = @authToken
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
api_instance = PureCloud::AppFoundryApi.new
|
|
43
|
-
|
|
44
|
-
platform_name = "platform_name_example" # String |
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
begin
|
|
48
|
-
#Return a structured hierarchy of available listing categories
|
|
49
|
-
result = api_instance.get_appfoundry_platform_name_categories(platform_name)
|
|
50
|
-
p result
|
|
51
|
-
rescue PureCloud::ApiError => e
|
|
52
|
-
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_categories: #{e}"
|
|
53
|
-
end
|
|
54
|
-
~~~
|
|
55
|
-
|
|
56
|
-
### Parameters
|
|
57
|
-
|
|
58
|
-
Name | Type | Description | Notes
|
|
59
|
-
------------- | ------------- | ------------- | -------------
|
|
60
|
-
**platform_name** | **String**| | |
|
|
61
|
-
{: class="table table-striped"}
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
### Return type
|
|
65
|
-
|
|
66
|
-
[**Array<AppFoundryListingCategory>**](AppFoundryListingCategory.html)
|
|
67
|
-
|
|
68
|
-
### HTTP request headers
|
|
69
|
-
|
|
70
|
-
- **Content-Type**: application/json
|
|
71
|
-
- **Accept**: application/json
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
<a name="get_appfoundry_platform_name_category"></a>
|
|
76
|
-
|
|
77
|
-
## -[**PagedListingEntity**](PagedListingEntity.html) get_appfoundry_platform_name_category(platform_name, category_name, opts)
|
|
78
|
-
|
|
79
|
-
Get listings that are part of the specified root category or a contained subcategory
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
Wraps GET /api/v2/appfoundry/{platformName}/categories/{categoryName}
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
### Example
|
|
87
|
-
~~~ruby
|
|
88
|
-
# load the gem
|
|
89
|
-
require 'purecloudplatformclientv2'
|
|
90
|
-
# setup authorization
|
|
91
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
92
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
93
|
-
environment = "mypurecloud.com"
|
|
94
|
-
|
|
95
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
96
|
-
|
|
97
|
-
PureCloud.configure do |config|
|
|
98
|
-
config.access_token = @authToken
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
api_instance = PureCloud::AppFoundryApi.new
|
|
102
|
-
|
|
103
|
-
platform_name = "platform_name_example" # String |
|
|
104
|
-
|
|
105
|
-
category_name = "category_name_example" # String | Name of category to request listings from
|
|
106
|
-
|
|
107
|
-
opts = {
|
|
108
|
-
page_size: 25, # Integer | The total page size requested
|
|
109
|
-
page_number: 1, # Integer | The page number requested
|
|
110
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
111
|
-
expand: nil, # Array<Object> | variable name requested by expand list
|
|
112
|
-
next_page: "next_page_example", # String | next page token
|
|
113
|
-
previous_page: "previous_page_example" # String | Previous page token
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
begin
|
|
117
|
-
#Get listings that are part of the specified root category or a contained subcategory
|
|
118
|
-
result = api_instance.get_appfoundry_platform_name_category(platform_name, category_name, opts)
|
|
119
|
-
p result
|
|
120
|
-
rescue PureCloud::ApiError => e
|
|
121
|
-
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_category: #{e}"
|
|
122
|
-
end
|
|
123
|
-
~~~
|
|
124
|
-
|
|
125
|
-
### Parameters
|
|
126
|
-
|
|
127
|
-
Name | Type | Description | Notes
|
|
128
|
-
------------- | ------------- | ------------- | -------------
|
|
129
|
-
**platform_name** | **String**| | |
|
|
130
|
-
**category_name** | **String**| Name of category to request listings from | |
|
|
131
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
132
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
133
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
134
|
-
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
135
|
-
**next_page** | **String**| next page token | [optional] |
|
|
136
|
-
**previous_page** | **String**| Previous page token | [optional] |
|
|
137
|
-
{: class="table table-striped"}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
### Return type
|
|
141
|
-
|
|
142
|
-
[**PagedListingEntity**](PagedListingEntity.html)
|
|
143
|
-
|
|
144
|
-
### HTTP request headers
|
|
145
|
-
|
|
146
|
-
- **Content-Type**: application/json
|
|
147
|
-
- **Accept**: application/json
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
<a name="get_appfoundry_platform_name_category_sub_category_name"></a>
|
|
152
|
-
|
|
153
|
-
## -[**PagedListingEntity**](PagedListingEntity.html) get_appfoundry_platform_name_category_sub_category_name(platform_name, category_name, sub_category_name, opts)
|
|
154
|
-
|
|
155
|
-
Get listings that are part of the specified subcategory
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
Wraps GET /api/v2/appfoundry/{platformName}/categories/{categoryName}/{subCategoryName}
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
### Example
|
|
163
|
-
~~~ruby
|
|
164
|
-
# load the gem
|
|
165
|
-
require 'purecloudplatformclientv2'
|
|
166
|
-
# setup authorization
|
|
167
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
168
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
169
|
-
environment = "mypurecloud.com"
|
|
170
|
-
|
|
171
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
172
|
-
|
|
173
|
-
PureCloud.configure do |config|
|
|
174
|
-
config.access_token = @authToken
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
api_instance = PureCloud::AppFoundryApi.new
|
|
178
|
-
|
|
179
|
-
platform_name = "platform_name_example" # String |
|
|
180
|
-
|
|
181
|
-
category_name = "category_name_example" # String | Name of category to request listings from
|
|
182
|
-
|
|
183
|
-
sub_category_name = "sub_category_name_example" # String | Name of subcategory to request listings from
|
|
184
|
-
|
|
185
|
-
opts = {
|
|
186
|
-
page_size: 25, # Integer | The total page size requested
|
|
187
|
-
page_number: 1, # Integer | The page number requested
|
|
188
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
|
189
|
-
expand: nil, # Array<Object> | variable name requested by expand list
|
|
190
|
-
next_page: "next_page_example", # String | next page token
|
|
191
|
-
previous_page: "previous_page_example" # String | Previous page token
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
begin
|
|
195
|
-
#Get listings that are part of the specified subcategory
|
|
196
|
-
result = api_instance.get_appfoundry_platform_name_category_sub_category_name(platform_name, category_name, sub_category_name, opts)
|
|
197
|
-
p result
|
|
198
|
-
rescue PureCloud::ApiError => e
|
|
199
|
-
puts "Exception when calling AppFoundryApi->get_appfoundry_platform_name_category_sub_category_name: #{e}"
|
|
200
|
-
end
|
|
201
|
-
~~~
|
|
202
|
-
|
|
203
|
-
### Parameters
|
|
204
|
-
|
|
205
|
-
Name | Type | Description | Notes
|
|
206
|
-
------------- | ------------- | ------------- | -------------
|
|
207
|
-
**platform_name** | **String**| | |
|
|
208
|
-
**category_name** | **String**| Name of category to request listings from | |
|
|
209
|
-
**sub_category_name** | **String**| Name of subcategory to request listings from | |
|
|
210
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
|
211
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
|
212
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
|
213
|
-
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
|
214
|
-
**next_page** | **String**| next page token | [optional] |
|
|
215
|
-
**previous_page** | **String**| Previous page token | [optional] |
|
|
216
|
-
{: class="table table-striped"}
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
### Return type
|
|
220
|
-
|
|
221
|
-
[**PagedListingEntity**](PagedListingEntity.html)
|
|
222
|
-
|
|
223
|
-
### HTTP request headers
|
|
224
|
-
|
|
225
|
-
- **Content-Type**: application/json
|
|
226
|
-
- **Accept**: application/json
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
data/docs/AppFoundryListing.md
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: AppFoundryListing
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::AppFoundryListing
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
-
| **name** | [**LocalizedField**](LocalizedField.html) | Localized name | [optional] |
|
|
12
|
-
| **registry_info** | [**AppFoundryListingRegistryInfo**](AppFoundryListingRegistryInfo.html) | Provides information about the integration implementation | [optional] |
|
|
13
|
-
| **marketing_info** | [**MarketingInfo**](MarketingInfo.html) | Marketing data | [optional] |
|
|
14
|
-
| **tagline** | [**LocalizedField**](LocalizedField.html) | Localized tagline | [optional] |
|
|
15
|
-
| **brief_description** | [**LocalizedField**](LocalizedField.html) | Localized short description | [optional] |
|
|
16
|
-
| **full_description** | [**LocalizedField**](LocalizedField.html) | Localized full description | [optional] |
|
|
17
|
-
| **platform** | [**Platform**](Platform.html) | The supported platform | [optional] |
|
|
18
|
-
| **company_logo** | **String** | URL to the company logo to be displayed | [optional] |
|
|
19
|
-
| **app_logo** | **String** | URL to the app logo to be displayed | [optional] |
|
|
20
|
-
| **company_name** | [**LocalizedField**](LocalizedField.html) | Localized company name for the listing publisher | [optional] |
|
|
21
|
-
| **website** | [**LocalizedField**](LocalizedField.html) | Localized URL to the website associated with the listing | [optional] |
|
|
22
|
-
| **screenshots** | **Array<String>** | Screenshot URLS | [optional] |
|
|
23
|
-
| **video_links** | **Array<String>** | Usage video URLS | [optional] |
|
|
24
|
-
| **languages** | **Array<String>** | Indicates the languages that the application supports. Supported application languages may differ from the listing localization languages | [optional] |
|
|
25
|
-
| **vendor_email** | **String** | Contact email for the listing publisher | [optional] |
|
|
26
|
-
| **terms_of_service** | **String** | URL to the terms of service | [optional] |
|
|
27
|
-
| **help_documentation_url** | [**LocalizedField**](LocalizedField.html) | URL to help documentation | [optional] |
|
|
28
|
-
| **marketing_url** | [**LocalizedField**](LocalizedField.html) | URL to external marketing page | [optional] |
|
|
29
|
-
| **industries** | **Array<String>** | Industries targeted | [optional] |
|
|
30
|
-
| **categories** | **Array<String>** | Indicated the categories the listing belongs to | [optional] |
|
|
31
|
-
| **smart_cases** | [**Array<SmartCase>**](SmartCase.html) | Use cases the listing is meant to address | [optional] |
|
|
32
|
-
| **pricing** | [**Array<PricingOption>**](PricingOption.html) | Pricing options for the listing | [optional] |
|
|
33
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
34
|
-
{: class="table table-striped"}
|
|
35
|
-
|
|
36
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: AppFoundryListingCategory
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::AppFoundryListingCategory
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **name** | **String** | Name of the category | [optional] |
|
|
11
|
-
| **sub_categories** | **Array<String>** | Subcategories under this category | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: AppFoundryListingRegistryInfo
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::AppFoundryListingRegistryInfo
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The ID of the integration registry entry that is represented by the listing | [optional] |
|
|
11
|
-
| **regions** | **Array<String>** | Supported regions where the listing may be installed | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
data/docs/LocalizedField.md
DELETED
data/docs/MarketingInfo.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: MarketingInfo
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::MarketingInfo
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaign_id** | **String** | The marketing campaign ID | [optional] |
|
|
11
|
-
| **form_id** | **String** | The ID of an associated marketing form | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
data/docs/PagedListingEntity.md
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: PagedListingEntity
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::PagedListingEntity
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **entities** | [**Array<AppFoundryListing>**](AppFoundryListing.html) | | [optional] |
|
|
11
|
-
| **page_size** | **Integer** | | [optional] |
|
|
12
|
-
| **page_number** | **Integer** | | [optional] |
|
|
13
|
-
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **page_count** | **Integer** | | [optional] |
|
|
15
|
-
{: class="table table-striped"}
|
|
16
|
-
|
|
17
|
-
|
data/docs/Platform.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Platform
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::Platform
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **name** | **String** | Name of the platform | |
|
|
11
|
-
| **subcategories** | **Array<String>** | Platform subcategories, eg, on-prem or cloud | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
data/docs/PricingOption.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: PricingOption
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::PricingOption
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **price** | [**LocalizedField**](LocalizedField.html) | The price | |
|
|
11
|
-
| **description** | [**LocalizedField**](LocalizedField.html) | Description explaining pricing option | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
data/docs/SmartCase.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: SmartCase
|
|
3
|
-
---
|
|
4
|
-
## PureCloud::SmartCase
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
|Name | Type | Description | Notes|
|
|
9
|
-
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **title** | [**LocalizedField**](LocalizedField.html) | Title of the use case | [optional] |
|
|
11
|
-
| **description** | [**LocalizedField**](LocalizedField.html) | Description of how the listing meets the use case | [optional] |
|
|
12
|
-
{: class="table table-striped"}
|
|
13
|
-
|
|
14
|
-
|
|
@@ -1,360 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
PureCloud Platform API
|
|
3
|
-
|
|
4
|
-
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
|
5
|
-
|
|
6
|
-
OpenAPI spec version: v2
|
|
7
|
-
Contact: DeveloperEvangelists@genesys.com
|
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
-
|
|
10
|
-
License: ININ
|
|
11
|
-
http://www.inin.com
|
|
12
|
-
|
|
13
|
-
Terms of Service: https://developer.mypurecloud.com/tos
|
|
14
|
-
|
|
15
|
-
=end
|
|
16
|
-
|
|
17
|
-
require "uri"
|
|
18
|
-
|
|
19
|
-
module PureCloud
|
|
20
|
-
class AppFoundryApi
|
|
21
|
-
attr_accessor :api_client
|
|
22
|
-
|
|
23
|
-
def initialize(api_client = ApiClient.default)
|
|
24
|
-
@api_client = api_client
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
# Return a structured hierarchy of available listing categories
|
|
28
|
-
#
|
|
29
|
-
# @param platform_name
|
|
30
|
-
# @param [Hash] opts the optional parameters
|
|
31
|
-
# @return [Array<AppFoundryListingCategory>]
|
|
32
|
-
def get_appfoundry_platform_name_categories(platform_name, opts = {})
|
|
33
|
-
data, _status_code, _headers = get_appfoundry_platform_name_categories_with_http_info(platform_name, opts)
|
|
34
|
-
return data
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
# Return a structured hierarchy of available listing categories
|
|
38
|
-
#
|
|
39
|
-
# @param platform_name
|
|
40
|
-
# @param [Hash] opts the optional parameters
|
|
41
|
-
# @return [Array<(Array<AppFoundryListingCategory>, Fixnum, Hash)>] Array<AppFoundryListingCategory> data, response status code and response headers
|
|
42
|
-
def get_appfoundry_platform_name_categories_with_http_info(platform_name, opts = {})
|
|
43
|
-
if @api_client.config.debugging
|
|
44
|
-
@api_client.config.logger.debug "Calling API: AppFoundryApi.get_appfoundry_platform_name_categories ..."
|
|
45
|
-
end
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
# verify the required parameter 'platform_name' is set
|
|
49
|
-
fail ArgumentError, "Missing the required parameter 'platform_name' when calling AppFoundryApi.get_appfoundry_platform_name_categories" if platform_name.nil?
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
# resource path
|
|
56
|
-
local_var_path = "/api/v2/appfoundry/{platformName}/categories".sub('{format}','json').sub('{' + 'platformName' + '}', platform_name.to_s)
|
|
57
|
-
|
|
58
|
-
# query parameters
|
|
59
|
-
query_params = {}
|
|
60
|
-
|
|
61
|
-
# header parameters
|
|
62
|
-
header_params = {}
|
|
63
|
-
|
|
64
|
-
# HTTP header 'Accept' (if needed)
|
|
65
|
-
local_header_accept = ['application/json']
|
|
66
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
67
|
-
|
|
68
|
-
# HTTP header 'Content-Type'
|
|
69
|
-
local_header_content_type = ['application/json']
|
|
70
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
71
|
-
|
|
72
|
-
# form parameters
|
|
73
|
-
form_params = {}
|
|
74
|
-
|
|
75
|
-
# http body (model)
|
|
76
|
-
post_body = nil
|
|
77
|
-
|
|
78
|
-
auth_names = ['PureCloud Auth']
|
|
79
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
80
|
-
:header_params => header_params,
|
|
81
|
-
:query_params => query_params,
|
|
82
|
-
:form_params => form_params,
|
|
83
|
-
:body => post_body,
|
|
84
|
-
:auth_names => auth_names,
|
|
85
|
-
:return_type => 'Array<AppFoundryListingCategory>')
|
|
86
|
-
if @api_client.config.debugging
|
|
87
|
-
@api_client.config.logger.debug "API called: AppFoundryApi#get_appfoundry_platform_name_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
88
|
-
end
|
|
89
|
-
return data, status_code, headers
|
|
90
|
-
end
|
|
91
|
-
|
|
92
|
-
# Get listings that are part of the specified root category or a contained subcategory
|
|
93
|
-
#
|
|
94
|
-
# @param platform_name
|
|
95
|
-
# @param category_name Name of category to request listings from
|
|
96
|
-
# @param [Hash] opts the optional parameters
|
|
97
|
-
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
98
|
-
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
99
|
-
# @option opts [String] :sort_by variable name requested to sort by
|
|
100
|
-
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
101
|
-
# @option opts [String] :next_page next page token
|
|
102
|
-
# @option opts [String] :previous_page Previous page token
|
|
103
|
-
# @return [PagedListingEntity]
|
|
104
|
-
def get_appfoundry_platform_name_category(platform_name, category_name, opts = {})
|
|
105
|
-
data, _status_code, _headers = get_appfoundry_platform_name_category_with_http_info(platform_name, category_name, opts)
|
|
106
|
-
return data
|
|
107
|
-
end
|
|
108
|
-
|
|
109
|
-
# Get listings that are part of the specified root category or a contained subcategory
|
|
110
|
-
#
|
|
111
|
-
# @param platform_name
|
|
112
|
-
# @param category_name Name of category to request listings from
|
|
113
|
-
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @option opts [Integer] :page_size The total page size requested
|
|
115
|
-
# @option opts [Integer] :page_number The page number requested
|
|
116
|
-
# @option opts [String] :sort_by variable name requested to sort by
|
|
117
|
-
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
118
|
-
# @option opts [String] :next_page next page token
|
|
119
|
-
# @option opts [String] :previous_page Previous page token
|
|
120
|
-
# @return [Array<(PagedListingEntity, Fixnum, Hash)>] PagedListingEntity data, response status code and response headers
|
|
121
|
-
def get_appfoundry_platform_name_category_with_http_info(platform_name, category_name, opts = {})
|
|
122
|
-
if @api_client.config.debugging
|
|
123
|
-
@api_client.config.logger.debug "Calling API: AppFoundryApi.get_appfoundry_platform_name_category ..."
|
|
124
|
-
end
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
# verify the required parameter 'platform_name' is set
|
|
128
|
-
fail ArgumentError, "Missing the required parameter 'platform_name' when calling AppFoundryApi.get_appfoundry_platform_name_category" if platform_name.nil?
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
# verify the required parameter 'category_name' is set
|
|
136
|
-
fail ArgumentError, "Missing the required parameter 'category_name' when calling AppFoundryApi.get_appfoundry_platform_name_category" if category_name.nil?
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
# resource path
|
|
179
|
-
local_var_path = "/api/v2/appfoundry/{platformName}/categories/{categoryName}".sub('{format}','json').sub('{' + 'platformName' + '}', platform_name.to_s).sub('{' + 'categoryName' + '}', category_name.to_s)
|
|
180
|
-
|
|
181
|
-
# query parameters
|
|
182
|
-
query_params = {}
|
|
183
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
184
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
185
|
-
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
186
|
-
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
|
187
|
-
query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
|
|
188
|
-
query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
|
|
189
|
-
|
|
190
|
-
# header parameters
|
|
191
|
-
header_params = {}
|
|
192
|
-
|
|
193
|
-
# HTTP header 'Accept' (if needed)
|
|
194
|
-
local_header_accept = ['application/json']
|
|
195
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
196
|
-
|
|
197
|
-
# HTTP header 'Content-Type'
|
|
198
|
-
local_header_content_type = ['application/json']
|
|
199
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
200
|
-
|
|
201
|
-
# form parameters
|
|
202
|
-
form_params = {}
|
|
203
|
-
|
|
204
|
-
# http body (model)
|
|
205
|
-
post_body = nil
|
|
206
|
-
|
|
207
|
-
auth_names = ['PureCloud Auth']
|
|
208
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
209
|
-
:header_params => header_params,
|
|
210
|
-
:query_params => query_params,
|
|
211
|
-
:form_params => form_params,
|
|
212
|
-
:body => post_body,
|
|
213
|
-
:auth_names => auth_names,
|
|
214
|
-
:return_type => 'PagedListingEntity')
|
|
215
|
-
if @api_client.config.debugging
|
|
216
|
-
@api_client.config.logger.debug "API called: AppFoundryApi#get_appfoundry_platform_name_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
-
end
|
|
218
|
-
return data, status_code, headers
|
|
219
|
-
end
|
|
220
|
-
|
|
221
|
-
# Get listings that are part of the specified subcategory
|
|
222
|
-
#
|
|
223
|
-
# @param platform_name
|
|
224
|
-
# @param category_name Name of category to request listings from
|
|
225
|
-
# @param sub_category_name Name of subcategory to request listings from
|
|
226
|
-
# @param [Hash] opts the optional parameters
|
|
227
|
-
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
228
|
-
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
229
|
-
# @option opts [String] :sort_by variable name requested to sort by
|
|
230
|
-
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
231
|
-
# @option opts [String] :next_page next page token
|
|
232
|
-
# @option opts [String] :previous_page Previous page token
|
|
233
|
-
# @return [PagedListingEntity]
|
|
234
|
-
def get_appfoundry_platform_name_category_sub_category_name(platform_name, category_name, sub_category_name, opts = {})
|
|
235
|
-
data, _status_code, _headers = get_appfoundry_platform_name_category_sub_category_name_with_http_info(platform_name, category_name, sub_category_name, opts)
|
|
236
|
-
return data
|
|
237
|
-
end
|
|
238
|
-
|
|
239
|
-
# Get listings that are part of the specified subcategory
|
|
240
|
-
#
|
|
241
|
-
# @param platform_name
|
|
242
|
-
# @param category_name Name of category to request listings from
|
|
243
|
-
# @param sub_category_name Name of subcategory to request listings from
|
|
244
|
-
# @param [Hash] opts the optional parameters
|
|
245
|
-
# @option opts [Integer] :page_size The total page size requested
|
|
246
|
-
# @option opts [Integer] :page_number The page number requested
|
|
247
|
-
# @option opts [String] :sort_by variable name requested to sort by
|
|
248
|
-
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
249
|
-
# @option opts [String] :next_page next page token
|
|
250
|
-
# @option opts [String] :previous_page Previous page token
|
|
251
|
-
# @return [Array<(PagedListingEntity, Fixnum, Hash)>] PagedListingEntity data, response status code and response headers
|
|
252
|
-
def get_appfoundry_platform_name_category_sub_category_name_with_http_info(platform_name, category_name, sub_category_name, opts = {})
|
|
253
|
-
if @api_client.config.debugging
|
|
254
|
-
@api_client.config.logger.debug "Calling API: AppFoundryApi.get_appfoundry_platform_name_category_sub_category_name ..."
|
|
255
|
-
end
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
# verify the required parameter 'platform_name' is set
|
|
259
|
-
fail ArgumentError, "Missing the required parameter 'platform_name' when calling AppFoundryApi.get_appfoundry_platform_name_category_sub_category_name" if platform_name.nil?
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
# verify the required parameter 'category_name' is set
|
|
267
|
-
fail ArgumentError, "Missing the required parameter 'category_name' when calling AppFoundryApi.get_appfoundry_platform_name_category_sub_category_name" if category_name.nil?
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
# verify the required parameter 'sub_category_name' is set
|
|
275
|
-
fail ArgumentError, "Missing the required parameter 'sub_category_name' when calling AppFoundryApi.get_appfoundry_platform_name_category_sub_category_name" if sub_category_name.nil?
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
# resource path
|
|
318
|
-
local_var_path = "/api/v2/appfoundry/{platformName}/categories/{categoryName}/{subCategoryName}".sub('{format}','json').sub('{' + 'platformName' + '}', platform_name.to_s).sub('{' + 'categoryName' + '}', category_name.to_s).sub('{' + 'subCategoryName' + '}', sub_category_name.to_s)
|
|
319
|
-
|
|
320
|
-
# query parameters
|
|
321
|
-
query_params = {}
|
|
322
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
323
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
324
|
-
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
325
|
-
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
|
326
|
-
query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
|
|
327
|
-
query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
|
|
328
|
-
|
|
329
|
-
# header parameters
|
|
330
|
-
header_params = {}
|
|
331
|
-
|
|
332
|
-
# HTTP header 'Accept' (if needed)
|
|
333
|
-
local_header_accept = ['application/json']
|
|
334
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
335
|
-
|
|
336
|
-
# HTTP header 'Content-Type'
|
|
337
|
-
local_header_content_type = ['application/json']
|
|
338
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
339
|
-
|
|
340
|
-
# form parameters
|
|
341
|
-
form_params = {}
|
|
342
|
-
|
|
343
|
-
# http body (model)
|
|
344
|
-
post_body = nil
|
|
345
|
-
|
|
346
|
-
auth_names = ['PureCloud Auth']
|
|
347
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
348
|
-
:header_params => header_params,
|
|
349
|
-
:query_params => query_params,
|
|
350
|
-
:form_params => form_params,
|
|
351
|
-
:body => post_body,
|
|
352
|
-
:auth_names => auth_names,
|
|
353
|
-
:return_type => 'PagedListingEntity')
|
|
354
|
-
if @api_client.config.debugging
|
|
355
|
-
@api_client.config.logger.debug "API called: AppFoundryApi#get_appfoundry_platform_name_category_sub_category_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
356
|
-
end
|
|
357
|
-
return data, status_code, headers
|
|
358
|
-
end
|
|
359
|
-
end
|
|
360
|
-
end
|