@seamapi/types 1.520.0 → 1.522.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.
@@ -21518,6 +21518,8 @@ export type Routes = {
21518
21518
  created_before?: Date | undefined;
21519
21519
  /** Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. */
21520
21520
  is_multi_phone_sync_credential?: boolean | undefined;
21521
+ /** 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`. */
21522
+ search?: string | undefined;
21521
21523
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
21522
21524
  page_cursor?: (string | undefined) | null;
21523
21525
  };
@@ -23709,21 +23711,20 @@ export type Routes = {
23709
23711
  method: 'GET' | 'POST';
23710
23712
  queryParams: {};
23711
23713
  jsonBody: {};
23712
- commonParams: {
23714
+ commonParams: ({
23713
23715
  /** ID of the access system for which you want to retrieve all encoders. */
23714
23716
  acs_system_id: string;
23715
- /** Number of encoders to return. */
23716
- limit?: number;
23717
23717
  } | {
23718
23718
  /** IDs of the access systems for which you want to retrieve all encoders. */
23719
23719
  acs_system_ids: string[];
23720
- /** Number of encoders to return. */
23721
- limit?: number;
23722
23720
  } | {
23723
23721
  /** IDs of the encoders that you want to retrieve. */
23724
23722
  acs_encoder_ids: string[];
23723
+ }) & {
23725
23724
  /** Number of encoders to return. */
23726
23725
  limit?: number;
23726
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
23727
+ page_cursor?: (string | undefined) | null;
23727
23728
  };
23728
23729
  formData: {};
23729
23730
  jsonResponse: {
@@ -23750,6 +23751,15 @@ export type Routes = {
23750
23751
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
23751
23752
  display_name: string;
23752
23753
  }[];
23754
+ /** Information about the current page of results. */
23755
+ pagination: {
23756
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
23757
+ next_page_cursor: string | null;
23758
+ /** Indicates whether there is another page of results after this one. */
23759
+ has_next_page: boolean;
23760
+ /** URL to get the next page of results. */
23761
+ next_page_url: string | null;
23762
+ };
23753
23763
  };
23754
23764
  };
23755
23765
  '/acs/encoders/scan_credential': {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.520.0",
3
+ "version": "1.522.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -31657,6 +31657,12 @@ export default {
31657
31657
  nullable: true,
31658
31658
  type: 'string',
31659
31659
  },
31660
+ search: {
31661
+ description:
31662
+ '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`.',
31663
+ minLength: 1,
31664
+ type: 'string',
31665
+ },
31660
31666
  },
31661
31667
  type: 'object',
31662
31668
  },
@@ -32543,8 +32549,9 @@ export default {
32543
32549
  type: 'array',
32544
32550
  },
32545
32551
  ok: { type: 'boolean' },
32552
+ pagination: { $ref: '#/components/schemas/pagination' },
32546
32553
  },
32547
- required: ['acs_encoders', 'ok'],
32554
+ required: ['acs_encoders', 'pagination', 'ok'],
32548
32555
  type: 'object',
32549
32556
  },
32550
32557
  },
