purecloud 0.18.0 → 0.25.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 (143) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +2 -2
  3. data/Gemfile.lock +2 -2
  4. data/README.md +1 -7
  5. data/config-ruby.json +1 -1
  6. data/extensions/auth.rb +2 -2
  7. data/lib/purecloud.rb +110 -75
  8. data/lib/purecloud/api/architect_api.rb +3127 -74
  9. data/lib/purecloud/api/attributes_api.rb +33 -33
  10. data/lib/purecloud/api/authorization_api.rb +83 -83
  11. data/lib/purecloud/api/compliance_api.rb +5 -5
  12. data/lib/purecloud/api/configuration_api.rb +594 -397
  13. data/lib/purecloud/api/content_management_api.rb +183 -183
  14. data/lib/purecloud/api/conversations_api.rb +289 -159
  15. data/lib/purecloud/api/downloads_api.rb +6 -6
  16. data/lib/purecloud/api/external_contacts_api.rb +1693 -0
  17. data/lib/purecloud/api/fax_api.rb +24 -24
  18. data/lib/purecloud/api/geolocation_api.rb +14 -14
  19. data/lib/purecloud/api/greetings_api.rb +68 -68
  20. data/lib/purecloud/api/groups_api.rb +31 -20
  21. data/lib/purecloud/api/languages_api.rb +18 -11
  22. data/lib/purecloud/api/licensing_api.rb +5 -5
  23. data/lib/purecloud/api/locations_api.rb +11 -11
  24. data/lib/purecloud/api/notifications_api.rb +41 -41
  25. data/lib/purecloud/api/o_auth_api.rb +69 -69
  26. data/lib/purecloud/api/outbound_api.rb +505 -325
  27. data/lib/purecloud/api/presence_api.rb +65 -65
  28. data/lib/purecloud/api/quality_api.rb +66 -639
  29. data/lib/purecloud/api/recording_api.rb +1343 -0
  30. data/lib/purecloud/api/response_management_api.rb +687 -0
  31. data/lib/purecloud/api/routing_api.rb +224 -170
  32. data/lib/purecloud/api/scripts_api.rb +52 -52
  33. data/lib/purecloud/api/search_api.rb +5 -5
  34. data/lib/purecloud/api/stations_api.rb +8 -8
  35. data/lib/purecloud/api/telephony_providers_edge_api.rb +138 -138
  36. data/lib/purecloud/api/user_recordings_api.rb +29 -29
  37. data/lib/purecloud/api/users_api.rb +123 -123
  38. data/lib/purecloud/api/utilities_api.rb +71 -15
  39. data/lib/purecloud/api/voicemail_api.rb +42 -42
  40. data/lib/purecloud/api_client.rb +1 -1
  41. data/lib/purecloud/models/address.rb +49 -51
  42. data/lib/purecloud/models/attribute_filter_item.rb +177 -0
  43. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +238 -0
  44. data/lib/purecloud/models/available_additional_service.rb +40 -1
  45. data/lib/purecloud/models/{topic_entity_listing.rb → available_topic_entity_listing.rb} +1 -1
  46. data/lib/purecloud/models/call.rb +36 -5
  47. data/lib/purecloud/models/{line_properties.rb → call_command.rb} +13 -3
  48. data/lib/purecloud/models/callback.rb +15 -4
  49. data/lib/purecloud/models/campaign.rb +219 -17
  50. data/lib/purecloud/models/campaign_progress.rb +186 -0
  51. data/lib/purecloud/models/channel_topic_entity_listing.rb +238 -0
  52. data/lib/purecloud/models/charge.rb +14 -4
  53. data/lib/purecloud/models/{attribute_value.rb → client_text_table_transform.rb} +52 -82
  54. data/lib/purecloud/models/contact.rb +1 -1
  55. data/lib/purecloud/models/contact_list.rb +111 -1
  56. data/lib/purecloud/models/contact_listing.rb +238 -0
  57. data/lib/purecloud/models/content_attribute_filter_item.rb +177 -0
  58. data/lib/purecloud/models/content_facet_filter_item.rb +1 -1
  59. data/lib/purecloud/models/content_query_request.rb +16 -4
  60. data/lib/purecloud/models/control.rb +221 -0
  61. data/lib/purecloud/models/{flow_activate_request.rb → control_options.rb} +18 -12
  62. data/lib/purecloud/models/create_callback_command.rb +200 -0
  63. data/lib/purecloud/models/discount.rb +220 -0
  64. data/lib/purecloud/models/document.rb +13 -1
  65. data/lib/purecloud/models/document_attribute.rb +158 -0
  66. data/lib/purecloud/models/document_update.rb +28 -16
  67. data/lib/purecloud/models/document_upload.rb +4 -16
  68. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +238 -0
  69. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +238 -0
  70. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +1 -1
  71. data/lib/purecloud/models/edge_line.rb +1 -1
  72. data/lib/purecloud/models/edge_logs_job.rb +181 -0
  73. data/lib/purecloud/models/edge_logs_job_file.rb +243 -0
  74. data/lib/purecloud/models/edge_logs_job_request.rb +168 -0
  75. data/lib/purecloud/models/{backend_work_item_data_element.rb → edge_logs_job_response.rb} +16 -24
  76. data/lib/purecloud/models/{flow_lock_request.rb → edge_logs_job_upload_request.rb} +10 -12
  77. data/lib/purecloud/models/email.rb +15 -4
  78. data/lib/purecloud/models/endpoint.rb +1 -1
  79. data/lib/purecloud/models/{flow_associate_workspaces_request.rb → estimated_wait_time_predictions.rb} +10 -11
  80. data/lib/purecloud/models/external_contact.rb +320 -0
  81. data/lib/purecloud/models/external_organization.rb +306 -0
  82. data/lib/purecloud/models/external_organization_listing.rb +238 -0
  83. data/lib/purecloud/models/facet_filter_item.rb +1 -1
  84. data/lib/purecloud/models/flow_body.rb +1 -1
  85. data/lib/purecloud/models/flow_body_format.rb +10 -20
  86. data/lib/purecloud/models/flow_terminate_request.rb +3 -16
  87. data/lib/purecloud/models/form.rb +148 -0
  88. data/lib/purecloud/models/group.rb +11 -1
  89. data/lib/purecloud/models/health_check_info.rb +268 -0
  90. data/lib/purecloud/models/{body_2.rb → inline_response_200.rb} +1 -1
  91. data/lib/purecloud/models/integration_type.rb +209 -0
  92. data/lib/purecloud/models/integration_type_entity_listing.rb +238 -0
  93. data/lib/purecloud/models/key_rotation_schedule.rb +1 -0
  94. data/lib/purecloud/models/language.rb +41 -1
  95. data/lib/purecloud/models/line.rb +1 -1
  96. data/lib/purecloud/models/line_base.rb +1 -1
  97. data/lib/purecloud/models/media_policies.rb +169 -0
  98. data/lib/purecloud/models/media_policy.rb +171 -0
  99. data/lib/purecloud/models/note.rb +200 -0
  100. data/lib/purecloud/models/{user_station_resource.rb → note_listing.rb} +68 -58
  101. data/lib/purecloud/models/o_auth_client.rb +1 -1
  102. data/lib/purecloud/models/page.rb +2 -2
  103. data/lib/purecloud/models/{byte_buffer.rb → payment_method.rb} +48 -61
  104. data/lib/purecloud/models/payment_method_listing.rb +238 -0
  105. data/lib/purecloud/models/payment_token_provider.rb +180 -0
  106. data/lib/purecloud/models/phone.rb +1 -1
  107. data/lib/purecloud/models/phone_base.rb +1 -1
  108. data/lib/purecloud/models/phone_number.rb +198 -0
  109. data/lib/purecloud/models/phones_reboot.rb +14 -4
  110. data/lib/purecloud/models/policy.rb +14 -1
  111. data/lib/purecloud/models/prediction_results.rb +167 -0
  112. data/lib/purecloud/models/query_request.rb +16 -4
  113. data/lib/purecloud/models/queue_member_entity_listing.rb +1 -1
  114. data/lib/purecloud/models/quote.rb +13 -1
  115. data/lib/purecloud/models/recording_settings.rb +146 -0
  116. data/lib/purecloud/models/relationship.rb +201 -0
  117. data/lib/purecloud/models/relationship_listing.rb +238 -0
  118. data/lib/purecloud/models/report_schedule.rb +3 -2
  119. data/lib/purecloud/models/service_type.rb +12 -1
  120. data/lib/purecloud/models/social_expression.rb +25 -4
  121. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +1 -1
  122. data/lib/purecloud/models/template.rb +1 -1
  123. data/lib/purecloud/models/text_table_transform_entity_listing.rb +1 -1
  124. data/lib/purecloud/models/ticker.rb +158 -0
  125. data/lib/purecloud/models/time_slot.rb +1 -0
  126. data/lib/purecloud/models/trunk_base.rb +1 -1
  127. data/lib/purecloud/models/vendor_connection_request.rb +166 -0
  128. data/lib/purecloud/models/video.rb +15 -4
  129. data/lib/purecloud/models/work_item_definition.rb +8 -10
  130. data/lib/purecloud/version.rb +1 -1
  131. data/ossindex.json +17 -0
  132. data/purecloud.gemspec +4 -3
  133. data/rakefile +3 -15
  134. data/spec/test.rb +6 -3
  135. data/swagger.json +1 -1
  136. data/swagger_template/api_client.mustache +304 -0
  137. data/swagger_template/base_object.mustache +90 -0
  138. data/{PureCloud.gemspec → swagger_template/gemspec.mustache} +12 -11
  139. data/version.json +1 -1
  140. metadata +76 -25
  141. data/lib/purecloud/api/analytics_api.rb +0 -1554
  142. data/lib/purecloud/api/orphaned_recordings_api.rb +0 -205
  143. data/newVersion.md +0 -1
