appwrite 2.4.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/lib/appwrite/client.rb +197 -56
  3. data/lib/appwrite/exception.rb +7 -7
  4. data/lib/appwrite/file.rb +9 -15
  5. data/lib/appwrite/models/attribute_boolean.rb +52 -0
  6. data/lib/appwrite/models/attribute_email.rb +57 -0
  7. data/lib/appwrite/models/attribute_enum.rb +62 -0
  8. data/lib/appwrite/models/attribute_float.rb +62 -0
  9. data/lib/appwrite/models/attribute_integer.rb +62 -0
  10. data/lib/appwrite/models/attribute_ip.rb +57 -0
  11. data/lib/appwrite/models/attribute_list.rb +32 -0
  12. data/lib/appwrite/models/attribute_string.rb +57 -0
  13. data/lib/appwrite/models/attribute_url.rb +57 -0
  14. data/lib/appwrite/models/bucket.rb +82 -0
  15. data/lib/appwrite/models/bucket_list.rb +32 -0
  16. data/lib/appwrite/models/collection.rb +62 -0
  17. data/lib/appwrite/models/collection_list.rb +32 -0
  18. data/lib/appwrite/models/continent.rb +32 -0
  19. data/lib/appwrite/models/continent_list.rb +32 -0
  20. data/lib/appwrite/models/country.rb +32 -0
  21. data/lib/appwrite/models/country_list.rb +32 -0
  22. data/lib/appwrite/models/currency.rb +57 -0
  23. data/lib/appwrite/models/currency_list.rb +32 -0
  24. data/lib/appwrite/models/deployment.rb +77 -0
  25. data/lib/appwrite/models/deployment_list.rb +32 -0
  26. data/lib/appwrite/models/document.rb +50 -0
  27. data/lib/appwrite/models/document_list.rb +36 -0
  28. data/lib/appwrite/models/execution.rb +72 -0
  29. data/lib/appwrite/models/execution_list.rb +32 -0
  30. data/lib/appwrite/models/file.rb +77 -0
  31. data/lib/appwrite/models/file_list.rb +32 -0
  32. data/lib/appwrite/models/function.rb +92 -0
  33. data/lib/appwrite/models/function_list.rb +32 -0
  34. data/lib/appwrite/models/health_antivirus.rb +32 -0
  35. data/lib/appwrite/models/health_queue.rb +27 -0
  36. data/lib/appwrite/models/health_status.rb +32 -0
  37. data/lib/appwrite/models/health_time.rb +37 -0
  38. data/lib/appwrite/models/index.rb +47 -0
  39. data/lib/appwrite/models/index_list.rb +32 -0
  40. data/lib/appwrite/models/language.rb +37 -0
  41. data/lib/appwrite/models/language_list.rb +32 -0
  42. data/lib/appwrite/models/locale.rb +57 -0
  43. data/lib/appwrite/models/log.rb +127 -0
  44. data/lib/appwrite/models/log_list.rb +32 -0
  45. data/lib/appwrite/models/membership.rb +67 -0
  46. data/lib/appwrite/models/membership_list.rb +32 -0
  47. data/lib/appwrite/models/phone.rb +37 -0
  48. data/lib/appwrite/models/phone_list.rb +32 -0
  49. data/lib/appwrite/models/preferences.rb +30 -0
  50. data/lib/appwrite/models/runtime.rb +57 -0
  51. data/lib/appwrite/models/runtime_list.rb +32 -0
  52. data/lib/appwrite/models/session.rb +142 -0
  53. data/lib/appwrite/models/session_list.rb +32 -0
  54. data/lib/appwrite/models/team.rb +42 -0
  55. data/lib/appwrite/models/team_list.rb +32 -0
  56. data/lib/appwrite/models/token.rb +42 -0
  57. data/lib/appwrite/models/user.rb +62 -0
  58. data/lib/appwrite/models/user_list.rb +32 -0
  59. data/lib/appwrite/query.rb +42 -0
  60. data/lib/appwrite/service.rb +0 -5
  61. data/lib/appwrite/services/account.rb +400 -138
  62. data/lib/appwrite/services/avatars.rb +188 -125
  63. data/lib/appwrite/services/database.rb +875 -130
  64. data/lib/appwrite/services/functions.rb +439 -207
  65. data/lib/appwrite/services/health.rb +201 -58
  66. data/lib/appwrite/services/locale.rb +133 -32
  67. data/lib/appwrite/services/storage.rb +469 -118
  68. data/lib/appwrite/services/teams.rb +302 -118
  69. data/lib/appwrite/services/users.rb +322 -127
  70. data/lib/appwrite.rb +57 -0
  71. metadata +74 -108
  72. data/.travis.yml +0 -16
  73. data/CHANGELOG.md +0 -1
  74. data/Gemfile +0 -4
  75. data/LICENSE +0 -12
  76. data/README.md +0 -96
  77. data/appwrite.gemspec +0 -11
  78. data/docs/examples/account/create-recovery.md +0 -15
  79. data/docs/examples/account/create-verification.md +0 -15
  80. data/docs/examples/account/delete-session.md +0 -15
  81. data/docs/examples/account/delete-sessions.md +0 -15
  82. data/docs/examples/account/delete.md +0 -15
  83. data/docs/examples/account/get-logs.md +0 -15
  84. data/docs/examples/account/get-prefs.md +0 -15
  85. data/docs/examples/account/get-session.md +0 -15
  86. data/docs/examples/account/get-sessions.md +0 -15
  87. data/docs/examples/account/get.md +0 -15
  88. data/docs/examples/account/update-email.md +0 -15
  89. data/docs/examples/account/update-name.md +0 -15
  90. data/docs/examples/account/update-password.md +0 -15
  91. data/docs/examples/account/update-prefs.md +0 -15
  92. data/docs/examples/account/update-recovery.md +0 -15
  93. data/docs/examples/account/update-verification.md +0 -15
  94. data/docs/examples/avatars/get-browser.md +0 -15
  95. data/docs/examples/avatars/get-credit-card.md +0 -15
  96. data/docs/examples/avatars/get-favicon.md +0 -15
  97. data/docs/examples/avatars/get-flag.md +0 -15
  98. data/docs/examples/avatars/get-image.md +0 -15
  99. data/docs/examples/avatars/get-initials.md +0 -15
  100. data/docs/examples/avatars/get-q-r.md +0 -15
  101. data/docs/examples/database/create-collection.md +0 -15
  102. data/docs/examples/database/create-document.md +0 -15
  103. data/docs/examples/database/delete-collection.md +0 -15
  104. data/docs/examples/database/delete-document.md +0 -15
  105. data/docs/examples/database/get-collection.md +0 -15
  106. data/docs/examples/database/get-document.md +0 -15
  107. data/docs/examples/database/list-collections.md +0 -15
  108. data/docs/examples/database/list-documents.md +0 -15
  109. data/docs/examples/database/update-collection.md +0 -15
  110. data/docs/examples/database/update-document.md +0 -15
  111. data/docs/examples/functions/create-execution.md +0 -15
  112. data/docs/examples/functions/create-tag.md +0 -15
  113. data/docs/examples/functions/create.md +0 -15
  114. data/docs/examples/functions/delete-tag.md +0 -15
  115. data/docs/examples/functions/delete.md +0 -15
  116. data/docs/examples/functions/get-execution.md +0 -15
  117. data/docs/examples/functions/get-tag.md +0 -15
  118. data/docs/examples/functions/get.md +0 -15
  119. data/docs/examples/functions/list-executions.md +0 -15
  120. data/docs/examples/functions/list-tags.md +0 -15
  121. data/docs/examples/functions/list.md +0 -15
  122. data/docs/examples/functions/update-tag.md +0 -15
  123. data/docs/examples/functions/update.md +0 -15
  124. data/docs/examples/health/get-anti-virus.md +0 -15
  125. data/docs/examples/health/get-cache.md +0 -15
  126. data/docs/examples/health/get-d-b.md +0 -15
  127. data/docs/examples/health/get-queue-certificates.md +0 -15
  128. data/docs/examples/health/get-queue-functions.md +0 -15
  129. data/docs/examples/health/get-queue-logs.md +0 -15
  130. data/docs/examples/health/get-queue-tasks.md +0 -15
  131. data/docs/examples/health/get-queue-usage.md +0 -15
  132. data/docs/examples/health/get-queue-webhooks.md +0 -15
  133. data/docs/examples/health/get-storage-local.md +0 -15
  134. data/docs/examples/health/get-time.md +0 -15
  135. data/docs/examples/health/get.md +0 -15
  136. data/docs/examples/locale/get-continents.md +0 -15
  137. data/docs/examples/locale/get-countries-e-u.md +0 -15
  138. data/docs/examples/locale/get-countries-phones.md +0 -15
  139. data/docs/examples/locale/get-countries.md +0 -15
  140. data/docs/examples/locale/get-currencies.md +0 -15
  141. data/docs/examples/locale/get-languages.md +0 -15
  142. data/docs/examples/locale/get.md +0 -15
  143. data/docs/examples/storage/create-file.md +0 -15
  144. data/docs/examples/storage/delete-file.md +0 -15
  145. data/docs/examples/storage/get-file-download.md +0 -15
  146. data/docs/examples/storage/get-file-preview.md +0 -15
  147. data/docs/examples/storage/get-file-view.md +0 -15
  148. data/docs/examples/storage/get-file.md +0 -15
  149. data/docs/examples/storage/list-files.md +0 -15
  150. data/docs/examples/storage/update-file.md +0 -15
  151. data/docs/examples/teams/create-membership.md +0 -15
  152. data/docs/examples/teams/create.md +0 -15
  153. data/docs/examples/teams/delete-membership.md +0 -15
  154. data/docs/examples/teams/delete.md +0 -15
  155. data/docs/examples/teams/get-memberships.md +0 -15
  156. data/docs/examples/teams/get.md +0 -15
  157. data/docs/examples/teams/list.md +0 -15
  158. data/docs/examples/teams/update-membership-roles.md +0 -15
  159. data/docs/examples/teams/update-membership-status.md +0 -15
  160. data/docs/examples/teams/update.md +0 -15
  161. data/docs/examples/users/create.md +0 -15
  162. data/docs/examples/users/delete-session.md +0 -15
  163. data/docs/examples/users/delete-sessions.md +0 -15
  164. data/docs/examples/users/delete.md +0 -15
  165. data/docs/examples/users/get-logs.md +0 -15
  166. data/docs/examples/users/get-prefs.md +0 -15
  167. data/docs/examples/users/get-sessions.md +0 -15
  168. data/docs/examples/users/get.md +0 -15
  169. data/docs/examples/users/list.md +0 -15
  170. data/docs/examples/users/update-email.md +0 -15
  171. data/docs/examples/users/update-name.md +0 -15
  172. data/docs/examples/users/update-password.md +0 -15
  173. data/docs/examples/users/update-prefs.md +0 -15
  174. data/docs/examples/users/update-status.md +0 -15
  175. data/docs/examples/users/update-verification.md +0 -15