@@ -32575,59 +32582,62 @@ export default {
32575
32582
  content: {
32576
32583
  'application/json': {
32577
32584
  schema: {
32578
- oneOf: [
32585
+ allOf: [
32579
32586
  {
32580
- properties: {
32581
- acs_system_id: {
32582
- description:
32583
- 'ID of the access system for which you want to retrieve all encoders.',
32584
- format: 'uuid',
32585
- type: 'string',
32587
+ oneOf: [
32588
+ {
32589
+ properties: {
32590
+ acs_system_id: {
32591
+ description:
32592
+ 'ID of the access system for which you want to retrieve all encoders.',
32593
+ format: 'uuid',
32594
+ type: 'string',
32595
+ },
32596
+ },
32597
+ required: ['acs_system_id'],
32598
+ type: 'object',
32586
32599
  },
32587
- limit: {
32588
- default: 500,
32589
- description: 'Number of encoders to return.',
32590
- format: 'float',
32591
- type: 'number',
32600
+ {
32601
+ properties: {
32602
+ acs_system_ids: {
32603
+ description:
32604
+ 'IDs of the access systems for which you want to retrieve all encoders.',
32605
+ items: { format: 'uuid', type: 'string' },
32606
+ type: 'array',
32607
+ },
32608
+ },
32609
+ required: ['acs_system_ids'],
32610
+ type: 'object',
32592
32611
  },
32593
- },
32594
- required: ['acs_system_id'],
32595
- type: 'object',
32612
+ {
32613
+ properties: {
32614
+ acs_encoder_ids: {
32615
+ description:
32616
+ 'IDs of the encoders that you want to retrieve.',
32617
+ items: { format: 'uuid', type: 'string' },
32618
+ type: 'array',
32619
+ },
32620
+ },
32621
+ required: ['acs_encoder_ids'],
32622
+ type: 'object',
32623
+ },
32624
+ ],
32596
32625
  },
32597
32626
  {
32598
32627
  properties: {
32599
- acs_system_ids: {
32600
- description:
32601
- 'IDs of the access systems for which you want to retrieve all encoders.',
32602
- items: { format: 'uuid', type: 'string' },
32603
- type: 'array',
32604
- },
32605
32628
  limit: {
32606
32629
  default: 500,
32607
32630
  description: 'Number of encoders to return.',
32608
32631
  format: 'float',
32609
32632
  type: 'number',
32610
32633
  },
32611
- },
32612
- required: ['acs_system_ids'],
32613
- type: 'object',
32614
- },
32615
- {
32616
- properties: {
32617
- acs_encoder_ids: {
32634
+ page_cursor: {
32618
32635
  description:
32619
- 'IDs of the encoders that you want to retrieve.',
32620
- items: { format: 'uuid', type: 'string' },
32621
- type: 'array',
32622
- },
32623
- limit: {
32624
- default: 500,
32625
- description: 'Number of encoders to return.',
32626
- format: 'float',
32627
- type: 'number',
32636
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
32637
+ nullable: true,
32638
+ type: 'string',
32628
32639
  },
32629
32640
  },
32630
- required: ['acs_encoder_ids'],
32631
32641
  type: 'object',
32632
32642
  },
32633
32643
  ],
@@ -32646,8 +32656,9 @@ export default {
32646
32656
  type: 'array',
32647
32657
  },
32648
32658
  ok: { type: 'boolean' },
32659
+ pagination: { $ref: '#/components/schemas/pagination' },
32649
32660
  },
32650
- required: ['acs_encoders', 'ok'],
32661
+ required: ['acs_encoders', 'pagination', 'ok'],
32651
32662
  type: 'object',
32652
32663
  },
32653
32664
  },
@@ -25003,6 +25003,8 @@ export type Routes = {
25003
25003
  created_before?: Date | undefined
25004
25004
  /** Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. */
25005
25005
  is_multi_phone_sync_credential?: boolean | undefined
25006
+ /** 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`. */
25007
+ search?: string | undefined
25006
25008
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
25007
25009
  page_cursor?: (string | undefined) | null
25008
25010
  }
@@ -27543,25 +27545,25 @@ export type Routes = {
27543
27545
  method: 'GET' | 'POST'
27544
27546
  queryParams: {}
27545
27547
  jsonBody: {}
27546
- commonParams:
27548
+ commonParams: (
27547
27549
  | {
27548
27550
  /** ID of the access system for which you want to retrieve all encoders. */
27549
27551
  acs_system_id: string
27550
- /** Number of encoders to return. */
27551
- limit?: number
27552
27552
  }
27553
27553
  | {
27554
27554
  /** IDs of the access systems for which you want to retrieve all encoders. */
27555
27555
  acs_system_ids: string[]
27556
- /** Number of encoders to return. */
27557
- limit?: number
27558
27556
  }
27559
27557
  | {
27560
27558
  /** IDs of the encoders that you want to retrieve. */
27561
27559
  acs_encoder_ids: string[]
27562
- /** Number of encoders to return. */
27563
- limit?: number
27564
27560
  }
27561
+ ) & {
27562
+ /** Number of encoders to return. */
27563
+ limit?: number
27564
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
27565
+ page_cursor?: (string | undefined) | null
27566
+ }
27565
27567
  formData: {}
27566
27568
  jsonResponse: {
27567
27569
  acs_encoders: {
@@ -27587,6 +27589,15 @@ export type Routes = {
27587
27589
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
27588
27590
  display_name: string
27589
27591
  }[]
27592
+ /** Information about the current page of results. */
27593
+ pagination: {
27594
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
27595
+ next_page_cursor: string | null
27596
+ /** Indicates whether there is another page of results after this one. */
27597
+ has_next_page: boolean
27598
+ /** URL to get the next page of results. */
27599
+ next_page_url: string | null
27600
+ }
27590
27601
  }
27591
27602
  }
27592
27603
  '/acs/encoders/scan_credential': {