@@ -13,10 +13,10 @@ module PureCloud
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [Integer] :page_size Page size
15
15
  # @option opts [Integer] :page_number Page number
16
- # @option opts [String] :name Name
16
+ # @option opts [String] :sort_order Ascending or descending sort order
17
17
  # @return [GroupEntityListing]
18
- def get(opts = {})
19
- data, status_code, headers = get_with_http_info(opts)
18
+ def get_groups(opts = {})
19
+ data, status_code, headers = get_groups_with_http_info(opts)
20
20
  return data
21
21
  end
22
22
 
@@ -25,11 +25,15 @@ module PureCloud
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Integer] :page_size Page size
27
27
  # @option opts [Integer] :page_number Page number
28
- # @option opts [String] :name Name
28
+ # @option opts [String] :sort_order Ascending or descending sort order
29
29
  # @return [Array<(GroupEntityListing, Fixnum, Hash)>] GroupEntityListing data, response status code and response headers
30
- def get_with_http_info(opts = {})
30
+ def get_groups_with_http_info(opts = {})
31
31
  if @api_client.config.debugging
32
- @api_client.config.logger.debug "Calling API: GroupsApi#get ..."
32
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_groups ..."
33
+ end
34
+
35
+ if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
36
+ fail 'invalid value for "sort_order", must be one of [ascending, descending]'
33
37
  end
