@seamapi/types 1.1074.0 → 1.1075.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.
@@ -89064,6 +89064,34 @@ export type Routes = {
89064
89064
  jsonResponse: {};
89065
89065
  maxDuration: undefined;
89066
89066
  };
89067
+ '/seam/webhooks/v1/preview_event': {
89068
+ route: '/seam/webhooks/v1/preview_event';
89069
+ method: 'POST';
89070
+ queryParams: {};
89071
+ jsonBody: {
89072
+ /** Type of the event that you want to preview. */
89073
+ event_type: 'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_expire' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted';
89074
+ /** Event payload fields that you want to set explicitly. Each field that you provide overrides the value that Seam would otherwise fill in. */
89075
+ payload?: {
89076
+ [x: string]: unknown;
89077
+ };
89078
+ };
89079
+ commonParams: {};
89080
+ formData: {};
89081
+ jsonResponse: {
89082
+ /** Event payload that `simulate_event` would send for this event type. */
89083
+ payload: {
89084
+ [x: string]: unknown;
89085
+ };
89086
+ /** Payload fields that Seam set to a real resource in your workspace. */
89087
+ resolved_fields: string[];
89088
+ /** Number of webhooks in your workspace that are subscribed to this event type and would therefore receive this event. If this is `0`, no webhook receives the event. `null` if Seam could not determine the count. */
89089
+ subscribed_webhook_count: number | null;
89090
+ /** Payload fields that Seam set to a placeholder value because your workspace has no matching resource and you did not provide one. */
89091
+ synthesized_fields: string[];
89092
+ };
89093
+ maxDuration: undefined;
89094
+ };
89067
89095
  '/seam/webhooks/v1/simulate_event': {
89068
89096
  route: '/seam/webhooks/v1/simulate_event';
89069
89097
  method: 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1074.0",
3
+ "version": "1.1075.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -65043,6 +65043,216 @@ const openapi: OpenAPISpec = {
65043
65043
  'x-undocumented': 'Internal endpoint for inbound provider webhooks',
65044
65044
  },
65045
65045
  },
