@seamapi/types 1.602.0 → 1.603.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.
@@ -77692,6 +77692,12 @@ export type Routes = {
77692
77692
  search?: string | undefined;
77693
77693
  /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
77694
77694
  credential_manager_acs_system_id?: string | undefined;
77695
+ /** Maximum number of records to return per page. */
77696
+ limit?: number;
77697
+ /** Timestamp by which to limit returned user identities. Returns user identities created before this timestamp. */
77698
+ created_before?: Date | undefined;
77699
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
77700
+ page_cursor?: (string | undefined) | null;
77695
77701
  };
77696
77702
  formData: {};
77697
77703
  jsonResponse: {
@@ -77742,6 +77748,15 @@ export type Routes = {
77742
77748
  /** Array of access system user IDs associated with the user identity. */
77743
77749
  acs_user_ids: string[];
77744
77750
  }[];
77751
+ /** Information about the current page of results. */
77752
+ pagination: {
77753
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
77754
+ next_page_cursor: string | null;
77755
+ /** Indicates whether there is another page of results after this one. */
77756
+ has_next_page: boolean;
77757
+ /** URL to get the next page of results. */
77758
+ next_page_url: string | null;
77759
+ };
77745
77760
  };
77746
77761
  };
77747
77762
  '/user_identities/list_accessible_devices': {
@@ -80632,6 +80647,12 @@ export type Routes = {
80632
80647
  commonParams: {
80633
80648
  /** String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
80634
80649
  search?: string | undefined;
80650
+ /** Maximum number of records to return per page. */
80651
+ limit?: number;
80652
+ /** Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp. */
80653
+ created_before?: Date | undefined;
80654
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
80655
+ page_cursor?: (string | undefined) | null;
80635
80656
  };
80636
80657
  formData: {};
80637
80658
  jsonResponse: {
@@ -80680,6 +80701,15 @@ export type Routes = {
80680
80701
  /** Array of access system user IDs associated with the user identity. */
80681
80702
  acs_user_ids: string[];
80682
80703
  }[];
80704
+ /** Information about the current page of results. */
80705
+ pagination: {
80706
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
80707
+ next_page_cursor: string | null;
80708
+ /** Indicates whether there is another page of results after this one. */
80709
+ has_next_page: boolean;
80710
+ /** URL to get the next page of results. */
80711
+ next_page_url: string | null;
80712
+ };
80683
80713
  };
80684
80714
  };
80685
80715
  '/user_identities/unmanaged/update': {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.602.0",
3
+ "version": "1.603.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -60442,6 +60442,37 @@ export default {
60442
60442
  type: 'string',
60443
60443
  },
60444
60444
  },
60445
+ {
60446
+ in: 'query',
60447
+ name: 'limit',
60448
+ schema: {
60449
+ default: 500,
60450
+ description: 'Maximum number of records to return per page.',
60451
+ exclusiveMinimum: true,
60452
+ minimum: 0,
60453
+ type: 'integer',
60454
+ },
60455
+ },
60456
+ {
60457
+ in: 'query',
60458
+ name: 'created_before',
60459
+ schema: {
60460
+ description:
60461
+ 'Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.',
60462
+ format: 'date-time',
60463
+ type: 'string',
60464
+ },
60465
+ },
60466
+ {
60467
+ in: 'query',
60468
+ name: 'page_cursor',
60469
+ schema: {
60470
+ description:
60471
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
60472
+ nullable: true,
60473
+ type: 'string',
60474
+ },
60475
+ },
60445
60476
  ],