34
38
 
35
39
  # resource path
@@ -39,7 +43,7 @@ module PureCloud
39
43
  query_params = {}
40
44
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
41
45
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
42
- query_params[:'name'] = opts[:'name'] if opts[:'name']
46
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
43
47
 
44
48
  # header parameters
45
49
  header_params = {}
@@ -68,7 +72,7 @@ module PureCloud
68
72
  :auth_names => auth_names,
69
73
  :return_type => 'GroupEntityListing')
70
74
  if @api_client.config.debugging
71
- @api_client.config.logger.debug "API called: GroupsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ @api_client.config.logger.debug "API called: GroupsApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
72
76
  end
73
77
  return data, status_code, headers
74
78
  end
@@ -78,8 +82,8 @@ module PureCloud
78
82
  # @param group_id Group ID
79
83
  # @param [Hash] opts the optional parameters
80
84
  # @return [Group]
81
- def get_group(group_id, opts = {})
82
- data, status_code, headers = get_group_with_http_info(group_id, opts)
85
+ def get_group_id(group_id, opts = {})
86
+ data, status_code, headers = get_group_id_with_http_info(group_id, opts)
83
87
  return data
84
88
  end
85
89
 
@@ -88,13 +92,13 @@ module PureCloud
88
92
  # @param group_id Group ID
89
93
  # @param [Hash] opts the optional parameters
90
94
  # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
91
- def get_group_with_http_info(group_id, opts = {})
95
+ def get_group_id_with_http_info(group_id, opts = {})
92
96
  if @api_client.config.debugging
93
- @api_client.config.logger.debug "Calling API: GroupsApi#get_group ..."
97
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_group_id ..."
94
98
  end
95
99
 
96
100
  # verify the required parameter 'group_id' is set
97
- fail "Missing the required parameter 'group_id' when calling get_group" if group_id.nil?
101
+ fail "Missing the required parameter 'group_id' when calling get_group_id" if group_id.nil?
98
102
 
99
103
  # resource path
100
104
  path = "/api/v1/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
@@ -129,7 +133,7 @@ module PureCloud
129
133
  :auth_names => auth_names,
130
134
  :return_type => 'Group')
131
135
  if @api_client.config.debugging
132
- @api_client.config.logger.debug "API called: GroupsApi#get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ @api_client.config.logger.debug "API called: GroupsApi#get_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
133
137
  end
134
138
  return data, status_code, headers
135
139
  end
@@ -140,9 +144,10 @@ module PureCloud
140
144
  # @param [Hash] opts the optional parameters
141
145
  # @option opts [Integer] :page_size Page size
142
146
  # @option opts [Integer] :page_number Page number
147
+ # @option opts [String] :sort_order Ascending or descending sort order
143
148
  # @return [UserEntityListing]
