appwrite 7.0.0.pre.RC1 → 7.0.0.pre.RC2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 01f7539c1b2b2cf555a208ea8d780fb9acac96bc82925a6f1f04b4531a9955c0
4
- data.tar.gz: 46cd30c3ac91258db353b6f59f912bc291e86f52a69e2e328f01328c05ec0e6f
3
+ metadata.gz: db30162a2dac2692eeebf378f4cea8089b30d382cb5b156cbcdad545493cd73a
4
+ data.tar.gz: 5ebf76520c1ca461bdad5b634bd20c6c20d1c73ea823b06bae536379e33a9dd4
5
5
  SHA512:
6
- metadata.gz: 16b84a186ee035ee618243fb8fd908c1985e6f2cf6c9a87ac0fd31904c8a30004e616d8568c0e367db6fd701f1542198dd1a1b7583cb400de9947a51889e559e
7
- data.tar.gz: 0ec0f97ebe6aa21a9a0d4374a41432b820ba23b07d785c231a615b731775cc4e46f342f88c5897e9f99e09602a98a81772d0d84ea533c3aa251e3be8165d834c
6
+ metadata.gz: 6b9d5a7f32ae74e0522f123ab55396219dbbbef748ec4eb8f728f15ad8da9f0ead7c5c0f65be89842e2415ce37ab1edfa7c095fb349978f7abd5828e5e5dfabe
7
+ data.tar.gz: 93bd9893306bf165137705f65cd43ec04d4f314177b4e24f129cb077ec91e88068a9262602cc5d6a6d6d6e9851e1eb933a7dc0719980336eba1435df6ffd902b
@@ -15,7 +15,7 @@ module Appwrite
15
15
  'x-sdk-name'=> 'Ruby',
16
16
  'x-sdk-platform'=> 'server',
17
17
  'x-sdk-language'=> 'ruby',
18
- 'x-sdk-version'=> '7.0.0-RC1',
18
+ 'x-sdk-version'=> '7.0.0-RC2',
19
19
  'X-Appwrite-Response-Format' => '1.0.0-RC1'
20
20
  }
21
21
  @endpoint = 'https://HOSTNAME/v1'
@@ -176,7 +176,7 @@ module Appwrite
176
176
  # /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
177
177
  # endpoint to send a confirmation SMS.
178
178
  #
179
- # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
179
+ # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
180
180
  # @param [String] password User password. Must be at least 8 chars.
181
181
  #
182
182
  # @return [Account]
@@ -424,7 +424,7 @@ module Appwrite
424
424
  # Use this endpoint to get a logged in user's session using a Session ID.
425
425
  # Inputting 'current' will return the current session being used.
426
426
  #
427
- # @param [String] session_id Session ID. Use the string 'current' to get the current device session.
427
+ # @param [String] session_id Session ID. Use the string 'current' to get the current device session.
428
428
  #
429
429
  # @return [Session]
430
430
  def get_session(session_id:)
@@ -457,7 +457,7 @@ module Appwrite
457
457
  # If session was created using an OAuth provider, this route can be used to
458
458
  # "refresh" the access token.
459
459
  #
460
- # @param [String] session_id Session ID. Use the string 'current' to update the current device session.
460
+ # @param [String] session_id Session ID. Use the string 'current' to update the current device session.
461
461
  #
462
462
  # @return [Session]
463
463
  def update_session(session_id:)
@@ -491,7 +491,7 @@ module Appwrite
491
491
  # Session ID argument, only the unique session ID provided is deleted.
492
492
  #
493
493
  #
494
- # @param [String] session_id Session ID. Use the string 'current' to delete the current device session.
494
+ # @param [String] session_id Session ID. Use the string 'current' to delete the current device session.
495
495
  #
496
496
  # @return []
497
497
  def delete_session(session_id:)
@@ -269,7 +269,7 @@ module Appwrite
269
269
  # @param [String] text Plain text to be converted to QR code image.
270
270
  # @param [Integer] size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
271
271
  # @param [Integer] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
