purecloudplatformclientv2 35.0.0 → 36.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 (82) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdditionalMessage.md +2 -0
  4. data/docs/AlertingApi.md +0 -2
  5. data/docs/AnalyticsApi.md +0 -13
  6. data/docs/ArchitectApi.md +210 -150
  7. data/docs/AttributesApi.md +0 -6
  8. data/docs/AuthorizationApi.md +15 -7
  9. data/docs/BillingApi.md +4 -1
  10. data/docs/CampaignDivisionView.md +1 -1
  11. data/docs/ContentManagementApi.md +0 -38
  12. data/docs/ConversationsApi.md +141 -75
  13. data/docs/CreateQueueRequest.md +1 -1
  14. data/docs/Division.md +15 -0
  15. data/docs/FaxApi.md +0 -6
  16. data/docs/Flow.md +1 -1
  17. data/docs/FlowDivisionView.md +1 -0
  18. data/docs/FreeSeatingConfiguration.md +1 -1
  19. data/docs/GeolocationApi.md +0 -3
  20. data/docs/GreetingsApi.md +0 -16
  21. data/docs/GroupsApi.md +2 -12
  22. data/docs/IdentityProviderApi.md +18 -9
  23. data/docs/IntegrationsApi.md +26 -31
  24. data/docs/LanguagesApi.md +0 -4
  25. data/docs/LicenseApi.md +21 -8
  26. data/docs/LocationsApi.md +0 -3
  27. data/docs/ManagementUnit.md +1 -0
  28. data/docs/MessageData.md +1 -0
  29. data/docs/MessageDetails.md +1 -0
  30. data/docs/MessageMedia.md +3 -0
  31. data/docs/MessageMediaData.md +20 -0
  32. data/docs/MessageSticker.md +14 -0
  33. data/docs/MobileDevicesApi.md +0 -5
  34. data/docs/NotificationsApi.md +0 -7
  35. data/docs/OrganizationApi.md +0 -2
  36. data/docs/OrganizationAuthorizationApi.md +16 -6
  37. data/docs/OutboundApi.md +8 -6
  38. data/docs/OutboundSettings.md +1 -0
  39. data/docs/PresenceApi.md +0 -5
  40. data/docs/QualityApi.md +0 -21
  41. data/docs/Queue.md +1 -1
  42. data/docs/RecordingApi.md +0 -17
  43. data/docs/ResponseManagementApi.md +0 -11
  44. data/docs/RoutingApi.md +93 -9
  45. data/docs/SearchApi.md +0 -14
  46. data/docs/StationsApi.md +0 -3
  47. data/docs/SuggestApi.md +0 -4
  48. data/docs/SurveyForm.md +3 -1
  49. data/docs/TelephonyProvidersEdgeApi.md +4 -16
  50. data/docs/TokensApi.md +0 -2
  51. data/docs/UserQueue.md +1 -1
  52. data/docs/UserRecordingsApi.md +0 -6
  53. data/docs/UsersApi.md +31 -42
  54. data/docs/UtilitiesApi.md +0 -3
  55. data/docs/VoicemailApi.md +8 -21
  56. data/docs/WorkforceManagementApi.md +25 -4
  57. data/lib/purecloudplatformclientv2.rb +3 -0
  58. data/lib/purecloudplatformclientv2/api/architect_api.rb +136 -102
  59. data/lib/purecloudplatformclientv2/api/conversations_api.rb +160 -0
  60. data/lib/purecloudplatformclientv2/api/routing_api.rb +122 -0
  61. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +22 -0
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/additional_message.rb +60 -4
  64. data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +1 -1
  65. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  66. data/lib/purecloudplatformclientv2/models/division.rb +253 -0
  67. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  68. data/lib/purecloudplatformclientv2/models/flow.rb +1 -1
  69. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +27 -1
  70. data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +23 -9
  71. data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +29 -1
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
  74. data/lib/purecloudplatformclientv2/models/message_media.rb +82 -4
  75. data/lib/purecloudplatformclientv2/models/message_media_data.rb +411 -0
  76. data/lib/purecloudplatformclientv2/models/message_sticker.rb +228 -0
  77. data/lib/purecloudplatformclientv2/models/outbound_settings.rb +27 -1
  78. data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
  79. data/lib/purecloudplatformclientv2/models/survey_form.rb +53 -1
  80. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
  81. data/lib/purecloudplatformclientv2/version.rb +1 -1
  82. metadata +8 -2
