@seamapi/types 1.725.0 → 1.727.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.
@@ -10456,8 +10456,8 @@ export type Routes = {
10456
10456
  access_grant_ids?: string[] | undefined;
10457
10457
  /** Keys of the access grants that you want to get along with their related resources. */
10458
10458
  access_grant_keys?: string[] | undefined;
10459
- include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
10460
- exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups')[] | undefined;
10459
+ include?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
10460
+ exclude?: ('spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identities' | 'acs_access_groups' | 'access_methods')[] | undefined;
10461
10461
  };
10462
10462
  formData: {};
10463
10463
  jsonResponse: {
@@ -12248,6 +12248,105 @@ export type Routes = {
12248
12248
  })[];
12249
12249
  is_managed: true;
12250
12250
  }[] | undefined;
12251
+ access_methods?: {
12252
+ /** ID of the Seam workspace associated with the access method. */
12253
+ workspace_id: string;
12254
+ /** ID of the access method. */
12255
+ access_method_id: string;
12256
+ /** Display name of the access method. */
12257
+ display_name: string;
12258
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
12259
+ mode: 'code' | 'card' | 'mobile_key';
12260
+ /** Date and time at which the access method was created. */
12261
+ created_at: string;
12262
+ /** Date and time at which the access method was issued. */
12263
+ issued_at: string | null;
12264
+ /** Indicates whether the access method has been issued. */
12265
+ is_issued: boolean;
12266
+ /** URL of the Instant Key for mobile key access methods. */
12267
+ instant_key_url?: string | undefined;
12268
+ /** Token of the client session associated with the access method. */
12269
+ client_session_token?: string | undefined;
12270
+ /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
12271
+ is_encoding_required?: boolean | undefined;
12272
+ /** The actual PIN code for code access methods. */
12273
+ code?: (string | null) | undefined;
12274
+ /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
12275
+ warnings: ({
12276
+ /** Date and time at which Seam created the warning. */
12277
+ created_at: string;
12278
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12279
+ message: string;
12280
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12281
+ warning_code: 'being_deleted';
12282
+ } | {
12283
+ /** Date and time at which Seam created the warning. */
12284
+ created_at: string;
12285
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12286
+ message: string;
12287
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12288
+ warning_code: 'updating_access_times';
12289
+ })[];
12290
+ /** Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. */
12291
+ pending_mutations: ({
12292
+ /** Date and time at which the mutation was created. */
12293
+ created_at: string;
12294
+ /** Detailed description of the mutation. */
12295
+ message: string;
12296
+ /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
12297
+ mutation_code: 'provisioning_access';
12298
+ /** Previous device configuration. */
12299
+ from: {
12300
+ /** Previous device IDs where access was provisioned. */
12301
+ device_ids: string[];
12302
+ };
12303
+ /** New device configuration. */
12304
+ to: {
12305
+ /** New device IDs where access is being provisioned. */
12306
+ device_ids: string[];
12307
+ };
12308
+ } | {
12309
+ /** Date and time at which the mutation was created. */
12310
+ created_at: string;
12311
+ /** Detailed description of the mutation. */
12312
+ message: string;
12313
+ /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
12314
+ mutation_code: 'revoking_access';
12315
+ /** Previous device configuration. */
12316
+ from: {
12317
+ /** Previous device IDs where access existed. */
12318
+ device_ids: string[];
12319
+ };
12320
+ /** New device configuration. */
12321
+ to: {
12322
+ /** New device IDs where access should remain. */
12323
+ device_ids: string[];
12324
+ };
12325
+ } | {
12326
+ /** Date and time at which the mutation was created. */
12327
+ created_at: string;
12328
+ /** Detailed description of the mutation. */
12329
+ message: string;
12330
+ /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
12331
+ mutation_code: 'updating_access_times';
12332
+ /** Previous access time configuration. */
12333
+ from: {
12334
+ /** Previous start time for access. */
12335
+ starts_at: string | null;
12336
+ /** Previous end time for access. */
12337
+ ends_at: string | null;
12338
+ };
12339
+ /** New access time configuration. */
12340
+ to: {
12341
+ /** New start time for access. */
12342
+ starts_at: string | null;
12343
+ /** New end time for access. */
12344
+ ends_at: string | null;
12345
+ };
12346
+ })[];
12347
+ /** ID of the customization profile associated with the access method. */
12348
+ customization_profile_id?: string | undefined;
12349
+ }[] | undefined;
12251
12350
  };
12252
12351
  };
12253
12352
  maxDuration: undefined;
@@ -60598,7 +60697,7 @@ export type Routes = {
60598
60697
  resource_key: string;
60599
60698
  } | undefined;
60600
60699
  /** Business vertical of the customer portal. */
60601
- business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60700
+ business_vertical?: ('neutral' | 'short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60602
60701
  };
60603
60702
  };
60604
60703
  maxDuration: undefined;
@@ -60715,6 +60814,18 @@ export type Routes = {
60715
60814
  };
