directus_sdk 1.1.1

data/docs/UtilsApi.md

@@ -0,0 +1,126 @@
+# DirectusSDK::UtilsApi
+
+All URIs are relative to *https://myinstance.directus.io/api/1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_hash**](UtilsApi.md#get_hash) | **POST** /hash | Get a hashed value
+[**get_random**](UtilsApi.md#get_random) | **POST** /random | Returns random alphanumeric string
+
+
+# **get_hash**
+> get_hash(opts)
+
+Get a hashed value
+
+### Example
+```ruby
+# load the gem
+require 'directus_sdk'
+# setup authorization
+DirectusSDK.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'Bearer'
+  # Configure your host
+  config.host = "myinstance.directus.io"
+  # Enable or disable debugging output
+  config.debugging = false
+end
+
+api_instance = DirectusSDK::UtilsApi.new
+
+opts = { 
+  string: "string_example", # String | The string to be hashed
+  hasher: "core", # String | The hasher used to hash the given string
+  options: "options_example" # String | The hasher options
+}
+
+begin
+  #Get a hashed value
+  api_instance.get_hash(opts)
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling UtilsApi->get_hash: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **string** | **String**| The string to be hashed | [optional] 
+ **hasher** | **String**| The hasher used to hash the given string | [optional] [default to core]
+ **options** | **String**| The hasher options | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **get_random**
+> get_random(opts)
+
+Returns random alphanumeric string
+
+### Example
+```ruby
+# load the gem
+require 'directus_sdk'
+# setup authorization
+DirectusSDK.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['access_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['access_token'] = 'Bearer'
+  # Configure your host
+  config.host = "myinstance.directus.io"
+  # Enable or disable debugging output
+  config.debugging = false
+end
+
+api_instance = DirectusSDK::UtilsApi.new
+
+opts = { 
+  length: "length_example" # String | Integer(String) for length of random string
+}
+
+begin
+  #Returns random alphanumeric string
+  api_instance.get_random(opts)
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling UtilsApi->get_random: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **length** | **String**| Integer(String) for length of random string | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/directus_sdk.rb

@@ -0,0 +1,92 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'directus_sdk/api_client'
+require 'directus_sdk/api_error'
+require 'directus_sdk/version'
+require 'directus_sdk/configuration'
+
+# Models
+require 'directus_sdk/models/get_activity'
+require 'directus_sdk/models/get_activity_data'
+require 'directus_sdk/models/get_activity_meta'
+require 'directus_sdk/models/get_bookmark'
+require 'directus_sdk/models/get_bookmarks'
+require 'directus_sdk/models/get_bookmarks_data'
+require 'directus_sdk/models/get_bookmarks_meta'
+require 'directus_sdk/models/get_file'
+require 'directus_sdk/models/get_files'
+require 'directus_sdk/models/get_files_data'
+require 'directus_sdk/models/get_group'
+require 'directus_sdk/models/get_groups'
+require 'directus_sdk/models/get_groups_data'
+require 'directus_sdk/models/get_groups_data_data'
+require 'directus_sdk/models/get_groups_data_meta'
+require 'directus_sdk/models/get_message'
+require 'directus_sdk/models/get_messages'
+require 'directus_sdk/models/get_messages_data'
+require 'directus_sdk/models/get_messages_meta'
+require 'directus_sdk/models/get_messages_responses'
+require 'directus_sdk/models/get_preferences'
+require 'directus_sdk/models/get_preferences_data'
+require 'directus_sdk/models/get_privileges'
+require 'directus_sdk/models/get_privileges_data'
+require 'directus_sdk/models/get_privileges_for_table'
+require 'directus_sdk/models/get_settings'
+require 'directus_sdk/models/get_settings_data'
+require 'directus_sdk/models/get_settings_data_files'
+require 'directus_sdk/models/get_settings_data_global'
+require 'directus_sdk/models/get_settings_for'
+require 'directus_sdk/models/get_settings_for_meta'
+require 'directus_sdk/models/get_table'
+require 'directus_sdk/models/get_table_column'
+require 'directus_sdk/models/get_table_column_data'
+require 'directus_sdk/models/get_table_columns'
+require 'directus_sdk/models/get_table_columns_data'
+require 'directus_sdk/models/get_table_data'
+require 'directus_sdk/models/get_table_row'
+require 'directus_sdk/models/get_table_rows'
+require 'directus_sdk/models/get_table_rows_data'
+require 'directus_sdk/models/get_table_rows_meta'
+require 'directus_sdk/models/get_tables'
+require 'directus_sdk/models/get_tables_data'
+require 'directus_sdk/models/get_tables_meta'
+
+# APIs
+require 'directus_sdk/api/activity_api'
+require 'directus_sdk/api/bookmarks_api'
+require 'directus_sdk/api/files_api'
+require 'directus_sdk/api/groups_api'
+require 'directus_sdk/api/messages_api'
+require 'directus_sdk/api/preferences_api'
+require 'directus_sdk/api/settings_api'
+require 'directus_sdk/api/tables_api'
+require 'directus_sdk/api/utils_api'
+
+module DirectusSDK
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DirectusSDK.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/directus_sdk/api/activity_api.rb

@@ -0,0 +1,70 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require "uri"
+
+module DirectusSDK
+  class ActivityApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Returns activity
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [GetActivity]
+    def get_activity(opts = {})
+      data, _status_code, _headers = get_activity_with_http_info(opts)
+      return data
+    end
+
+    # Returns activity
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetActivity, Fixnum, Hash)>] GetActivity data, response status code and response headers
+    def get_activity_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ActivityApi.get_activity ..."
+      end
+      # resource path
+      local_var_path = "/activity"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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 => 'GetActivity')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActivityApi#get_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/directus_sdk/api/bookmarks_api.rb

