@seamapi/types 1.389.0 → 1.390.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.389.0",
3
+ "version": "1.390.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -5,6 +5,7 @@ import { deprecated_action_attempts } from './deprecated.js'
5
5
  import { encode_access_method_action_attempt } from './encode-access-method.js'
6
6
  import { encode_credential_action_attempt } from './encode-credential.js'
7
7
  import { lock_door_action_attempt } from './lock-door.js'
8
+ import { push_thermostat_programs_action_attempt } from './push-thermostat-programs.js'
8
9
  import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
9
10
  import { scan_credential_action_attempt } from './scan-credential.js'
10
11
  import { set_fan_mode_action_attempt } from './set-fan-mode.js'
@@ -25,6 +26,7 @@ export const action_attempt = z.union([
25
26
  ...activate_climate_preset_action_attempt.options,
26
27
  ...simulate_keypad_code_entry_action_attempt.options,
27
28
  ...simulate_manual_lock_via_keypad_action_attempt.options,
29
+ ...push_thermostat_programs_action_attempt.options,
28
30
  ...deprecated_action_attempts,
29
31
  ]).describe(`
30
32
  ---
@@ -0,0 +1,36 @@
1
+ import { z } from 'zod'
2
+
3
+ import {
4
+ common_failed_action_attempt,
5
+ common_pending_action_attempt,
6
+ common_succeeded_action_attempt,
7
+ } from './common.js'
8
+
9
+ const action_type = z.literal('PUSH_THERMOSTAT_PROGRAMS')
10
+
11
+ const error = z.object({
12
+ type: z.string(),
13
+ message: z.string(),
14
+ })
15
+
16
+ const result = z.object({})
17
+
18
+ export const push_thermostat_programs_action_attempt = z.discriminatedUnion(
19
+ 'status',
20
+ [
21
+ common_pending_action_attempt
22
+ .extend({
23
+ action_type,
24
+ })
25
+ .describe('Pushing thermostat weekly programs.'),
26
+ common_succeeded_action_attempt
27
+ .extend({
28
+ action_type,
29
+ result,
30
+ })
31
+ .describe('Pushing thermostat weekly programs succeeded.'),
32
+ common_failed_action_attempt
33
+ .extend({ action_type, error })
34
+ .describe('Pushing thermostat weekly programs failed.'),
35
+ ],
36
+ )
@@ -6353,6 +6353,104 @@ export default {
6353
6353
  ],
6354
6354
  type: 'object',
6355
6355
  },
6356
+ {
6357
+ description: 'Pushing thermostat weekly programs.',
6358
+ properties: {
6359
+ action_attempt_id: {
6360
+ description: 'ID of the action attempt.',
6361
+ format: 'uuid',
6362
+ type: 'string',
6363
+ },
6364
+ action_type: {
6365
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
6366
+ type: 'string',
6367
+ },
6368
+ error: {
6369
+ description:
6370
+ 'Errors associated with the action attempt. Null for pending action attempts.',
6371
+ nullable: true,
6372
+ },
6373
+ result: {
6374
+ description:
6375
+ 'Result of the action attempt. Null for pending action attempts.',
6376
+ nullable: true,
6377
+ },
6378
+ status: { enum: ['pending'], type: 'string' },
6379
+ },
6380
+ required: [
6381
+ 'action_attempt_id',
6382
+ 'status',
6383
+ 'result',
6384
+ 'error',
6385
+ 'action_type',
6386
+ ],
6387
+ type: 'object',
6388
+ },
6389
+ {
6390
+ description: 'Pushing thermostat weekly programs succeeded.',
6391
+ properties: {
6392
+ action_attempt_id: {
6393
+ description: 'ID of the action attempt.',
6394
+ format: 'uuid',
6395
+ type: 'string',
6396
+ },
6397
+ action_type: {
6398
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
6399
+ type: 'string',
6400
+ },
6401
+ error: {
6402
+ description:
6403
+ 'Errors associated with the action attempt. Null for successful action attempts.',
6404
+ nullable: true,
6405
+ },
6406
+ result: { properties: {}, type: 'object' },
6407
+ status: { enum: ['success'], type: 'string' },
6408
+ },
6409
+ required: [
6410
+ 'action_attempt_id',
6411
+ 'status',
6412
+ 'error',
6413
+ 'action_type',
6414
+ 'result',
6415
+ ],
6416
+ type: 'object',
6417
+ },
6418
+ {
6419
+ description: 'Pushing thermostat weekly programs failed.',
6420
+ properties: {
6421
+ action_attempt_id: {
6422
+ description: 'ID of the action attempt.',
6423
+ format: 'uuid',
6424
+ type: 'string',
6425
+ },
6426
+ action_type: {
6427
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
6428
+ type: 'string',
6429
+ },
6430
+ error: {
6431
+ properties: {
6432
+ message: { type: 'string' },
6433
+ type: { type: 'string' },
6434
+ },
6435
+ required: ['type', 'message'],
6436
+ type: 'object',
6437
+ },
6438
+ result: {
6439
+ description:
6440
+ 'Result of the action attempt. Null for failed action attempts.',
6441
+ nullable: true,
6442
+ },
6443
+ status: { enum: ['error'], type: 'string' },
6444
+ },
6445
+ required: [
6446
+ 'action_attempt_id',
6447
+ 'status',
6448
+ 'result',
6449
+ 'action_type',
6450
+ 'error',
6451
+ ],
6452
+ type: 'object',
6453
+ },
6356
6454
  {
6357
6455
  properties: {
6358
6456
  action_attempt_id: {
@@ -29864,86 +29962,12 @@ export default {
29864
29962
  'application/json': {
29865
29963
  schema: {
29866
29964
  properties: {
29867
- ok: { type: 'boolean' },
29868
- thermostat_weekly_program: {
29869
- properties: {
29870
- created_at: {
29871
- description:
29872
- 'Date and time at which the thermostat weekly program was created.',
29873
- format: 'date-time',
29874
- type: 'string',
29875
- },
29876
- device_id: {
29877
- description:
29878
- 'ID of the thermostat device the weekly program is for.',
29879
- format: 'uuid',
29880
- type: 'string',
29881
- },
29882
- friday_program_id: {
29883
- description:
29884
- 'ID of the thermostat daily program to run on Fridays.',
29885
- format: 'uuid',
29886
- nullable: true,
29887
- type: 'string',
29888
- },
29889
- monday_program_id: {
29890
- description:
29891
- 'ID of the thermostat daily program to run on Mondays.',
29892
- format: 'uuid',
29893
- nullable: true,
29894
- type: 'string',
29895
- },
29896
- saturday_program_id: {
29897
- description:
29898
- 'ID of the thermostat daily program to run on Saturdays.',
29899
- format: 'uuid',
29900
- nullable: true,
29901
- type: 'string',
29902
- },
29903
- sunday_program_id: {
29904
- description:
29905
- 'ID of the thermostat daily program to run on Sundays.',
29906
- format: 'uuid',
29907
- nullable: true,
29908
- type: 'string',
29909
- },
29910
- thursday_program_id: {
29911
- description:
29912
- 'ID of the thermostat daily program to run on Thursdays.',
29913
- format: 'uuid',
29914
- nullable: true,
29915
- type: 'string',
29916
- },
29917
- tuesday_program_id: {
29918
- description:
29919
- 'ID of the thermostat daily program to run on Tuesdays.',
29920
- format: 'uuid',
29921
- nullable: true,
29922
- type: 'string',
29923
- },
29924
- wednesday_program_id: {
29925
- description:
29926
- 'ID of the thermostat daily program to run on Wednesdays.',
29927
- format: 'uuid',
29928
- nullable: true,
29929
- type: 'string',
29930
- },
29931
- },
29932
- required: [
29933
- 'device_id',
29934
- 'monday_program_id',
29935
- 'tuesday_program_id',
29936
- 'wednesday_program_id',
29937
- 'thursday_program_id',
29938
- 'friday_program_id',
29939
- 'saturday_program_id',
29940
- 'sunday_program_id',
29941
- 'created_at',
29942
- ],
29943
- type: 'object',
29965
+ action_attempt: {
29966
+ $ref: '#/components/schemas/action_attempt',
29944
29967
  },
29968
+ ok: { type: 'boolean' },
29945
29969
  },
29946
- required: ['thermostat_weekly_program', 'ok'],
29970
+ required: ['action_attempt', 'ok'],
29947
29971
  type: 'object',
29948
29972
  },
29949
29973
  },
@@ -29961,10 +29985,11 @@ export default {
29961
29985
  ],
29962
29986
  summary: '/thermostats/activate_weekly_program',
29963
29987
  tags: ['/thermostats'],
29988
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
29964
29989
  'x-fern-sdk-group-name': ['thermostats'],
29965
29990
  'x-fern-sdk-method-name': 'activate_weekly_program',
29966
- 'x-fern-sdk-return-value': 'thermostat_weekly_program',
29967
- 'x-response-key': 'thermostat_weekly_program',
29991
+ 'x-fern-sdk-return-value': 'action_attempt',
29992
+ 'x-response-key': 'action_attempt',
29968
29993
  'x-title': 'Activate a Thermostat Weekly Program',
29969
29994
  'x-undocumented': 'Unreleased.',
29970
29995
  },
@@ -29996,8 +30021,13 @@ export default {
29996
30021
  content: {
29997
30022
  'application/json': {
29998
30023
  schema: {
29999
- properties: { ok: { type: 'boolean' } },
30000
- required: ['ok'],
30024
+ properties: {
30025
+ action_attempt: {
30026
+ $ref: '#/components/schemas/action_attempt',
30027
+ },
30028
+ ok: { type: 'boolean' },
30029
+ },
30030
+ required: ['action_attempt', 'ok'],
30001
30031
  type: 'object',
30002
30032
  },
30003
30033
  },
@@ -30015,9 +30045,11 @@ export default {
30015
30045
  ],
30016
30046
  summary: '/thermostats/clear_weekly_program',
30017
30047
  tags: ['/thermostats'],
30048
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30018
30049
  'x-fern-sdk-group-name': ['thermostats'],
30019
30050
  'x-fern-sdk-method-name': 'clear_weekly_program',
30020
- 'x-response-key': null,
30051
+ 'x-fern-sdk-return-value': 'action_attempt',
30052
+ 'x-response-key': 'action_attempt',
30021
30053
  'x-title': 'Clear a Thermostat Weekly Program',
30022
30054
  'x-undocumented': 'Unreleased.',
30023
30055
  },
@@ -30447,8 +30479,13 @@ export default {
30447
30479
  content: {
30448
30480
  'application/json': {
30449
30481
  schema: {
30450
- properties: { ok: { type: 'boolean' } },
30451
- required: ['ok'],
30482
+ properties: {
30483
+ action_attempt: {
30484
+ $ref: '#/components/schemas/action_attempt',
30485
+ },
30486
+ ok: { type: 'boolean' },
30487
+ },
30488
+ required: ['action_attempt', 'ok'],
30452
30489
  type: 'object',
30453
30490
  },
30454
30491
  },
@@ -30466,8 +30503,9 @@ export default {
30466
30503
  ],
30467
30504
  summary: '/thermostats/daily_programs/update',
30468
30505
  tags: ['/thermostats'],
30506
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30469
30507
  'x-fern-ignore': true,
30470
- 'x-response-key': null,
30508
+ 'x-response-key': 'action_attempt',
30471
30509
  'x-title': 'Update a Thermostat Daily Program',
30472
30510
  'x-undocumented': 'Unreleased.',
30473
30511
  },
@@ -30522,8 +30560,13 @@ export default {
30522
30560
  content: {
30523
30561
  'application/json': {
30524
30562
  schema: {
30525
- properties: { ok: { type: 'boolean' } },
30526
- required: ['ok'],
30563
+ properties: {
30564
+ action_attempt: {
30565
+ $ref: '#/components/schemas/action_attempt',
30566
+ },
30567
+ ok: { type: 'boolean' },
30568
+ },
30569
+ required: ['action_attempt', 'ok'],
30527
30570
  type: 'object',
30528
30571
  },
30529
30572
  },
@@ -30541,9 +30584,11 @@ export default {
30541
30584
  ],
30542
30585
  summary: '/thermostats/daily_programs/update',
30543
30586
  tags: ['/thermostats'],
30587
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30544
30588
  'x-fern-sdk-group-name': ['thermostats', 'daily_programs'],
30545
30589
  'x-fern-sdk-method-name': 'update',
30546
- 'x-response-key': null,
30590
+ 'x-fern-sdk-return-value': 'action_attempt',
30591
+ 'x-response-key': 'action_attempt',
30547
30592
  'x-title': 'Update a Thermostat Daily Program',
30548
30593
  'x-undocumented': 'Unreleased.',
30549
30594
  },