purecloudplatformclientv2 75.1.0 → 79.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.
Files changed (179) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActivityCode.md +1 -1
  4. data/docs/AnalyticsApi.md +66 -2
  5. data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
  6. data/docs/AnalyticsConversationQueryResponse.md +1 -1
  7. data/docs/AnalyticsParticipant.md +1 -0
  8. data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
  9. data/docs/ArchitectApi.md +345 -0
  10. data/docs/AuditApi.md +3 -1
  11. data/docs/AuditLogMessage.md +1 -1
  12. data/docs/AuthorizationApi.md +154 -9
  13. data/docs/AvailableTopic.md +3 -1
  14. data/docs/BuAgentScheduleActivity.md +18 -0
  15. data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
  16. data/docs/BuAgentScheduleSearchResponse.md +15 -0
  17. data/docs/BuAgentScheduleShift.md +18 -0
  18. data/docs/BuAgentSchedulesSearchResponse.md +15 -0
  19. data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
  20. data/docs/BuFullDayTimeOffMarker.md +18 -0
  21. data/docs/BuScheduleReference.md +15 -0
  22. data/docs/Call.md +1 -1
  23. data/docs/CallBasic.md +1 -1
  24. data/docs/CallMediaParticipant.md +1 -1
  25. data/docs/CallbackMediaParticipant.md +1 -1
  26. data/docs/CampaignProgress.md +2 -1
  27. data/docs/ChatMediaParticipant.md +1 -1
  28. data/docs/CobrowseMediaParticipant.md +1 -1
  29. data/docs/ConversationsApi.md +71 -1
  30. data/docs/CopyAttachmentsRequest.md +14 -0
  31. data/docs/CreateManagementUnitApiRequest.md +3 -2
  32. data/docs/CreateManagementUnitSettingsRequest.md +1 -1
  33. data/docs/CreateWorkPlanShift.md +1 -1
  34. data/docs/DataTableExportJob.md +22 -0
  35. data/docs/DataTableImportJob.md +25 -0
  36. data/docs/DivsPermittedEntityListing.md +23 -0
  37. data/docs/EmailMediaParticipant.md +1 -1
  38. data/docs/EntityListing.md +17 -0
  39. data/docs/ErrorBody.md +2 -2
  40. data/docs/ErrorInfo.md +14 -0
  41. data/docs/Evaluation.md +1 -0
  42. data/docs/EvaluationQuestionGroupScore.md +4 -0
  43. data/docs/EvaluationScoringSet.md +1 -0
  44. data/docs/FacebookIntegrationRequest.md +2 -2
  45. data/docs/GDPRJourneyCustomer.md +2 -2
  46. data/docs/InboundDomain.md +2 -0
  47. data/docs/Library.md +4 -3
  48. data/docs/LicenseApi.md +66 -0
  49. data/docs/MailFromResult.md +15 -0
  50. data/docs/ManagementUnit.md +2 -2
  51. data/docs/ManagementUnitSettingsRequest.md +1 -1
  52. data/docs/MessageMediaParticipant.md +1 -1
  53. data/docs/MessagingApi.md +0 -936
  54. data/docs/MessagingTemplate.md +15 -0
  55. data/docs/Organization.md +1 -0
  56. data/docs/QualityApi.md +5 -6
  57. data/docs/Record.md +15 -0
  58. data/docs/ReportingExportMetadataJobListing.md +22 -0
  59. data/docs/ReportingExportMetadataJobResponse.md +22 -0
  60. data/docs/Response.md +2 -0
  61. data/docs/RoutingApi.md +385 -0
  62. data/docs/RoutingSettings.md +13 -0
  63. data/docs/SCIMApi.md +397 -23
  64. data/docs/ScimUserExtensions.md +14 -0
  65. data/docs/ScimUserRole.md +13 -0
  66. data/docs/ScimUserRoutingLanguage.md +14 -0
  67. data/docs/ScimUserRoutingSkill.md +14 -0
  68. data/docs/ScimV2CreateUser.md +2 -1
  69. data/docs/ScimV2SchemaAttribute.md +24 -0
  70. data/docs/ScimV2SchemaDefinition.md +17 -0
  71. data/docs/ScimV2SchemaListResponse.md +17 -0
  72. data/docs/ScimV2User.md +2 -1
  73. data/docs/ShortTermForecast.md +2 -2
  74. data/docs/ShortTermForecastListItemResponse.md +2 -2
  75. data/docs/ShortTermForecastReference.md +2 -2
  76. data/docs/TimeOffRequestLookup.md +3 -3
  77. data/docs/TimeOffRequestResponse.md +3 -3
  78. data/docs/UserScheduleAdherence.md +1 -1
  79. data/docs/UsersApi.md +358 -10
  80. data/docs/ViewFilter.md +4 -10
  81. data/docs/WeekSchedule.md +1 -1
  82. data/docs/WeekScheduleListItemResponse.md +1 -1
  83. data/docs/WeekScheduleReference.md +1 -1
  84. data/docs/WorkPlanShift.md +1 -1
  85. data/docs/WorkforceManagementApi.md +40 -41
  86. data/lib/purecloudplatformclientv2.rb +27 -0
  87. data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
  88. data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
  89. data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
  90. data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
  91. data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
  92. data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
  93. data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
  94. data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
  95. data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
  96. data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
  97. data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
  98. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
  99. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  100. data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
  101. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
  102. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
  103. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
  104. data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
  105. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
  106. data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
  107. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
  108. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
  110. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
  111. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
  112. data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
  113. data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
  114. data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
  115. data/lib/purecloudplatformclientv2/models/call.rb +1 -1
  116. data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
  117. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
  118. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
  119. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
  120. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
  121. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
  122. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  123. data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
  124. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
  125. data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
  126. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
  127. data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
  128. data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
  129. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
  130. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
  131. data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
  132. data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
  133. data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
  134. data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
  135. data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
  136. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
  137. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
  138. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  139. data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
  140. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
  141. data/lib/purecloudplatformclientv2/models/library.rb +44 -2
  142. data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
  143. data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
  144. data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
  145. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
  146. data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
  147. data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
  148. data/lib/purecloudplatformclientv2/models/record.rb +269 -0
  149. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
  150. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
  151. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
  152. data/lib/purecloudplatformclientv2/models/response.rb +67 -1
  153. data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
  154. data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
  155. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
  156. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
  157. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
  158. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
  159. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
  160. data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
  161. data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
  162. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
  163. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
  164. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
  165. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
  166. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  167. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
  168. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
  169. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
  170. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
  171. data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
  172. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
  173. data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
  174. data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
  175. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
  176. data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
  177. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
  178. data/lib/purecloudplatformclientv2/version.rb +1 -1
  179. metadata +56 -2