@@ -2580,6 +2580,91 @@ module PureCloud
2580
2580
  return data, status_code, headers
2581
2581
  end
2582
2582
 
2583
+ # Get media
2584
+ #
2585
+ # @param conversation_id conversationId
2586
+ # @param communication_id communicationId
2587
+ # @param media_id mediaId
2588
+ # @param [Hash] opts the optional parameters
2589
+ # @return [MessageMediaData]
2590
+ def get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id, opts = {})
2591
+ data, _status_code, _headers = get_conversations_message_communication_messages_media_media_id_with_http_info(conversation_id, communication_id, media_id, opts)
2592
+ return data
2593
+ end
2594
+
2595
+ # Get media
2596
+ #
2597
+ # @param conversation_id conversationId
2598
+ # @param communication_id communicationId
2599
+ # @param media_id mediaId
2600
+ # @param [Hash] opts the optional parameters
2601
+ # @return [Array<(MessageMediaData, Fixnum, Hash)>] MessageMediaData data, response status code and response headers
2602
+ def get_conversations_message_communication_messages_media_media_id_with_http_info(conversation_id, communication_id, media_id, opts = {})
2603
+ if @api_client.config.debugging
2604
+ @api_client.config.logger.debug "Calling API: ConversationsApi.get_conversations_message_communication_messages_media_media_id ..."
2605
+ end
2606
+
2607
+
2608
+ # verify the required parameter 'conversation_id' is set
2609
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversations_message_communication_messages_media_media_id" if conversation_id.nil?
2610
+
2611
+
2612
+
2613
+
2614
+
2615
+
2616
+ # verify the required parameter 'communication_id' is set
2617
+ fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.get_conversations_message_communication_messages_media_media_id" if communication_id.nil?
2618
+
2619
+
2620
+
2621
+
2622
+
2623
+
2624
+ # verify the required parameter 'media_id' is set
2625
+ fail ArgumentError, "Missing the required parameter 'media_id' when calling ConversationsApi.get_conversations_message_communication_messages_media_media_id" if media_id.nil?
2626
+
2627
+
2628
+
2629
+
2630
+
2631
+ # resource path
2632
+ local_var_path = "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s).sub('{' + 'mediaId' + '}', media_id.to_s)
2633
+
2634
+ # query parameters
2635
+ query_params = {}
2636
+
2637
+ # header parameters
2638
+ header_params = {}
2639
+
2640
+ # HTTP header 'Accept' (if needed)
2641
+ local_header_accept = ['application/json']
2642
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2643
+
2644
+ # HTTP header 'Content-Type'
2645
+ local_header_content_type = ['application/json']
2646
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2647
+
2648
+ # form parameters
2649
+ form_params = {}
2650
+
2651
+ # http body (model)
2652
+ post_body = nil
2653
+
2654
+ auth_names = ['PureCloud Auth']
2655
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2656
+ :header_params => header_params,
2657
+ :query_params => query_params,
2658
+ :form_params => form_params,
2659
+ :body => post_body,
2660
+ :auth_names => auth_names,
2661
+ :return_type => 'MessageMediaData')
2662
+ if @api_client.config.debugging
2663
+ @api_client.config.logger.debug "API called: ConversationsApi#get_conversations_message_communication_messages_media_media_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2664
+ end
2665
+ return data, status_code, headers
2666
+ end
2667
+
2583
2668
  # Get message