144
- def get_group_members(group_id, opts = {})
145
- data, status_code, headers = get_group_members_with_http_info(group_id, opts)
149
+ def get_group_id_members(group_id, opts = {})
150
+ data, status_code, headers = get_group_id_members_with_http_info(group_id, opts)
146
151
  return data
147
152
  end
148
153
 
@@ -152,14 +157,19 @@ module PureCloud
152
157
  # @param [Hash] opts the optional parameters
153
158
  # @option opts [Integer] :page_size Page size
154
159
  # @option opts [Integer] :page_number Page number
160
+ # @option opts [String] :sort_order Ascending or descending sort order
155
161
  # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
156
- def get_group_members_with_http_info(group_id, opts = {})
162
+ def get_group_id_members_with_http_info(group_id, opts = {})
157
163
  if @api_client.config.debugging
158
- @api_client.config.logger.debug "Calling API: GroupsApi#get_group_members ..."
164
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_group_id_members ..."
159
165
  end
160
166
 
161
167
  # verify the required parameter 'group_id' is set
162
- fail "Missing the required parameter 'group_id' when calling get_group_members" if group_id.nil?
168
+ fail "Missing the required parameter 'group_id' when calling get_group_id_members" if group_id.nil?
169
+
170
+ if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
171
+ fail 'invalid value for "sort_order", must be one of [ascending, descending]'
172
+ end
163
173
 
164
174
  # resource path
165
175
  path = "/api/v1/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
@@ -168,6 +178,7 @@ module PureCloud
168
178
  query_params = {}
169
179
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
170
180
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
181
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
171
182
 
172
183
  # header parameters
173
184
  header_params = {}
@@ -196,7 +207,7 @@ module PureCloud
196
207
  :auth_names => auth_names,
197
208
  :return_type => 'UserEntityListing')
198
209
  if @api_client.config.debugging
199
- @api_client.config.logger.debug "API called: GroupsApi#get_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
210
+ @api_client.config.logger.debug "API called: GroupsApi#get_group_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
200
211
  end
201
212
  return data, status_code, headers
202
213
  end
@@ -13,9 +13,10 @@ module PureCloud
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [Integer] :page_size Page size
15
15
  # @option opts [Integer] :page_number Page number
16
+ # @option opts [String] :sort_order Ascending or descending sort order
16
17
  # @return [LanguageEntityListing]
17
- def get(opts = {})
18
- data, status_code, headers = get_with_http_info(opts)
18
+ def get_languages(opts = {})
19
+ data, status_code, headers = get_languages_with_http_info(opts)
19
20
  return data
20
21
  end
21
22
 
@@ -24,10 +25,15 @@ module PureCloud
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @option opts [Integer] :page_size Page size
26
27
  # @option opts [Integer] :page_number Page number
28
+ # @option opts [String] :sort_order Ascending or descending sort order
27
29
  # @return [Array<(LanguageEntityListing, Fixnum, Hash)>] LanguageEntityListing data, response status code and response headers
28
- def get_with_http_info(opts = {})
30
+ def get_languages_with_http_info(opts = {})
29
31
  if @api_client.config.debugging
30
- @api_client.config.logger.debug "Calling API: LanguagesApi#get ..."
32
+ @api_client.config.logger.debug "Calling API: LanguagesApi#get_languages ..."
33
+ end
34
+
35
+ if opts[:'sort_order'] && !['[ascending', 'descending]'].include?(opts[:'sort_order'])
36
+ fail 'invalid value for "sort_order", must be one of [ascending, descending]'
31
37
  end
32
38
 
33
39
  # resource path
@@ -37,6 +43,7 @@ module PureCloud
37
43
  query_params = {}
38
44
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
39
45
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
46
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
40
47
 
41
48
  # header parameters
42
49
  header_params = {}
@@ -65,7 +72,7 @@ module PureCloud
65
72
  :auth_names => auth_names,
66
73
  :return_type => 'LanguageEntityListing')
67
74
  if @api_client.config.debugging
68
- @api_client.config.logger.debug "API called: LanguagesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ @api_client.config.logger.debug "API called: LanguagesApi#get_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
69
76
  end
70
77
  return data, status_code, headers
71
78
  end
@@ -75,8 +82,8 @@ module PureCloud
75
82
  # @param language_id Language ID
76
83
  # @param [Hash] opts the optional parameters
77
84
  # @return [Language]
78
- def get_language(language_id, opts = {})
79
- data, status_code, headers = get_language_with_http_info(language_id, opts)
85
+ def get_language_id(language_id, opts = {})
86
+ data, status_code, headers = get_language_id_with_http_info(language_id, opts)
80
87
  return data
81
88
  end
82
89
 
@@ -85,13 +92,13 @@ module PureCloud
85
92
  # @param language_id Language ID