@@ -0,0 +1,288 @@
+=begin
+#directus.io
+
+#API for directus.io
+
+OpenAPI spec version: 1.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.0-SNAPSHOT
+
+=end
+
+require "uri"
+
+module DirectusSDK
+  class BookmarksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Create a column in a given table
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user [Directus user id] This assigns the bookmark to a specific user (there's a ticket to allow for \"global\" bookmarks using NULL) (Only using local connection)
+    # @option opts [String] :title The text to display in the navigation menu
+    # @option opts [String] :url The path to navigate to when clicked, relative to the Directus root
+    # @option opts [String] :icon_class Deprecated
+    # @option opts [String] :active Deprecated
+    # @option opts [String] :section [\"search\" or \"other\"] Which nav section to show the link within. User generated bookmarks use \"search\", while all system links go within \"other\"
+    # @return [nil]
+    def add_bookmark(opts = {})
+      add_bookmark_with_http_info(opts)
+      return nil
+    end
+
+    # Create a column in a given table
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user [Directus user id] This assigns the bookmark to a specific user (there's a ticket to allow for \"global\" bookmarks using NULL) (Only using local connection)
+    # @option opts [String] :title The text to display in the navigation menu
+    # @option opts [String] :url The path to navigate to when clicked, relative to the Directus root
+    # @option opts [String] :icon_class Deprecated
+    # @option opts [String] :active Deprecated
+    # @option opts [String] :section [\"search\" or \"other\"] Which nav section to show the link within. User generated bookmarks use \"search\", while all system links go within \"other\"
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def add_bookmark_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BookmarksApi.add_bookmark ..."
+      end
+      # resource path
+      local_var_path = "/bookmarks"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+      form_params["user"] = opts[:'user'] if !opts[:'user'].nil?
+      form_params["title"] = opts[:'title'] if !opts[:'title'].nil?
+      form_params["url"] = opts[:'url'] if !opts[:'url'].nil?
+      form_params["icon_class"] = opts[:'icon_class'] if !opts[:'icon_class'].nil?
+      form_params["active"] = opts[:'active'] if !opts[:'active'].nil?
+      form_params["section"] = opts[:'section'] if !opts[:'section'].nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BookmarksApi#add_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes specific bookmark
+    # 
+    # @param bookmark_id ID of table to return rows from
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_bookmark(bookmark_id, opts = {})
+      delete_bookmark_with_http_info(bookmark_id, opts)
+      return nil
+    end
+
+    # Deletes specific bookmark
+    # 
+    # @param bookmark_id ID of table to return rows from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_bookmark_with_http_info(bookmark_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BookmarksApi.delete_bookmark ..."
+      end
+      # verify the required parameter 'bookmark_id' is set
+      if @api_client.config.client_side_validation && bookmark_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bookmark_id' when calling BookmarksApi.delete_bookmark"
+      end
+      # resource path
+      local_var_path = "/bookmarks/{bookmarkId}".sub('{' + 'bookmarkId' + '}', bookmark_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_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: BookmarksApi#delete_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns specific bookmark
+    # 
+    # @param bookmark_id ID of table to return rows from
+    # @param [Hash] opts the optional parameters
+    # @return [GetBookmark]
+    def get_bookmark(bookmark_id, opts = {})
+      data, _status_code, _headers = get_bookmark_with_http_info(bookmark_id, opts)
+      return data
+    end
+
+    # Returns specific bookmark
+    # 
+    # @param bookmark_id ID of table to return rows from
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetBookmark, Fixnum, Hash)>] GetBookmark data, response status code and response headers
+    def get_bookmark_with_http_info(bookmark_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BookmarksApi.get_bookmark ..."
+      end
+      # verify the required parameter 'bookmark_id' is set
+      if @api_client.config.client_side_validation && bookmark_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bookmark_id' when calling BookmarksApi.get_bookmark"
+      end
+      # resource path
+      local_var_path = "/bookmarks/{bookmarkId}".sub('{' + 'bookmarkId' + '}', bookmark_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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 => 'GetBookmark')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BookmarksApi#get_bookmark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns bookmarks
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [GetBookmarks]
+    def get_bookmarks(opts = {})
+      data, _status_code, _headers = get_bookmarks_with_http_info(opts)
+      return data
+    end
+
+    # Returns bookmarks
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetBookmarks, Fixnum, Hash)>] GetBookmarks data, response status code and response headers
+    def get_bookmarks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BookmarksApi.get_bookmarks ..."
+      end
+      # resource path
+      local_var_path = "/bookmarks"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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 => 'GetBookmarks')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BookmarksApi#get_bookmarks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns bookmarks of current user
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [GetBookmarks]
+    def get_bookmarks_self(opts = {})
+      data, _status_code, _headers = get_bookmarks_self_with_http_info(opts)
+      return data
+    end
+
+    # Returns bookmarks of current user
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetBookmarks, Fixnum, Hash)>] GetBookmarks data, response status code and response headers
+    def get_bookmarks_self_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BookmarksApi.get_bookmarks_self ..."
+      end
+      # resource path
+      local_var_path = "/bookmarks/self"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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 => 'GetBookmarks')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BookmarksApi#get_bookmarks_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end