@seamapi/types 1.516.0 → 1.518.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.
@@ -3616,6 +3616,7 @@ declare const access_grant: z.ZodObject<{
3616
3616
  requested_access_methods: z.ZodArray<z.ZodObject<{
3617
3617
  display_name: z.ZodString;
3618
3618
  mode: z.ZodEnum<["code", "card", "mobile_key"]>;
3619
+ code: z.ZodOptional<z.ZodString>;
3619
3620
  created_at: z.ZodString;
3620
3621
  created_access_method_ids: z.ZodArray<z.ZodString, "many">;
3621
3622
  }, "strip", z.ZodTypeAny, {
@@ -3623,11 +3624,13 @@ declare const access_grant: z.ZodObject<{
3623
3624
  created_at: string;
3624
3625
  mode: "code" | "card" | "mobile_key";
3625
3626
  created_access_method_ids: string[];
3627
+ code?: string | undefined;
3626
3628
  }, {
3627
3629
  display_name: string;
3628
3630
  created_at: string;
3629
3631
  mode: "code" | "card" | "mobile_key";
3630
3632
  created_access_method_ids: string[];
3633
+ code?: string | undefined;
3631
3634
  }>, "many">;
3632
3635
  access_method_ids: z.ZodArray<z.ZodString, "many">;
3633
3636
  client_session_token: z.ZodOptional<z.ZodString>;
@@ -3654,6 +3657,7 @@ declare const access_grant: z.ZodObject<{
3654
3657
  created_at: string;
3655
3658
  mode: "code" | "card" | "mobile_key";
3656
3659
  created_access_method_ids: string[];
3660
+ code?: string | undefined;
3657
3661
  }[];
3658
3662
  access_method_ids: string[];
3659
3663
  access_grant_key?: string | undefined;
@@ -3676,6 +3680,7 @@ declare const access_grant: z.ZodObject<{
3676
3680
  created_at: string;
3677
3681
  mode: "code" | "card" | "mobile_key";
3678
3682
  created_access_method_ids: string[];
3683
+ code?: string | undefined;
3679
3684
  }[];
3680
3685
  access_method_ids: string[];
3681
3686
  access_grant_key?: string | undefined;
@@ -24301,6 +24306,7 @@ declare const batch: z.ZodObject<{
24301
24306
  requested_access_methods: z.ZodArray<z.ZodObject<{
24302
24307
  display_name: z.ZodString;
24303
24308
  mode: z.ZodEnum<["code", "card", "mobile_key"]>;
24309
+ code: z.ZodOptional<z.ZodString>;
24304
24310
  created_at: z.ZodString;
24305
24311
  created_access_method_ids: z.ZodArray<z.ZodString, "many">;
24306
24312
  }, "strip", z.ZodTypeAny, {
@@ -24308,11 +24314,13 @@ declare const batch: z.ZodObject<{
24308
24314
  created_at: string;
24309
24315
  mode: "code" | "card" | "mobile_key";
24310
24316
  created_access_method_ids: string[];
24317
+ code?: string | undefined;
24311
24318
  }, {
24312
24319
  display_name: string;
24313
24320
  created_at: string;
24314
24321
  mode: "code" | "card" | "mobile_key";
24315
24322
  created_access_method_ids: string[];
24323
+ code?: string | undefined;
24316
24324
  }>, "many">;
24317
24325
  access_method_ids: z.ZodArray<z.ZodString, "many">;
24318
24326
  client_session_token: z.ZodOptional<z.ZodString>;
@@ -24339,6 +24347,7 @@ declare const batch: z.ZodObject<{
24339
24347
  created_at: string;
24340
24348
  mode: "code" | "card" | "mobile_key";
24341
24349
  created_access_method_ids: string[];
24350
+ code?: string | undefined;
24342
24351
  }[];
24343
24352
  access_method_ids: string[];
24344
24353
  access_grant_key?: string | undefined;
@@ -24361,6 +24370,7 @@ declare const batch: z.ZodObject<{
24361
24370
  created_at: string;
24362
24371
  mode: "code" | "card" | "mobile_key";
24363
24372
  created_access_method_ids: string[];
24373
+ code?: string | undefined;
24364
24374
  }[];
24365
24375
  access_method_ids: string[];
24366
24376
  access_grant_key?: string | undefined;
@@ -31306,6 +31316,7 @@ declare const batch: z.ZodObject<{
31306
31316
  created_at: string;
31307
31317
  mode: "code" | "card" | "mobile_key";
31308
31318
  created_access_method_ids: string[];
31319
+ code?: string | undefined;
31309
31320
  }[];
31310
31321
  access_method_ids: string[];
31311
31322
  access_grant_key?: string | undefined;
@@ -35143,6 +35154,7 @@ declare const batch: z.ZodObject<{
35143
35154
  created_at: string;
35144
35155
  mode: "code" | "card" | "mobile_key";
35145
35156
  created_access_method_ids: string[];
35157
+ code?: string | undefined;
35146
35158
  }[];
35147
35159
  access_method_ids: string[];
35148
35160
  access_grant_key?: string | undefined;
@@ -50934,6 +50946,13 @@ declare const _default: {
50934
50946
  description: string;
50935
50947
  items: {
50936
50948
  properties: {
50949
+ code: {
50950
+ description: string;
50951
+ maxLength: number;
50952
+ minLength: number;
50953
+ pattern: string;
50954
+ type: string;
50955
+ };
50937
50956
  created_access_method_ids: {
50938
50957
  description: string;
50939
50958
  items: {
@@ -67214,6 +67233,13 @@ declare const _default: {
67214
67233
  requested_access_methods: {
67215
67234
  items: {
67216
67235
  properties: {
67236
+ code: {
67237
+ description: string;
67238
+ maxLength: number;
67239
+ minLength: number;
67240
+ pattern: string;
67241
+ type: string;
67242
+ };
67217
67243
  mode: {
67218
67244
  description: string;
67219
67245
  enum: string[];
@@ -67880,8 +67906,8 @@ declare const _default: {
67880
67906
  name: string;
67881
67907
  schema: {
67882
67908
  description: string;
67883
- format: string;
67884
67909
  type: string;
67910
+ format?: never;
67885
67911
  deprecated?: never;
67886
67912
  'x-deprecated'?: never;
67887
67913
  };
@@ -67889,21 +67915,21 @@ declare const _default: {
67889
67915
  in: string;
67890
67916
  name: string;
67891
67917
  schema: {
67892
- deprecated: boolean;
67918
+ description: string;
67893
67919
  format: string;
67894
67920
  type: string;
67895
- 'x-deprecated': string;
67896
- description?: never;
67921
+ deprecated?: never;
67922
+ 'x-deprecated'?: never;
67897
67923
  };
67898
67924
  } | {
67899
67925
  in: string;
67900
67926
  name: string;
67901
67927
  schema: {
67902
- description: string;
67928
+ deprecated: boolean;
67929
+ format: string;
67903
67930
  type: string;
67904
- format?: never;
67905
- deprecated?: never;
67906
- 'x-deprecated'?: never;
67931
+ 'x-deprecated': string;
67932
+ description?: never;
67907
67933
  };
67908
67934
  })[];
67909
67935
  responses: {
@@ -67988,6 +68014,10 @@ declare const _default: {
67988
68014
  format: string;
67989
68015
  type: string;
67990
68016
  };
68017
+ customer_key: {
68018
+ description: string;
68019
+ type: string;
68020
+ };
67991
68021
  location_id: {
67992
68022
  deprecated: boolean;
67993
68023
  format: string;
@@ -83484,8 +83514,8 @@ declare const _default: {
83484
83514
  name: string;
83485
83515
  schema: {
83486
83516
  description: string;
83487
- format: string;
83488
83517
  type: string;
83518
+ format?: never;
83489
83519
  items?: never;
83490
83520
  maxItems?: never;
83491
83521
  minItems?: never;
@@ -83497,8 +83527,8 @@ declare const _default: {
83497
83527
  name: string;
83498
83528
  schema: {
83499
83529
  description: string;
83530
+ format: string;
83500
83531
  type: string;
83501
- format?: never;
83502
83532
  items?: never;
83503
83533
  maxItems?: never;
83504
83534
  minItems?: never;
@@ -83720,12 +83750,8 @@ declare const _default: {
83720
83750
  format: string;
83721
83751
  type: string;
83722
83752
  };
83723
- customer_ids: {
83753
+ customer_key: {
83724
83754
  description: string;
83725
- items: {
83726
- format: string;
83727
- type: string;
83728
- };
83729
83755
  type: string;
83730
83756
  };
83731
83757
  device_id: {
@@ -91336,8 +91362,8 @@ declare const _default: {
91336
91362
  name: string;
91337
91363
  schema: {
91338
91364
  description: string;
91339
- minLength: number;
91340
91365
  type: string;
91366
+ minLength?: never;
91341
91367
  format?: never;
91342
91368
  'x-draft'?: never;
91343
91369
  'x-undocumented'?: never;
@@ -91347,22 +91373,22 @@ declare const _default: {
91347
91373
  name: string;
91348
91374
  schema: {
91349
91375
  description: string;
91350
- format: string;
91376
+ minLength: number;
91351
91377
  type: string;
91352
- 'x-draft': string;
91353
- 'x-undocumented': string;
91354
- minLength?: never;
91378
+ format?: never;
91379
+ 'x-draft'?: never;
91380
+ 'x-undocumented'?: never;
91355
91381
  };
91356
91382
  } | {
91357
91383
  in: string;
91358
91384
  name: string;
91359
91385
  schema: {
91360
91386
  description: string;
91387
+ format: string;
91361
91388
  type: string;
91389
+ 'x-draft': string;
91390
+ 'x-undocumented': string;
91362
91391
  minLength?: never;
91363
- format?: never;
91364
- 'x-draft'?: never;
91365
- 'x-undocumented'?: never;
91366
91392
  };
91367
91393
  })[];
91368
91394
  responses: {
@@ -91440,6 +91466,10 @@ declare const _default: {
91440
91466
  'x-draft': string;
91441
91467
  'x-undocumented': string;
91442
91468
  };
91469
+ customer_key: {
91470
+ description: string;
91471
+ type: string;
91472
+ };
91443
91473
  search: {
91444
91474
  description: string;
91445
91475
  minLength: number;
@@ -99446,6 +99476,14 @@ declare const _default: {
99446
99476
  get: {
99447
99477
  description: string;
99448
99478
  operationId: string;
99479
+ parameters: {
99480
+ in: string;
99481
+ name: string;
99482
+ schema: {
99483
+ description: string;
99484
+ type: string;
99485
+ };
99486
+ }[];
99449
99487
  responses: {
99450
99488
  200: {
99451
99489
  content: {
@@ -99509,6 +99547,21 @@ declare const _default: {
99509
99547
  post: {
99510
99548
  description: string;
99511
99549
  operationId: string;
99550
+ requestBody: {
99551
+ content: {
99552
+ 'application/json': {
99553
+ schema: {
99554
+ properties: {
99555
+ customer_key: {
99556
+ description: string;
99557
+ type: string;
99558
+ };
99559
+ };
99560
+ type: string;
99561
+ };
99562
+ };
99563
+ };
99564
+ };
99512
99565
  responses: {
99513
99566
  200: {
99514
99567
  content: {
@@ -110808,6 +110861,8 @@ type Routes = {
110808
110861
  requested_access_methods: {
110809
110862
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
110810
110863
  mode: 'code' | 'card' | 'mobile_key';
110864
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
110865
+ code?: string | undefined;
110811
110866
  }[];
110812
110867
  /** 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. */
110813
110868
  starts_at?: string | undefined;
@@ -110839,6 +110894,8 @@ type Routes = {
110839
110894
  display_name: string;
110840
110895
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
110841
110896
  mode: 'code' | 'card' | 'mobile_key';
110897
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
110898
+ code?: string | undefined;
110842
110899
  /** Date and time at which the requested access method was added to the Access Grant. */
110843
110900
  created_at: string;
110844
110901
  /** IDs of the access methods created for the requested access method. */
@@ -110912,6 +110969,8 @@ type Routes = {
110912
110969
  display_name: string;
110913
110970
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
110914
110971
  mode: 'code' | 'card' | 'mobile_key';
110972
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
110973
+ code?: string | undefined;
110915
110974
  /** Date and time at which the requested access method was added to the Access Grant. */
110916
110975
  created_at: string;
110917
110976
  /** IDs of the access methods created for the requested access method. */
@@ -112587,6 +112646,8 @@ type Routes = {
112587
112646
  queryParams: {};
112588
112647
  jsonBody: {};
112589
112648
  commonParams: {
112649
+ /** Customer key for which you want to list access grants. */
112650
+ customer_key?: string | undefined;
112590
112651
  /** ID of user identity by which you want to filter the list of Access Grants. */
112591
112652
  user_identity_id?: string | undefined;
112592
112653
  /** ID of the access system by which you want to filter the list of Access Grants. */
@@ -112623,6 +112684,8 @@ type Routes = {
112623
112684
  display_name: string;
112624
112685
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
112625
112686
  mode: 'code' | 'card' | 'mobile_key';
112687
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
112688
+ code?: string | undefined;
112626
112689
  /** Date and time at which the requested access method was added to the Access Grant. */
112627
112690
  created_at: string;
112628
112691
  /** IDs of the access methods created for the requested access method. */
@@ -117999,6 +118062,8 @@ type Routes = {
117999
118062
  display_name: string;
118000
118063
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
118001
118064
  mode: 'code' | 'card' | 'mobile_key';
118065
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
118066
+ code?: string | undefined;
118002
118067
  /** Date and time at which the requested access method was added to the Access Grant. */
118003
118068
  created_at: string;
118004
118069
  /** IDs of the access methods created for the requested access method. */
@@ -137583,6 +137648,8 @@ type Routes = {
137583
137648
  queryParams: {};
137584
137649
  jsonBody: {};
137585
137650
  commonParams: {
137651
+ /** Customer key for which you want to list events. */
137652
+ customer_key?: string | undefined;
137586
137653
  /** Offset for the events that you want to list. */
137587
137654
  unstable_offset?: number | undefined;
137588
137655
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
@@ -137613,8 +137680,6 @@ type Routes = {
137613
137680
  limit?: number;
137614
137681
  /** IDs of the events that you want to list. */
137615
137682
  event_ids?: string[] | undefined;
137616
- /** IDs of the customers for which you want to list events. */
137617
- customer_ids?: string[] | undefined;
137618
137683
  };
137619
137684
  formData: {};
137620
137685
  jsonResponse: {
@@ -160524,6 +160589,8 @@ type Routes = {
160524
160589
  queryParams: {};
160525
160590
  jsonBody: {};
160526
160591
  commonParams: {
160592
+ /** Customer key for which you want to list spaces. */
160593
+ customer_key?: string | undefined;
160527
160594
  /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
160528
160595
  search?: string | undefined;
160529
160596
  /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
@@ -179531,7 +179598,10 @@ type Routes = {
179531
179598
  method: 'POST' | 'GET';
179532
179599
  queryParams: {};
179533
179600
  jsonBody: {};
179534
- commonParams: {};
179601
+ commonParams: {
179602
+ /** Customer key for which you want to list customization profiles. */
179603
+ customer_key?: string | undefined;
179604
+ };
179535
179605
  formData: {};
179536
179606
  jsonResponse: {
179537
179607
  customization_profiles: {
@@ -183585,6 +183655,8 @@ type Routes = {
183585
183655
  display_name: string;
183586
183656
  /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
183587
183657
  mode: 'code' | 'card' | 'mobile_key';
183658
+ /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
183659
+ code?: string | undefined;
183588
183660
  /** Date and time at which the requested access method was added to the Access Grant. */
183589
183661
  created_at: string;
183590
183662
  /** IDs of the access methods created for the requested access method. */
package/dist/index.cjs CHANGED
@@ -2262,6 +2262,9 @@ var requested_access_method = zod.z.object({
2262
2262
  mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
2263
2263
  "Access method mode. Supported values: `code`, `card`, `mobile_key`."
2264
2264
  ),
2265
+ code: zod.z.string().min(4).max(9).regex(/^\d+$/, "Must only contain digits").optional().describe(
2266
+ "Specific PIN code to use for this access method. Only applicable when mode is 'code'."
2267
+ ),
2265
2268
  created_at: zod.z.string().datetime().describe(
2266
2269
  "Date and time at which the requested access method was added to the Access Grant."
2267
2270
  ),
@@ -7177,6 +7180,13 @@ var openapi_default = {
7177
7180
  description: "Access methods that the user requested for the Access Grant.",
7178
7181
  items: {
7179
7182
  properties: {
7183
+ code: {
7184
+ description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
7185
+ maxLength: 9,
7186
+ minLength: 4,
7187
+ pattern: "^\\d+$",
7188
+ type: "string"
7189
+ },
7180
7190
  created_access_method_ids: {
7181
7191
  description: "IDs of the access methods created for the requested access method.",
7182
7192
  items: { format: "uuid", type: "string" },
@@ -30661,6 +30671,13 @@ var openapi_default = {
30661
30671
  requested_access_methods: {
30662
30672
  items: {
30663
30673
  properties: {
30674
+ code: {
30675
+ description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
30676
+ maxLength: 9,
30677
+ minLength: 4,
30678
+ pattern: "^\\d+$",
30679
+ type: "string"
30680
+ },
30664
30681
  mode: {
30665
30682
  description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
30666
30683
  enum: ["code", "card", "mobile_key"],
@@ -31190,6 +31207,14 @@ var openapi_default = {
31190
31207
  description: "Gets an Access Grant.",
31191
31208
  operationId: "accessGrantsListGet",
31192
31209
  parameters: [
31210
+ {
31211
+ in: "query",
31212
+ name: "customer_key",
31213
+ schema: {
31214
+ description: "Customer key for which you want to list access grants.",
31215
+ type: "string"
31216
+ }
31217
+ },
31193
31218
  {
31194
31219
  in: "query",
31195
31220
  name: "user_identity_id",
@@ -31304,6 +31329,10 @@ var openapi_default = {
31304
31329
  format: "uuid",
31305
31330
  type: "string"
31306
31331
  },
31332
+ customer_key: {
31333
+ description: "Customer key for which you want to list access grants.",
31334
+ type: "string"
31335
+ },
31307
31336
  location_id: {
31308
31337
  deprecated: true,
31309
31338
  format: "uuid",
@@ -44621,6 +44650,14 @@ var openapi_default = {
44621
44650
  description: "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.",
44622
44651
  operationId: "eventsListGet",
44623
44652
  parameters: [
44653
+ {
44654
+ in: "query",
44655
+ name: "customer_key",
44656
+ schema: {
44657
+ description: "Customer key for which you want to list events.",
44658
+ type: "string"
44659
+ }
44660
+ },
44624
44661
  {
44625
44662
  in: "query",
44626
44663
  name: "unstable_offset",
@@ -44947,15 +44984,6 @@ var openapi_default = {
44947
44984
  items: { format: "uuid", type: "string" },
44948
44985
  type: "array"
44949
44986
  }
44950
- },
44951
- {
44952
- in: "query",
44953
- name: "customer_ids",
44954
- schema: {
44955
- description: "IDs of the customers for which you want to list events.",
44956
- items: { format: "uuid", type: "string" },
44957
- type: "array"
44958
- }
44959
44987
  }
44960
44988
  ],
44961
44989
  responses: {
@@ -45045,10 +45073,9 @@ var openapi_default = {
45045
45073
  format: "uuid",
45046
45074
  type: "string"
45047
45075
  },
45048
- customer_ids: {
45049
- description: "IDs of the customers for which you want to list events.",
45050
- items: { format: "uuid", type: "string" },
45051
- type: "array"
45076
+ customer_key: {
45077
+ description: "Customer key for which you want to list events.",
45078
+ type: "string"
45052
45079
  },
45053
45080
  device_id: {
45054
45081
  description: "ID of the device for which you want to list events.",
@@ -52128,6 +52155,14 @@ var openapi_default = {
52128
52155
  description: "Returns a list of all spaces.",
52129
52156
  operationId: "spacesListGet",
52130
52157
  parameters: [
52158
+ {
52159
+ in: "query",
52160
+ name: "customer_key",
52161
+ schema: {
52162
+ description: "Customer key for which you want to list spaces.",
52163
+ type: "string"
52164
+ }
52165
+ },
52131
52166
  {
52132
52167
  in: "query",
52133
52168
  name: "search",
@@ -52209,6 +52244,10 @@ var openapi_default = {
52209
52244
  "x-draft": "Needs review.",
52210
52245
  "x-undocumented": "Only used internally."
52211
52246
  },
52247
+ customer_key: {
52248
+ description: "Customer key for which you want to list spaces.",
52249
+ type: "string"
52250
+ },
52212
52251
  search: {
52213
52252
  description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
52214
52253
  minLength: 1,
@@ -58561,6 +58600,16 @@ var openapi_default = {
58561
58600
  get: {
58562
58601
  description: "Retrieves the customization profile for the workspace.",
58563
58602
  operationId: "workspacesCustomizationProfilesListGet",
58603
+ parameters: [
58604
+ {
58605
+ in: "query",
58606
+ name: "customer_key",
58607
+ schema: {
58608
+ description: "Customer key for which you want to list customization profiles.",
58609
+ type: "string"
58610
+ }
58611
+ }
58612
+ ],
58564
58613
  responses: {
58565
58614
  200: {
58566
58615
  content: {
@@ -58603,6 +58652,21 @@ var openapi_default = {
58603
58652
  post: {
58604
58653
  description: "Retrieves the customization profile for the workspace.",
58605
58654
  operationId: "workspacesCustomizationProfilesListPost",
58655
+ requestBody: {
58656
+ content: {
58657
+ "application/json": {
58658
+ schema: {
58659
+ properties: {
58660
+ customer_key: {
58661
+ description: "Customer key for which you want to list customization profiles.",
58662
+ type: "string"
58663
+ }
58664
+ },
58665
+ type: "object"
58666
+ }
58667
+ }
58668
+ }
58669
+ },
58606
58670
  responses: {
58607
58671
  200: {
58608
58672
  content: {