artikcloud 2.0.0

data/lib/artikcloud/api/export_api.rb

@@ -0,0 +1,269 @@
+=begin
+ARTIK Cloud API
+
+OpenAPI spec version: 2.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: MIT
+http://en.wikipedia.org/wiki/MIT_License
+
+Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+
+=end
+
+require "uri"
+
+module ArtikCloud
+  class ExportApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Create Export Request
+    # Export normalized messages. The following input combinations are supported:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Get by users</td><td>uids</td><td>Search by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.</td></tr><tr><td>Get by devices</td><td>sdids</td><td>Search by Source Device IDs.</td></tr><tr><td>Get by device types</td><td>uids,sdtids</td><td>Search by list of Source Device Type IDs for the given list of users.</td></tr><tr><td>Get by trial</td><td>trialId</td><td>Search by Trial ID.</td></tr><tr><td>Get by combination of parameters</td><td>uids,sdids,sdtids</td><td>Search by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.</td></tr><tr><td>Common</td><td>startDate,endDate,order,format,url,csvHeaders</td><td>Parameters that can be used with the above combinations.</td></tr></table>
+    # @param export_request_info ExportRequest object that is passed in the body
+    # @param [Hash] opts the optional parameters
+    # @return [ExportRequestResponse]
+    def export_request(export_request_info, opts = {})
+      data, status_code, headers = export_request_with_http_info(export_request_info, opts)
+      return data
+    end
+
+    # Create Export Request
+    # Export normalized messages. The following input combinations are supported:&lt;br/&gt;&lt;table&gt;&lt;tr&gt;&lt;th&gt;Combination&lt;/th&gt;&lt;th&gt;Parameters&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Get by users&lt;/td&gt;&lt;td&gt;uids&lt;/td&gt;&lt;td&gt;Search by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Get by devices&lt;/td&gt;&lt;td&gt;sdids&lt;/td&gt;&lt;td&gt;Search by Source Device IDs.&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Get by device types&lt;/td&gt;&lt;td&gt;uids,sdtids&lt;/td&gt;&lt;td&gt;Search by list of Source Device Type IDs for the given list of users.&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Get by trial&lt;/td&gt;&lt;td&gt;trialId&lt;/td&gt;&lt;td&gt;Search by Trial ID.&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Get by combination of parameters&lt;/td&gt;&lt;td&gt;uids,sdids,sdtids&lt;/td&gt;&lt;td&gt;Search by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;Common&lt;/td&gt;&lt;td&gt;startDate,endDate,order,format,url,csvHeaders&lt;/td&gt;&lt;td&gt;Parameters that can be used with the above combinations.&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
+    # @param export_request_info ExportRequest object that is passed in the body
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExportRequestResponse, Fixnum, Hash)>] ExportRequestResponse data, response status code and response headers
+    def export_request_with_http_info(export_request_info, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExportApi#export_request ..."
+      end
+      
+      # verify the required parameter 'export_request_info' is set
+      fail "Missing the required parameter 'export_request_info' when calling export_request" if export_request_info.nil?
+      
+      # resource path
+      local_var_path = "/messages/export".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 = []
+      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(export_request_info)
+      
+      auth_names = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ExportRequestResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExportApi#export_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Export History
+    # Get the history of export requests.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :trial_id Filter by trialId.
+    # @option opts [Integer] :count Pagination count.
+    # @option opts [Integer] :offset Pagination offset.
+    # @return [ExportHistoryResponse]
+    def get_export_history(opts = {})
+      data, status_code, headers = get_export_history_with_http_info(opts)
+      return data
+    end
+
+    # Get Export History
+    # Get the history of export requests.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :trial_id Filter by trialId.
+    # @option opts [Integer] :count Pagination count.
+    # @option opts [Integer] :offset Pagination offset.
+    # @return [Array<(ExportHistoryResponse, Fixnum, Hash)>] ExportHistoryResponse data, response status code and response headers
+    def get_export_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExportApi#get_export_history ..."
+      end
+      
+      # resource path
+      local_var_path = "/messages/export/history".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'trialId'] = opts[:'trial_id'] if opts[:'trial_id']
+      query_params[:'count'] = opts[:'count'] if opts[:'count']
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+
+      # 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 = []
+      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 = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ExportHistoryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExportApi#get_export_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Export Result
+    # Retrieve result of the export query in tgz format. The tar file may contain one or more files with the results.
+    # @param export_id Export ID of the export query.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_export_result(export_id, opts = {})
+      data, status_code, headers = get_export_result_with_http_info(export_id, opts)
+      return data
+    end
+
+    # Get Export Result
+    # Retrieve result of the export query in tgz format. The tar file may contain one or more files with the results.
+    # @param export_id Export ID of the export query.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_export_result_with_http_info(export_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExportApi#get_export_result ..."
+      end
+      
+      # verify the required parameter 'export_id' is set
+      fail "Missing the required parameter 'export_id' when calling get_export_result" if export_id.nil?
+      
+      # resource path
+      local_var_path = "/messages/export/{exportId}/result".sub('{format}','json').sub('{' + 'exportId' + '}', export_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 = []
+      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 = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_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: ExportApi#get_export_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Check Export Status
+    # Check status of the export query.
+    # @param export_id Export ID of the export query.
+    # @param [Hash] opts the optional parameters
+    # @return [ExportStatusResponse]
+    def get_export_status(export_id, opts = {})
+      data, status_code, headers = get_export_status_with_http_info(export_id, opts)
+      return data
+    end
+
+    # Check Export Status
+    # Check status of the export query.
+    # @param export_id Export ID of the export query.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ExportStatusResponse, Fixnum, Hash)>] ExportStatusResponse data, response status code and response headers
+    def get_export_status_with_http_info(export_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ExportApi#get_export_status ..."
+      end
+      
+      # verify the required parameter 'export_id' is set
+      fail "Missing the required parameter 'export_id' when calling get_export_status" if export_id.nil?
+      
+      # resource path
+      local_var_path = "/messages/export/{exportId}/status".sub('{format}','json').sub('{' + 'exportId' + '}', export_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 = []
+      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 = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ExportStatusResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ExportApi#get_export_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end