directus_sdk 1.1.1

data/docs/FilesApi.md

@@ -0,0 +1,277 @@
+# DirectusSDK::FilesApi
+
+All URIs are relative to *https://myinstance.directus.io/api/1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_file**](FilesApi.md#create_file) | **POST** /files | Creates file
+[**get_file**](FilesApi.md#get_file) | **GET** /files/{fileId} | Returns specific file by id
+[**get_files**](FilesApi.md#get_files) | **GET** /files | Returns files
+[**update_file**](FilesApi.md#update_file) | **PUT** /files/{fileId} | Creates file
+
+
+# **create_file**
+> create_file(opts)
+
+Creates file
+
+### 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::FilesApi.new
+
+opts = { 
+  data: "data_example", # String | The file's Base64 content
+  active: 56, # Integer | The file's status, default options are: 1 (active), 2 (inactive), 0 (deleted)
+  name: "name_example", # String | The name used in the filesystem, including the extension, eg: \"my-file.jpg\". This is generated by the system based on Global Settings
+  title: "title_example", # String | The file's title
+  location: "location_example", # String | Location of where the picture was taken, if any. Pulled from the IPTC location when available
+  type: "type_example", # String | The file's mime type
+  tags: "tags_example", # String | A CSV of tags for this file. Pulled from the IPTC keywords when available
+  caption: "caption_example", # String | The file's caption or description. Pulled from the IPTC description when available
+}
+
+begin
+  #Creates file
+  api_instance.create_file(opts)
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling FilesApi->create_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | **String**| The file's Base64 content | [optional] 
+ **active** | **Integer**| The file's status, default options are: 1 (active), 2 (inactive), 0 (deleted) | [optional] 
+ **name** | **String**| The name used in the filesystem, including the extension, eg: \"my-file.jpg\". This is generated by the system based on Global Settings | [optional] 
+ **title** | **String**| The file's title | [optional] 
+ **location** | **String**| Location of where the picture was taken, if any. Pulled from the IPTC location when available | [optional] 
+ **type** | **String**| The file's mime type | [optional] 
+ **tags** | **String**| A CSV of tags for this file. Pulled from the IPTC keywords when available | [optional] 
+ **caption** | **String**| The file's caption or description. Pulled from the IPTC description when available | [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_file**
+> GetFile get_file(file_id)
+
+Returns specific file by id
+
+### 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::FilesApi.new
+
+file_id = 56 # Integer | ID of file to get
+
+
+begin
+  #Returns specific file by id
+  result = api_instance.get_file(file_id)
+  p result
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling FilesApi->get_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_id** | **Integer**| ID of file to get | 
+
+### Return type
+
+[**GetFile**](GetFile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_files**
+> GetFiles get_files
+
+Returns files
+
+### 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::FilesApi.new
+
+begin
+  #Returns files
+  result = api_instance.get_files
+  p result
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling FilesApi->get_files: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetFiles**](GetFiles.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_file**
+> update_file(file_id, opts)
+
+Creates file
+
+### 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::FilesApi.new
+
+file_id = 56 # Integer | ID of file to get
+
+opts = { 
+  data: "data_example", # String | The file's Base64 content
+  active: 56, # Integer | The file's status, default options are: 1 (active), 2 (inactive), 0 (deleted)
+  name: "name_example", # String | The name used in the filesystem, including the extension, eg: \"my-file.jpg\". This is generated by the system based on Global Settings
+  title: "title_example", # String | The file's title
+  location: "location_example", # String | Location of where the picture was taken, if any. Pulled from the IPTC location when available
+  type: "type_example", # String | The file's mime type
+  tags: "tags_example", # String | A CSV of tags for this file. Pulled from the IPTC keywords when available
+  caption: "caption_example", # String | The file's caption or description. Pulled from the IPTC description when available
+  url: "url_example", # String | File url relativity to Directus base url
+  width: 56, # Integer | File width
+  height: 56, # Integer | File height
+  size: 56, # Integer | File size in bytes
+  embed_id: "embed_id_example", # String | ID of the embedded file. Ex Youtube ID
+  user: 56, # Integer | File owner (who uploaded the file)
+  date_uploaded: "date_uploaded_example", # String | File uploaded date. TODO It should be an DateTime object
+  storage_adapter: "storage_adapter_example" # String | Storage adapter used to upload the file
+}
+
+begin
+  #Creates file
+  api_instance.update_file(file_id, opts)
+rescue DirectusSDK::ApiError => e
+  puts "Exception when calling FilesApi->update_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_id** | **Integer**| ID of file to get | 
+ **data** | **String**| The file's Base64 content | [optional] 
+ **active** | **Integer**| The file's status, default options are: 1 (active), 2 (inactive), 0 (deleted) | [optional] 
+ **name** | **String**| The name used in the filesystem, including the extension, eg: \"my-file.jpg\". This is generated by the system based on Global Settings | [optional] 
+ **title** | **String**| The file's title | [optional] 
+ **location** | **String**| Location of where the picture was taken, if any. Pulled from the IPTC location when available | [optional] 
+ **type** | **String**| The file's mime type | [optional] 
+ **tags** | **String**| A CSV of tags for this file. Pulled from the IPTC keywords when available | [optional] 
+ **caption** | **String**| The file's caption or description. Pulled from the IPTC description when available | [optional] 
+ **url** | **String**| File url relativity to Directus base url | [optional] 
+ **width** | **Integer**| File width | [optional] 
+ **height** | **Integer**| File height | [optional] 
+ **size** | **Integer**| File size in bytes | [optional] 
+ **embed_id** | **String**| ID of the embedded file. Ex Youtube ID | [optional] 
+ **user** | **Integer**| File owner (who uploaded the file) | [optional] 
+ **date_uploaded** | **String**| File uploaded date. TODO It should be an DateTime object | [optional] 
+ **storage_adapter** | **String**| Storage adapter used to upload the file | [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/docs/GetActivity.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetActivityMeta**](GetActivityMeta.md) |  | [optional] 
+**data** | [**Array<GetActivityData>**](GetActivityData.md) |  | [optional] 
+
+

data/docs/GetActivityData.md

@@ -0,0 +1,16 @@
+# DirectusSDK::GetActivityData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**action** | **String** |  | [optional] 
+**table_name** | **String** |  | [optional] 
+**row_id** | **Integer** |  | [optional] 
+**user** | **String** |  | [optional] 
+**datetime** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**data** | **String** |  | [optional] 
+
+

data/docs/GetActivityMeta.md

@@ -0,0 +1,10 @@
+# DirectusSDK::GetActivityMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** |  | [optional] 
+**type** | **String** |  | [optional] 
+**table** | **String** |  | [optional] 
+
+

data/docs/GetBookmark.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetBookmark
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetTablesMeta**](GetTablesMeta.md) |  | [optional] 
+**data** | [**GetBookmarksData**](GetBookmarksData.md) |  | [optional] 
+
+

data/docs/GetBookmarks.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetBookmarks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetBookmarksMeta**](GetBookmarksMeta.md) |  | [optional] 
+**data** | [**Array<GetBookmarksData>**](GetBookmarksData.md) |  | [optional] 
+
+

data/docs/GetBookmarksData.md

@@ -0,0 +1,14 @@
+# DirectusSDK::GetBookmarksData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**user** | **Integer** |  | [optional] 
+**title** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**icon_class** | **String** |  | [optional] 
+**active** | **String** |  | [optional] 
+**section** | **String** |  | [optional] 
+
+

data/docs/GetBookmarksMeta.md

@@ -0,0 +1,14 @@
+# DirectusSDK::GetBookmarksMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**table** | **String** |  | 
+**total** | **Integer** |  | [optional] 
+**delete** | **Integer** |  | [optional] 
+**active** | **Integer** |  | [optional] 
+**draft** | **Integer** |  | [optional] 
+**total_entries** | **Integer** |  | [optional] 
+
+

data/docs/GetFile.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetTablesMeta**](GetTablesMeta.md) |  | [optional] 
+**data** | [**GetFilesData**](GetFilesData.md) |  | [optional] 
+
+

data/docs/GetFiles.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetFiles
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetTablesMeta**](GetTablesMeta.md) |  | [optional] 
+**data** | [**Array<GetFilesData>**](GetFilesData.md) |  | [optional] 
+
+

