@seamapi/types 1.20.0 → 1.22.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.
@@ -115,7 +115,7 @@ export default {
115
115
  external_type: { enum: ['pti_user'], type: 'string' },
116
116
  external_type_display_name: { type: 'string' },
117
117
  full_name: { type: 'string' },
118
- is_being_deleted: { type: 'boolean' },
118
+ is_suspended: { type: 'boolean' },
119
119
  phone_number: { nullable: true, type: 'string' },
120
120
  workspace_id: { format: 'uuid', type: 'string' },
121
121
  },
@@ -127,7 +127,7 @@ export default {
127
127
  'display_name',
128
128
  'external_type',
129
129
  'external_type_display_name',
130
- 'is_being_deleted',
130
+ 'is_suspended',
131
131
  ],
132
132
  type: 'object',
133
133
  },
@@ -1747,16 +1747,19 @@ export default {
1747
1747
  },
1748
1748
  },
1749
1749
  '/access_codes/generate_code': {
1750
- get: {
1751
- operationId: 'accessCodesGenerateCodeGet',
1752
- parameters: [
1753
- {
1754
- in: 'query',
1755
- name: 'device_id',
1756
- required: true,
1757
- schema: { format: 'uuid', type: 'string' },
1750
+ post: {
1751
+ operationId: 'accessCodesGenerateCodePost',
1752
+ requestBody: {
1753
+ content: {
1754
+ 'application/json': {
1755
+ schema: {
1756
+ properties: { device_id: { format: 'uuid', type: 'string' } },
1757
+ required: ['device_id'],
1758
+ type: 'object',
1759
+ },
1760
+ },
1758
1761
  },
1759
- ],
1762
+ },
1760
1763
  responses: {
1761
1764
  200: {
1762
1765
  content: {
@@ -2468,6 +2471,71 @@ export default {
2468
2471
  },
2469
2472
  },
2470
2473
  '/access_codes/update': {
2474
+ patch: {
2475
+ operationId: 'accessCodesUpdatePatch',
2476
+ requestBody: {
2477
+ content: {
2478
+ 'application/json': {
2479
+ schema: {
2480
+ properties: {
2481
+ access_code_id: { format: 'uuid', type: 'string' },
2482
+ allow_external_modification: { type: 'boolean' },
2483
+ attempt_for_offline_device: {
2484
+ default: true,
2485
+ type: 'boolean',
2486
+ },
2487
+ code: {
2488
+ maxLength: 8,
2489
+ minLength: 4,
2490
+ pattern: '^\\d+$',
2491
+ type: 'string',
2492
+ },
2493
+ device_id: { format: 'uuid', type: 'string' },
2494
+ ends_at: { type: 'string' },
2495
+ is_managed: { type: 'boolean' },
2496
+ name: { type: 'string' },
2497
+ prefer_native_scheduling: { type: 'boolean' },
2498
+ starts_at: { type: 'string' },
2499
+ sync: { default: false, type: 'boolean' },
2500
+ type: { enum: ['ongoing', 'time_bound'], type: 'string' },
2501
+ use_backup_access_code_pool: { type: 'boolean' },
2502
+ },
2503
+ required: ['access_code_id'],
2504
+ type: 'object',
2505
+ },
2506
+ },
2507
+ },
2508
+ },
2509
+ responses: {
2510
+ 200: {
2511
+ content: {
2512
+ 'application/json': {
2513
+ schema: {
2514
+ properties: {
2515
+ action_attempt: {
2516
+ $ref: '#/components/schemas/action_attempt',
2517
+ },
2518
+ ok: { type: 'boolean' },
2519
+ },
2520
+ required: ['action_attempt', 'ok'],
2521
+ type: 'object',
2522
+ },
2523
+ },
2524
+ },
2525
+ description: 'OK',
2526
+ },
2527
+ 400: { description: 'Bad Request' },
2528
+ 401: { description: 'Unauthorized' },
2529
+ },
2530
+ security: [
2531
+ { access_token: [], seam_workspace: [] },
2532
+ { seam_client_session_token: [] },
2533
+ { client_session_token: [] },
2534
+ ],
2535
+ summary: '/access_codes/update',
2536
+ tags: ['/access_codes'],
2537
+ 'x-fern-ignore': true,
2538
+ },
2471
2539
  post: {
2472
2540
  operationId: 'accessCodesUpdatePost',
2473
2541
  requestBody: {
@@ -2602,8 +2670,8 @@ export default {
2602
2670
  },
2603
2671
  },
2604
2672
  '/acs/access_groups/add_user': {
2605
- patch: {
2606
- operationId: 'acsAccessGroupsAddUserPatch',
2673
+ post: {
2674
+ operationId: 'acsAccessGroupsAddUserPost',
2607
2675
  requestBody: {
2608
2676
  content: {
2609
2677
  'application/json': {
@@ -2641,10 +2709,11 @@ export default {
2641
2709
  ],
2642
2710
  summary: '/acs/access_groups/add_user',
2643
2711
  tags: [],
2644
- 'x-fern-ignore': true,
2712
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
2713
+ 'x-fern-sdk-method-name': 'add_user',
2645
2714
  },
2646
- post: {
2647
- operationId: 'acsAccessGroupsAddUserPost',
2715
+ put: {
2716
+ operationId: 'acsAccessGroupsAddUserPut',
2648
2717
  requestBody: {
2649
2718
  content: {
2650
2719
  'application/json': {
@@ -2682,8 +2751,7 @@ export default {
2682
2751
  ],
2683
2752
  summary: '/acs/access_groups/add_user',
2684
2753
  tags: [],
2685
- 'x-fern-sdk-group-name': ['acs', 'access_groups'],
2686
- 'x-fern-sdk-method-name': 'add_user',
2754
+ 'x-fern-ignore': true,
2687
2755
  },
2688
2756
  },
2689
2757
  '/acs/access_groups/create': {
@@ -3397,8 +3465,8 @@ export default {
3397
3465
  },
3398
3466
  },
3399
3467
  '/acs/users/add_to_access_group': {
3400
- patch: {
3401
- operationId: 'acsUsersAddToAccessGroupPatch',
3468
+ post: {
3469
+ operationId: 'acsUsersAddToAccessGroupPost',
3402
3470
  requestBody: {
3403
3471
  content: {
3404
3472
  'application/json': {
@@ -3425,10 +3493,11 @@ export default {
3425
3493
  ],
3426
3494
  summary: '/acs/users/add_to_access_group',
3427
3495
  tags: [],
3428
- 'x-fern-ignore': true,
3496
+ 'x-fern-sdk-group-name': ['acs', 'users'],
3497
+ 'x-fern-sdk-method-name': 'add_to_access_group',
3429
3498
  },
3430
- post: {
3431
- operationId: 'acsUsersAddToAccessGroupPost',
3499
+ put: {
3500
+ operationId: 'acsUsersAddToAccessGroupPut',
3432
3501
  requestBody: {
3433
3502
  content: {
3434
3503
  'application/json': {
@@ -3455,8 +3524,7 @@ export default {
3455
3524
  ],
3456
3525
  summary: '/acs/users/add_to_access_group',
3457
3526
  tags: [],
3458
- 'x-fern-sdk-group-name': ['acs', 'users'],
3459
- 'x-fern-sdk-method-name': 'add_to_access_group',
3527
+ 'x-fern-ignore': true,
3460
3528
  },
3461
3529
  },
3462
3530
  '/acs/users/create': {
@@ -5605,8 +5673,12 @@ export default {
5605
5673
  'device.tampered',
5606
5674
  'device.low_battery',
5607
5675
  'device.battery_status_changed',
5676
+ 'device.third_party_integration_detected',
5677
+ 'device.third_party_integration_no_longer_detected',
5608
5678
  'device.salto.privacy_mode_activated',
5609
5679
  'device.salto.privacy_mode_deactivated',
5680
+ 'device.connection_became_flaky',
5681
+ 'device.connection_stabilized',
5610
5682
  'access_code.created',
5611
5683
  'access_code.changed',
5612
5684
  'access_code.scheduled_on_device',
@@ -5617,6 +5689,7 @@ export default {
5617
5689
  'access_code.delay_in_setting_on_device',
5618
5690
  'access_code.failed_to_remove_from_device',
5619
5691
  'access_code.delay_in_removing_from_device',
5692
+ 'access_code.deleted_external_to_seam',
5620
5693
  'access_code.modified_external_to_seam',
5621
5694
  'access_code.unmanaged.converted_to_managed',
5622
5695
  'access_code.unmanaged.failed_to_convert_to_managed',
@@ -5648,8 +5721,12 @@ export default {
5648
5721
  'device.tampered',
5649
5722
  'device.low_battery',
5650
5723
  'device.battery_status_changed',
5724
+ 'device.third_party_integration_detected',
5725
+ 'device.third_party_integration_no_longer_detected',
5651
5726
  'device.salto.privacy_mode_activated',
5652
5727
  'device.salto.privacy_mode_deactivated',
5728
+ 'device.connection_became_flaky',
5729
+ 'device.connection_stabilized',
5653
5730
  'access_code.created',
5654
5731
  'access_code.changed',
5655
5732
  'access_code.scheduled_on_device',
@@ -5660,6 +5737,7 @@ export default {
5660
5737
  'access_code.delay_in_setting_on_device',
5661
5738
  'access_code.failed_to_remove_from_device',
5662
5739
  'access_code.delay_in_removing_from_device',
5740
+ 'access_code.deleted_external_to_seam',
5663
5741
  'access_code.modified_external_to_seam',
5664
5742
  'access_code.unmanaged.converted_to_managed',
5665
5743
  'access_code.unmanaged.failed_to_convert_to_managed',
@@ -6421,6 +6499,58 @@ export default {
6421
6499
  },
6422
6500
  },
6423
6501
  '/noise_sensors/noise_thresholds/update': {
6502
+ patch: {
6503
+ operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
6504
+ requestBody: {
6505
+ content: {
6506
+ 'application/json': {
6507
+ schema: {
6508
+ properties: {
6509
+ device_id: { format: 'uuid', type: 'string' },
6510
+ ends_daily_at: { type: 'string' },
6511
+ name: { type: 'string' },
6512
+ noise_threshold_decibels: { type: 'number' },
6513
+ noise_threshold_id: { format: 'uuid', type: 'string' },
6514
+ noise_threshold_nrs: { type: 'number' },
6515
+ starts_daily_at: { type: 'string' },
6516
+ sync: { default: false, type: 'boolean' },
6517
+ },
6518
+ required: ['noise_threshold_id', 'device_id'],
6519
+ type: 'object',
6520
+ },
6521
+ },
6522
+ },
6523
+ },
6524
+ responses: {
6525
+ 200: {
6526
+ content: {
6527
+ 'application/json': {
6528
+ schema: {
6529
+ properties: {
6530
+ action_attempt: {
6531
+ $ref: '#/components/schemas/action_attempt',
6532
+ },
6533
+ ok: { type: 'boolean' },
6534
+ },
6535
+ required: ['action_attempt', 'ok'],
6536
+ type: 'object',
6537
+ },
6538
+ },
6539
+ },
6540
+ description: 'OK',
6541
+ },
6542
+ 400: { description: 'Bad Request' },
6543
+ 401: { description: 'Unauthorized' },
6544
+ },
6545
+ security: [
6546
+ { access_token: [], seam_workspace: [] },
6547
+ { seam_client_session_token: [] },
6548
+ { client_session_token: [] },
6549
+ ],
6550
+ summary: '/noise_sensors/noise_thresholds/update',
6551
+ tags: ['/noise_sensors'],
6552
+ 'x-fern-ignore': true,
6553
+ },
6424
6554
  post: {
6425
6555
  operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
6426
6556
  requestBody: {
@@ -6836,6 +6966,73 @@ export default {
6836
6966
  },
6837
6967
  },
6838
6968
  '/thermostats/climate_setting_schedules/update': {
6969
+ patch: {
6970
+ operationId: 'thermostatsClimateSettingSchedulesUpdatePatch',
6971
+ requestBody: {
6972
+ content: {
6973
+ 'application/json': {
6974
+ schema: {
6975
+ properties: {
6976
+ automatic_cooling_enabled: { type: 'boolean' },
6977
+ automatic_heating_enabled: { type: 'boolean' },
6978
+ climate_setting_schedule_id: {
6979
+ format: 'uuid',
6980
+ type: 'string',
6981
+ },
6982
+ cooling_set_point_celsius: { type: 'number' },
6983
+ cooling_set_point_fahrenheit: { type: 'number' },
6984
+ heating_set_point_celsius: { type: 'number' },
6985
+ heating_set_point_fahrenheit: { type: 'number' },
6986
+ hvac_mode_setting: {
6987
+ enum: ['off', 'heat', 'cool', 'heat_cool'],
6988
+ type: 'string',
6989
+ },
6990
+ manual_override_allowed: { type: 'boolean' },
6991
+ name: { type: 'string' },
6992
+ schedule_ends_at: { type: 'string' },
6993
+ schedule_starts_at: { type: 'string' },
6994
+ schedule_type: {
6995
+ default: 'time_bound',
6996
+ enum: ['time_bound'],
6997
+ type: 'string',
6998
+ },
6999
+ },
7000
+ required: ['climate_setting_schedule_id'],
7001
+ type: 'object',
7002
+ },
7003
+ },
7004
+ },
7005
+ },
7006
+ responses: {
7007
+ 200: {
7008
+ content: {
7009
+ 'application/json': {
7010
+ schema: {
7011
+ properties: {
7012
+ climate_setting_schedule: {
7013
+ $ref: '#/components/schemas/climate_setting_schedule',
7014
+ },
7015
+ ok: { type: 'boolean' },
7016
+ },
7017
+ required: ['climate_setting_schedule', 'ok'],
7018
+ type: 'object',
7019
+ },
7020
+ },
7021
+ },
7022
+ description: 'OK',
7023
+ },
7024
+ 400: { description: 'Bad Request' },
7025
+ 401: { description: 'Unauthorized' },
7026
+ },
7027
+ security: [
7028
+ { access_token: [], seam_workspace: [] },
7029
+ { seam_client_session_token: [] },
7030
+ { client_session_token: [] },
7031
+ ],
7032
+ summary: '/thermostats/climate_setting_schedules/update',
7033
+ tags: [],
7034
+ 'x-fern-ignore': true,
7035
+ },
6839
7036
  post: {
6840
7037
  operationId: 'thermostatsClimateSettingSchedulesUpdatePost',
6841
7038
  requestBody: {
@@ -7437,6 +7634,62 @@ export default {
7437
7634
  },
7438
7635
  },
7439
7636
  '/thermostats/update': {
7637
+ patch: {
7638
+ operationId: 'thermostatsUpdatePatch',
7639
+ requestBody: {
7640
+ content: {
7641
+ 'application/json': {
7642
+ schema: {
7643
+ properties: {
7644
+ default_climate_setting: {
7645
+ properties: {
7646
+ automatic_cooling_enabled: { type: 'boolean' },
7647
+ automatic_heating_enabled: { type: 'boolean' },
7648
+ cooling_set_point_celsius: { type: 'number' },
7649
+ cooling_set_point_fahrenheit: { type: 'number' },
7650
+ heating_set_point_celsius: { type: 'number' },
7651
+ heating_set_point_fahrenheit: { type: 'number' },
7652
+ hvac_mode_setting: {
7653
+ enum: ['off', 'heat', 'cool', 'heat_cool'],
7654
+ type: 'string',
7655
+ },
7656
+ manual_override_allowed: { type: 'boolean' },
7657
+ },
7658
+ type: 'object',
7659
+ },
7660
+ device_id: { format: 'uuid', type: 'string' },
7661
+ },
7662
+ required: ['device_id', 'default_climate_setting'],
7663
+ type: 'object',
7664
+ },
7665
+ },
7666
+ },
7667
+ },
7668
+ responses: {
7669
+ 200: {
7670
+ content: {
7671
+ 'application/json': {
7672
+ schema: {
7673
+ properties: { ok: { type: 'boolean' } },
7674
+ required: ['ok'],
7675
+ type: 'object',
7676
+ },
7677
+ },
7678
+ },
7679
+ description: 'OK',
7680
+ },
7681
+ 400: { description: 'Bad Request' },
7682
+ 401: { description: 'Unauthorized' },
7683
+ },
7684
+ security: [
7685
+ { access_token: [], seam_workspace: [] },
7686
+ { seam_client_session_token: [] },
7687
+ { client_session_token: [] },
7688
+ ],
7689
+ summary: '/thermostats/update',
7690
+ tags: [],
7691
+ 'x-fern-ignore': true,
7692
+ },
7440
7693
  post: {
7441
7694
  operationId: 'thermostatsUpdatePost',
7442
7695
  requestBody: {
@@ -7665,6 +7918,39 @@ export default {
7665
7918
  ],
7666
7919
  summary: '/webhooks/list',
7667
7920
  tags: ['/webhooks'],
7921
+ 'x-fern-ignore': true,
7922
+ },
7923
+ post: {
7924
+ operationId: 'webhooksListPost',
7925
+ responses: {
7926
+ 200: {
7927
+ content: {
7928
+ 'application/json': {
7929
+ schema: {
7930
+ properties: {
7931
+ ok: { type: 'boolean' },
7932
+ webhooks: {
7933
+ items: { $ref: '#/components/schemas/webhook' },
7934
+ type: 'array',
7935
+ },
7936
+ },
7937
+ required: ['webhooks', 'ok'],
7938
+ type: 'object',
7939
+ },
7940
+ },
7941
+ },
7942
+ description: 'OK',
7943
+ },
7944
+ 400: { description: 'Bad Request' },
7945
+ 401: { description: 'Unauthorized' },
7946
+ },
7947
+ security: [
7948
+ { access_token: [], seam_workspace: [] },
7949
+ { seam_client_session_token: [] },
7950
+ { client_session_token: [] },
7951
+ ],
7952
+ summary: '/webhooks/list',
7953
+ tags: ['/webhooks'],
7668
7954
  'x-fern-sdk-group-name': ['webhooks'],
7669
7955
  'x-fern-sdk-method-name': 'list',
7670
7956
  'x-fern-sdk-return-value': 'webhooks',
@@ -7699,6 +7985,36 @@ export default {
7699
7985
  ],
7700
7986
  summary: '/workspaces/get',
7701
7987
  tags: ['/workspaces'],
7988
+ 'x-fern-ignore': true,
7989
+ },
7990
+ post: {
7991
+ operationId: 'workspacesGetPost',
7992
+ responses: {
7993
+ 200: {
7994
+ content: {
7995
+ 'application/json': {
7996
+ schema: {
7997
+ properties: {
7998
+ ok: { type: 'boolean' },
7999
+ workspace: { $ref: '#/components/schemas/workspace' },
8000
+ },
8001
+ required: ['ok'],
8002
+ type: 'object',
8003
+ },
8004
+ },
8005
+ },
8006
+ description: 'OK',
8007
+ },
8008
+ 400: { description: 'Bad Request' },
8009
+ 401: { description: 'Unauthorized' },
8010
+ },
8011
+ security: [
8012
+ { access_token: [], seam_workspace: [] },
8013
+ { seam_client_session_token: [] },
8014
+ { client_session_token: [] },
8015
+ ],
8016
+ summary: '/workspaces/get',
8017
+ tags: ['/workspaces'],
7702
8018
  'x-fern-sdk-group-name': ['workspaces'],
7703
8019
  'x-fern-sdk-method-name': 'get',
7704
8020
  'x-fern-sdk-return-value': 'workspace',
@@ -7736,6 +8052,39 @@ export default {
7736
8052
  ],
7737
8053
  summary: '/workspaces/list',
7738
8054
  tags: ['/workspaces'],
8055
+ 'x-fern-ignore': true,
8056
+ },
8057
+ post: {
8058
+ operationId: 'workspacesListPost',
8059
+ responses: {
8060
+ 200: {
8061
+ content: {
8062
+ 'application/json': {
8063
+ schema: {
8064
+ properties: {
8065
+ ok: { type: 'boolean' },
8066
+ workspaces: {
8067
+ items: { $ref: '#/components/schemas/workspace' },
8068
+ type: 'array',
8069
+ },
8070
+ },
8071
+ required: ['workspaces', 'ok'],
8072
+ type: 'object',
8073
+ },
8074
+ },
8075
+ },
8076
+ description: 'OK',
8077
+ },
8078
+ 400: { description: 'Bad Request' },
8079
+ 401: { description: 'Unauthorized' },
8080
+ },
8081
+ security: [
8082
+ { access_token: [], seam_workspace: [] },
8083
+ { seam_client_session_token: [] },
8084
+ { client_session_token: [] },
8085
+ ],
8086
+ summary: '/workspaces/list',
8087
+ tags: ['/workspaces'],
7739
8088
  'x-fern-sdk-group-name': ['workspaces'],
7740
8089
  'x-fern-sdk-method-name': 'list',
7741
8090
  'x-fern-sdk-return-value': 'workspace',