purecloud 0.57.1 → 0.58.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/CreateCallbackCommand.html.md +0 -2
  5. data/doc_out/CreateQueueRequest.html.md +1 -0
  6. data/doc_out/DomainOrganizationRole.html.md +1 -1
  7. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  8. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  9. data/doc_out/JsonNode.html.md +3 -3
  10. data/doc_out/Location.html.md +5 -9
  11. data/doc_out/LocationDefinition.html.md +21 -0
  12. data/doc_out/LocationsApi.html.md +4 -4
  13. data/doc_out/LocationsSearchResponse.html.md +1 -1
  14. data/doc_out/Queue.html.md +1 -0
  15. data/doc_out/QueueEmailAddress.html.md +14 -0
  16. data/doc_out/RecordingApi.html.md +8 -6
  17. data/doc_out/RoutingApi.html.md +13 -3
  18. data/doc_out/Site.html.md +1 -1
  19. data/doc_out/User.html.md +1 -0
  20. data/doc_out/UserMe.html.md +2 -1
  21. data/doc_out/UserQueue.html.md +1 -0
  22. data/doc_out/index.html.md +3 -3
  23. data/lib/purecloud.rb +2 -0
  24. data/lib/purecloud/api/locations_api.rb +6 -6
  25. data/lib/purecloud/api/recording_api.rb +12 -10
  26. data/lib/purecloud/api/routing_api.rb +12 -0
  27. data/lib/purecloud/api_client.rb +1 -1
  28. data/lib/purecloud/models/create_callback_command.rb +1 -25
  29. data/lib/purecloud/models/create_queue_request.rb +11 -1
  30. data/lib/purecloud/models/domain_organization_role.rb +13 -13
  31. data/lib/purecloud/models/domain_organization_role_create.rb +13 -13
  32. data/lib/purecloud/models/domain_organization_role_update.rb +13 -13
  33. data/lib/purecloud/models/json_node.rb +32 -32
  34. data/lib/purecloud/models/location.rb +27 -81
  35. data/lib/purecloud/models/location_definition.rb +261 -0
  36. data/lib/purecloud/models/locations_search_response.rb +1 -1
  37. data/lib/purecloud/models/queue.rb +11 -1
  38. data/lib/purecloud/models/queue_email_address.rb +175 -0
  39. data/lib/purecloud/models/site.rb +1 -1
  40. data/lib/purecloud/models/user.rb +14 -1
  41. data/lib/purecloud/models/user_me.rb +22 -9
  42. data/lib/purecloud/models/user_queue.rb +11 -1
  43. data/lib/purecloud/version.rb +1 -1
  44. data/newVersion.md +1 -1
  45. data/swagger.json +1 -1
  46. data/version.json +1 -1
  47. metadata +6 -2
@@ -352,10 +352,10 @@ module PureCloud
352
352
  # @option opts [String] :format_id The desired media format. (default to WEBM)
353
353
  # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
354
354
  # @option opts [String] :file_name the name of the downloaded fileName
355
- # @return [nil]
355
+ # @return [Recording]
356
356
  def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
357
- get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
358
- return nil
357
+ data, status_code, headers = get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
358
+ return data
359
359
  end
360
360
 
361
361
  # Gets a specific recording.
@@ -366,7 +366,7 @@ module PureCloud
366
366
  # @option opts [String] :format_id The desired media format.
367
367
  # @option opts [BOOLEAN] :download requesting a download format of the recording
368
368
  # @option opts [String] :file_name the name of the downloaded fileName
369
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
369
+ # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
370
370
  def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {})
371
371
  if @api_client.config.debugging
372
372
  @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..."
@@ -414,7 +414,8 @@ module PureCloud
414
414
  :query_params => query_params,
415
415
  :form_params => form_params,
416
416
  :body => post_body,
417
- :auth_names => auth_names)
417
+ :auth_names => auth_names,
418
+ :return_type => 'Recording')
418
419
  if @api_client.config.debugging
419
420
  @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
420
421
  end
@@ -1621,10 +1622,10 @@ module PureCloud
1621
1622
  # @param recording_id Recording ID
1622
1623
  # @param body recording
1623
1624
  # @param [Hash] opts the optional parameters
1624
- # @return [nil]
1625
+ # @return [Recording]
1625
1626
  def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
1626
- put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
1627
- return nil
1627
+ data, status_code, headers = put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
1628
+ return data
1628
1629
  end
