@seamapi/types 1.389.0 → 1.391.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.
@@ -1090,6 +1090,27 @@ export default {
1090
1090
  required: ['message', 'warning_code'],
1091
1091
  type: 'object',
1092
1092
  },
1093
+ {
1094
+ description: 'Duplicate access code name detected.',
1095
+ properties: {
1096
+ created_at: {
1097
+ description: 'Date and time at which Seam created the warning.',
1098
+ format: 'date-time',
1099
+ type: 'string',
1100
+ },
1101
+ message: {
1102
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1103
+ type: 'string',
1104
+ },
1105
+ warning_code: {
1106
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1107
+ enum: ['schlage_detected_duplicate_code_name'],
1108
+ type: 'string',
1109
+ },
1110
+ },
1111
+ required: ['message', 'warning_code'],
1112
+ type: 'object',
1113
+ },
1093
1114
  {
1094
1115
  description: 'Received an error when attempting to create this code.',
1095
1116
  properties: {
@@ -5672,6 +5693,100 @@ export default {
5672
5693
  ],
5673
5694
  type: 'object',
5674
5695
  },
5696
+ {
5697
+ description: 'Pushing thermostat weekly programs.',
5698
+ properties: {
5699
+ action_attempt_id: {
5700
+ description: 'ID of the action attempt.',
5701
+ format: 'uuid',
5702
+ type: 'string',
5703
+ },
5704
+ action_type: {
5705
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
5706
+ type: 'string',
5707
+ },
5708
+ error: {
5709
+ description: 'Errors associated with the action attempt. Null for pending action attempts.',
5710
+ nullable: true,
5711
+ },
5712
+ result: {
5713
+ description: 'Result of the action attempt. Null for pending action attempts.',
5714
+ nullable: true,
5715
+ },
5716
+ status: { enum: ['pending'], type: 'string' },
5717
+ },
5718
+ required: [
5719
+ 'action_attempt_id',
5720
+ 'status',
5721
+ 'result',
5722
+ 'error',
5723
+ 'action_type',
5724
+ ],
5725
+ type: 'object',
5726
+ },
5727
+ {
5728
+ description: 'Pushing thermostat weekly programs succeeded.',
5729
+ properties: {
5730
+ action_attempt_id: {
5731
+ description: 'ID of the action attempt.',
5732
+ format: 'uuid',
5733
+ type: 'string',
5734
+ },
5735
+ action_type: {
5736
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
5737
+ type: 'string',
5738
+ },
5739
+ error: {
5740
+ description: 'Errors associated with the action attempt. Null for successful action attempts.',
5741
+ nullable: true,
5742
+ },
5743
+ result: { properties: {}, type: 'object' },
5744
+ status: { enum: ['success'], type: 'string' },
5745
+ },
5746
+ required: [
5747
+ 'action_attempt_id',
5748
+ 'status',
5749
+ 'error',
5750
+ 'action_type',
5751
+ 'result',
5752
+ ],
5753
+ type: 'object',
5754
+ },
5755
+ {
5756
+ description: 'Pushing thermostat weekly programs failed.',
5757
+ properties: {
5758
+ action_attempt_id: {
5759
+ description: 'ID of the action attempt.',
5760
+ format: 'uuid',
5761
+ type: 'string',
5762
+ },
5763
+ action_type: {
5764
+ enum: ['PUSH_THERMOSTAT_PROGRAMS'],
5765
+ type: 'string',
5766
+ },
5767
+ error: {
5768
+ properties: {
5769
+ message: { type: 'string' },
5770
+ type: { type: 'string' },
5771
+ },
5772
+ required: ['type', 'message'],
5773
+ type: 'object',
5774
+ },
5775
+ result: {
5776
+ description: 'Result of the action attempt. Null for failed action attempts.',
5777
+ nullable: true,
5778
+ },
5779
+ status: { enum: ['error'], type: 'string' },
5780
+ },
5781
+ required: [
5782
+ 'action_attempt_id',
5783
+ 'status',
5784
+ 'result',
5785
+ 'action_type',
5786
+ 'error',
5787
+ ],
5788
+ type: 'object',
5789
+ },
5675
5790
  {
5676
5791
  properties: {
5677
5792
  action_attempt_id: {
@@ -14802,6 +14917,27 @@ export default {
14802
14917
  required: ['message', 'warning_code'],
14803
14918
  type: 'object',
14804
14919
  },
14920
+ {
14921
+ description: 'Duplicate access code name detected.',
14922
+ properties: {
14923
+ created_at: {
14924
+ description: 'Date and time at which Seam created the warning.',
14925
+ format: 'date-time',
14926
+ type: 'string',
14927
+ },
14928
+ message: {
14929
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
14930
+ type: 'string',
14931
+ },
14932
+ warning_code: {
14933
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
14934
+ enum: ['schlage_detected_duplicate_code_name'],
14935
+ type: 'string',
14936
+ },
14937
+ },
14938
+ required: ['message', 'warning_code'],
14939
+ type: 'object',
14940
+ },
14805
14941
  {
14806
14942
  description: 'Received an error when attempting to create this code.',
14807
14943
  properties: {
@@ -27826,77 +27962,12 @@ export default {
27826
27962
  'application/json': {
27827
27963
  schema: {
27828
27964
  properties: {
27829
- ok: { type: 'boolean' },
27830
- thermostat_weekly_program: {
27831
- properties: {
27832
- created_at: {
27833
- description: 'Date and time at which the thermostat weekly program was created.',
27834
- format: 'date-time',
27835
- type: 'string',
27836
- },
27837
- device_id: {
27838
- description: 'ID of the thermostat device the weekly program is for.',
27839
- format: 'uuid',
27840
- type: 'string',
27841
- },
27842
- friday_program_id: {
27843
- description: 'ID of the thermostat daily program to run on Fridays.',
27844
- format: 'uuid',
27845
- nullable: true,
27846
- type: 'string',
27847
- },
27848
- monday_program_id: {
27849
- description: 'ID of the thermostat daily program to run on Mondays.',
27850
- format: 'uuid',
27851
- nullable: true,
27852
- type: 'string',
27853
- },
27854
- saturday_program_id: {
27855
- description: 'ID of the thermostat daily program to run on Saturdays.',
27856
- format: 'uuid',
27857
- nullable: true,
27858
- type: 'string',
27859
- },
27860
- sunday_program_id: {
27861
- description: 'ID of the thermostat daily program to run on Sundays.',
27862
- format: 'uuid',
27863
- nullable: true,
27864
- type: 'string',
27865
- },
27866
- thursday_program_id: {
27867
- description: 'ID of the thermostat daily program to run on Thursdays.',
27868
- format: 'uuid',
27869
- nullable: true,
27870
- type: 'string',
27871
- },
27872
- tuesday_program_id: {
27873
- description: 'ID of the thermostat daily program to run on Tuesdays.',
27874
- format: 'uuid',
27875
- nullable: true,
27876
- type: 'string',
27877
- },
27878
- wednesday_program_id: {
27879
- description: 'ID of the thermostat daily program to run on Wednesdays.',
27880
- format: 'uuid',
27881
- nullable: true,
27882
- type: 'string',
27883
- },
27884
- },
27885
- required: [
27886
- 'device_id',
27887
- 'monday_program_id',
27888
- 'tuesday_program_id',
27889
- 'wednesday_program_id',
27890
- 'thursday_program_id',
27891
- 'friday_program_id',
27892
- 'saturday_program_id',
27893
- 'sunday_program_id',
27894
- 'created_at',
27895
- ],
27896
- type: 'object',
27965
+ action_attempt: {
27966
+ $ref: '#/components/schemas/action_attempt',
27897
27967
  },
27968
+ ok: { type: 'boolean' },
27898
27969
  },
27899
- required: ['thermostat_weekly_program', 'ok'],
27970
+ required: ['action_attempt', 'ok'],
27900
27971
  type: 'object',
27901
27972
  },
27902
27973
  },
@@ -27914,10 +27985,11 @@ export default {
27914
27985
  ],
27915
27986
  summary: '/thermostats/activate_weekly_program',
27916
27987
  tags: ['/thermostats'],
27988
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
27917
27989
  'x-fern-sdk-group-name': ['thermostats'],
27918
27990
  'x-fern-sdk-method-name': 'activate_weekly_program',
27919
- 'x-fern-sdk-return-value': 'thermostat_weekly_program',
27920
- 'x-response-key': 'thermostat_weekly_program',
27991
+ 'x-fern-sdk-return-value': 'action_attempt',
27992
+ 'x-response-key': 'action_attempt',
27921
27993
  'x-title': 'Activate a Thermostat Weekly Program',
27922
27994
  'x-undocumented': 'Unreleased.',
27923
27995
  },
@@ -27948,8 +28020,13 @@ export default {
27948
28020
  content: {
27949
28021
  'application/json': {
27950
28022
  schema: {
27951
- properties: { ok: { type: 'boolean' } },
27952
- required: ['ok'],
28023
+ properties: {
28024
+ action_attempt: {
28025
+ $ref: '#/components/schemas/action_attempt',
28026
+ },
28027
+ ok: { type: 'boolean' },
28028
+ },
28029
+ required: ['action_attempt', 'ok'],
27953
28030
  type: 'object',
27954
28031
  },
27955
28032
  },
@@ -27967,9 +28044,11 @@ export default {
27967
28044
  ],
27968
28045
  summary: '/thermostats/clear_weekly_program',
27969
28046
  tags: ['/thermostats'],
28047
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
27970
28048
  'x-fern-sdk-group-name': ['thermostats'],
27971
28049
  'x-fern-sdk-method-name': 'clear_weekly_program',
27972
- 'x-response-key': null,
28050
+ 'x-fern-sdk-return-value': 'action_attempt',
28051
+ 'x-response-key': 'action_attempt',
27973
28052
  'x-title': 'Clear a Thermostat Weekly Program',
27974
28053
  'x-undocumented': 'Unreleased.',
27975
28054
  },
@@ -28373,8 +28452,13 @@ export default {
28373
28452
  content: {
28374
28453
  'application/json': {
28375
28454
  schema: {
28376
- properties: { ok: { type: 'boolean' } },
28377
- required: ['ok'],
28455
+ properties: {
28456
+ action_attempt: {
28457
+ $ref: '#/components/schemas/action_attempt',
28458
+ },
28459
+ ok: { type: 'boolean' },
28460
+ },
28461
+ required: ['action_attempt', 'ok'],
28378
28462
  type: 'object',
28379
28463
  },
28380
28464
  },
@@ -28392,8 +28476,9 @@ export default {
28392
28476
  ],
28393
28477
  summary: '/thermostats/daily_programs/update',
28394
28478
  tags: ['/thermostats'],
28479
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
28395
28480
  'x-fern-ignore': true,
28396
- 'x-response-key': null,
28481
+ 'x-response-key': 'action_attempt',
28397
28482
  'x-title': 'Update a Thermostat Daily Program',
28398
28483
  'x-undocumented': 'Unreleased.',
28399
28484
  },
@@ -28445,8 +28530,13 @@ export default {
28445
28530
  content: {
28446
28531
  'application/json': {
28447
28532
  schema: {
28448
- properties: { ok: { type: 'boolean' } },
28449
- required: ['ok'],
28533
+ properties: {
28534
+ action_attempt: {
28535
+ $ref: '#/components/schemas/action_attempt',
28536
+ },
28537
+ ok: { type: 'boolean' },
28538
+ },
28539
+ required: ['action_attempt', 'ok'],
28450
28540
  type: 'object',
28451
28541
  },
28452
28542
  },
@@ -28464,9 +28554,11 @@ export default {
28464
28554
  ],
28465
28555
  summary: '/thermostats/daily_programs/update',
28466
28556
  tags: ['/thermostats'],
28557
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
28467
28558
  'x-fern-sdk-group-name': ['thermostats', 'daily_programs'],
28468
28559
  'x-fern-sdk-method-name': 'update',
28469
- 'x-response-key': null,
28560
+ 'x-fern-sdk-return-value': 'action_attempt',
28561
+ 'x-response-key': 'action_attempt',
28470
28562
  'x-title': 'Update a Thermostat Daily Program',
28471
28563
  'x-undocumented': 'Unreleased.',
28472
28564
  },