86
93
  # @param [Hash] opts the optional parameters
87
94
  # @return [Array<(Language, Fixnum, Hash)>] Language data, response status code and response headers
88
- def get_language_with_http_info(language_id, opts = {})
95
+ def get_language_id_with_http_info(language_id, opts = {})
89
96
  if @api_client.config.debugging
90
- @api_client.config.logger.debug "Calling API: LanguagesApi#get_language ..."
97
+ @api_client.config.logger.debug "Calling API: LanguagesApi#get_language_id ..."
91
98
  end
92
99
 
93
100
  # verify the required parameter 'language_id' is set
94
- fail "Missing the required parameter 'language_id' when calling get_language" if language_id.nil?
101
+ fail "Missing the required parameter 'language_id' when calling get_language_id" if language_id.nil?
95
102
 
96
103
  # resource path
97
104
  path = "/api/v1/languages/{languageId}".sub('{format}','json').sub('{' + 'languageId' + '}', language_id.to_s)
@@ -126,7 +133,7 @@ module PureCloud
126
133
  :auth_names => auth_names,
127
134
  :return_type => 'Language')
128
135
  if @api_client.config.debugging
129
- @api_client.config.logger.debug "API called: LanguagesApi#get_language\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ @api_client.config.logger.debug "API called: LanguagesApi#get_language_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
130
137
  end
131
138
  return data, status_code, headers
132
139
  end
@@ -249,8 +249,8 @@ module PureCloud
249
249
  # @option opts [Array<String>] :id ID
250
250
  # @option opts [Permissions] :body The permissions details
251
251
  # @return [Array<LicensesByPermission>]
252
- def create_permissions(opts = {})
253
- data, status_code, headers = create_permissions_with_http_info(opts)
252
+ def post_permissions(opts = {})
253
+ data, status_code, headers = post_permissions_with_http_info(opts)
254
254
  return data
255
255
  end
256
256
 
@@ -260,9 +260,9 @@ module PureCloud
260
260
  # @option opts [Array<String>] :id ID
261
261
  # @option opts [Permissions] :body The permissions details
262
262
  # @return [Array<(Array<LicensesByPermission>, Fixnum, Hash)>] Array<LicensesByPermission> data, response status code and response headers
263
- def create_permissions_with_http_info(opts = {})
263
+ def post_permissions_with_http_info(opts = {})
264
264
  if @api_client.config.debugging
265
- @api_client.config.logger.debug "Calling API: LicensingApi#create_permissions ..."
265
+ @api_client.config.logger.debug "Calling API: LicensingApi#post_permissions ..."
266
266
  end
267
267
 
268
268
  # resource path
@@ -299,7 +299,7 @@ module PureCloud
299
299
  :auth_names => auth_names,
300
300
  :return_type => 'Array<LicensesByPermission>')
301
301
  if @api_client.config.debugging
302
- @api_client.config.logger.debug "API called: LicensingApi#create_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
302
+ @api_client.config.logger.debug "API called: LicensingApi#post_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
303
  end
304
304
  return data, status_code, headers
305
305
  end
@@ -16,8 +16,8 @@ module PureCloud
16
16
  # @option opts [Integer] :page_size Page size
17
17
  # @option opts [Integer] :page_number Page number
18
18
  # @return [LocationEntityListing]
19
- def get(opts = {})
20
- data, status_code, headers = get_with_http_info(opts)
19
+ def get_locations(opts = {})
20
+ data, status_code, headers = get_locations_with_http_info(opts)
21
21
  return data
22
22
  end
23
23
 
@@ -29,9 +29,9 @@ module PureCloud
29
29
  # @option opts [Integer] :page_size Page size
30
30
  # @option opts [Integer] :page_number Page number
31
31
  # @return [Array<(LocationEntityListing, Fixnum, Hash)>] LocationEntityListing data, response status code and response headers
32
- def get_with_http_info(opts = {})
32
+ def get_locations_with_http_info(opts = {})
33
33
  if @api_client.config.debugging
34
- @api_client.config.logger.debug "Calling API: LocationsApi#get ..."
34
+ @api_client.config.logger.debug "Calling API: LocationsApi#get_locations ..."
35
35
  end
36
36
 
37
37
  if opts[:'state'] && !['ACTIVE', 'DELETED'].include?(opts[:'state'])
@@ -75,7 +75,7 @@ module PureCloud
75
75
  :auth_names => auth_names,
76
76
  :return_type => 'LocationEntityListing')
77
77
  if @api_client.config.debugging
78
- @api_client.config.logger.debug "API called: LocationsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
79
  end
80
80
  return data, status_code, headers
81
81
  end