@@ -1,211 +1,562 @@
1
+ #frozen_string_literal: true
2
+
1
3
  module Appwrite
2
4
  class Storage < Service
3
5
 
4
- def list_files(search: nil, limit: nil, offset: nil, order_type: nil)
5
- path = '/storage/files'
6
-
7
- params = {}
8
-
9
- if !search.nil?
10
- params[:search] = search
11
- end
6
+ # Get a list of all the storage buckets. You can use the query params to
7
+ # filter your results.
8
+ #
9
+ # @param [string] search Search term to filter your list results. Max length: 256 chars.
10
+ # @param [number] limit Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.
11
+ # @param [number] offset Results offset. The default value is 0. Use this param to manage pagination.
12
+ # @param [string] cursor ID of the bucket used as the starting point for the query, excluding the bucket itself. Should be used for efficient pagination when working with large sets of data.
13
+ # @param [string] cursor_direction Direction of the cursor.
14
+ # @param [string] order_type Order result by ASC or DESC order.
15
+ #
16
+ # @return [BucketList]
17
+ def list_buckets(search: nil, limit: nil, offset: nil, cursor: nil, cursor_direction: nil, order_type: nil)
18
+ path = '/storage/buckets'
19
+
20
+ params = {
21
+ search: search,
22
+ limit: limit,
23
+ offset: offset,
24
+ cursor: cursor,
25
+ cursorDirection: cursor_direction,
26
+ orderType: order_type,
27
+ }
28
+
29
+ headers = {
30
+ "content-type": 'application/json',
31
+ }
32
+
33
+ @client.call(
34
+ method: 'GET',
35
+ path: path,
36
+ headers: headers,
37
+ params: params,
38
+ response_type: Models::BucketList
39
+ )
40
+ end
12
41
 