60446
60477
  responses: {
60447
60478
  200: {
@@ -60450,12 +60481,13 @@ export default {
60450
60481
  schema: {
60451
60482
  properties: {
60452
60483
  ok: { type: 'boolean' },
60484
+ pagination: { $ref: '#/components/schemas/pagination' },
60453
60485
  user_identities: {
60454
60486
  items: { $ref: '#/components/schemas/user_identity' },
60455
60487
  type: 'array',
60456
60488
  },
60457
60489
  },
60458
- required: ['user_identities', 'ok'],
60490
+ required: ['user_identities', 'pagination', 'ok'],
60459
60491
  type: 'object',
60460
60492
  },
60461
60493
  },
@@ -60488,12 +60520,32 @@ export default {
60488
60520
  'application/json': {
60489
60521
  schema: {
60490
60522
  properties: {
60523
+ created_before: {
60524
+ description:
60525
+ 'Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.',
60526
+ format: 'date-time',
60527
+ type: 'string',
60528
+ },
60491
60529
  credential_manager_acs_system_id: {
60492
60530
  description:
60493
60531
  '`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
60494
60532
  format: 'uuid',
60495
60533
  type: 'string',
60496
60534
  },
60535
+ limit: {
60536
+ default: 500,
60537
+ description:
60538
+ 'Maximum number of records to return per page.',
60539
+ exclusiveMinimum: true,
60540
+ minimum: 0,
60541
+ type: 'integer',
60542
+ },
60543
+ page_cursor: {
60544
+ description:
60545
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
60546
+ nullable: true,
60547
+ type: 'string',
60548
+ },
60497
60549
  search: {
60498
60550
  description:
60499
60551
  'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
@@ -60512,12 +60564,13 @@ export default {
60512
60564
  schema: {
60513
60565
  properties: {
60514
60566
  ok: { type: 'boolean' },
60567
+ pagination: { $ref: '#/components/schemas/pagination' },
60515
60568
  user_identities: {
60516
60569
  items: { $ref: '#/components/schemas/user_identity' },
60517
60570
  type: 'array',
60518
60571
  },
60519
60572
  },
60520
- required: ['user_identities', 'ok'],
60573
+ required: ['user_identities', 'pagination', 'ok'],
60521
60574
  type: 'object',
60522
60575
  },
60523
60576
  },
@@ -61615,6 +61668,37 @@ export default {
61615
61668
  type: 'string',
61616
61669
  },
61617
61670
  },
61671
+ {
61672
+ in: 'query',
61673
+ name: 'limit',
61674
+ schema: {
61675
+ default: 500,
61676
+ description: 'Maximum number of records to return per page.',
61677
+ exclusiveMinimum: true,
61678
+ minimum: 0,
61679
+ type: 'integer',
61680
+ },
61681
+ },
61682
+ {
61683
+ in: 'query',
61684
+ name: 'created_before',
61685
+ schema: {
61686
+ description:
61687
+ 'Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.',
61688
+ format: 'date-time',
61689
+ type: 'string',
61690
+ },
61691
+ },
61692
+ {
61693
+ in: 'query',
61694
+ name: 'page_cursor',
61695
+ schema: {
61696
+ description:
61697
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
61698
+ nullable: true,
61699
+ type: 'string',
61700
+ },
61701
+ },
61618
61702
  ],
61619
61703
  responses: {
61620
61704
  200: {
@@ -61623,6 +61707,7 @@ export default {
61623
61707
  schema: {
61624
61708
  properties: {
61625
61709
  ok: { type: 'boolean' },
61710
+ pagination: { $ref: '#/components/schemas/pagination' },
61626
61711
  user_identities: {
61627
61712
  items: {
61628
61713
  description:
@@ -61817,7 +61902,7 @@ export default {
61817
61902
  type: 'array',
61818
61903
  },
61819
61904
  },
61820
- required: ['user_identities', 'ok'],
61905
+ required: ['user_identities', 'pagination', 'ok'],
61821
61906
  type: 'object',
61822
61907
  },
61823
61908
  },
@@ -61850,6 +61935,26 @@ export default {
61850
61935
  'application/json': {
61851
61936
  schema: {
61852
61937
  properties: {
61938
+ created_before: {
61939
+ description:
61940
+ 'Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.',
61941
+ format: 'date-time',
61942
+ type: 'string',
61943
+ },
61944
+ limit: {
61945
+ default: 500,
61946
+ description:
61947
+ 'Maximum number of records to return per page.',
61948
+ exclusiveMinimum: true,
61949
+ minimum: 0,
61950
+ type: 'integer',
61951
+ },
61952
+ page_cursor: {
61953
+ description:
61954
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
61955
+ nullable: true,
61956
+ type: 'string',
61957
+ },
61853
61958
  search: {
61854
61959
  description:
61855
61960
  'String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
@@ -61868,6 +61973,7 @@ export default {
61868
61973
  schema: {
61869
61974
  properties: {
61870
61975
  ok: { type: 'boolean' },
61976
+ pagination: { $ref: '#/components/schemas/pagination' },
61871
61977
  user_identities: {
61872
61978
  items: {
61873
61979
  description:
@@ -62062,7 +62168,7 @@ export default {
62062
62168
  type: 'array',
62063
62169
  },
62064
62170
  },
62065
- required: ['user_identities', 'ok'],
62171
+ required: ['user_identities', 'pagination', 'ok'],
62066
62172
  type: 'object',
62067
62173
  },
62068
62174
  },
@@ -92338,6 +92338,12 @@ export type Routes = {
92338
92338
  search?: string | undefined
92339
92339
  /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
92340
92340
  credential_manager_acs_system_id?: string | undefined
92341
+ /** Maximum number of records to return per page. */
92342
+ limit?: number
92343
+ /** Timestamp by which to limit returned user identities. Returns user identities created before this timestamp. */
92344
+ created_before?: Date | undefined
92345
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
92346
+ page_cursor?: (string | undefined) | null
92341
92347
  }
92342
92348
  formData: {}
92343
92349
  jsonResponse: {
@@ -92391,6 +92397,15 @@ export type Routes = {
92391
92397
  /** Array of access system user IDs associated with the user identity. */
92392
92398
  acs_user_ids: string[]
92393
92399
  }[]
92400
+ /** Information about the current page of results. */
92401
+ pagination: {
92402
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
92403
+ next_page_cursor: string | null
92404
+ /** Indicates whether there is another page of results after this one. */
92405
+ has_next_page: boolean
92406
+ /** URL to get the next page of results. */
92407
+ next_page_url: string | null
92408
+ }
92394
92409
  }
92395
92410
  }
92396
92411
  '/user_identities/list_accessible_devices': {
@@ -95986,6 +96001,12 @@ export type Routes = {
95986
96001
  commonParams: {
95987
96002
  /** String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
95988
96003
  search?: string | undefined
96004
+ /** Maximum number of records to return per page. */
96005
+ limit?: number
96006
+ /** Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp. */
96007
+ created_before?: Date | undefined
96008
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
96009
+ page_cursor?: (string | undefined) | null
95989
96010
  }
95990
96011
  formData: {}
95991
96012
  jsonResponse: {
@@ -96037,6 +96058,15 @@ export type Routes = {
96037
96058
  /** Array of access system user IDs associated with the user identity. */
96038
96059
  acs_user_ids: string[]
96039
96060
  }[]
96061
+ /** Information about the current page of results. */
96062
+ pagination: {
96063
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
96064
+ next_page_cursor: string | null
96065
+ /** Indicates whether there is another page of results after this one. */
96066
+ has_next_page: boolean
96067
+ /** URL to get the next page of results. */
96068
+ next_page_url: string | null
96069
+ }
96040
96070
  }
96041
96071
  }
96042
96072
  '/user_identities/unmanaged/update': {