@@ -85,8 +85,8 @@ module PureCloud
85
85
  # @param location_id Location ID
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [Location]
88
- def get_location(location_id, opts = {})
89
- data, status_code, headers = get_location_with_http_info(location_id, opts)
88
+ def get_location_id(location_id, opts = {})
89
+ data, status_code, headers = get_location_id_with_http_info(location_id, opts)
90
90
  return data
91
91
  end
92
92
 
@@ -95,13 +95,13 @@ module PureCloud
95
95
  # @param location_id Location ID
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @return [Array<(Location, Fixnum, Hash)>] Location data, response status code and response headers
98
- def get_location_with_http_info(location_id, opts = {})
98
+ def get_location_id_with_http_info(location_id, opts = {})
99
99
  if @api_client.config.debugging
100
- @api_client.config.logger.debug "Calling API: LocationsApi#get_location ..."
100
+ @api_client.config.logger.debug "Calling API: LocationsApi#get_location_id ..."
101
101
  end
102
102
 
103
103
  # verify the required parameter 'location_id' is set
104
- fail "Missing the required parameter 'location_id' when calling get_location" if location_id.nil?
104
+ fail "Missing the required parameter 'location_id' when calling get_location_id" if location_id.nil?
105
105
 
106
106
  # resource path
107
107
  path = "/api/v1/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s)
@@ -136,7 +136,7 @@ module PureCloud
136
136
  :auth_names => auth_names,
137
137
  :return_type => 'Location')
138
138
  if @api_client.config.debugging
139
- @api_client.config.logger.debug "API called: LocationsApi#get_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
139
+ @api_client.config.logger.debug "API called: LocationsApi#get_location_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
140
  end
141
141
  return data, status_code, headers
142
142
  end
@@ -11,7 +11,7 @@ module PureCloud
11
11
  # Get available notification topics.
12
12
  #
13
13
  # @param [Hash] opts the optional parameters
14
- # @return [TopicEntityListing]
14
+ # @return [AvailableTopicEntityListing]
15
15
  def get_availabletopics(opts = {})
16
16
  data, status_code, headers = get_availabletopics_with_http_info(opts)
17
17
  return data
@@ -20,7 +20,7 @@ module PureCloud
20
20
  # Get available notification topics.
21
21
  #
22
22
  # @param [Hash] opts the optional parameters
23
- # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
23
+ # @return [Array<(AvailableTopicEntityListing, Fixnum, Hash)>] AvailableTopicEntityListing data, response status code and response headers
24
24
  def get_availabletopics_with_http_info(opts = {})
25
25
  if @api_client.config.debugging
26
26
  @api_client.config.logger.debug "Calling API: NotificationsApi#get_availabletopics ..."
@@ -57,7 +57,7 @@ module PureCloud
57
57
  :form_params => form_params,
58
58
  :body => post_body,
59
59
  :auth_names => auth_names,
60
- :return_type => 'TopicEntityListing')
60
+ :return_type => 'AvailableTopicEntityListing')
61
61
  if @api_client.config.debugging
62
62
  @api_client.config.logger.debug "API called: NotificationsApi#get_availabletopics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
63
63
  end
@@ -124,8 +124,8 @@ module PureCloud
124
124
  # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
125
125
  # @param [Hash] opts the optional parameters
126
126
  # @return [Channel]
127
- def create_channels(opts = {})
128
- data, status_code, headers = create_channels_with_http_info(opts)
127
+ def post_channels(opts = {})
128
+ data, status_code, headers = post_channels_with_http_info(opts)
129
129
  return data
130
130
  end
131
131
 
@@ -133,9 +133,9 @@ module PureCloud
133
133
  # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
134
134
  # @param [Hash] opts the optional parameters
135
135
  # @return [Array<(Channel, Fixnum, Hash)>] Channel data, response status code and response headers
136
- def create_channels_with_http_info(opts = {})
136
+ def post_channels_with_http_info(opts = {})
137
137
  if @api_client.config.debugging
138
- @api_client.config.logger.debug "Calling API: NotificationsApi#create_channels ..."
138
+ @api_client.config.logger.debug "Calling API: NotificationsApi#post_channels ..."
139
139
  end
140
140
 
141
141
  # resource path
@@ -171,7 +171,7 @@ module PureCloud
171
171
  :auth_names => auth_names,
172
172
  :return_type => 'Channel')
173
173
  if @api_client.config.debugging
174
- @api_client.config.logger.debug "API called: NotificationsApi#create_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
174
+ @api_client.config.logger.debug "API called: NotificationsApi#post_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
175
175
  end
176
176
  return data, status_code, headers
177
177
  end
@@ -180,9 +180,9 @@ module PureCloud
180
180
  #
181
181
  # @param channel_id Channel ID
182
182
  # @param [Hash] opts the optional parameters