2584
2669
  #
2585
2670
  # @param conversation_id conversationId
@@ -7030,6 +7115,81 @@ module PureCloud
7030
7115
  return data, status_code, headers
7031
7116
  end
7032
7117
 
7118
+ # Create media
7119
+ #
7120
+ # @param conversation_id conversationId
7121
+ # @param communication_id communicationId
7122
+ # @param [Hash] opts the optional parameters
7123
+ # @return [MessageMediaData]
7124
+ def post_conversations_message_communication_messages_media(conversation_id, communication_id, opts = {})
7125
+ data, _status_code, _headers = post_conversations_message_communication_messages_media_with_http_info(conversation_id, communication_id, opts)
7126
+ return data
7127
+ end
7128
+
7129
+ # Create media
7130
+ #
7131
+ # @param conversation_id conversationId
7132
+ # @param communication_id communicationId
7133
+ # @param [Hash] opts the optional parameters
7134
+ # @return [Array<(MessageMediaData, Fixnum, Hash)>] MessageMediaData data, response status code and response headers
7135
+ def post_conversations_message_communication_messages_media_with_http_info(conversation_id, communication_id, opts = {})
7136
+ if @api_client.config.debugging
7137
+ @api_client.config.logger.debug "Calling API: ConversationsApi.post_conversations_message_communication_messages_media ..."
7138
+ end
7139
+
7140
+
7141
+ # verify the required parameter 'conversation_id' is set
7142
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversations_message_communication_messages_media" if conversation_id.nil?
7143
+
7144
+
7145
+
7146
+
7147
+
7148
+
7149
+ # verify the required parameter 'communication_id' is set
7150
+ fail ArgumentError, "Missing the required parameter 'communication_id' when calling ConversationsApi.post_conversations_message_communication_messages_media" if communication_id.nil?
7151
+
7152
+
7153
+
7154
+
7155
+
7156
+ # resource path
7157
+ local_var_path = "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)
7158
+
7159
+ # query parameters
7160
+ query_params = {}
7161
+
7162
+ # header parameters
7163
+ header_params = {}
7164
+
7165
+ # HTTP header 'Accept' (if needed)
7166
+ local_header_accept = ['application/json']
7167
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
7168
+
7169
+ # HTTP header 'Content-Type'
7170
+ local_header_content_type = ['application/json']
7171
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
7172
+
7173
+ # form parameters
7174
+ form_params = {}
7175
+
7176
+ # http body (model)
7177
+ post_body = nil
7178
+
7179
+ auth_names = ['PureCloud Auth']
7180
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
7181
+ :header_params => header_params,
7182
+ :query_params => query_params,
7183
+ :form_params => form_params,
7184
+ :body => post_body,
7185
+ :auth_names => auth_names,
7186
+ :return_type => 'MessageMediaData')
7187
+ if @api_client.config.debugging
7188
+ @api_client.config.logger.debug "API called: ConversationsApi#post_conversations_message_communication_messages_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7189
+ end
7190
+ return data, status_code, headers
7191
+ end
7192
+
7033
7193
  # Get messages in batch
7034
7194
  #
7035
7195
  # @param conversation_id conversationId
@@ -1904,6 +1904,128 @@ module PureCloud
1904
1904
  return data, status_code, headers
1905
1905
  end
1906
1906
 
