@seamapi/types 1.1073.0 → 1.1074.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.
|
@@ -59709,6 +59709,208 @@ const openapi = {
|
|
|
59709
59709
|
'x-undocumented': 'Internal endpoint for inbound provider webhooks',
|
|
59710
59710
|
},
|
|
59711
59711
|
},
|
|
59712
|
+
'/seam/webhooks/v1/simulate_event': {
|
|
59713
|
+
post: {
|
|
59714
|
+
description: 'Creates an event of a specified type and delivers it to every [webhook](https://docs.seam.co/developer-tools/webhooks) in the workspace that is subscribed to that event type, so that a developer can test their webhook endpoint against any event Seam can send. Only applicable within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).\n\nSeam fills in the event payload, using real resources from the workspace where it can and placeholder values otherwise. Provide `payload` to set any field explicitly.\n\nThis creates a real event and delivers a real webhook, but does not change the state of any device or other resource. For example, simulating a `lock.unlocked` event does not unlock the lock.',
|
|
59715
|
+
operationId: 'seamWebhooksV1SimulateEventPost',
|
|
59716
|
+
requestBody: {
|
|
59717
|
+
content: {
|
|
59718
|
+
'application/json': {
|
|
59719
|
+
schema: {
|
|
59720
|
+
properties: {
|
|
59721
|
+
event_type: {
|
|
59722
|
+
description: 'Type of the event that you want to send to your webhooks.',
|
|
59723
|
+
enum: [
|
|
59724
|
+
'access_code.created',
|
|
59725
|
+
'access_code.changed',
|
|
59726
|
+
'access_code.name_changed',
|
|
59727
|
+
'access_code.code_changed',
|
|
59728
|
+
'access_code.time_frame_changed',
|
|
59729
|
+
'access_code.mutations_requested',
|
|
59730
|
+
'access_code.scheduled_on_device',
|
|
59731
|
+
'access_code.set_on_device',
|
|
59732
|
+
'access_code.removed_from_device',
|
|
59733
|
+
'access_code.delay_in_setting_on_device',
|
|
59734
|
+
'access_code.failed_to_set_on_device',
|
|
59735
|
+
'access_code.issued',
|
|
59736
|
+
'access_code.delay_in_issuing',
|
|
59737
|
+
'access_code.failed_to_issue',
|
|
59738
|
+
'access_code.failed_to_update',
|
|
59739
|
+
'access_code.failed_to_expire',
|
|
59740
|
+
'access_code.deleted',
|
|
59741
|
+
'access_code.delay_in_removing_from_device',
|
|
59742
|
+
'access_code.failed_to_remove_from_device',
|
|
59743
|
+
'access_code.modified_external_to_seam',
|
|
59744
|
+
'access_code.deleted_external_to_seam',
|
|
59745
|
+
'access_code.backup_access_code_pulled',
|
|
59746
|
+
'access_code.unmanaged.converted_to_managed',
|
|
59747
|
+
'access_code.unmanaged.failed_to_convert_to_managed',
|
|
59748
|
+
'access_code.unmanaged.created',
|
|
59749
|
+
'access_code.unmanaged.removed',
|
|
59750
|
+
'access_grant.created',
|
|
59751
|
+
'access_grant.deleted',
|
|
59752
|
+
'access_grant.access_granted_to_all_doors',
|
|
59753
|
+
'access_grant.access_granted_to_door',
|
|
59754
|
+
'access_grant.access_to_door_lost',
|
|
59755
|
+
'access_grant.access_times_changed',
|
|
59756
|
+
'access_grant.could_not_create_requested_access_methods',
|
|
59757
|
+
'access_method.issued',
|
|
59758
|
+
'access_method.revoked',
|
|
59759
|
+
'access_method.card_encoding_required',
|
|
59760
|
+
'access_method.deleted',
|
|
59761
|
+
'access_method.reissued',
|
|
59762
|
+
'access_method.created',
|
|
59763
|
+
'access_method.delay_in_issuing',
|
|
59764
|
+
'access_method.failed_to_issue',
|
|
59765
|
+
'acs_system.connected',
|
|
59766
|
+
'acs_system.added',
|
|
59767
|
+
'acs_system.disconnected',
|
|
59768
|
+
'acs_credential.deleted',
|
|
59769
|
+
'acs_credential.issued',
|
|
59770
|
+
'acs_credential.reissued',
|
|
59771
|
+
'acs_credential.invalidated',
|
|
59772
|
+
'acs_user.created',
|
|
59773
|
+
'acs_user.deleted',
|
|
59774
|
+
'acs_encoder.added',
|
|
59775
|
+
'acs_encoder.removed',
|
|
59776
|
+
'acs_access_group.deleted',
|
|
59777
|
+
'acs_entrance.added',
|
|
59778
|
+
'acs_entrance.removed',
|
|
59779
|
+
'client_session.deleted',
|
|
59780
|
+
'connected_account.connected',
|
|
59781
|
+
'connected_account.created',
|
|
59782
|
+
'connected_account.successful_login',
|
|
59783
|
+
'connected_account.disconnected',
|
|
59784
|
+
'connected_account.completed_first_sync',
|
|
59785
|
+
'connected_account.deleted',
|
|
59786
|
+
'connected_account.completed_first_sync_after_reconnection',
|
|
59787
|
+
'connected_account.reauthorization_requested',
|
|
59788
|
+
'action_attempt.lock_door.succeeded',
|
|
59789
|
+
'action_attempt.lock_door.failed',
|
|
59790
|
+
'action_attempt.unlock_door.succeeded',
|
|
59791
|
+
'action_attempt.unlock_door.failed',
|
|
59792
|
+
'action_attempt.simulate_keypad_code_entry.succeeded',
|
|
59793
|
+
'action_attempt.simulate_keypad_code_entry.failed',
|
|
59794
|
+
'action_attempt.simulate_manual_lock_via_keypad.succeeded',
|
|
59795
|
+
'action_attempt.simulate_manual_lock_via_keypad.failed',
|
|
59796
|
+
'connect_webview.login_succeeded',
|
|
59797
|
+
'connect_webview.login_failed',
|
|
59798
|
+
'device.connected',
|
|
59799
|
+
'device.added',
|
|
59800
|
+
'device.converted_to_unmanaged',
|
|
59801
|
+
'device.unmanaged.converted_to_managed',
|
|
59802
|
+
'device.unmanaged.connected',
|
|
59803
|
+
'device.disconnected',
|
|
59804
|
+
'device.unmanaged.disconnected',
|
|
59805
|
+
'device.tampered',
|
|
59806
|
+
'device.low_battery',
|
|
59807
|
+
'device.battery_status_changed',
|
|
59808
|
+
'device.removed',
|
|
59809
|
+
'device.deleted',
|
|
59810
|
+
'device.third_party_integration_detected',
|
|
59811
|
+
'device.third_party_integration_no_longer_detected',
|
|
59812
|
+
'device.salto.privacy_mode_activated',
|
|
59813
|
+
'device.salto.privacy_mode_deactivated',
|
|
59814
|
+
'device.connection_became_flaky',
|
|
59815
|
+
'device.connection_stabilized',
|
|
59816
|
+
'device.error.subscription_required',
|
|
59817
|
+
'device.error.subscription_required.resolved',
|
|
59818
|
+
'device.accessory_keypad_connected',
|
|
59819
|
+
'device.accessory_keypad_disconnected',
|
|
59820
|
+
'noise_sensor.noise_threshold_triggered',
|
|
59821
|
+
'lock.locked',
|
|
59822
|
+
'lock.unlocked',
|
|
59823
|
+
'lock.access_denied',
|
|
59824
|
+
'thermostat.climate_preset_activated',
|
|
59825
|
+
'thermostat.manually_adjusted',
|
|
59826
|
+
'thermostat.temperature_threshold_exceeded',
|
|
59827
|
+
'thermostat.temperature_threshold_no_longer_exceeded',
|
|
59828
|
+
'thermostat.temperature_reached_set_point',
|
|
59829
|
+
'thermostat.temperature_changed',
|
|
59830
|
+
'device.name_changed',
|
|
59831
|
+
'camera.activated',
|
|
59832
|
+
'device.doorbell_rang',
|
|
59833
|
+
'enrollment_automation.deleted',
|
|
59834
|
+
'phone.deactivated',
|
|
59835
|
+
'space.device_membership_changed',
|
|
59836
|
+
'space.created',
|
|
59837
|
+
'space.deleted',
|
|
59838
|
+
],
|
|
59839
|
+
type: 'string',
|
|
59840
|
+
},
|
|
59841
|
+
payload: {
|
|
59842
|
+
additionalProperties: {},
|
|
59843
|
+
default: {},
|
|
59844
|
+
description: 'Event payload fields that you want to set explicitly. Each field that you provide overrides the value that Seam would otherwise fill in.',
|
|
59845
|
+
type: 'object',
|
|
59846
|
+
},
|
|
59847
|
+
},
|
|
59848
|
+
required: ['event_type'],
|
|
59849
|
+
type: 'object',
|
|
59850
|
+
},
|
|
59851
|
+
},
|
|
59852
|
+
},
|
|
59853
|
+
},
|
|
59854
|
+
responses: {
|
|
59855
|
+
'200': {
|
|
59856
|
+
content: {
|
|
59857
|
+
'application/json': {
|
|
59858
|
+
schema: {
|
|
59859
|
+
properties: {
|
|
59860
|
+
event: { $ref: '#/components/schemas/event' },
|
|
59861
|
+
ok: { type: 'boolean' },
|
|
59862
|
+
simulation: {
|
|
59863
|
+
properties: {
|
|
59864
|
+
resolved_fields: {
|
|
59865
|
+
description: 'Payload fields that Seam set to a real resource in your workspace.',
|
|
59866
|
+
items: { type: 'string' },
|
|
59867
|
+
type: 'array',
|
|
59868
|
+
},
|
|
59869
|
+
subscribed_webhook_count: {
|
|
59870
|
+
description: 'Number of webhooks in your workspace that are subscribed to this event type and therefore receive this event. If this is `0`, no webhook receives the event. `null` if Seam could not determine the count.',
|
|
59871
|
+
format: 'float',
|
|
59872
|
+
nullable: true,
|
|
59873
|
+
type: 'number',
|
|
59874
|
+
},
|
|
59875
|
+
synthesized_fields: {
|
|
59876
|
+
description: 'Payload fields that Seam set to a placeholder value because your workspace has no matching resource and you did not provide one.',
|
|
59877
|
+
items: { type: 'string' },
|
|
59878
|
+
type: 'array',
|
|
59879
|
+
},
|
|
59880
|
+
},
|
|
59881
|
+
required: [
|
|
59882
|
+
'resolved_fields',
|
|
59883
|
+
'subscribed_webhook_count',
|
|
59884
|
+
'synthesized_fields',
|
|
59885
|
+
],
|
|
59886
|
+
type: 'object',
|
|
59887
|
+
},
|
|
59888
|
+
},
|
|
59889
|
+
required: ['event', 'simulation', 'ok'],
|
|
59890
|
+
type: 'object',
|
|
59891
|
+
},
|
|
59892
|
+
},
|
|
59893
|
+
},
|
|
59894
|
+
description: 'OK',
|
|
59895
|
+
},
|
|
59896
|
+
'400': { description: 'Bad Request' },
|
|
59897
|
+
'401': { description: 'Unauthorized' },
|
|
59898
|
+
},
|
|
59899
|
+
security: [
|
|
59900
|
+
{ api_key: [] },
|
|
59901
|
+
{ pat_with_workspace: [] },
|
|
59902
|
+
{ console_session_with_workspace: [] },
|
|
59903
|
+
],
|
|
59904
|
+
summary: '/seam/webhooks/v1/simulate_event',
|
|
59905
|
+
tags: ['/webhooks'],
|
|
59906
|
+
'x-fern-sdk-group-name': ['seam', 'webhooks', 'v1'],
|
|
59907
|
+
'x-fern-sdk-method-name': 'simulate_event',
|
|
59908
|
+
'x-fern-sdk-return-value': 'event',
|
|
59909
|
+
'x-response-key': 'event',
|
|
59910
|
+
'x-title': 'Simulate Sending an Event to a Webhook',
|
|
59911
|
+
'x-undocumented': 'Unreleased. Seam Wizard and internal webhook testing only.',
|
|
59912
|
+
},
|
|
59913
|
+
},
|
|
59712
59914
|
'/seam/wizard/v1/session': {
|
|
59713
59915
|
post: {
|
|
59714
59916
|
description: "Exchanges a Seam API key for a short-lived wizard inference token. The Seam\nWizard CLI calls this once, then sends the returned token as the bearer to the\ninference proxy. The session also carries the workspace org's Console-collected\nonboarding answers (or null) so the CLI can pre-fill its integration plan.",
|