routing_api.rb in purecloud-0.37.1

- old
+ new

@@ -1,18 +1,18 @@
 =begin
-PureCloud API
+PureCloud Platform API
 
-PureCloud API
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
 
-OpenAPI spec version: v1
-Contact: chuck.pulfer@inin.com
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@inin.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 License: ININ
 http://www.inin.com
 
-Terms of Service: http://www.inin.com
+Terms of Service: https://developer.mypurecloud.com/tos
 
 =end
 
 require "uri"
 
@@ -22,40 +22,35 @@
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
 
-    # Delete a route
+    # Delete a domain
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_id domain ID
     # @param [Hash] opts the optional parameters
     # @return [String]
-    def delete_email_domains_domain_routes_id(domain, id, opts = {})
-      data, status_code, headers = delete_email_domains_domain_routes_id_with_http_info(domain, id, opts)
+    def delete_email_domains_domain_id(domain_id, opts = {})
+      data, status_code, headers = delete_email_domains_domain_id_with_http_info(domain_id, opts)
       return data
     end
 
-    # Delete a route
+    # Delete a domain
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_id domain ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def delete_email_domains_domain_routes_id_with_http_info(domain, id, opts = {})
+    def delete_email_domains_domain_id_with_http_info(domain_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domain_routes_id ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domain_id ..."
       end
       
-      # verify the required parameter 'domain' is set
-      fail "Missing the required parameter 'domain' when calling delete_email_domains_domain_routes_id" if domain.nil?
+      # verify the required parameter 'domain_id' is set
+      fail "Missing the required parameter 'domain_id' when calling delete_email_domains_domain_id" if domain_id.nil?
       
-      # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling delete_email_domains_domain_routes_id" if id.nil?
-      
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -82,40 +77,45 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domain_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete a domain
+    # Delete a route
     # 
-    # @param id domain ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @return [String]
-    def delete_email_domains_id(id, opts = {})
-      data, status_code, headers = delete_email_domains_id_with_http_info(id, opts)
+    def delete_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {})
+      data, status_code, headers = delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts)
       return data
     end
 
-    # Delete a domain
+    # Delete a route
     # 
-    # @param id domain ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
-    def delete_email_domains_id_with_http_info(id, opts = {})
+    def delete_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_id ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#delete_email_domains_domainname_routes_route_id ..."
       end
       
-      # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling delete_email_domains_id" if id.nil?
+      # verify the required parameter 'domain_name' is set
+      fail "Missing the required parameter 'domain_name' when calling delete_email_domains_domainname_routes_route_id" if domain_name.nil?
       
+      # verify the required parameter 'route_id' is set
+      fail "Missing the required parameter 'route_id' when calling delete_email_domains_domainname_routes_route_id" if route_id.nil?
+      
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -142,11 +142,11 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#delete_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Delete a queue
@@ -637,33 +637,33 @@
       return data, status_code, headers
     end
 
     # Get routes
     # 
-    # @param domain email domain
+    # @param domain_name email domain
     # @param [Hash] opts the optional parameters
     # @return [InboundRouteEntityListing]
-    def get_email_domains_domain_routes(domain, opts = {})
-      data, status_code, headers = get_email_domains_domain_routes_with_http_info(domain, opts)
+    def get_email_domains_domainname_routes(domain_name, opts = {})
+      data, status_code, headers = get_email_domains_domainname_routes_with_http_info(domain_name, opts)
       return data
     end
 
     # Get routes
     # 
-    # @param domain email domain
+    # @param domain_name email domain
     # @param [Hash] opts the optional parameters
     # @return [Array<(InboundRouteEntityListing, Fixnum, Hash)>] InboundRouteEntityListing data, response status code and response headers
-    def get_email_domains_domain_routes_with_http_info(domain, opts = {})
+    def get_email_domains_domainname_routes_with_http_info(domain_name, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domainname_routes ..."
       end
       
-      # verify the required parameter 'domain' is set
-      fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes" if domain.nil?
+      # verify the required parameter 'domain_name' is set
+      fail "Missing the required parameter 'domain_name' when calling get_email_domains_domainname_routes" if domain_name.nil?
       
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -690,45 +690,45 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'InboundRouteEntityListing')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domainname_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Get a route
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @return [InboundRoute]
-    def get_email_domains_domain_routes_id(domain, id, opts = {})
-      data, status_code, headers = get_email_domains_domain_routes_id_with_http_info(domain, id, opts)
+    def get_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {})
+      data, status_code, headers = get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts)
       return data
     end
 
     # Get a route
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers
-    def get_email_domains_domain_routes_id_with_http_info(domain, id, opts = {})
+    def get_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domain_routes_id ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_email_domains_domainname_routes_route_id ..."
       end
       