13
- if !limit.nil?
14
- params[:limit] = limit
42
+ # Create a new storage bucket.
43
+ #
44
+ # @param [string] bucket_id Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
45
+ # @param [string] name Bucket name
46
+ # @param [string] permission Permissions type model to use for reading files in this bucket. You can use bucket-level permission set once on the bucket using the `read` and `write` params, or you can set file-level permission where each file read and write params will decide who has access to read and write to each file individually. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
47
+ # @param [array] read An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
48
+ # @param [array] write An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
49
+ # @param [boolean] enabled Is bucket enabled?
50
+ # @param [number] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the `_APP_STORAGE_LIMIT` environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
51
+ # @param [array] allowed_file_extensions Allowed file extensions
52
+ # @param [boolean] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
53
+ # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
54
+ #
55
+ # @return [Bucket]
56
+ def create_bucket(bucket_id:, name:, permission:, read: nil, write: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, encryption: nil, antivirus: nil)
57
+ if bucket_id.nil?
58
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
15
59
  end
16
60
 
17
- if !offset.nil?
18
- params[:offset] = offset
61
+ if name.nil?
62
+ raise Appwrite::Exception.new('Missing required parameter: "name"')
19
63
  end
20
64
 
21
- if !order_type.nil?
22
- params[:orderType] = order_type
65
+ if permission.nil?
66
+ raise Appwrite::Exception.new('Missing required parameter: "permission"')
23
67
  end
