sdk-for-ruby

What's New

• Support for Appwrite 1.6
• Added key attribute to Runtime response model.
• Added buildSize attribute to Deployments response model.
• Added scheduledAt attribute to Executions response model.
• Added scopes attribute to Functions response model.
• Added specifications attribute to Functions response model.
• Added new response model for Specifications.
• Added new response model for Builds.
• Added createJWT() : Enables creating a JWT using the userId.
• Added listSpecifications(): Enables listing available runtime specifications.
• Added deleteExecution() : Enables deleting executions.
• Added updateDeploymentBuild(): Enables cancelling a deployment.
• Added scheduledAt parameter to createExecution(): Enables creating a delayed execution

Breaking changes

You can find the new syntax for breaking changes in the Appwrite API references. Select version 1.6.x.

• Removed otp parameter from deleteMFAAuthenticator.
• Added scopes parameter for create/update function.
• Renamed templateBranch to templateVersion in createFunction().
• Renamed downloadDeployment() to getDeploymentDownload()

Bug Fixes

• None reported.

Please note: This version is compatible with Appwrite 1.6 and later only. If you do not update your Appwrite SDK, old SDKs will not break your app. Appwrite APIs are backwards compatible.

New Contributors

• @EVDOG4LIFE made their first contribution in https://github.com/appwrite/sdk-for-ruby/pull/26

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/11.0.2...12.0.0

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/12.0.0-rc.3...12.0.0-rc.4

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/12.0.0-rc.1...12.0.0-rc.3

What's Changed

• Add GitHub action for publishing by @stnguyen90 in https://github.com/appwrite/sdk-for-ruby/pull/25

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/11.0.2...12.0.0-rc.1

What's Changed

• Fix deleteMfaAuthenticator response type
• Fix missing attachments param for update email
• Fix missing enums values
• Fix missing recoveryCode param on MfaFactors
• Fix missing updatedAt param on Session

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/11.0.1...11.0.2

What's Changed

• Fix msg91 params by @stnguyen90 in https://github.com/appwrite/sdk-for-ruby/pull/23

New Contributors

• @stnguyen90 made their first contribution in https://github.com/appwrite/sdk-for-ruby/pull/23

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/11.0.0...11.0.1

What's New

• Support for Appwrite 1.5
• Added enum support.
• Added SSR support, learn more in docs.
• Added messaging service support, learn more in docs.
• Added Query.contains support. Can be used on array and string attributes.
• Added Query.or query support. Can be used to apply a logical or on all nested queries inside.
• Added 2FA support learn more in docs
• Added tokens support, can be used for one-time password login flows, learn more in docs

Breaking changes

You can find the new syntax for breaking changes in the Appwrite API references. Select version 1.5.x.

Account changes (use with SSR)

• update_recovery no longer requires password_again.
• create_email_session renamed to create_email_password_session
• update_phone_session renamed to create_phone_token
• create_magic_url_session renamed to create_email_token
• create_o_auth2_session renamed to create_o_auth2_token
• update_phone, update_magic_url_session, which are the confirmation flows for password-less logins, are renamed to create_session and accept a secret to create session.

If you do not update your Appwrite SDK, old SDKs will not break your app. Appwrite APIs are backwards compatible.

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/10.1.2...11.0.0-rc.4

What's Changed

• Dev by @christyjacob4 in https://github.com/appwrite/sdk-for-ruby/pull/20

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/10.1.1...10.1.2

What's Changed

• Fix null params by @abnegate in https://github.com/appwrite/sdk-for-ruby/pull/19
• Fix list documents by @abnegate in https://github.com/appwrite/sdk-for-ruby/pull/19

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/10.1.0...10.1.1

What's Changed

• Fix between query output by @abnegate in https://github.com/appwrite/sdk-for-ruby/pull/18

New Contributors

• @abnegate made their first contribution in https://github.com/appwrite/sdk-for-ruby/pull/18

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/10.0.0...10.1.0

What's Changed

• BREAKING - Parameter url is now optional in the createMembership endpoint
• Parameter runtime is now optional in the update endpoint of the Functions class

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/9.0.1...10.0.0

What's Changed

• Fix variable name collisions
• Fix content-range header for chunked uploads

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/9.0.0...9.0.1

What's Changed

• Support for Appwrite 1.4.0
• New endpoints for fetching user identities
• New endpoints for listing locale codes
• New endpoint for downloading a function deployment
• Updated documentation
• Breaking changes:
  • The createFunction method has a new signature.
  • The createExecution method has a new signature.
  • The updateFunction method has a new signature.
  • The createDeployment method no longer requires an entrypoint.
  • The updateFile method now includes the ability to update the file name.
  • The updateMembershipRoles method has been renamed to updateMembership.

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/8.0.0...9.0.0

