appwrite 27.0.0 → 28.0.0.rc1

data/lib/appwrite/services/organization.rb

@@ -1,8 +1,7 @@
-#frozen_string_literal: true
+# frozen_string_literal: true
 
 module Appwrite
     class Organization < Service
-
         def initialize(client)
             @client = client
         end
@@ -14,9 +13,8 @@ module Appwrite
         def get()
             api_path = '/organization'
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -29,25 +27,26 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Organization
             )
-
         end
 
-        # Update the current organization's name.
+        # Update the current organization&#039;s name.
         #
         # @param [String] name New organization name. Max length: 128 chars.
         #
         # @return [Organization]
-        def update(name:)
+        def update(
+            name:
+        )
             api_path = '/organization'
 
             if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
+                raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
             api_params = {
                 name: name,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -61,7 +60,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Organization
             )
-
         end
 
         # Delete the current organization. All projects that belong to the
@@ -72,9 +70,8 @@ module Appwrite
         def delete()
             api_path = '/organization'
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -86,7 +83,6 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
-
         end
 
         # List app installations on the organization. Any organization member can
@@ -96,14 +92,17 @@ module Appwrite
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [AppInstallationList]
-        def list_installations(queries: nil, total: nil)
+        def list_installations(
+            queries: nil,
+            total: nil
+        )
             api_path = '/organization/installations'
 
             api_params = {
                 queries: queries,
                 total: total,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -116,7 +115,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AppInstallationList
             )
-
         end
 
         # Install an app on the organization. Only organization members with the
@@ -127,18 +125,21 @@ module Appwrite
         # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
         #
         # @return [AppInstallation]
-        def create_installation(app_id:, authorization_details: nil)
+        def create_installation(
+            app_id:,
+            authorization_details: nil
+        )
             api_path = '/organization/installations'
 
             if app_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "appId"')
+                raise Appwrite::Exception.new('Missing required parameter: "appId"')
             end
 
             api_params = {
                 appId: app_id,
                 authorizationDetails: authorization_details,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -152,7 +153,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AppInstallation
             )
-
         end
 
         # Get an app installation on the organization by its unique ID. Any
@@ -161,17 +161,18 @@ module Appwrite
         # @param [String] installation_id Installation unique ID.
         #
         # @return [AppInstallation]
-        def get_installation(installation_id:)
+        def get_installation(
+            installation_id:
+        )
             api_path = '/organization/installations/{installationId}'
                 .gsub('{installationId}', installation_id)
 
             if installation_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+                raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -184,11 +185,10 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AppInstallation
             )
-
         end
 
         # Update an app installation on the organization. Only organization members
-        # with the owner role can update installations. The installation's granted
+        # with the owner role can update installations. The installation&#039;s granted
         # scopes are refreshed to the scopes the app currently requests; previously
         # issued installation access tokens are revoked.
         #
@@ -196,18 +196,21 @@ module Appwrite
         # @param [String] authorization_details Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
         #
         # @return [AppInstallation]
-        def update_installation(installation_id:, authorization_details: nil)
+        def update_installation(
+            installation_id:,
+            authorization_details: nil
+        )
             api_path = '/organization/installations/{installationId}'
                 .gsub('{installationId}', installation_id)
 
             if installation_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+                raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
             api_params = {
                 authorizationDetails: authorization_details,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -221,7 +224,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::AppInstallation
             )
-
         end
 
         # Uninstall an app from the organization by its installation ID. Only
@@ -231,17 +233,18 @@ module Appwrite
         # @param [String] installation_id Installation unique ID.
         #
         # @return []
-        def delete_installation(installation_id:)
+        def delete_installation(
+            installation_id:
+        )
             api_path = '/organization/installations/{installationId}'
                 .gsub('{installationId}', installation_id)
 
             if installation_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "installationId"')