272
- # @param [] download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
272
+ # @param [] download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
273
273
  #
274
274
  # @return []
275
275
  def get_qr(text:, size: nil, margin: nil, download: nil)
@@ -40,7 +40,7 @@ module Appwrite
40
40
  # Create a new Database.
41
41
  #
42
42
  #
43
- # @param [String] database_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't start with a special char. Max length is 36 chars.
43
+ # @param [String] database_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't start with a special char. Max length is 36 chars.
44
44
  # @param [String] name Collection name. Max length: 128 chars.
45
45
  #
46
46
  # @return [Database]
@@ -217,7 +217,7 @@ module Appwrite
217
217
  # directly from your database console.
218
218
  #
219
219
  # @param [String] database_id Database ID.
220
- # @param [String] collection_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't start with a special char. Max length is 36 chars.
220
+ # @param [String] collection_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't start with a special char. Max length is 36 chars.
221
221
  # @param [String] name Collection name. Max length: 128 chars.
222
222
  # @param [Array] permissions An array of permissions strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions).
223
223
  # @param [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](/docs/permissions).
@@ -1061,7 +1061,7 @@ module Appwrite
1061
1061
  #
1062
1062
  # @param [String] database_id Database ID.
1063
1063
  # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
1064
- # @param [String] document_id Document 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't start with a special char. Max length is 36 chars.
1064
+ # @param [String] document_id Document 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't start with a special char. Max length is 36 chars.
1065
1065
  # @param [Hash] data Document data as JSON object.
1066
1066
  # @param [Array] permissions An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
1067
1067
  #
@@ -41,7 +41,7 @@ module Appwrite
41
41
  # [permissions](/docs/permissions) to allow different project users or team
42
42
  # with access to execute the function using the client API.
43
43
  #
44
- # @param [String] function_id Function 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't start with a special char. Max length is 36 chars.
44
+ # @param [String] function_id Function 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't start with a special char. Max length is 36 chars.
45
45
  # @param [String] name Function name. Max length: 128 chars.
46
46
  # @param [Array] execute An array of strings with execution roles. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long.
47
47
  # @param [String] runtime Execution runtime.
@@ -39,16 +39,16 @@ module Appwrite
39
39
 
40
40
  # Create a new storage bucket.
41
41
  #
42
- # @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't start with a special char. Max length is 36 chars.
42
+ # @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't start with a special char. Max length is 36 chars.
43
43
  # @param [String] name Bucket name
44
44
  # @param [Array] permissions An array of permission strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions).
45
45
  # @param [] file_security Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](/docs/permissions).
46
46
  # @param [] enabled Is bucket enabled?
47
47
  # @param [Integer] 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)
48
48
  # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
49
- # @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
50
- # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
51
- # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
49
+ # @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
50
+ # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
51
+ # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
52
52
  #
53
53
  # @return [Bucket]
54
54
  def create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
@@ -131,9 +131,9 @@ module Appwrite
131
131
  # @param [] enabled Is bucket enabled?
132
132
  # @param [Integer] 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)
133
133
  # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
134
- # @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
135
- # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
136
- # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
134
+ # @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
135
+ # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
136
+ # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
137
137
  #
138
138
  # @return [Bucket]
139
139
  def update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
@@ -262,7 +262,7 @@ module Appwrite
262
262
  #
263
263
  #
264
264
  # @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).
265
- # @param [String] file_id File 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't start with a special char. Max length is 36 chars.
265
+ # @param [String] file_id File 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't start with a special char. Max length is 36 chars.
266
266
  # @param [file] file Binary file.
267
267
  # @param [Array] permissions An array of permission strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
268
268
  #
@@ -44,7 +44,7 @@ module Appwrite
44
44
  # assigned as the owner of the team. Only the users with the owner role can
45
45
  # invite new members, add new owners and delete or update the team.
46
46
  #
47
- # @param [String] team_id Team 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't start with a special char. Max length is 36 chars.
47
+ # @param [String] team_id Team 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't start with a special char. Max length is 36 chars.
48
48
  # @param [String] name Team name. Max length: 128 chars.