1629
1630
 
1630
1631
  # Updates the retention records on a recording.
@@ -1633,7 +1634,7 @@ module PureCloud
1633
1634
  # @param recording_id Recording ID
1634
1635
  # @param body recording
1635
1636
  # @param [Hash] opts the optional parameters
1636
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1637
+ # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
1637
1638
  def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
1638
1639
  if @api_client.config.debugging
1639
1640
  @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..."
@@ -1677,7 +1678,8 @@ module PureCloud
1677
1678
  :query_params => query_params,
1678
1679
  :form_params => form_params,
1679
1680
  :body => post_body,
1680
- :auth_names => auth_names)
1681
+ :auth_names => auth_names,
1682
+ :return_type => 'Recording')
1681
1683
  if @api_client.config.debugging
1682
1684
  @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1683
1685
  end
@@ -701,6 +701,9 @@ module PureCloud
701
701
  #
702
702
  # @param domain_name email domain
703
703
  # @param [Hash] opts the optional parameters
704
+ # @option opts [Integer] :page_size Page size (default to 25)
705
+ # @option opts [Integer] :page_number Page number (default to 1)
706
+ # @option opts [String] :pattern Filter routes by the route&#39;s pattern property
704
707
  # @return [InboundRouteEntityListing]
705
708
  def get_email_domains_domainname_routes(domain_name, opts = {})
706
709
  data, status_code, headers = get_email_domains_domainname_routes_with_http_info(domain_name, opts)
@@ -711,6 +714,9 @@ module PureCloud
711
714
  #
712
715
  # @param domain_name email domain
713
716
  # @param [Hash] opts the optional parameters
717
+ # @option opts [Integer] :page_size Page size
718
+ # @option opts [Integer] :page_number Page number
719
+ # @option opts [String] :pattern Filter routes by the route&#39;s pattern property
714
720
  # @return [Array<(InboundRouteEntityListing, Fixnum, Hash)>] InboundRouteEntityListing data, response status code and response headers
715
721
  def get_email_domains_domainname_routes_with_http_info(domain_name, opts = {})
716
722
  if @api_client.config.debugging
@@ -725,6 +731,9 @@ module PureCloud
725
731
 
726
732
  # query parameters
727
733
  query_params = {}
734
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
735
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
736
+ query_params[:'pattern'] = opts[:'pattern'] if opts[:'pattern']
728
737
 
729
738
  # header parameters
730
739
  header_params = {}
@@ -1558,6 +1567,7 @@ module PureCloud
1558
1567
  # @param [Hash] opts the optional parameters
1559
1568
  # @option opts [Integer] :page_size Page size (default to 25)
1560
1569
  # @option opts [Integer] :page_number Page number (default to 1)
1570
+ # @option opts [String] :name Filter for results that start with this value
1561
1571
  # @return [SkillEntityListing]
1562
1572
  def get_skills(opts = {})
1563
1573
  data, status_code, headers = get_skills_with_http_info(opts)
@@ -1569,6 +1579,7 @@ module PureCloud
1569
1579
  # @param [Hash] opts the optional parameters
1570
1580
  # @option opts [Integer] :page_size Page size
1571
1581
  # @option opts [Integer] :page_number Page number
1582
+ # @option opts [String] :name Filter for results that start with this value
1572
1583
  # @return [Array<(SkillEntityListing, Fixnum, Hash)>] SkillEntityListing data, response status code and response headers
1573
1584
  def get_skills_with_http_info(opts = {})
1574
1585
  if @api_client.config.debugging
@@ -1582,6 +1593,7 @@ module PureCloud
1582
1593
  query_params = {}
1583
1594
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1584
1595
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1596
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1585
1597
 
1586
1598
  # header parameters
1587
1599
  header_params = {}
@@ -33,7 +33,7 @@ module PureCloud
33
33
 
34
34
  def initialize(config = Configuration.default)
35
35
  @config = config
