seam 2.164.0 → 2.166.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -169,8 +169,10 @@ module Seam
169
169
  # Device whose access code could not be revoked.
170
170
  # @return [String]
171
171
  attr_accessor :device_id
172
- # Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
172
+ # Reason the access code could not be revoked.
173
173
  # @return [String]
174
+ # Known values:
175
+ # - `offline_access_code_not_revocable`
174
176
  attr_accessor :error_code
175
177
  # Human-readable description of why revocation failed.
176
178
  # @return [String]
@@ -211,10 +213,13 @@ module Seam
211
213
  date_accessor :created_at
212
214
  end
213
215
 
214
- # Indicates that the requested PIN code was already in use on a device, so a different code was assigned.
216
+ # Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
215
217
  class RequestedCodeUnavailable < Warnings
216
- # ID of the device where the requested code was unavailable.
217
- # @return [String]
218
+ # ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
219
+ # @return [String, nil]
220
+ attr_accessor :access_method_id
221
+ # ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
222
+ # @return [String, nil]
218
223
  attr_accessor :device_id
219
224
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
220
225
  # @return [String]
@@ -189,6 +189,27 @@ module Seam
189
189
  date_accessor :created_at
190
190
  end
191
191
 
192
+ # Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
193
+ class RequestedCodeUnavailable < Warnings
194
+ # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
195
+ # @return [String]
196
+ attr_accessor :message
197
+ # The PIN code that was assigned instead.
198
+ # @return [String]
199
+ attr_accessor :new_code
200
+ # The originally requested PIN code that could not be used.
201
+ # @return [String]
202
+ attr_accessor :original_code
203
+ # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
204
+ # @return [String]
205
+ # Known values:
206
+ # - `requested_code_unavailable`
207
+ attr_accessor :warning_code
208
+ # Date and time at which Seam created the warning.
209
+ # @return [Time]
210
+ date_accessor :created_at
211
+ end
212
+
192
213
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
193
214
  # @return [String]
194
215
  attr_accessor :message
@@ -201,6 +222,7 @@ module Seam
201
222
  # - `delay_in_issuing`
202
223
  # - `user_identity_missing_email_address`
203
224
  # - `user_identity_missing_phone_number`
225
+ # - `requested_code_unavailable`
204
226
  attr_accessor :warning_code
205
227
  # Date and time at which Seam created the warning.
206
228
  # @return [Time]
@@ -212,7 +234,8 @@ module Seam
212
234
  "pulled_backup_access_code" => PulledBackupAccessCode,
213
235
  "delay_in_issuing" => DelayInIssuing,
214
236
  "user_identity_missing_email_address" => UserIdentityMissingEmailAddress,
215
- "user_identity_missing_phone_number" => UserIdentityMissingPhoneNumber
237
+ "user_identity_missing_phone_number" => UserIdentityMissingPhoneNumber,
238
+ "requested_code_unavailable" => RequestedCodeUnavailable
216
239
  }.freeze
217
240
  end
218
241
 
@@ -249,7 +272,7 @@ module Seam
249
272
  # Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
250
273
  # @return [Boolean, nil]
251
274
  attr_accessor :is_ready_for_assignment
252
- # Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
275
+ # Indicates whether the access method is ready to be encoded. This is true when the card has not yet been issued and the access system has received all the access the card needs. While it is false, `pending_mutations` contains `waiting_for_access_on_acs_system`.
253
276
  # @return [Boolean, nil]
254
277
  attr_accessor :is_ready_for_encoding
255
278
  # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
@@ -949,6 +949,15 @@ module Seam
949
949
  # Indicates whether the thermostat supports simultaneous heating and cooling.
950
950
  # @return [Boolean, nil]
951
951
  attr_accessor :can_hvac_heat_cool
952
+ # Indicates whether the speaker supports muting and unmuting.
953
+ # @return [Boolean, nil]
954
+ attr_accessor :can_mute_speaker
955
+ # Indicates whether the speaker supports pausing and resuming playback.
956
+ # @return [Boolean, nil]
957
+ attr_accessor :can_pause_speaker_playback
958
+ # Indicates whether the speaker supports playing a chime.
959
+ # @return [Boolean, nil]
960
+ attr_accessor :can_play_speaker_chime
952
961
  # Indicates whether the device supports programming offline access codes.
953
962
  # @return [Boolean, nil]
954
963
  attr_accessor :can_program_offline_access_codes
@@ -973,6 +982,9 @@ module Seam
973
982
  # Indicates whether the thermostat supports running climate programs.
