kinetic_sdk 0.1.1

data/lib/kinetic_sdk/request_ce/lib/attribute_definitions.rb

@@ -0,0 +1,153 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a new user attribute definition.
+    #
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_user_attribute_definition(name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding User attribute definition \"#{name}\" to the \"#{space_slug}\" space.")
+      # Create the user attribute definition
+      post("#{@api_url}/userAttributeDefinitions", body, headers)
+    end
+
+    # Add a new user profile attribute definition.
+    #
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_user_profile_attribute_definition(name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding User attribute definition \"#{name}\" to the \"#{space_slug}\" space.")
+      # Create the user attribute definition
+      post("#{@api_url}/userProfileAttributeDefinitions", body, headers)
+    end
+
+    # Add a new space attribute definition.
+    #
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_space_attribute_definition(name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Space attribute definition \"#{name}\" to the \"#{space_slug}\" space.")
+      # Create the attribute definition
+      post("#{@api_url}/spaceAttributeDefinitions", body, headers)
+    end
+
+    # Add a new datastore form attribute definition.
+    #
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_datastore_form_attribute_definition(name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Datastore Form attribute definition \"#{name}\" to the \"#{space_slug}\" space.")
+      # Create the attribute definition
+      post("#{@api_url}/datastoreFormAttributeDefinitions", body, headers)
+    end
+
+    # Add a new category attribute definition.
+    #
+    # @param kapp_slug [String] slug of the kapp where the category exists
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_category_attribute_definition(kapp_slug, name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Category attribute definition \"#{name}\" to the \"#{kapp_slug}\" kapp.")
+      # Create the attribute definition
+      post("#{@api_url}/kapps/#{kapp_slug}/categoryAttributeDefinitions", body, headers)
+    end
+
+    # Add a new form attribute definition.
+    #
+    # @param kapp_slug [String] slug of the kapp where the form exists
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_form_attribute_definition(kapp_slug, name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Form attribute definition \"#{name}\" to the \"#{kapp_slug}\" kapp.")
+      # Create the attribute definition
+      post("#{@api_url}/kapps/#{kapp_slug}/formAttributeDefinitions", body, headers)
+    end
+
+    # Add a new kapp attribute definition.
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_kapp_attribute_definition(kapp_slug, name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Kapp attribute definition \"#{name}\" to the \"#{kapp_slug}\" kapp.")
+      # Create the attribute definition
+      post("#{@api_url}/kapps/#{kapp_slug}/kappAttributeDefinitions", body, headers)
+    end
+
+    # Add a new team attribute definition.
+    #
+    # @param name [String] name of the attribute definition
+    # @param description [String] description of the attribute definition
+    # @param allows_multiple [Boolean] whether the attribute allows multiple values
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_team_attribute_definition(name, description, allows_multiple, headers=default_headers)
+      body = {
+        "allowsMultiple" => allows_multiple,
+        "description" => description,
+        "name" => name
+      }
+      info("Adding Team attribute definition \"#{name}\" to the \"#{space_slug}\" space.")
+      # Create the team attribute definition
+      post("#{@api_url}/teamAttributeDefinitions", body, headers)
+    end
+
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/bridges.rb