24
68
 
25
- return @client.call('get', path, {
26
- 'content-type' => 'application/json',
27
- }, params);
69
+ path = '/storage/buckets'
70
+
71
+ params = {
72
+ bucketId: bucket_id,
73
+ name: name,
74
+ permission: permission,
75
+ read: read,
76
+ write: write,
77
+ enabled: enabled,
78
+ maximumFileSize: maximum_file_size,
79
+ allowedFileExtensions: allowed_file_extensions,
80
+ encryption: encryption,
81
+ antivirus: antivirus,
82
+ }
83
+
84
+ headers = {
85
+ "content-type": 'application/json',
86
+ }
87
+
88
+ @client.call(
89
+ method: 'POST',
90
+ path: path,
91
+ headers: headers,
92
+ params: params,
93
+ response_type: Models::Bucket
94
+ )
28
95
  end
29
96
 
30
- def create_file(file:, read: nil, write: nil)
31
- if file.nil?
32
- raise Appwrite::Exception.new('Missing required parameter: "file"')
97
+ # Get a storage bucket by its unique ID. This endpoint response returns a
98
+ # JSON object with the storage bucket metadata.
99
+ #
100
+ # @param [string] bucket_id Bucket unique ID.
101
+ #
102
+ # @return [Bucket]
103
+ def get_bucket(bucket_id:)
104
+ if bucket_id.nil?
105
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
33
106
  end
34
107
 
35
- path = '/storage/files'
108
+ path = '/storage/buckets/{bucketId}'
109
+ .gsub('{bucketId}', bucket_id)
36
110
 
37
- params = {}
111
+ params = {
112
+ }
38
113
 
39
- if !file.nil?
40
- params[:file] = file
114
+ headers = {
115
+ "content-type": 'application/json',
116
+ }
117
+
118
+ @client.call(
119
+ method: 'GET',
120
+ path: path,
121
+ headers: headers,
122
+ params: params,
123
+ response_type: Models::Bucket
124
+ )
125
+ end
126
+
127
+ # Update a storage bucket by its unique ID.
128
+ #
129
+ # @param [string] bucket_id Bucket unique ID.
130
+ # @param [string] name Bucket name
131
+ # @param [string] permission Permissions type model to use for reading files in this bucket. You can use bucket-level permission set once on the bucket using the `read` and `write` params, or you can set file-level permission where each file read and write params will decide who has access to read and write to each file individually. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
132
+ # @param [array] read An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
133
+ # @param [array] write An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.
134
+ # @param [boolean] enabled Is bucket enabled?
135
+ # @param [number] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
136
+ # @param [array] allowed_file_extensions Allowed file extensions
137
+ # @param [boolean] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
138
+ # @param [boolean] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
139
+ #
140
+ # @return [Bucket]
141
+ def update_bucket(bucket_id:, name:, permission:, read: nil, write: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, encryption: nil, antivirus: nil)
142
+ if bucket_id.nil?
143
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
41
144
  end
