purecloud 0.0.0

data/lib/purecloud/api/downloads_api.rb

@@ -0,0 +1,140 @@
+require "uri"
+
+module PureCloud
+  class DownloadsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # OAuth Callback used during code authorization grant flow.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code 
+    # @option opts [String] :state 
+    # @return [nil]
+    def get_callback(opts = {})
+      get_callback_with_http_info(opts)
+      return nil
+    end
+
+    # OAuth Callback used during code authorization grant flow.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code 
+    # @option opts [String] :state 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_callback_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DownloadsApi#get_callback ..."
+      end
+      
+      # resource path
+      path = "/api/v1/downloads/callback".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'code'] = opts[:'code'] if opts[:'code']
+      query_params[:'state'] = opts[:'state'] if opts[:'state']
+
+      # 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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#get_callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Issues a redirect to a signed secure download URL for specified download
+    # this method will issue a redirect to the url to the content
+    # @param download_id Download ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_disposition 
+    # @return [UrlResponse]
+    def get(download_id, opts = {})
+      data, status_code, headers = get_with_http_info(download_id, opts)
+      return data
+    end
+
+    # Issues a redirect to a signed secure download URL for specified download
+    # this method will issue a redirect to the url to the content
+    # @param download_id Download ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_disposition 
+    # @return [Array<(UrlResponse, Fixnum, Hash)>] UrlResponse data, response status code and response headers
+    def get_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DownloadsApi#get ..."
+      end
+      
+      # verify the required parameter 'download_id' is set
+      fail "Missing the required parameter 'download_id' when calling get" if download_id.nil?
+      
+      # resource path
+      path = "/api/v1/downloads/{downloadId}".sub('{format}','json').sub('{' + 'downloadId' + '}', download_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'contentDisposition'] = opts[:'content_disposition'] if opts[:'content_disposition']
+
+      # 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 => 'UrlResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end
+
+
+
+

data/lib/purecloud/api/fax_api.rb

@@ -0,0 +1,378 @@
+require "uri"
+
+module PureCloud
+  class FaxApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get a list of fax documents.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [FaxDocumentEntityListing]
+    def get_documents(opts = {})
+      data, status_code, headers = get_documents_with_http_info(opts)
+      return data
+    end
+
+    # Get a list of fax documents.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(FaxDocumentEntityListing, Fixnum, Hash)>] FaxDocumentEntityListing data, response status code and response headers
+    def get_documents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#get_documents ..."
+      end
+      
+      # resource path
+      path = "/api/v1/fax/documents".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      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 => 'FaxDocumentEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [FaxDocument]
+    def get_document(document_id, opts = {})
+      data, status_code, headers = get_document_with_http_info(document_id, opts)
+      return data
+    end
+
+    # Get a document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaxDocument, Fixnum, Hash)>] FaxDocument data, response status code and response headers
+    def get_document_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#get_document ..."
+      end
+      
+      # verify the required parameter 'document_id' is set
+      fail "Missing the required parameter 'document_id' when calling get_document" if document_id.nil?
+      
+      # resource path
+      path = "/api/v1/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_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 => 'FaxDocument')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [FaxDocument] :body Document
+    # @return [FaxDocument]
+    def put_document(document_id, opts = {})
+      data, status_code, headers = put_document_with_http_info(document_id, opts)
+      return data
+    end
+
+    # Update a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [FaxDocument] :body Document
+    # @return [Array<(FaxDocument, Fixnum, Hash)>] FaxDocument data, response status code and response headers
+    def put_document_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#put_document ..."
+      end
+      
+      # verify the required parameter 'document_id' is set
+      fail "Missing the required parameter 'document_id' when calling put_document" if document_id.nil?
+      
+      # resource path
+      path = "/api/v1/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_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 => 'FaxDocument')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#put_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_document(document_id, opts = {})
+      delete_document_with_http_info(document_id, opts)
+      return nil
+    end
+
+    # Delete a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_document_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#delete_document ..."
+      end
+      
+      # verify the required parameter 'document_id' is set
+      fail "Missing the required parameter 'document_id' when calling delete_document" if document_id.nil?
+      
+      # resource path
+      path = "/api/v1/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#delete_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [DownloadResponse]
+    def get_document_content(document_id, opts = {})
+      data, status_code, headers = get_document_content_with_http_info(document_id, opts)
+      return data
+    end
+
+    # Download a fax document.
+    # 
+    # @param document_id Document ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DownloadResponse, Fixnum, Hash)>] DownloadResponse data, response status code and response headers
+    def get_document_content_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#get_document_content ..."
+      end
+      
+      # verify the required parameter 'document_id' is set
+      fail "Missing the required parameter 'document_id' when calling get_document_content" if document_id.nil?
+      
+      # resource path
+      path = "/api/v1/fax/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_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 => 'DownloadResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#get_document_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get fax summary
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [FaxSummary]
+    def get_summary(opts = {})
+      data, status_code, headers = get_summary_with_http_info(opts)
+      return data
+    end
+
+    # Get fax summary
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaxSummary, Fixnum, Hash)>] FaxSummary data, response status code and response headers
+    def get_summary_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FaxApi#get_summary ..."
+      end
+      
+      # resource path
+      path = "/api/v1/fax/summary".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 => 'FaxSummary')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FaxApi#get_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end
+
+
+
+