feat: SDK update for version 23.1.0

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 23.1.0
+
+* Added: Introduced `bigint` create/update APIs for legacy Databases attributes
+* Added: Introduced `bigint` create/update APIs for `TablesDB` columns
+* Updated: Extended key-list query filters with `key`, `resourceType`, `resourceId`, and `secret`
+
 ## 23.0.0
 
 * [BREAKING] Renamed Webhook model fields: `security` → `tls`, `httpUser` → `authUsername`, `httpPass` → `authPassword`, `signatureKey` → `secret`

README.md

@@ -1,7 +1,7 @@
 # Appwrite Ruby SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.9.1-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.4-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

appwrite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '23.0.0'
+  spec.version = '23.1.0'
   spec.license = 'BSD-3-Clause'
   spec.summary = 'Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API'
   spec.author = 'Appwrite Team'

docs/examples/databases/create-big-int-attribute.md

@@ -0,0 +1,23 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(client)
+
+result = databases.create_big_int_attribute(
+    database_id: '<DATABASE_ID>',
+    collection_id: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    min: null, # optional
+    max: null, # optional
+    default: null, # optional
+    array: false # optional
+)
+```

docs/examples/databases/update-big-int-attribute.md

@@ -0,0 +1,23 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+databases = Databases.new(client)
+
+result = databases.update_big_int_attribute(
+    database_id: '<DATABASE_ID>',
+    collection_id: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: null,
+    min: null, # optional
+    max: null, # optional
+    new_key: '' # optional
+)
+```

docs/examples/functions/create-variable.md

@@ -12,6 +12,7 @@ functions = Functions.new(client)
 
 result = functions.create_variable(
     function_id: '<FUNCTION_ID>',
+    variable_id: '<VARIABLE_ID>',
     key: '<KEY>',
     value: '<VALUE>',
     secret: false # optional

docs/examples/functions/create.md

@@ -23,7 +23,7 @@ result = functions.create(
     logging: false, # optional
     entrypoint: '<ENTRYPOINT>', # optional
     commands: '<COMMANDS>', # optional
-    scopes: [Scopes::SESSIONS_WRITE], # optional
+    scopes: [Scopes::PROJECT_READ], # optional
     installation_id: '<INSTALLATION_ID>', # optional
     provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional
     provider_branch: '<PROVIDER_BRANCH>', # optional

docs/examples/functions/list-variables.md

@@ -11,6 +11,8 @@ client = Client.new
 functions = Functions.new(client)
 
 result = functions.list_variables(
-    function_id: '<FUNCTION_ID>'
+    function_id: '<FUNCTION_ID>',
+    queries: [], # optional
+    total: false # optional
 )
 ```

docs/examples/functions/update-variable.md

@@ -13,7 +13,7 @@ functions = Functions.new(client)
 result = functions.update_variable(
     function_id: '<FUNCTION_ID>',
     variable_id: '<VARIABLE_ID>',
-    key: '<KEY>',
+    key: '<KEY>', # optional
     value: '<VALUE>', # optional
     secret: false # optional
 )

docs/examples/functions/update.md

@@ -23,7 +23,7 @@ result = functions.update(
     logging: false, # optional
     entrypoint: '<ENTRYPOINT>', # optional
     commands: '<COMMANDS>', # optional
-    scopes: [Scopes::SESSIONS_WRITE], # optional
+    scopes: [Scopes::PROJECT_READ], # optional
     installation_id: '<INSTALLATION_ID>', # optional
     provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional
     provider_branch: '<PROVIDER_BRANCH>', # optional

docs/examples/project/create-ephemeral-key.md

@@ -0,0 +1,18 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.create_ephemeral_key(
+    scopes: [Scopes::PROJECT_READ],
+    duration: 600
+)
+```

docs/examples/project/create-key.md

@@ -14,7 +14,7 @@ project = Project.new(client)
 result = project.create_key(
     key_id: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [Scopes::SESSIONS_WRITE],
+    scopes: [Scopes::PROJECT_READ],
     expire: '2020-10-15T06:38:00.000+00:00' # optional
 )
 ```

docs/examples/project/create-mock-phone.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.create_mock_phone(
+    number: '+12065550100',
+    otp: '<OTP>'
+)
+```

docs/examples/project/create-smtp-test.md

@@ -0,0 +1,16 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.create_smtp_test(
+    emails: []
+)
+```

docs/examples/project/delete-mock-phone.md

@@ -0,0 +1,16 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.delete_mock_phone(
+    number: '+12065550100'
+)
+```

docs/examples/project/delete.md

@@ -0,0 +1,14 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.delete()
+```

docs/examples/project/get-email-template.md

@@ -0,0 +1,18 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.get_email_template(
+    template_id: EmailTemplateType::VERIFICATION,
+    locale: EmailTemplateLocale::AF # optional
+)
+```

docs/examples/project/get-mock-phone.md

@@ -0,0 +1,16 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.get_mock_phone(
+    number: '+12065550100'
+)
+```

docs/examples/project/get-o-auth-2-provider.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.get_o_auth2_provider(
+    provider_id: OAuthProvider::AMAZON
+)
+```

docs/examples/project/get-policy.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.get_policy(
+    policy_id: ProjectPolicy::PASSWORD_DICTIONARY
+)
+```

docs/examples/project/list-email-templates.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.list_email_templates(
+    queries: [], # optional
+    total: false # optional
+)
+```

docs/examples/project/list-mock-phones.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.list_mock_phones(
+    queries: [], # optional
+    total: false # optional
+)
+```

docs/examples/project/list-o-auth-2-providers.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.list_o_auth2_providers(
+    queries: [], # optional
+    total: false # optional
+)
+```

docs/examples/project/list-policies.md

@@ -0,0 +1,17 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.list_policies(
+    queries: [], # optional
+    total: false # optional
+)
+```

docs/examples/project/update-auth-method.md

@@ -0,0 +1,18 @@
+```ruby
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('<YOUR_PROJECT_ID>') # Your project ID
+    .set_key('<YOUR_API_KEY>') # Your secret API key
+
+project = Project.new(client)
+
+result = project.update_auth_method(
+    method_id: AuthMethod::EMAIL_PASSWORD,
+    enabled: false
+)
+```