183
- # @return [TopicEntityListing]
184
- def get_channel_subscriptions(channel_id, opts = {})
185
- data, status_code, headers = get_channel_subscriptions_with_http_info(channel_id, opts)
183
+ # @return [ChannelTopicEntityListing]
184
+ def get_channels_channel_id_subscriptions(channel_id, opts = {})
185
+ data, status_code, headers = get_channels_channel_id_subscriptions_with_http_info(channel_id, opts)
186
186
  return data
187
187
  end
188
188
 
@@ -190,14 +190,14 @@ module PureCloud
190
190
  #
191
191
  # @param channel_id Channel ID
192
192
  # @param [Hash] opts the optional parameters
193
- # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
194
- def get_channel_subscriptions_with_http_info(channel_id, opts = {})
193
+ # @return [Array<(ChannelTopicEntityListing, Fixnum, Hash)>] ChannelTopicEntityListing data, response status code and response headers
194
+ def get_channels_channel_id_subscriptions_with_http_info(channel_id, opts = {})
195
195
  if @api_client.config.debugging
196
- @api_client.config.logger.debug "Calling API: NotificationsApi#get_channel_subscriptions ..."
196
+ @api_client.config.logger.debug "Calling API: NotificationsApi#get_channels_channel_id_subscriptions ..."
197
197
  end
198
198
 
199
199
  # verify the required parameter 'channel_id' is set
200
- fail "Missing the required parameter 'channel_id' when calling get_channel_subscriptions" if channel_id.nil?
200
+ fail "Missing the required parameter 'channel_id' when calling get_channels_channel_id_subscriptions" if channel_id.nil?
201
201
 
202
202
  # resource path
203
203
  path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
@@ -230,9 +230,9 @@ module PureCloud
230
230
  :form_params => form_params,
231
231
  :body => post_body,
232
232
  :auth_names => auth_names,
233
- :return_type => 'TopicEntityListing')
233
+ :return_type => 'ChannelTopicEntityListing')
234
234
  if @api_client.config.debugging
235
- @api_client.config.logger.debug "API called: NotificationsApi#get_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ @api_client.config.logger.debug "API called: NotificationsApi#get_channels_channel_id_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
236
236
  end
237
237
  return data, status_code, headers
238
238
  end
@@ -242,9 +242,9 @@ module PureCloud
242
242
  # @param channel_id Channel ID
243
243
  # @param [Hash] opts the optional parameters
244
244
  # @option opts [Array<ChannelTopic>] :body Topic
245
- # @return [TopicEntityListing]
246
- def update_channel_subscriptions(channel_id, opts = {})
247
- data, status_code, headers = update_channel_subscriptions_with_http_info(channel_id, opts)
245
+ # @return [ChannelTopicEntityListing]
246
+ def put_channels_channel_id_subscriptions(channel_id, opts = {})
247
+ data, status_code, headers = put_channels_channel_id_subscriptions_with_http_info(channel_id, opts)
248
248
  return data
249
249
  end
250
250
 
@@ -253,14 +253,14 @@ module PureCloud
253
253
  # @param channel_id Channel ID
254
254
  # @param [Hash] opts the optional parameters
255
255
  # @option opts [Array<ChannelTopic>] :body Topic
256
- # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
257
- def update_channel_subscriptions_with_http_info(channel_id, opts = {})
256
+ # @return [Array<(ChannelTopicEntityListing, Fixnum, Hash)>] ChannelTopicEntityListing data, response status code and response headers
257
+ def put_channels_channel_id_subscriptions_with_http_info(channel_id, opts = {})
258
258
  if @api_client.config.debugging
259
- @api_client.config.logger.debug "Calling API: NotificationsApi#update_channel_subscriptions ..."
259
+ @api_client.config.logger.debug "Calling API: NotificationsApi#put_channels_channel_id_subscriptions ..."
260
260
  end
261
261
 
262
262
  # verify the required parameter 'channel_id' is set
263
- fail "Missing the required parameter 'channel_id' when calling update_channel_subscriptions" if channel_id.nil?
263
+ fail "Missing the required parameter 'channel_id' when calling put_channels_channel_id_subscriptions" if channel_id.nil?
264
264
 
265
265
  # resource path
266
266
  path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
@@ -293,9 +293,9 @@ module PureCloud
293
293
  :form_params => form_params,
294
294
  :body => post_body,
295
295
  :auth_names => auth_names,
296
- :return_type => 'TopicEntityListing')
296
+ :return_type => 'ChannelTopicEntityListing')
297
297
  if @api_client.config.debugging
298
- @api_client.config.logger.debug "API called: NotificationsApi#update_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
+ @api_client.config.logger.debug "API called: NotificationsApi#put_channels_channel_id_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
299
299
  end