What's Changed

• Added Appwrite 1.3.0 support
• Added relationships support
• Added support for new queries: isNull, isNotNull, startsWith, endsWith, between and select.
• Added update attribute support
• Added team prefs support
• Added support for select queries with getDocument
• [BREAKING] Changed function create/update execute parameter to optional
• [BREAKING] Changed team update function to updateName
• [BREAKING] Changed Account service to use the User model instead of Account
• [BREAKING] Changed createMembership to allow an email, userId or phone

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/7.1.0...8.0.0

What's Changed

• chore: update role helper class by @christyjacob4 in https://github.com/appwrite/sdk-for-ruby/pull/12

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/7.0.0...7.2.0

What's Changed

• chore: update role helper class by @christyjacob4 in https://github.com/appwrite/sdk-for-ruby/pull/12

Full Changelog: https://github.com/appwrite/sdk-for-ruby/compare/7.0.0...7.1.0

NEW

• Support for Appwrite 1.0.0
• More verbose headers have been included in the Clients - x-sdk-name, x-sdk-platform, x-sdk-language, x-sdk-version
• Helper classes and methods for Permissions, Roles and IDs
• Helper methods to suport new queries
• All Dates and times are now returned in the ISO 8601 format
• Execution Model now has an additional stdout attribute
• Endpoint for creating DateTime attribute
• User imports API with support for multiple hashing algorithms
• CRUD API for functions environment variables
• createBucket now supports different compression algorithms

BREAKING CHANGES

• databaseId is no longer part of the Database Service constructor. databaseId will be part of the respective methods of the database service.
• The Users.create() method signature has now been updated to include a phone parameter
• color attribute is no longer supported in the Avatars Service
• The number argument in phone endpoints have been renamed to phone
• List endpoints no longer support limit, offset, cursor, cursorDirection, orderAttributes, orderTypes as they have been moved to the queries array
• read and write permission have been deprecated and they are now included in the permissions array
• Parameter permission for collections and buckets are now renamed to documentSecurity & fileSecurity respectively
• All get prefixed endpoints returning lists have been re-prefixed to list
• Renamed methods of the Query helper
  1. lesser renamed to lessThan
  2. lesserEqual renamed to lessThanEqual
  3. greater renamed to greaterThan
  4. greaterEqual renamed to greaterThanEqual

Full Changelog for Appwrite 1.0.0 can be found here: https://github.com/appwrite/appwrite/blob/master/CHANGES.md

=### NEW

• Support for Appwrite 1.0.0-RC1
• More verbose headers have been included in the Clients - x-sdk-name, x-sdk-platform, x-sdk-language, x-sdk-version
• Helper classes and methods for Permissions, Roles and IDs
• Helper methods to suport new queries
• All Dates and times are now returned in the ISO 8601 format
• Execution Model now has an additional stdout attribute
• Endpoint for creating DateTime attribute
• User imports API with support for multiple hashing algorithms
• CRUD API for functions environment variables
• createBucket now supports different compression algorithms

BREAKING CHANGES

• databaseId is no longer part of the Database Service constructor. databaseId will be part of the respective methods of the database service.
• The Users.create() method signature has now been updated to include a phone parameter
• color attribute is no longer supported in the Avatars Service
• The number argument in phone endpoints have been renamed to phone
• List endpoints no longer support limit, offset, cursor, cursorDirection, orderAttributes, orderTypes as they have been moved to the queries array
• read and write permission have been deprecated and they are now included in the permissions array
• Parameter permission for collections and buckets are now renamed to documentSecurity & fileSecurity respectively
• Renamed methods of the Query helper
  1. lesser renamed to lessThan
  2. lesserEqual renamed to lessThanEqual
  3. greater renamed to greaterThan
  4. greaterEqual renamed to greaterThanEqual

Full Changelog for Appwrite 1.0.0-RC1 can be found here: https://github.com/appwrite/appwrite/blob/master/CHANGES.md

• Support for Appwrite 0.15
• BREAKING Database -> Databases
• BREAKING account.createSession() -> account.createEmailSession()
• BREAKING dateCreated attribute removed from Team, Execution, File models
• BREAKING dateCreated and dateUpdated attribute removed from Func, Deployment, Bucket models

Full Changelog for Appwrite 0.15 can be found here: https://github.com/appwrite/appwrite/blob/master/CHANGES.md#version-0150