974
983
  # @return [Boolean, nil]
975
984
  attr_accessor :can_run_thermostat_programs
985
+ # Indicates whether the speaker supports setting its volume.
986
+ # @return [Boolean, nil]
987
+ attr_accessor :can_set_speaker_volume
976
988
  # Indicates whether the device supports simulating connection in a sandbox.
977
989
  # @return [Boolean, nil]
978
990
  attr_accessor :can_simulate_connection
@@ -1068,6 +1080,7 @@ module Seam
1068
1080
  # - `tapo_camera`
1069
1081
  # - `arlo_camera`
1070
1082
  # - `reolink_camera`
1083
+ # - `sonos_speaker`
1071
1084
  attr_accessor :device_type
1072
1085
  # Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
1073
1086
  # @return [String]
@@ -29,6 +29,7 @@ module Seam
29
29
 
30
30
  # Deletes customer data including resources like spaces, properties, rooms, users, etc.
31
31
  # This will delete the partner resources and any related Seam resources (user identities, access grants, spaces).
32
+ # Space keys also match spaces created directly with a `space_key` (for example, through `/spaces/create`).
32
33
  # @param access_grant_keys [Array<String>, nil] List of access grant keys to delete.
33
34
  # @param booking_keys [Array<String>, nil] List of booking keys to delete.
34
35
  # @param building_keys [Array<String>, nil] List of building keys to delete.
@@ -65,6 +66,7 @@ module Seam
65
66
  # @param facilities [Array<Hash>, nil] List of gym or fitness facilities.
66
67
  # @param guests [Array<Hash>, nil] List of guests.
67
68
  # @param listings [Array<Hash>, nil] List of property listings.
69
+ # @param low_battery_alert_threshold [Float, Seam::Null, nil] Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Overrides the workspace and device defaults. Pass `null` to remove the customer's override.
68
70
  # @param properties [Array<Hash>, nil] List of short-term rental properties.
69
71
  # @param property_listings [Array<Hash>, nil] List of property listings.
70
72
  # @param reservations [Array<Hash>, nil] List of reservations.
@@ -78,8 +80,8 @@ module Seam
78
80
  # @param user_identities [Array<Hash>, nil] List of user identities.
79
81
  # @param users [Array<Hash>, nil] List of users.
80
82
  # @return [nil] OK
81
- def push_data(customer_key:, access_grants: nil, bookings: nil, buildings: nil, common_areas: nil, customization_profile_id: nil, facilities: nil, guests: nil, listings: nil, properties: nil, property_listings: nil, reservations: nil, residents: nil, rooms: nil, sites: nil, spaces: nil, staff_members: nil, tenants: nil, units: nil, user_identities: nil, users: nil)
82
- @client.post("/customers/push_data", {customer_key: customer_key, access_grants: access_grants, bookings: bookings, buildings: buildings, common_areas: common_areas, customization_profile_id: customization_profile_id, facilities: facilities, guests: guests, listings: listings, properties: properties, property_listings: property_listings, reservations: reservations, residents: residents, rooms: rooms, sites: sites, spaces: spaces, staff_members: staff_members, tenants: tenants, units: units, user_identities: user_identities, users: users}.compact)
83
+ def push_data(customer_key:, access_grants: nil, bookings: nil, buildings: nil, common_areas: nil, customization_profile_id: nil, facilities: nil, guests: nil, listings: nil, low_battery_alert_threshold: nil, properties: nil, property_listings: nil, reservations: nil, residents: nil, rooms: nil, sites: nil, spaces: nil, staff_members: nil, tenants: nil, units: nil, user_identities: nil, users: nil)
84
+ @client.post("/customers/push_data", {customer_key: customer_key, access_grants: access_grants, bookings: bookings, buildings: buildings, common_areas: common_areas, customization_profile_id: customization_profile_id, facilities: facilities, guests: guests, listings: listings, low_battery_alert_threshold: low_battery_alert_threshold, properties: properties, property_listings: property_listings, reservations: reservations, residents: residents, rooms: rooms, sites: sites, spaces: spaces, staff_members: staff_members, tenants: tenants, units: units, user_identities: user_identities, users: users}.compact)
83
85
 
84
86
  nil
85
87
  end
data/lib/seam/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Seam
4
- VERSION = "2.164.0"
4
+ VERSION = "2.166.0"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: seam
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.164.0
4
+ version: 2.166.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Seam Labs, Inc.