36
- @user_agent = "PureCloud SDK/Ruby 0.57.1"
36
+ @user_agent = "PureCloud SDK/Ruby 0.58.1"
37
37
  @default_headers = {
38
38
  'Content-Type' => "application/json",
39
39
  'User-Agent' => @user_agent
@@ -39,12 +39,6 @@ module PureCloud
39
39
  # The country code to be associated with the callback numbers.
40
40
  attr_accessor :country_code
41
41
 
42
- # Whether or not to automatically place a call for this callback.
43
- attr_accessor :is_automated
44
-
45
- # The id of the configuration to handle the response (e.g. live voice, machine) from automatically placing a call for a callback.
46
- attr_accessor :automated_callback_config_id
47
-
48
42
  # A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }
49
43
  attr_accessor :data
50
44
 
@@ -66,10 +60,6 @@ module PureCloud
66
60
 
67
61
  :'country_code' => :'countryCode',
68
62
 
69
- :'is_automated' => :'isAutomated',
70
-
71
- :'automated_callback_config_id' => :'automatedCallbackConfigId',
72
-
73
63
  :'data' => :'data'
74
64
 
75
65
  }
@@ -85,8 +75,6 @@ module PureCloud
85
75
  :'callback_numbers' => :'Array<String>',
86
76
  :'callback_scheduled_time' => :'DateTime',
87
77
  :'country_code' => :'String',
88
- :'is_automated' => :'BOOLEAN',
89
- :'automated_callback_config_id' => :'String',
90
78
  :'data' => :'Hash<String, String>'
91
79
 
92
80
  }
@@ -129,16 +117,6 @@ module PureCloud
129
117
  self.country_code = attributes[:'countryCode']
130
118
  end
131
119
 
132
- if attributes[:'isAutomated']
133
- self.is_automated = attributes[:'isAutomated']
134
- else
135
- self.is_automated = false
136
- end
137
-
138
- if attributes[:'automatedCallbackConfigId']
139
- self.automated_callback_config_id = attributes[:'automatedCallbackConfigId']
140
- end
141
-
142
120
  if attributes[:'data']
143
121
  if (value = attributes[:'data']).is_a?(Array)
144
122
  self.data = value
@@ -158,8 +136,6 @@ module PureCloud
158
136
  callback_numbers == o.callback_numbers &&
159
137
  callback_scheduled_time == o.callback_scheduled_time &&
160
138
  country_code == o.country_code &&
161
- is_automated == o.is_automated &&
162
- automated_callback_config_id == o.automated_callback_config_id &&
163
139
  data == o.data
164
140
  end
165
141
 
@@ -170,7 +146,7 @@ module PureCloud
170
146
 
171
147
  # Calculate hash code according to all attributes.
172
148
  def hash
173
- [script_id, queue_id, routing_data, callback_user_name, callback_numbers, callback_scheduled_time, country_code, is_automated, automated_callback_config_id, data].hash
149
+ [script_id, queue_id, routing_data, callback_user_name, callback_numbers, callback_scheduled_time, country_code, data].hash
174
150
  end
175
151
 
176
152
  # build the object from hash
@@ -64,6 +64,8 @@ module PureCloud
64
64
  # The phone number to use for caller identification for outbound calls from this queue.
65
65
  attr_accessor :calling_party_number
66
66
 
67
+ attr_accessor :outbound_email_address
68
+
67
69
  # The id of an existing queue to copy the settings from when creating a new queue.
68
70
  attr_accessor :source_queue_id
69
71
 
@@ -112,6 +114,8 @@ module PureCloud
112
114
 
113
115
  :'calling_party_number' => :'callingPartyNumber',
114
116
 
117
+ :'outbound_email_address' => :'outboundEmailAddress',
118
+
115
119
  :'source_queue_id' => :'sourceQueueId',
116
120
 
117
121
  :'member_count' => :'memberCount',
@@ -142,6 +146,7 @@ module PureCloud
142
146
  :'queue_flow' => :'UriReference',
143
147
  :'calling_party_name' => :'String',
144
148
  :'calling_party_number' => :'String',
149
+ :'outbound_email_address' => :'QueueEmailAddress',
145
150
  :'source_queue_id' => :'String',
146
151
  :'member_count' => :'Integer',
147
152
  :'self_uri' => :'String'
@@ -230,6 +235,10 @@ module PureCloud
230
235
  self.calling_party_number = attributes[:'callingPartyNumber']
231
236
  end
232
237
 
238
+ if attributes[:'outboundEmailAddress']
239
+ self.outbound_email_address = attributes[:'outboundEmailAddress']
240
+ end
241
+
233
242
  if attributes[:'sourceQueueId']
234
243
  self.source_queue_id = attributes[:'sourceQueueId']
235
244
  end