@@ -95,6 +95,7 @@ module PureCloud
95
95
  # @param [Hash] opts the optional parameters
96
96
  # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
97
97
  # @option opts [Integer] :page_size Page size (default to 25)
98
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
98
99
  # @return [AuditQueryExecutionResultsResponse]
99
100
  def get_audits_query_transaction_id_results(transaction_id, opts = {})
100
101
  data, _status_code, _headers = get_audits_query_transaction_id_results_with_http_info(transaction_id, opts)
@@ -107,6 +108,7 @@ module PureCloud
107
108
  # @param [Hash] opts the optional parameters
108
109
  # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
109
110
  # @option opts [Integer] :page_size Page size
111
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
110
112
  # @return [Array<(AuditQueryExecutionResultsResponse, Fixnum, Hash)>] AuditQueryExecutionResultsResponse data, response status code and response headers
111
113
  def get_audits_query_transaction_id_results_with_http_info(transaction_id, opts = {})
112
114
  if @api_client.config.debugging
@@ -130,6 +132,12 @@ module PureCloud
130
132
 
131
133
 
132
134
 
135
+
136
+
137
+
138
+
139
+
140
+
133
141
 
134
142
 
135
143
 
@@ -140,6 +148,7 @@ module PureCloud
140
148
  query_params = {}
141
149
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
142
150
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
151
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
143
152
 
144
153
  # header parameters
145
154
  header_params = {}
@@ -629,8 +629,8 @@ module PureCloud
629
629
  return data, status_code, headers
630
630
  end
631
631
 
632
- # Returns whether or not current user can perform the specified action(s).
633
- #
632
+ # Returns which divisions the current user has the given permission in.
633
+ # This route is deprecated, use authorization/divisionspermitted/paged/me instead.
634
634
  # @param permission The permission string, including the object to access, e.g. routing:queue:view
635
635
  # @param [Hash] opts the optional parameters
636
636
  # @option opts [String] :name Search term to filter by division name
@@ -640,8 +640,8 @@ module PureCloud
640
640
  return data
641
641
  end
642
642
 
643
- # Returns whether or not current user can perform the specified action(s).
644
- #
643
+ # Returns which divisions the current user has the given permission in.
644
+ # This route is deprecated, use authorization/divisionspermitted/paged/me instead.
645
645
  # @param permission The permission string, including the object to access, e.g. routing:queue:view
646
646
  # @param [Hash] opts the optional parameters
647
647
  # @option opts [String] :name Search term to filter by division name
@@ -704,11 +704,189 @@ module PureCloud
704
704
  return data, status_code, headers
705
705
  end
706
706
 
707
- # Returns whether or not specified user can perform the specified action(s).
707
+ # Returns which divisions the current user has the given permission in.
708
+ #
709
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
710
+ # @param [Hash] opts the optional parameters
711
+ # @option opts [Integer] :page_number Page number (default to 1)
712
+ # @option opts [Integer] :page_size Page size (default to 25)
713
+ # @return [DivsPermittedEntityListing]
714
+ def get_authorization_divisionspermitted_paged_me(permission, opts = {})
715
+ data, _status_code, _headers = get_authorization_divisionspermitted_paged_me_with_http_info(permission, opts)
716
+ return data
717
+ end
718
+
719
+ # Returns which divisions the current user has the given permission in.
720
+ #
721
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
722
+ # @param [Hash] opts the optional parameters
723
+ # @option opts [Integer] :page_number Page number
724
+ # @option opts [Integer] :page_size Page size
725
+ # @return [Array<(DivsPermittedEntityListing, Fixnum, Hash)>] DivsPermittedEntityListing data, response status code and response headers
726
+ def get_authorization_divisionspermitted_paged_me_with_http_info(permission, opts = {})
727
+ if @api_client.config.debugging
728
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisionspermitted_paged_me ..."
729
+ end
730
+
731
+
732
+ # verify the required parameter 'permission' is set
733
+ fail ArgumentError, "Missing the required parameter 'permission' when calling AuthorizationApi.get_authorization_divisionspermitted_paged_me" if permission.nil?
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+ # resource path
752
+ local_var_path = "/api/v2/authorization/divisionspermitted/paged/me".sub('{format}','json')
753
+
754
+ # query parameters
755
+ query_params = {}
756
+ query_params[:'permission'] = permission
757
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
758
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
759
+
760
+ # header parameters
761
+ header_params = {}
762
+
763
+ # HTTP header 'Accept' (if needed)
764
+ local_header_accept = ['application/json']
765
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
766
+
767
+ # HTTP header 'Content-Type'
768
+ local_header_content_type = ['application/json']
769
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
770
+
771
+ # form parameters
772
+ form_params = {}
773
+
774
+ # http body (model)
775
+ post_body = nil
776
+
777
+ auth_names = ['PureCloud OAuth']
778
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
779
+ :header_params => header_params,
780
+ :query_params => query_params,
781
+ :form_params => form_params,
782
+ :body => post_body,
783
+ :auth_names => auth_names,
784
+ :return_type => 'DivsPermittedEntityListing')
785
+ if @api_client.config.debugging
786
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisionspermitted_paged_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
787
+ end
788
+ return data, status_code, headers
789
+ end
790
+
791
+ # Returns which divisions the specified user has the given permission in.
708
792
  #
709
793
  # @param subject_id Subject ID (user or group)
710
794
  # @param permission The permission string, including the object to access, e.g. routing:queue:view
711
795
  # @param [Hash] opts the optional parameters
