@seamapi/types 1.444.1 → 1.445.1

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 (26) hide show
  1. package/dist/connect.cjs +75 -73
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +114 -125
  4. package/dist/index.cjs +75 -73
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.js +12 -12
  7. package/lib/seam/connect/models/access-grants/access-method.js +1 -1
  8. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
  9. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -0
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +4 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/events/access-grants.js +6 -6
  13. package/lib/seam/connect/models/events/access-methods.js +1 -1
  14. package/lib/seam/connect/openapi.d.ts +6 -26
  15. package/lib/seam/connect/openapi.js +66 -65
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +105 -99
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/access-grants/access-grant.ts +12 -12
  20. package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
  21. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
  22. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +4 -0
  23. package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
  24. package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
  25. package/src/lib/seam/connect/openapi.ts +71 -65
  26. package/src/lib/seam/connect/route-types.ts +105 -99
@@ -4,12 +4,12 @@ export const access_grant = z.object({
4
4
  workspace_id: z
5
5
  .string()
6
6
  .uuid()
7
- .describe('ID of the Seam workspace associated with the access grant.'),
8
- access_grant_id: z.string().uuid().describe('ID of the access grant.'),
7
+ .describe('ID of the Seam workspace associated with the Access Grant.'),
8
+ access_grant_id: z.string().uuid().describe('ID of the Access Grant.'),
9
9
  user_identity_id: z
10
10
  .string()
11
11
  .uuid()
12
- .describe('ID of user identity to which the access grant gives access.'),
12
+ .describe('ID of user identity to which the Access Grant gives access.'),
13
13
  location_ids: z.array(z.string().uuid()).describe(`
14
14
  ---
15
15
  deprecated: Use \`space_ids\`.
@@ -17,38 +17,38 @@ export const access_grant = z.object({
17
17
  `),
18
18
  space_ids: z
19
19
  .array(z.string().uuid())
20
- .describe('IDs of the spaces to which the access grant gives access.'),
20
+ .describe('IDs of the spaces to which the Access Grant gives access.'),
21
21
  requested_access_methods: z
22
22
  .array(requested_access_method)
23
- .describe('Access methods that the user requested for the access grant.'),
23
+ .describe('Access methods that the user requested for the Access Grant.'),
24
24
  access_method_ids: z
25
25
  .array(z.string().uuid())
26
- .describe('IDs of the access methods created for the access grant.'),
27
- display_name: z.string().describe('Display name of the access grant.'),
26
+ .describe('IDs of the access methods created for the Access Grant.'),
27
+ display_name: z.string().describe('Display name of the Access Grant.'),
28
28
  instant_key_url: z
29
29
  .string()
30
30
  .url()
31
31
  .optional()
32
- .describe('Instant Key URL. Only returned if the access grant has a single mobile_key access_method. '),
32
+ .describe('Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. '),
33
33
  created_at: z
34
34
  .string()
35
35
  .datetime()
36
- .describe('Date and time at which the access grant was created.'),
36
+ .describe('Date and time at which the Access Grant was created.'),
37
37
  starts_at: z
38
38
  .string()
39
39
  .datetime()
40
40
  .optional()
41
- .describe('Date and time at which the access grant starts.'),
41
+ .describe('Date and time at which the Access Grant starts.'),
42
42
  ends_at: z
43
43
  .string()
44
44
  .datetime()
45
45
  .optional()
46
- .describe('Date and time at which the access grant ends.'),
46
+ .describe('Date and time at which the Access Grant ends.'),
47
47
  }).describe(`
48
48
  ---
49
49
  draft: Early access.
50
50
  route_path: /access_grants
51
51
  ---
52
- Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant.
52
+ Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
53
53
  `);
54
54
  //# sourceMappingURL=access-grant.js.map
