batchly_api 0.6.6 → 0.6.7

data/lib/batchly_api/controllers/processors_controller.rb

@@ -0,0 +1,225 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
+
+module BatchlyApi
+  class ProcessorsController
+
+    # TODO: type endpoint description here
+    # @return Array<ProcessorModel> response from the API call
+    def list_marketplace_processors
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors/Marketplace"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @return Array<ProcessorModel> response from the API call
+    def list_vault_processors id
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors/Vault/{id}"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+      }
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @param [AddParameterGroupRequest] request Required parameter: TODO: type description here
+    # @return Array<DescribeParameterGroupResponse> response from the API call
+    def add_parameter_group id, request
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors/{id}/ParameterGroups"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+      }
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.post query_url, headers:headers, parameters:request.to_json
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] parameter_group_id Required parameter: TODO: type description here
+    # @param [String] processor_id Required parameter: TODO: type description here
+    # @return DescribeParameterGroupResponse response from the API call
+    def describe_parameter_group parameter_group_id, processor_id
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors/{processorId}/ParameterGroups/{parameterGroupId}"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "parameterGroupId" => parameter_group_id,
+        "processorId" => processor_id,
+      }
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [AddProcessorRequest] request Required parameter: TODO: type description here
+    # @return Array<ProcessorModel> response from the API call
+    def add_processor_to_vault request
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors/Vault"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.post query_url, headers:headers, parameters:request.to_json
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # TODO: type endpoint description here
+    # @param [AddProcessorRequest] request Required parameter: TODO: type description here
+    # @return Array<ProcessorModel> response from the API call
+    def add_processor_to_job request
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Processors"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.post query_url, headers:headers, parameters:request.to_json
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+  end
+end

data/lib/batchly_api/controllers/{project_controller.rb → projects_controller.rb}

@@ -1,9 +1,41 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
-  class ProjectController
+  class ProjectsController
 
-    # Add a new Project and associate with a cloud VPC
+    # Returns the active list of projects within batchly.  The information includes the account information under which the project operates.
+    # @return Array<ProjectModel> response from the API call
+    def list_projects
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Projects"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # Creates a new project from the request information.  Account Identifier should be a valid value and can be obtained from the ListAccounts endpoint.
     # @param [CreateProjectRequest] request Required parameter: Create Project Request
     # @return ProjectModel response from the API call
     def add_project request
@@ -11,14 +43,14 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Project"
+      query_builder << "/api/Projects"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -39,7 +71,7 @@ module BatchlyApi
       response.body
     end
 
-    # Describes the Project in detail
+    # Returns the project information for the submitted identifier.
     # @param [String] id Required parameter: Project Identifier
     # @return ProjectModel response from the API call
     def describe_project id
@@ -47,7 +79,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Project/{id}"
+      query_builder << "/api/Projects/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -59,7 +91,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -79,7 +111,7 @@ module BatchlyApi
       response.body
     end
 
-    # Update the project with new information
+    # Updates the project with new details.  Projects belong to an account when created and this association cannot be altered.
     # @param [String] id Required parameter: Project Identifier
     # @param [UpdateProjectRequest] request Required parameter: Update Project Request
     # @return ProjectModel response from the API call
@@ -88,7 +120,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Project/{id}"
+      query_builder << "/api/Projects/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -100,7 +132,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -123,7 +155,7 @@ module BatchlyApi
       response.body
     end
 
-    # Deletes the project & deactivates all existing jobs in the project
+    # Removes the project and deactivates all the jobs currently active in it.
     # @param [String] id Required parameter: Project Identifier
     # @return void response from the API call
     def delete_project id
@@ -131,7 +163,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Project/{id}"
+      query_builder << "/api/Projects/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -143,7 +175,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3"
+        "user-agent" => "batchly/1.0.1"
       }
 
       # append custom auth authorization
@@ -160,37 +192,5 @@ module BatchlyApi
       end
     end
 
