diff --git a/appwrite.gemspec b/appwrite.gemspec index 0940036..f8ca46c 100644 --- a/appwrite.gemspec +++ b/appwrite.gemspec @@ -1,7 +1,7 @@ Gem::Specification.new do |spec| spec.name = 'appwrite' - spec.version = '7.0.0-RC1' + spec.version = '7.0.0-RC2' spec.license = 'BSD-3-Clause' spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API' spec.author = 'Appwrite Team' diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb index 491fcce..41ca684 100644 --- a/lib/appwrite/client.rb +++ b/lib/appwrite/client.rb @@ -15,7 +15,7 @@ def initialize 'x-sdk-name'=> 'Ruby', 'x-sdk-platform'=> 'server', 'x-sdk-language'=> 'ruby', - 'x-sdk-version'=> '7.0.0-RC1', + 'x-sdk-version'=> '7.0.0-RC2', 'X-Appwrite-Response-Format' => '1.0.0-RC1' } @endpoint = 'https://HOSTNAME/v1' diff --git a/lib/appwrite/services/account.rb b/lib/appwrite/services/account.rb index 5f8e9a2..465ad82 100644 --- a/lib/appwrite/services/account.rb +++ b/lib/appwrite/services/account.rb @@ -176,7 +176,7 @@ def update_password(password:, old_password: nil) # /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) # endpoint to send a confirmation SMS. # - # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. + # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. # @param [String] password User password. Must be at least 8 chars. # # @return [Account] @@ -424,7 +424,7 @@ def delete_sessions() # Use this endpoint to get a logged in user's session using a Session ID. # Inputting 'current' will return the current session being used. # - # @param [String] session_id Session ID. Use the string 'current' to get the current device session. + # @param [String] session_id Session ID. Use the string 'current' to get the current device session. # # @return [Session] def get_session(session_id:) @@ -457,7 +457,7 @@ def get_session(session_id:) # If session was created using an OAuth provider, this route can be used to # "refresh" the access token. # - # @param [String] session_id Session ID. Use the string 'current' to update the current device session. + # @param [String] session_id Session ID. Use the string 'current' to update the current device session. # # @return [Session] def update_session(session_id:) @@ -491,7 +491,7 @@ def update_session(session_id:) # Session ID argument, only the unique session ID provided is deleted. # # - # @param [String] session_id Session ID. Use the string 'current' to delete the current device session. + # @param [String] session_id Session ID. Use the string 'current' to delete the current device session. # # @return [] def delete_session(session_id:) diff --git a/lib/appwrite/services/avatars.rb b/lib/appwrite/services/avatars.rb index 95ebf54..294c8bc 100644 --- a/lib/appwrite/services/avatars.rb +++ b/lib/appwrite/services/avatars.rb @@ -269,7 +269,7 @@ def get_initials(name: nil, width: nil, height: nil, background: nil) # @param [String] text Plain text to be converted to QR code image. # @param [Integer] size QR code size. Pass an integer between 1 to 1000. Defaults to 400. # @param [Integer] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1. - # @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. + # @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. # # @return [] def get_qr(text:, size: nil, margin: nil, download: nil) diff --git a/lib/appwrite/services/databases.rb b/lib/appwrite/services/databases.rb index d0eecf4..f366e8e 100644 --- a/lib/appwrite/services/databases.rb +++ b/lib/appwrite/services/databases.rb @@ -40,7 +40,7 @@ def list(queries: nil, search: nil) # Create a new Database. # # - # @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. + # @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. # @param [String] name Collection name. Max length: 128 chars. # # @return [Database] @@ -217,7 +217,7 @@ def list_collections(database_id:, queries: nil, search: nil) # directly from your database console. # # @param [String] database_id Database ID. - # @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. + # @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. # @param [String] name Collection name. Max length: 128 chars. # @param [Array] permissions An array of permissions strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions). # @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 @@ def list_documents(database_id:, collection_id:, queries: nil) # # @param [String] database_id Database ID. # @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. - # @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. + # @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. # @param [Hash] data Document data as JSON object. # @param [Array] permissions An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions). # diff --git a/lib/appwrite/services/functions.rb b/lib/appwrite/services/functions.rb index bb27dac..a0f6b8c 100644 --- a/lib/appwrite/services/functions.rb +++ b/lib/appwrite/services/functions.rb @@ -41,7 +41,7 @@ def list(queries: nil, search: nil) # [permissions](/docs/permissions) to allow different project users or team # with access to execute the function using the client API. # - # @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. + # @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. # @param [String] name Function name. Max length: 128 chars. # @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. # @param [String] runtime Execution runtime. diff --git a/lib/appwrite/services/storage.rb b/lib/appwrite/services/storage.rb index 9eeed30..9620d6f 100644 --- a/lib/appwrite/services/storage.rb +++ b/lib/appwrite/services/storage.rb @@ -39,16 +39,16 @@ def list_buckets(queries: nil, search: nil) # Create a new storage bucket. # - # @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. + # @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. # @param [String] name Bucket name # @param [Array] permissions An array of permission strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions). # @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). # @param [] enabled Is bucket enabled? # @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) # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. - # @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 - # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled - # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled + # @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 + # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled + # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled # # @return [Bucket] 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 @@ def get_bucket(bucket_id:) # @param [] enabled Is bucket enabled? # @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) # @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. - # @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 - # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled - # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled + # @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 + # @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled + # @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled # # @return [Bucket] 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 @@ def list_files(bucket_id:, queries: nil, search: nil) # # # @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). - # @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. + # @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. # @param [file] file Binary file. # @param [Array] permissions An array of permission strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions). # diff --git a/lib/appwrite/services/teams.rb b/lib/appwrite/services/teams.rb index f322714..5ee13ce 100644 --- a/lib/appwrite/services/teams.rb +++ b/lib/appwrite/services/teams.rb @@ -44,7 +44,7 @@ def list(queries: nil, search: nil) # assigned as the owner of the team. Only the users with the owner role can # invite new members, add new owners and delete or update the team. # - # @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. + # @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. # @param [String] name Team name. Max length: 128 chars. # @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. # @@ -326,7 +326,7 @@ def get_membership(team_id:, membership_id:) # # @param [String] team_id Team ID. # @param [String] membership_id Membership ID. - # @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. + # @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. # # @return [Membership] def update_membership_roles(team_id:, membership_id:, roles:) diff --git a/lib/appwrite/services/users.rb b/lib/appwrite/services/users.rb index b4c5c48..ca64d95 100644 --- a/lib/appwrite/services/users.rb +++ b/lib/appwrite/services/users.rb @@ -39,9 +39,9 @@ def list(queries: nil, search: nil) # Create a new user. # - # @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. + # @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. # @param [String] email User email. - # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. + # @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. # @param [String] password Plain text user password. Must be at least 8 chars. # @param [String] name User name. Max length: 128 chars. # @@ -81,7 +81,7 @@ def create(user_id:, email: nil, phone: nil, password: nil, name: nil) # /users](/docs/server/users#usersCreate) endpoint to create users with a # plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using Argon2. # @param [String] name User name. Max length: 128 chars. @@ -129,7 +129,7 @@ def create_argon2_user(user_id:, email:, password:, name: nil) # /users](/docs/server/users#usersCreate) endpoint to create users with a # plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using Bcrypt. # @param [String] name User name. Max length: 128 chars. @@ -177,7 +177,7 @@ def create_bcrypt_user(user_id:, email:, password:, name: nil) # /users](/docs/server/users#usersCreate) endpoint to create users with a # plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using MD5. # @param [String] name User name. Max length: 128 chars. @@ -225,7 +225,7 @@ def create_md5_user(user_id:, email:, password:, name: nil) # /users](/docs/server/users#usersCreate) endpoint to create users with a # plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using PHPass. # @param [String] name User name. Max length: 128 chars. @@ -273,7 +273,7 @@ def create_ph_pass_user(user_id:, email:, password:, name: nil) # /users](/docs/server/users#usersCreate) endpoint to create users with a # plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using Scrypt. # @param [String] password_salt Optional salt used to hash password. @@ -351,7 +351,7 @@ def create_scrypt_user(user_id:, email:, password:, password_salt:, password_cpu # algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint # to create users with a plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using Scrypt Modified. # @param [String] password_salt Salt used to hash password. @@ -417,10 +417,10 @@ def create_scrypt_modified_user(user_id:, email:, password:, password_salt:, pas # the [POST /users](/docs/server/users#usersCreate) endpoint to create users # with a plain text password. # - # @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. + # @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. # @param [String] email User email. # @param [String] password User password hashed using SHA. - # @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' + # @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' # @param [String] name User name. Max length: 128 chars. # # @return [User]