directus_sdk 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +185 -0
  4. data/Rakefile +8 -0
  5. data/directus_sdk.gemspec +46 -0
  6. data/docs/ActivityApi.md +59 -0
  7. data/docs/BookmarksApi.md +290 -0
  8. data/docs/FilesApi.md +277 -0
  9. data/docs/GetActivity.md +9 -0
  10. data/docs/GetActivityData.md +16 -0
  11. data/docs/GetActivityMeta.md +10 -0
  12. data/docs/GetBookmark.md +9 -0
  13. data/docs/GetBookmarks.md +9 -0
  14. data/docs/GetBookmarksData.md +14 -0
  15. data/docs/GetBookmarksMeta.md +14 -0
  16. data/docs/GetFile.md +9 -0
  17. data/docs/GetFiles.md +9 -0
  18. data/docs/GetFilesData.md +24 -0
  19. data/docs/GetGroup.md +9 -0
  20. data/docs/GetGroups.md +9 -0
  21. data/docs/GetGroupsData.md +9 -0
  22. data/docs/GetGroupsDataData.md +16 -0
  23. data/docs/GetGroupsDataMeta.md +11 -0
  24. data/docs/GetMessage.md +9 -0
  25. data/docs/GetMessages.md +9 -0
  26. data/docs/GetMessagesData.md +18 -0
  27. data/docs/GetMessagesMeta.md +13 -0
  28. data/docs/GetMessagesResponses.md +8 -0
  29. data/docs/GetPreferences.md +9 -0
  30. data/docs/GetPreferencesData.md +16 -0
  31. data/docs/GetPrivileges.md +9 -0
  32. data/docs/GetPrivilegesData.md +19 -0
  33. data/docs/GetPrivilegesForTable.md +9 -0
  34. data/docs/GetSettings.md +9 -0
  35. data/docs/GetSettingsData.md +9 -0
  36. data/docs/GetSettingsDataFiles.md +13 -0
  37. data/docs/GetSettingsDataGlobal.md +13 -0
  38. data/docs/GetSettingsFor.md +9 -0
  39. data/docs/GetSettingsForMeta.md +10 -0
  40. data/docs/GetTable.md +9 -0
  41. data/docs/GetTableColumn.md +9 -0
  42. data/docs/GetTableColumnData.md +23 -0
  43. data/docs/GetTableColumns.md +9 -0
  44. data/docs/GetTableColumnsData.md +27 -0
  45. data/docs/GetTableData.md +29 -0
  46. data/docs/GetTableRow.md +9 -0
  47. data/docs/GetTableRows.md +9 -0
  48. data/docs/GetTableRowsData.md +9 -0
  49. data/docs/GetTableRowsMeta.md +14 -0
  50. data/docs/GetTables.md +9 -0
  51. data/docs/GetTablesData.md +8 -0
  52. data/docs/GetTablesMeta.md +9 -0
  53. data/docs/GroupsApi.md +455 -0
  54. data/docs/MessagesApi.md +116 -0
  55. data/docs/PreferencesApi.md +135 -0
  56. data/docs/SettingsApi.md +175 -0
  57. data/docs/TablesApi.md +873 -0
  58. data/docs/UtilsApi.md +126 -0
  59. data/git_push.sh +55 -0
  60. data/lib/directus_sdk.rb +92 -0
  61. data/lib/directus_sdk/api/activity_api.rb +70 -0
  62. data/lib/directus_sdk/api/bookmarks_api.rb +288 -0
  63. data/lib/directus_sdk/api/files_api.rb +297 -0
  64. data/lib/directus_sdk/api/groups_api.rb +469 -0
  65. data/lib/directus_sdk/api/messages_api.rb +123 -0
  66. data/lib/directus_sdk/api/preferences_api.rb +151 -0
  67. data/lib/directus_sdk/api/settings_api.rb +183 -0
  68. data/lib/directus_sdk/api/tables_api.rb +890 -0
  69. data/lib/directus_sdk/api/utils_api.rb +134 -0
  70. data/lib/directus_sdk/api_client.rb +389 -0
  71. data/lib/directus_sdk/api_error.rb +38 -0
  72. data/lib/directus_sdk/configuration.rb +209 -0
  73. data/lib/directus_sdk/models/get_activity.rb +199 -0
  74. data/lib/directus_sdk/models/get_activity_data.rb +260 -0
  75. data/lib/directus_sdk/models/get_activity_meta.rb +206 -0
  76. data/lib/directus_sdk/models/get_bookmark.rb +197 -0
  77. data/lib/directus_sdk/models/get_bookmarks.rb +199 -0
  78. data/lib/directus_sdk/models/get_bookmarks_data.rb +242 -0
  79. data/lib/directus_sdk/models/get_bookmarks_meta.rb +252 -0
  80. data/lib/directus_sdk/models/get_file.rb +197 -0
  81. data/lib/directus_sdk/models/get_files.rb +199 -0
  82. data/lib/directus_sdk/models/get_files_data.rb +332 -0
  83. data/lib/directus_sdk/models/get_group.rb +197 -0
  84. data/lib/directus_sdk/models/get_groups.rb +197 -0
  85. data/lib/directus_sdk/models/get_groups_data.rb +199 -0
  86. data/lib/directus_sdk/models/get_groups_data_data.rb +260 -0
  87. data/lib/directus_sdk/models/get_groups_data_meta.rb +215 -0
  88. data/lib/directus_sdk/models/get_message.rb +197 -0
  89. data/lib/directus_sdk/models/get_messages.rb +199 -0
  90. data/lib/directus_sdk/models/get_messages_data.rb +278 -0
  91. data/lib/directus_sdk/models/get_messages_meta.rb +233 -0
  92. data/lib/directus_sdk/models/get_messages_responses.rb +190 -0
  93. data/lib/directus_sdk/models/get_preferences.rb +197 -0
  94. data/lib/directus_sdk/models/get_preferences_data.rb +260 -0
  95. data/lib/directus_sdk/models/get_privileges.rb +199 -0
  96. data/lib/directus_sdk/models/get_privileges_data.rb +287 -0
  97. data/lib/directus_sdk/models/get_privileges_for_table.rb +197 -0
  98. data/lib/directus_sdk/models/get_settings.rb +197 -0
  99. data/lib/directus_sdk/models/get_settings_data.rb +197 -0
  100. data/lib/directus_sdk/models/get_settings_data_files.rb +233 -0
  101. data/lib/directus_sdk/models/get_settings_data_global.rb +233 -0
  102. data/lib/directus_sdk/models/get_settings_for.rb +197 -0
  103. data/lib/directus_sdk/models/get_settings_for_meta.rb +206 -0
  104. data/lib/directus_sdk/models/get_table.rb +197 -0
  105. data/lib/directus_sdk/models/get_table_column.rb +197 -0
  106. data/lib/directus_sdk/models/get_table_column_data.rb +325 -0
  107. data/lib/directus_sdk/models/get_table_columns.rb +199 -0
  108. data/lib/directus_sdk/models/get_table_columns_data.rb +363 -0
  109. data/lib/directus_sdk/models/get_table_data.rb +379 -0
  110. data/lib/directus_sdk/models/get_table_row.rb +197 -0
  111. data/lib/directus_sdk/models/get_table_rows.rb +199 -0
  112. data/lib/directus_sdk/models/get_table_rows_data.rb +197 -0
  113. data/lib/directus_sdk/models/get_table_rows_meta.rb +242 -0
  114. data/lib/directus_sdk/models/get_tables.rb +199 -0
  115. data/lib/directus_sdk/models/get_tables_data.rb +188 -0
  116. data/lib/directus_sdk/models/get_tables_meta.rb +197 -0
  117. data/lib/directus_sdk/version.rb +15 -0
  118. data/spec/api/activity_api_spec.rb +46 -0
  119. data/spec/api/bookmarks_api_spec.rb +98 -0
  120. data/spec/api/files_api_spec.rb +105 -0
  121. data/spec/api/groups_api_spec.rb +143 -0
  122. data/spec/api/messages_api_spec.rb +58 -0
  123. data/spec/api/preferences_api_spec.rb +65 -0
  124. data/spec/api/settings_api_spec.rb +71 -0
  125. data/spec/api/tables_api_spec.rb +236 -0
  126. data/spec/api/utils_api_spec.rb +61 -0
  127. data/spec/api_client_spec.rb +226 -0
  128. data/spec/configuration_spec.rb +42 -0
  129. data/spec/models/get_activity_data_spec.rb +90 -0
  130. data/spec/models/get_activity_meta_spec.rb +54 -0
  131. data/spec/models/get_activity_spec.rb +48 -0
  132. data/spec/models/get_bookmark_spec.rb +48 -0
  133. data/spec/models/get_bookmarks_data_spec.rb +78 -0
  134. data/spec/models/get_bookmarks_meta_spec.rb +78 -0
  135. data/spec/models/get_bookmarks_spec.rb +48 -0
  136. data/spec/models/get_file_spec.rb +48 -0
  137. data/spec/models/get_files_data_spec.rb +138 -0
  138. data/spec/models/get_files_spec.rb +48 -0
  139. data/spec/models/get_group_spec.rb +48 -0
  140. data/spec/models/get_groups_data_data_spec.rb +90 -0
  141. data/spec/models/get_groups_data_meta_spec.rb +60 -0
  142. data/spec/models/get_groups_data_spec.rb +48 -0
  143. data/spec/models/get_groups_spec.rb +48 -0
  144. data/spec/models/get_message_spec.rb +48 -0
  145. data/spec/models/get_messages_data_spec.rb +102 -0
  146. data/spec/models/get_messages_meta_spec.rb +72 -0
  147. data/spec/models/get_messages_responses_spec.rb +42 -0
  148. data/spec/models/get_messages_spec.rb +48 -0
  149. data/spec/models/get_preferences_data_spec.rb +90 -0
  150. data/spec/models/get_preferences_spec.rb +48 -0
  151. data/spec/models/get_privileges_data_spec.rb +108 -0
  152. data/spec/models/get_privileges_for_table_spec.rb +48 -0
  153. data/spec/models/get_privileges_spec.rb +48 -0
  154. data/spec/models/get_settings_data_files_spec.rb +72 -0
  155. data/spec/models/get_settings_data_global_spec.rb +72 -0
  156. data/spec/models/get_settings_data_spec.rb +48 -0
  157. data/spec/models/get_settings_for_meta_spec.rb +54 -0
  158. data/spec/models/get_settings_for_spec.rb +48 -0
  159. data/spec/models/get_settings_spec.rb +48 -0
  160. data/spec/models/get_table_column_data_spec.rb +132 -0
  161. data/spec/models/get_table_column_spec.rb +48 -0
  162. data/spec/models/get_table_columns_data_spec.rb +156 -0
  163. data/spec/models/get_table_columns_spec.rb +48 -0
  164. data/spec/models/get_table_data_spec.rb +168 -0
  165. data/spec/models/get_table_row_spec.rb +48 -0
  166. data/spec/models/get_table_rows_data_spec.rb +48 -0
  167. data/spec/models/get_table_rows_meta_spec.rb +78 -0
  168. data/spec/models/get_table_rows_spec.rb +48 -0
  169. data/spec/models/get_table_spec.rb +48 -0
  170. data/spec/models/get_tables_data_spec.rb +42 -0
  171. data/spec/models/get_tables_meta_spec.rb +48 -0
  172. data/spec/models/get_tables_spec.rb +48 -0
  173. data/spec/spec_helper.rb +111 -0
  174. metadata +451 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d1e268aeed3ebe49c743f2c30c9d9de59a7f4661