42
145
 
43
- if !read.nil?
44
- params[:read] = read
146
+ if name.nil?
147
+ raise Appwrite::Exception.new('Missing required parameter: "name"')
45
148
  end
46
149
 
47
- if !write.nil?
48
- params[:write] = write
150
+ if permission.nil?
151
+ raise Appwrite::Exception.new('Missing required parameter: "permission"')
49
152
  end
50
153
 
51
- return @client.call('post', path, {
52
- 'content-type' => 'multipart/form-data',
53
- }, params);
154
+ path = '/storage/buckets/{bucketId}'
155
+ .gsub('{bucketId}', bucket_id)
156
+
157
+ params = {
158
+ name: name,
159
+ permission: permission,
160
+ read: read,
161
+ write: write,
162
+ enabled: enabled,
163
+ maximumFileSize: maximum_file_size,
164
+ allowedFileExtensions: allowed_file_extensions,
165
+ encryption: encryption,
166
+ antivirus: antivirus,
167
+ }
168
+
169
+ headers = {
170
+ "content-type": 'application/json',
171
+ }
172
+
173
+ @client.call(
174
+ method: 'PUT',
175
+ path: path,
176
+ headers: headers,
177
+ params: params,
178
+ response_type: Models::Bucket
179
+ )
54
180
  end
55
181
 
56
- def get_file(file_id:)
57
- if file_id.nil?
58
- raise Appwrite::Exception.new('Missing required parameter: "fileId"')
182
+ # Delete a storage bucket by its unique ID.
183
+ #
184
+ # @param [string] bucket_id Bucket unique ID.
185
+ #
186
+ # @return []
187
+ def delete_bucket(bucket_id:)
188
+ if bucket_id.nil?
189
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
59
190
  end
60
191
 
61
- path = '/storage/files/{fileId}'
62
- .gsub('{fileId}', file_id)
192
+ path = '/storage/buckets/{bucketId}'
193
+ .gsub('{bucketId}', bucket_id)
194
+
195
+ params = {
196
+ }
63
197
 
64
- params = {}
198
+ headers = {
199
+ "content-type": 'application/json',
200
+ }
65
201
 
66
- return @client.call('get', path, {
67
- 'content-type' => 'application/json',
68
- }, params);
202
+ @client.call(
203
+ method: 'DELETE',
204
+ path: path,
205
+ headers: headers,
206
+ params: params,
207
+ )
69
208
  end
70
209
 
71
- def update_file(file_id:, read:, write:)
72
- if file_id.nil?
73
- raise Appwrite::Exception.new('Missing required parameter: "fileId"')
210
+ # Get a list of all the user files. You can use the query params to filter
211
+ # your results. On admin mode, this endpoint will return a list of all of the
212
+ # project's files. [Learn more about different API modes](/docs/admin).
213
+ #
214
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
215
+ # @param [string] search Search term to filter your list results. Max length: 256 chars.
216
+ # @param [number] limit Maximum number of files to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
217
+ # @param [number] offset Offset value. The default value is 0. Use this param to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)
218
+ # @param [string] cursor ID of the file used as the starting point for the query, excluding the file itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)
219
+ # @param [string] cursor_direction Direction of the cursor.
220
+ # @param [string] order_type Order result by ASC or DESC order.
221
+ #
222
+ # @return [FileList]
223
+ def list_files(bucket_id:, search: nil, limit: nil, offset: nil, cursor: nil, cursor_direction: nil, order_type: nil)
224
+ if bucket_id.nil?
225
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
74
226
  end
75
227
 
76
- if read.nil?
77
- raise Appwrite::Exception.new('Missing required parameter: "read"')
78
- end
228
+ path = '/storage/buckets/{bucketId}/files'
229
+ .gsub('{bucketId}', bucket_id)
230
+
231
+ params = {
232
+ search: search,
233
+ limit: limit,
234
+ offset: offset,
235
+ cursor: cursor,
236
+ cursorDirection: cursor_direction,
237
+ orderType: order_type,
238
+ }
239
+
240
+ headers = {
241
+ "content-type": 'application/json',
242
+ }
243
+
244
+ @client.call(
245
+ method: 'GET',
246
+ path: path,
247
+ headers: headers,
248
+ params: params,
249
+ response_type: Models::FileList
250
+ )
251
+ end
79
252
 