@@ -36,6 +36,6 @@ export const access_method = z.object({
36
36
  draft: Early access.
37
37
  route_path: /access_methods
38
38
  ---
39
- Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
39
+ Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
40
40
  `);
41
41
  //# sourceMappingURL=access-method.js.map
@@ -7,7 +7,7 @@ export const requested_access_method = z.object({
7
7
  created_at: z
8
8
  .string()
9
9
  .datetime()
10
- .describe('Date and time at which the requested access method was added to the access grant.'),
10
+ .describe('Date and time at which the requested access method was added to the Access Grant.'),
11
11
  created_access_method_ids: z
12
12
  .array(z.string().uuid())
13
13
  .describe('IDs of the access methods created for the requested access method.'),
@@ -21,6 +21,7 @@ export declare const connect_webview: z.ZodObject<{
21
21
  wait_for_device_creation: z.ZodBoolean;
22
22
  authorized_at: z.ZodNullable<z.ZodString>;
23
23
  selected_provider: z.ZodNullable<z.ZodString>;
24
+ customer_key: z.ZodOptional<z.ZodString>;
24
25
  }, "strip", z.ZodTypeAny, {
25
26
  url: string;
26
27
  status: "failed" | "pending" | "authorized";
@@ -42,6 +43,7 @@ export declare const connect_webview: z.ZodObject<{
42
43
  wait_for_device_creation: boolean;
43
44
  authorized_at: string | null;
44
45
  selected_provider: string | null;
46
+ customer_key?: string | undefined;
45
47
  }, {
46
48
  url: string;
47
49
  status: "failed" | "pending" | "authorized";
@@ -63,5 +65,6 @@ export declare const connect_webview: z.ZodObject<{
63
65
  wait_for_device_creation: boolean;
64
66
  authorized_at: string | null;
65
67
  selected_provider: string | null;
68
+ customer_key?: string | undefined;
66
69
  }>;
67
70
  export type ConnectWebview = z.infer<typeof connect_webview>;
@@ -80,6 +80,10 @@ export const connect_webview = z.object({
80
80
  .string()
81
81
  .nullable()
82
82
  .describe('Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).'),
83
+ customer_key: z
84
+ .string()
85
+ .optional()
86
+ .describe('The customer key associated with this webview, if any.'),
83
87
  }).describe(`
84
88
  ---
85
89
  route_path: /connect_webviews
@@ -1 +1 @@
1
- {"version":3,"file":"connect-webview.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/connect-webviews/connect-webview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAE/D,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM;IACN,QAAQ;IACR,UAAU;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC5E,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,gHAAgH,CACjH;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,kIAAkI,CACnI;IACH,GAAG,EAAE,CAAC;SACH,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,CACP,gGAAgG,CACjG;IACH,qBAAqB,EAAE,qCAAqC;IAE5D,wBAAwB;IACxB,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,qLAAqL,CACtL;IAEH,qBAAqB,EAAE,CAAC;SACrB,KAAK,CAAC,mBAAmB,CAAC;SAC1B,QAAQ,CACP,ulBAAulB,CACxlB;IAEH,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAC5C;;;;;OAKG,CACJ;IACD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CACtC;;;;;OAKG,CACJ;IAED,oBAAoB,EAAE,CAAC;SACpB,OAAO,EAAE;SACT,QAAQ,CAAC,4CAA4C,CAAC;IACzD,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,CACP,8EAA8E,CAC/E;IACH,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;SACzC,QAAQ,CACP,0KAA0K,CAC3K;IACH,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,wPAAwP,CACzP;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,mFAAmF,CACpF;IACH,eAAe;IACf,gCAAgC,EAAE,CAAC;SAChC,OAAO,EAAE;SACT,QAAQ,CACP,oRAAoR,CACrR;IACH,wBAAwB,EAAE,CAAC;SACxB,OAAO,EAAE;SACT,QAAQ,CACP,6PAA6P,CAC9P;IACH,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;IACH,iBAAiB,EAAE,CAAC;SACjB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yNAAyN,CAC1N;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;CAeX,CAAC,CAAA"}
1
+ {"version":3,"file":"connect-webview.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/connect-webviews/connect-webview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAE/D,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1D,MAAM;IACN,QAAQ;IACR,UAAU;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC5E,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,gHAAgH,CACjH;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,kIAAkI,CACnI;IACH,GAAG,EAAE,CAAC;SACH,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,CACP,gGAAgG,CACjG;IACH,qBAAqB,EAAE,qCAAqC;IAE5D,wBAAwB;IACxB,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,qLAAqL,CACtL;IAEH,qBAAqB,EAAE,CAAC;SACrB,KAAK,CAAC,mBAAmB,CAAC;SAC1B,QAAQ,CACP,ulBAAulB,CACxlB;IAEH,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAC5C;;;;;OAKG,CACJ;IACD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CACtC;;;;;OAKG,CACJ;IAED,oBAAoB,EAAE,CAAC;SACpB,OAAO,EAAE;SACT,QAAQ,CAAC,4CAA4C,CAAC;IACzD,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,CACP,8EAA8E,CAC/E;IACH,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;SACzC,QAAQ,CACP,0KAA0K,CAC3K;IACH,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,wPAAwP,CACzP;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,mFAAmF,CACpF;IACH,eAAe;IACf,gCAAgC,EAAE,CAAC;SAChC,OAAO,EAAE;SACT,QAAQ,CACP,oRAAoR,CACrR;IACH,wBAAwB,EAAE,CAAC;SACxB,OAAO,EAAE;SACT,QAAQ,CACP,6PAA6P,CAC9P;IACH,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;IACH,iBAAiB,EAAE,CAAC;SACjB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yNAAyN,CAC1N;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;CAeX,CAAC,CAAA"}
@@ -4,7 +4,7 @@ const access_grant_event = common_event.extend({
4
4
  access_grant_id: z
5
5
  .string()
6
6
  .uuid()
7
- .describe('ID of the affected access grant.'),
7
+ .describe('ID of the affected Access Grant.'),
8
8
  });
9
9
  export const access_grant_created_event = access_grant_event.extend({
10
10
  event_type: z.literal('access_grant.created'),
@@ -12,7 +12,7 @@ export const access_grant_created_event = access_grant_event.extend({
12
12
  ---
13
13
  route_path: /access_grants
14
14
  ---
15
- An access grant was created.
15
+ An Access Grant was created.
16
16
  `);
17
17
  export const access_grant_deleted_event = access_grant_event.extend({
18
18
  event_type: z.literal('access_grant.deleted'),
@@ -20,7 +20,7 @@ export const access_grant_deleted_event = access_grant_event.extend({
20
20
  ---
21
21
  route_path: /access_grants
22
22
  ---
23
- An access grant was deleted.
23
+ An Access Grant was deleted.
24
24
  `);
25
25
  export const access_grant_access_granted_to_all_doors_event = access_grant_event.extend({
26
26
  event_type: z.literal('access_grant.access_granted_to_all_doors'),
@@ -28,7 +28,7 @@ export const access_grant_access_granted_to_all_doors_event = access_grant_event
28
28
  ---
29
29
  route_path: /access_grants
30
30
  ---
31
- All access requested for an access grant was successfully granted.
31
+ All access requested for an Access Grant was successfully granted.
32
32
  `);
33
33
  const acs_entrance_id = z
34
34
  .string()
@@ -41,7 +41,7 @@ export const access_grant_access_granted_to_door_event = access_grant_event.exte
41
41
  ---
42
42
  route_path: /access_grants
43
43
  ---
44
- Access requested as part of an access grant to a particular door was successfully granted.
44
+ Access requested as part of an Access Grant to a particular door was successfully granted.
45
45
  `);
46
46
  export const access_grant_access_to_door_lost_event = access_grant_event.extend({
47
47
  event_type: z.literal('access_grant.access_to_door_lost'),
@@ -50,7 +50,7 @@ export const access_grant_access_to_door_lost_event = access_grant_event.extend(
50
50
  ---
51
51
  route_path: /access_grants
52
52
  ---
53
- Access to a particular door that was requested as part of an access grant was lost.
53
+ Access to a particular door that was requested as part of an Access Grant was lost.
54
54
  `);
55
55
  export const access_grant_events = [
56
56
  access_grant_created_event,
@@ -44,7 +44,7 @@ export const access_method_reissued_event = access_method_event.extend({
44
44
  ---
45
45
  route_path: /access_methods
46
46
  ---
47
- An access method was reissued due to an access grant update.
47
+ An access method was reissued due to an Access Grant update.
48
48
  `);
49
49
  export const access_method_events = [
50
50
  access_method_issued_event,
@@ -3901,6 +3901,10 @@ declare const _default: {
3901
3901
  nullable: boolean;
3902
3902
  type: string;
3903
3903
  };
3904
+ customer_key: {
3905
+ description: string;
3906
+ type: string;
3907
+ };
3904
3908
  device_selection_mode: {
3905
3909
  enum: string[];
3906
3910
  type: string;
@@ -26040,8 +26044,8 @@ declare const _default: {
26040
26044
  description: string;
26041
26045
  type: string;
26042
26046
  };
26043
- customer_id: {
26044
- format: string;
26047
+ customer_key: {
26048
+ description: string;
26045
26049
  type: string;
26046
26050
  };
26047
26051
  device_selection_mode: {
@@ -26434,26 +26438,11 @@ declare const _default: {
26434
26438
  description: string;
26435
26439
  operationId: string;
26436
26440
  parameters: ({
26437
- in: string;
26438
- name: string;
26439
- schema: {
26440
- items: {
26441
- type: string;
26442
- };
26443
- type: string;
26444
- description?: never;
26445
- additionalProperties?: never;
26446
- default?: never;
26447
- format?: never;
26448
- nullable?: never;
26449
- };
26450
- } | {
26451
26441
  in: string;
26452
26442
  name: string;
26453
26443
  schema: {
26454
26444
  description: string;
26455
26445
  type: string;
26456
- items?: never;
26457
26446
  additionalProperties?: never;
26458
26447
  default?: never;
26459
26448
  format?: never;
@@ -26470,7 +26459,6 @@ declare const _default: {
26470
26459
  };
26471
26460
  description: string;
26472
26461
  type: string;
26473
- items?: never;
26474
26462
  default?: never;
26475
26463
  format?: never;
26476
26464
  nullable?: never;
@@ -26483,7 +26471,6 @@ declare const _default: {
26483
26471
  description: string;
26484
26472
  format: string;
26485
26473
  type: string;
26486
- items?: never;
26487
26474
  additionalProperties?: never;
26488
26475
  nullable?: never;
26489
26476
  };
@@ -26494,7 +26481,6 @@ declare const _default: {
26494
26481
  description: string;
26495
26482
  nullable: boolean;
26496
26483
  type: string;
26497
- items?: never;
26498
26484
  additionalProperties?: never;
26499
26485
  default?: never;
26500
26486
  format?: never;
@@ -26589,12 +26575,6 @@ declare const _default: {
26589
26575
  description: string;
26590
26576
  type: string;
26591
26577
  };
26592
- customer_ids: {
26593
- items: {
26594
- type: string;
26595
- };
26596
- type: string;
26597
- };
26598
26578
  limit: {
26599
26579
  default: number;
26600
26580
  description: string;