@seamapi/types 1.20.0 → 1.21.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',
@@ -5648,8 +5720,12 @@ export default {
5648
5720
  'device.tampered',
5649
5721
  'device.low_battery',
5650
5722
  'device.battery_status_changed',
5723
+ 'device.third_party_integration_detected',
5724
+ 'device.third_party_integration_no_longer_detected',
5651
5725
  'device.salto.privacy_mode_activated',
5652
5726
  'device.salto.privacy_mode_deactivated',
5727
+ 'device.connection_became_flaky',
5728
+ 'device.connection_stabilized',
5653
5729
  'access_code.created',
5654
5730
  'access_code.changed',
5655
5731
  'access_code.scheduled_on_device',
@@ -6421,6 +6497,58 @@ export default {
6421
6497
  },
6422
6498
  },
6423
6499
  '/noise_sensors/noise_thresholds/update': {
6500
+ patch: {
6501
+ operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
6502
+ requestBody: {
6503
+ content: {
6504
+ 'application/json': {
6505
+ schema: {
6506
+ properties: {
6507
+ device_id: { format: 'uuid', type: 'string' },
6508
+ ends_daily_at: { type: 'string' },
6509
+ name: { type: 'string' },
6510
+ noise_threshold_decibels: { type: 'number' },
6511
+ noise_threshold_id: { format: 'uuid', type: 'string' },
6512
+ noise_threshold_nrs: { type: 'number' },
6513
+ starts_daily_at: { type: 'string' },
6514
+ sync: { default: false, type: 'boolean' },
6515
+ },
6516
+ required: ['noise_threshold_id', 'device_id'],
6517
+ type: 'object',
6518
+ },
6519
+ },
6520
+ },
6521
+ },
6522
+ responses: {
6523
+ 200: {
6524
+ content: {
6525
+ 'application/json': {
6526
+ schema: {
6527
+ properties: {
6528
+ action_attempt: {
6529
+ $ref: '#/components/schemas/action_attempt',
6530
+ },
6531
+ ok: { type: 'boolean' },
6532
+ },
6533
+ required: ['action_attempt', 'ok'],
6534
+ type: 'object',
6535
+ },
6536
+ },
6537
+ },
6538
+ description: 'OK',
6539
+ },
6540
+ 400: { description: 'Bad Request' },
6541
+ 401: { description: 'Unauthorized' },
6542
+ },
6543
+ security: [
6544
+ { access_token: [], seam_workspace: [] },
6545
+ { seam_client_session_token: [] },
6546
+ { client_session_token: [] },
6547
+ ],
6548
+ summary: '/noise_sensors/noise_thresholds/update',
6549
+ tags: ['/noise_sensors'],
6550
+ 'x-fern-ignore': true,
6551
+ },
6424
6552
  post: {
6425
6553
  operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
6426
6554
  requestBody: {
@@ -6836,6 +6964,73 @@ export default {
6836
6964
  },
6837
6965
  },
6838
6966
  '/thermostats/climate_setting_schedules/update': {
6967
+ patch: {
6968
+ operationId: 'thermostatsClimateSettingSchedulesUpdatePatch',
6969
+ requestBody: {
6970
+ content: {
6971
+ 'application/json': {
6972
+ schema: {
6973
+ properties: {
6974
+ automatic_cooling_enabled: { type: 'boolean' },
6975
+ automatic_heating_enabled: { type: 'boolean' },
6976
+ climate_setting_schedule_id: {
6977
+ format: 'uuid',
6978
+ type: 'string',
6979
+ },
6980
+ cooling_set_point_celsius: { type: 'number' },
6981
+ cooling_set_point_fahrenheit: { type: 'number' },
6982
+ heating_set_point_celsius: { type: 'number' },
6983
+ heating_set_point_fahrenheit: { type: 'number' },
6984
+ hvac_mode_setting: {
6985
+ enum: ['off', 'heat', 'cool', 'heat_cool'],
6986
+ type: 'string',
6987
+ },
6988
+ manual_override_allowed: { type: 'boolean' },
6989
+ name: { type: 'string' },
6990
+ schedule_ends_at: { type: 'string' },
6991
+ schedule_starts_at: { type: 'string' },
6992
+ schedule_type: {
6993
+ default: 'time_bound',
6994
+ enum: ['time_bound'],
6995
+ type: 'string',
6996
+ },
6997
+ },
6998
+ required: ['climate_setting_schedule_id'],
6999
+ type: 'object',
7000
+ },
7001
+ },
7002
+ },
7003
+ },
7004
+ responses: {
7005
+ 200: {
7006
+ content: {
7007
+ 'application/json': {
7008
+ schema: {
7009
+ properties: {
7010
+ climate_setting_schedule: {
7011
+ $ref: '#/components/schemas/climate_setting_schedule',
7012
+ },
7013
+ ok: { type: 'boolean' },
7014
+ },
7015
+ required: ['climate_setting_schedule', 'ok'],
7016
+ type: 'object',
7017
+ },
7018
+ },
7019
+ },
7020
+ description: 'OK',
7021
+ },
7022
+ 400: { description: 'Bad Request' },
7023
+ 401: { description: 'Unauthorized' },
7024
+ },
7025
+ security: [
7026
+ { access_token: [], seam_workspace: [] },
7027
+ { seam_client_session_token: [] },
7028
+ { client_session_token: [] },
7029
+ ],
7030
+ summary: '/thermostats/climate_setting_schedules/update',
7031
+ tags: [],
7032
+ 'x-fern-ignore': true,
7033
+ },
6839
7034
  post: {
6840
7035
  operationId: 'thermostatsClimateSettingSchedulesUpdatePost',
6841
7036
  requestBody: {
@@ -7437,6 +7632,62 @@ export default {
7437
7632
  },
7438
7633
  },
7439
7634
  '/thermostats/update': {
7635
+ patch: {
7636
+ operationId: 'thermostatsUpdatePatch',
7637
+ requestBody: {
7638
+ content: {
7639
+ 'application/json': {
7640
+ schema: {
7641
+ properties: {
7642
+ default_climate_setting: {
7643
+ properties: {
7644
+ automatic_cooling_enabled: { type: 'boolean' },
7645
+ automatic_heating_enabled: { type: 'boolean' },
7646
+ cooling_set_point_celsius: { type: 'number' },
7647
+ cooling_set_point_fahrenheit: { type: 'number' },
7648
+ heating_set_point_celsius: { type: 'number' },
7649
+ heating_set_point_fahrenheit: { type: 'number' },
7650
+ hvac_mode_setting: {
7651
+ enum: ['off', 'heat', 'cool', 'heat_cool'],
7652
+ type: 'string',
7653
+ },
7654
+ manual_override_allowed: { type: 'boolean' },
7655
+ },
7656
+ type: 'object',
7657
+ },
7658
+ device_id: { format: 'uuid', type: 'string' },
7659
+ },
7660
+ required: ['device_id', 'default_climate_setting'],
7661
+ type: 'object',
7662
+ },
7663
+ },
7664
+ },
7665
+ },
7666
+ responses: {
7667
+ 200: {
7668
+ content: {
7669
+ 'application/json': {
7670
+ schema: {
7671
+ properties: { ok: { type: 'boolean' } },
7672
+ required: ['ok'],
7673
+ type: 'object',
7674
+ },
7675
+ },
7676
+ },
7677
+ description: 'OK',
7678
+ },
7679
+ 400: { description: 'Bad Request' },
7680
+ 401: { description: 'Unauthorized' },
7681
+ },
7682
+ security: [
7683
+ { access_token: [], seam_workspace: [] },
7684
+ { seam_client_session_token: [] },
7685
+ { client_session_token: [] },
7686
+ ],
7687
+ summary: '/thermostats/update',
7688
+ tags: [],
7689
+ 'x-fern-ignore': true,
7690
+ },
7440
7691
  post: {
7441
7692
  operationId: 'thermostatsUpdatePost',
7442
7693
  requestBody: {
@@ -7665,6 +7916,39 @@ export default {
7665
7916
  ],
7666
7917
  summary: '/webhooks/list',
7667
7918
  tags: ['/webhooks'],
7919
+ 'x-fern-ignore': true,
7920
+ },
7921
+ post: {
7922
+ operationId: 'webhooksListPost',
7923
+ responses: {
7924
+ 200: {
7925
+ content: {
7926
+ 'application/json': {
7927
+ schema: {
7928
+ properties: {
7929
+ ok: { type: 'boolean' },
7930
+ webhooks: {
7931
+ items: { $ref: '#/components/schemas/webhook' },
7932
+ type: 'array',
7933
+ },
7934
+ },
7935
+ required: ['webhooks', 'ok'],
7936
+ type: 'object',
7937
+ },
7938
+ },
7939
+ },
7940
+ description: 'OK',
7941
+ },
7942
+ 400: { description: 'Bad Request' },
7943
+ 401: { description: 'Unauthorized' },
7944
+ },
7945
+ security: [
7946
+ { access_token: [], seam_workspace: [] },
7947
+ { seam_client_session_token: [] },
7948
+ { client_session_token: [] },
7949
+ ],
7950
+ summary: '/webhooks/list',
7951
+ tags: ['/webhooks'],
7668
7952
  'x-fern-sdk-group-name': ['webhooks'],
7669
7953
  'x-fern-sdk-method-name': 'list',
7670
7954
  'x-fern-sdk-return-value': 'webhooks',
@@ -7699,6 +7983,36 @@ export default {
7699
7983
  ],
7700
7984
  summary: '/workspaces/get',
7701
7985
  tags: ['/workspaces'],
7986
+ 'x-fern-ignore': true,
7987
+ },
7988
+ post: {
7989
+ operationId: 'workspacesGetPost',
7990
+ responses: {
7991
+ 200: {
7992
+ content: {
7993
+ 'application/json': {
7994
+ schema: {
7995
+ properties: {
7996
+ ok: { type: 'boolean' },
7997
+ workspace: { $ref: '#/components/schemas/workspace' },
7998
+ },
7999
+ required: ['ok'],
8000
+ type: 'object',
8001
+ },
8002
+ },
8003
+ },
8004
+ description: 'OK',
8005
+ },
8006
+ 400: { description: 'Bad Request' },
8007
+ 401: { description: 'Unauthorized' },
8008
+ },
8009
+ security: [
8010
+ { access_token: [], seam_workspace: [] },
8011
+ { seam_client_session_token: [] },
8012
+ { client_session_token: [] },
8013
+ ],
8014
+ summary: '/workspaces/get',
8015
+ tags: ['/workspaces'],
7702
8016
  'x-fern-sdk-group-name': ['workspaces'],
7703
8017
  'x-fern-sdk-method-name': 'get',
7704
8018
  'x-fern-sdk-return-value': 'workspace',
@@ -7736,6 +8050,39 @@ export default {
7736
8050
  ],
7737
8051
  summary: '/workspaces/list',
7738
8052
  tags: ['/workspaces'],
8053
+ 'x-fern-ignore': true,
8054
+ },
8055
+ post: {
8056
+ operationId: 'workspacesListPost',
8057
+ responses: {
8058
+ 200: {
8059
+ content: {
8060
+ 'application/json': {
8061
+ schema: {
8062
+ properties: {
8063
+ ok: { type: 'boolean' },
8064
+ workspaces: {
8065
+ items: { $ref: '#/components/schemas/workspace' },
8066
+ type: 'array',
8067
+ },
8068
+ },
8069
+ required: ['workspaces', 'ok'],
8070
+ type: 'object',
8071
+ },
8072
+ },
8073
+ },
8074
+ description: 'OK',
8075
+ },
8076
+ 400: { description: 'Bad Request' },
8077
+ 401: { description: 'Unauthorized' },
8078
+ },
8079
+ security: [
8080
+ { access_token: [], seam_workspace: [] },
8081
+ { seam_client_session_token: [] },
8082
+ { client_session_token: [] },
8083
+ ],
8084
+ summary: '/workspaces/list',
8085
+ tags: ['/workspaces'],
7739
8086
  'x-fern-sdk-group-name': ['workspaces'],
7740
8087
  'x-fern-sdk-method-name': 'list',
7741
8088
  'x-fern-sdk-return-value': 'workspace',