@seamapi/types 1.407.0 → 1.408.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 (30) hide show
  1. package/dist/connect.cjs +7138 -5344
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3890 -1270
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
  8. package/lib/seam/connect/models/access-grants/access-grant.js +7 -2
  9. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  10. package/lib/seam/connect/models/index.d.ts +1 -0
  11. package/lib/seam/connect/models/index.js +1 -0
  12. package/lib/seam/connect/models/index.js.map +1 -1
  13. package/lib/seam/connect/models/spaces/index.d.ts +1 -0
  14. package/lib/seam/connect/models/spaces/index.js +2 -0
  15. package/lib/seam/connect/models/spaces/index.js.map +1 -0
  16. package/lib/seam/connect/models/spaces/space.d.ts +21 -0
  17. package/lib/seam/connect/models/spaces/space.js +15 -0
  18. package/lib/seam/connect/models/spaces/space.js.map +1 -0
  19. package/lib/seam/connect/openapi.d.ts +5941 -3781
  20. package/lib/seam/connect/openapi.js +6886 -5092
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +473 -13
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  25. package/src/lib/seam/connect/models/access-grants/access-grant.ts +7 -2
  26. package/src/lib/seam/connect/models/index.ts +1 -0
  27. package/src/lib/seam/connect/models/spaces/index.ts +1 -0
  28. package/src/lib/seam/connect/models/spaces/space.ts +19 -0
  29. package/src/lib/seam/connect/openapi.ts +7390 -5521
  30. package/src/lib/seam/connect/route-types.ts +478 -13
@@ -8867,6 +8867,271 @@ export interface Routes {
8867
8867
  formData: {};
8868
8868
  jsonResponse: {};
8869
8869
  };