1907
+ # Search for queues by name
1908
+ #
1909
+ # @param [Hash] opts the optional parameters
1910
+ # @option opts [Integer] :page_size Page size (default to 25)
1911
+ # @option opts [Integer] :page_number Page number (default to 1)
1912
+ # @option opts [String] :sort_by Sort by (default to name)
1913
+ # @option opts [String] :sort_order Sort order (default to asc)
1914
+ # @option opts [String] :name Name
1915
+ # @option opts [Array<String>] :id Queue ID(s)
1916
+ # @option opts [Array<String>] :division_id Division ID(s)
1917
+ # @return [QueueEntityListing]
1918
+ def get_routing_queues_search(opts = {})
1919
+ data, _status_code, _headers = get_routing_queues_search_with_http_info(opts)
1920
+ return data
1921
+ end
1922
+
1923
+ # Search for queues by name
1924
+ #
1925
+ # @param [Hash] opts the optional parameters
1926
+ # @option opts [Integer] :page_size Page size
1927
+ # @option opts [Integer] :page_number Page number
1928
+ # @option opts [String] :sort_by Sort by
1929
+ # @option opts [String] :sort_order Sort order
1930
+ # @option opts [String] :name Name
1931
+ # @option opts [Array<String>] :id Queue ID(s)
1932
+ # @option opts [Array<String>] :division_id Division ID(s)
1933
+ # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers
1934
+ def get_routing_queues_search_with_http_info(opts = {})
1935
+ if @api_client.config.debugging
1936
+ @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queues_search ..."
1937
+ end
1938
+
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+
1959
+
1960
+ if opts[:'sort_order'] && !['asc', 'desc', 'score'].include?(opts[:'sort_order'])
1961
+ fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc, score'
1962
+ end
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+ # resource path
1986
+ local_var_path = "/api/v2/routing/queues/search".sub('{format}','json')
1987
+
1988
+ # query parameters
1989
+ query_params = {}
1990
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1991
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1992
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1993
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1994
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1995
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1996
+ query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
1997
+
1998
+ # header parameters
1999
+ header_params = {}
2000
+
2001
+ # HTTP header 'Accept' (if needed)
2002
+ local_header_accept = ['application/json']
2003
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2004
+
2005
+ # HTTP header 'Content-Type'
2006
+ local_header_content_type = ['application/json']
2007
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2008
+
2009
+ # form parameters
2010
+ form_params = {}
2011
+
2012
+ # http body (model)
2013
+ post_body = nil
2014
+
2015
+ auth_names = ['PureCloud Auth']
2016
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2017
+ :header_params => header_params,
2018
+ :query_params => query_params,
2019
+ :form_params => form_params,
2020
+ :body => post_body,
2021
+ :auth_names => auth_names,
2022
+ :return_type => 'QueueEntityListing')
2023
+ if @api_client.config.debugging
2024
+ @api_client.config.logger.debug "API called: RoutingApi#get_routing_queues_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2025
+ end
2026
+ return data, status_code, headers
2027
+ end
2028
+
1907
2029
  # Get Routing Skill
1908
2030
  #
1909
2031
  # @param skill_id Skill ID
@@ -471,6 +471,8 @@ module PureCloud
471
471
  # @option opts [Integer] :page_size
472
472
  # @option opts [Integer] :page_number
473
473
  # @option opts [String] :expand
474
+ # @option opts [String] :feature
475
+ # @option opts [String] :division_id
474
476
  # @return [ManagementUnitListing]
475
477
  def get_workforcemanagement_managementunits(opts = {})
476
478
  data, _status_code, _headers = get_workforcemanagement_managementunits_with_http_info(opts)
@@ -483,6 +485,8 @@ module PureCloud
483
485
  # @option opts [Integer] :page_size
484
486
  # @option opts [Integer] :page_number
485
487
  # @option opts [String] :expand
488
+ # @option opts [String] :feature
489
+ # @option opts [String] :division_id
486
490
  # @return [Array<(ManagementUnitListing, Fixnum, Hash)>] ManagementUnitListing data, response status code and response headers
487
491
  def get_workforcemanagement_managementunits_with_http_info(opts = {})
488
492
  if @api_client.config.debugging
@@ -511,6 +515,22 @@ module PureCloud
511
515
 
512
516
 
513
517
 