@@ -284,6 +293,7 @@ module PureCloud
284
293
  queue_flow == o.queue_flow &&
285
294
  calling_party_name == o.calling_party_name &&
286
295
  calling_party_number == o.calling_party_number &&
296
+ outbound_email_address == o.outbound_email_address &&
287
297
  source_queue_id == o.source_queue_id &&
288
298
  member_count == o.member_count &&
289
299
  self_uri == o.self_uri
@@ -296,7 +306,7 @@ module PureCloud
296
306
 
297
307
  # Calculate hash code according to all attributes.
298
308
  def hash
299
- [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, source_queue_id, member_count, self_uri].hash
309
+ [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, outbound_email_address, source_queue_id, member_count, self_uri].hash
300
310
  end
301
311
 
302
312
  # build the object from hash
@@ -36,10 +36,10 @@ module PureCloud
36
36
  # Optional unless patch operation.
37
37
  attr_accessor :role_needs_update
38
38
 
39
- attr_accessor :default
40
-
41
39
  attr_accessor :base
42
40
 
41
+ attr_accessor :default
42
+
43
43
  # The URI for this object
44
44
  attr_accessor :self_uri
45
45
 
@@ -63,10 +63,10 @@ module PureCloud
63
63
 
64
64
  :'role_needs_update' => :'roleNeedsUpdate',
65
65
 
66
- :'default' => :'default',
67
-
68
66
  :'base' => :'base',
69
67
 
68
+ :'default' => :'default',
69
+
70
70
  :'self_uri' => :'selfUri'
71
71
 
72
72
  }
@@ -83,8 +83,8 @@ module PureCloud
83
83
  :'permission_policies' => :'Array<DomainPermissionPolicy>',
84
84
  :'user_count' => :'Integer',
85
85
  :'role_needs_update' => :'BOOLEAN',
86
- :'default' => :'BOOLEAN',
87
86
  :'base' => :'BOOLEAN',
87
+ :'default' => :'BOOLEAN',
88
88
  :'self_uri' => :'String'
89
89
 
90
90
  }
@@ -135,18 +135,18 @@ module PureCloud
135
135
  self.role_needs_update = false
136
136
  end
137
137
 
138
- if attributes[:'default']
139
- self.default = attributes[:'default']
140
- else
141
- self.default = false
142
- end
143
-
144
138
  if attributes[:'base']
145
139
  self.base = attributes[:'base']
146
140
  else
147
141
  self.base = false
148
142
  end
149
143
 
144
+ if attributes[:'default']
145
+ self.default = attributes[:'default']
146
+ else
147
+ self.default = false
148
+ end
149
+
150
150
  if attributes[:'selfUri']
151
151
  self.self_uri = attributes[:'selfUri']
152
152
  end
@@ -165,8 +165,8 @@ module PureCloud
165
165
  permission_policies == o.permission_policies &&
166
166
  user_count == o.user_count &&
167
167
  role_needs_update == o.role_needs_update &&
168
- default == o.default &&
169
168
  base == o.base &&
169
+ default == o.default &&
170
170
  self_uri == o.self_uri
171
171
  end
172
172
 
@@ -177,7 +177,7 @@ module PureCloud
177
177
 
178
178
  # Calculate hash code according to all attributes.
179
179
  def hash
180
- [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, default, base, self_uri].hash
180
+ [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, base, default, self_uri].hash
181
181
  end
182
182
 
183
183
  # build the object from hash
@@ -37,10 +37,10 @@ module PureCloud
37
37
  # Optional unless patch operation.
38
38
  attr_accessor :role_needs_update
39
39
 
40
- attr_accessor :default
41
-
42
40
  attr_accessor :base
43
41
 
42
+ attr_accessor :default
43
+
44
44
  # The URI for this object
45
45
  attr_accessor :self_uri
46
46
 
@@ -64,10 +64,10 @@ module PureCloud
64
64
 
65
65
  :'role_needs_update' => :'roleNeedsUpdate',
66
66
 
67
- :'default' => :'default',
68
-
69
67
  :'base' => :'base',
70
68
 
69
+ :'default' => :'default',
70
+
71
71
  :'self_uri' => :'selfUri'
72
72
 
73
73
  }
@@ -84,8 +84,8 @@ module PureCloud
84
84
  :'permission_policies' => :'Array<DomainPermissionPolicy>',
85
85
  :'user_count' => :'Integer',
