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