518
+
519
+
520
+
521
+ if opts[:'feature'] && !['Agents', 'ActivityCodes', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
522
+ fail ArgumentError, 'invalid value for "feature", must be one of Agents, ActivityCodes, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShortTermForecasts, TimeOffRequests, WorkPlans'
523
+ end
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
514
534
  # resource path
515
535
  local_var_path = "/api/v2/workforcemanagement/managementunits".sub('{format}','json')
516
536
 
@@ -519,6 +539,8 @@ module PureCloud
519
539
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
520
540
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
521
541
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
542
+ query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
543
+ query_params[:'divisionId'] = opts[:'division_id'] if opts[:'division_id']
522
544
 
523
545
  # header parameters
524
546
  header_params = {}
@@ -76,7 +76,7 @@ module PureCloud
76
76
  http_method = http_method.to_sym.downcase
77
77
 
78
78
  header_params = @default_headers.merge(opts[:header_params] || {})
79
- header_params['purecloud-sdk'] = '35.0.0'
79
+ header_params['purecloud-sdk'] = '36.0.0'
80
80
  query_params = opts[:query_params] || {}
81
81
  form_params = opts[:form_params] || {}
82
82
 
@@ -21,11 +21,21 @@ module PureCloud
21
21
  # The body of the text message.
22
22
  attr_accessor :text_body
23
23
 
24
+ # The media ids associated with the text message.
25
+ attr_accessor :media_ids
26
+
27
+ # The sticker ids associated with the text message.
28
+ attr_accessor :sticker_ids
29
+
24
30
  # Attribute mapping from ruby-style variable name to JSON key.
25
31
  def self.attribute_map
26
32
  {
27
33
 
28
- :'text_body' => :'textBody'
34
+ :'text_body' => :'textBody',
35
+
36
+ :'media_ids' => :'mediaIds',
37
+
38
+ :'sticker_ids' => :'stickerIds'
29
39
 
30
40
  }
31
41
  end
@@ -34,7 +44,11 @@ module PureCloud
34
44
  def self.swagger_types
35
45
  {
36
46
 
37
- :'text_body' => :'String'
47
+ :'text_body' => :'String',
48
+
49
+ :'media_ids' => :'Array<String>',
50
+
51
+ :'sticker_ids' => :'Array<String>'
38
52
 
39
53
  }
40
54
  end
@@ -57,6 +71,28 @@ module PureCloud
57
71
  end
58
72
 
59
73
 
74
+ if attributes.has_key?(:'mediaIds')
75
+
76
+ if (value = attributes[:'mediaIds']).is_a?(Array)
77
+ self.media_ids = value
78
+ end
79
+
80
+
81
+
82
+ end
83
+
84
+
85
+ if attributes.has_key?(:'stickerIds')
86
+
87
+ if (value = attributes[:'stickerIds']).is_a?(Array)
88
+ self.sticker_ids = value
89
+ end
90
+
91
+
92
+
93
+ end
94
+
95
+
60
96
  end
61
97
 
62
98
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -81,6 +117,14 @@ module PureCloud
81
117
 
82
118
 
83
119
 
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
84
128
  end
85
129
 
86
130
 
@@ -89,12 +133,24 @@ module PureCloud
89
133
 
90
134
 
91
135
 
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
92
146
  # Checks equality by comparing each attribute.
93
147
  # @param [Object] Object to be compared
94
148
  def ==(o)
95
149
  return true if self.equal?(o)
96
150
  self.class == o.class &&
97
- text_body == o.text_body
151
+ text_body == o.text_body &&
152
+ media_ids == o.media_ids &&
153
+ sticker_ids == o.sticker_ids
98
154
  end
99
155
 
100
156
  # @see the `==` method
@@ -106,7 +162,7 @@ module PureCloud
106
162
  # Calculates hash code according to all attributes.
107
163
  # @return [Fixnum] Hash code
108
164
  def hash
109
- [text_body].hash
165
+ [text_body, media_ids, sticker_ids].hash
110
166
  end
111
167
 
112
168
  # build the object from hash