796
+ # @option opts [Integer] :page_number Page number (default to 1)
797
+ # @option opts [Integer] :page_size Page size (default to 25)
798
+ # @return [DivsPermittedEntityListing]
799
+ def get_authorization_divisionspermitted_paged_subject_id(subject_id, permission, opts = {})
800
+ data, _status_code, _headers = get_authorization_divisionspermitted_paged_subject_id_with_http_info(subject_id, permission, opts)
801
+ return data
802
+ end
803
+
804
+ # Returns which divisions the specified user has the given permission in.
805
+ #
806
+ # @param subject_id Subject ID (user or group)
807
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
808
+ # @param [Hash] opts the optional parameters
809
+ # @option opts [Integer] :page_number Page number
810
+ # @option opts [Integer] :page_size Page size
811
+ # @return [Array<(DivsPermittedEntityListing, Fixnum, Hash)>] DivsPermittedEntityListing data, response status code and response headers
812
+ def get_authorization_divisionspermitted_paged_subject_id_with_http_info(subject_id, permission, opts = {})
813
+ if @api_client.config.debugging
814
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisionspermitted_paged_subject_id ..."
815
+ end
816
+
817
+
818
+ # verify the required parameter 'subject_id' is set
819
+ fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.get_authorization_divisionspermitted_paged_subject_id" if subject_id.nil?
820
+
821
+
822
+
823
+
824
+
825
+
826
+ # verify the required parameter 'permission' is set
827
+ fail ArgumentError, "Missing the required parameter 'permission' when calling AuthorizationApi.get_authorization_divisionspermitted_paged_subject_id" if permission.nil?
828
+
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+ # resource path
846
+ local_var_path = "/api/v2/authorization/divisionspermitted/paged/{subjectId}".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s)
847
+
848
+ # query parameters
849
+ query_params = {}
850
+ query_params[:'permission'] = permission
851
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
852
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
853
+
854
+ # header parameters
855
+ header_params = {}
856
+
857
+ # HTTP header 'Accept' (if needed)
858
+ local_header_accept = ['application/json']
859
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
860
+
861
+ # HTTP header 'Content-Type'
862
+ local_header_content_type = ['application/json']
863
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
864
+
865
+ # form parameters
866
+ form_params = {}
867
+
868
+ # http body (model)
869
+ post_body = nil
870
+
871
+ auth_names = ['PureCloud OAuth']
872
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
873
+ :header_params => header_params,
874
+ :query_params => query_params,
875
+ :form_params => form_params,
876
+ :body => post_body,
877
+ :auth_names => auth_names,
878
+ :return_type => 'DivsPermittedEntityListing')
879
+ if @api_client.config.debugging
880
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisionspermitted_paged_subject_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
881
+ end
882
+ return data, status_code, headers
883
+ end
884
+
885
+ # Returns which divisions the specified user has the given permission in.
886
+ # This route is deprecated, use authorization/divisionspermitted/paged/{subjectId} instead.
887
+ # @param subject_id Subject ID (user or group)
888
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
889
+ # @param [Hash] opts the optional parameters
712
890
  # @option opts [String] :name Search term to filter by division name
713
891
  # @return [Array<AuthzDivision>]
714
892
  def get_authorization_divisionspermitted_subject_id(subject_id, permission, opts = {})
@@ -716,8 +894,8 @@ module PureCloud
716
894
  return data
717
895
  end
718
896
 
719
- # Returns whether or not specified user can perform the specified action(s).
720
- #
897
+ # Returns which divisions the specified user has the given permission in.
898
+ # This route is deprecated, use authorization/divisionspermitted/paged/{subjectId} instead.
721
899
  # @param subject_id Subject ID (user or group)
722
900
  # @param permission The permission string, including the object to access, e.g. routing:queue:view
723
901
  # @param [Hash] opts the optional parameters
@@ -850,6 +850,7 @@ module PureCloud
850
850
  # @param job_id jobId
851
851
  # @param [Hash] opts the optional parameters
852
852
  # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
853
+ # @option opts [Integer] :page_size The desired maximum number of results
853
854
  # @return [AnalyticsConversationAsyncQueryResponse]
854
855
  def get_analytics_conversations_details_job_results(job_id, opts = {})
855
856
  data, _status_code, _headers = get_analytics_conversations_details_job_results_with_http_info(job_id, opts)
@@ -861,6 +862,7 @@ module PureCloud
861
862
  # @param job_id jobId
862
863
  # @param [Hash] opts the optional parameters
863
864
  # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
865
+ # @option opts [Integer] :page_size The desired maximum number of results
864
866
  # @return [Array<(AnalyticsConversationAsyncQueryResponse, Fixnum, Hash)>] AnalyticsConversationAsyncQueryResponse data, response status code and response headers
865
867
  def get_analytics_conversations_details_job_results_with_http_info(job_id, opts = {})
866
868
  if @api_client.config.debugging
@@ -881,12 +883,19 @@ module PureCloud
881
883
 
882
884
 
883
885
 
886
+
887
+
888
+
889
+
890
+
891
+
884
892
  # resource path
885
893
  local_var_path = "/api/v2/analytics/conversations/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
886
894
 
887
895
  # query parameters
888
896
  query_params = {}
889
897
  query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
898
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
890
899
 
891
900
  # header parameters
892
901
  header_params = {}
@@ -8602,6 +8611,81 @@ module PureCloud
8602
8611
  return data, status_code, headers
8603
8612
  end
8604
8613
 
8614
+ # Copy attachments from an email message to the current draft.
8615
+ #
8616
+ # @param conversation_id conversationId
8617
+ # @param body Copy Attachment Request
8618
+ # @param [Hash] opts the optional parameters
8619
+ # @return [EmailMessage]
8620
+ def post_conversations_email_messages_draft_attachments_copy(conversation_id, body, opts = {})
8621
+ data, _status_code, _headers = post_conversations_email_messages_draft_attachments_copy_with_http_info(conversation_id, body, opts)
8622
+ return data
8623
+ end
8624
+
8625
+ # Copy attachments from an email message to the current draft.
8626
+ #
8627
+ # @param conversation_id conversationId
8628
+ # @param body Copy Attachment Request
8629
+ # @param [Hash] opts the optional parameters
8630
+ # @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
8631
+ def post_conversations_email_messages_draft_attachments_copy_with_http_info(conversation_id, body, opts = {})
8632
+ if @api_client.config.debugging
8633
+ @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_email_messages_draft_attachments_copy ..."
8634
+ end
8635
+
8636
+
8637
+ # verify the required parameter 'conversation_id' is set
8638
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_email_messages_draft_attachments_copy" if conversation_id.nil?
8639
+
8640
+
8641
+
8642
+
8643
+
8644
+
8645
+ # verify the required parameter 'body' is set
8646
+ fail ArgumentError, "Missing the required parameter 'body' when calling ConversationsApi.post_conversations_email_messages_draft_attachments_copy" if body.nil?
8647
+
8648
+
8649
+
8650
+
8651
+
8652
+ # resource path
8653
+ local_var_path = "/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
8654
+
8655
+ # query parameters
8656
+ query_params = {}
8657
+
8658
+ # header parameters
8659
+ header_params = {}
8660
+
8661
+ # HTTP header 'Accept' (if needed)
8662
+ local_header_accept = ['application/json']
8663
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
8664
+
8665
+ # HTTP header 'Content-Type'
8666
+ local_header_content_type = ['application/json']
8667
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
8668
+
8669
+ # form parameters
8670
+ form_params = {}
8671
+
8672
+ # http body (model)
8673
+ post_body = @api_client.object_to_http_body(body)
8674
+
8675
+ auth_names = ['PureCloud OAuth']
8676
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
8677
+ :header_params => header_params,
8678
+ :query_params => query_params,
8679
+ :form_params => form_params,
8680
+ :body => post_body,
8681
+ :auth_names => auth_names,
8682
+ :return_type => 'EmailMessage')
8683
+ if @api_client.config.debugging
8684
+ @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_email_messages_draft_attachments_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8685
+ end
8686
+ return data, status_code, headers
8687
+ end
8688
+
8605
8689
  # Replace this participant with the specified user and/or address
