New Ruby SDK

New Ruby SDK

This week, we’re excited to continue our new SDK releases with the official announcement of our new Ruby SDK!

Like the other new Seam SDKs that we’ve released recently, the new Ruby SDK is generated automatically on a daily basis to ensure that methods and types are always up-to-date with the latest API changes. Our new Ruby SDK streamlines dependencies and standardizes the core interfaces to match our JavaScript and other SDKs closely. This means that if your organization uses multiple programming languages, you can expect the same familiar features—like the Seam::Webhook handler and wait_for_action_attempt option—no matter which SDK you need.

By auto-generating and aligning our SDKs, we make sure that using the Seam SDKs is always the best developer experience for integrating with Seam.

We encourage you to install the new Seam Ruby SDK right away. Use the following command to add the Seam Ruby SDK as a dependency to your project using Bundler:

ShellCopy
1bundle add seam

If you’re running the original Seam Ruby SDK (that is, the seamapi gem instead of the new seam gem), see our migration guide. seam is mostly a drop-in replacement for seamapi, but some method signatures and options have changed to improve overall consistency with the Seam API.

2024.11.15 Changelog

New

• Akiles integration: We are thrilled to promote our Akiles integration from the previous preview stage to a stable release! For details, see our Get started with Akiles locks guide.

Changed

• Deprecate /devices/delete: We have now deprecated /devices/delete, and we plan to remove this endpoint in the near future. Migrate away from using this endpoint. Instead, unmanage devices.

  If you want a way to mark unmanaged devices as "deleted" in you app, we recommend setting device.custom_metadata.

  We plan to bring back /devices/delete in the future, but the behavior will be different. Consequently, to avoid unexpected changes in you app’s behavior, we will remove this endpoint and then reintroduce it later. In this way, we can ensure that no customers rely on the current behavior. We are monitoring the use of /devices/delete and will reach out directly to any workspace owners that are actively using this endpoint. In addition, we plan to provide advanced notice once we have set a date for the removal of /devices/delete.

  Note that Seam will continue to emit device.deleted events when devices are deleted due to the deletion of the associated connected_account.

  If you have any questions, contact us.

• Improved validation consistency for thermostats in Seam Console: We have made field validation more visually consistent across the thermostat pages in Seam Console.

• Deprecate climate preset manual_override_allowed property: We are in the process of migrating the manual_override_allowed property from climate presets to thermostat_schedule.is_override_allowed. As an intermediary step, we have made this manual_override_allowed property optional on climate presets, and it defaults to true. Because we have deprecated manual_override_allowed property on climate presets, we recommend omitting this property from all climate preset requests.