86
86
  :'role_needs_update' => :'BOOLEAN',
87
- :'default' => :'BOOLEAN',
88
87
  :'base' => :'BOOLEAN',
88
+ :'default' => :'BOOLEAN',
89
89
  :'self_uri' => :'String'
90
90
 
91
91
  }
@@ -136,18 +136,18 @@ module PureCloud
136
136
  self.role_needs_update = false
137
137
  end
138
138
 
139
- if attributes[:'default']
140
- self.default = attributes[:'default']
141
- else
142
- self.default = false
143
- end
144
-
145
139
  if attributes[:'base']
146
140
  self.base = attributes[:'base']
147
141
  else
148
142
  self.base = false
149
143
  end
150
144
 
145
+ if attributes[:'default']
146
+ self.default = attributes[:'default']
147
+ else
148
+ self.default = false
149
+ end
150
+
151
151
  if attributes[:'selfUri']
152
152
  self.self_uri = attributes[:'selfUri']
153
153
  end
@@ -166,8 +166,8 @@ module PureCloud
166
166
  permission_policies == o.permission_policies &&
167
167
  user_count == o.user_count &&
168
168
  role_needs_update == o.role_needs_update &&
169
- default == o.default &&
170
169
  base == o.base &&
170
+ default == o.default &&
171
171
  self_uri == o.self_uri
172
172
  end
173
173
 
@@ -178,7 +178,7 @@ module PureCloud
178
178
 
179
179
  # Calculate hash code according to all attributes.
180
180
  def hash
181
- [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, default, base, self_uri].hash
181
+ [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, base, default, self_uri].hash
182
182
  end
183
183
 
184
184
  # build the object from hash
@@ -37,10 +37,10 @@ module PureCloud
37
37
  # Optional unless patch operation.
38
38
  attr_accessor :role_needs_update
39
39
 
40
- attr_accessor :default
41
-
42
40
  attr_accessor :base
43
41
 
42
+ attr_accessor :default
43
+
44
44
  # The URI for this object
45
45
  attr_accessor :self_uri
46
46
 
@@ -64,10 +64,10 @@ module PureCloud
64
64
 
65
65
  :'role_needs_update' => :'roleNeedsUpdate',
66
66
 
67
- :'default' => :'default',
68
-
69
67
  :'base' => :'base',
70
68
 
69
+ :'default' => :'default',
70
+
71
71
  :'self_uri' => :'selfUri'
72
72
 
73
73
  }
@@ -84,8 +84,8 @@ module PureCloud
84
84
  :'permission_policies' => :'Array<DomainPermissionPolicy>',
85
85
  :'user_count' => :'Integer',
86
86
  :'role_needs_update' => :'BOOLEAN',
87
- :'default' => :'BOOLEAN',
88
87
  :'base' => :'BOOLEAN',
88
+ :'default' => :'BOOLEAN',
89
89
  :'self_uri' => :'String'
90
90
 
91
91
  }
@@ -136,18 +136,18 @@ module PureCloud
136
136
  self.role_needs_update = false
137
137
  end
138
138
 
139
- if attributes[:'default']
140
- self.default = attributes[:'default']
141
- else
142
- self.default = false
143
- end
144
-
145
139
  if attributes[:'base']
146
140
  self.base = attributes[:'base']
147
141
  else
148
142
  self.base = false
149
143
  end
150
144
 
145
+ if attributes[:'default']
146
+ self.default = attributes[:'default']
147
+ else
148
+ self.default = false
149
+ end
150
+
151
151
  if attributes[:'selfUri']
152
152
  self.self_uri = attributes[:'selfUri']
153
153
  end
@@ -166,8 +166,8 @@ module PureCloud
166
166
  permission_policies == o.permission_policies &&
167
167
  user_count == o.user_count &&
168
168
  role_needs_update == o.role_needs_update &&
169
- default == o.default &&
170
169
  base == o.base &&
170
+ default == o.default &&
171
171
  self_uri == o.self_uri
172
172
  end
173
173
 
@@ -178,7 +178,7 @@ module PureCloud
178
178
 
179
179
  # Calculate hash code according to all attributes.
180
180
  def hash
181
- [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, default, base, self_uri].hash
181
+ [id, name, description, default_role_id, permissions, permission_policies, user_count, role_needs_update, base, default, self_uri].hash
182
182
  end
183
183
 
184
184
  # build the object from hash