@seamapi/types 1.793.0 → 1.795.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.
@@ -2157,6 +2157,83 @@ export type Routes = {
2157
2157
  is_overridable?: boolean | undefined
2158
2158
  } | null)
2159
2159
  | undefined
2160
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
2161
+ pending_mutations: (
2162
+ | {
2163
+ /** Date and time at which the mutation was created. */
2164
+ created_at: string
2165
+ /** Detailed description of the mutation. */
2166
+ message: string
2167
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
2168
+ mutation_code: 'creating'
2169
+ }
2170
+ | {
2171
+ /** Date and time at which the mutation was created. */
2172
+ created_at: string
2173
+ /** Detailed description of the mutation. */
2174
+ message: string
2175
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
2176
+ mutation_code: 'deleting'
2177
+ }
2178
+ | {
2179
+ /** Date and time at which the mutation was created. */
2180
+ created_at: string
2181
+ /** Detailed description of the mutation. */
2182
+ message: string
2183
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
2184
+ mutation_code: 'updating_code'
2185
+ /** Previous code configuration. */
2186
+ from: {
2187
+ /** Previous PIN code. */
2188
+ code: string | null
2189
+ }
2190
+ /** New code configuration. */
2191
+ to: {
2192
+ /** New PIN code. */
2193
+ code: string | null
2194
+ }
2195
+ }
2196
+ | {
2197
+ /** Date and time at which the mutation was created. */
2198
+ created_at: string
2199
+ /** Detailed description of the mutation. */
2200
+ message: string
2201
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
2202
+ mutation_code: 'updating_name'
2203
+ /** Previous name configuration. */
2204
+ from: {
2205
+ /** Previous access code name. */
2206
+ name: string | null
2207
+ }
2208
+ /** New name configuration. */
2209
+ to: {
2210
+ /** New access code name. */
2211
+ name: string | null
2212
+ }
2213
+ }
2214
+ | {
2215
+ /** Date and time at which the mutation was created. */
2216
+ created_at: string
2217
+ /** Detailed description of the mutation. */
2218
+ message: string
2219
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
2220
+ mutation_code: 'updating_time_frame'
2221
+ /** Previous time frame configuration. */
2222
+ from: {
2223
+ /** Previous start time for the access code. */
2224
+ starts_at: string | null
2225
+ /** Previous end time for the access code. */
2226
+ ends_at: string | null
2227
+ }
2228
+ /** New time frame configuration. */
2229
+ to: {
2230
+ /** New start time for the access code. */
2231
+ starts_at: string | null
2232
+ /** New end time for the access code. */
2233
+ ends_at: string | null
2234
+ }
2235
+ }
2236
+ )[]
2160
2237
  }
2161
2238
  }
2162
2239
  maxDuration: undefined
@@ -2761,6 +2838,83 @@ export type Routes = {
2761
2838
  is_overridable?: boolean | undefined
2762
2839
  } | null)
2763
2840
  | undefined
2841
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
2842
+ pending_mutations: (
2843
+ | {
2844
+ /** Date and time at which the mutation was created. */
2845
+ created_at: string
2846
+ /** Detailed description of the mutation. */
2847
+ message: string
2848
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
2849
+ mutation_code: 'creating'
2850
+ }
2851
+ | {
2852
+ /** Date and time at which the mutation was created. */
2853
+ created_at: string
2854
+ /** Detailed description of the mutation. */
2855
+ message: string
2856
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
2857
+ mutation_code: 'deleting'
2858
+ }
2859
+ | {
2860
+ /** Date and time at which the mutation was created. */
2861
+ created_at: string
2862
+ /** Detailed description of the mutation. */
2863
+ message: string
2864
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
2865
+ mutation_code: 'updating_code'
2866
+ /** Previous code configuration. */
2867
+ from: {
2868
+ /** Previous PIN code. */
2869
+ code: string | null
2870
+ }
2871
+ /** New code configuration. */
2872
+ to: {
2873
+ /** New PIN code. */
2874
+ code: string | null
2875
+ }
2876
+ }
2877
+ | {
2878
+ /** Date and time at which the mutation was created. */
2879
+ created_at: string
2880
+ /** Detailed description of the mutation. */
2881
+ message: string
2882
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
2883
+ mutation_code: 'updating_name'
2884
+ /** Previous name configuration. */
2885
+ from: {
2886
+ /** Previous access code name. */
2887
+ name: string | null
2888
+ }
2889
+ /** New name configuration. */
2890
+ to: {
2891
+ /** New access code name. */
2892
+ name: string | null
2893
+ }
2894
+ }
2895
+ | {
2896
+ /** Date and time at which the mutation was created. */
2897
+ created_at: string
2898
+ /** Detailed description of the mutation. */
2899
+ message: string
2900
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
2901
+ mutation_code: 'updating_time_frame'
2902
+ /** Previous time frame configuration. */
2903
+ from: {
2904
+ /** Previous start time for the access code. */
2905
+ starts_at: string | null
2906
+ /** Previous end time for the access code. */
2907
+ ends_at: string | null
2908
+ }
2909
+ /** New time frame configuration. */
2910
+ to: {
2911
+ /** New start time for the access code. */
2912
+ starts_at: string | null
2913
+ /** New end time for the access code. */
2914
+ ends_at: string | null
2915
+ }
2916
+ }
2917
+ )[]
2764
2918
  }[]