300
300
  return data, status_code, headers
301
301
  end
@@ -305,9 +305,9 @@ module PureCloud
305
305
  # @param channel_id Channel ID
306
306
  # @param [Hash] opts the optional parameters
307
307
  # @option opts [Array<ChannelTopic>] :body Topic
308
- # @return [TopicEntityListing]
309
- def create_channel_subscriptions(channel_id, opts = {})
310
- data, status_code, headers = create_channel_subscriptions_with_http_info(channel_id, opts)
308
+ # @return [ChannelTopicEntityListing]
309
+ def post_channels_channel_id_subscriptions(channel_id, opts = {})
310
+ data, status_code, headers = post_channels_channel_id_subscriptions_with_http_info(channel_id, opts)
311
311
  return data
312
312
  end
313
313
 
@@ -316,14 +316,14 @@ module PureCloud
316
316
  # @param channel_id Channel ID
317
317
  # @param [Hash] opts the optional parameters
318
318
  # @option opts [Array<ChannelTopic>] :body Topic
319
- # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
320
- def create_channel_subscriptions_with_http_info(channel_id, opts = {})
319
+ # @return [Array<(ChannelTopicEntityListing, Fixnum, Hash)>] ChannelTopicEntityListing data, response status code and response headers
320
+ def post_channels_channel_id_subscriptions_with_http_info(channel_id, opts = {})
321
321
  if @api_client.config.debugging
322
- @api_client.config.logger.debug "Calling API: NotificationsApi#create_channel_subscriptions ..."
322
+ @api_client.config.logger.debug "Calling API: NotificationsApi#post_channels_channel_id_subscriptions ..."
323
323
  end
324
324
 
325
325
  # verify the required parameter 'channel_id' is set
326
- fail "Missing the required parameter 'channel_id' when calling create_channel_subscriptions" if channel_id.nil?
326
+ fail "Missing the required parameter 'channel_id' when calling post_channels_channel_id_subscriptions" if channel_id.nil?
327
327
 
328
328
  # resource path
329
329
  path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
@@ -356,9 +356,9 @@ module PureCloud
356
356
  :form_params => form_params,
357
357
  :body => post_body,
358
358
  :auth_names => auth_names,
359
- :return_type => 'TopicEntityListing')
359
+ :return_type => 'ChannelTopicEntityListing')
360
360
  if @api_client.config.debugging
361
- @api_client.config.logger.debug "API called: NotificationsApi#create_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
361
+ @api_client.config.logger.debug "API called: NotificationsApi#post_channels_channel_id_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
362
362
  end
363
363
  return data, status_code, headers
364
364
  end
@@ -368,8 +368,8 @@ module PureCloud
368
368
  # @param channel_id Channel ID
369
369
  # @param [Hash] opts the optional parameters
370
370
  # @return [String]
371
- def delete_channel_subscriptions(channel_id, opts = {})
372
- data, status_code, headers = delete_channel_subscriptions_with_http_info(channel_id, opts)
371
+ def delete_channels_channel_id_subscriptions(channel_id, opts = {})
372
+ data, status_code, headers = delete_channels_channel_id_subscriptions_with_http_info(channel_id, opts)
373
373
  return data
374
374
  end
375
375
 
@@ -378,13 +378,13 @@ module PureCloud
378
378
  # @param channel_id Channel ID
379
379
  # @param [Hash] opts the optional parameters
380
380
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
381
- def delete_channel_subscriptions_with_http_info(channel_id, opts = {})
381
+ def delete_channels_channel_id_subscriptions_with_http_info(channel_id, opts = {})
382
382
  if @api_client.config.debugging
383
- @api_client.config.logger.debug "Calling API: NotificationsApi#delete_channel_subscriptions ..."
383
+ @api_client.config.logger.debug "Calling API: NotificationsApi#delete_channels_channel_id_subscriptions ..."
384
384
  end
385
385
 
386
386
  # verify the required parameter 'channel_id' is set
387
- fail "Missing the required parameter 'channel_id' when calling delete_channel_subscriptions" if channel_id.nil?
387
+ fail "Missing the required parameter 'channel_id' when calling delete_channels_channel_id_subscriptions" if channel_id.nil?
388
388
 
389
389
  # resource path
390
390
  path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
@@ -419,7 +419,7 @@ module PureCloud
419
419
  :auth_names => auth_names,
420
420
  :return_type => 'String')
421
421
  if @api_client.config.debugging
422
- @api_client.config.logger.debug "API called: NotificationsApi#delete_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
422
+ @api_client.config.logger.debug "API called: NotificationsApi#delete_channels_channel_id_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
423
423
  end
424
424
  return data, status_code, headers
425
425
  end