@seamapi/types 1.129.0 → 1.130.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.
Files changed (15) hide show
  1. package/dist/connect.cjs +19 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +87 -12
  4. package/lib/seam/connect/openapi.d.ts +33 -12
  5. package/lib/seam/connect/openapi.js +19 -4
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +54 -0
  8. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +48 -0
  9. package/lib/seam/connect/unstable/models/devices/managed-device.js +9 -0
  10. package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
  11. package/lib/seam/connect/unstable/models/devices/unmanaged-device.d.ts +8 -0
  12. package/package.json +1 -1
  13. package/src/lib/seam/connect/openapi.ts +21 -4
  14. package/src/lib/seam/connect/route-types.ts +54 -0
  15. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +13 -0
package/dist/connect.d.cts CHANGED
@@ -827,6 +827,16 @@ declare const _default: {
827
827
  allOf: ({
828
828
  allOf: ({
829
829
  properties: {
830
+ appearance: {
831
+ properties: {
832
+ name: {
833
+ description: string;
834
+ type: string;
835
+ };
836
+ };
837
+ required: string[];
838
+ type: string;
839
+ };
830
840
  battery: {
831
841
  description: string;
832
842
  properties: {
@@ -896,6 +906,10 @@ declare const _default: {
896
906
  description: string;
897
907
  type: string;
898
908
  };
909
+ nickname: {
910
+ description: string;
911
+ type: string;
912
+ };
899
913
  offline_access_codes_enabled: {
900
914
  description: string;
901
915
  type: string;
@@ -950,6 +964,7 @@ declare const _default: {
950
964
  required: string[];
951
965
  type: string;
952
966
  };
967
+ appearance?: never;
953
968
  battery?: never;
954
969
  battery_level?: never;
955
970
  has_direct_power?: never;
@@ -958,6 +973,7 @@ declare const _default: {
958
973
  manufacturer?: never;
959
974
  model?: never;
960
975
  name?: never;
976
+ nickname?: never;
961
977
  offline_access_codes_enabled?: never;
962
978
  online?: never;
963
979
  online_access_codes_enabled?: never;
@@ -12055,20 +12071,25 @@ declare const _default: {
12055
12071
  };
12056
12072
  };
12057
12073
  security: ({
12058
- access_token: never[];
12059
- seam_workspace: never[];
12060
- seam_client_session_token?: never;
12061
- client_session_token?: never;
12074
+ client_session: never[];
12075
+ pat_with_workspace?: never;
12076
+ console_session?: never;
12077
+ api_key?: never;
12062
12078
  } | {
12063
- seam_client_session_token: never[];
12064
- access_token?: never;
12065
- seam_workspace?: never;
12066
- client_session_token?: never;
12079
+ pat_with_workspace: never[];
12080
+ client_session?: never;
12081
+ console_session?: never;
12082
+ api_key?: never;
12067
12083
  } | {
12068
- client_session_token: never[];
12069
- access_token?: never;
12070
- seam_workspace?: never;
12071
- seam_client_session_token?: never;
12084
+ console_session: never[];
12085
+ client_session?: never;
12086
+ pat_with_workspace?: never;
12087
+ api_key?: never;
12088
+ } | {
12089
+ api_key: never[];
12090
+ client_session?: never;
12091
+ pat_with_workspace?: never;
12092
+ console_session?: never;
12072
12093
  })[];
12073
12094
  summary: string;
12074
12095
  tags: string[];
@@ -18877,6 +18898,12 @@ interface Routes {
18877
18898
  online: boolean;
18878
18899
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
18879
18900
  name: string;
18901
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
18902
+ nickname?: string | undefined;
18903
+ appearance: {
18904
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
18905
+ name: string;
18906
+ };
18880
18907
  model: {
18881
18908
  /** Display name of the device model. */
18882
18909
  display_name: string;
@@ -19367,6 +19394,12 @@ interface Routes {
19367
19394
  online: boolean;
19368
19395
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
19369
19396
  name: string;
19397
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
19398
+ nickname?: string | undefined;
19399
+ appearance: {
19400
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
19401
+ name: string;
19402
+ };
19370
19403
  model: {
19371
19404
  /** Display name of the device model. */
19372
19405
  display_name: string;
@@ -20180,6 +20213,12 @@ interface Routes {
20180
20213
  online: boolean;
20181
20214
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20182
20215
  name: string;
20216
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20217
+ nickname?: string | undefined;
20218
+ appearance: {
20219
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
20220
+ name: string;
20221
+ };
20183
20222
  model: {
20184
20223
  /** Display name of the device model. */
20185
20224
  display_name: string;
@@ -20647,6 +20686,12 @@ interface Routes {
20647
20686
  online: boolean;
20648
20687
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20649
20688
  name: string;
20689
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20690
+ nickname?: string | undefined;
20691
+ appearance: {
20692
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
20693
+ name: string;
20694
+ };
20650
20695
  model: {
20651
20696
  /** Display name of the device model. */
20652
20697
  display_name: string;
@@ -21137,6 +21182,12 @@ interface Routes {
21137
21182
  online: boolean;
21138
21183
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21139
21184
  name: string;
21185
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21186
+ nickname?: string | undefined;
21187
+ appearance: {
21188
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
21189
+ name: string;
21190
+ };
21140
21191
  model: {
21141
21192
  /** Display name of the device model. */
21142
21193
  display_name: string;
@@ -21604,6 +21655,12 @@ interface Routes {
21604
21655
  online: boolean;
21605
21656
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21606
21657
  name: string;
21658
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21659
+ nickname?: string | undefined;
21660
+ appearance: {
21661
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
21662
+ name: string;
21663
+ };
21607
21664
  model: {
21608
21665
  /** Display name of the device model. */
21609
21666
  display_name: string;
@@ -22700,6 +22757,12 @@ interface Routes {
22700
22757
  online: boolean;
22701
22758
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
22702
22759
  name: string;
22760
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
22761
+ nickname?: string | undefined;
22762
+ appearance: {
22763
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
22764
+ name: string;
22765
+ };
22703
22766
  model: {
22704
22767
  /** Display name of the device model. */
22705
22768
  display_name: string;
@@ -23266,6 +23329,12 @@ interface Routes {
23266
23329
  online: boolean;
23267
23330
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
23268
23331
  name: string;
23332
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
23333
+ nickname?: string | undefined;
23334
+ appearance: {
23335
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
23336
+ name: string;
23337
+ };
23269
23338
  model: {
23270
23339
  /** Display name of the device model. */
23271
23340
  display_name: string;
@@ -24017,6 +24086,12 @@ interface Routes {
24017
24086
  online: boolean;
24018
24087
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
24019
24088
  name: string;
24089
+ /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
24090
+ nickname?: string | undefined;
24091
+ appearance: {
24092
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
24093
+ name: string;
24094
+ };
24020
24095
  model: {
24021
24096
  /** Display name of the device model. */
24022
24097
  display_name: string;
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -753,6 +753,16 @@ declare const _default: {
753
753
  allOf: ({
754
754
  allOf: ({
755
755
  properties: {
756
+ appearance: {
757
+ properties: {
758
+ name: {
759
+ description: string;
760
+ type: string;
761
+ };
762
+ };
763
+ required: string[];
764
+ type: string;
765
+ };
756
766
  battery: {
757
767
  description: string;
758
768
  properties: {
@@ -822,6 +832,10 @@ declare const _default: {
822
832
  description: string;
823
833
  type: string;
824
834
  };
835
+ nickname: {
836
+ description: string;
837
+ type: string;
838
+ };
825
839
  offline_access_codes_enabled: {
826
840
  description: string;
827
841
  type: string;
@@ -876,6 +890,7 @@ declare const _default: {
876
890
  required: string[];
877
891
  type: string;
878
892
  };
893
+ appearance?: never;
879
894
  battery?: never;
880
895
  battery_level?: never;
881
896
  has_direct_power?: never;
@@ -884,6 +899,7 @@ declare const _default: {
884
899
  manufacturer?: never;
885
900
  model?: never;
886
901
  name?: never;
902
+ nickname?: never;
887
903
  offline_access_codes_enabled?: never;
888
904
  online?: never;
889
905
  online_access_codes_enabled?: never;
@@ -11981,20 +11997,25 @@ declare const _default: {
11981
11997
  };
11982
11998
  };
11983
11999
  security: ({
11984
- access_token: never[];
11985
- seam_workspace: never[];
11986
- seam_client_session_token?: never;
11987
- client_session_token?: never;
12000
+ client_session: never[];
12001
+ pat_with_workspace?: never;
12002
+ console_session?: never;
12003
+ api_key?: never;
11988
12004
  } | {
11989
- seam_client_session_token: never[];
11990
- access_token?: never;
11991
- seam_workspace?: never;
11992
- client_session_token?: never;
12005
+ pat_with_workspace: never[];
12006
+ client_session?: never;
12007
+ console_session?: never;
12008
+ api_key?: never;
11993
12009
  } | {
11994
- client_session_token: never[];
11995
- access_token?: never;
11996
- seam_workspace?: never;
11997
- seam_client_session_token?: never;
12010
+ console_session: never[];
12011
+ client_session?: never;
12012
+ pat_with_workspace?: never;
12013
+ api_key?: never;
12014
+ } | {
12015
+ api_key: never[];
12016
+ client_session?: never;
12017
+ pat_with_workspace?: never;
12018
+ console_session?: never;
11998
12019
  })[];
11999
12020
  summary: string;
12000
12021
  tags: string[];
package/lib/seam/connect/openapi.js CHANGED
@@ -635,6 +635,16 @@ export default {
635
635
  allOf: [
636
636
  {
637
637
  properties: {
638
+ appearance: {
639
+ properties: {
640
+ name: {
641
+ description: 'Name of the device as seen from the provider API and application, not settable through Seam.',
642
+ type: 'string',
643
+ },
644
+ },
645
+ required: ['name'],
646
+ type: 'object',
647
+ },
638
648
  battery: {
639
649
  description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
640
650
  properties: {
@@ -703,6 +713,10 @@ export default {
703
713
  description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
704
714
  type: 'string',
705
715
  },
716
+ nickname: {
717
+ description: 'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
718
+ type: 'string',
719
+ },
706
720
  offline_access_codes_enabled: {
707
721
  description: 'Indicates whether it is currently possible to use offline access codes for the device.',
708
722
  type: 'boolean',
@@ -728,7 +742,7 @@ export default {
728
742
  type: 'boolean',
729
743
  },
730
744
  },
731
- required: ['online', 'name', 'model'],
745
+ required: ['online', 'name', 'appearance', 'model'],
732
746
  type: 'object',
733
747
  },
734
748
  {
@@ -9133,9 +9147,10 @@ export default {
9133
9147
  401: { description: 'Unauthorized' },
9134
9148
  },
9135
9149
  security: [
9136
- { access_token: [], seam_workspace: [] },
9137
- { seam_client_session_token: [] },
9138
- { client_session_token: [] },
9150
+ { client_session: [] },
9151
+ { pat_with_workspace: [] },
9152
+ { console_session: [] },
9153
+ { api_key: [] },
9139
9154
  ],
9140
9155
  summary: '/locks/unlock_door',
9141
9156
  tags: ['/locks'],