2765
2919
  }
2766
2920
  maxDuration: undefined
@@ -4925,6 +5079,83 @@ export type Routes = {
4925
5079
  is_overridable?: boolean | undefined
4926
5080
  } | null)
4927
5081
  | undefined
5082
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
5083
+ pending_mutations: (
5084
+ | {
5085
+ /** Date and time at which the mutation was created. */
5086
+ created_at: string
5087
+ /** Detailed description of the mutation. */
5088
+ message: string
5089
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
5090
+ mutation_code: 'creating'
5091
+ }
5092
+ | {
5093
+ /** Date and time at which the mutation was created. */
5094
+ created_at: string
5095
+ /** Detailed description of the mutation. */
5096
+ message: string
5097
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
5098
+ mutation_code: 'deleting'
5099
+ }
5100
+ | {
5101
+ /** Date and time at which the mutation was created. */
5102
+ created_at: string
5103
+ /** Detailed description of the mutation. */
5104
+ message: string
5105
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
5106
+ mutation_code: 'updating_code'
5107
+ /** Previous code configuration. */
5108
+ from: {
5109
+ /** Previous PIN code. */
5110
+ code: string | null
5111
+ }
5112
+ /** New code configuration. */
5113
+ to: {
5114
+ /** New PIN code. */
5115
+ code: string | null
5116
+ }
5117
+ }
5118
+ | {
5119
+ /** Date and time at which the mutation was created. */
5120
+ created_at: string
5121
+ /** Detailed description of the mutation. */
5122
+ message: string
5123
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
5124
+ mutation_code: 'updating_name'
5125
+ /** Previous name configuration. */
5126
+ from: {
5127
+ /** Previous access code name. */
5128
+ name: string | null
5129
+ }
5130
+ /** New name configuration. */
5131
+ to: {
5132
+ /** New access code name. */
5133
+ name: string | null
5134
+ }
5135
+ }
5136
+ | {
5137
+ /** Date and time at which the mutation was created. */
5138
+ created_at: string
5139
+ /** Detailed description of the mutation. */
5140
+ message: string
5141
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
5142
+ mutation_code: 'updating_time_frame'
5143
+ /** Previous time frame configuration. */
5144
+ from: {
5145
+ /** Previous start time for the access code. */
5146
+ starts_at: string | null
5147
+ /** Previous end time for the access code. */
5148
+ ends_at: string | null
5149
+ }
5150
+ /** New time frame configuration. */
5151
+ to: {
5152
+ /** New start time for the access code. */
5153
+ starts_at: string | null
5154
+ /** New end time for the access code. */
5155
+ ends_at: string | null
5156
+ }
5157
+ }
5158
+ )[]
4928
5159
  }
4929
5160
  }
4930
5161
  maxDuration: undefined
@@ -5618,6 +5849,83 @@ export type Routes = {
5618
5849
  is_overridable?: boolean | undefined
5619
5850
  } | null)
5620
5851
  | undefined
