Skip to content

Commit 3ac7fce

Browse files
author
PureCloud Jenkins
committed
248.0.0
1 parent a1b00d9 commit 3ac7fce

6,027 files changed

Lines changed: 8538 additions & 9297 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-python/
77

8-
Documentation version PureCloudPlatformClientV2 247.0.0
8+
Documentation version PureCloudPlatformClientV2 248.0.0
99

1010
## Preview APIs
1111

@@ -379,6 +379,26 @@ worktype_update.default_queue_id = PureCloudPlatformClientV2.ApiNullValue()
379379
task_api.patch_taskmanagement_worktype(worktype_id, worktype_update)
380380
```
381381

382+
### SDK Specific Types and Classes
383+
384+
The Platform API Client SDK for Python defines some types and classes specific to the SDK.
385+
386+
#### LocalDateTime
387+
388+
`LocalDateTime` is defined as an alias of `datetime` class.
389+
390+
#### YearMonth
391+
392+
Some API Endpoints of the Platform API (REST API) contain properties defined as string with a "year-month" format (e.g. value equal to "2026-01").
393+
If part of an API Response, these properties will be deserialized to the SDK's YearMonth class.
394+
YearMonth class instance will be serialized to "year-month" string format if part of an API Request (REST API).
395+
396+
You can import the YearMonth class in your python code using: `from PureCloudPlatformClientV2 import YearMonth`
397+
398+
The YearMonth class contains two properties of integer type: **year** (allowing value from 0 to 9999) and **month** (allowing value from 1 to 12).
399+
An instance of the class can be created using the class constructor `YearMonth(year: int, month: int)` or parsing a `date` with `YearMonth.from_date(d: date)`.
400+
A YearMonth instance can also be transformed into a date (with day being forced to 1) with `my_year_month.to_date()`.
401+
382402
### Managing updates in Platform API Enumerations
383403

384404
The Platform API Client SDKs (Java, Javascript/NodeJs, Python, Go, .Net, iOS/Swift) are automatically generated using the Platform API OpenAPI v2 definition.

‎build/.openapi-generator/FILES‎

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,7 @@ PureCloudPlatformClientV2/models/audit_topic_domain_entity_ref.py
486486
PureCloudPlatformClientV2/models/audit_topic_message_info.py
487487
PureCloudPlatformClientV2/models/audit_topic_property_change.py
488488
PureCloudPlatformClientV2/models/authentication_settings.py
489+
PureCloudPlatformClientV2/models/authoring_knowledge_settings.py
489490
PureCloudPlatformClientV2/models/authorization_policy.py
490491
PureCloudPlatformClientV2/models/authorization_policy_entity_listing.py
491492
PureCloudPlatformClientV2/models/authorization_settings.py
@@ -866,7 +867,10 @@ PureCloudPlatformClientV2/models/capacity_planning_requirements_result_topic_sta
866867
PureCloudPlatformClientV2/models/capacity_plans_list_response.py
867868
PureCloudPlatformClientV2/models/card.py
868869
PureCloudPlatformClientV2/models/card_action.py
870+
PureCloudPlatformClientV2/models/card_body_text.py
869871
PureCloudPlatformClientV2/models/card_parameters.py
872+
PureCloudPlatformClientV2/models/carousel.py
873+
PureCloudPlatformClientV2/models/carousel_card.py
870874
PureCloudPlatformClientV2/models/carousel_parameters.py
871875
PureCloudPlatformClientV2/models/case_management_aggregate_data_container.py
872876
PureCloudPlatformClientV2/models/case_management_aggregate_query_clause.py
@@ -931,6 +935,7 @@ PureCloudPlatformClientV2/models/checklist_inference_job_creation_response.py
931935
PureCloudPlatformClientV2/models/checklist_inference_job_payload.py
932936
PureCloudPlatformClientV2/models/checklist_inference_job_response.py
933937
PureCloudPlatformClientV2/models/checklist_item.py
938+
PureCloudPlatformClientV2/models/chunk_search_register_request.py
934939
PureCloudPlatformClientV2/models/client_app.py
935940
PureCloudPlatformClientV2/models/client_app_configuration_info.py
936941
PureCloudPlatformClientV2/models/client_app_entity_listing.py
@@ -1374,7 +1379,6 @@ PureCloudPlatformClientV2/models/conversation_event_topic_phone_number_column.py
13741379
PureCloudPlatformClientV2/models/conversation_event_topic_queue_media_settings.py
13751380
PureCloudPlatformClientV2/models/conversation_event_topic_recorders_state.py
13761381
PureCloudPlatformClientV2/models/conversation_event_topic_scored_agent.py
1377-
PureCloudPlatformClientV2/models/conversation_event_topic_screen_monitoring.py
13781382
PureCloudPlatformClientV2/models/conversation_event_topic_screen_share.py
13791383
PureCloudPlatformClientV2/models/conversation_event_topic_social_expression.py
13801384
PureCloudPlatformClientV2/models/conversation_event_topic_transfer_destination.py
@@ -3075,6 +3079,7 @@ PureCloudPlatformClientV2/models/knowledge_parse_record.py
30753079
PureCloudPlatformClientV2/models/knowledge_search_client_application.py
30763080
PureCloudPlatformClientV2/models/knowledge_search_document_response.py
30773081
PureCloudPlatformClientV2/models/knowledge_setting.py
3082+
PureCloudPlatformClientV2/models/knowledge_settings.py
30783083
PureCloudPlatformClientV2/models/knowledge_suggestion_config.py
30793084
PureCloudPlatformClientV2/models/knowledge_sync_job_report.py
30803085
PureCloudPlatformClientV2/models/knowledge_sync_job_request.py
@@ -3862,7 +3867,6 @@ PureCloudPlatformClientV2/models/program_insights_settings.py
38623867
PureCloudPlatformClientV2/models/program_insights_settings_entity_listing.py
38633868
PureCloudPlatformClientV2/models/program_job.py
38643869
PureCloudPlatformClientV2/models/program_job_request.py
3865-
PureCloudPlatformClientV2/models/program_mappings.py
38663870
PureCloudPlatformClientV2/models/program_mappings_request.py
38673871
PureCloudPlatformClientV2/models/program_request.py
38683872
PureCloudPlatformClientV2/models/program_topic_links_test_phrase_detected_phrase.py
@@ -3872,7 +3876,6 @@ PureCloudPlatformClientV2/models/program_topic_links_topics_definitions_job.py
38723876
PureCloudPlatformClientV2/models/program_transcription_engine.py
38733877
PureCloudPlatformClientV2/models/program_transcription_engines.py
38743878
PureCloudPlatformClientV2/models/programs_entity_listing.py
3875-
PureCloudPlatformClientV2/models/programs_mappings_entity_listing.py
38763879
PureCloudPlatformClientV2/models/progress_consult_transfer_event.py
38773880
PureCloudPlatformClientV2/models/progress_transfer_event.py
38783881
PureCloudPlatformClientV2/models/prompt.py
@@ -4080,7 +4083,6 @@ PureCloudPlatformClientV2/models/queue_conversation_event_topic_phone_number_col
40804083
PureCloudPlatformClientV2/models/queue_conversation_event_topic_queue_media_settings.py
40814084
PureCloudPlatformClientV2/models/queue_conversation_event_topic_recorders_state.py
40824085
PureCloudPlatformClientV2/models/queue_conversation_event_topic_scored_agent.py
4083-
PureCloudPlatformClientV2/models/queue_conversation_event_topic_screen_monitoring.py
40844086
PureCloudPlatformClientV2/models/queue_conversation_event_topic_screen_share.py
40854087
PureCloudPlatformClientV2/models/queue_conversation_event_topic_social_expression.py
40864088
PureCloudPlatformClientV2/models/queue_conversation_event_topic_transfer_destination.py
@@ -4174,7 +4176,6 @@ PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topi
41744176
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_queue_media_settings.py
41754177
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_recorders_state.py
41764178
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_scored_agent.py
4177-
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_screen_monitoring.py
41784179
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_screen_share.py
41794180
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_social_expression.py
41804181
PureCloudPlatformClientV2/models/queue_conversation_social_expression_event_topic_transfer_destination.py
@@ -4225,7 +4226,6 @@ PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_phone_numb
42254226
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_queue_media_settings.py
42264227
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_recorders_state.py
42274228
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_scored_agent.py
4228-
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_screen_monitoring.py
42294229
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_screen_share.py
42304230
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_social_expression.py
42314231
PureCloudPlatformClientV2/models/queue_conversation_video_event_topic_transfer_destination.py
@@ -4714,8 +4714,8 @@ PureCloudPlatformClientV2/models/social_media_statistical_summary.py
47144714
PureCloudPlatformClientV2/models/social_topic_patch_request.py
47154715
PureCloudPlatformClientV2/models/social_topic_request.py
47164716
PureCloudPlatformClientV2/models/social_topic_response.py
4717-
PureCloudPlatformClientV2/models/social_topic_response_entity_listing.py
47184717
PureCloudPlatformClientV2/models/social_topic_with_data_ingestion_rule_metadata_response.py
4718+
PureCloudPlatformClientV2/models/social_topic_with_data_ingestion_rule_metadata_response_entity_listing.py
47194719
PureCloudPlatformClientV2/models/sort_item.py
47204720
PureCloudPlatformClientV2/models/source.py
47214721
PureCloudPlatformClientV2/models/source_base_response.py
@@ -4765,6 +4765,7 @@ PureCloudPlatformClientV2/models/station_entity_listing.py
47654765
PureCloudPlatformClientV2/models/statistical_response.py
47664766
PureCloudPlatformClientV2/models/statistical_summary.py
47674767
PureCloudPlatformClientV2/models/status_change.py
4768+
PureCloudPlatformClientV2/models/status_info.py
47684769
PureCloudPlatformClientV2/models/stop_settings.py
47694770
PureCloudPlatformClientV2/models/story_setting.py
47704771
PureCloudPlatformClientV2/models/street_address.py
@@ -4996,6 +4997,8 @@ PureCloudPlatformClientV2/models/topic_job_request.py
49964997
PureCloudPlatformClientV2/models/topic_offset.py
49974998
PureCloudPlatformClientV2/models/topic_phrase.py
49984999
PureCloudPlatformClientV2/models/topic_request.py
5000+
PureCloudPlatformClientV2/models/topics_definitions_program_mappings.py
5001+
PureCloudPlatformClientV2/models/topics_definitions_programs_mappings_entity_listing.py
49995002
PureCloudPlatformClientV2/models/topics_entity_listing.py
50005003
PureCloudPlatformClientV2/models/touchpoint.py
50015004
PureCloudPlatformClientV2/models/touchpoint_response.py
@@ -5951,7 +5954,6 @@ PureCloudPlatformClientV2/models/writable_dialer_contact.py
59515954
PureCloudPlatformClientV2/models/writable_division.py
59525955
PureCloudPlatformClientV2/models/writable_entity.py
59535956
PureCloudPlatformClientV2/models/writable_starrable_division.py
5954-
PureCloudPlatformClientV2/models/year_month.py
59555957
PureCloudPlatformClientV2/rest.py
59565958
README.md
59575959
docs/ADFS.md
@@ -6366,6 +6368,7 @@ docs/AuditTopicDomainEntityRef.md
63666368
docs/AuditTopicMessageInfo.md
63676369
docs/AuditTopicPropertyChange.md
63686370
docs/AuthenticationSettings.md
6371+
docs/AuthoringKnowledgeSettings.md
63696372
docs/AuthorizationApi.json
63706373
docs/AuthorizationApi.md
63716374
docs/AuthorizationPolicy.md
@@ -6752,7 +6755,10 @@ docs/CapacityPlanningRequirementsResultTopicStaffingRequirementsNotification.md
67526755
docs/CapacityPlansListResponse.md
67536756
docs/Card.md
67546757
docs/CardAction.md
6758+
docs/CardBodyText.md
67556759
docs/CardParameters.md
6760+
docs/Carousel.md
6761+
docs/CarouselCard.md
67566762
docs/CarouselParameters.md
67576763
docs/CarrierServicesApi.json
67586764
docs/CarrierServicesApi.md
@@ -6821,6 +6827,7 @@ docs/ChecklistInferenceJobCreationResponse.md
68216827
docs/ChecklistInferenceJobPayload.md
68226828
docs/ChecklistInferenceJobResponse.md
68236829
docs/ChecklistItem.md
6830+
docs/ChunkSearchRegisterRequest.md
68246831
docs/ClientApp.md
68256832
docs/ClientAppConfigurationInfo.md
68266833
docs/ClientAppEntityListing.md
@@ -7268,7 +7275,6 @@ docs/ConversationEventTopicPhoneNumberColumn.md
72687275
docs/ConversationEventTopicQueueMediaSettings.md
72697276
docs/ConversationEventTopicRecordersState.md
72707277
docs/ConversationEventTopicScoredAgent.md
7271-
docs/ConversationEventTopicScreenMonitoring.md
72727278
docs/ConversationEventTopicScreenShare.md
72737279
docs/ConversationEventTopicSocialExpression.md
72747280
docs/ConversationEventTopicTransferDestination.md
@@ -9011,6 +9017,7 @@ docs/KnowledgeParseRecord.md
90119017
docs/KnowledgeSearchClientApplication.md
90129018
docs/KnowledgeSearchDocumentResponse.md
90139019
docs/KnowledgeSetting.md
9020+
docs/KnowledgeSettings.md
90149021
docs/KnowledgeSuggestionConfig.md
90159022
docs/KnowledgeSyncJobReport.md
90169023
docs/KnowledgeSyncJobRequest.md
@@ -9832,7 +9839,6 @@ docs/ProgramInsightsSettings.md
98329839
docs/ProgramInsightsSettingsEntityListing.md
98339840
docs/ProgramJob.md
98349841
docs/ProgramJobRequest.md
9835-
docs/ProgramMappings.md
98369842
docs/ProgramMappingsRequest.md
98379843
docs/ProgramRequest.md
98389844
docs/ProgramTopicLinksTestPhraseDetectedPhrase.md
@@ -9842,7 +9848,6 @@ docs/ProgramTopicLinksTopicsDefinitionsJob.md
98429848
docs/ProgramTranscriptionEngine.md
98439849
docs/ProgramTranscriptionEngines.md
98449850
docs/ProgramsEntityListing.md
9845-
docs/ProgramsMappingsEntityListing.md
98469851
docs/ProgressConsultTransferEvent.md
98479852
docs/ProgressTransferEvent.md
98489853
docs/Prompt.md
@@ -10052,7 +10057,6 @@ docs/QueueConversationEventTopicPhoneNumberColumn.md
1005210057
docs/QueueConversationEventTopicQueueMediaSettings.md
1005310058
docs/QueueConversationEventTopicRecordersState.md
1005410059
docs/QueueConversationEventTopicScoredAgent.md
10055-
docs/QueueConversationEventTopicScreenMonitoring.md
1005610060
docs/QueueConversationEventTopicScreenShare.md
1005710061
docs/QueueConversationEventTopicSocialExpression.md
1005810062
docs/QueueConversationEventTopicTransferDestination.md
@@ -10146,7 +10150,6 @@ docs/QueueConversationSocialExpressionEventTopicPhoneNumberColumn.md
1014610150
docs/QueueConversationSocialExpressionEventTopicQueueMediaSettings.md
1014710151
docs/QueueConversationSocialExpressionEventTopicRecordersState.md
1014810152
docs/QueueConversationSocialExpressionEventTopicScoredAgent.md
10149-
docs/QueueConversationSocialExpressionEventTopicScreenMonitoring.md
1015010153
docs/QueueConversationSocialExpressionEventTopicScreenShare.md
1015110154
docs/QueueConversationSocialExpressionEventTopicSocialExpression.md
1015210155
docs/QueueConversationSocialExpressionEventTopicTransferDestination.md
@@ -10197,7 +10200,6 @@ docs/QueueConversationVideoEventTopicPhoneNumberColumn.md
1019710200
docs/QueueConversationVideoEventTopicQueueMediaSettings.md
1019810201
docs/QueueConversationVideoEventTopicRecordersState.md
1019910202
docs/QueueConversationVideoEventTopicScoredAgent.md
10200-
docs/QueueConversationVideoEventTopicScreenMonitoring.md
1020110203
docs/QueueConversationVideoEventTopicScreenShare.md
1020210204
docs/QueueConversationVideoEventTopicSocialExpression.md
1020310205
docs/QueueConversationVideoEventTopicTransferDestination.md
@@ -10704,8 +10706,8 @@ docs/SocialMediaStatisticalSummary.md
1070410706
docs/SocialTopicPatchRequest.md
1070510707
docs/SocialTopicRequest.md
1070610708
docs/SocialTopicResponse.md
10707-
docs/SocialTopicResponseEntityListing.md
1070810709
docs/SocialTopicWithDataIngestionRuleMetadataResponse.md
10710+
docs/SocialTopicWithDataIngestionRuleMetadataResponseEntityListing.md
1070910711
docs/SortItem.md
1071010712
docs/Source.md
1071110713
docs/SourceBaseResponse.md
@@ -10759,6 +10761,7 @@ docs/StationsApi.md
1075910761
docs/StatisticalResponse.md
1076010762
docs/StatisticalSummary.md
1076110763
docs/StatusChange.md
10764+
docs/StatusInfo.md
1076210765
docs/StopSettings.md
1076310766
docs/StorySetting.md
1076410767
docs/StreetAddress.md
@@ -11004,6 +11007,8 @@ docs/TopicJobRequest.md
1100411007
docs/TopicOffset.md
1100511008
docs/TopicPhrase.md
1100611009
docs/TopicRequest.md
11010+
docs/TopicsDefinitionsProgramMappings.md
11011+
docs/TopicsDefinitionsProgramsMappingsEntityListing.md
1100711012
docs/TopicsEntityListing.md
1100811013
docs/Touchpoint.md
1100911014
docs/TouchpointResponse.md
@@ -11983,7 +11988,6 @@ docs/WritableDialerContact.md
1198311988
docs/WritableDivision.md
1198411989
docs/WritableEntity.md
1198511990
docs/WritableStarrableDivision.md
11986-
docs/YearMonth.md
1198711991
docs/delete_alerting_alert-example.txt
1198811992
docs/delete_alerting_alerts_all-example.txt
1198911993
docs/delete_alerting_rule-example.txt
@@ -13873,6 +13877,7 @@ docs/patch_journey_view_version_job-example.txt
1387313877
docs/patch_knowledge_guest_session_documents_search_search_id-example.txt
1387413878
docs/patch_knowledge_knowledgebase-example.txt
1387513879
docs/patch_knowledge_knowledgebase_category-example.txt
13880+
docs/patch_knowledge_knowledgebase_chunks_search_search_id-example.txt
1387613881
docs/patch_knowledge_knowledgebase_document-example.txt
1387713882
docs/patch_knowledge_knowledgebase_document_feedback_feedback_id-example.txt
1387813883
docs/patch_knowledge_knowledgebase_document_variation-example.txt
@@ -14359,6 +14364,8 @@ docs/post_guide_version_jobs-example.txt
1435914364
docs/post_guide_versions-example.txt
1436014365
docs/post_guides-example.txt
1436114366
docs/post_guides_jobs-example.txt
14367+
docs/post_guides_uploads-example.txt
14368+
docs/post_guides_uploads-example.txt
1436214369
docs/post_identityproviders-example.txt
1436314370
docs/post_infrastructureascode_jobs-example.txt
1436414371
docs/post_integrations-example.txt

0 commit comments

Comments
 (0)