@@ -0,0 +1,66 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Bridge
+    #
+    # @param body [Hash] optional properties associated to the Bridge
+    #   - +name+
+    #   - +status+
+    #   - +url+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_bridge(body={}, headers=default_headers)
+      info("Adding the \"#{body['name']}\" Bridge.")
+      post("#{@api_url}/bridges", body, headers)
+    end
+
+    # Add a Bridge Model
+    #
+    # @param body [Hash] optional properties associated to the Bridge Model
+    #   - +name+
+    #   - +status+
+    #   - +activeMappingName+
+    #   - +attributes+
+    #   - +mappings+
+    #   - +qualifications+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_bridge_model(body={}, headers=default_headers)
+      info("Adding the \"#{body['name']}\" Bridge Model and Mappings.")
+      post("#{@api_url}/models", body, headers)
+    end
+
+    # Find a list of bridges
+    #
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_bridges(params={}, headers=default_headers)
+      info("Find Bridges.")
+      get("#{@api_url}/bridges", params, headers)
+    end
+
+    # Find a bridge
+    #
+    # @param name [String] name of the bridge
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_bridge(name, params={}, headers=default_headers)
+      info("Finding the \"#{name}\" Bridge.")
+      get("#{@api_url}/bridges/#{encode{name}}", params, headers)
+    end
+
+    # Update a bridge
+    #
+    # @param name [String] name of the bridge
+    # @param body [Hash] properties of the bridge to update
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_bridge(name, body={}, headers=default_headers)
+      info("Updating the \"#{name}\" Bridge.")
+      put("#{@api_url}/bridges/#{encode(name)}", body, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/categories.rb

@@ -0,0 +1,34 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a category on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the category belongs to
+    # @param body [Hash] category properties
+    #   - +name+ - A descriptive name for the category
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_category_on_kapp(kapp_slug, body, headers=default_headers)
+      raise StandardError.new "Category properties is not valid, must be a Hash." unless body.is_a? Hash
+      info("Adding Category \"#{body['name']}\" for \"#{kapp_slug}\" kapp")
+      post("#{@api_url}/kapps/#{kapp_slug}/categories", body, headers)
+    end
+
+    # Add a categorization on a form
+    #
+    # @param kapp_slug [String] slug of the Kapp the category belongs to
+    # @param body [Hash] categorization properties
+    #   - +category+ - A hash of properties for the category
+    #   - +category/slug+ - The slug of the category to apply to the form
+    #   - +form+ - A hash of properties for the form
+    #   - +form/slug+ - The slug of the form to apply the category
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_categorization_on_form(kapp_slug, body, headers=default_headers)
+      raise StandardError.new "Category properties is not valid, must be a Hash." unless body.is_a? Hash
+      info("Adding Categorization for \"#{kapp_slug}\" kapp")
+      post("#{@api_url}/kapps/#{kapp_slug}/categorizations", body, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/datastore_form.rb

@@ -0,0 +1,110 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Datastore Form
+    #
+    # @param form_properties [Hash] form properties
+    #   - +customHeadContent+
+    #   - +description+
+    #   - +name+
+    #   - +notes+
+    #   - +slug+
+    #   - +status+
+    #   - +submissionLabelExpression+
+    #   - +attributes+
+    #   - +attributesMap+
+    #   - +bridgedResources+
+    #   - +pages+
+    #   - +securityPolicies+
+    #   - +indexDefinitions+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_datastore_form(form_properties={}, headers=default_headers)
+      info("Adding the \"#{form_properties['name']}\" Form.")
+      post("#{@api_url}/datastore/forms", form_properties, headers)
+    end
+
+    # Delete a Datastore Form
+    #
+    # @param form_slug [String] slug of the form
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def delete_datastore_form(form_slug, headers=default_headers)
+      info("Deleting the \"#{form_slug}\" Datastore Form")
+      delete("#{@api_url}/datastore/forms/#{form_slug}", headers)
+    end
+
+    # Export a Datastore Form
+    #
+    # @param form_slug [String] slug of the form
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def export_datastore_form(form_slug, headers=default_headers)
+      info("Exporting the \"#{form_slug}\" Datastore Form.")
+      get("#{@api_url}/datastore/forms/#{form_slug}", { 'export' => true }, headers)
+    end
+
+    # Find Datastore Forms
+    #
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_datastore_forms(params={}, headers=default_headers)
+      info("Finding Forms.")
+      get("#{@api_url}/datastore/forms", params, headers)
+    end
+
+    # Find a Datastore Form
+    #
+    # @param form_slug [String] slug of the form
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_datastore_form(form_slug, params={}, headers=default_headers)
+      info("Finding the \"#{form_slug}\" Datastore Form")
+      get("#{@api_url}/datastore/forms/#{form_slug}", params, headers)
+    end
+
+    # Update a Datastore Form
+    #
+    # @param form_slug [String] slug of the form
+    # @param properties [Hash] form properties to update
+    #   - +customHeadContent+
+    #   - +description+
+    #   - +name+
+    #   - +notes+
+    #   - +slug+
+    #   - +status+
+    #   - +submissionLabelExpression+
+    #   - +attributes+
+    #   - +attributesMap+
+    #   - +bridgedResources+
+    #   - +pages+
+    #   - +securityPolicies+
+    #   - +indexDefinitions+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_datastore_form(form_slug, properties={}, headers=default_headers)
+      info("Updating the \"#{form_slug}\" Datastore Form.")
+      put("#{@api_url}/datastore/forms/#{form_slug}", properties, headers)
+    end
+
+    # Build Datastore Indexes
+    # 
+    # @param form_slug [String] slug of the form
+    # @param indexes [Array] array of index names to build indexes
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def build_datastore_form_indexes(form_slug, indexes, headers=default_headers)
+      payload = {
+        "type" => "Datastore Indexing",
+        "content" => {
+          "indexes" => indexes
+        }
+      }
+      info("Building indexes for the \"#{form_slug}\" Datastore Form.")
+      post("#{@api_url}/datastore/forms/#{form_slug}/backgroundJobs", payload, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/datastore_submissions.rb

@@ -0,0 +1,157 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Datastore Submission
+    #
+    # @param form_slug [String] slug of the Form
+    # @param payload [Hash] payload of the submission
+    #   - +origin+ - Origin ID of the submission to be added
+    #   - +parent+ - Parent ID of the submission to be added
+    #   - +values+ - hash of field values for the submission
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_datastore_submission(form_slug, payload={}, headers=default_headers)
+      # initialize "values" if nil
+      payload["values"] = {} if payload["values"].nil?
+      # set origin hash if origin was passed as a string
+      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
+      # set parent hash if parent was passed as a string
+      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # Create the submission
+      info("Adding a submission in the \"#{form_slug}\" Datastore Form.")
+      post("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
+    end
+
+    # Add a Datastore Submission page
+    #
+    # @param form_slug [String] slug of the Form
+    # @param page_name [String] name of the Page
+    # @param payload [Hash] payload of the submission
+    #   - +origin+ - Origin ID of the submission to be added
+    #   - +parent+ - Parent ID of the submission to be added
+    #   - +values+ - hash of field values for the submission
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_datastore_submission_page(form_slug, page_name, payload={}, headers=default_headers)
+      # initialize "values" if nil
+      payload["values"] = {} if payload["values"].nil?
+      # set origin hash if origin was passed as a string
+      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
+      # set parent hash if parent was passed as a string
+      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # Create the submission
+      info("Adding a submission page in the \"#{form_slug}\" Datastore Form.")
+      post("#{@api_url}/datastore/forms/#{form_slug}/submissions?page=#{encode(page_name)}", payload, headers)
+    end
+
+    # Patch a new Datastore Submission
+    #
+    # @param form_slug [String] slug of the Form
+    # @param payload [Hash] payload of the submission
+    #   - +origin+ - Origin ID of the submission to be patched
+    #   - +parent+ - Parent ID of the submission to be patched
+    #   - +values+ - hash of field values for the submission
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def patch_datastore_submission(form_slug, payload={}, headers=default_headers)
+      # set the currentPage hash if currentPage was passed as a string
+      payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
+      # initialize "values" if nil
+      payload["values"] = {} if payload["values"].nil?
+      # set origin hash if origin was passed as a string
+      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
+      # set parent hash if parent was passed as a string
+      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # Create the submission
+      info("Patching a submission in the \"#{form_slug}\" Form.")
+      patch("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
+    end
+
+    # Find all Submissions for a Datastore Form.
+    #
+    # This method will process pages of form submissions and internally
+    # concatenate the results into a single array.
+    #
+    # Warning - using this method can cause out of memory errors on large
+    #           result sets.
+    #
+    # @param form_slug [String] slug of the Form
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_all_form_datastore_submissions(form_slug, params={}, headers=default_headers)
+      info("Finding submissions for the \"#{form_slug}\" Datastore Form.")
+      # Make the initial request of pages submissions
+      response = find_form_datastore_submissions(form_slug, params, headers)
+      # Build the Messages Array
+      messages = response.content["messages"]
+      # Build Submissions Array
+      submissions = response.content["submissions"]
+      # if a next page token exists, keep retrieving submissions and add them to the results
+      while (!response.content["nextPageToken"].nil?)
+        params['pageToken'] = response.content["nextPageToken"]
+        response = find_form_datastore_submissions(form_slug, params, headers)
+        # concat the messages
+        messages.concat(response.content["messages"] || [])
+        # concat the submissions
+        submissions.concat(response.content["submissions"] || [])
+      end
+      final_content = { "messages" => messages, "submissions" => submissions, "nextPageToken" => nil }
+      # Return the results
+      response.content=final_content
+      response.content_string=final_content.to_json
+      response
+    end
+
+    # Find a page of Submissions for a Datastore form.
+    #
+    # The page offset can be defined by passing in the "pageToken" parameter,
+    # indicating the value of the token that will represent the first
+    # submission in the result set.  If not provided, the first page of
+    # submissions will be retrieved.
+    #
+    # @param form_slug [String] slug of the Form
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    #   - +pageToken+ - used for paginated results
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_form_datastore_submissions(form_slug, params={}, headers=default_headers)
+      # Get next page token
+      token = params["pageToken"]
+      if token.nil?
+        info("Finding first page of submissions for the \"#{form_slug}\" Datastore.")
+      else
+        info("Finding page of submissions starting with token \"#{token}\" for the \"#{form_slug}\" Form.")
+      end
+
+      # Build Submission URL
+      url = "#{@api_url}/datastore/forms/#{form_slug}/submissions"
+      # Return the response
+      get(url, params, headers)
+    end
+
+
+    # Update a Datastore submission
+    #
+    # @param submission_id [String] String value of the Submission Id (UUID)
+    # @param body [Hash] submission properties to update
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_datastore_submission(submission_id, body={}, headers=default_headers)
+      info("Updating Datastore Submission \"#{submission_id}\"")
+      put("#{@api_url}/datastore/submissions/#{encode(submission_id)}", body, headers)
+    end
+
+
+    # Delete a Datastore submission
+    #
+    # @param submission_id [String] String value of the Submission Id (UUID)
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def delete_datastore_submission(submission_id, headers=default_headers)
+      info("Deleting Datastore Submission \"#{submission_id}\"")
+      delete("#{@api_url}/datastore/submissions/#{encode(submission_id)}", headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/form.rb

@@ -0,0 +1,99 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Form
+    #
+    # @param kapp_slug [String] slug of the Kapp the form belongs to
+    # @param form_properties [Hash] form properties
+    #   - +anonymous+
+    #   - +customHeadContent+
+    #   - +description+
+    #   - +name+
+    #   - +notes+
+    #   - +slug+
+    #   - +status+
+    #   - +submissionLabelExpression+
+    #   - +type+
+    #   - +attributes+
+    #   - +bridgedResources+
+    #   - +pages+
+    #   - +securityPolicies+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_form(kapp_slug, form_properties={}, headers=default_headers)
+      info("Adding the \"#{form_properties['name']}\" Form.")
+      post("#{@api_url}/kapps/#{kapp_slug}/forms", form_properties, headers)
+    end
+
+    # Delete a Form
+    #
+    # @param kapp_slug [String] slug of the Kapp the form belongs to
+    # @param form_slug [String] slug of the form
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def delete_form(kapp_slug, form_slug, headers=default_headers)
+      info("Deleting the \"#{form_slug}\" Form in the \"#{kapp_slug}\" Kapp.")
+      delete("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}", headers)
+    end
+
+    # Export a Form
+    #
+    # @param kapp_slug [String] slug of the Kapp the form belongs to
+    # @param form_slug [String] slug of the form
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def export_form(kapp_slug, form_slug, headers=default_headers)
+      info("Exporting the \"#{form_slug}\" Form in the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}", { 'export' => true }, headers)
+    end
+
+    # Find Forms
+    #
+    # @param kapp_slug [String] slug of the Kapp the forms belongs to
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_forms(kapp_slug, params={}, headers=default_headers)
+      info("Finding Forms.")
+      get("#{@api_url}/kapps/#{kapp_slug}/forms", params, headers)
+    end
+
+    # Find a Form
+    #
+    # @param kapp_slug [String] slug of the Kapp the form belongs to
+    # @param form_slug [String] slug of the form
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_form(kapp_slug, form_slug, params={}, headers=default_headers)
+      info("Finding the \"#{form_slug}\" Form in the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}", params, headers)
+    end
+
+    # Update a Form
+    #
+    # @param kapp_slug [String] slug of the Kapp the form belongs to
+    # @param form_slug [String] slug of the form
+    # @param properties [Hash] form properties to update
+    #   - +anonymous+
+    #   - +customHeadContent+
+    #   - +description+
+    #   - +name+
+    #   - +notes+
+    #   - +slug+
+    #   - +status+
+    #   - +submissionLabelExpression+
+    #   - +type+
+    #   - +attributes+
+    #   - +bridgedResources+
+    #   - +pages+
+    #   - +securityPolicies+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_form(kapp_slug, form_slug, properties={}, headers=default_headers)
+      info("Updating the \"#{form_slug}\" Form in the \"#{kapp_slug}\" Kapp.")
+      put("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}", properties, headers)
+    end
+
+  end
+end