-      # verify the required parameter 'domain' is set
-      fail "Missing the required parameter 'domain' when calling get_email_domains_domain_routes_id" if domain.nil?
+      # verify the required parameter 'domain_name' is set
+      fail "Missing the required parameter 'domain_name' when calling get_email_domains_domainname_routes_route_id" if domain_name.nil?
       
-      # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling get_email_domains_domain_routes_id" if id.nil?
+      # verify the required parameter 'route_id' is set
+      fail "Missing the required parameter 'route_id' when calling get_email_domains_domainname_routes_route_id" if route_id.nil?
       
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -755,11 +755,11 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'InboundRoute')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#get_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Get email setup
@@ -1709,35 +1709,35 @@
       return data, status_code, headers
     end
 
     # Create a route
     # 
-    # @param domain email domain
+    # @param domain_name email domain
     # @param [Hash] opts the optional parameters
     # @option opts [InboundRoute] :body Route
     # @return [InboundRoute]
-    def post_email_domains_domain_routes(domain, opts = {})
-      data, status_code, headers = post_email_domains_domain_routes_with_http_info(domain, opts)
+    def post_email_domains_domainname_routes(domain_name, opts = {})
+      data, status_code, headers = post_email_domains_domainname_routes_with_http_info(domain_name, opts)
       return data
     end
 
     # Create a route
     # 
-    # @param domain email domain
+    # @param domain_name email domain
     # @param [Hash] opts the optional parameters
     # @option opts [InboundRoute] :body Route
     # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers
-    def post_email_domains_domain_routes_with_http_info(domain, opts = {})
+    def post_email_domains_domainname_routes_with_http_info(domain_name, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains_domain_routes ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#post_email_domains_domainname_routes ..."
       end
       
-      # verify the required parameter 'domain' is set
-      fail "Missing the required parameter 'domain' when calling post_email_domains_domain_routes" if domain.nil?
+      # verify the required parameter 'domain_name' is set
+      fail "Missing the required parameter 'domain_name' when calling post_email_domains_domainname_routes" if domain_name.nil?
       
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{domain}/routes".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -1764,11 +1764,11 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'InboundRoute')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#post_email_domains_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#post_email_domains_domainname_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Create queue
@@ -2193,40 +2193,40 @@
       return data, status_code, headers
     end
 
     # Update a route
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @option opts [InboundRoute] :body Route
     # @return [InboundRoute]
-    def put_email_domains_domain_routes_id(domain, id, opts = {})
-      data, status_code, headers = put_email_domains_domain_routes_id_with_http_info(domain, id, opts)
+    def put_email_domains_domainname_routes_route_id(domain_name, route_id, opts = {})
+      data, status_code, headers = put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts)
       return data
     end
 
     # Update a route
     # 
-    # @param domain email domain
-    # @param id route ID
+    # @param domain_name email domain
+    # @param route_id route ID
     # @param [Hash] opts the optional parameters
     # @option opts [InboundRoute] :body Route
     # @return [Array<(InboundRoute, Fixnum, Hash)>] InboundRoute data, response status code and response headers
-    def put_email_domains_domain_routes_id_with_http_info(domain, id, opts = {})
+    def put_email_domains_domainname_routes_route_id_with_http_info(domain_name, route_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RoutingApi#put_email_domains_domain_routes_id ..."
+        @api_client.config.logger.debug "Calling API: RoutingApi#put_email_domains_domainname_routes_route_id ..."
       end
       
-      # verify the required parameter 'domain' is set
-      fail "Missing the required parameter 'domain' when calling put_email_domains_domain_routes_id" if domain.nil?
+      # verify the required parameter 'domain_name' is set
+      fail "Missing the required parameter 'domain_name' when calling put_email_domains_domainname_routes_route_id" if domain_name.nil?
       
-      # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling put_email_domains_domain_routes_id" if id.nil?
+      # verify the required parameter 'route_id' is set
+      fail "Missing the required parameter 'route_id' when calling put_email_domains_domainname_routes_route_id" if route_id.nil?
       
       # resource path
-      local_var_path = "/api/v2/routing/email/domains/{domain}/routes/{id}".sub('{format}','json').sub('{' + 'domain' + '}', domain.to_s).sub('{' + 'id' + '}', id.to_s)
+      local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)
 
       # query parameters
       query_params = {}
 
       # header parameters
@@ -2253,10 +2253,10 @@
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'InboundRoute')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: RoutingApi#put_email_domains_domain_routes_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: RoutingApi#put_email_domains_domainname_routes_route_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Update a queue