-    # Lists all active projects in batchly
-    # @return Array<ProjectModel> response from the API call
-    def list_projects
-      # the base uri for api requests
-      query_builder = Configuration.BASE_URI.dup
-
-      # prepare query string for API call
-      query_builder << "/api/Project"
-
-      # validate and preprocess url
-      query_url = APIHelper.clean_url query_builder
-
-      # prepare headers
-      headers = {
-        "user-agent" => "batchly/0.5.3",
-        "accept" => "application/json"
-      }
-
-      # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
-
-      # invoke the API call request to fetch the response
-      response = Unirest.get query_url, headers:headers
-
-      #Error handling using HTTP status codes
-      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
-        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
-      end
-
-      response.body
-    end
-
   end
 end

data/lib/batchly_api/controllers/{run_controller.rb → runs_controller.rb}

@@ -1,47 +1,41 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
-  class RunController
+  class RunsController
 
-    # Executes the job and creates a new run for tracking
-    # @param [ExecuteJobRequest] request Required parameter: Execute Job Request
-    # @return RunModel response from the API call
-    def start_run request
+    # Returns the active runs with details about the current status
+    # @return Array<RunModel> response from the API call
+    def list_runs
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Run"
+      query_builder << "/api/Runs"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
-        "accept" => "application/json",
-        "content-type" => "application/json; charset=utf-8"
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json"
       }
 
       # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
 
       # invoke the API call request to fetch the response
-      response = Unirest.post query_url, headers:headers, parameters:request.to_json
+      response = Unirest.get query_url, headers:headers
 
-      # Error handling using HTTP status codes
-      if response.code == 400
-        raise APIException.new "BadRequest", 400, response.raw_body
-      elsif response.code == 409
-        raise APIException.new "Conflict", 409, response.raw_body
-      elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
         raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
       end
 
       response.body
     end
 
-    # Describes the run
+    # Returns the detailed information about the requested run
     # @param [String] id Required parameter: Run Identifier
     # @return RunModel response from the API call
     def describe_run id
@@ -49,7 +43,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Run/{id}"
+      query_builder << "/api/Runs/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -61,7 +55,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -81,7 +75,7 @@ module BatchlyApi
       response.body
     end
 
-    # Stops the execution of job
+    # Stops the run if its executing and returns 200 true response. Repeat calls to a run which is currently stopping returns a 200 false response
     # @param [String] id Required parameter: Run Identifier
     # @return Boolean response from the API call
     def stop_run id
@@ -89,7 +83,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Run/{id}"
+      query_builder << "/api/Runs/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -101,7 +95,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3"
+        "user-agent" => "batchly/1.0.1"
       }
 
       # append custom auth authorization
@@ -120,7 +114,9 @@ module BatchlyApi
       response.body
     end
 
-    # Delete the run
+    # Removes the run from the active list.  The values are still considered for cost and savings calculation.
+    #                 Only completed, terminated and error runs can be archived.
+    #                 Active execution should first be stopped and then archived.
     # @param [String] id Required parameter: Run Identifier
     # @return void response from the API call
     def delete_run id
@@ -128,7 +124,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Run/{id}"
+      query_builder << "/api/Runs/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -140,7 +136,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3"
+        "user-agent" => "batchly/1.0.1"
       }
 
       # append custom auth authorization
@@ -157,37 +153,5 @@ module BatchlyApi
       end
     end
 
-    # Lists all the active runs in batchly
-    # @return Array<RunModel> response from the API call
-    def list_runs
-      # the base uri for api requests
-      query_builder = Configuration.BASE_URI.dup
-
-      # prepare query string for API call
-      query_builder << "/api/Run"
-
-      # validate and preprocess url
-      query_url = APIHelper.clean_url query_builder
-
-      # prepare headers
-      headers = {
-        "user-agent" => "batchly/0.5.3",
-        "accept" => "application/json"
-      }
-
-      # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
-
-      # invoke the API call request to fetch the response
-      response = Unirest.get query_url, headers:headers
-
-      #Error handling using HTTP status codes
-      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
-        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
-      end
-
-      response.body
-    end
-
   end
 end