60716
60815
  maxDuration: undefined;
60717
60816
  };
60817
+ '/seam/customer/v1/settings/business_verticals/list': {
60818
+ route: '/seam/customer/v1/settings/business_verticals/list';
60819
+ method: 'GET' | 'POST';
60820
+ queryParams: {};
60821
+ jsonBody: {};
60822
+ commonParams: {};
60823
+ formData: {};
60824
+ jsonResponse: {
60825
+ business_verticals: ('neutral' | 'short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours')[];
60826
+ };
60827
+ maxDuration: undefined;
60828
+ };
60718
60829
  '/seam/customer/v1/settings/get': {
60719
60830
  route: '/seam/customer/v1/settings/get';
60720
60831
  method: 'GET' | 'POST';
@@ -60724,7 +60835,7 @@ export type Routes = {
60724
60835
  formData: {};
60725
60836
  jsonResponse: {
60726
60837
  /** Business vertical of the customer portal. */
60727
- business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60838
+ business_vertical?: ('neutral' | 'short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60728
60839
  slug?: (string | null) | undefined;
60729
60840
  };
60730
60841
  maxDuration: undefined;
@@ -60735,7 +60846,7 @@ export type Routes = {
60735
60846
  queryParams: {};
60736
60847
  jsonBody: {
60737
60848
  /** Business vertical to set on the workspace. */
60738
- business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60849
+ business_vertical?: ('neutral' | 'short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
60739
60850
  /** Slug to set on the workspace. */
60740
60851
  slug?: (string | null) | undefined;
60741
60852
  };
@@ -60744,6 +60855,63 @@ export type Routes = {
60744
60855
  jsonResponse: {};
60745
60856
  maxDuration: undefined;
60746
60857
  };
60858
+ '/seam/customer/v1/settings/vertical_resource_aliases/get': {
60859
+ route: '/seam/customer/v1/settings/vertical_resource_aliases/get';
60860
+ method: 'GET' | 'POST';
60861
+ queryParams: {};
60862
+ jsonBody: {};
60863
+ commonParams: {};
60864
+ formData: {};
60865
+ jsonResponse: {
60866
+ vertical_resource_aliases: {
60867
+ /** Primary space alias for this vertical. */
60868
+ space: {
60869
+ /** The key alias for a single resource. */
60870
+ resource_key: string;
60871
+ /** Human-readable label for a single resource. */
60872
+ resource_label: string;
60873
+ /** The key alias for a collection of resources. */
60874
+ collection_key: string;
60875
+ /** Human-readable label for a collection of resources. */
60876
+ collection_label: string;
60877
+ };
60878
+ /** Additional space aliases relevant to this vertical. */
60879
+ additional_spaces: {
60880
+ /** The key alias for a single resource. */
60881
+ resource_key: string;
60882
+ /** Human-readable label for a single resource. */
60883
+ resource_label: string;
60884
+ /** The key alias for a collection of resources. */
60885
+ collection_key: string;
60886
+ /** Human-readable label for a collection of resources. */
60887
+ collection_label: string;
60888
+ }[];
60889
+ /** Primary user identity alias for this vertical. */
60890
+ user_identity: {
60891
+ /** The key alias for a single resource. */
60892
+ resource_key: string;
60893
+ /** Human-readable label for a single resource. */
60894
+ resource_label: string;
60895
+ /** The key alias for a collection of resources. */
60896
+ collection_key: string;
60897
+ /** Human-readable label for a collection of resources. */
60898
+ collection_label: string;
60899
+ };
60900
+ /** Primary access grant alias for this vertical. */
60901
+ access_grant: {
60902
+ /** The key alias for a single resource. */
60903
+ resource_key: string;
60904
+ /** Human-readable label for a single resource. */
60905
+ resource_label: string;
60906
+ /** The key alias for a collection of resources. */
60907
+ collection_key: string;
60908
+ /** Human-readable label for a collection of resources. */
60909
+ collection_label: string;
60910
+ };
60911
+ };
60912
+ };
60913
+ maxDuration: undefined;
60914
+ };
60747
60915
  '/seam/customer/v1/spaces/create': {
60748
60916
  route: '/seam/customer/v1/spaces/create';
60749
60917
  method: 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.725.0",
3
+ "version": "1.727.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -91,7 +91,7 @@
91
91
  "zod": "^3.24.0"
92
92
  },
93
93
  "devDependencies": {
94
- "@seamapi/blueprint": "^0.53.0",
94
+ "@seamapi/blueprint": "^0.53.2",
95
95
  "@swc/core": "^1.11.29",
96
96
  "@types/node": "^24.10.9",
97
97
  "del-cli": "^7.0.0",
@@ -2,6 +2,7 @@ import { z } from 'zod'
2
2
 
3
3
  export const business_vertical = z
4
4
  .enum([
5
+ 'neutral',
5
6
  'short_term_rental',
6
7
  'hospitality',
7
8
  'multi_family',