8870
+ '/access_grants/create': {
8871
+ route: '/access_grants/create';
8872
+ method: 'POST';
8873
+ queryParams: {};
8874
+ jsonBody: {};
8875
+ commonParams: ({
8876
+ /** ID of user identity for whom access is being granted. */
8877
+ user_identity_id: string;
8878
+ } | {
8879
+ /** When used, creates a new user identity with the given details, and grants them access. */
8880
+ user_identity: {
8881
+ /** Unique email address for the user identity. */
8882
+ email_address?: (string | null) | undefined;
8883
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
8884
+ phone_number?: (string | null) | undefined;
8885
+ full_name?: (string | null) | undefined;
8886
+ };
8887
+ }) & {
8888
+ /**
8889
+ * @deprecated Use `space_ids`. */
8890
+ location_ids?: string[] | undefined;
8891
+ /** Set of IDs of existing spaces to which access is being granted. */
8892
+ space_ids?: string[] | undefined;
8893
+ /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
8894
+ location?: {
8895
+ /** Name of the location. */
8896
+ name?: string | undefined;
8897
+ /**
8898
+ * @deprecated Use `acs_entrance_ids` at the top level. */
8899
+ acs_entrance_ids?: string[];
8900
+ /**
8901
+ * @deprecated Use `device_ids` at the top level. */
8902
+ device_ids?: string[];
8903
+ } | undefined;
8904
+ /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted. */
8905
+ acs_entrance_ids?: string[];
8906
+ /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
8907
+ device_ids?: string[];
8908
+ requested_access_methods: Array<{
8909
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
8910
+ mode: 'code' | 'card' | 'mobile_key';
8911
+ }>;
8912
+ /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
8913
+ starts_at?: string | undefined;
8914
+ /** Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
8915
+ ends_at?: string | undefined;
8916
+ };
8917
+ formData: {};
8918
+ jsonResponse: {
8919
+ /** */
8920
+ access_grant: {
8921
+ /** Unique identifier for the Seam workspace associated with the access grant. */
8922
+ workspace_id: string;
8923
+ /** ID of the access grant. */
8924
+ access_grant_id: string;
8925
+ /** ID of user identity to which access is being granted. */
8926
+ user_identity_id: string;
8927
+ /**
8928
+ * @deprecated Use `space_ids`. */
8929
+ location_ids: string[];
8930
+ /** IDs of the spaces to which access is being given. */
8931
+ space_ids: string[];
8932
+ /** Access methods that the user requested for this access grant. */
8933
+ requested_access_methods: Array<{
8934
+ /** Display name of the access method. */
8935
+ display_name: string;
8936
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
8937
+ mode: 'code' | 'card' | 'mobile_key';
8938
+ /** Date and time at which the requested access method was added to this access grant. */
8939
+ created_at: string;
8940
+ /** IDs of the access methods that were created for this requested access method. */
8941
+ created_access_method_ids: string[];
8942
+ }>;
8943
+ /** IDs of the access methods that were created for this access grant. */
8944
+ access_method_ids: string[];
8945
+ /** Display name of the access grant. */
8946
+ display_name: string;
8947
+ /** Date and time at which the access grant was created. */
8948
+ created_at: string;
8949
+ };
8950
+ };
8951
+ };
8952
+ '/access_grants/delete': {
8953
+ route: '/access_grants/delete';
8954
+ method: 'GET' | 'POST';
8955
+ queryParams: {};
8956
+ jsonBody: {};
8957
+ commonParams: {
8958
+ /** ID of access grant to delete. */
8959
+ access_grant_id: string;
8960
+ };
8961
+ formData: {};
8962
+ jsonResponse: {};
8963
+ };
8964
+ '/access_grants/get': {
8965
+ route: '/access_grants/get';
8966
+ method: 'GET' | 'POST';
8967
+ queryParams: {};
8968
+ jsonBody: {};
8969
+ commonParams: {
8970
+ /** ID of access grant to get. */
8971
+ access_grant_id: string;
8972
+ };
8973
+ formData: {};
8974
+ jsonResponse: {
8975
+ /** */
8976
+ access_grant: {
8977
+ /** Unique identifier for the Seam workspace associated with the access grant. */
8978
+ workspace_id: string;
8979
+ /** ID of the access grant. */
8980
+ access_grant_id: string;
8981
+ /** ID of user identity to which access is being granted. */
8982
+ user_identity_id: string;
8983
+ /**
8984
+ * @deprecated Use `space_ids`. */
8985
+ location_ids: string[];
8986
+ /** IDs of the spaces to which access is being given. */
8987
+ space_ids: string[];
8988
+ /** Access methods that the user requested for this access grant. */
8989
+ requested_access_methods: Array<{
8990
+ /** Display name of the access method. */
8991
+ display_name: string;
8992
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
8993
+ mode: 'code' | 'card' | 'mobile_key';
8994
+ /** Date and time at which the requested access method was added to this access grant. */
8995
+ created_at: string;
8996
+ /** IDs of the access methods that were created for this requested access method. */
8997
+ created_access_method_ids: string[];
8998
+ }>;
8999
+ /** IDs of the access methods that were created for this access grant. */
9000
+ access_method_ids: string[];
9001
+ /** Display name of the access grant. */
9002
+ display_name: string;
9003
+ /** Date and time at which the access grant was created. */
9004
+ created_at: string;
9005
+ };
9006
+ };
9007
+ };
9008
+ '/access_grants/list': {
9009
+ route: '/access_grants/list';
9010
+ method: 'GET' | 'POST';
9011
+ queryParams: {};
9012
+ jsonBody: {};
9013
+ commonParams: {
9014
+ /** ID of user identity to filter list of access grants by. */
9015
+ user_identity_id?: string | undefined;
9016
+ /** ID of system to filter list of access grants by. */
9017
+ acs_system_id?: string | undefined;
9018
+ /** ID of entrance to filter list of access grants by. */
9019
+ acs_entrance_id?: string | undefined;
9020
+ /**
9021
+ * @deprecated Use `space_id`. */
9022
+ location_id?: string | undefined;
9023
+ /** ID of space to filter list of access grants by. */
9024
+ space_id?: string | undefined;
9025
+ };
9026
+ formData: {};
9027
+ jsonResponse: {
9028
+ access_grants: Array<{
9029
+ /** Unique identifier for the Seam workspace associated with the access grant. */
9030
+ workspace_id: string;
9031
+ /** ID of the access grant. */
9032
+ access_grant_id: string;
9033
+ /** ID of user identity to which access is being granted. */
9034
+ user_identity_id: string;
9035
+ /**
9036
+ * @deprecated Use `space_ids`. */
9037
+ location_ids: string[];
9038
+ /** IDs of the spaces to which access is being given. */
9039
+ space_ids: string[];
9040
+ /** Access methods that the user requested for this access grant. */
9041
+ requested_access_methods: Array<{
9042
+ /** Display name of the access method. */
9043
+ display_name: string;
9044
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
9045
+ mode: 'code' | 'card' | 'mobile_key';
9046
+ /** Date and time at which the requested access method was added to this access grant. */
9047
+ created_at: string;
9048
+ /** IDs of the access methods that were created for this requested access method. */
9049
+ created_access_method_ids: string[];
9050
+ }>;
9051
+ /** IDs of the access methods that were created for this access grant. */
9052
+ access_method_ids: string[];
9053
+ /** Display name of the access grant. */
9054
+ display_name: string;
9055
+ /** Date and time at which the access grant was created. */
9056
+ created_at: string;
9057
+ }>;
9058
+ };
9059
+ };
9060
+ '/access_methods/delete': {
9061
+ route: '/access_methods/delete';
9062
+ method: 'GET' | 'POST';
9063
+ queryParams: {};
9064
+ jsonBody: {};
9065
+ commonParams: {
9066
+ /** ID of access method to get. */
9067
+ access_method_id: string;
9068
+ };
9069
+ formData: {};
9070
+ jsonResponse: {};
9071
+ };
9072
+ '/access_methods/get': {
9073
+ route: '/access_methods/get';
9074
+ method: 'GET' | 'POST';
9075
+ queryParams: {};
9076
+ jsonBody: {};
9077
+ commonParams: {
9078
+ /** ID of access method to get. */
9079
+ access_method_id: string;
9080
+ };
9081
+ formData: {};
9082
+ jsonResponse: {
9083
+ /** */
9084
+ access_method: {
9085
+ /** Unique identifier for the Seam workspace associated with the access grant. */
9086
+ workspace_id: string;
9087
+ /** ID of the access method. */
9088
+ access_method_id: string;
9089
+ /** Display name of the access method. */
9090
+ display_name: string;
9091
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
9092
+ mode: 'code' | 'card' | 'mobile_key';
9093
+ /** Date and time at which the access method was created. */
9094
+ created_at: string;
9095
+ /** Date and time at which the access method was issued. */
9096
+ issued_at?: string | undefined;
9097
+ /** URL of instant key for mobile key access methods. */
9098
+ instant_key_url?: string | undefined;
9099
+ /** Whether card encoding is required for plastic card access methods. */
9100
+ is_card_encoding_required?: boolean | undefined;
9101
+ };
9102
+ };
9103
+ };
9104
+ '/access_methods/list': {
9105
+ route: '/access_methods/list';
9106
+ method: 'GET' | 'POST';
9107
+ queryParams: {};
9108
+ jsonBody: {};
9109
+ commonParams: {
9110
+ /** ID of access grant to list access methods for. */
9111
+ access_grant_id: string;
9112
+ };
9113
+ formData: {};
9114
+ jsonResponse: {
9115
+ access_methods: Array<{
9116
+ /** Unique identifier for the Seam workspace associated with the access grant. */
9117
+ workspace_id: string;
9118
+ /** ID of the access method. */
9119
+ access_method_id: string;
9120
+ /** Display name of the access method. */
9121
+ display_name: string;
9122
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
9123
+ mode: 'code' | 'card' | 'mobile_key';
9124
+ /** Date and time at which the access method was created. */
9125
+ created_at: string;
9126
+ /** Date and time at which the access method was issued. */
9127
+ issued_at?: string | undefined;
9128
+ /** URL of instant key for mobile key access methods. */
9129
+ instant_key_url?: string | undefined;
9130
+ /** Whether card encoding is required for plastic card access methods. */
9131
+ is_card_encoding_required?: boolean | undefined;
9132
+ }>;
9133
+ };
9134
+ };
8870
9135
  '/acs/access_groups/add_user': {
8871
9136
  route: '/acs/access_groups/add_user';
8872
9137
  method: 'PUT' | 'POST';
@@ -14408,8 +14673,11 @@ export interface Routes {
14408
14673
  acs_system_id?: string | undefined;
14409
14674
  /** ID of the credential for which you want to retrieve all entrances. */
14410
14675
  acs_credential_id?: string | undefined;
14411
- /** ID of the location for which you want to retrieve all entrances. */
14676
+ /**
14677
+ * @deprecated Use `space_id`. */
14412
14678
  location_id?: (string | null) | undefined;
14679
+ /** ID of the space for which you want to list entrances. */
14680
+ space_id?: string | undefined;
14413
14681
  };
14414
14682
  formData: {};
14415
14683
  jsonResponse: {
@@ -20705,8 +20973,11 @@ export interface Routes {
20705
20973
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
20706
20974
  /** */
20707
20975
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
20708
- /** ID of the location for which you want to list devices. */
20976
+ /**
20977
+ * @deprecated Use `space_id`. */
20709
20978
  unstable_location_id?: (string | null) | undefined;
20979
+ /** ID of the space for which you want to list devices. */
20980
+ space_id?: string | undefined;
20710
20981
  };
20711
20982
  formData: {};
20712
20983
  jsonResponse: {
@@ -22337,8 +22608,11 @@ export interface Routes {
22337
22608
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
22338
22609
  /** */
22339
22610
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
22340
- /** ID of the location for which you want to list devices. */
22611
+ /**
22612
+ * @deprecated Use `space_id`. */
22341
22613
  unstable_location_id?: (string | null) | undefined;
22614
+ /** ID of the space for which you want to list devices. */
22615
+ space_id?: string | undefined;
22342
22616
  };
22343
22617
  formData: {};
22344
22618
  jsonResponse: {
@@ -27954,8 +28228,11 @@ export interface Routes {
27954
28228
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
27955
28229
  /** */
27956
28230
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
27957
- /** ID of the location for which you want to list devices. */
28231
+ /**
28232
+ * @deprecated Use `space_id`. */
27958
28233
  unstable_location_id?: (string | null) | undefined;
28234
+ /** ID of the space for which you want to list devices. */
28235
+ space_id?: string | undefined;
27959
28236
  };
27960
28237
  formData: {};
27961
28238
  jsonResponse: {
@@ -34907,8 +35184,11 @@ export interface Routes {
34907
35184
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
34908
35185
  /** */
34909
35186
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
34910
- /** ID of the location for which you want to list devices. */
35187
+ /**
35188
+ * @deprecated Use `space_id`. */
34911
35189
  unstable_location_id?: (string | null) | undefined;
35190
+ /** ID of the space for which you want to list devices. */
35191
+ space_id?: string | undefined;
34912
35192
  };
34913
35193
  formData: {};
34914
35194
  jsonResponse: {
@@ -41676,6 +41956,162 @@ export interface Routes {
41676
41956
  }>;
41677
41957
  };
41678
41958
  };
41959
+ '/spaces/add_acs_entrances': {
41960
+ route: '/spaces/add_acs_entrances';
41961
+ method: 'POST' | 'PUT';
41962
+ queryParams: {};
41963
+ jsonBody: {
41964
+ space_id: string;
41965
+ acs_entrance_ids: string[];
41966
+ };
41967
+ commonParams: {};
41968
+ formData: {};
41969
+ jsonResponse: {};
41970
+ };
41971
+ '/spaces/add_devices': {
41972
+ route: '/spaces/add_devices';
41973
+ method: 'POST' | 'PUT';
41974
+ queryParams: {};
41975
+ jsonBody: {
41976
+ space_id: string;
41977
+ device_ids: string[];
41978
+ };
41979
+ commonParams: {};
41980
+ formData: {};
41981
+ jsonResponse: {};
41982
+ };
41983
+ '/spaces/create': {
41984
+ route: '/spaces/create';
41985
+ method: 'POST';
41986
+ queryParams: {};
41987
+ jsonBody: {
41988
+ name: string;
41989
+ device_ids?: string[] | undefined;
41990
+ acs_entrance_ids?: string[] | undefined;
41991
+ };
41992
+ commonParams: {};
41993
+ formData: {};
41994
+ jsonResponse: {
41995
+ space: {
41996
+ /** Unique identifier for the space. */
41997
+ space_id: string;
41998
+ /** Unique identifier for the Seam workspace associated with the space. */
41999
+ workspace_id: string;
42000
+ /** Name of the space. */
42001
+ name: string;
42002
+ /** Display name of the space. */
42003
+ display_name: string;
42004
+ /** Date and time at which the space object was created. */
42005
+ created_at: string;
42006
+ };
42007
+ };
42008
+ };
42009
+ '/spaces/delete': {
42010
+ route: '/spaces/delete';
42011
+ method: 'DELETE' | 'POST';
42012
+ queryParams: {};
42013
+ jsonBody: {
42014
+ space_id: string;
42015
+ };
42016
+ commonParams: {};
42017
+ formData: {};
42018
+ jsonResponse: {};
42019
+ };
42020
+ '/spaces/get': {
42021
+ route: '/spaces/get';
42022
+ method: 'GET' | 'POST';
42023
+ queryParams: {};
42024
+ jsonBody: {};
42025
+ commonParams: {
42026
+ space_id: string;
42027
+ };
42028
+ formData: {};
42029
+ jsonResponse: {
42030
+ space: {
42031
+ /** Unique identifier for the space. */
42032
+ space_id: string;
42033
+ /** Unique identifier for the Seam workspace associated with the space. */
42034
+ workspace_id: string;
42035
+ /** Name of the space. */
42036
+ name: string;
42037
+ /** Display name of the space. */
42038
+ display_name: string;
42039
+ /** Date and time at which the space object was created. */
42040
+ created_at: string;
42041
+ };
42042
+ };
42043
+ };
42044
+ '/spaces/list': {
42045
+ route: '/spaces/list';
42046
+ method: 'GET' | 'POST';
42047
+ queryParams: {};
42048
+ jsonBody: {};
42049
+ commonParams: {};
42050
+ formData: {};
42051
+ jsonResponse: {
42052
+ spaces: Array<{
42053
+ /** Unique identifier for the space. */
42054
+ space_id: string;
42055
+ /** Unique identifier for the Seam workspace associated with the space. */
42056
+ workspace_id: string;
42057
+ /** Name of the space. */
42058
+ name: string;
42059
+ /** Display name of the space. */
42060
+ display_name: string;
42061
+ /** Date and time at which the space object was created. */
42062
+ created_at: string;
42063
+ }>;
42064
+ };
42065
+ };
42066
+ '/spaces/remove_acs_entrances': {
42067
+ route: '/spaces/remove_acs_entrances';
42068
+ method: 'POST' | 'DELETE';
42069
+ queryParams: {};
42070
+ jsonBody: {};
42071
+ commonParams: {
42072
+ space_id: string;
42073
+ acs_entrance_ids: string[];
42074
+ };
42075
+ formData: {};
42076
+ jsonResponse: {};
42077
+ };
42078
+ '/spaces/remove_devices': {
42079
+ route: '/spaces/remove_devices';
42080
+ method: 'POST' | 'DELETE';
42081
+ queryParams: {};
42082
+ jsonBody: {};
42083
+ commonParams: {
42084
+ space_id: string;
42085
+ device_ids: string[];
42086
+ };
42087
+ formData: {};
42088
+ jsonResponse: {};
42089
+ };
42090
+ '/spaces/update': {
42091
+ route: '/spaces/update';
42092
+ method: 'POST' | 'PATCH';
42093
+ queryParams: {};
42094
+ jsonBody: {
42095
+ space_id: string;
42096
+ name?: string | undefined;
42097
+ };
42098
+ commonParams: {};
42099
+ formData: {};
42100
+ jsonResponse: {
42101
+ space: {
42102
+ /** Unique identifier for the space. */
42103
+ space_id: string;
42104
+ /** Unique identifier for the Seam workspace associated with the space. */
42105
+ workspace_id: string;
42106
+ /** Name of the space. */
42107
+ name: string;
42108
+ /** Display name of the space. */
42109
+ display_name: string;
42110
+ /** Date and time at which the space object was created. */
42111
+ created_at: string;
42112
+ };
42113
+ };
42114
+ };
41679
42115
  '/thermostats/activate_climate_preset': {
41680
42116
  route: '/thermostats/activate_climate_preset';
41681
42117
  method: 'POST';
@@ -48642,8 +49078,11 @@ export interface Routes {
48642
49078
  include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
48643
49079
  /** */
48644
49080
  exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
48645
- /** ID of the location for which you want to list devices. */
49081
+ /**
49082
+ * @deprecated Use `space_id`. */
48646
49083
  unstable_location_id?: (string | null) | undefined;
49084
+ /** ID of the space for which you want to list devices. */
49085
+ space_id?: string | undefined;
48647
49086
  };
48648
49087
  formData: {};
48649
49088
  jsonResponse: {
@@ -55893,17 +56332,26 @@ export interface Routes {
55893
56332
  full_name?: (string | null) | undefined;
55894
56333
  };
55895
56334
  }) & {
55896
- /** Set of IDs of existing locations to which access is being granted. */
56335
+ /**
56336
+ * @deprecated Use `space_ids`. */
55897
56337
  location_ids?: string[] | undefined;
56338
+ /** Set of IDs of existing spaces to which access is being granted. */
56339
+ space_ids?: string[] | undefined;
55898
56340
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
55899
56341
  location?: {
55900
56342
  /** Name of the location. */
55901
56343
  name?: string | undefined;
55902
- /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted. */
56344
+ /**
56345
+ * @deprecated Use `acs_entrance_ids` at the top level. */
55903
56346
  acs_entrance_ids?: string[];
55904
- /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted. */
56347
+ /**
56348
+ * @deprecated Use `device_ids` at the top level. */
55905
56349
  device_ids?: string[];
55906
56350
  } | undefined;
56351
+ /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted. */
56352
+ acs_entrance_ids?: string[];
56353
+ /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
56354
+ device_ids?: string[];
55907
56355
  requested_access_methods: Array<{
55908
56356
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
55909
56357
  mode: 'code' | 'card' | 'mobile_key';
@@ -55923,8 +56371,11 @@ export interface Routes {
55923
56371
  access_grant_id: string;
55924
56372
  /** ID of user identity to which access is being granted. */
55925
56373
  user_identity_id: string;
55926
- /** IDs of the locations to which access is being given. */
56374
+ /**
56375
+ * @deprecated Use `space_ids`. */
55927
56376
  location_ids: string[];
56377
+ /** IDs of the spaces to which access is being given. */
56378
+ space_ids: string[];
55928
56379
  /** Access methods that the user requested for this access grant. */
55929
56380
  requested_access_methods: Array<{
55930
56381
  /** Display name of the access method. */
@@ -55976,8 +56427,11 @@ export interface Routes {
55976
56427
  access_grant_id: string;
55977
56428
  /** ID of user identity to which access is being granted. */
55978
56429
  user_identity_id: string;
55979
- /** IDs of the locations to which access is being given. */
56430
+ /**
56431
+ * @deprecated Use `space_ids`. */
55980
56432
  location_ids: string[];
56433
+ /** IDs of the spaces to which access is being given. */
56434
+ space_ids: string[];
55981
56435
  /** Access methods that the user requested for this access grant. */
55982
56436
  requested_access_methods: Array<{
55983
56437
  /** Display name of the access method. */
@@ -56010,8 +56464,11 @@ export interface Routes {
56010
56464
  acs_system_id?: string | undefined;
56011
56465
  /** ID of entrance to filter list of access grants by. */
56012
56466
  acs_entrance_id?: string | undefined;
56013
- /** ID of location to filter list of access grants by. */
56467
+ /**
56468
+ * @deprecated Use `space_id`. */
56014
56469
  location_id?: string | undefined;
56470
+ /** ID of space to filter list of access grants by. */
56471
+ space_id?: string | undefined;
56015
56472
  };
56016
56473
  formData: {};
56017
56474
  jsonResponse: {
@@ -56022,8 +56479,11 @@ export interface Routes {
56022
56479
  access_grant_id: string;
56023
56480
  /** ID of user identity to which access is being granted. */
56024
56481
  user_identity_id: string;
56025
- /** IDs of the locations to which access is being given. */
56482
+ /**
56483
+ * @deprecated Use `space_ids`. */
56026
56484
  location_ids: string[];
56485
+ /** IDs of the spaces to which access is being given. */
56486
+ space_ids: string[];
56027
56487
  /** Access methods that the user requested for this access grant. */
56028
56488
  requested_access_methods: Array<{
56029
56489
  /** Display name of the access method. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.407.0",
3
+ "version": "1.408.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -53,6 +53,7 @@ export {
53
53
  phone_number,
54
54
  phone_registration,
55
55
  phone_session,
56
+ space,
56
57
  thermostat_capability_properties,
57
58
  thermostat_device_type,
58
59
  thermostat_schedule,
@@ -14,9 +14,14 @@ export const access_grant = z.object({
14
14
  .string()
15
15
  .uuid()
16
16
  .describe('ID of user identity to which access is being granted.'),
17
- location_ids: z
17
+ location_ids: z.array(z.string().uuid()).describe(`
18
+ ---
19
+ deprecated: Use \`space_ids\`.
20
+ ---
21
+ `),
22
+ space_ids: z
18
23
  .array(z.string().uuid())
19
- .describe('IDs of the locations to which access is being given.'),
24
+ .describe('IDs of the spaces to which access is being given.'),
20
25
  requested_access_methods: z
21
26
  .array(requested_access_method)
22
27
  .describe('Access methods that the user requested for this access grant.'),
@@ -17,6 +17,7 @@ export * from './pagination.js'
17
17
  export * from './partner/index.js'
18
18
  export * from './phone-number.js'
19
19
  export * from './phones/index.js'
20
+ export * from './spaces/index.js'
20
21
  export * from './thermostats/index.js'
21
22
  export * from './user-identities/index.js'
22
23
  export * from './webhooks/index.js'
@@ -0,0 +1 @@
1
+ export * from './space.js'
@@ -0,0 +1,19 @@
1
+ import { z } from 'zod'
2
+
3
+ export const space = z.object({
4
+ space_id: z.string().uuid().describe('Unique identifier for the space.'),
5
+ workspace_id: z
6
+ .string()
7
+ .uuid()
8
+ .describe(
9
+ 'Unique identifier for the Seam workspace associated with the space.',
10
+ ),
11
+ name: z.string().describe('Name of the space.'),
12
+ display_name: z.string().describe('Display name of the space.'),
13
+ created_at: z
14
+ .string()
15
+ .datetime()
16
+ .describe('Date and time at which the space object was created.'),
17
+ })
18
+
19
+ export type Space = z.infer<typeof space>