80
- if write.nil?
81
- raise Appwrite::Exception.new('Missing required parameter: "write"')
253
+ # Create a new file. Before using this route, you should create a new bucket
254
+ # resource using either a [server
255
+ # integration](/docs/server/database#storageCreateBucket) API or directly
256
+ # from your Appwrite console.
257
+ #
258
+ # Larger files should be uploaded using multiple requests with the
259
+ # [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
260
+ # header to send a partial request with a maximum supported chunk of `5MB`.
261
+ # The `content-range` header values should always be in bytes.
262
+ #
263
+ # When the first request is sent, the server will return the **File** object,
264
+ # and the subsequent part request must include the file's **id** in
265
+ # `x-appwrite-id` header to allow the server to know that the partial upload
266
+ # is for the existing file and not for a new one.
267
+ #
268
+ # If you're creating a new file using one of the Appwrite SDKs, all the
269
+ # chunking logic will be managed by the SDK internally.
270
+ #
271
+ #
272
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
273
+ # @param [string] file_id File ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
274
+ # @param [file] file Binary file.
275
+ # @param [array] read An array of strings with read permissions. By default only the current user is granted with read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
276
+ # @param [array] write An array of strings with write permissions. By default only the current user is granted with write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
277
+ #
278
+ # @return [File]
279
+ def create_file(bucket_id:, file_id:, file:, read: nil, write: nil, on_progress: nil)
280
+ if bucket_id.nil?
281
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
82
282
  end
83
283
 
84
- path = '/storage/files/{fileId}'
85
- .gsub('{fileId}', file_id)
86
-
87
- params = {}
88
-
89
- if !read.nil?
90
- params[:read] = read
284
+ if file_id.nil?
285
+ raise Appwrite::Exception.new('Missing required parameter: "fileId"')
91
286
  end
92
287
 
93
- if !write.nil?
94
- params[:write] = write
288
+ if file.nil?
289
+ raise Appwrite::Exception.new('Missing required parameter: "file"')
95
290
  end
96
291
 
97
- return @client.call('put', path, {
98
- 'content-type' => 'application/json',
99
- }, params);
292
+ path = '/storage/buckets/{bucketId}/files'
293
+ .gsub('{bucketId}', bucket_id)
294
+
295
+ params = {
296
+ fileId: file_id,
297
+ file: file,
298
+ read: read,
299
+ write: write,
300
+ }
301
+
302
+ headers = {
303
+ "content-type": 'multipart/form-data',
304
+ }
305
+
306
+ param_name = 'file'
307
+
308
+ @client.chunked_upload(
309
+ path: path,
310
+ headers: headers,
311
+ params: params,
312
+ param_name: param_name,
313
+ on_progress: on_progress,
314
+ response_type: Models::File
315
+ )
100
316
  end
101
317
 
102
- def delete_file(file_id:)
318
+ # Get a file by its unique ID. This endpoint response returns a JSON object
319
+ # with the file metadata.
320
+ #
321
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
322
+ # @param [string] file_id File ID.
323
+ #
324
+ # @return [File]
325
+ def get_file(bucket_id:, file_id:)
326
+ if bucket_id.nil?
327
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
328
+ end
329
+
103
330
  if file_id.nil?
104
331
  raise Appwrite::Exception.new('Missing required parameter: "fileId"')
105
332
  end
106
333
 
107
- path = '/storage/files/{fileId}'
334
+ path = '/storage/buckets/{bucketId}/files/{fileId}'
335
+ .gsub('{bucketId}', bucket_id)
108
336
  .gsub('{fileId}', file_id)
109
337
 
110
- params = {}
338
+ params = {
339
+ }
111
340
 
112
- return @client.call('delete', path, {
113
- 'content-type' => 'application/json',
114
- }, params);
341
+ headers = {
342
+ "content-type": 'application/json',
343
+ }
344
+
345
+ @client.call(
346
+ method: 'GET',
347
+ path: path,
348
+ headers: headers,
349
+ params: params,
350
+ response_type: Models::File
351
+ )
115
352
  end
