@seamapi/types 1.419.0 → 1.420.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.
- package/dist/connect.cjs +188 -1
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +276 -2
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +6 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +10 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/events/access-grants.d.ts +0 -2
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/access-methods.d.ts +47 -0
- package/lib/seam/connect/models/events/access-methods.js +9 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +24 -1
- package/lib/seam/connect/openapi.d.ts +181 -0
- package/lib/seam/connect/openapi.js +178 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +66 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +10 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +0 -6
- package/src/lib/seam/connect/models/events/access-methods.ts +10 -0
- package/src/lib/seam/connect/openapi.ts +183 -0
- package/src/lib/seam/connect/route-types.ts +68 -0
|
@@ -10184,6 +10184,10 @@ export interface Routes {
|
|
|
10184
10184
|
display_name: string;
|
|
10185
10185
|
/** Date and time at which the access grant was created. */
|
|
10186
10186
|
created_at: string;
|
|
10187
|
+
/** Date and time at which the access grant starts. */
|
|
10188
|
+
starts_at?: string | undefined;
|
|
10189
|
+
/** Date and time at which the access grant ends. */
|
|
10190
|
+
ends_at?: string | undefined;
|
|
10187
10191
|
};
|
|
10188
10192
|
};
|
|
10189
10193
|
};
|
|
@@ -10240,6 +10244,10 @@ export interface Routes {
|
|
|
10240
10244
|
display_name: string;
|
|
10241
10245
|
/** Date and time at which the access grant was created. */
|
|
10242
10246
|
created_at: string;
|
|
10247
|
+
/** Date and time at which the access grant starts. */
|
|
10248
|
+
starts_at?: string | undefined;
|
|
10249
|
+
/** Date and time at which the access grant ends. */
|
|
10250
|
+
ends_at?: string | undefined;
|
|
10243
10251
|
};
|
|
10244
10252
|
};
|
|
10245
10253
|
};
|
|
@@ -10292,9 +10300,29 @@ export interface Routes {
|
|
|
10292
10300
|
display_name: string;
|
|
10293
10301
|
/** Date and time at which the access grant was created. */
|
|
10294
10302
|
created_at: string;
|
|
10303
|
+
/** Date and time at which the access grant starts. */
|
|
10304
|
+
starts_at?: string | undefined;
|
|
10305
|
+
/** Date and time at which the access grant ends. */
|
|
10306
|
+
ends_at?: string | undefined;
|
|
10295
10307
|
}>;
|
|
10296
10308
|
};
|
|
10297
10309
|
};
|
|
10310
|
+
'/access_grants/update': {
|
|
10311
|
+
route: '/access_grants/update';
|
|
10312
|
+
method: 'POST' | 'PATCH';
|
|
10313
|
+
queryParams: {};
|
|
10314
|
+
jsonBody: {};
|
|
10315
|
+
commonParams: {
|
|
10316
|
+
/** ID of the access grant to update. */
|
|
10317
|
+
access_grant_id: string;
|
|
10318
|
+
/** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
10319
|
+
starts_at?: (string | null) | undefined;
|
|
10320
|
+
/** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
10321
|
+
ends_at?: (string | null) | undefined;
|
|
10322
|
+
};
|
|
10323
|
+
formData: {};
|
|
10324
|
+
jsonResponse: {};
|
|
10325
|
+
};
|
|
10298
10326
|
'/access_methods/delete': {
|
|
10299
10327
|
route: '/access_methods/delete';
|
|
10300
10328
|
method: 'GET' | 'POST';
|
|
@@ -26109,6 +26137,18 @@ export interface Routes {
|
|
|
26109
26137
|
created_at: string;
|
|
26110
26138
|
/** Date and time at which the event occurred. */
|
|
26111
26139
|
occurred_at: string;
|
|
26140
|
+
/** ID of the affected access method. */
|
|
26141
|
+
access_method_id: string;
|
|
26142
|
+
event_type: 'access_method.reissued';
|
|
26143
|
+
} | {
|
|
26144
|
+
/** ID of the event. */
|
|
26145
|
+
event_id: string;
|
|
26146
|
+
/** ID of the workspace associated with the event. */
|
|
26147
|
+
workspace_id: string;
|
|
26148
|
+
/** Date and time at which the event was created. */
|
|
26149
|
+
created_at: string;
|
|
26150
|
+
/** Date and time at which the event occurred. */
|
|
26151
|
+
occurred_at: string;
|
|
26112
26152
|
/** ID of the connected account. */
|
|
26113
26153
|
connected_account_id?: string | undefined;
|
|
26114
26154
|
/** ID of the access system. */
|
|
@@ -27115,9 +27155,9 @@ export interface Routes {
|
|
|
27115
27155
|
/** IDs of the access codes for which you want to list events. */
|
|
27116
27156
|
access_code_ids?: string[] | undefined;
|
|
27117
27157
|
/** Type of the events that you want to list. */
|
|
27118
|
-
event_type?: ('access_code.created' | 'access_code.changed' | '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.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | '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' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.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' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
|
|
27158
|
+
event_type?: ('access_code.created' | 'access_code.changed' | '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.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.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' | 'enrollment_automation.deleted' | 'phone.deactivated') | undefined;
|
|
27119
27159
|
/** Types of the events that you want to list. */
|
|
27120
|
-
event_types?: Array<'access_code.created' | 'access_code.changed' | '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.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | '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' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.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' | 'enrollment_automation.deleted' | 'phone.deactivated'> | undefined;
|
|
27160
|
+
event_types?: Array<'access_code.created' | 'access_code.changed' | '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.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.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' | 'enrollment_automation.deleted' | 'phone.deactivated'> | undefined;
|
|
27121
27161
|
/** ID of the connected account for which you want to list events. */
|
|
27122
27162
|
connected_account_id?: string | undefined;
|
|
27123
27163
|
/** IDs of the connected accounts for which you want to list events. */
|
|
@@ -27531,6 +27571,18 @@ export interface Routes {
|
|
|
27531
27571
|
created_at: string;
|
|
27532
27572
|
/** Date and time at which the event occurred. */
|
|
27533
27573
|
occurred_at: string;
|
|
27574
|
+
/** ID of the affected access method. */
|
|
27575
|
+
access_method_id: string;
|
|
27576
|
+
event_type: 'access_method.reissued';
|
|
27577
|
+
} | {
|
|
27578
|
+
/** ID of the event. */
|
|
27579
|
+
event_id: string;
|
|
27580
|
+
/** ID of the workspace associated with the event. */
|
|
27581
|
+
workspace_id: string;
|
|
27582
|
+
/** Date and time at which the event was created. */
|
|
27583
|
+
created_at: string;
|
|
27584
|
+
/** Date and time at which the event occurred. */
|
|
27585
|
+
occurred_at: string;
|
|
27534
27586
|
/** ID of the connected account. */
|
|
27535
27587
|
connected_account_id?: string | undefined;
|
|
27536
27588
|
/** ID of the access system. */
|
|
@@ -61616,6 +61668,10 @@ export interface Routes {
|
|
|
61616
61668
|
display_name: string;
|
|
61617
61669
|
/** Date and time at which the access grant was created. */
|
|
61618
61670
|
created_at: string;
|
|
61671
|
+
/** Date and time at which the access grant starts. */
|
|
61672
|
+
starts_at?: string | undefined;
|
|
61673
|
+
/** Date and time at which the access grant ends. */
|
|
61674
|
+
ends_at?: string | undefined;
|
|
61619
61675
|
};
|
|
61620
61676
|
};
|
|
61621
61677
|
};
|
|
@@ -61672,6 +61728,10 @@ export interface Routes {
|
|
|
61672
61728
|
display_name: string;
|
|
61673
61729
|
/** Date and time at which the access grant was created. */
|
|
61674
61730
|
created_at: string;
|
|
61731
|
+
/** Date and time at which the access grant starts. */
|
|
61732
|
+
starts_at?: string | undefined;
|
|
61733
|
+
/** Date and time at which the access grant ends. */
|
|
61734
|
+
ends_at?: string | undefined;
|
|
61675
61735
|
};
|
|
61676
61736
|
};
|
|
61677
61737
|
};
|
|
@@ -61724,6 +61784,10 @@ export interface Routes {
|
|
|
61724
61784
|
display_name: string;
|
|
61725
61785
|
/** Date and time at which the access grant was created. */
|
|
61726
61786
|
created_at: string;
|
|
61787
|
+
/** Date and time at which the access grant starts. */
|
|
61788
|
+
starts_at?: string | undefined;
|
|
61789
|
+
/** Date and time at which the access grant ends. */
|
|
61790
|
+
ends_at?: string | undefined;
|
|
61727
61791
|
}>;
|
|
61728
61792
|
};
|
|
61729
61793
|
};
|
package/package.json
CHANGED
|
@@ -31,6 +31,16 @@ export const access_grant = z.object({
|
|
|
31
31
|
.string()
|
|
32
32
|
.datetime()
|
|
33
33
|
.describe('Date and time at which the access grant was created.'),
|
|
34
|
+
starts_at: z
|
|
35
|
+
.string()
|
|
36
|
+
.datetime()
|
|
37
|
+
.optional()
|
|
38
|
+
.describe('Date and time at which the access grant starts.'),
|
|
39
|
+
ends_at: z
|
|
40
|
+
.string()
|
|
41
|
+
.datetime()
|
|
42
|
+
.optional()
|
|
43
|
+
.describe('Date and time at which the access grant ends.'),
|
|
34
44
|
}).describe(`
|
|
35
45
|
---
|
|
36
46
|
draft: Early access.
|
|
@@ -18,8 +18,6 @@ export const access_grant_created_event = access_grant_event.extend({
|
|
|
18
18
|
An access grant was created.
|
|
19
19
|
`)
|
|
20
20
|
|
|
21
|
-
export type AccessGrantCreatedEvent = z.infer<typeof access_grant_created_event>
|
|
22
|
-
|
|
23
21
|
export const access_grant_deleted_event = access_grant_event.extend({
|
|
24
22
|
event_type: z.literal('access_grant.deleted'),
|
|
25
23
|
}).describe(`
|
|
@@ -29,10 +27,6 @@ export const access_grant_deleted_event = access_grant_event.extend({
|
|
|
29
27
|
An access grant was deleted.
|
|
30
28
|
`)
|
|
31
29
|
|
|
32
|
-
export type AccessGrantDeleteddEvent = z.infer<
|
|
33
|
-
typeof access_grant_deleted_event
|
|
34
|
-
>
|
|
35
|
-
|
|
36
30
|
export const access_grant_access_granted_to_all_doors_event =
|
|
37
31
|
access_grant_event.extend({
|
|
38
32
|
event_type: z.literal('access_grant.access_granted_to_all_doors'),
|
|
@@ -52,6 +52,15 @@ export const access_method_deleted_event = access_method_event.extend({
|
|
|
52
52
|
An access method was deleted.
|
|
53
53
|
`)
|
|
54
54
|
|
|
55
|
+
export const access_method_reissued_event = access_method_event.extend({
|
|
56
|
+
event_type: z.literal('access_method.reissued'),
|
|
57
|
+
}).describe(`
|
|
58
|
+
---
|
|
59
|
+
route_path: /access_methods
|
|
60
|
+
---
|
|
61
|
+
An access method was reissued due to an access grant update.
|
|
62
|
+
`)
|
|
63
|
+
|
|
55
64
|
export type AccessMethodRevokedEvent = z.infer<
|
|
56
65
|
typeof access_method_revoked_event
|
|
57
66
|
>
|
|
@@ -61,4 +70,5 @@ export const access_method_events = [
|
|
|
61
70
|
access_method_revoked_event,
|
|
62
71
|
access_method_card_encoding_required_event,
|
|
63
72
|
access_method_deleted_event,
|
|
73
|
+
access_method_reissued_event,
|
|
64
74
|
] as const
|
|
@@ -1837,6 +1837,11 @@ export default {
|
|
|
1837
1837
|
description: 'Display name of the access grant.',
|
|
1838
1838
|
type: 'string',
|
|
1839
1839
|
},
|
|
1840
|
+
ends_at: {
|
|
1841
|
+
description: 'Date and time at which the access grant ends.',
|
|
1842
|
+
format: 'date-time',
|
|
1843
|
+
type: 'string',
|
|
1844
|
+
},
|
|
1840
1845
|
location_ids: {
|
|
1841
1846
|
deprecated: true,
|
|
1842
1847
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -1887,6 +1892,11 @@ export default {
|
|
|
1887
1892
|
items: { format: 'uuid', type: 'string' },
|
|
1888
1893
|
type: 'array',
|
|
1889
1894
|
},
|
|
1895
|
+
starts_at: {
|
|
1896
|
+
description: 'Date and time at which the access grant starts.',
|
|
1897
|
+
format: 'date-time',
|
|
1898
|
+
type: 'string',
|
|
1899
|
+
},
|
|
1890
1900
|
user_identity_id: {
|
|
1891
1901
|
description:
|
|
1892
1902
|
'ID of user identity to which the access grant gives access.',
|
|
@@ -14344,6 +14354,48 @@ export default {
|
|
|
14344
14354
|
type: 'object',
|
|
14345
14355
|
'x-route-path': '/access_methods',
|
|
14346
14356
|
},
|
|
14357
|
+
{
|
|
14358
|
+
description:
|
|
14359
|
+
'An access method was reissued due to an access grant update.',
|
|
14360
|
+
properties: {
|
|
14361
|
+
access_method_id: {
|
|
14362
|
+
description: 'ID of the affected access method.',
|
|
14363
|
+
format: 'uuid',
|
|
14364
|
+
type: 'string',
|
|
14365
|
+
},
|
|
14366
|
+
created_at: {
|
|
14367
|
+
description: 'Date and time at which the event was created.',
|
|
14368
|
+
format: 'date-time',
|
|
14369
|
+
type: 'string',
|
|
14370
|
+
},
|
|
14371
|
+
event_id: {
|
|
14372
|
+
description: 'ID of the event.',
|
|
14373
|
+
format: 'uuid',
|
|
14374
|
+
type: 'string',
|
|
14375
|
+
},
|
|
14376
|
+
event_type: { enum: ['access_method.reissued'], type: 'string' },
|
|
14377
|
+
occurred_at: {
|
|
14378
|
+
description: 'Date and time at which the event occurred.',
|
|
14379
|
+
format: 'date-time',
|
|
14380
|
+
type: 'string',
|
|
14381
|
+
},
|
|
14382
|
+
workspace_id: {
|
|
14383
|
+
description: 'ID of the workspace associated with the event.',
|
|
14384
|
+
format: 'uuid',
|
|
14385
|
+
type: 'string',
|
|
14386
|
+
},
|
|
14387
|
+
},
|
|
14388
|
+
required: [
|
|
14389
|
+
'event_id',
|
|
14390
|
+
'workspace_id',
|
|
14391
|
+
'created_at',
|
|
14392
|
+
'occurred_at',
|
|
14393
|
+
'access_method_id',
|
|
14394
|
+
'event_type',
|
|
14395
|
+
],
|
|
14396
|
+
type: 'object',
|
|
14397
|
+
'x-route-path': '/access_methods',
|
|
14398
|
+
},
|
|
14347
14399
|
{
|
|
14348
14400
|
description:
|
|
14349
14401
|
'An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
|
|
@@ -26367,6 +26419,135 @@ export default {
|
|
|
26367
26419
|
'x-title': 'List Access Grants',
|
|
26368
26420
|
},
|
|
26369
26421
|
},
|
|
26422
|
+
'/access_grants/update': {
|
|
26423
|
+
patch: {
|
|
26424
|
+
description: "Updates an existing access grant's time window.",
|
|
26425
|
+
operationId: 'accessGrantsUpdatePatch',
|
|
26426
|
+
requestBody: {
|
|
26427
|
+
content: {
|
|
26428
|
+
'application/json': {
|
|
26429
|
+
schema: {
|
|
26430
|
+
properties: {
|
|
26431
|
+
access_grant_id: {
|
|
26432
|
+
description: 'ID of the access grant to update.',
|
|
26433
|
+
format: 'uuid',
|
|
26434
|
+
type: 'string',
|
|
26435
|
+
},
|
|
26436
|
+
ends_at: {
|
|
26437
|
+
description:
|
|
26438
|
+
'Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
26439
|
+
format: 'date-time',
|
|
26440
|
+
nullable: true,
|
|
26441
|
+
type: 'string',
|
|
26442
|
+
},
|
|
26443
|
+
starts_at: {
|
|
26444
|
+
description:
|
|
26445
|
+
'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
26446
|
+
format: 'date-time',
|
|
26447
|
+
nullable: true,
|
|
26448
|
+
type: 'string',
|
|
26449
|
+
},
|
|
26450
|
+
},
|
|
26451
|
+
required: ['access_grant_id'],
|
|
26452
|
+
type: 'object',
|
|
26453
|
+
},
|
|
26454
|
+
},
|
|
26455
|
+
},
|
|
26456
|
+
},
|
|
26457
|
+
responses: {
|
|
26458
|
+
200: {
|
|
26459
|
+
content: {
|
|
26460
|
+
'application/json': {
|
|
26461
|
+
schema: {
|
|
26462
|
+
properties: { ok: { type: 'boolean' } },
|
|
26463
|
+
required: ['ok'],
|
|
26464
|
+
type: 'object',
|
|
26465
|
+
},
|
|
26466
|
+
},
|
|
26467
|
+
},
|
|
26468
|
+
description: 'OK',
|
|
26469
|
+
},
|
|
26470
|
+
400: { description: 'Bad Request' },
|
|
26471
|
+
401: { description: 'Unauthorized' },
|
|
26472
|
+
},
|
|
26473
|
+
security: [
|
|
26474
|
+
{ pat_with_workspace: [] },
|
|
26475
|
+
{ console_session_with_workspace: [] },
|
|
26476
|
+
{ api_key: [] },
|
|
26477
|
+
{ client_session_with_customer: [] },
|
|
26478
|
+
],
|
|
26479
|
+
summary: '/access_grants/update',
|
|
26480
|
+
tags: [],
|
|
26481
|
+
'x-draft': 'Early access.',
|
|
26482
|
+
'x-fern-ignore': true,
|
|
26483
|
+
'x-response-key': null,
|
|
26484
|
+
'x-title': 'Update an Access Grant',
|
|
26485
|
+
},
|
|
26486
|
+
post: {
|
|
26487
|
+
description: "Updates an existing access grant's time window.",
|
|
26488
|
+
operationId: 'accessGrantsUpdatePost',
|
|
26489
|
+
requestBody: {
|
|
26490
|
+
content: {
|
|
26491
|
+
'application/json': {
|
|
26492
|
+
schema: {
|
|
26493
|
+
properties: {
|
|
26494
|
+
access_grant_id: {
|
|
26495
|
+
description: 'ID of the access grant to update.',
|
|
26496
|
+
format: 'uuid',
|
|
26497
|
+
type: 'string',
|
|
26498
|
+
},
|
|
26499
|
+
ends_at: {
|
|
26500
|
+
description:
|
|
26501
|
+
'Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
26502
|
+
format: 'date-time',
|
|
26503
|
+
nullable: true,
|
|
26504
|
+
type: 'string',
|
|
26505
|
+
},
|
|
26506
|
+
starts_at: {
|
|
26507
|
+
description:
|
|
26508
|
+
'Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
26509
|
+
format: 'date-time',
|
|
26510
|
+
nullable: true,
|
|
26511
|
+
type: 'string',
|
|
26512
|
+
},
|
|
26513
|
+
},
|
|
26514
|
+
required: ['access_grant_id'],
|
|
26515
|
+
type: 'object',
|
|
26516
|
+
},
|
|
26517
|
+
},
|
|
26518
|
+
},
|
|
26519
|
+
},
|
|
26520
|
+
responses: {
|
|
26521
|
+
200: {
|
|
26522
|
+
content: {
|
|
26523
|
+
'application/json': {
|
|
26524
|
+
schema: {
|
|
26525
|
+
properties: { ok: { type: 'boolean' } },
|
|
26526
|
+
required: ['ok'],
|
|
26527
|
+
type: 'object',
|
|
26528
|
+
},
|
|
26529
|
+
},
|
|
26530
|
+
},
|
|
26531
|
+
description: 'OK',
|
|
26532
|
+
},
|
|
26533
|
+
400: { description: 'Bad Request' },
|
|
26534
|
+
401: { description: 'Unauthorized' },
|
|
26535
|
+
},
|
|
26536
|
+
security: [
|
|
26537
|
+
{ pat_with_workspace: [] },
|
|
26538
|
+
{ console_session_with_workspace: [] },
|
|
26539
|
+
{ api_key: [] },
|
|
26540
|
+
{ client_session_with_customer: [] },
|
|
26541
|
+
],
|
|
26542
|
+
summary: '/access_grants/update',
|
|
26543
|
+
tags: [],
|
|
26544
|
+
'x-draft': 'Early access.',
|
|
26545
|
+
'x-fern-sdk-group-name': ['access_grants'],
|
|
26546
|
+
'x-fern-sdk-method-name': 'update',
|
|
26547
|
+
'x-response-key': null,
|
|
26548
|
+
'x-title': 'Update an Access Grant',
|
|
26549
|
+
},
|
|
26550
|
+
},
|
|
26370
26551
|
'/access_methods/delete': {
|
|
26371
26552
|
post: {
|
|
26372
26553
|
description: 'Delete an access method.',
|
|
@@ -33905,6 +34086,7 @@ export default {
|
|
|
33905
34086
|
'access_method.revoked',
|
|
33906
34087
|
'access_method.card_encoding_required',
|
|
33907
34088
|
'access_method.deleted',
|
|
34089
|
+
'access_method.reissued',
|
|
33908
34090
|
'acs_system.connected',
|
|
33909
34091
|
'acs_system.added',
|
|
33910
34092
|
'acs_system.disconnected',
|
|
@@ -34001,6 +34183,7 @@ export default {
|
|
|
34001
34183
|
'access_method.revoked',
|
|
34002
34184
|
'access_method.card_encoding_required',
|
|
34003
34185
|
'access_method.deleted',
|
|
34186
|
+
'access_method.reissued',
|
|
34004
34187
|
'acs_system.connected',
|
|
34005
34188
|
'acs_system.added',
|
|
34006
34189
|
'acs_system.disconnected',
|
|
@@ -11440,6 +11440,10 @@ export interface Routes {
|
|
|
11440
11440
|
display_name: string
|
|
11441
11441
|
/** Date and time at which the access grant was created. */
|
|
11442
11442
|
created_at: string
|
|
11443
|
+
/** Date and time at which the access grant starts. */
|
|
11444
|
+
starts_at?: string | undefined
|
|
11445
|
+
/** Date and time at which the access grant ends. */
|
|
11446
|
+
ends_at?: string | undefined
|
|
11443
11447
|
}
|
|
11444
11448
|
}
|
|
11445
11449
|
}
|
|
@@ -11496,6 +11500,10 @@ export interface Routes {
|
|
|
11496
11500
|
display_name: string
|
|
11497
11501
|
/** Date and time at which the access grant was created. */
|
|
11498
11502
|
created_at: string
|
|
11503
|
+
/** Date and time at which the access grant starts. */
|
|
11504
|
+
starts_at?: string | undefined
|
|
11505
|
+
/** Date and time at which the access grant ends. */
|
|
11506
|
+
ends_at?: string | undefined
|
|
11499
11507
|
}
|
|
11500
11508
|
}
|
|
11501
11509
|
}
|
|
@@ -11548,9 +11556,29 @@ export interface Routes {
|
|
|
11548
11556
|
display_name: string
|
|
11549
11557
|
/** Date and time at which the access grant was created. */
|
|
11550
11558
|
created_at: string
|
|
11559
|
+
/** Date and time at which the access grant starts. */
|
|
11560
|
+
starts_at?: string | undefined
|
|
11561
|
+
/** Date and time at which the access grant ends. */
|
|
11562
|
+
ends_at?: string | undefined
|
|
11551
11563
|
}>
|
|
11552
11564
|
}
|
|
11553
11565
|
}
|
|
11566
|
+
'/access_grants/update': {
|
|
11567
|
+
route: '/access_grants/update'
|
|
11568
|
+
method: 'POST' | 'PATCH'
|
|
11569
|
+
queryParams: {}
|
|
11570
|
+
jsonBody: {}
|
|
11571
|
+
commonParams: {
|
|
11572
|
+
/** ID of the access grant to update. */
|
|
11573
|
+
access_grant_id: string
|
|
11574
|
+
/** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
11575
|
+
starts_at?: (string | null) | undefined
|
|
11576
|
+
/** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
11577
|
+
ends_at?: (string | null) | undefined
|
|
11578
|
+
}
|
|
11579
|
+
formData: {}
|
|
11580
|
+
jsonResponse: {}
|
|
11581
|
+
}
|
|
11554
11582
|
'/access_methods/delete': {
|
|
11555
11583
|
route: '/access_methods/delete'
|
|
11556
11584
|
method: 'GET' | 'POST'
|
|
@@ -30255,6 +30283,19 @@ export interface Routes {
|
|
|
30255
30283
|
created_at: string
|
|
30256
30284
|
/** Date and time at which the event occurred. */
|
|
30257
30285
|
occurred_at: string
|
|
30286
|
+
/** ID of the affected access method. */
|
|
30287
|
+
access_method_id: string
|
|
30288
|
+
event_type: 'access_method.reissued'
|
|
30289
|
+
}
|
|
30290
|
+
| {
|
|
30291
|
+
/** ID of the event. */
|
|
30292
|
+
event_id: string
|
|
30293
|
+
/** ID of the workspace associated with the event. */
|
|
30294
|
+
workspace_id: string
|
|
30295
|
+
/** Date and time at which the event was created. */
|
|
30296
|
+
created_at: string
|
|
30297
|
+
/** Date and time at which the event occurred. */
|
|
30298
|
+
occurred_at: string
|
|
30258
30299
|
/** ID of the connected account. */
|
|
30259
30300
|
connected_account_id?: string | undefined
|
|
30260
30301
|
/** ID of the access system. */
|
|
@@ -31373,6 +31414,7 @@ export interface Routes {
|
|
|
31373
31414
|
| 'access_method.revoked'
|
|
31374
31415
|
| 'access_method.card_encoding_required'
|
|
31375
31416
|
| 'access_method.deleted'
|
|
31417
|
+
| 'access_method.reissued'
|
|
31376
31418
|
| 'acs_system.connected'
|
|
31377
31419
|
| 'acs_system.added'
|
|
31378
31420
|
| 'acs_system.disconnected'
|
|
@@ -31467,6 +31509,7 @@ export interface Routes {
|
|
|
31467
31509
|
| 'access_method.revoked'
|
|
31468
31510
|
| 'access_method.card_encoding_required'
|
|
31469
31511
|
| 'access_method.deleted'
|
|
31512
|
+
| 'access_method.reissued'
|
|
31470
31513
|
| 'acs_system.connected'
|
|
31471
31514
|
| 'acs_system.added'
|
|
31472
31515
|
| 'acs_system.disconnected'
|
|
@@ -31972,6 +32015,19 @@ export interface Routes {
|
|
|
31972
32015
|
created_at: string
|
|
31973
32016
|
/** Date and time at which the event occurred. */
|
|
31974
32017
|
occurred_at: string
|
|
32018
|
+
/** ID of the affected access method. */
|
|
32019
|
+
access_method_id: string
|
|
32020
|
+
event_type: 'access_method.reissued'
|
|
32021
|
+
}
|
|
32022
|
+
| {
|
|
32023
|
+
/** ID of the event. */
|
|
32024
|
+
event_id: string
|
|
32025
|
+
/** ID of the workspace associated with the event. */
|
|
32026
|
+
workspace_id: string
|
|
32027
|
+
/** Date and time at which the event was created. */
|
|
32028
|
+
created_at: string
|
|
32029
|
+
/** Date and time at which the event occurred. */
|
|
32030
|
+
occurred_at: string
|
|
31975
32031
|
/** ID of the connected account. */
|
|
31976
32032
|
connected_account_id?: string | undefined
|
|
31977
32033
|
/** ID of the access system. */
|
|
@@ -71608,6 +71664,10 @@ export interface Routes {
|
|
|
71608
71664
|
display_name: string
|
|
71609
71665
|
/** Date and time at which the access grant was created. */
|
|
71610
71666
|
created_at: string
|
|
71667
|
+
/** Date and time at which the access grant starts. */
|
|
71668
|
+
starts_at?: string | undefined
|
|
71669
|
+
/** Date and time at which the access grant ends. */
|
|
71670
|
+
ends_at?: string | undefined
|
|
71611
71671
|
}
|
|
71612
71672
|
}
|
|
71613
71673
|
}
|
|
@@ -71664,6 +71724,10 @@ export interface Routes {
|
|
|
71664
71724
|
display_name: string
|
|
71665
71725
|
/** Date and time at which the access grant was created. */
|
|
71666
71726
|
created_at: string
|
|
71727
|
+
/** Date and time at which the access grant starts. */
|
|
71728
|
+
starts_at?: string | undefined
|
|
71729
|
+
/** Date and time at which the access grant ends. */
|
|
71730
|
+
ends_at?: string | undefined
|
|
71667
71731
|
}
|
|
71668
71732
|
}
|
|
71669
71733
|
}
|
|
@@ -71716,6 +71780,10 @@ export interface Routes {
|
|
|
71716
71780
|
display_name: string
|
|
71717
71781
|
/** Date and time at which the access grant was created. */
|
|
71718
71782
|
created_at: string
|
|
71783
|
+
/** Date and time at which the access grant starts. */
|
|
71784
|
+
starts_at?: string | undefined
|
|
71785
|
+
/** Date and time at which the access grant ends. */
|
|
71786
|
+
ends_at?: string | undefined
|
|
71719
71787
|
}>
|
|
71720
71788
|
}
|
|
71721
71789
|
}
|