+                raise Appwrite::Exception.new('Missing required parameter: "installationId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -254,7 +257,6 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
-
         end
 
         # Get a list of all API keys from the current organization.
@@ -263,14 +265,17 @@ module Appwrite
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [KeyList]
-        def list_keys(queries: nil, total: nil)
+        def list_keys(
+            queries: nil,
+            total: nil
+        )
             api_path = '/organization/keys'
 
             api_params = {
                 queries: queries,
                 total: total,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -283,30 +288,34 @@ module Appwrite
                 params: api_params,
                 response_type: Models::KeyList
             )
-
         end
 
         # Create a new organization API key.
         #
-        # @param [String] key_id Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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] key_id Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
         # @param [String] name Key name. Max length: 128 chars.
         # @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
         # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
         #
         # @return [Key]
-        def create_key(key_id:, name:, scopes:, expire: nil)
+        def create_key(
+            key_id:,
+            name:,
+            scopes:,
+            expire: nil
+        )
             api_path = '/organization/keys'
 
             if key_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
             if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
+                raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
             if scopes.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "scopes"')
+                raise Appwrite::Exception.new('Missing required parameter: "scopes"')
             end
 
             api_params = {
@@ -315,7 +324,7 @@ module Appwrite
                 scopes: scopes,
                 expire: expire,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -329,7 +338,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Key
             )
-
         end
 
         # Get a key by its unique ID. This endpoint returns details about a specific
@@ -338,17 +346,18 @@ module Appwrite
         # @param [String] key_id Key unique ID.
         #
         # @return [Key]
-        def get_key(key_id:)
+        def get_key(
+            key_id:
+        )
             api_path = '/organization/keys/{keyId}'
                 .gsub('{keyId}', key_id)
 
             if key_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -361,7 +370,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Key
             )
-
         end
 
         # Update a key by its unique ID. Use this endpoint to update the name,
@@ -373,20 +381,25 @@ module Appwrite
         # @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
         #
         # @return [Key]
-        def update_key(key_id:, name:, scopes:, expire: nil)
+        def update_key(
+            key_id:,
+            name:,
+            scopes:,
+            expire: nil
+        )
             api_path = '/organization/keys/{keyId}'
                 .gsub('{keyId}', key_id)
 
             if key_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
             if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
+                raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
             if scopes.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "scopes"')
+                raise Appwrite::Exception.new('Missing required parameter: "scopes"')
             end
 
             api_params = {
@@ -394,7 +407,7 @@ module Appwrite
                 scopes: scopes,
                 expire: expire,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -408,7 +421,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Key
             )
-
         end
 
         # Delete a key by its unique ID. Once deleted, the key can no longer be used
@@ -417,17 +429,18 @@ module Appwrite
         # @param [String] key_id Key unique ID.
         #
         # @return []
-        def delete_key(key_id:)
+        def delete_key(
+            key_id:
+        )
             api_path = '/organization/keys/{keyId}'
                 .gsub('{keyId}', key_id)
 
             if key_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "keyId"')
+                raise Appwrite::Exception.new('Missing required parameter: "keyId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -439,7 +452,6 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
-
         end
 
         # Get a list of all memberships from the current organization.
@@ -449,7 +461,11 @@ module Appwrite
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [MembershipList]
-        def list_memberships(queries: nil, search: nil, total: nil)
+        def list_memberships(
+            queries: nil,
+            search: nil,
+            total: nil
+        )
             api_path = '/organization/memberships'
 
             api_params = {
@@ -457,7 +473,7 @@ module Appwrite
                 search: search,
                 total: total,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -470,26 +486,32 @@ module Appwrite
                 params: api_params,
                 response_type: Models::MembershipList
             )
-
         end
 
         # Invite a new member to join the current organization. An email with a link
-        # to join the organization will be sent to the new member's email address. If
-        # member doesn't exist in the project it will be automatically created.
+        # to join the organization will be sent to the new member&#039;s email address. If
+        # member doesn&#039;t exist in the project it will be automatically created.
         #
         # @param [Array] roles Array of strings. Use this param to set the user roles in the organization. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
         # @param [String] email Email of the new organization member.
         # @param [String] user_id ID of the user to be added to the organization.
-        # @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 &#039;+&#039; and a country code, e.g., +16175551212.
         # @param [String] url URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied.
         # @param [String] name Name of the new organization member. Max length: 128 chars.
         #
         # @return [Membership]
-        def create_membership(roles:, email: nil, user_id: nil, phone: nil, url: nil, name: nil)
+        def create_membership(
+            roles:,
+            email: nil,
+            user_id: nil,
+            phone: nil,
+            url: nil,
+            name: nil
+        )
             api_path = '/organization/memberships'
 
             if roles.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "roles"')
+                raise Appwrite::Exception.new('Missing required parameter: "roles"')
             end
 
             api_params = {
@@ -500,7 +522,7 @@ module Appwrite
                 url: url,
                 name: name,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -514,7 +536,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Membership
             )
-
         end
 
         # Get a membership from the current organization by its unique ID.
@@ -522,17 +543,18 @@ module Appwrite
         # @param [String] membership_id Membership ID.
         #
         # @return [Membership]
-        def get_membership(membership_id:)
+        def get_membership(
+            membership_id:
+        )
             api_path = '/organization/memberships/{membershipId}'
                 .gsub('{membershipId}', membership_id)
 
             if membership_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
+                raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -545,31 +567,33 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Membership
             )
