@seamapi/types 1.750.0 → 1.752.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 (23) hide show
  1. package/dist/connect.cjs +126 -53
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2351 -962
  4. package/dist/index.cjs +126 -53
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.d.ts +42 -42
  7. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +37 -37
  8. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +9 -9
  9. package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -0
  11. package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
  12. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  13. package/lib/seam/connect/models/batch.d.ts +63 -58
  14. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
  15. package/lib/seam/connect/openapi.d.ts +84 -0
  16. package/lib/seam/connect/openapi.js +112 -42
  17. package/lib/seam/connect/openapi.js.map +1 -1
  18. package/lib/seam/connect/route-types.d.ts +1606 -309
  19. package/package.json +1 -1
  20. package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +14 -14
  21. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  22. package/src/lib/seam/connect/openapi.ts +122 -48
  23. package/src/lib/seam/connect/route-types.ts +1754 -254
package/lib/seam/connect/models/phones/phone-session.d.ts CHANGED
@@ -358,6 +358,7 @@ declare const phone_provider_session: z.ZodObject<{
358
358
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
359
359
  can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
360
360
  can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
361
+ can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
361
362
  }, "strip", z.ZodTypeAny, {
362
363
  display_name: string;
363
364
  created_at: string;
@@ -403,6 +404,7 @@ declare const phone_provider_session: z.ZodObject<{
403
404
  can_unlock_with_mobile_key?: boolean | undefined;
404
405
  can_unlock_with_card?: boolean | undefined;
405
406
  can_belong_to_reservation?: boolean | undefined;
407
+ can_unlock_with_cloud_key?: boolean | undefined;
406
408
  latch_metadata?: {
407
409
  door_name: string;
408
410
  is_connected: boolean;
@@ -473,6 +475,7 @@ declare const phone_provider_session: z.ZodObject<{
473
475
  can_unlock_with_mobile_key?: boolean | undefined;
474
476
  can_unlock_with_card?: boolean | undefined;
475
477
  can_belong_to_reservation?: boolean | undefined;
478
+ can_unlock_with_cloud_key?: boolean | undefined;
476
479
  latch_metadata?: {
477
480
  door_name: string;
478
481
  is_connected: boolean;
@@ -582,6 +585,7 @@ declare const phone_provider_session: z.ZodObject<{
582
585
  can_unlock_with_mobile_key?: boolean | undefined;
583
586
  can_unlock_with_card?: boolean | undefined;
584
587
  can_belong_to_reservation?: boolean | undefined;
588
+ can_unlock_with_cloud_key?: boolean | undefined;
585
589
  latch_metadata?: {
586
590
  door_name: string;
587
591
  is_connected: boolean;
@@ -725,6 +729,7 @@ declare const phone_provider_session: z.ZodObject<{
725
729
  can_unlock_with_mobile_key?: boolean | undefined;
726
730
  can_unlock_with_card?: boolean | undefined;
727
731
  can_belong_to_reservation?: boolean | undefined;
732
+ can_unlock_with_cloud_key?: boolean | undefined;
728
733
  latch_metadata?: {
729
734
  door_name: string;
730
735
  is_connected: boolean;
@@ -870,6 +875,7 @@ declare const phone_provider_session: z.ZodObject<{
870
875
  can_unlock_with_mobile_key?: boolean | undefined;
871
876
  can_unlock_with_card?: boolean | undefined;
872
877
  can_belong_to_reservation?: boolean | undefined;
878
+ can_unlock_with_cloud_key?: boolean | undefined;
873
879
  latch_metadata?: {
874
880
  door_name: string;
875
881
  is_connected: boolean;
@@ -1021,6 +1027,7 @@ declare const phone_provider_session: z.ZodObject<{
1021
1027
  can_unlock_with_mobile_key?: boolean | undefined;
1022
1028
  can_unlock_with_card?: boolean | undefined;
1023
1029
  can_belong_to_reservation?: boolean | undefined;
1030
+ can_unlock_with_cloud_key?: boolean | undefined;
1024
1031
  latch_metadata?: {
1025
1032
  door_name: string;
1026
1033
  is_connected: boolean;
@@ -1449,6 +1456,7 @@ export declare const phone_session: z.ZodObject<{
1449
1456
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
1450
1457
  can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
1451
1458
  can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
1459
+ can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
1452
1460
  }, "strip", z.ZodTypeAny, {
1453
1461
  display_name: string;
1454
1462
  created_at: string;
@@ -1494,6 +1502,7 @@ export declare const phone_session: z.ZodObject<{
1494
1502
  can_unlock_with_mobile_key?: boolean | undefined;
1495
1503
  can_unlock_with_card?: boolean | undefined;
1496
1504
  can_belong_to_reservation?: boolean | undefined;
1505
+ can_unlock_with_cloud_key?: boolean | undefined;
1497
1506
  latch_metadata?: {
1498
1507
  door_name: string;
1499
1508
  is_connected: boolean;
@@ -1564,6 +1573,7 @@ export declare const phone_session: z.ZodObject<{
1564
1573
  can_unlock_with_mobile_key?: boolean | undefined;
1565
1574
  can_unlock_with_card?: boolean | undefined;
1566
1575
  can_belong_to_reservation?: boolean | undefined;
1576
+ can_unlock_with_cloud_key?: boolean | undefined;
1567
1577
  latch_metadata?: {
1568
1578
  door_name: string;
1569
1579
  is_connected: boolean;
@@ -1673,6 +1683,7 @@ export declare const phone_session: z.ZodObject<{
1673
1683
  can_unlock_with_mobile_key?: boolean | undefined;
1674
1684
  can_unlock_with_card?: boolean | undefined;
1675
1685
  can_belong_to_reservation?: boolean | undefined;
1686
+ can_unlock_with_cloud_key?: boolean | undefined;
1676
1687
  latch_metadata?: {
1677
1688
  door_name: string;
1678
1689
  is_connected: boolean;
@@ -1816,6 +1827,7 @@ export declare const phone_session: z.ZodObject<{
1816
1827
  can_unlock_with_mobile_key?: boolean | undefined;
1817
1828
  can_unlock_with_card?: boolean | undefined;
1818
1829
  can_belong_to_reservation?: boolean | undefined;
1830
+ can_unlock_with_cloud_key?: boolean | undefined;
1819
1831
  latch_metadata?: {
1820
1832
  door_name: string;
1821
1833
  is_connected: boolean;
@@ -1961,6 +1973,7 @@ export declare const phone_session: z.ZodObject<{
1961
1973
  can_unlock_with_mobile_key?: boolean | undefined;
1962
1974
  can_unlock_with_card?: boolean | undefined;
1963
1975
  can_belong_to_reservation?: boolean | undefined;
1976
+ can_unlock_with_cloud_key?: boolean | undefined;
1964
1977
  latch_metadata?: {
1965
1978
  door_name: string;
1966
1979
  is_connected: boolean;
@@ -2112,6 +2125,7 @@ export declare const phone_session: z.ZodObject<{
2112
2125
  can_unlock_with_mobile_key?: boolean | undefined;
2113
2126
  can_unlock_with_card?: boolean | undefined;
2114
2127
  can_belong_to_reservation?: boolean | undefined;
2128
+ can_unlock_with_cloud_key?: boolean | undefined;
2115
2129
  latch_metadata?: {
2116
2130
  door_name: string;
2117
2131
  is_connected: boolean;
@@ -2378,6 +2392,7 @@ export declare const phone_session: z.ZodObject<{
2378
2392
  can_unlock_with_mobile_key?: boolean | undefined;
2379
2393
  can_unlock_with_card?: boolean | undefined;
2380
2394
  can_belong_to_reservation?: boolean | undefined;
2395
+ can_unlock_with_cloud_key?: boolean | undefined;
2381
2396
  latch_metadata?: {
2382
2397
  door_name: string;
2383
2398
  is_connected: boolean;
@@ -2560,6 +2575,7 @@ export declare const phone_session: z.ZodObject<{
2560
2575
  can_unlock_with_mobile_key?: boolean | undefined;
2561
2576
  can_unlock_with_card?: boolean | undefined;
2562
2577
  can_belong_to_reservation?: boolean | undefined;
2578
+ can_unlock_with_cloud_key?: boolean | undefined;
2563
2579
  latch_metadata?: {
2564
2580
  door_name: string;
2565
2581
  is_connected: boolean;
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -1966,6 +1966,10 @@ declare const _default: {
1966
1966
  description: string;
1967
1967
  type: string;
1968
1968
  };
1969
+ can_unlock_with_cloud_key: {
1970
+ description: string;
1971
+ type: string;
1972
+ };
1969
1973
  can_unlock_with_code: {
1970
1974
  description: string;
1971
1975
  type: string;
@@ -15607,6 +15611,10 @@ declare const _default: {
15607
15611
  description: string;
15608
15612
  type: string;
15609
15613
  };
15614
+ can_unlock_with_cloud_key: {
15615
+ description: string;
15616
+ type: string;
15617
+ };
15610
15618
  can_unlock_with_code: {
15611
15619
  description: string;
15612
15620
  type: string;
@@ -33019,6 +33027,82 @@ declare const _default: {
33019
33027
  'x-title': string;
33020
33028
  };
33021
33029
  };
33030
+ '/acs/entrances/unlock': {
33031
+ post: {
33032
+ description: string;
33033
+ operationId: string;
33034
+ requestBody: {
33035
+ content: {
33036
+ 'application/json': {
33037
+ schema: {
33038
+ properties: {
33039
+ acs_credential_id: {
33040
+ description: string;
33041
+ format: string;
33042
+ type: string;
33043
+ };
33044
+ acs_entrance_id: {
33045
+ description: string;
33046
+ format: string;
33047
+ type: string;
33048
+ };
33049
+ };
33050
+ required: string[];
33051
+ type: string;
33052
+ };
33053
+ };
33054
+ };
33055
+ };
33056
+ responses: {
33057
+ 200: {
33058
+ content: {
33059
+ 'application/json': {
33060
+ schema: {
33061
+ properties: {
33062
+ action_attempt: {
33063
+ $ref: string;
33064
+ };
33065
+ ok: {
33066
+ type: string;
33067
+ };
33068
+ };
33069
+ required: string[];
33070
+ type: string;
33071
+ };
33072
+ };
33073
+ };
33074
+ description: string;
33075
+ };
33076
+ 400: {
33077
+ description: string;
33078
+ };
33079
+ 401: {
33080
+ description: string;
33081
+ };
33082
+ };
33083
+ security: ({
33084
+ pat_with_workspace: never[];
33085
+ console_session_with_workspace?: never;
33086
+ api_key?: never;
33087
+ } | {
33088
+ console_session_with_workspace: never[];
33089
+ pat_with_workspace?: never;
33090
+ api_key?: never;
33091
+ } | {
33092
+ api_key: never[];
33093
+ pat_with_workspace?: never;
33094
+ console_session_with_workspace?: never;
33095
+ })[];
33096
+ summary: string;
33097
+ tags: string[];
33098
+ 'x-action-attempt-type': string;
33099
+ 'x-fern-sdk-group-name': string[];
33100
+ 'x-fern-sdk-method-name': string;
33101
+ 'x-fern-sdk-return-value': string;
33102
+ 'x-response-key': string;
33103
+ 'x-title': string;
33104
+ };
33105
+ };
33022
33106
  '/acs/systems/get': {
33023
33107
  get: {
33024
33108
  description: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -2496,6 +2496,27 @@ export default {
2496
2496
  required: ['created_at', 'message', 'mutation_code'],
2497
2497
  type: 'object',
2498
2498
  },
2499
+ {
2500
+ description: 'This access group is scheduled for automatic deletion when its access window expires.',
2501
+ properties: {
2502
+ created_at: {
2503
+ description: 'Date and time at which the mutation was created.',
2504
+ format: 'date-time',
2505
+ type: 'string',
2506
+ },
2507
+ message: {
2508
+ description: 'Detailed description of the mutation.',
2509
+ type: 'string',
2510
+ },
2511
+ mutation_code: {
2512
+ description: 'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.',
2513
+ enum: ['deferring_deletion'],
2514
+ type: 'string',
2515
+ },
2516
+ },
2517
+ required: ['created_at', 'message', 'mutation_code'],
2518
+ type: 'object',
2519
+ },
2499
2520
  {
2500
2521
  description: 'Seam is in the process of pushing an access group information update to the integrated access system.',
2501
2522
  properties: {
@@ -2753,27 +2774,6 @@ export default {
2753
2774
  ],
2754
2775
  type: 'object',
2755
2776
  },
2756
- {
2757
- description: 'This access group is scheduled for automatic deletion when its access window expires.',
2758
- properties: {
2759
- created_at: {
2760
- description: 'Date and time at which the mutation was created.',
2761
- format: 'date-time',
2762
- type: 'string',
2763
- },
2764
- message: {
2765
- description: 'Detailed description of the mutation.',
2766
- type: 'string',
2767
- },
2768
- mutation_code: {
2769
- description: 'Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes.',
2770
- enum: ['deferring_deletion'],
2771
- type: 'string',
2772
- },
2773
- },
2774
- required: ['created_at', 'message', 'mutation_code'],
2775
- type: 'object',
2776
- },
2777
2777
  ],
2778
2778
  },
2779
2779
  type: 'array',
@@ -3405,6 +3405,10 @@ export default {
3405
3405
  description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
3406
3406
  type: 'boolean',
3407
3407
  },
3408
+ can_unlock_with_cloud_key: {
3409
+ description: 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
3410
+ type: 'boolean',
3411
+ },
3408
3412
  can_unlock_with_code: {
3409
3413
  description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
3410
3414
  type: 'boolean',
@@ -21685,6 +21689,10 @@ export default {
21685
21689
  description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
21686
21690
  type: 'boolean',
21687
21691
  },
21692
+ can_unlock_with_cloud_key: {
21693
+ description: 'Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.',
21694
+ type: 'boolean',
21695
+ },
21688
21696
  can_unlock_with_code: {
21689
21697
  description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
21690
21698
  type: 'boolean',
@@ -24423,6 +24431,27 @@ export default {
24423
24431
  required: ['created_at', 'message', 'mutation_code'],
24424
24432
  type: 'object',
24425
24433
  },
24434
+ {
24435
+ description: 'This access group is scheduled for automatic deletion when its access window expires.',
24436
+ properties: {
24437
+ created_at: {
24438
+ description: 'Date and time at which the mutation was created.',
24439
+ format: 'date-time',
24440
+ type: 'string',
24441
+ },
24442
+ message: {
24443
+ description: 'Detailed description of the mutation.',
24444
+ type: 'string',
24445
+ },
24446
+ mutation_code: {
24447
+ description: 'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.',
24448
+ enum: ['deferring_deletion'],
24449
+ type: 'string',
24450
+ },
24451
+ },
24452
+ required: ['created_at', 'message', 'mutation_code'],
24453
+ type: 'object',
24454
+ },
24426
24455
  {
24427
24456
  description: 'Seam is in the process of pushing an access group information update to the integrated access system.',
24428
24457
  properties: {
@@ -24680,27 +24709,6 @@ export default {
24680
24709
  ],
24681
24710
  type: 'object',
24682
24711
  },
24683
- {
24684
- description: 'This access group is scheduled for automatic deletion when its access window expires.',
24685
- properties: {
24686
- created_at: {
24687
- description: 'Date and time at which the mutation was created.',
24688
- format: 'date-time',
24689
- type: 'string',
24690
- },
24691
- message: {
24692
- description: 'Detailed description of the mutation.',
24693
- type: 'string',
24694
- },
24695
- mutation_code: {
24696
- description: 'Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes.',
24697
- enum: ['deferring_deletion'],
24698
- type: 'string',
24699
- },
24700
- },
24701
- required: ['created_at', 'message', 'mutation_code'],
24702
- type: 'object',
24703
- },
24704
24712
  ],
24705
24713
  },
24706
24714
  type: 'array',
@@ -39998,6 +40006,68 @@ export default {
39998
40006
  'x-title': 'List Credentials with Access to an Entrance',
39999
40007
  },
40000
40008
  },
40009
+ '/acs/entrances/unlock': {
40010
+ post: {
40011
+ description: 'Remotely unlocks a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.',
40012
+ operationId: 'acsEntrancesUnlockPost',
40013
+ requestBody: {
40014
+ content: {
40015
+ 'application/json': {
40016
+ schema: {
40017
+ properties: {
40018
+ acs_credential_id: {
40019
+ description: 'ID of the cloud_key credential to use for the unlock operation.',
40020
+ format: 'uuid',
40021
+ type: 'string',
40022
+ },
40023
+ acs_entrance_id: {
40024
+ description: 'ID of the entrance to unlock.',
40025
+ format: 'uuid',
40026
+ type: 'string',
40027
+ },
40028
+ },
40029
+ required: ['acs_entrance_id', 'acs_credential_id'],
40030
+ type: 'object',
40031
+ },
40032
+ },
40033
+ },
40034
+ },
40035
+ responses: {
40036
+ 200: {
40037
+ content: {
40038
+ 'application/json': {
40039
+ schema: {
40040
+ properties: {
40041
+ action_attempt: {
40042
+ $ref: '#/components/schemas/action_attempt',
40043
+ },
40044
+ ok: { type: 'boolean' },
40045
+ },
40046
+ required: ['action_attempt', 'ok'],
40047
+ type: 'object',
40048
+ },
40049
+ },
40050
+ },
40051
+ description: 'OK',
40052
+ },
40053
+ 400: { description: 'Bad Request' },
40054
+ 401: { description: 'Unauthorized' },
40055
+ },
40056
+ security: [
40057
+ { pat_with_workspace: [] },
40058
+ { console_session_with_workspace: [] },
40059
+ { api_key: [] },
40060
+ ],
40061
+ summary: '/acs/entrances/unlock',
40062
+ tags: ['/acs'],
40063
+ 'x-action-attempt-type': 'UNLOCK_DOOR',
40064
+ 'x-fern-sdk-group-name': ['acs', 'entrances'],
40065
+ 'x-fern-sdk-method-name': 'unlock',
40066
+ 'x-fern-sdk-return-value': 'action_attempt',
40067
+ 'x-response-key': 'action_attempt',
40068
+ 'x-title': 'Unlock an Entrance',
40069
+ },
40070
+ },
40001
40071
  '/acs/systems/get': {
40002
40072
  get: {
40003
40073
  description: 'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',