49
49
  # @param [Array] roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
50
50
  #
@@ -326,7 +326,7 @@ module Appwrite
326
326
  #
327
327
  # @param [String] team_id Team ID.
328
328
  # @param [String] membership_id Membership ID.
329
- # @param [Array] roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
329
+ # @param [Array] roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
330
330
  #
331
331
  # @return [Membership]
332
332
  def update_membership_roles(team_id:, membership_id:, roles:)
@@ -39,9 +39,9 @@ module Appwrite
39
39
 
40
40
  # Create a new user.
41
41
  #
42
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
42
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
43
43
  # @param [String] email User email.
44
- # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
44
+ # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
45
45
  # @param [String] password Plain text user password. Must be at least 8 chars.
46
46
  # @param [String] name User name. Max length: 128 chars.
47
47
  #
@@ -81,7 +81,7 @@ module Appwrite
81
81
  # /users](/docs/server/users#usersCreate) endpoint to create users with a
82
82
  # plain text password.
83
83
  #
84
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
84
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
85
85
  # @param [String] email User email.
86
86
  # @param [String] password User password hashed using Argon2.
87
87
  # @param [String] name User name. Max length: 128 chars.
@@ -129,7 +129,7 @@ module Appwrite
129
129
  # /users](/docs/server/users#usersCreate) endpoint to create users with a
130
130
  # plain text password.
131
131
  #
132
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
132
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
133
133
  # @param [String] email User email.
134
134
  # @param [String] password User password hashed using Bcrypt.
135
135
  # @param [String] name User name. Max length: 128 chars.
@@ -177,7 +177,7 @@ module Appwrite
177
177
  # /users](/docs/server/users#usersCreate) endpoint to create users with a
178
178
  # plain text password.
179
179
  #
180
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
180
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
181
181
  # @param [String] email User email.
182
182
  # @param [String] password User password hashed using MD5.
183
183
  # @param [String] name User name. Max length: 128 chars.
@@ -225,7 +225,7 @@ module Appwrite
225
225
  # /users](/docs/server/users#usersCreate) endpoint to create users with a
226
226
  # plain text password.
227
227
  #
228
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
228
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
229
229
  # @param [String] email User email.
230
230
  # @param [String] password User password hashed using PHPass.
231
231
  # @param [String] name User name. Max length: 128 chars.
@@ -273,7 +273,7 @@ module Appwrite
273
273
  # /users](/docs/server/users#usersCreate) endpoint to create users with a
274
274
  # plain text password.
275
275
  #
276
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
276
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
277
277
  # @param [String] email User email.
278
278
  # @param [String] password User password hashed using Scrypt.
279
279
  # @param [String] password_salt Optional salt used to hash password.
@@ -351,7 +351,7 @@ module Appwrite
351
351
  # algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint
352
352
  # to create users with a plain text password.
353
353
  #
354
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
354
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
355
355
  # @param [String] email User email.
356
356
  # @param [String] password User password hashed using Scrypt Modified.
357
357
  # @param [String] password_salt Salt used to hash password.
@@ -417,10 +417,10 @@ module Appwrite
417
417
  # the [POST /users](/docs/server/users#usersCreate) endpoint to create users
418
418
  # with a plain text password.
419
419
  #
420
- # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
420
+ # @param [String] user_id User 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't start with a special char. Max length is 36 chars.
421
421
  # @param [String] email User email.
422
422
  # @param [String] password User password hashed using SHA.
423
- # @param [String] password_version Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
423
+ # @param [String] password_version Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
424
424
  # @param [String] name User name. Max length: 128 chars.
425
425
  #
426
426
  # @return [User]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: appwrite
3
3
  version: !ruby/object:Gem::Version
4
- version: 7.0.0.pre.RC1
4
+ version: 7.0.0.pre.RC2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Appwrite Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-09-05 00:00:00.000000000 Z
11
+ date: 2022-09-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: mime-types