-
         end
 
         # Modify the roles of a member in the current organization.
         #
         # @param [String] membership_id Membership ID.
-        # @param [Array] roles An array of strings. Use this param to set the user's roles in the organization. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
+        # @param [Array] roles An array of strings. Use this param to set the user&#039;s roles in the organization. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
         #
         # @return [Membership]
-        def update_membership(membership_id:, roles:)
+        def update_membership(
+            membership_id:,
+            roles:
+        )
             api_path = '/organization/memberships/{membershipId}'
                 .gsub('{membershipId}', membership_id)
 
             if membership_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
+                raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
             if roles.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "roles"')
+                raise Appwrite::Exception.new('Missing required parameter: "roles"')
             end
 
             api_params = {
                 roles: roles,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -583,7 +607,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Membership
             )
-
         end
 
         # Remove a member from the current organization. The member is removed
@@ -593,17 +616,18 @@ module Appwrite
         # @param [String] membership_id Membership ID.
         #
         # @return []
-        def delete_membership(membership_id:)
+        def delete_membership(
+            membership_id:
+        )
             api_path = '/organization/memberships/{membershipId}'
                 .gsub('{membershipId}', membership_id)
 
             if membership_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
+                raise Appwrite::Exception.new('Missing required parameter: "membershipId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -615,7 +639,6 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
-
         end
 
         # Get a list of all projects. You can use the query params to filter your
@@ -626,7 +649,11 @@ module Appwrite
         # @param [] total When set to false, the total count returned will be 0 and will not be calculated.
         #
         # @return [ProjectList]
-        def list_projects(queries: nil, search: nil, total: nil)
+        def list_projects(
+            queries: nil,
+            search: nil,
+            total: nil
+        )
             api_path = '/organization/projects'
 
             api_params = {
@@ -634,7 +661,7 @@ module Appwrite
                 search: search,
                 total: total,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "accept": 'application/json',
@@ -647,25 +674,28 @@ module Appwrite
                 params: api_params,
                 response_type: Models::ProjectList
             )
-
         end
 
         # Create a new project.
         #
-        # @param [String] project_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
+        # @param [String] project_id Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can&#039;t start with a special char. Max length is 36 chars.
         # @param [String] name Project name. Max length: 128 chars.
         # @param [Region] region Project Region.
         #
         # @return [Project]
-        def create_project(project_id:, name:, region: nil)
+        def create_project(
+            project_id:,
+            name:,
+            region: nil
+        )
             api_path = '/organization/projects'
 
             if project_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
             if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
+                raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
             api_params = {
@@ -673,7 +703,7 @@ module Appwrite
                 name: name,
                 region: region,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -687,7 +717,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Project
             )
-
         end
 
         # Get a project.
@@ -695,17 +724,18 @@ module Appwrite
         # @param [String] project_id Project unique ID.
         #
         # @return [Project]
-        def get_project(project_id:)
+        def get_project(
+            project_id:
+        )
             api_path = '/organization/projects/{projectId}'
                 .gsub('{projectId}', project_id)
 
             if project_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
             }
@@ -717,7 +747,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Project
             )
-
         end
 
         # Update a project by its unique ID.
@@ -726,22 +755,25 @@ module Appwrite
         # @param [String] name Project name. Max length: 128 chars.
         #
         # @return [Project]
-        def update_project(project_id:, name:)
+        def update_project(
+            project_id:,
+            name:
+        )
             api_path = '/organization/projects/{projectId}'
                 .gsub('{projectId}', project_id)
 
             if project_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
             if name.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "name"')
+                raise Appwrite::Exception.new('Missing required parameter: "name"')
             end
 
             api_params = {
                 name: name,
             }
-            
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -755,7 +787,6 @@ module Appwrite
                 params: api_params,
                 response_type: Models::Project
             )
-
         end
 
         # Delete a project by its unique ID.
@@ -763,17 +794,18 @@ module Appwrite
         # @param [String] project_id Project unique ID.
         #
         # @return []
-        def delete_project(project_id:)
+        def delete_project(
+            project_id:
+        )
             api_path = '/organization/projects/{projectId}'
                 .gsub('{projectId}', project_id)
 
             if project_id.nil?
-              raise Appwrite::Exception.new('Missing required parameter: "projectId"')
+                raise Appwrite::Exception.new('Missing required parameter: "projectId"')
             end
 
-            api_params = {
-            }
-            
+            api_params = {}
+
             api_headers = {
                 "X-Appwrite-Project": @client.get_config('project'),
                 "content-type": 'application/json',
@@ -785,8 +817,6 @@ module Appwrite
                 headers: api_headers,
                 params: api_params,
             )
-
         end
-
-    end 
+    end
 end