8606
8690
  #
8607
8691
  # @param conversation_id conversationId
@@ -347,6 +347,69 @@ module PureCloud
347
347
  return data, status_code, headers
348
348
  end
349
349
 
350
+ # Get a list of licenses inferred based on a list of roleIds
351
+ #
352
+ # @param [Hash] opts the optional parameters
353
+ # @option opts [Array<String>] :body The roleIds to use while inferring licenses
354
+ # @return [Array<String>]
355
+ def post_license_infer(opts = {})
356
+ data, _status_code, _headers = post_license_infer_with_http_info(opts)
357
+ return data
358
+ end
359
+
360
+ # Get a list of licenses inferred based on a list of roleIds
361
+ #
362
+ # @param [Hash] opts the optional parameters
363
+ # @option opts [Array<String>] :body The roleIds to use while inferring licenses
364
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
365
+ def post_license_infer_with_http_info(opts = {})
366
+ if @api_client.config.debugging
367
+ @api_client.config.logger.debug "Calling API: LicenseApi.post_license_infer ..."
368
+ end
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+ # resource path
377
+ local_var_path = "/api/v2/license/infer".sub('{format}','json')
378
+
379
+ # query parameters
380
+ query_params = {}
381
+
382
+ # header parameters
383
+ header_params = {}
384
+
385
+ # HTTP header 'Accept' (if needed)
386
+ local_header_accept = ['application/json']
387
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
388
+
389
+ # HTTP header 'Content-Type'
390
+ local_header_content_type = ['application/json']
391
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
392
+
393
+ # form parameters
394
+ form_params = {}
395
+
396
+ # http body (model)
397
+ post_body = @api_client.object_to_http_body(opts[:'body'])
398
+
399
+ auth_names = ['PureCloud OAuth']
400
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
401
+ :header_params => header_params,
402
+ :query_params => query_params,
403
+ :form_params => form_params,
404
+ :body => post_body,
405
+ :auth_names => auth_names,
406
+ :return_type => 'Array<String>')
407
+ if @api_client.config.debugging
408
+ @api_client.config.logger.debug "API called: LicenseApi#post_license_infer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
+ end
410
+ return data, status_code, headers
411
+ end
412
+
350
413
  # Update the organization's license assignments in a batch.
351
414
  #
352
415
  # @param [Hash] opts the optional parameters