5852
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
5853
+ pending_mutations: (
5854
+ | {
5855
+ /** Date and time at which the mutation was created. */
5856
+ created_at: string
5857
+ /** Detailed description of the mutation. */
5858
+ message: string
5859
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
5860
+ mutation_code: 'creating'
5861
+ }
5862
+ | {
5863
+ /** Date and time at which the mutation was created. */
5864
+ created_at: string
5865
+ /** Detailed description of the mutation. */
5866
+ message: string
5867
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
5868
+ mutation_code: 'deleting'
5869
+ }
5870
+ | {
5871
+ /** Date and time at which the mutation was created. */
5872
+ created_at: string
5873
+ /** Detailed description of the mutation. */
5874
+ message: string
5875
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
5876
+ mutation_code: 'updating_code'
5877
+ /** Previous code configuration. */
5878
+ from: {
5879
+ /** Previous PIN code. */
5880
+ code: string | null
5881
+ }
5882
+ /** New code configuration. */
5883
+ to: {
5884
+ /** New PIN code. */
5885
+ code: string | null
5886
+ }
5887
+ }
5888
+ | {
5889
+ /** Date and time at which the mutation was created. */
5890
+ created_at: string
5891
+ /** Detailed description of the mutation. */
5892
+ message: string
5893
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
5894
+ mutation_code: 'updating_name'
5895
+ /** Previous name configuration. */
5896
+ from: {
5897
+ /** Previous access code name. */
5898
+ name: string | null
5899
+ }
5900
+ /** New name configuration. */
5901
+ to: {
5902
+ /** New access code name. */
5903
+ name: string | null
5904
+ }
5905
+ }
5906
+ | {
5907
+ /** Date and time at which the mutation was created. */
5908
+ created_at: string
5909
+ /** Detailed description of the mutation. */
5910
+ message: string
5911
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
5912
+ mutation_code: 'updating_time_frame'
5913
+ /** Previous time frame configuration. */
5914
+ from: {
5915
+ /** Previous start time for the access code. */
5916
+ starts_at: string | null
5917
+ /** Previous end time for the access code. */
5918
+ ends_at: string | null
5919
+ }
5920
+ /** New time frame configuration. */
5921
+ to: {
5922
+ /** New start time for the access code. */
5923
+ starts_at: string | null
5924
+ /** New end time for the access code. */
5925
+ ends_at: string | null
5926
+ }
5927
+ }
5928
+ )[]
5621
5929
  }[]
5622
5930
  /** Information about the current page of results. */
5623
5931
  pagination: {
@@ -6213,6 +6521,83 @@ export type Routes = {
6213
6521
  is_overridable?: boolean | undefined
6214
6522
  } | null)
6215
6523
  | undefined
6524
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
6525
+ pending_mutations: (
6526
+ | {
6527
+ /** Date and time at which the mutation was created. */
6528
+ created_at: string
6529
+ /** Detailed description of the mutation. */
6530
+ message: string
6531
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
6532
+ mutation_code: 'creating'
6533
+ }
6534
+ | {
6535
+ /** Date and time at which the mutation was created. */
6536
+ created_at: string
6537
+ /** Detailed description of the mutation. */
6538
+ message: string
6539
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
6540
+ mutation_code: 'deleting'
6541
+ }
6542
+ | {
6543
+ /** Date and time at which the mutation was created. */
6544
+ created_at: string
6545
+ /** Detailed description of the mutation. */
6546
+ message: string
6547
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
6548
+ mutation_code: 'updating_code'
6549
+ /** Previous code configuration. */
6550
+ from: {
6551
+ /** Previous PIN code. */
6552
+ code: string | null
6553
+ }
6554
+ /** New code configuration. */
6555
+ to: {
6556
+ /** New PIN code. */
6557
+ code: string | null
6558
+ }
6559
+ }
6560
+ | {
6561
+ /** Date and time at which the mutation was created. */
6562
+ created_at: string
6563
+ /** Detailed description of the mutation. */
6564
+ message: string
6565
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
6566
+ mutation_code: 'updating_name'
6567
+ /** Previous name configuration. */
6568
+ from: {
6569
+ /** Previous access code name. */
6570
+ name: string | null
6571
+ }
6572
+ /** New name configuration. */
6573
+ to: {
6574
+ /** New access code name. */
6575
+ name: string | null
6576
+ }
6577
+ }
6578
+ | {
6579
+ /** Date and time at which the mutation was created. */
6580
+ created_at: string
6581
+ /** Detailed description of the mutation. */
6582
+ message: string
6583
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
6584
+ mutation_code: 'updating_time_frame'
6585
+ /** Previous time frame configuration. */
6586
+ from: {
6587
+ /** Previous start time for the access code. */
6588
+ starts_at: string | null
6589
+ /** Previous end time for the access code. */
6590
+ ends_at: string | null
6591
+ }
6592
+ /** New time frame configuration. */
6593
+ to: {
6594
+ /** New start time for the access code. */
6595
+ starts_at: string | null
6596
+ /** New end time for the access code. */
6597
+ ends_at: string | null
6598
+ }
6599
+ }
6600
+ )[]
6216
6601
  }
6217
6602
  /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
6218
6603
 
@@ -6785,6 +7170,83 @@ export type Routes = {
6785
7170
  is_overridable?: boolean | undefined
6786
7171
  } | null)
6787
7172
  | undefined
