Update Ruby constructors and requires

seamapi · Nov 15, 2024 · 892be65 · 892be65
1 parent 94987da
commit 892be65
Show file tree

Hide file tree

Showing 24 changed files with 29 additions and 29 deletions.
diff --git a/docs/api-clients/authentication.md b/docs/api-clients/authentication.md
@@ -101,7 +101,7 @@ checkAuth();
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 workspace = seam.workspaces.get()
 

diff --git a/docs/api-clients/locks/get.md b/docs/api-clients/locks/get.md
@@ -181,7 +181,7 @@ console.log(device)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 device_id = "123e4567-e89b-12d3-a456-426614174000"
 
 device = seam.locks.get(device_id)

diff --git a/docs/core-concepts/authentication/api-keys.md b/docs/core-concepts/authentication/api-keys.md
@@ -144,7 +144,7 @@ checkAuth();
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 workspace = seam.workspaces.get()
 

diff --git a/docs/core-concepts/authentication/personal-access-tokens.md b/docs/core-concepts/authentication/personal-access-tokens.md
@@ -73,7 +73,7 @@ console.log(await seam.devices.list())
 
 {% tab title="Ruby" %}
 ```ruby
-client = Seam::Client.new(
+client = Seam.new(
   # Specify PAT.
   api_key: pat,
   # Specify workspace ID.

diff --git a/docs/core-concepts/devices/managed-and-unmanaged-devices.md b/docs/core-concepts/devices/managed-and-unmanaged-devices.md
@@ -104,7 +104,7 @@ print(unmanaged_device)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new()
+seam = Seam.new()
 device_id = "aa3958c3-4236-4f71-bd77-3b60f85b3456"
 
 seam.devices.update(device_id: device_id, is_managed: false)
@@ -290,7 +290,7 @@ print(device)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new()
+seam = Seam.new()
 device_id = "aa3958c3-4236-4f71-bd77-3b60f85b3456"
 seam.unmanaged_devices.update(device_id: device_id, is_managed: true)
 

diff --git a/...e-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md b/...e-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md
@@ -224,7 +224,7 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 connect_webview = seam.connect_webviews.create(
   accepted_providers: ["four_suites"]

diff --git a/...ice-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md b/...ice-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md
@@ -224,7 +224,7 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 connect_webview = seam.connect_webviews.create(
   accepted_providers: ["akiles"]

diff --git a/docs/device-guides/get-started-with-2n-intercoms.md b/docs/device-guides/get-started-with-2n-intercoms.md
@@ -141,7 +141,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["my_2n"]

diff --git a/docs/device-guides/get-started-with-august-locks.md b/docs/device-guides/get-started-with-august-locks.md
@@ -224,7 +224,7 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 connect_webview = seam.connect_webviews.create(
   accepted_providers: ["august"]

diff --git a/docs/device-guides/get-started-with-controlbyweb-devices.md b/docs/device-guides/get-started-with-controlbyweb-devices.md
@@ -134,7 +134,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["controlbyweb"]

diff --git a/docs/device-guides/get-started-with-dormakaba-oracode-locks.md b/docs/device-guides/get-started-with-dormakaba-oracode-locks.md
@@ -140,9 +140,9 @@ console.log(connectWebview.url)
 
 {% tab title="Ruby" %}
 ```ruby
-require 'seamapi'
+require 'seam'
 
-seam = Seam::Client.new(api_key: 'MY_API_KEY')
+seam = Seam.new(api_key: 'MY_API_KEY')
 
 webview = seam.connect_webviews.create(accepted_providers: %w[dormakaba_oracode])
 

diff --git a/docs/device-guides/get-started-with-igloo-locks.md b/docs/device-guides/get-started-with-igloo-locks.md
@@ -132,9 +132,9 @@ console.log(connectWebview.url)
 
 {% tab title="Ruby" %}
 ```ruby
-require 'seamapi'
+require 'seam'
 
-seam = Seam::Client.new(api_key: 'MY_API_KEY')
+seam = Seam.new(api_key: 'MY_API_KEY')
 
 webview = seam.connect_webviews.create(accepted_providers: %w[igloohome])
 

diff --git a/docs/device-guides/get-started-with-kwikset-wifi-locks.md b/docs/device-guides/get-started-with-kwikset-wifi-locks.md
@@ -144,7 +144,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["kwikset"]

diff --git a/docs/device-guides/get-started-with-minut-sensors.md b/docs/device-guides/get-started-with-minut-sensors.md
@@ -129,7 +129,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["minut"]

diff --git a/docs/device-guides/get-started-with-noiseaware-sensors.md b/docs/device-guides/get-started-with-noiseaware-sensors.md
@@ -135,7 +135,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["noiseaware"]

diff --git a/docs/device-guides/get-started-with-salto-locks.md b/docs/device-guides/get-started-with-salto-locks.md
@@ -134,9 +134,9 @@ console.log(connectWebview.url)
 
 {% tab title="Ruby" %}
 ```ruby
-require 'seamapi'
+require 'seam'
 
-seam = Seam::Client.new(api_key: 'MY_API_KEY')
+seam = Seam.new(api_key: 'MY_API_KEY')
 
 webview = seam.connect_webviews.create(accepted_providers: %w[salto])
 

diff --git a/docs/device-guides/get-started-with-schlage-locks.md b/docs/device-guides/get-started-with-schlage-locks.md
@@ -136,7 +136,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["schlage"]

diff --git a/docs/device-guides/get-started-with-smartlocks-api.md b/docs/device-guides/get-started-with-smartlocks-api.md
@@ -142,7 +142,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   provider_category: "stable"

diff --git a/docs/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md
@@ -138,7 +138,7 @@ console.log(webview)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["smartthings"]

diff --git a/docs/device-guides/get-started-with-ttlock-devices.md b/docs/device-guides/get-started-with-ttlock-devices.md
@@ -224,7 +224,7 @@ https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-12
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 connect_webview = seam.connect_webviews.create(
   accepted_providers: ["ttlock"]

diff --git a/docs/device-guides/get-started-with-wyze-locks.md b/docs/device-guides/get-started-with-wyze-locks.md
@@ -152,9 +152,9 @@ console.log(connectWebview.url);
 
 {% tab title="Ruby" %}
 ```ruby
-require 'seamapi'
+require 'seam'
 
-seam = Seam::Client.new(api_key: 'MY_API_KEY')
+seam = Seam.new(api_key: 'MY_API_KEY')
 
 webview = seam.connect_webviews.create(accepted_providers: %w[wyze])
 

diff --git a/docs/device-guides/get-started-with-yale-locks.md b/docs/device-guides/get-started-with-yale-locks.md
@@ -140,7 +140,7 @@ console.log(connectWebview.url)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 webview = seam.connect_webviews.create(
   accepted_providers: ["yale"]

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -265,7 +265,7 @@ if (frontDoor.can_remotely_unlock) {
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new() # Seam automatically uses your exported SEAM_API_KEY.
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
 
 # Retrieve all devices, filtered by manufacturer,
 # which is one of several filters that list() supports.

diff --git a/docs/quickstart/authentication.md b/docs/quickstart/authentication.md
@@ -66,7 +66,7 @@ print(workspace)
 ```ruby
 require "seamapi"
 
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
 
 workspace = seam.workspaces.get