@@ -24,685 +24,6 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
- # Delete a Facebook messaging integration
28
- #
29
- # @param integration_id Integration ID
30
- # @param [Hash] opts the optional parameters
31
- # @return [nil]
32
- def delete_messaging_integrations_facebook_integration_id(integration_id, opts = {})
33
- delete_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts)
34
- return nil
35
- end
36
-
37
- # Delete a Facebook messaging integration
38
- #
39
- # @param integration_id Integration ID
40
- # @param [Hash] opts the optional parameters
41
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
42
- def delete_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts = {})
43
- if @api_client.config.debugging
44
- @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_facebook_integration_id ..."
45
- end
46
-
47
-
48
- # verify the required parameter 'integration_id' is set
49
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_facebook_integration_id" if integration_id.nil?
50
-
51
-
52
-
53
-
54
-
55
- # resource path
56
- local_var_path = "/api/v2/messaging/integrations/facebook/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.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 OAuth']
79
- data, status_code, headers = @api_client.call_api(:DELETE, 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
- if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: MessagingApi#delete_messaging_integrations_facebook_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
- end
88
- return data, status_code, headers
89
- end
90
-
91
- # Delete a LINE messenger integration
92
- #
93
- # @param integration_id Integration ID
94
- # @param [Hash] opts the optional parameters
95
- # @return [nil]
96
- def delete_messaging_integrations_line_integration_id(integration_id, opts = {})
97
- delete_messaging_integrations_line_integration_id_with_http_info(integration_id, opts)
98
- return nil
99
- end
100
-
101
- # Delete a LINE messenger integration
102
- #
103
- # @param integration_id Integration ID
104
- # @param [Hash] opts the optional parameters
105
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
106
- def delete_messaging_integrations_line_integration_id_with_http_info(integration_id, opts = {})
107
- if @api_client.config.debugging
108
- @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_line_integration_id ..."
109
- end
110
-
111
-
112
- # verify the required parameter 'integration_id' is set
113
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_line_integration_id" if integration_id.nil?
114
-
115
-
116
-
117
-
118
-
119
- # resource path
120
- local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
121
-
122
- # query parameters
123
- query_params = {}
124
-
125
- # header parameters
126
- header_params = {}
127
-
128
- # HTTP header 'Accept' (if needed)
129
- local_header_accept = ['application/json']
130
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
131
-
132
- # HTTP header 'Content-Type'
133
- local_header_content_type = ['application/json']
134
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
135
-
136
- # form parameters
137
- form_params = {}
138
-
139
- # http body (model)
140
- post_body = nil
141
-
142
- auth_names = ['PureCloud OAuth']
143
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
144
- :header_params => header_params,
145
- :query_params => query_params,
146
- :form_params => form_params,
147
- :body => post_body,
148
- :auth_names => auth_names)
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "API called: MessagingApi#delete_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
- end
152
- return data, status_code, headers
153
- end
154
-
155
- # Delete a Twitter messaging integration
156
- #
157
- # @param integration_id Integration ID
158
- # @param [Hash] opts the optional parameters
159
- # @return [nil]
160
- def delete_messaging_integrations_twitter_integration_id(integration_id, opts = {})
161
- delete_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts)
162
- return nil
163
- end
164
-
165
- # Delete a Twitter messaging integration
166
- #
167
- # @param integration_id Integration ID
168
- # @param [Hash] opts the optional parameters
169
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
170
- def delete_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts = {})
171
- if @api_client.config.debugging
172
- @api_client.config.logger.debug "Calling API: MessagingApi.delete_messaging_integrations_twitter_integration_id ..."
173
- end
174
-
175
-
176
- # verify the required parameter 'integration_id' is set
177
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.delete_messaging_integrations_twitter_integration_id" if integration_id.nil?
178
-
179
-
180
-
181
-
182
-
183
- # resource path
184
- local_var_path = "/api/v2/messaging/integrations/twitter/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
185
-
186
- # query parameters
187
- query_params = {}
188
-
189
- # header parameters
190
- header_params = {}
191
-
192
- # HTTP header 'Accept' (if needed)
193
- local_header_accept = ['application/json']
194
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
195
-
196
- # HTTP header 'Content-Type'
197
- local_header_content_type = ['application/json']
198
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
199
-
200
- # form parameters
201
- form_params = {}
202
-
203
- # http body (model)
204
- post_body = nil
205
-
206
- auth_names = ['PureCloud OAuth']
207
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
208
- :header_params => header_params,
209
- :query_params => query_params,
210
- :form_params => form_params,
211
- :body => post_body,
212
- :auth_names => auth_names)
213
- if @api_client.config.debugging
214
- @api_client.config.logger.debug "API called: MessagingApi#delete_messaging_integrations_twitter_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
215
- end
216
- return data, status_code, headers
217
- end
218
-
219
- # Get a list of Integrations
220
- #
221
- # @param [Hash] opts the optional parameters
222
- # @option opts [Integer] :page_size Page size (default to 25)
223
- # @option opts [Integer] :page_number Page number (default to 1)
224
- # @return [MessagingIntegrationEntityListing]
225
- def get_messaging_integrations(opts = {})
226
- data, _status_code, _headers = get_messaging_integrations_with_http_info(opts)
227
- return data
228
- end
229
-
230
- # Get a list of Integrations
231
- #
232
- # @param [Hash] opts the optional parameters
233
- # @option opts [Integer] :page_size Page size
234
- # @option opts [Integer] :page_number Page number
235
- # @return [Array<(MessagingIntegrationEntityListing, Fixnum, Hash)>] MessagingIntegrationEntityListing data, response status code and response headers
236
- def get_messaging_integrations_with_http_info(opts = {})
237
- if @api_client.config.debugging
238
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations ..."
239
- end
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
- # resource path
254
- local_var_path = "/api/v2/messaging/integrations".sub('{format}','json')
255
-
256
- # query parameters
257
- query_params = {}
258
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
259
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
260
-
261
- # header parameters
262
- header_params = {}
263
-
264
- # HTTP header 'Accept' (if needed)
265
- local_header_accept = ['application/json']
266
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
267
-
268
- # HTTP header 'Content-Type'
269
- local_header_content_type = ['application/json']
270
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
271
-
272
- # form parameters
273
- form_params = {}
274
-
275
- # http body (model)
276
- post_body = nil
277
-
278
- auth_names = ['PureCloud OAuth']
279
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
280
- :header_params => header_params,
281
- :query_params => query_params,
282
- :form_params => form_params,
283
- :body => post_body,
284
- :auth_names => auth_names,
285
- :return_type => 'MessagingIntegrationEntityListing')
286
- if @api_client.config.debugging
287
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
288
- end
289
- return data, status_code, headers
290
- end
291
-
292
- # Get a list of Facebook Integrations
293
- #
294
- # @param [Hash] opts the optional parameters
295
- # @option opts [Integer] :page_size Page size (default to 25)
296
- # @option opts [Integer] :page_number Page number (default to 1)
297
- # @return [FacebookIntegrationEntityListing]
298
- def get_messaging_integrations_facebook(opts = {})
299
- data, _status_code, _headers = get_messaging_integrations_facebook_with_http_info(opts)
300
- return data
301
- end
302
-
303
- # Get a list of Facebook Integrations
304
- #
305
- # @param [Hash] opts the optional parameters
306
- # @option opts [Integer] :page_size Page size
307
- # @option opts [Integer] :page_number Page number
308
- # @return [Array<(FacebookIntegrationEntityListing, Fixnum, Hash)>] FacebookIntegrationEntityListing data, response status code and response headers
309
- def get_messaging_integrations_facebook_with_http_info(opts = {})
310
- if @api_client.config.debugging
311
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_facebook ..."
312
- end
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
- # resource path
327
- local_var_path = "/api/v2/messaging/integrations/facebook".sub('{format}','json')
328
-
329
- # query parameters
330
- query_params = {}
331
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
332
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
333
-
334
- # header parameters
335
- header_params = {}
336
-
337
- # HTTP header 'Accept' (if needed)
338
- local_header_accept = ['application/json']
339
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
340
-
341
- # HTTP header 'Content-Type'
342
- local_header_content_type = ['application/json']
343
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
344
-
345
- # form parameters
346
- form_params = {}
347
-
348
- # http body (model)
349
- post_body = nil
350
-
351
- auth_names = ['PureCloud OAuth']
352
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
353
- :header_params => header_params,
354
- :query_params => query_params,
355
- :form_params => form_params,
356
- :body => post_body,
357
- :auth_names => auth_names,
358
- :return_type => 'FacebookIntegrationEntityListing')
359
- if @api_client.config.debugging
360
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_facebook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
361
- end
362
- return data, status_code, headers
363
- end
364
-
365
- # Get a Facebook messaging integration
366
- #
367
- # @param integration_id Integration ID
368
- # @param [Hash] opts the optional parameters
369
- # @return [FacebookIntegration]
370
- def get_messaging_integrations_facebook_integration_id(integration_id, opts = {})
371
- data, _status_code, _headers = get_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts)
372
- return data
373
- end
374
-
375
- # Get a Facebook messaging integration
376
- #
377
- # @param integration_id Integration ID
378
- # @param [Hash] opts the optional parameters
379
- # @return [Array<(FacebookIntegration, Fixnum, Hash)>] FacebookIntegration data, response status code and response headers
380
- def get_messaging_integrations_facebook_integration_id_with_http_info(integration_id, opts = {})
381
- if @api_client.config.debugging
382
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_facebook_integration_id ..."
383
- end
384
-
385
-
386
- # verify the required parameter 'integration_id' is set
387
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_facebook_integration_id" if integration_id.nil?
388
-
389
-
390
-
391
-
392
-
393
- # resource path
394
- local_var_path = "/api/v2/messaging/integrations/facebook/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
395
-
396
- # query parameters
397
- query_params = {}
398
-
399
- # header parameters
400
- header_params = {}
401
-
402
- # HTTP header 'Accept' (if needed)
403
- local_header_accept = ['application/json']
404
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
405
-
406
- # HTTP header 'Content-Type'
407
- local_header_content_type = ['application/json']
408
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
409
-
410
- # form parameters
411
- form_params = {}
412
-
413
- # http body (model)
414
- post_body = nil
415
-
416
- auth_names = ['PureCloud OAuth']
417
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
418
- :header_params => header_params,
419
- :query_params => query_params,
420
- :form_params => form_params,
421
- :body => post_body,
422
- :auth_names => auth_names,
423
- :return_type => 'FacebookIntegration')
424
- if @api_client.config.debugging
425
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_facebook_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
426
- end
427
- return data, status_code, headers
428
- end
429
-
430
- # Get a list of LINE messenger Integrations
431
- #
432
- # @param [Hash] opts the optional parameters
433
- # @option opts [Integer] :page_size Page size (default to 25)
434
- # @option opts [Integer] :page_number Page number (default to 1)
435
- # @return [LineIntegrationEntityListing]
436
- def get_messaging_integrations_line(opts = {})
437
- data, _status_code, _headers = get_messaging_integrations_line_with_http_info(opts)
438
- return data
439
- end
440
-
441
- # Get a list of LINE messenger Integrations
442
- #
443
- # @param [Hash] opts the optional parameters
444
- # @option opts [Integer] :page_size Page size
445
- # @option opts [Integer] :page_number Page number
446
- # @return [Array<(LineIntegrationEntityListing, Fixnum, Hash)>] LineIntegrationEntityListing data, response status code and response headers
447
- def get_messaging_integrations_line_with_http_info(opts = {})
448
- if @api_client.config.debugging
449
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_line ..."
450
- end
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
- # resource path
465
- local_var_path = "/api/v2/messaging/integrations/line".sub('{format}','json')
466
-
467
- # query parameters
468
- query_params = {}
469
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
470
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
471
-
472
- # header parameters
473
- header_params = {}
474
-
475
- # HTTP header 'Accept' (if needed)
476
- local_header_accept = ['application/json']
477
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
478
-
479
- # HTTP header 'Content-Type'
480
- local_header_content_type = ['application/json']
481
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
482
-
483
- # form parameters
484
- form_params = {}
485
-
486
- # http body (model)
487
- post_body = nil
488
-
489
- auth_names = ['PureCloud OAuth']
490
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
491
- :header_params => header_params,
492
- :query_params => query_params,
493
- :form_params => form_params,
494
- :body => post_body,
495
- :auth_names => auth_names,
496
- :return_type => 'LineIntegrationEntityListing')
497
- if @api_client.config.debugging
498
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
499
- end
500
- return data, status_code, headers
501
- end
502
-
503
- # Get a LINE messenger integration
504
- #
505
- # @param integration_id Integration ID
506
- # @param [Hash] opts the optional parameters
507
- # @return [LineIntegration]
508
- def get_messaging_integrations_line_integration_id(integration_id, opts = {})
509
- data, _status_code, _headers = get_messaging_integrations_line_integration_id_with_http_info(integration_id, opts)
510
- return data
511
- end
512
-
513
- # Get a LINE messenger integration
514
- #
515
- # @param integration_id Integration ID
516
- # @param [Hash] opts the optional parameters
517
- # @return [Array<(LineIntegration, Fixnum, Hash)>] LineIntegration data, response status code and response headers
518
- def get_messaging_integrations_line_integration_id_with_http_info(integration_id, opts = {})
519
- if @api_client.config.debugging
520
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_line_integration_id ..."
521
- end
522
-
523
-
524
- # verify the required parameter 'integration_id' is set
525
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_line_integration_id" if integration_id.nil?
526
-
527
-
528
-
529
-
530
-
531
- # resource path
532
- local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
533
-
534
- # query parameters
535
- query_params = {}
536
-
537
- # header parameters
538
- header_params = {}
539
-
540
- # HTTP header 'Accept' (if needed)
541
- local_header_accept = ['application/json']
542
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
543
-
544
- # HTTP header 'Content-Type'
545
- local_header_content_type = ['application/json']
546
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
547
-
548
- # form parameters
549
- form_params = {}
550
-
551
- # http body (model)
552
- post_body = nil
553
-
554
- auth_names = ['PureCloud OAuth']
555
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
556
- :header_params => header_params,
557
- :query_params => query_params,
558
- :form_params => form_params,
559
- :body => post_body,
560
- :auth_names => auth_names,
561
- :return_type => 'LineIntegration')
562
- if @api_client.config.debugging
563
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
564
- end
565
- return data, status_code, headers
566
- end
567
-
568
- # Get a list of Twitter Integrations
569
- #
570
- # @param [Hash] opts the optional parameters
571
- # @option opts [Integer] :page_size Page size (default to 25)
572
- # @option opts [Integer] :page_number Page number (default to 1)
573
- # @return [TwitterIntegrationEntityListing]
574
- def get_messaging_integrations_twitter(opts = {})
575
- data, _status_code, _headers = get_messaging_integrations_twitter_with_http_info(opts)
576
- return data
577
- end
578
-
579
- # Get a list of Twitter Integrations
580
- #
581
- # @param [Hash] opts the optional parameters
582
- # @option opts [Integer] :page_size Page size
583
- # @option opts [Integer] :page_number Page number
584
- # @return [Array<(TwitterIntegrationEntityListing, Fixnum, Hash)>] TwitterIntegrationEntityListing data, response status code and response headers
585
- def get_messaging_integrations_twitter_with_http_info(opts = {})
586
- if @api_client.config.debugging
587
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_twitter ..."
588
- end
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
- # resource path
603
- local_var_path = "/api/v2/messaging/integrations/twitter".sub('{format}','json')
604
-
605
- # query parameters
606
- query_params = {}
607
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
608
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
609
-
610
- # header parameters
611
- header_params = {}
612
-
613
- # HTTP header 'Accept' (if needed)
614
- local_header_accept = ['application/json']
615
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
616
-
617
- # HTTP header 'Content-Type'
618
- local_header_content_type = ['application/json']
619
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
620
-
621
- # form parameters
622
- form_params = {}
623
-
624
- # http body (model)
625
- post_body = nil
626
-
627
- auth_names = ['PureCloud OAuth']
628
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
629
- :header_params => header_params,
630
- :query_params => query_params,
631
- :form_params => form_params,
632
- :body => post_body,
633
- :auth_names => auth_names,
634
- :return_type => 'TwitterIntegrationEntityListing')
635
- if @api_client.config.debugging
636
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_twitter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
637
- end
638
- return data, status_code, headers
639
- end
640
-
641
- # Get a Twitter messaging integration
642
- #
643
- # @param integration_id Integration ID
644
- # @param [Hash] opts the optional parameters
645
- # @return [TwitterIntegration]
646
- def get_messaging_integrations_twitter_integration_id(integration_id, opts = {})
647
- data, _status_code, _headers = get_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts)
648
- return data
649
- end
650
-
651
- # Get a Twitter messaging integration
652
- #
653
- # @param integration_id Integration ID
654
- # @param [Hash] opts the optional parameters
655
- # @return [Array<(TwitterIntegration, Fixnum, Hash)>] TwitterIntegration data, response status code and response headers
656
- def get_messaging_integrations_twitter_integration_id_with_http_info(integration_id, opts = {})
657
- if @api_client.config.debugging
658
- @api_client.config.logger.debug "Calling API: MessagingApi.get_messaging_integrations_twitter_integration_id ..."
659
- end
660
-
661
-
662
- # verify the required parameter 'integration_id' is set
663
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.get_messaging_integrations_twitter_integration_id" if integration_id.nil?
664
-
665
-
666
-
667
-
668
-
669
- # resource path
670
- local_var_path = "/api/v2/messaging/integrations/twitter/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
671
-
672
- # query parameters
673
- query_params = {}
674
-
675
- # header parameters
676
- header_params = {}
677
-
678
- # HTTP header 'Accept' (if needed)
679
- local_header_accept = ['application/json']
680
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
681
-
682
- # HTTP header 'Content-Type'
683
- local_header_content_type = ['application/json']
684
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
685
-
686
- # form parameters
687
- form_params = {}
688
-
689
- # http body (model)
690
- post_body = nil
691
-
692
- auth_names = ['PureCloud OAuth']
693
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
694
- :header_params => header_params,
695
- :query_params => query_params,
696
- :form_params => form_params,
697
- :body => post_body,
698
- :auth_names => auth_names,
699
- :return_type => 'TwitterIntegration')
700
- if @api_client.config.debugging
701
- @api_client.config.logger.debug "API called: MessagingApi#get_messaging_integrations_twitter_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
702
- end
703
- return data, status_code, headers
704
- end
705
-
706
27
  # Get a list of Messaging Stickers