116
353
 
117
- def get_file_download(file_id:)
354
+ # Update a file by its unique ID. Only users with write permissions have
355
+ # access to update this resource.
356
+ #
357
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
358
+ # @param [string] file_id File unique ID.
359
+ # @param [array] read An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
360
+ # @param [array] write An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.
361
+ #
362
+ # @return [File]
363
+ def update_file(bucket_id:, file_id:, read: nil, write: nil)
364
+ if bucket_id.nil?
365
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
366
+ end
367
+
118
368
  if file_id.nil?
119
369
  raise Appwrite::Exception.new('Missing required parameter: "fileId"')
120
370
  end
121
371
 
122
- path = '/storage/files/{fileId}/download'
372
+ path = '/storage/buckets/{bucketId}/files/{fileId}'
373
+ .gsub('{bucketId}', bucket_id)
123
374
  .gsub('{fileId}', file_id)
124
375
 
125
- params = {}
126
-
127
- return @client.call('get', path, {
128
- 'content-type' => 'application/json',
129
- }, params);
376
+ params = {
377
+ read: read,
378
+ write: write,
379
+ }
380
+
381
+ headers = {
382
+ "content-type": 'application/json',
383
+ }
384
+
385
+ @client.call(
386
+ method: 'PUT',
387
+ path: path,
388
+ headers: headers,
389
+ params: params,
390
+ response_type: Models::File
391
+ )
130
392
  end
131
393
 
132
- def get_file_preview(file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil)
394
+ # Delete a file by its unique ID. Only users with write permissions have
395
+ # access to delete this resource.
396
+ #
397
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
398
+ # @param [string] file_id File ID.
399
+ #
400
+ # @return []
401
+ def delete_file(bucket_id:, file_id:)
402
+ if bucket_id.nil?
403
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
404
+ end
405
+
133
406
  if file_id.nil?
134
407
  raise Appwrite::Exception.new('Missing required parameter: "fileId"')
135
408
  end
136
409
 
137
- path = '/storage/files/{fileId}/preview'
410
+ path = '/storage/buckets/{bucketId}/files/{fileId}'
411
+ .gsub('{bucketId}', bucket_id)
138
412
  .gsub('{fileId}', file_id)
139
413
 
140
- params = {}
414
+ params = {
415
+ }
141
416
 
142
- if !width.nil?
143
- params[:width] = width
144
- end
417
+ headers = {
418
+ "content-type": 'application/json',
419
+ }
145
420
 
146
- if !height.nil?
147
- params[:height] = height
148
- end
421
+ @client.call(
422
+ method: 'DELETE',
423
+ path: path,
424
+ headers: headers,
425
+ params: params,
426
+ )
427
+ end
149
428
 
150
- if !gravity.nil?
151
- params[:gravity] = gravity
429
+ # Get a file content by its unique ID. The endpoint response return with a
430
+ # 'Content-Disposition: attachment' header that tells the browser to start
431
+ # downloading the file to user downloads directory.
432
+ #
433
+ # @param [string] bucket_id Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
434
+ # @param [string] file_id File ID.
435
+ #
436
+ # @return []
437
+ def get_file_download(bucket_id:, file_id:)
438
+ if bucket_id.nil?
439
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
152
440
  end
153
441
 
154
- if !quality.nil?
155
- params[:quality] = quality
442
+ if file_id.nil?
443
+ raise Appwrite::Exception.new('Missing required parameter: "fileId"')
156
444
  end
157
445
 
158
- if !border_width.nil?
159
- params[:borderWidth] = border_width
160
- end
446
+ path = '/storage/buckets/{bucketId}/files/{fileId}/download'
447
+ .gsub('{bucketId}', bucket_id)
448
+ .gsub('{fileId}', file_id)
161
449
 
162
- if !border_color.nil?
163
- params[:borderColor] = border_color
164
- end
450
+ params = {
451
+ }
165
452
 
166
- if !border_radius.nil?
167
- params[:borderRadius] = border_radius
168
- end
453
+ headers = {
454
+ "content-type": 'application/json',
455
+ }
169
456
 
