purecloud 0.0.0

data/lib/purecloud/api/locations_api.rb

@@ -0,0 +1,148 @@
+require "uri"
+
+module PureCloud
+  class LocationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get the list of locations.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :state Location state
+    # @option opts [String] :name Location name
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [LocationEntityListing]
+    def get_locations(opts = {})
+      data, status_code, headers = get_locations_with_http_info(opts)
+      return data
+    end
+
+    # Get the list of locations.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :state Location state
+    # @option opts [String] :name Location name
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(LocationEntityListing, Fixnum, Hash)>] LocationEntityListing data, response status code and response headers
+    def get_locations_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: LocationsApi#get_locations ..."
+      end
+      
+      if opts[:'state'] && !['ACTIVE', 'DELETED'].include?(opts[:'state'])
+        fail 'invalid value for "state", must be one of ACTIVE, DELETED'
+      end
+      
+      # resource path
+      path = "/api/v1/locations".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'state'] = opts[:'state'] if opts[:'state']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'LocationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Location by ID.
+    # 
+    # @param location_id Location ID
+    # @param [Hash] opts the optional parameters
+    # @return [Location]
+    def get(location_id, opts = {})
+      data, status_code, headers = get_with_http_info(location_id, opts)
+      return data
+    end
+
+    # Get Location by ID.
+    # 
+    # @param location_id Location ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Location, Fixnum, Hash)>] Location data, response status code and response headers
+    def get_with_http_info(location_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: LocationsApi#get ..."
+      end
+      
+      # verify the required parameter 'location_id' is set
+      fail "Missing the required parameter 'location_id' when calling get" if location_id.nil?
+      
+      # resource path
+      path = "/api/v1/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Location')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end
+
+
+
+

data/lib/purecloud/api/notifications_api.rb

@@ -0,0 +1,431 @@
+require "uri"
+
+module PureCloud
+  class NotificationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get available notification topics.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [TopicEntityListing]
+    def get_availabletopics(opts = {})
+      data, status_code, headers = get_availabletopics_with_http_info(opts)
+      return data
+    end
+
+    # Get available notification topics.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
+    def get_availabletopics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#get_availabletopics ..."
+      end
+      
+      # resource path
+      path = "/api/v1/notifications/availabletopics".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TopicEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#get_availabletopics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # The list of existing channels
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [ChannelEntityListing]
+    def get_channels(opts = {})
+      data, status_code, headers = get_channels_with_http_info(opts)
+      return data
+    end
+
+    # The list of existing channels
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChannelEntityListing, Fixnum, Hash)>] ChannelEntityListing data, response status code and response headers
+    def get_channels_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#get_channels ..."
+      end
+      
+      # resource path
+      path = "/api/v1/notifications/channels".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ChannelEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#get_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new channel
+    # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
+    # @param [Hash] opts the optional parameters
+    # @return [Channel]
+    def post_channels(opts = {})
+      data, status_code, headers = post_channels_with_http_info(opts)
+      return data
+    end
+
+    # Create a new channel
+    # There is a limit of 10 channels. Creating an 11th channel will remove the channel with oldest last used date.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Channel, Fixnum, Hash)>] Channel data, response status code and response headers
+    def post_channels_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#post_channels ..."
+      end
+      
+      # resource path
+      path = "/api/v1/notifications/channels".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Channel')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#post_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # The list of all subscriptions for this channel
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @return [TopicEntityListing]
+    def get_channel_subscriptions(channel_id, opts = {})
+      data, status_code, headers = get_channel_subscriptions_with_http_info(channel_id, opts)
+      return data
+    end
+
+    # The list of all subscriptions for this channel
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
+    def get_channel_subscriptions_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#get_channel_subscriptions ..."
+      end
+      
+      # verify the required parameter 'channel_id' is set
+      fail "Missing the required parameter 'channel_id' when calling get_channel_subscriptions" if channel_id.nil?
+      
+      # resource path
+      path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TopicEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#get_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replace the current list of subscriptions with a new list.
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<ChannelTopic>] :body Topic
+    # @return [TopicEntityListing]
+    def put_channel_subscriptions(channel_id, opts = {})
+      data, status_code, headers = put_channel_subscriptions_with_http_info(channel_id, opts)
+      return data
+    end
+
+    # Replace the current list of subscriptions with a new list.
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<ChannelTopic>] :body Topic
+    # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
+    def put_channel_subscriptions_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#put_channel_subscriptions ..."
+      end
+      
+      # verify the required parameter 'channel_id' is set
+      fail "Missing the required parameter 'channel_id' when calling put_channel_subscriptions" if channel_id.nil?
+      
+      # resource path
+      path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:PUT, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TopicEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#put_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add a list of subscriptions to the existing list of subscriptions
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<ChannelTopic>] :body Topic
+    # @return [TopicEntityListing]
+    def post_channel_subscriptions(channel_id, opts = {})
+      data, status_code, headers = post_channel_subscriptions_with_http_info(channel_id, opts)
+      return data
+    end
+
+    # Add a list of subscriptions to the existing list of subscriptions
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<ChannelTopic>] :body Topic
+    # @return [Array<(TopicEntityListing, Fixnum, Hash)>] TopicEntityListing data, response status code and response headers
+    def post_channel_subscriptions_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#post_channel_subscriptions ..."
+      end
+      
+      # verify the required parameter 'channel_id' is set
+      fail "Missing the required parameter 'channel_id' when calling post_channel_subscriptions" if channel_id.nil?
+      
+      # resource path
+      path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TopicEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationsApi#post_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove all subscriptions
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def delete_channel_subscriptions(channel_id, opts = {})
+      data, status_code, headers = delete_channel_subscriptions_with_http_info(channel_id, opts)
+      return data
+    end
+
+    # Remove all subscriptions
+    # 
+    # @param channel_id Channel ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def delete_channel_subscriptions_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationsApi#delete_channel_subscriptions ..."
+      end
+      
+      # verify the required parameter 'channel_id' is set
+      fail "Missing the required parameter 'channel_id' when calling delete_channel_subscriptions" if channel_id.nil?
+      
+      # resource path
+      path = "/api/v1/notifications/channels/{channelId}/subscriptions".sub('{format}','json').sub('{' + 'channelId' + '}', channel_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:DELETE, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :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: NotificationsApi#delete_channel_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end
+
+
+
+