707
28
  #
708
29
  # @param messenger_type Messenger Type
@@ -785,275 +106,5 @@ module PureCloud
785
106
  end
786
107
  return data, status_code, headers
787
108
  end
788
-
789
- # Create a Facebook Integration
790
- #
791
- # @param body FacebookIntegrationRequest
792
- # @param [Hash] opts the optional parameters
793
- # @return [FacebookIntegration]
794
- def post_messaging_integrations_facebook(body, opts = {})
795
- data, _status_code, _headers = post_messaging_integrations_facebook_with_http_info(body, opts)
796
- return data
797
- end
798
-
799
- # Create a Facebook Integration
800
- #
801
- # @param body FacebookIntegrationRequest
802
- # @param [Hash] opts the optional parameters
803
- # @return [Array<(FacebookIntegration, Fixnum, Hash)>] FacebookIntegration data, response status code and response headers
804
- def post_messaging_integrations_facebook_with_http_info(body, opts = {})
805
- if @api_client.config.debugging
806
- @api_client.config.logger.debug "Calling API: MessagingApi.post_messaging_integrations_facebook ..."
807
- end
808
-
809
-
810
- # verify the required parameter 'body' is set
811
- fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.post_messaging_integrations_facebook" if body.nil?
812
-
813
-
814
-
815
-
816
-
817
- # resource path
818
- local_var_path = "/api/v2/messaging/integrations/facebook".sub('{format}','json')
819
-
820
- # query parameters
821
- query_params = {}
822
-
823
- # header parameters
824
- header_params = {}
825
-
826
- # HTTP header 'Accept' (if needed)
827
- local_header_accept = ['application/json']
828
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
829
-
830
- # HTTP header 'Content-Type'
831
- local_header_content_type = ['application/json']
832
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
833
-
834
- # form parameters
835
- form_params = {}
836
-
837
- # http body (model)
838
- post_body = @api_client.object_to_http_body(body)
839
-
840
- auth_names = ['PureCloud OAuth']
841
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
842
- :header_params => header_params,
843
- :query_params => query_params,
844
- :form_params => form_params,
845
- :body => post_body,
846
- :auth_names => auth_names,
847
- :return_type => 'FacebookIntegration')
848
- if @api_client.config.debugging
849
- @api_client.config.logger.debug "API called: MessagingApi#post_messaging_integrations_facebook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
850
- end
851
- return data, status_code, headers
852
- end
853
-
854
- # Create a LINE messenger Integration
855
- #
856
- # @param body LineIntegrationRequest
857
- # @param [Hash] opts the optional parameters
858
- # @return [LineIntegration]
859
- def post_messaging_integrations_line(body, opts = {})
860
- data, _status_code, _headers = post_messaging_integrations_line_with_http_info(body, opts)
861
- return data
862
- end
863
-
864
- # Create a LINE messenger Integration
865
- #
866
- # @param body LineIntegrationRequest
867
- # @param [Hash] opts the optional parameters
868
- # @return [Array<(LineIntegration, Fixnum, Hash)>] LineIntegration data, response status code and response headers
869
- def post_messaging_integrations_line_with_http_info(body, opts = {})
870
- if @api_client.config.debugging
871
- @api_client.config.logger.debug "Calling API: MessagingApi.post_messaging_integrations_line ..."
872
- end
873
-
874
-
875
- # verify the required parameter 'body' is set
876
- fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.post_messaging_integrations_line" if body.nil?
877
-
878
-
879
-
880
-
881
-
882
- # resource path
883
- local_var_path = "/api/v2/messaging/integrations/line".sub('{format}','json')
884
-
885
- # query parameters
886
- query_params = {}
887
-
888
- # header parameters
889
- header_params = {}
890
-
891
- # HTTP header 'Accept' (if needed)
892
- local_header_accept = ['application/json']
893
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
894
-
895
- # HTTP header 'Content-Type'
896
- local_header_content_type = ['application/json']
897
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
898
-
899
- # form parameters
900
- form_params = {}
901
-
902
- # http body (model)
903
- post_body = @api_client.object_to_http_body(body)
904
-
905
- auth_names = ['PureCloud OAuth']
906
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
907
- :header_params => header_params,
908
- :query_params => query_params,
909
- :form_params => form_params,
910
- :body => post_body,
911
- :auth_names => auth_names,
912
- :return_type => 'LineIntegration')
913
- if @api_client.config.debugging
914
- @api_client.config.logger.debug "API called: MessagingApi#post_messaging_integrations_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
915
- end
916
- return data, status_code, headers
917
- end
918
-
919
- # Create a Twitter Integration
920
- #
921
- # @param body TwitterIntegrationRequest
922
- # @param [Hash] opts the optional parameters
923
- # @return [TwitterIntegration]
924
- def post_messaging_integrations_twitter(body, opts = {})
925
- data, _status_code, _headers = post_messaging_integrations_twitter_with_http_info(body, opts)
926
- return data
927
- end
928
-
929
- # Create a Twitter Integration
930
- #
931
- # @param body TwitterIntegrationRequest
932
- # @param [Hash] opts the optional parameters
933
- # @return [Array<(TwitterIntegration, Fixnum, Hash)>] TwitterIntegration data, response status code and response headers
934
- def post_messaging_integrations_twitter_with_http_info(body, opts = {})
935
- if @api_client.config.debugging
936
- @api_client.config.logger.debug "Calling API: MessagingApi.post_messaging_integrations_twitter ..."
937
- end
938
-
939
-
940
- # verify the required parameter 'body' is set
941
- fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.post_messaging_integrations_twitter" if body.nil?
942
-
943
-
944
-
945
-
946
-
947
- # resource path
948
- local_var_path = "/api/v2/messaging/integrations/twitter".sub('{format}','json')
949
-
950
- # query parameters
951
- query_params = {}
952
-
953
- # header parameters
954
- header_params = {}
955
-
956
- # HTTP header 'Accept' (if needed)
957
- local_header_accept = ['application/json']
958
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
959
-
960
- # HTTP header 'Content-Type'
961
- local_header_content_type = ['application/json']
962
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
963
-
964
- # form parameters
965
- form_params = {}
966
-
967
- # http body (model)
968
- post_body = @api_client.object_to_http_body(body)
969
-
970
- auth_names = ['PureCloud OAuth']
971
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
972
- :header_params => header_params,
973
- :query_params => query_params,
974
- :form_params => form_params,
975
- :body => post_body,
976
- :auth_names => auth_names,
977
- :return_type => 'TwitterIntegration')
978
- if @api_client.config.debugging
979
- @api_client.config.logger.debug "API called: MessagingApi#post_messaging_integrations_twitter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
980
- end
981
- return data, status_code, headers
982
- end
983
-
984
- # Update a LINE messenger integration
985
- #
986
- # @param integration_id Integration ID
987
- # @param body LineIntegrationRequest
988
- # @param [Hash] opts the optional parameters
989
- # @return [LineIntegration]
990
- def put_messaging_integrations_line_integration_id(integration_id, body, opts = {})
991
- data, _status_code, _headers = put_messaging_integrations_line_integration_id_with_http_info(integration_id, body, opts)
992
- return data
993
- end
994
-
995
- # Update a LINE messenger integration
996
- #
997
- # @param integration_id Integration ID
998
- # @param body LineIntegrationRequest
999
- # @param [Hash] opts the optional parameters
1000
- # @return [Array<(LineIntegration, Fixnum, Hash)>] LineIntegration data, response status code and response headers
1001
- def put_messaging_integrations_line_integration_id_with_http_info(integration_id, body, opts = {})
1002
- if @api_client.config.debugging
1003
- @api_client.config.logger.debug "Calling API: MessagingApi.put_messaging_integrations_line_integration_id ..."
1004
- end
1005
-
1006
-
1007
- # verify the required parameter 'integration_id' is set
1008
- fail ArgumentError, "Missing the required parameter 'integration_id' when calling MessagingApi.put_messaging_integrations_line_integration_id" if integration_id.nil?
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
- # verify the required parameter 'body' is set
1016
- fail ArgumentError, "Missing the required parameter 'body' when calling MessagingApi.put_messaging_integrations_line_integration_id" if body.nil?
1017
-
1018
-
1019
-
1020
-
1021
-
1022
- # resource path
1023
- local_var_path = "/api/v2/messaging/integrations/line/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)
1024
-
1025
- # query parameters
1026
- query_params = {}
1027
-
1028
- # header parameters
1029
- header_params = {}
1030
-
1031
- # HTTP header 'Accept' (if needed)
1032
- local_header_accept = ['application/json']
1033
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1034
-
1035
- # HTTP header 'Content-Type'
1036
- local_header_content_type = ['application/json']
1037
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1038
-
1039
- # form parameters
1040
- form_params = {}
1041
-
1042
- # http body (model)
1043
- post_body = @api_client.object_to_http_body(body)
1044
-
1045
- auth_names = ['PureCloud OAuth']
1046
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1047
- :header_params => header_params,
1048
- :query_params => query_params,
1049
- :form_params => form_params,
1050
- :body => post_body,
1051
- :auth_names => auth_names,
1052
- :return_type => 'LineIntegration')
1053
- if @api_client.config.debugging
1054
- @api_client.config.logger.debug "API called: MessagingApi#put_messaging_integrations_line_integration_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1055
- end
1056
- return data, status_code, headers
1057
- end
1058
109
  end
1059
110
  end