170
- if !opacity.nil?
171
- params[:opacity] = opacity
172
- end
457
+ @client.call(
458
+ method: 'GET',
459
+ path: path,
460
+ headers: headers,
461
+ params: params,
462
+ )
463
+ end
173
464
 
174
- if !rotation.nil?
175
- params[:rotation] = rotation
465
+ # Get a file preview image. Currently, this method supports preview for image
466
+ # files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
467
+ # and spreadsheets, will return the file icon image. You can also pass query
468
+ # string arguments for cutting and resizing your preview image. Preview is
469
+ # supported only for image files smaller than 10MB.
470
+ #
471
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
472
+ # @param [string] file_id File ID
473
+ # @param [number] width Resize preview image width, Pass an integer between 0 to 4000.
474
+ # @param [number] height Resize preview image height, Pass an integer between 0 to 4000.
475
+ # @param [string] gravity Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
476
+ # @param [number] quality Preview image quality. Pass an integer between 0 to 100. Defaults to 100.
477
+ # @param [number] border_width Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
478
+ # @param [string] border_color Preview image border color. Use a valid HEX color, no # is needed for prefix.
479
+ # @param [number] border_radius Preview image border radius in pixels. Pass an integer between 0 to 4000.
480
+ # @param [number] opacity Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
481
+ # @param [number] rotation Preview image rotation in degrees. Pass an integer between -360 and 360.
482
+ # @param [string] background Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
483
+ # @param [string] output Output format type (jpeg, jpg, png, gif and webp).
484
+ #
485
+ # @return []
486
+ def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil)
487
+ if bucket_id.nil?
488
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
176
489
  end
177
490
 
178
- if !background.nil?
179
- params[:background] = background
491
+ if file_id.nil?
492
+ raise Appwrite::Exception.new('Missing required parameter: "fileId"')
180
493
  end
181
494
 
182
- if !output.nil?
183
- params[:output] = output
184
- end
495
+ path = '/storage/buckets/{bucketId}/files/{fileId}/preview'
496
+ .gsub('{bucketId}', bucket_id)
497
+ .gsub('{fileId}', file_id)
185
498
 
186
- return @client.call('get', path, {
187
- 'content-type' => 'application/json',
188
- }, params);
499
+ params = {
500
+ width: width,
501
+ height: height,
502
+ gravity: gravity,
503
+ quality: quality,
504
+ borderWidth: border_width,
505
+ borderColor: border_color,
506
+ borderRadius: border_radius,
507
+ opacity: opacity,
508
+ rotation: rotation,
509
+ background: background,
510
+ output: output,
511
+ }
512
+
513
+ headers = {
514
+ "content-type": 'application/json',
515
+ }
516
+
517
+ @client.call(
518
+ method: 'GET',
519
+ path: path,
520
+ headers: headers,
521
+ params: params,
522
+ )
189
523
  end
190
524
 
191
- def get_file_view(file_id:)
525
+ # Get a file content by its unique ID. This endpoint is similar to the
526
+ # download method but returns with no 'Content-Disposition: attachment'
527
+ # header.
528
+ #
529
+ # @param [string] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
530
+ # @param [string] file_id File ID.
531
+ #
532
+ # @return []
533
+ def get_file_view(bucket_id:, file_id:)
534
+ if bucket_id.nil?
535
+ raise Appwrite::Exception.new('Missing required parameter: "bucketId"')
536
+ end
537
+
192
538
  if file_id.nil?
193
539
  raise Appwrite::Exception.new('Missing required parameter: "fileId"')
194
540
  end
195
541
 
196
- path = '/storage/files/{fileId}/view'
542
+ path = '/storage/buckets/{bucketId}/files/{fileId}/view'
543
+ .gsub('{bucketId}', bucket_id)
197
544
  .gsub('{fileId}', file_id)
198
545
 
199
- params = {}
200
-
201
- return @client.call('get', path, {
202
- 'content-type' => 'application/json',
203
- }, params);
204
- end
546
+ params = {
547
+ }
205
548
 
549
+ headers = {
550
+ "content-type": 'application/json',
551
+ }
206
552
 
207
- protected
553
+ @client.call(
554
+ method: 'GET',
555
+ path: path,
556
+ headers: headers,
557
+ params: params,
558
+ )
559
+ end
208
560
 
209
- private
210
561
  end
211
562
  end