4
+ data.tar.gz: fb8b8b4edbc200516ed444a72bde2be16ba14897
5
+ SHA512:
6
+ metadata.gz: e76bcbe76e8ff14cd270d0ebba0cf18518eb923355374e8f34a6b8a61075f83997fa53c2c7015690ca3cfdaf62ca2d9d21a525e1275805b15d3f3856985dbd09
7
+ data.tar.gz: d7882f49e67d8a8646796bd9566b3490a0b98d433fff7224bfec2a6d6aa580a659bd43f951ded0b8a3ee9d57f3c38f7211b503952b45f216f65a01a3fcc4cde3
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
data/README.md ADDED
@@ -0,0 +1,185 @@
1
+ # directus_sdk
2
+
3
+ DirectusSDK - the Ruby gem for the directus.io
4
+
5
+ API for directus.io
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 1.1
10
+ - Package version: 1.1.1
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build directus_sdk.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./directus_sdk-1.1.1.gem
27
+ ```
28
+ (for development, run `gem install --dev ./directus_sdk-1.1.1.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'directus_sdk', '~> 1.1.1'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'directus_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'directus_sdk'
56
+
57
+ # Setup authorization
58
+ DirectusSDK.configure do |config|
59
+ # Configure API key authorization: api_key
60
+ config.api_key['access_token'] = 'YOUR API KEY'
61
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
62
+ #config.api_key_prefix['access_token'] = 'Bearer'
63
+ # Configure your host
64
+ config.host = "myinstance.directus.io"
65
+ # Enable or disable debugging output
66
+ config.debugging = false
67
+ end
68
+
69
+ api_instance = DirectusSDK::ActivityApi.new
70
+
71
+ begin
72
+ #Returns activity
73
+ result = api_instance.get_activity
74
+ p result
75
+ rescue DirectusSDK::ApiError => e
76
+ puts "Exception when calling ActivityApi->get_activity: #{e}"
77
+ end
78
+
79
+ ```
80
+
81
+ ## Documentation for API Endpoints
82
+
83
+ All URIs are relative to *https://myinstance.directus.io/api/1.1*
84
+
85
+ Class | Method | HTTP request | Description
86
+ ------------ | ------------- | ------------- | -------------
87
+ *DirectusSDK::ActivityApi* | [**get_activity**](docs/ActivityApi.md#get_activity) | **GET** /activity | Returns activity
88
+ *DirectusSDK::BookmarksApi* | [**add_bookmark**](docs/BookmarksApi.md#add_bookmark) | **POST** /bookmarks | Create a column in a given table
89
+ *DirectusSDK::BookmarksApi* | [**delete_bookmark**](docs/BookmarksApi.md#delete_bookmark) | **DELETE** /bookmarks/{bookmarkId} | Deletes specific bookmark
90
+ *DirectusSDK::BookmarksApi* | [**get_bookmark**](docs/BookmarksApi.md#get_bookmark) | **GET** /bookmarks/{bookmarkId} | Returns specific bookmark
91
+ *DirectusSDK::BookmarksApi* | [**get_bookmarks**](docs/BookmarksApi.md#get_bookmarks) | **GET** /bookmarks | Returns bookmarks
92
+ *DirectusSDK::BookmarksApi* | [**get_bookmarks_self**](docs/BookmarksApi.md#get_bookmarks_self) | **GET** /bookmarks/self | Returns bookmarks of current user
93
+ *DirectusSDK::FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /files | Creates file
94
+ *DirectusSDK::FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /files/{fileId} | Returns specific file by id
95
+ *DirectusSDK::FilesApi* | [**get_files**](docs/FilesApi.md#get_files) | **GET** /files | Returns files
96
+ *DirectusSDK::FilesApi* | [**update_file**](docs/FilesApi.md#update_file) | **PUT** /files/{fileId} | Creates file
97
+ *DirectusSDK::GroupsApi* | [**add_group**](docs/GroupsApi.md#add_group) | **POST** /groups | Add a new group
98
+ *DirectusSDK::GroupsApi* | [**add_privilege**](docs/GroupsApi.md#add_privilege) | **POST** /privileges/{groupId} | Create new table privileges for the specified user group
99
+ *DirectusSDK::GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /groups/{groupId} | Returns specific group
100
+ *DirectusSDK::GroupsApi* | [**get_groups**](docs/GroupsApi.md#get_groups) | **GET** /groups | Returns groups
101
+ *DirectusSDK::GroupsApi* | [**get_privileges**](docs/GroupsApi.md#get_privileges) | **GET** /privileges/{groupId} | Returns group privileges
102
+ *DirectusSDK::GroupsApi* | [**get_privileges_for_table**](docs/GroupsApi.md#get_privileges_for_table) | **GET** /privileges/{groupId}/{tableNameOrPrivilegeId} | Returns group privileges by tableName
103
+ *DirectusSDK::GroupsApi* | [**update_privileges**](docs/GroupsApi.md#update_privileges) | **PUT** /privileges/{groupId}/{tableNameOrPrivilegeId} | Update privileges by privilegeId
104
+ *DirectusSDK::MessagesApi* | [**get_message**](docs/MessagesApi.md#get_message) | **GET** /messages/{messageId} | Returns specific message
105
+ *DirectusSDK::MessagesApi* | [**get_messages**](docs/MessagesApi.md#get_messages) | **GET** /messages/self | Returns messages
106
+ *DirectusSDK::PreferencesApi* | [**get_preferences**](docs/PreferencesApi.md#get_preferences) | **GET** /tables/{tableId}/preferences | Returns table preferences
107
+ *DirectusSDK::PreferencesApi* | [**update_preferences**](docs/PreferencesApi.md#update_preferences) | **PUT** /tables/{tableId}/preferences | Update table preferences
108
+ *DirectusSDK::SettingsApi* | [**get_settings**](docs/SettingsApi.md#get_settings) | **GET** /settings | Returns settings
109
+ *DirectusSDK::SettingsApi* | [**get_settings_for**](docs/SettingsApi.md#get_settings_for) | **GET** /settings/{collectionName} | Returns settings for collection
110
+ *DirectusSDK::SettingsApi* | [**update_settings**](docs/SettingsApi.md#update_settings) | **PUT** /settings/{collectionName} | Update settings
111
+ *DirectusSDK::TablesApi* | [**add_column**](docs/TablesApi.md#add_column) | **POST** /tables/{tableId}/columns | Create a column in a given table
112
+ *DirectusSDK::TablesApi* | [**add_row**](docs/TablesApi.md#add_row) | **POST** /tables/{tableId}/rows | Add a new row
113
+ *DirectusSDK::TablesApi* | [**add_table**](docs/TablesApi.md#add_table) | **POST** /tables | Add a new table
114
+ *DirectusSDK::TablesApi* | [**delete_column**](docs/TablesApi.md#delete_column) | **DELETE** /tables/{tableId}/columns/{columnName} | Delete row
115
+ *DirectusSDK::TablesApi* | [**delete_row**](docs/TablesApi.md#delete_row) | **DELETE** /tables/{tableId}/rows/{rowId} | Delete row
116
+ *DirectusSDK::TablesApi* | [**delete_table**](docs/TablesApi.md#delete_table) | **DELETE** /tables/{tableId} | Delete Table
117
+ *DirectusSDK::TablesApi* | [**get_table**](docs/TablesApi.md#get_table) | **GET** /tables/{tableId} | Returns specific table
118
+ *DirectusSDK::TablesApi* | [**get_table_column**](docs/TablesApi.md#get_table_column) | **GET** /tables/{tableId}/columns/{columnName} | Returns specific table column
119
+ *DirectusSDK::TablesApi* | [**get_table_columns**](docs/TablesApi.md#get_table_columns) | **GET** /tables/{tableId}/columns | Returns table columns
120
+ *DirectusSDK::TablesApi* | [**get_table_row**](docs/TablesApi.md#get_table_row) | **GET** /tables/{tableId}/rows/{rowId} | Returns specific table row
121
+ *DirectusSDK::TablesApi* | [**get_table_rows**](docs/TablesApi.md#get_table_rows) | **GET** /tables/{tableId}/rows | Returns table rows
122
+ *DirectusSDK::TablesApi* | [**get_tables**](docs/TablesApi.md#get_tables) | **GET** /tables | Returns tables
123
+ *DirectusSDK::TablesApi* | [**update_column**](docs/TablesApi.md#update_column) | **PUT** /tables/{tableId}/columns/{columnName} | Update column
124
+ *DirectusSDK::TablesApi* | [**update_row**](docs/TablesApi.md#update_row) | **PUT** /tables/{tableId}/rows/{rowId} | Update row
125
+ *DirectusSDK::UtilsApi* | [**get_hash**](docs/UtilsApi.md#get_hash) | **POST** /hash | Get a hashed value
126
+ *DirectusSDK::UtilsApi* | [**get_random**](docs/UtilsApi.md#get_random) | **POST** /random | Returns random alphanumeric string
127
+
128
+
129
+ ## Documentation for Models
130
+
131
+ - [DirectusSDK::GetActivity](docs/GetActivity.md)
132
+ - [DirectusSDK::GetActivityData](docs/GetActivityData.md)
133
+ - [DirectusSDK::GetActivityMeta](docs/GetActivityMeta.md)
134
+ - [DirectusSDK::GetBookmark](docs/GetBookmark.md)
135
+ - [DirectusSDK::GetBookmarks](docs/GetBookmarks.md)
136
+ - [DirectusSDK::GetBookmarksData](docs/GetBookmarksData.md)
137
+ - [DirectusSDK::GetBookmarksMeta](docs/GetBookmarksMeta.md)
138
+ - [DirectusSDK::GetFile](docs/GetFile.md)
139
+ - [DirectusSDK::GetFiles](docs/GetFiles.md)
140
+ - [DirectusSDK::GetFilesData](docs/GetFilesData.md)
141
+ - [DirectusSDK::GetGroup](docs/GetGroup.md)
142
+ - [DirectusSDK::GetGroups](docs/GetGroups.md)
143
+ - [DirectusSDK::GetGroupsData](docs/GetGroupsData.md)
144
+ - [DirectusSDK::GetGroupsDataData](docs/GetGroupsDataData.md)
145
+ - [DirectusSDK::GetGroupsDataMeta](docs/GetGroupsDataMeta.md)
146
+ - [DirectusSDK::GetMessage](docs/GetMessage.md)
147
+ - [DirectusSDK::GetMessages](docs/GetMessages.md)
148
+ - [DirectusSDK::GetMessagesData](docs/GetMessagesData.md)
149
+ - [DirectusSDK::GetMessagesMeta](docs/GetMessagesMeta.md)
150
+ - [DirectusSDK::GetMessagesResponses](docs/GetMessagesResponses.md)
151
+ - [DirectusSDK::GetPreferences](docs/GetPreferences.md)
152
+ - [DirectusSDK::GetPreferencesData](docs/GetPreferencesData.md)
153
+ - [DirectusSDK::GetPrivileges](docs/GetPrivileges.md)
154
+ - [DirectusSDK::GetPrivilegesData](docs/GetPrivilegesData.md)
155
+ - [DirectusSDK::GetPrivilegesForTable](docs/GetPrivilegesForTable.md)
156
+ - [DirectusSDK::GetSettings](docs/GetSettings.md)
157
+ - [DirectusSDK::GetSettingsData](docs/GetSettingsData.md)
158
+ - [DirectusSDK::GetSettingsDataFiles](docs/GetSettingsDataFiles.md)
159
+ - [DirectusSDK::GetSettingsDataGlobal](docs/GetSettingsDataGlobal.md)
160
+ - [DirectusSDK::GetSettingsFor](docs/GetSettingsFor.md)
161
+ - [DirectusSDK::GetSettingsForMeta](docs/GetSettingsForMeta.md)
162
+ - [DirectusSDK::GetTable](docs/GetTable.md)
163
+ - [DirectusSDK::GetTableColumn](docs/GetTableColumn.md)
164
+ - [DirectusSDK::GetTableColumnData](docs/GetTableColumnData.md)
165
+ - [DirectusSDK::GetTableColumns](docs/GetTableColumns.md)
166
+ - [DirectusSDK::GetTableColumnsData](docs/GetTableColumnsData.md)
167
+ - [DirectusSDK::GetTableData](docs/GetTableData.md)
168
+ - [DirectusSDK::GetTableRow](docs/GetTableRow.md)
169
+ - [DirectusSDK::GetTableRows](docs/GetTableRows.md)
170
+ - [DirectusSDK::GetTableRowsData](docs/GetTableRowsData.md)
171
+ - [DirectusSDK::GetTableRowsMeta](docs/GetTableRowsMeta.md)
172
+ - [DirectusSDK::GetTables](docs/GetTables.md)
173
+ - [DirectusSDK::GetTablesData](docs/GetTablesData.md)
174
+ - [DirectusSDK::GetTablesMeta](docs/GetTablesMeta.md)
175
+
176
+
177
+ ## Documentation for Authorization
178
+
179
+
180
+ ### api_key
181
+
182
+ - **Type**: API key
183
+ - **API key parameter name**: access_token
184
+ - **Location**: URL query string
185
+
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,46 @@
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ =begin
4
+ #directus.io
5
+
6
+ #API for directus.io
7
+
8
+ OpenAPI spec version: 1.1
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 3.0.0-SNAPSHOT
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "directus_sdk/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "directus_sdk"
20
+ s.version = DirectusSDK::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Swagger-Codegen"]
23
+ s.email = [""]
24
+ s.homepage = "https://directus.io"
25
+ s.summary = "Ruby gem to work with directus API. generated by swagger"
26
+ s.description = "API for directus.io"
27
+ # TODO uncommnet and update below with a proper license
28
+ #s.license = "Apache 2.0"
29
+ s.required_ruby_version = ">= 1.9"
30
+
31
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
32
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
33
+
34
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
35
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
37
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
40
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
41
+
42
+ s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
43
+ s.test_files = `find spec/*`.split("\n")
44
+ s.executables = []
45
+ s.require_paths = ["lib"]
46
+ end
@@ -0,0 +1,59 @@
1
+ # DirectusSDK::ActivityApi
2
+
3
+ All URIs are relative to *https://myinstance.directus.io/api/1.1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_activity**](ActivityApi.md#get_activity) | **GET** /activity | Returns activity
8
+
9
+
10
+ # **get_activity**
11
+ > GetActivity get_activity
12
+
13
+ Returns activity
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'directus_sdk'
19
+ # setup authorization
20
+ DirectusSDK.configure do |config|
21
+ # Configure API key authorization: api_key
22
+ config.api_key['access_token'] = 'YOUR API KEY'
23
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24
+ #config.api_key_prefix['access_token'] = 'Bearer'
25
+ # Configure your host
26
+ config.host = "myinstance.directus.io"
27
+ # Enable or disable debugging output
28
+ config.debugging = false
29
+ end
30
+
31
+ api_instance = DirectusSDK::ActivityApi.new
32
+
33
+ begin
34
+ #Returns activity
35
+ result = api_instance.get_activity
36
+ p result
37
+ rescue DirectusSDK::ApiError => e
38
+ puts "Exception when calling ActivityApi->get_activity: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+ This endpoint does not need any parameter.
44
+
45
+ ### Return type
46
+
47
+ [**GetActivity**](GetActivity.md)
48
+
49
+ ### Authorization
50
+
51
+ [api_key](../README.md#api_key)
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: application/json
57
+
58
+
59
+
@@ -0,0 +1,290 @@
1
+ # DirectusSDK::BookmarksApi
2
+
3
+ All URIs are relative to *https://myinstance.directus.io/api/1.1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**add_bookmark**](BookmarksApi.md#add_bookmark) | **POST** /bookmarks | Create a column in a given table
8
+ [**delete_bookmark**](BookmarksApi.md#delete_bookmark) | **DELETE** /bookmarks/{bookmarkId} | Deletes specific bookmark
9
+ [**get_bookmark**](BookmarksApi.md#get_bookmark) | **GET** /bookmarks/{bookmarkId} | Returns specific bookmark
10
+ [**get_bookmarks**](BookmarksApi.md#get_bookmarks) | **GET** /bookmarks | Returns bookmarks
11
+ [**get_bookmarks_self**](BookmarksApi.md#get_bookmarks_self) | **GET** /bookmarks/self | Returns bookmarks of current user
12
+
13
+
14
+ # **add_bookmark**
15
+ > add_bookmark(opts)
16
+
17
+ Create a column in a given table
18
+
19
+ ### Example
20
+ ```ruby
21
+ # load the gem
22
+ require 'directus_sdk'
23
+ # setup authorization
24
+ DirectusSDK.configure do |config|
25
+ # Configure API key authorization: api_key
26
+ config.api_key['access_token'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ #config.api_key_prefix['access_token'] = 'Bearer'
29
+ # Configure your host
30
+ config.host = "myinstance.directus.io"
31
+ # Enable or disable debugging output
32
+ config.debugging = false
33
+ end
34
+
35
+ api_instance = DirectusSDK::BookmarksApi.new
36
+
37
+ opts = {
38
+ user: "user_example", # String | [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)
39
+ title: "title_example", # String | The text to display in the navigation menu
40
+ url: "url_example", # String | The path to navigate to when clicked, relative to the Directus root
41
+ icon_class: "icon_class_example", # String | Deprecated
42
+ active: "active_example", # String | Deprecated
43
+ section: "section_example" # String | [\"search\" or \"other\"] Which nav section to show the link within. User generated bookmarks use \"search\", while all system links go within \"other\"
44
+ }
45
+
46
+ begin
47
+ #Create a column in a given table
48
+ api_instance.add_bookmark(opts)
49
+ rescue DirectusSDK::ApiError => e
50
+ puts "Exception when calling BookmarksApi->add_bookmark: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **user** | **String**| [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) | [optional]
59
+ **title** | **String**| The text to display in the navigation menu | [optional]
60
+ **url** | **String**| The path to navigate to when clicked, relative to the Directus root | [optional]
61
+ **icon_class** | **String**| Deprecated | [optional]
62
+ **active** | **String**| Deprecated | [optional]
63
+ **section** | **String**| [\"search\" or \"other\"] Which nav section to show the link within. User generated bookmarks use \"search\", while all system links go within \"other\" | [optional]
64
+
65
+ ### Return type
66
+
67
+ nil (empty response body)
68
+
69
+ ### Authorization
70
+
71
+ [api_key](../README.md#api_key)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/x-www-form-urlencoded
76
+ - **Accept**: application/json
77
+
78
+
79
+
80
+ # **delete_bookmark**
81
+ > delete_bookmark(bookmark_id)
82
+
83
+ Deletes specific bookmark
84
+
85
+ ### Example
86
+ ```ruby
87
+ # load the gem
88
+ require 'directus_sdk'
89
+ # setup authorization
90
+ DirectusSDK.configure do |config|
91
+ # Configure API key authorization: api_key
92
+ config.api_key['access_token'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
94
+ #config.api_key_prefix['access_token'] = 'Bearer'
95
+ # Configure your host
96
+ config.host = "myinstance.directus.io"
97
+ # Enable or disable debugging output
98
+ config.debugging = false
99
+ end
100
+
101
+ api_instance = DirectusSDK::BookmarksApi.new
102
+
103
+ bookmark_id = 56 # Integer | ID of table to return rows from
104
+
105
+
106
+ begin
107
+ #Deletes specific bookmark
108
+ api_instance.delete_bookmark(bookmark_id)
109
+ rescue DirectusSDK::ApiError => e
110
+ puts "Exception when calling BookmarksApi->delete_bookmark: #{e}"
111
+ end
112
+ ```
113
+
114
+ ### Parameters
115
+
116
+ Name | Type | Description | Notes
117
+ ------------- | ------------- | ------------- | -------------
118
+ **bookmark_id** | **Integer**| ID of table to return rows from |
119
+
120
+ ### Return type
121
+
122
+ nil (empty response body)
123
+
124
+ ### Authorization
125
+
126
+ [api_key](../README.md#api_key)
127
+
128
+ ### HTTP request headers
129
+
130
+ - **Content-Type**: Not defined
131
+ - **Accept**: application/json
132
+
133
+
134
+
135
+ # **get_bookmark**
136
+ > GetBookmark get_bookmark(bookmark_id)
137
+
138
+ Returns specific bookmark
139
+
140
+ ### Example
141
+ ```ruby
142
+ # load the gem
143
+ require 'directus_sdk'
144
+ # setup authorization
145
+ DirectusSDK.configure do |config|
146
+ # Configure API key authorization: api_key
147
+ config.api_key['access_token'] = 'YOUR API KEY'
148
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
149
+ #config.api_key_prefix['access_token'] = 'Bearer'
150
+ # Configure your host
151
+ config.host = "myinstance.directus.io"
152
+ # Enable or disable debugging output
153
+ config.debugging = false
154
+ end
155
+
156
+ api_instance = DirectusSDK::BookmarksApi.new
157
+
158
+ bookmark_id = 56 # Integer | ID of table to return rows from
159
+
160
+
161
+ begin
162
+ #Returns specific bookmark
163
+ result = api_instance.get_bookmark(bookmark_id)
164
+ p result
165
+ rescue DirectusSDK::ApiError => e
166
+ puts "Exception when calling BookmarksApi->get_bookmark: #{e}"
167
+ end
168
+ ```
169
+
170
+ ### Parameters
171
+
172
+ Name | Type | Description | Notes
173
+ ------------- | ------------- | ------------- | -------------
174
+ **bookmark_id** | **Integer**| ID of table to return rows from |
175
+
176
+ ### Return type
177
+
178
+ [**GetBookmark**](GetBookmark.md)
179
+
180
+ ### Authorization
181
+
182
+ [api_key](../README.md#api_key)
183
+
184
+ ### HTTP request headers
185
+
186
+ - **Content-Type**: Not defined
187
+ - **Accept**: application/json
188
+
189
+
190
+
191
+ # **get_bookmarks**
192
+ > GetBookmarks get_bookmarks
193
+
194
+ Returns bookmarks
195
+
196
+ ### Example
197
+ ```ruby
198
+ # load the gem
199
+ require 'directus_sdk'
200
+ # setup authorization
201
+ DirectusSDK.configure do |config|
202
+ # Configure API key authorization: api_key
203
+ config.api_key['access_token'] = 'YOUR API KEY'
204
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
205
+ #config.api_key_prefix['access_token'] = 'Bearer'
206
+ # Configure your host
207
+ config.host = "myinstance.directus.io"
208
+ # Enable or disable debugging output
209
+ config.debugging = false
210
+ end
211
+
212
+ api_instance = DirectusSDK::BookmarksApi.new
213
+
214
+ begin
215
+ #Returns bookmarks
216
+ result = api_instance.get_bookmarks
217
+ p result
218
+ rescue DirectusSDK::ApiError => e
219
+ puts "Exception when calling BookmarksApi->get_bookmarks: #{e}"
220
+ end
221
+ ```
222
+
223
+ ### Parameters
224
+ This endpoint does not need any parameter.
225
+
226
+ ### Return type
227
+
228
+ [**GetBookmarks**](GetBookmarks.md)
229
+
230
+ ### Authorization
231
+
232
+ [api_key](../README.md#api_key)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: Not defined
237
+ - **Accept**: application/json
238
+
239
+
240
+
241
+ # **get_bookmarks_self**
242
+ > GetBookmarks get_bookmarks_self
243
+
244
+ Returns bookmarks of current user
245
+
246
+ ### Example
247
+ ```ruby
248
+ # load the gem
249
+ require 'directus_sdk'
250
+ # setup authorization
251
+ DirectusSDK.configure do |config|
252
+ # Configure API key authorization: api_key
253
+ config.api_key['access_token'] = 'YOUR API KEY'
254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
255
+ #config.api_key_prefix['access_token'] = 'Bearer'
256
+ # Configure your host
257
+ config.host = "myinstance.directus.io"
258
+ # Enable or disable debugging output
259
+ config.debugging = false
260
+ end
261
+
262
+ api_instance = DirectusSDK::BookmarksApi.new
263
+
264
+ begin
265
+ #Returns bookmarks of current user
266
+ result = api_instance.get_bookmarks_self
267
+ p result
268
+ rescue DirectusSDK::ApiError => e
269
+ puts "Exception when calling BookmarksApi->get_bookmarks_self: #{e}"
270
+ end
271
+ ```
272
+
273
+ ### Parameters
274
+ This endpoint does not need any parameter.
275
+
276
+ ### Return type
277
+
278
+ [**GetBookmarks**](GetBookmarks.md)
279
+
280
+ ### Authorization
281
+
282
+ [api_key](../README.md#api_key)
283
+
284
+ ### HTTP request headers
285
+
286
+ - **Content-Type**: Not defined
287
+ - **Accept**: application/json
288
+
289
+
290
+