65046
+ '/seam/webhooks/v1/preview_event': {
65047
+ post: {
65048
+ description:
65049
+ 'Returns the event payload that `/seam/webhooks/v1/simulate_event` would send for a specified event type, without creating an event or delivering a [webhook](https://docs.seam.co/developer-tools/webhooks). Only applicable within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).\n\nSeam fills in the payload the same way that `simulate_event` does, using real resources from the workspace where it can and placeholder values otherwise, and reports which fields it filled in each way. Provide `payload` to set any field explicitly.',
65050
+ operationId: 'seamWebhooksV1PreviewEventPost',
65051
+ requestBody: {
65052
+ content: {
65053
+ 'application/json': {
65054
+ schema: {
65055
+ properties: {
65056
+ event_type: {
65057
+ description: 'Type of the event that you want to preview.',
65058
+ enum: [
65059
+ 'access_code.created',
65060
+ 'access_code.changed',
65061
+ 'access_code.name_changed',
65062
+ 'access_code.code_changed',
65063
+ 'access_code.time_frame_changed',
65064
+ 'access_code.mutations_requested',
65065
+ 'access_code.scheduled_on_device',
65066
+ 'access_code.set_on_device',
65067
+ 'access_code.removed_from_device',
65068
+ 'access_code.delay_in_setting_on_device',
65069
+ 'access_code.failed_to_set_on_device',
65070
+ 'access_code.issued',
65071
+ 'access_code.delay_in_issuing',
65072
+ 'access_code.failed_to_issue',
65073
+ 'access_code.failed_to_update',
65074
+ 'access_code.failed_to_expire',
65075
+ 'access_code.deleted',
65076
+ 'access_code.delay_in_removing_from_device',
65077
+ 'access_code.failed_to_remove_from_device',
65078
+ 'access_code.modified_external_to_seam',
65079
+ 'access_code.deleted_external_to_seam',
65080
+ 'access_code.backup_access_code_pulled',
65081
+ 'access_code.unmanaged.converted_to_managed',
65082
+ 'access_code.unmanaged.failed_to_convert_to_managed',
65083
+ 'access_code.unmanaged.created',
65084
+ 'access_code.unmanaged.removed',
65085
+ 'access_grant.created',
65086
+ 'access_grant.deleted',
65087
+ 'access_grant.access_granted_to_all_doors',
65088
+ 'access_grant.access_granted_to_door',
65089
+ 'access_grant.access_to_door_lost',
65090
+ 'access_grant.access_times_changed',
65091
+ 'access_grant.could_not_create_requested_access_methods',
65092
+ 'access_method.issued',
65093
+ 'access_method.revoked',
65094
+ 'access_method.card_encoding_required',
65095
+ 'access_method.deleted',
65096
+ 'access_method.reissued',
65097
+ 'access_method.created',
65098
+ 'access_method.delay_in_issuing',
65099
+ 'access_method.failed_to_issue',
65100
+ 'acs_system.connected',
65101
+ 'acs_system.added',
65102
+ 'acs_system.disconnected',
65103
+ 'acs_credential.deleted',
65104
+ 'acs_credential.issued',
65105
+ 'acs_credential.reissued',
65106
+ 'acs_credential.invalidated',
65107
+ 'acs_user.created',
65108
+ 'acs_user.deleted',
65109
+ 'acs_encoder.added',
65110
+ 'acs_encoder.removed',
65111
+ 'acs_access_group.deleted',
65112
+ 'acs_entrance.added',
65113
+ 'acs_entrance.removed',
65114
+ 'client_session.deleted',
65115
+ 'connected_account.connected',
65116
+ 'connected_account.created',
65117
+ 'connected_account.successful_login',
65118
+ 'connected_account.disconnected',
65119
+ 'connected_account.completed_first_sync',
65120
+ 'connected_account.deleted',
65121
+ 'connected_account.completed_first_sync_after_reconnection',
65122
+ 'connected_account.reauthorization_requested',
65123
+ 'action_attempt.lock_door.succeeded',
65124
+ 'action_attempt.lock_door.failed',
65125
+ 'action_attempt.unlock_door.succeeded',
65126
+ 'action_attempt.unlock_door.failed',
65127
+ 'action_attempt.simulate_keypad_code_entry.succeeded',
65128
+ 'action_attempt.simulate_keypad_code_entry.failed',
65129
+ 'action_attempt.simulate_manual_lock_via_keypad.succeeded',
65130
+ 'action_attempt.simulate_manual_lock_via_keypad.failed',
65131
+ 'connect_webview.login_succeeded',
65132
+ 'connect_webview.login_failed',
65133
+ 'device.connected',
65134
+ 'device.added',
65135
+ 'device.converted_to_unmanaged',
65136
+ 'device.unmanaged.converted_to_managed',
65137
+ 'device.unmanaged.connected',
65138
+ 'device.disconnected',
65139
+ 'device.unmanaged.disconnected',
65140
+ 'device.tampered',
65141
+ 'device.low_battery',
65142
+ 'device.battery_status_changed',
65143
+ 'device.removed',
65144
+ 'device.deleted',
65145
+ 'device.third_party_integration_detected',
65146
+ 'device.third_party_integration_no_longer_detected',
65147
+ 'device.salto.privacy_mode_activated',
65148
+ 'device.salto.privacy_mode_deactivated',
65149
+ 'device.connection_became_flaky',
65150
+ 'device.connection_stabilized',
65151
+ 'device.error.subscription_required',
65152
+ 'device.error.subscription_required.resolved',
65153
+ 'device.accessory_keypad_connected',
65154
+ 'device.accessory_keypad_disconnected',
65155
+ 'noise_sensor.noise_threshold_triggered',
65156
+ 'lock.locked',
65157
+ 'lock.unlocked',
65158
+ 'lock.access_denied',
65159
+ 'thermostat.climate_preset_activated',
65160
+ 'thermostat.manually_adjusted',
65161
+ 'thermostat.temperature_threshold_exceeded',
65162
+ 'thermostat.temperature_threshold_no_longer_exceeded',
65163
+ 'thermostat.temperature_reached_set_point',
65164
+ 'thermostat.temperature_changed',
65165
+ 'device.name_changed',
65166
+ 'camera.activated',
65167
+ 'device.doorbell_rang',
65168
+ 'enrollment_automation.deleted',
65169
+ 'phone.deactivated',
65170
+ 'space.device_membership_changed',
65171
+ 'space.created',
65172
+ 'space.deleted',
65173
+ ],
65174
+ type: 'string',
65175
+ },
65176
+ payload: {
65177
+ additionalProperties: {},
65178
+ default: {},
65179
+ description:
65180
+ 'Event payload fields that you want to set explicitly. Each field that you provide overrides the value that Seam would otherwise fill in.',
65181
+ type: 'object',
65182
+ },
65183
+ },
65184
+ required: ['event_type'],
65185
+ type: 'object',
65186
+ },
65187
+ },
65188
+ },
65189
+ },
65190
+ responses: {
65191
+ '200': {
65192
+ content: {
65193
+ 'application/json': {
65194
+ schema: {
65195
+ properties: {
65196
+ ok: { type: 'boolean' },
65197
+ payload: {
65198
+ additionalProperties: {
65199
+ $ref: '#/components/schemas/access_code',
65200
+ },
65201
+ description:
65202
+ 'Event payload that `simulate_event` would send for this event type.',
65203
+ type: 'object',
65204
+ },
65205
+ resolved_fields: {
65206
+ description:
65207
+ 'Payload fields that Seam set to a real resource in your workspace.',
65208
+ items: { type: 'string' },
65209
+ type: 'array',
65210
+ },
65211
+ subscribed_webhook_count: {
65212
+ description:
65213
+ 'Number of webhooks in your workspace that are subscribed to this event type and would therefore receive this event. If this is `0`, no webhook receives the event. `null` if Seam could not determine the count.',
65214
+ format: 'float',
65215
+ nullable: true,
65216
+ type: 'number',
65217
+ },
65218
+ synthesized_fields: {
65219
+ description:
65220
+ 'Payload fields that Seam set to a placeholder value because your workspace has no matching resource and you did not provide one.',
65221
+ items: { type: 'string' },
65222
+ type: 'array',
65223
+ },
65224
+ },
65225
+ required: [
65226
+ 'payload',
65227
+ 'resolved_fields',
65228
+ 'subscribed_webhook_count',
65229
+ 'synthesized_fields',
65230
+ 'ok',
65231
+ ],
65232
+ type: 'object',
65233
+ },
65234
+ },
65235
+ },
65236
+ description: 'OK',
65237
+ },
65238
+ '400': { description: 'Bad Request' },
65239
+ '401': { description: 'Unauthorized' },
65240
+ },
65241
+ security: [
65242
+ { api_key: [] },
65243
+ { pat_with_workspace: [] },
65244
+ { console_session_with_workspace: [] },
65245
+ ],
65246
+ summary: '/seam/webhooks/v1/preview_event',
65247
+ tags: ['/webhooks'],
65248
+ 'x-fern-sdk-group-name': ['seam', 'webhooks', 'v1'],
65249
+ 'x-fern-sdk-method-name': 'preview_event',
65250
+ 'x-response-key': null,
65251
+ 'x-title': 'Preview a Simulated Event',
65252
+ 'x-undocumented':
65253
+ 'Unreleased. Seam Wizard and internal webhook testing only.',
65254
+ },
65255
+ },
65046
65256
  '/seam/webhooks/v1/simulate_event': {
65047
65257
  post: {
65048
65258
  description:
@@ -106798,6 +106798,148 @@ export type Routes = {
106798
106798
  jsonResponse: {}
106799
106799
  maxDuration: undefined
106800
106800
  }
106801
+ '/seam/webhooks/v1/preview_event': {
106802
+ route: '/seam/webhooks/v1/preview_event'
106803
+ method: 'POST'
106804
+ queryParams: {}
106805
+ jsonBody: {
106806
+ /** Type of the event that you want to preview. */
106807
+ event_type:
106808
+ | 'access_code.created'
106809
+ | 'access_code.changed'
106810
+ | 'access_code.name_changed'
106811
+ | 'access_code.code_changed'
106812
+ | 'access_code.time_frame_changed'
106813
+ | 'access_code.mutations_requested'
106814
+ | 'access_code.scheduled_on_device'
106815
+ | 'access_code.set_on_device'
106816
+ | 'access_code.removed_from_device'
106817
+ | 'access_code.delay_in_setting_on_device'
106818
+ | 'access_code.failed_to_set_on_device'
106819
+ | 'access_code.issued'
106820
+ | 'access_code.delay_in_issuing'
106821
+ | 'access_code.failed_to_issue'
106822
+ | 'access_code.failed_to_update'
106823
+ | 'access_code.failed_to_expire'
106824
+ | 'access_code.deleted'
106825
+ | 'access_code.delay_in_removing_from_device'
106826
+ | 'access_code.failed_to_remove_from_device'
106827
+ | 'access_code.modified_external_to_seam'
106828
+ | 'access_code.deleted_external_to_seam'
106829
+ | 'access_code.backup_access_code_pulled'
106830
+ | 'access_code.unmanaged.converted_to_managed'
106831
+ | 'access_code.unmanaged.failed_to_convert_to_managed'
106832
+ | 'access_code.unmanaged.created'
106833
+ | 'access_code.unmanaged.removed'
106834
+ | 'access_grant.created'
106835
+ | 'access_grant.deleted'
106836
+ | 'access_grant.access_granted_to_all_doors'
106837
+ | 'access_grant.access_granted_to_door'
106838
+ | 'access_grant.access_to_door_lost'
106839
+ | 'access_grant.access_times_changed'
106840
+ | 'access_grant.could_not_create_requested_access_methods'
106841
+ | 'access_method.issued'
106842
+ | 'access_method.revoked'
106843
+ | 'access_method.card_encoding_required'
106844
+ | 'access_method.deleted'
106845
+ | 'access_method.reissued'
106846
+ | 'access_method.created'
106847
+ | 'access_method.delay_in_issuing'
106848
+ | 'access_method.failed_to_issue'
106849
+ | 'acs_system.connected'
106850
+ | 'acs_system.added'
106851
+ | 'acs_system.disconnected'
106852
+ | 'acs_credential.deleted'
106853
+ | 'acs_credential.issued'
106854
+ | 'acs_credential.reissued'
106855
+ | 'acs_credential.invalidated'
106856
+ | 'acs_user.created'
106857
+ | 'acs_user.deleted'
106858
+ | 'acs_encoder.added'
106859
+ | 'acs_encoder.removed'
106860
+ | 'acs_access_group.deleted'
106861
+ | 'acs_entrance.added'
106862
+ | 'acs_entrance.removed'
106863
+ | 'client_session.deleted'
106864
+ | 'connected_account.connected'
106865
+ | 'connected_account.created'
106866
+ | 'connected_account.successful_login'
106867
+ | 'connected_account.disconnected'
106868
+ | 'connected_account.completed_first_sync'
106869
+ | 'connected_account.deleted'
106870
+ | 'connected_account.completed_first_sync_after_reconnection'
106871
+ | 'connected_account.reauthorization_requested'
106872
+ | 'action_attempt.lock_door.succeeded'
106873
+ | 'action_attempt.lock_door.failed'
106874
+ | 'action_attempt.unlock_door.succeeded'
106875
+ | 'action_attempt.unlock_door.failed'
106876
+ | 'action_attempt.simulate_keypad_code_entry.succeeded'
106877
+ | 'action_attempt.simulate_keypad_code_entry.failed'
106878
+ | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
106879
+ | 'action_attempt.simulate_manual_lock_via_keypad.failed'
106880
+ | 'connect_webview.login_succeeded'
106881
+ | 'connect_webview.login_failed'
106882
+ | 'device.connected'
106883
+ | 'device.added'
106884
+ | 'device.converted_to_unmanaged'
106885
+ | 'device.unmanaged.converted_to_managed'
106886
+ | 'device.unmanaged.connected'
106887
+ | 'device.disconnected'
106888
+ | 'device.unmanaged.disconnected'
106889
+ | 'device.tampered'
106890
+ | 'device.low_battery'
106891
+ | 'device.battery_status_changed'
106892
+ | 'device.removed'
106893
+ | 'device.deleted'
106894
+ | 'device.third_party_integration_detected'
106895
+ | 'device.third_party_integration_no_longer_detected'
106896
+ | 'device.salto.privacy_mode_activated'
106897
+ | 'device.salto.privacy_mode_deactivated'
106898
+ | 'device.connection_became_flaky'
106899
+ | 'device.connection_stabilized'
106900
+ | 'device.error.subscription_required'
106901
+ | 'device.error.subscription_required.resolved'
106902
+ | 'device.accessory_keypad_connected'
106903
+ | 'device.accessory_keypad_disconnected'
106904
+ | 'noise_sensor.noise_threshold_triggered'
106905
+ | 'lock.locked'
106906
+ | 'lock.unlocked'
106907
+ | 'lock.access_denied'
106908
+ | 'thermostat.climate_preset_activated'
106909
+ | 'thermostat.manually_adjusted'
106910
+ | 'thermostat.temperature_threshold_exceeded'
106911
+ | 'thermostat.temperature_threshold_no_longer_exceeded'
106912
+ | 'thermostat.temperature_reached_set_point'
106913
+ | 'thermostat.temperature_changed'
106914
+ | 'device.name_changed'
106915
+ | 'camera.activated'
106916
+ | 'device.doorbell_rang'
106917
+ | 'enrollment_automation.deleted'
106918
+ | 'phone.deactivated'
106919
+ | 'space.device_membership_changed'
106920
+ | 'space.created'
106921
+ | 'space.deleted'
106922
+ /** Event payload fields that you want to set explicitly. Each field that you provide overrides the value that Seam would otherwise fill in. */
106923
+ payload?: {
106924
+ [x: string]: unknown
106925
+ }
106926
+ }
106927
+ commonParams: {}
106928
+ formData: {}
106929
+ jsonResponse: {
106930
+ /** Event payload that `simulate_event` would send for this event type. */
106931
+ payload: {
106932
+ [x: string]: unknown
106933
+ }
106934
+ /** Payload fields that Seam set to a real resource in your workspace. */
106935
+ resolved_fields: string[]
106936
+ /** Number of webhooks in your workspace that are subscribed to this event type and would therefore receive this event. If this is `0`, no webhook receives the event. `null` if Seam could not determine the count. */
106937
+ subscribed_webhook_count: number | null
106938
+ /** Payload fields that Seam set to a placeholder value because your workspace has no matching resource and you did not provide one. */
106939
+ synthesized_fields: string[]
106940
+ }
106941
+ maxDuration: undefined
106942
+ }
106801
106943
  '/seam/webhooks/v1/simulate_event': {
106802
106944
  route: '/seam/webhooks/v1/simulate_event'
106803
106945
  method: 'POST'