7173
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
7174
+ pending_mutations: (
7175
+ | {
7176
+ /** Date and time at which the mutation was created. */
7177
+ created_at: string
7178
+ /** Detailed description of the mutation. */
7179
+ message: string
7180
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
7181
+ mutation_code: 'creating'
7182
+ }
7183
+ | {
7184
+ /** Date and time at which the mutation was created. */
7185
+ created_at: string
7186
+ /** Detailed description of the mutation. */
7187
+ message: string
7188
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
7189
+ mutation_code: 'deleting'
7190
+ }
7191
+ | {
7192
+ /** Date and time at which the mutation was created. */
7193
+ created_at: string
7194
+ /** Detailed description of the mutation. */
7195
+ message: string
7196
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
7197
+ mutation_code: 'updating_code'
7198
+ /** Previous code configuration. */
7199
+ from: {
7200
+ /** Previous PIN code. */
7201
+ code: string | null
7202
+ }
7203
+ /** New code configuration. */
7204
+ to: {
7205
+ /** New PIN code. */
7206
+ code: string | null
7207
+ }
7208
+ }
7209
+ | {
7210
+ /** Date and time at which the mutation was created. */
7211
+ created_at: string
7212
+ /** Detailed description of the mutation. */
7213
+ message: string
7214
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
7215
+ mutation_code: 'updating_name'
7216
+ /** Previous name configuration. */
7217
+ from: {
7218
+ /** Previous access code name. */
7219
+ name: string | null
7220
+ }
7221
+ /** New name configuration. */
7222
+ to: {
7223
+ /** New access code name. */
7224
+ name: string | null
7225
+ }
7226
+ }
7227
+ | {
7228
+ /** Date and time at which the mutation was created. */
7229
+ created_at: string
7230
+ /** Detailed description of the mutation. */
7231
+ message: string
7232
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
7233
+ mutation_code: 'updating_time_frame'
7234
+ /** Previous time frame configuration. */
7235
+ from: {
7236
+ /** Previous start time for the access code. */
7237
+ starts_at: string | null
7238
+ /** Previous end time for the access code. */
7239
+ ends_at: string | null
7240
+ }
7241
+ /** New time frame configuration. */
7242
+ to: {
7243
+ /** New start time for the access code. */
7244
+ starts_at: string | null
7245
+ /** New end time for the access code. */
7246
+ ends_at: string | null
7247
+ }
7248
+ }
7249
+ )[]
6788
7250
  }
6789
7251
  }
6790
7252
  maxDuration: undefined
@@ -118203,6 +118665,83 @@ export type Routes = {
118203
118665
  is_overridable?: boolean | undefined
118204
118666
  } | null)
118205
118667
  | undefined
118668
+ /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
118669
+ pending_mutations: (
118670
+ | {
118671
+ /** Date and time at which the mutation was created. */
118672
+ created_at: string
118673
+ /** Detailed description of the mutation. */
118674
+ message: string
118675
+ /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
118676
+ mutation_code: 'creating'
118677
+ }
118678
+ | {
118679
+ /** Date and time at which the mutation was created. */
118680
+ created_at: string
118681
+ /** Detailed description of the mutation. */
118682
+ message: string
118683
+ /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
118684
+ mutation_code: 'deleting'
118685
+ }
118686
+ | {
118687
+ /** Date and time at which the mutation was created. */
118688
+ created_at: string
118689
+ /** Detailed description of the mutation. */
118690
+ message: string
118691
+ /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
118692
+ mutation_code: 'updating_code'
118693
+ /** Previous code configuration. */
118694
+ from: {
118695
+ /** Previous PIN code. */
118696
+ code: string | null
118697
+ }
118698
+ /** New code configuration. */
118699
+ to: {
118700
+ /** New PIN code. */
118701
+ code: string | null
118702
+ }
118703
+ }
118704
+ | {
118705
+ /** Date and time at which the mutation was created. */
118706
+ created_at: string
118707
+ /** Detailed description of the mutation. */
118708
+ message: string
118709
+ /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
118710
+ mutation_code: 'updating_name'
118711
+ /** Previous name configuration. */
118712
+ from: {
118713
+ /** Previous access code name. */
118714
+ name: string | null
118715
+ }
118716
+ /** New name configuration. */
118717
+ to: {
118718
+ /** New access code name. */
118719
+ name: string | null
118720
+ }
118721
+ }
118722
+ | {
118723
+ /** Date and time at which the mutation was created. */
118724
+ created_at: string
118725
+ /** Detailed description of the mutation. */
118726
+ message: string
118727
+ /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
118728
+ mutation_code: 'updating_time_frame'
118729
+ /** Previous time frame configuration. */
118730
+ from: {
118731
+ /** Previous start time for the access code. */
118732
+ starts_at: string | null
118733
+ /** Previous end time for the access code. */
118734
+ ends_at: string | null
118735
+ }
118736
+ /** New time frame configuration. */
118737
+ to: {
118738
+ /** New start time for the access code. */
118739
+ starts_at: string | null
118740
+ /** New end time for the access code. */
118741
+ ends_at: string | null
118742
+ }
118743
+ }
118744
+ )[]
118206
118745
  }[]
118207
118746
  | undefined
118208
118747
  thermostat_daily_programs?: