@seamapi/types 1.981.0 → 1.982.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.
@@ -38592,7 +38592,7 @@ const openapi = {
38592
38592
  in: 'query',
38593
38593
  name: 'device_id',
38594
38594
  schema: {
38595
- description: 'ID of the device for which you want to retrieve all access methods.',
38595
+ description: 'ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38596
38596
  format: 'uuid',
38597
38597
  type: 'string',
38598
38598
  },
@@ -38601,7 +38601,7 @@ const openapi = {
38601
38601
  in: 'query',
38602
38602
  name: 'acs_entrance_id',
38603
38603
  schema: {
38604
- description: 'ID of the entrance for which you want to retrieve all access methods.',
38604
+ description: 'ID of the entrance for which you want to retrieve all access methods that grant access to it.',
38605
38605
  format: 'uuid',
38606
38606
  type: 'string',
38607
38607
  },
@@ -38610,7 +38610,7 @@ const openapi = {
38610
38610
  in: 'query',
38611
38611
  name: 'space_id',
38612
38612
  schema: {
38613
- description: 'ID of the space for which you want to retrieve all access methods.',
38613
+ description: 'ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38614
38614
  format: 'uuid',
38615
38615
  type: 'string',
38616
38616
  },
@@ -38619,11 +38619,31 @@ const openapi = {
38619
38619
  in: 'query',
38620
38620
  name: 'access_code_id',
38621
38621
  schema: {
38622
- description: 'ID of the access code for which you want to retrieve all access methods.',
38622
+ description: 'ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38623
38623
  format: 'uuid',
38624
38624
  type: 'string',
38625
38625
  },
38626
38626
  },
38627
+ {
38628
+ in: 'query',
38629
+ name: 'limit',
38630
+ schema: {
38631
+ default: 500,
38632
+ description: 'Maximum number of records to return per page.',
38633
+ exclusiveMinimum: true,
38634
+ minimum: 0,
38635
+ type: 'integer',
38636
+ },
38637
+ },
38638
+ {
38639
+ in: 'query',
38640
+ name: 'page_cursor',
38641
+ schema: {
38642
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
38643
+ nullable: true,
38644
+ type: 'string',
38645
+ },
38646
+ },
38627
38647
  ],
38628
38648
  responses: {
38629
38649
  200: {
@@ -38636,8 +38656,9 @@ const openapi = {
38636
38656
  type: 'array',
38637
38657
  },
38638
38658
  ok: { type: 'boolean' },
38659
+ pagination: { $ref: '#/components/schemas/pagination' },
38639
38660
  },
38640
- required: ['access_methods', 'ok'],
38661
+ required: ['access_methods', 'pagination', 'ok'],
38641
38662
  type: 'object',
38642
38663
  },
38643
38664
  },
@@ -38672,7 +38693,7 @@ const openapi = {
38672
38693
  schema: {
38673
38694
  properties: {
38674
38695
  access_code_id: {
38675
- description: 'ID of the access code for which you want to retrieve all access methods.',
38696
+ description: 'ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38676
38697
  format: 'uuid',
38677
38698
  type: 'string',
38678
38699
  },
@@ -38687,17 +38708,29 @@ const openapi = {
38687
38708
  type: 'string',
38688
38709
  },
38689
38710
  acs_entrance_id: {
38690
- description: 'ID of the entrance for which you want to retrieve all access methods.',
38711
+ description: 'ID of the entrance for which you want to retrieve all access methods that grant access to it.',
38691
38712
  format: 'uuid',
38692
38713
  type: 'string',
38693
38714
  },
38694
38715
  device_id: {
38695
- description: 'ID of the device for which you want to retrieve all access methods.',
38716
+ description: 'ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38696
38717
  format: 'uuid',
38697
38718
  type: 'string',
38698
38719
  },
38720
+ limit: {
38721
+ default: 500,
38722
+ description: 'Maximum number of records to return per page.',
38723
+ exclusiveMinimum: true,
38724
+ minimum: 0,
38725
+ type: 'integer',
38726
+ },
38727
+ page_cursor: {
38728
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
38729
+ nullable: true,
38730
+ type: 'string',
38731
+ },
38699
38732
  space_id: {
38700
- description: 'ID of the space for which you want to retrieve all access methods.',
38733
+ description: 'ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.',
38701
38734
  format: 'uuid',
38702
38735
  type: 'string',
38703
38736
  },
@@ -38718,8 +38751,9 @@ const openapi = {
38718
38751
  type: 'array',
38719
38752
  },
38720
38753
  ok: { type: 'boolean' },
38754
+ pagination: { $ref: '#/components/schemas/pagination' },
38721
38755
  },
38722
- required: ['access_methods', 'ok'],
38756
+ required: ['access_methods', 'pagination', 'ok'],
38723
38757
  type: 'object',
38724
38758
  },
38725
38759
  },