@seamapi/types 1.521.0 → 1.523.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 (19) hide show
  1. package/dist/connect.cjs +65 -1
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +266 -0
  4. package/dist/index.cjs +65 -1
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/batch.d.ts +100 -0
  7. package/lib/seam/connect/models/customer/customer-delete-data.d.ts +2 -2
  8. package/lib/seam/connect/models/events/access-methods.d.ts +60 -0
  9. package/lib/seam/connect/models/events/access-methods.js +7 -0
  10. package/lib/seam/connect/models/events/access-methods.js.map +1 -1
  11. package/lib/seam/connect/models/events/seam-event.d.ts +30 -0
  12. package/lib/seam/connect/openapi.d.ts +84 -0
  13. package/lib/seam/connect/openapi.js +60 -0
  14. package/lib/seam/connect/openapi.js.map +1 -1
  15. package/lib/seam/connect/route-types.d.ts +102 -0
  16. package/package.json +1 -1
  17. package/src/lib/seam/connect/models/events/access-methods.ts +9 -0
  18. package/src/lib/seam/connect/openapi.ts +71 -0
  19. package/src/lib/seam/connect/route-types.ts +102 -0
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -17712,6 +17712,10 @@ export type Routes = {
17712
17712
  occurred_at: string;
17713
17713
  /** ID of the affected access method. */
17714
17714
  access_method_id: string;
17715
+ /** IDs of the access grants associated with this access method. */
17716
+ access_grant_ids: string[];
17717
+ /** Keys of the access grants associated with this access method (if present). */
17718
+ access_grant_keys?: string[] | undefined;
17715
17719
  event_type: 'access_method.issued';
17716
17720
  } | {
17717
17721
  /** ID of the event. */
@@ -17724,6 +17728,10 @@ export type Routes = {
17724
17728
  occurred_at: string;
17725
17729
  /** ID of the affected access method. */
17726
17730
  access_method_id: string;
17731
+ /** IDs of the access grants associated with this access method. */
17732
+ access_grant_ids: string[];
17733
+ /** Keys of the access grants associated with this access method (if present). */
17734
+ access_grant_keys?: string[] | undefined;
17727
17735
  event_type: 'access_method.revoked';
17728
17736
  } | {
17729
17737
  /** ID of the event. */
@@ -17736,6 +17744,10 @@ export type Routes = {
17736
17744
  occurred_at: string;
17737
17745
  /** ID of the affected access method. */
17738
17746
  access_method_id: string;
17747
+ /** IDs of the access grants associated with this access method. */
17748
+ access_grant_ids: string[];
17749
+ /** Keys of the access grants associated with this access method (if present). */
17750
+ access_grant_keys?: string[] | undefined;
17739
17751
  event_type: 'access_method.card_encoding_required';
17740
17752
  } | {
17741
17753
  /** ID of the event. */
@@ -17748,6 +17760,10 @@ export type Routes = {
17748
17760
  occurred_at: string;
17749
17761
  /** ID of the affected access method. */
17750
17762
  access_method_id: string;
17763
+ /** IDs of the access grants associated with this access method. */
17764
+ access_grant_ids: string[];
17765
+ /** Keys of the access grants associated with this access method (if present). */
17766
+ access_grant_keys?: string[] | undefined;
17751
17767
  event_type: 'access_method.deleted';
17752
17768
  } | {
17753
17769
  /** ID of the event. */
@@ -17760,6 +17776,10 @@ export type Routes = {
17760
17776
  occurred_at: string;
17761
17777
  /** ID of the affected access method. */
17762
17778
  access_method_id: string;
17779
+ /** IDs of the access grants associated with this access method. */
17780
+ access_grant_ids: string[];
17781
+ /** Keys of the access grants associated with this access method (if present). */
17782
+ access_grant_keys?: string[] | undefined;
17763
17783
  event_type: 'access_method.reissued';
17764
17784
  } | {
17765
17785
  /** ID of the event. */
@@ -21518,6 +21538,8 @@ export type Routes = {
21518
21538
  created_before?: Date | undefined;
21519
21539
  /** Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. */
21520
21540
  is_multi_phone_sync_credential?: boolean | undefined;
21541
+ /** String for which to search. Filters returned credentials to include all records that satisfy a partial match using `code`, `card_number`, `acs_user_id` or `acs_credential_id`. */
21542
+ search?: string | undefined;
21521
21543
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
21522
21544
  page_cursor?: (string | undefined) | null;
21523
21545
  };
@@ -35453,6 +35475,10 @@ export type Routes = {
35453
35475
  occurred_at: string;
35454
35476
  /** ID of the affected access method. */
35455
35477
  access_method_id: string;
35478
+ /** IDs of the access grants associated with this access method. */
35479
+ access_grant_ids: string[];
35480
+ /** Keys of the access grants associated with this access method (if present). */
35481
+ access_grant_keys?: string[] | undefined;
35456
35482
  event_type: 'access_method.issued';
35457
35483
  } | {
35458
35484
  /** ID of the event. */
@@ -35465,6 +35491,10 @@ export type Routes = {
35465
35491
  occurred_at: string;
35466
35492
  /** ID of the affected access method. */
35467
35493
  access_method_id: string;
35494
+ /** IDs of the access grants associated with this access method. */
35495
+ access_grant_ids: string[];
35496
+ /** Keys of the access grants associated with this access method (if present). */
35497
+ access_grant_keys?: string[] | undefined;
35468
35498
  event_type: 'access_method.revoked';
35469
35499
  } | {
35470
35500
  /** ID of the event. */
@@ -35477,6 +35507,10 @@ export type Routes = {
35477
35507
  occurred_at: string;
35478
35508
  /** ID of the affected access method. */
35479
35509
  access_method_id: string;
35510
+ /** IDs of the access grants associated with this access method. */
35511
+ access_grant_ids: string[];
35512
+ /** Keys of the access grants associated with this access method (if present). */
35513
+ access_grant_keys?: string[] | undefined;
35480
35514
  event_type: 'access_method.card_encoding_required';
35481
35515
  } | {
35482
35516
  /** ID of the event. */
@@ -35489,6 +35523,10 @@ export type Routes = {
35489
35523
  occurred_at: string;
35490
35524
  /** ID of the affected access method. */
35491
35525
  access_method_id: string;
35526
+ /** IDs of the access grants associated with this access method. */
35527
+ access_grant_ids: string[];
35528
+ /** Keys of the access grants associated with this access method (if present). */
35529
+ access_grant_keys?: string[] | undefined;
35492
35530
  event_type: 'access_method.deleted';
35493
35531
  } | {
35494
35532
  /** ID of the event. */
@@ -35501,6 +35539,10 @@ export type Routes = {
35501
35539
  occurred_at: string;
35502
35540
  /** ID of the affected access method. */
35503
35541
  access_method_id: string;
35542
+ /** IDs of the access grants associated with this access method. */
35543
+ access_grant_ids: string[];
35544
+ /** Keys of the access grants associated with this access method (if present). */
35545
+ access_grant_keys?: string[] | undefined;
35504
35546
  event_type: 'access_method.reissued';
35505
35547
  } | {
35506
35548
  /** ID of the event. */
@@ -37327,6 +37369,10 @@ export type Routes = {
37327
37369
  occurred_at: string;
37328
37370
  /** ID of the affected access method. */
37329
37371
  access_method_id: string;
37372
+ /** IDs of the access grants associated with this access method. */
37373
+ access_grant_ids: string[];
37374
+ /** Keys of the access grants associated with this access method (if present). */
37375
+ access_grant_keys?: string[] | undefined;
37330
37376
  event_type: 'access_method.issued';
37331
37377
  } | {
37332
37378
  /** ID of the event. */
@@ -37339,6 +37385,10 @@ export type Routes = {
37339
37385
  occurred_at: string;
37340
37386
  /** ID of the affected access method. */
37341
37387
  access_method_id: string;
37388
+ /** IDs of the access grants associated with this access method. */
37389
+ access_grant_ids: string[];
37390
+ /** Keys of the access grants associated with this access method (if present). */
37391
+ access_grant_keys?: string[] | undefined;
37342
37392
  event_type: 'access_method.revoked';
37343
37393
  } | {
37344
37394
  /** ID of the event. */
@@ -37351,6 +37401,10 @@ export type Routes = {
37351
37401
  occurred_at: string;
37352
37402
  /** ID of the affected access method. */
37353
37403
  access_method_id: string;
37404
+ /** IDs of the access grants associated with this access method. */
37405
+ access_grant_ids: string[];
37406
+ /** Keys of the access grants associated with this access method (if present). */
37407
+ access_grant_keys?: string[] | undefined;
37354
37408
  event_type: 'access_method.card_encoding_required';
37355
37409
  } | {
37356
37410
  /** ID of the event. */
@@ -37363,6 +37417,10 @@ export type Routes = {
37363
37417
  occurred_at: string;
37364
37418
  /** ID of the affected access method. */
37365
37419
  access_method_id: string;
37420
+ /** IDs of the access grants associated with this access method. */
37421
+ access_grant_ids: string[];
37422
+ /** Keys of the access grants associated with this access method (if present). */
37423
+ access_grant_keys?: string[] | undefined;
37366
37424
  event_type: 'access_method.deleted';
37367
37425
  } | {
37368
37426
  /** ID of the event. */
@@ -37375,6 +37433,10 @@ export type Routes = {
37375
37433
  occurred_at: string;
37376
37434
  /** ID of the affected access method. */
37377
37435
  access_method_id: string;
37436
+ /** IDs of the access grants associated with this access method. */
37437
+ access_grant_ids: string[];
37438
+ /** Keys of the access grants associated with this access method (if present). */
37439
+ access_grant_keys?: string[] | undefined;
37378
37440
  event_type: 'access_method.reissued';
37379
37441
  } | {
37380
37442
  /** ID of the event. */
@@ -56115,6 +56177,10 @@ export type Routes = {
56115
56177
  occurred_at: string;
56116
56178
  /** ID of the affected access method. */
56117
56179
  access_method_id: string;
56180
+ /** IDs of the access grants associated with this access method. */
56181
+ access_grant_ids: string[];
56182
+ /** Keys of the access grants associated with this access method (if present). */
56183
+ access_grant_keys?: string[] | undefined;
56118
56184
  event_type: 'access_method.issued';
56119
56185
  } | {
56120
56186
  /** ID of the event. */
@@ -56127,6 +56193,10 @@ export type Routes = {
56127
56193
  occurred_at: string;
56128
56194
  /** ID of the affected access method. */
56129
56195
  access_method_id: string;
56196
+ /** IDs of the access grants associated with this access method. */
56197
+ access_grant_ids: string[];
56198
+ /** Keys of the access grants associated with this access method (if present). */
56199
+ access_grant_keys?: string[] | undefined;
56130
56200
  event_type: 'access_method.revoked';
56131
56201
  } | {
56132
56202
  /** ID of the event. */
@@ -56139,6 +56209,10 @@ export type Routes = {
56139
56209
  occurred_at: string;
56140
56210
  /** ID of the affected access method. */
56141
56211
  access_method_id: string;
56212
+ /** IDs of the access grants associated with this access method. */
56213
+ access_grant_ids: string[];
56214
+ /** Keys of the access grants associated with this access method (if present). */
56215
+ access_grant_keys?: string[] | undefined;
56142
56216
  event_type: 'access_method.card_encoding_required';
56143
56217
  } | {
56144
56218
  /** ID of the event. */
@@ -56151,6 +56225,10 @@ export type Routes = {
56151
56225
  occurred_at: string;
56152
56226
  /** ID of the affected access method. */
56153
56227
  access_method_id: string;
56228
+ /** IDs of the access grants associated with this access method. */
56229
+ access_grant_ids: string[];
56230
+ /** Keys of the access grants associated with this access method (if present). */
56231
+ access_grant_keys?: string[] | undefined;
56154
56232
  event_type: 'access_method.deleted';
56155
56233
  } | {
56156
56234
  /** ID of the event. */
@@ -56163,6 +56241,10 @@ export type Routes = {
56163
56241
  occurred_at: string;
56164
56242
  /** ID of the affected access method. */
56165
56243
  access_method_id: string;
56244
+ /** IDs of the access grants associated with this access method. */
56245
+ access_grant_ids: string[];
56246
+ /** Keys of the access grants associated with this access method (if present). */
56247
+ access_grant_keys?: string[] | undefined;
56166
56248
  event_type: 'access_method.reissued';
56167
56249
  } | {
56168
56250
  /** ID of the event. */
@@ -83325,6 +83407,10 @@ export type Routes = {
83325
83407
  occurred_at: string;
83326
83408
  /** ID of the affected access method. */
83327
83409
  access_method_id: string;
83410
+ /** IDs of the access grants associated with this access method. */
83411
+ access_grant_ids: string[];
83412
+ /** Keys of the access grants associated with this access method (if present). */
83413
+ access_grant_keys?: string[] | undefined;
83328
83414
  event_type: 'access_method.issued';
83329
83415
  } | {
83330
83416
  /** ID of the event. */
@@ -83337,6 +83423,10 @@ export type Routes = {
83337
83423
  occurred_at: string;
83338
83424
  /** ID of the affected access method. */
83339
83425
  access_method_id: string;
83426
+ /** IDs of the access grants associated with this access method. */
83427
+ access_grant_ids: string[];
83428
+ /** Keys of the access grants associated with this access method (if present). */
83429
+ access_grant_keys?: string[] | undefined;
83340
83430
  event_type: 'access_method.revoked';
83341
83431
  } | {
83342
83432
  /** ID of the event. */
@@ -83349,6 +83439,10 @@ export type Routes = {
83349
83439
  occurred_at: string;
83350
83440
  /** ID of the affected access method. */
83351
83441
  access_method_id: string;
83442
+ /** IDs of the access grants associated with this access method. */
83443
+ access_grant_ids: string[];
83444
+ /** Keys of the access grants associated with this access method (if present). */
83445
+ access_grant_keys?: string[] | undefined;
83352
83446
  event_type: 'access_method.card_encoding_required';
83353
83447
  } | {
83354
83448
  /** ID of the event. */
@@ -83361,6 +83455,10 @@ export type Routes = {
83361
83455
  occurred_at: string;
83362
83456
  /** ID of the affected access method. */
83363
83457
  access_method_id: string;
83458
+ /** IDs of the access grants associated with this access method. */
83459
+ access_grant_ids: string[];
83460
+ /** Keys of the access grants associated with this access method (if present). */
83461
+ access_grant_keys?: string[] | undefined;
83364
83462
  event_type: 'access_method.deleted';
83365
83463
  } | {
83366
83464
  /** ID of the event. */
@@ -83373,6 +83471,10 @@ export type Routes = {
83373
83471
  occurred_at: string;
83374
83472
  /** ID of the affected access method. */
83375
83473
  access_method_id: string;
83474
+ /** IDs of the access grants associated with this access method. */
83475
+ access_grant_ids: string[];
83476
+ /** Keys of the access grants associated with this access method (if present). */
83477
+ access_grant_keys?: string[] | undefined;
83376
83478
  event_type: 'access_method.reissued';
83377
83479
  } | {
83378
83480
  /** ID of the event. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.521.0",
3
+ "version": "1.523.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/events/access-methods.ts CHANGED
@@ -7,6 +7,15 @@ const access_method_event = common_event.extend({
7
7
  .string()
8
8
  .uuid()
9
9
  .describe('ID of the affected access method.'),
10
+ access_grant_ids: z
11
+ .array(z.string().uuid())
12
+ .describe('IDs of the access grants associated with this access method.'),
13
+ access_grant_keys: z
14
+ .array(z.string())
15
+ .optional()
16
+ .describe(
17
+ 'Keys of the access grants associated with this access method (if present).',
18
+ ),
10
19
  })
11
20
 
12
21
  export const access_method_issued_event = access_method_event.extend({
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -14592,6 +14592,18 @@ export default {
14592
14592
  {
14593
14593
  description: 'An access method was issued.',
14594
14594
  properties: {
14595
+ access_grant_ids: {
14596
+ description:
14597
+ 'IDs of the access grants associated with this access method.',
14598
+ items: { format: 'uuid', type: 'string' },
14599
+ type: 'array',
14600
+ },
14601
+ access_grant_keys: {
14602
+ description:
14603
+ 'Keys of the access grants associated with this access method (if present).',
14604
+ items: { type: 'string' },
14605
+ type: 'array',
14606
+ },
14595
14607
  access_method_id: {
14596
14608
  description: 'ID of the affected access method.',
14597
14609
  format: 'uuid',
@@ -14626,6 +14638,7 @@ export default {
14626
14638
  'created_at',
14627
14639
  'occurred_at',
14628
14640
  'access_method_id',
14641
+ 'access_grant_ids',
14629
14642
  'event_type',
14630
14643
  ],
14631
14644
  type: 'object',
@@ -14634,6 +14647,18 @@ export default {
14634
14647
  {
14635
14648
  description: 'An access method was revoked.',
14636
14649
  properties: {
14650
+ access_grant_ids: {
14651
+ description:
14652
+ 'IDs of the access grants associated with this access method.',
14653
+ items: { format: 'uuid', type: 'string' },
14654
+ type: 'array',
14655
+ },
14656
+ access_grant_keys: {
14657
+ description:
14658
+ 'Keys of the access grants associated with this access method (if present).',
14659
+ items: { type: 'string' },
14660
+ type: 'array',
14661
+ },
14637
14662
  access_method_id: {
14638
14663
  description: 'ID of the affected access method.',
14639
14664
  format: 'uuid',
@@ -14668,6 +14693,7 @@ export default {
14668
14693
  'created_at',
14669
14694
  'occurred_at',
14670
14695
  'access_method_id',
14696
+ 'access_grant_ids',
14671
14697
  'event_type',
14672
14698
  ],
14673
14699
  type: 'object',
@@ -14677,6 +14703,18 @@ export default {
14677
14703
  description:
14678
14704
  'An access method representing a physical card requires encoding.',
14679
14705
  properties: {
14706
+ access_grant_ids: {
14707
+ description:
14708
+ 'IDs of the access grants associated with this access method.',
14709
+ items: { format: 'uuid', type: 'string' },
14710
+ type: 'array',
14711
+ },
14712
+ access_grant_keys: {
14713
+ description:
14714
+ 'Keys of the access grants associated with this access method (if present).',
14715
+ items: { type: 'string' },
14716
+ type: 'array',
14717
+ },
14680
14718
  access_method_id: {
14681
14719
  description: 'ID of the affected access method.',
14682
14720
  format: 'uuid',
@@ -14714,6 +14752,7 @@ export default {
14714
14752
  'created_at',
14715
14753
  'occurred_at',
14716
14754
  'access_method_id',
14755
+ 'access_grant_ids',
14717
14756
  'event_type',
14718
14757
  ],
14719
14758
  type: 'object',
@@ -14722,6 +14761,18 @@ export default {
14722
14761
  {
14723
14762
  description: 'An access method was deleted.',
14724
14763
  properties: {
14764
+ access_grant_ids: {
14765
+ description:
14766
+ 'IDs of the access grants associated with this access method.',
14767
+ items: { format: 'uuid', type: 'string' },
14768
+ type: 'array',
14769
+ },
14770
+ access_grant_keys: {
14771
+ description:
14772
+ 'Keys of the access grants associated with this access method (if present).',
14773
+ items: { type: 'string' },
14774
+ type: 'array',
14775
+ },
14725
14776
  access_method_id: {
14726
14777
  description: 'ID of the affected access method.',
14727
14778
  format: 'uuid',
@@ -14756,6 +14807,7 @@ export default {
14756
14807
  'created_at',
14757
14808
  'occurred_at',
14758
14809
  'access_method_id',
14810
+ 'access_grant_ids',
14759
14811
  'event_type',
14760
14812
  ],
14761
14813
  type: 'object',
@@ -14765,6 +14817,18 @@ export default {
14765
14817
  description:
14766
14818
  'An access method was reissued due to an Access Grant update.',
14767
14819
  properties: {
14820
+ access_grant_ids: {
14821
+ description:
14822
+ 'IDs of the access grants associated with this access method.',
14823
+ items: { format: 'uuid', type: 'string' },
14824
+ type: 'array',
14825
+ },
14826
+ access_grant_keys: {
14827
+ description:
14828
+ 'Keys of the access grants associated with this access method (if present).',
14829
+ items: { type: 'string' },
14830
+ type: 'array',
14831
+ },
14768
14832
  access_method_id: {
14769
14833
  description: 'ID of the affected access method.',
14770
14834
  format: 'uuid',
@@ -14799,6 +14863,7 @@ export default {
14799
14863
  'created_at',
14800
14864
  'occurred_at',
14801
14865
  'access_method_id',
14866
+ 'access_grant_ids',
14802
14867
  'event_type',
14803
14868
  ],
14804
14869
  type: 'object',
@@ -31657,6 +31722,12 @@ export default {
31657
31722
  nullable: true,
31658
31723
  type: 'string',
31659
31724
  },
31725
+ search: {
31726
+ description:
31727
+ 'String for which to search. Filters returned credentials to include all records that satisfy a partial match using `code`, `card_number`, `acs_user_id` or `acs_credential_id`.',
31728
+ minLength: 1,
31729
+ type: 'string',
31730
+ },
31660
31731
  },
31661
31732
  type: 'object',
31662
31733
  },