data/docs/GetFilesData.md

@@ -0,0 +1,24 @@
+# DirectusSDK::GetFilesData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**active** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**location** | **String** |  | [optional] 
+**caption** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**charset** | **String** |  | [optional] 
+**tags** | **String** |  | [optional] 
+**width** | **Integer** |  | [optional] 
+**height** | **Integer** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**embed_id** | **String** |  | [optional] 
+**user** | **Integer** |  | [optional] 
+**date_uploaded** | **String** |  | [optional] 
+**storage_adapter** | **String** |  | [optional] 
+
+

data/docs/GetGroup.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetTablesMeta**](GetTablesMeta.md) |  | [optional] 
+**data** | [**GetGroupsDataData**](GetGroupsDataData.md) |  | [optional] 
+
+

data/docs/GetGroups.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetGroups
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetTablesMeta**](GetTablesMeta.md) |  | [optional] 
+**data** | [**GetGroupsData**](GetGroupsData.md) |  | [optional] 
+
+

data/docs/GetGroupsData.md

@@ -0,0 +1,9 @@
+# DirectusSDK::GetGroupsData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetGroupsDataMeta**](GetGroupsDataMeta.md) |  | [optional] 
+**data** | [**Array<GetGroupsDataData>**](GetGroupsDataData.md) |  | [optional] 
+
+