@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.
@@ -71475,6 +71475,11 @@ declare const _default: {
71475
71475
  nullable: boolean;
71476
71476
  type: string;
71477
71477
  };
71478
+ search: {
71479
+ description: string;
71480
+ minLength: number;
71481
+ type: string;
71482
+ };
71478
71483
  };
71479
71484
  type: string;
71480
71485
  oneOf?: never;
@@ -72534,6 +72539,9 @@ declare const _default: {
72534
72539
  ok: {
72535
72540
  type: string;
72536
72541
  };
72542
+ pagination: {
72543
+ $ref: string;
72544
+ };
72537
72545
  };
72538
72546
  required: string[];
72539
72547
  type: string;
@@ -72577,66 +72585,68 @@ declare const _default: {
72577
72585
  content: {
72578
72586
  'application/json': {
72579
72587
  schema: {
72580
- oneOf: ({
72581
- properties: {
72582
- acs_system_id: {
72583
- description: string;
72584
- format: string;
72585
- type: string;
72586
- };
72587
- limit: {
72588
- default: number;
72589
- description: string;
72590
- format: string;
72591
- type: string;
72592
- };
72593
- acs_system_ids?: never;
72594
- acs_encoder_ids?: never;
72595
- };
72596
- required: string[];
72597
- type: string;
72598
- } | {
72599
- properties: {
72600
- acs_system_ids: {
72601
- description: string;
72602
- items: {
72588
+ allOf: ({
72589
+ oneOf: ({
72590
+ properties: {
72591
+ acs_system_id: {
72592
+ description: string;
72603
72593
  format: string;
72604
72594
  type: string;
72605
72595
  };
72606
- type: string;
72596
+ acs_system_ids?: never;
72597
+ acs_encoder_ids?: never;
72607
72598
  };
72608
- limit: {
72609
- default: number;
72610
- description: string;
72611
- format: string;
72612
- type: string;
72599
+ required: string[];
72600
+ type: string;
72601
+ } | {
72602
+ properties: {
72603
+ acs_system_ids: {
72604
+ description: string;
72605
+ items: {
72606
+ format: string;
72607
+ type: string;
72608
+ };
72609
+ type: string;
72610
+ };
72611
+ acs_system_id?: never;
72612
+ acs_encoder_ids?: never;
72613
72613
  };
72614
- acs_system_id?: never;
72615
- acs_encoder_ids?: never;
72616
- };
72617
- required: string[];
72618
- type: string;
72619
- } | {
72620
- properties: {
72621
- acs_encoder_ids: {
72622
- description: string;
72623
- items: {
72624
- format: string;
72614
+ required: string[];
72615
+ type: string;
72616
+ } | {
72617
+ properties: {
72618
+ acs_encoder_ids: {
72619
+ description: string;
72620
+ items: {
72621
+ format: string;
72622
+ type: string;
72623
+ };
72625
72624
  type: string;
72626
72625
  };
72627
- type: string;
72626
+ acs_system_id?: never;
72627
+ acs_system_ids?: never;
72628
72628
  };
72629
+ required: string[];
72630
+ type: string;
72631
+ })[];
72632
+ properties?: never;
72633
+ type?: never;
72634
+ } | {
72635
+ properties: {
72629
72636
  limit: {
72630
72637
  default: number;
72631
72638
  description: string;
72632
72639
  format: string;
72633
72640
  type: string;
72634
72641
  };
72635
- acs_system_id?: never;
72636
- acs_system_ids?: never;
72642
+ page_cursor: {
72643
+ description: string;
72644
+ nullable: boolean;
72645
+ type: string;
72646
+ };
72637
72647
  };
72638
- required: string[];
72639
72648
  type: string;
72649
+ oneOf?: never;
72640
72650
  })[];
72641
72651
  };
72642
72652
  };
@@ -72657,6 +72667,9 @@ declare const _default: {
72657
72667
  ok: {
72658
72668
  type: string;
72659
72669
  };
72670
+ pagination: {
72671
+ $ref: string;
72672
+ };
72660
72673
  };
72661
72674
  required: string[];
72662
72675
  type: string;
@@ -122410,6 +122423,8 @@ type Routes = {
122410
122423
  created_before?: Date | undefined;
122411
122424
  /** Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. */
122412
122425
  is_multi_phone_sync_credential?: boolean | undefined;
122426
+ /** 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`. */
122427
+ search?: string | undefined;
122413
122428
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
122414
122429
  page_cursor?: (string | undefined) | null;
122415
122430
  };
@@ -124601,21 +124616,20 @@ type Routes = {
124601
124616
  method: 'GET' | 'POST';
124602
124617
  queryParams: {};
124603
124618
  jsonBody: {};
124604
- commonParams: {
124619
+ commonParams: ({
124605
124620
  /** ID of the access system for which you want to retrieve all encoders. */
124606
124621
  acs_system_id: string;
124607
- /** Number of encoders to return. */
124608
- limit?: number;
124609
124622
  } | {
124610
124623
  /** IDs of the access systems for which you want to retrieve all encoders. */
124611
124624
  acs_system_ids: string[];
124612
- /** Number of encoders to return. */
124613
- limit?: number;
124614
124625
  } | {
124615
124626
  /** IDs of the encoders that you want to retrieve. */
124616
124627
  acs_encoder_ids: string[];
124628
+ }) & {
124617
124629
  /** Number of encoders to return. */
124618
124630
  limit?: number;
124631
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
124632
+ page_cursor?: (string | undefined) | null;
124619
124633
  };
124620
124634
  formData: {};
124621
124635
  jsonResponse: {
@@ -124642,6 +124656,15 @@ type Routes = {
124642
124656
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
124643
124657
  display_name: string;
124644
124658
  }[];
124659
+ /** Information about the current page of results. */
124660
+ pagination: {
124661
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
124662
+ next_page_cursor: string | null;
124663
+ /** Indicates whether there is another page of results after this one. */
124664
+ has_next_page: boolean;
124665
+ /** URL to get the next page of results. */
124666
+ next_page_url: string | null;
124667
+ };
124645
124668
  };
124646
124669
  };
124647
124670
  '/acs/encoders/scan_credential': {
package/dist/index.cjs CHANGED
@@ -34201,6 +34201,11 @@ var openapi_default = {
34201
34201
  description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
34202
34202
  nullable: true,
34203
34203
  type: "string"
34204
+ },
34205
+ search: {
34206
+ description: "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`.",
34207
+ minLength: 1,
34208
+ type: "string"
34204
34209
  }
34205
34210
  },
34206
34211
  type: "object"
@@ -35045,9 +35050,10 @@ var openapi_default = {
35045
35050
  items: { $ref: "#/components/schemas/acs_encoder" },
35046
35051
  type: "array"
35047
35052
  },
35048
- ok: { type: "boolean" }
35053
+ ok: { type: "boolean" },
35054
+ pagination: { $ref: "#/components/schemas/pagination" }
35049
35055
  },
35050
- required: ["acs_encoders", "ok"],
35056
+ required: ["acs_encoders", "pagination", "ok"],
35051
35057
  type: "object"
35052
35058
  }
35053
35059
  }
@@ -35077,56 +35083,58 @@ var openapi_default = {
35077
35083
  content: {
35078
35084
  "application/json": {
35079
35085
  schema: {
35080
- oneOf: [
35086
+ allOf: [
35081
35087
  {
35082
- properties: {
35083
- acs_system_id: {
35084
- description: "ID of the access system for which you want to retrieve all encoders.",
35085
- format: "uuid",
35086
- type: "string"
35088
+ oneOf: [
35089
+ {
35090
+ properties: {
35091
+ acs_system_id: {
35092
+ description: "ID of the access system for which you want to retrieve all encoders.",
35093
+ format: "uuid",
35094
+ type: "string"
35095
+ }
35096
+ },
35097
+ required: ["acs_system_id"],
35098
+ type: "object"
35087
35099
  },
35088
- limit: {
35089
- default: 500,
35090
- description: "Number of encoders to return.",
35091
- format: "float",
35092
- type: "number"
35093
- }
35094
- },
35095
- required: ["acs_system_id"],
35096
- type: "object"
35097
- },
35098
- {
35099
- properties: {
35100
- acs_system_ids: {
35101
- description: "IDs of the access systems for which you want to retrieve all encoders.",
35102
- items: { format: "uuid", type: "string" },
35103
- type: "array"
35100
+ {
35101
+ properties: {
35102
+ acs_system_ids: {
35103
+ description: "IDs of the access systems for which you want to retrieve all encoders.",
35104
+ items: { format: "uuid", type: "string" },
35105
+ type: "array"
35106
+ }
35107
+ },
35108
+ required: ["acs_system_ids"],
35109
+ type: "object"
35104
35110
  },
35105
- limit: {
35106
- default: 500,
35107
- description: "Number of encoders to return.",
35108
- format: "float",
35109
- type: "number"
35111
+ {
35112
+ properties: {
35113
+ acs_encoder_ids: {
35114
+ description: "IDs of the encoders that you want to retrieve.",
35115
+ items: { format: "uuid", type: "string" },
35116
+ type: "array"
35117
+ }
35118
+ },
35119
+ required: ["acs_encoder_ids"],
35120
+ type: "object"
35110
35121
  }
35111
- },
35112
- required: ["acs_system_ids"],
35113
- type: "object"
35122
+ ]
35114
35123
  },
35115
35124
  {
35116
35125
  properties: {
35117
- acs_encoder_ids: {
35118
- description: "IDs of the encoders that you want to retrieve.",
35119
- items: { format: "uuid", type: "string" },
35120
- type: "array"
35121
- },
35122
35126
  limit: {
35123
35127
  default: 500,
35124
35128
  description: "Number of encoders to return.",
35125
35129
  format: "float",
35126
35130
  type: "number"
35131
+ },
35132
+ page_cursor: {
35133
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
35134
+ nullable: true,
35135
+ type: "string"
35127
35136
  }
35128
35137
  },
35129
- required: ["acs_encoder_ids"],
35130
35138
  type: "object"
35131
35139
  }
35132
35140
  ]
@@ -35144,9 +35152,10 @@ var openapi_default = {
35144
35152
  items: { $ref: "#/components/schemas/acs_encoder" },
35145
35153
  type: "array"
35146
35154
  },
35147
- ok: { type: "boolean" }
35155
+ ok: { type: "boolean" },
35156
+ pagination: { $ref: "#/components/schemas/pagination" }
35148
35157
  },
35149
- required: ["acs_encoders", "ok"],
35158
+ required: ["acs_encoders", "pagination", "ok"],
35150
35159
  type: "object"
35151
35160
  }
35152
35161
  }