@seamapi/types 1.519.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.
@@ -72534,6 +72534,9 @@ declare const _default: {
72534
72534
  ok: {
72535
72535
  type: string;
72536
72536
  };
72537
+ pagination: {
72538
+ $ref: string;
72539
+ };
72537
72540
  };
72538
72541
  required: string[];
72539
72542
  type: string;
@@ -72577,66 +72580,68 @@ declare const _default: {
72577
72580
  content: {
72578
72581
  'application/json': {
72579
72582
  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: {
72583
+ allOf: ({
72584
+ oneOf: ({
72585
+ properties: {
72586
+ acs_system_id: {
72587
+ description: string;
72603
72588
  format: string;
72604
72589
  type: string;
72605
72590
  };
72606
- type: string;
72591
+ acs_system_ids?: never;
72592
+ acs_encoder_ids?: never;
72607
72593
  };
72608
- limit: {
72609
- default: number;
72610
- description: string;
72611
- format: string;
72612
- type: string;
72594
+ required: string[];
72595
+ type: string;
72596
+ } | {
72597
+ properties: {
72598
+ acs_system_ids: {
72599
+ description: string;
72600
+ items: {
72601
+ format: string;
72602
+ type: string;
72603
+ };
72604
+ type: string;
72605
+ };
72606
+ acs_system_id?: never;
72607
+ acs_encoder_ids?: never;
72613
72608
  };
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;
72609
+ required: string[];
72610
+ type: string;
72611
+ } | {
72612
+ properties: {
72613
+ acs_encoder_ids: {
72614
+ description: string;
72615
+ items: {
72616
+ format: string;
72617
+ type: string;
72618
+ };
72625
72619
  type: string;
72626
72620
  };
72627
- type: string;
72621
+ acs_system_id?: never;
72622
+ acs_system_ids?: never;
72628
72623
  };
72624
+ required: string[];
72625
+ type: string;
72626
+ })[];
72627
+ properties?: never;
72628
+ type?: never;
72629
+ } | {
72630
+ properties: {
72629
72631
  limit: {
72630
72632
  default: number;
72631
72633
  description: string;
72632
72634
  format: string;
72633
72635
  type: string;
72634
72636
  };
72635
- acs_system_id?: never;
72636
- acs_system_ids?: never;
72637
+ page_cursor: {
72638
+ description: string;
72639
+ nullable: boolean;
72640
+ type: string;
72641
+ };
72637
72642
  };
72638
- required: string[];
72639
72643
  type: string;
72644
+ oneOf?: never;
72640
72645
  })[];
72641
72646
  };
72642
72647
  };
@@ -72657,6 +72662,9 @@ declare const _default: {
72657
72662
  ok: {
72658
72663
  type: string;
72659
72664
  };
72665
+ pagination: {
72666
+ $ref: string;
72667
+ };
72660
72668
  };
72661
72669
  required: string[];
72662
72670
  type: string;
@@ -79429,6 +79437,10 @@ declare const _default: {
79429
79437
  description: string;
79430
79438
  type: string;
79431
79439
  };
79440
+ preferred_code: {
79441
+ description: string;
79442
+ type: string;
79443
+ };
79432
79444
  property_keys: {
79433
79445
  description: string;
79434
79446
  items: {
@@ -79531,6 +79543,10 @@ declare const _default: {
79531
79543
  description: string;
79532
79544
  type: string;
79533
79545
  };
79546
+ preferred_code: {
79547
+ description: string;
79548
+ type: string;
79549
+ };
79534
79550
  property_keys: {
79535
79551
  description: string;
79536
79552
  items: {
@@ -79767,6 +79783,10 @@ declare const _default: {
79767
79783
  description: string;
79768
79784
  type: string;
79769
79785
  };
79786
+ preferred_code: {
79787
+ description: string;
79788
+ type: string;
79789
+ };
79770
79790
  property_keys: {
79771
79791
  description: string;
79772
79792
  items: {
@@ -80341,6 +80361,10 @@ declare const _default: {
80341
80361
  description: string;
80342
80362
  type: string;
80343
80363
  };
80364
+ preferred_code: {
80365
+ description: string;
80366
+ type: string;
80367
+ };
80344
80368
  property_keys: {
80345
80369
  description: string;
80346
80370
  items: {
@@ -80443,6 +80467,10 @@ declare const _default: {
80443
80467
  description: string;
80444
80468
  type: string;
80445
80469
  };
80470
+ preferred_code: {
80471
+ description: string;
80472
+ type: string;
80473
+ };
80446
80474
  property_keys: {
80447
80475
  description: string;
80448
80476
  items: {
@@ -80679,6 +80707,10 @@ declare const _default: {
80679
80707
  description: string;
80680
80708
  type: string;
80681
80709
  };
80710
+ preferred_code: {
80711
+ description: string;
80712
+ type: string;
80713
+ };
80682
80714
  property_keys: {
80683
80715
  description: string;
80684
80716
  items: {
@@ -124577,21 +124609,20 @@ type Routes = {
124577
124609
  method: 'GET' | 'POST';
124578
124610
  queryParams: {};
124579
124611
  jsonBody: {};
124580
- commonParams: {
124612
+ commonParams: ({
124581
124613
  /** ID of the access system for which you want to retrieve all encoders. */
124582
124614
  acs_system_id: string;
124583
- /** Number of encoders to return. */
124584
- limit?: number;
124585
124615
  } | {
124586
124616
  /** IDs of the access systems for which you want to retrieve all encoders. */
124587
124617
  acs_system_ids: string[];
124588
- /** Number of encoders to return. */
124589
- limit?: number;
124590
124618
  } | {
124591
124619
  /** IDs of the encoders that you want to retrieve. */
124592
124620
  acs_encoder_ids: string[];
124621
+ }) & {
124593
124622
  /** Number of encoders to return. */
124594
124623
  limit?: number;
124624
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
124625
+ page_cursor?: (string | undefined) | null;
124595
124626
  };
124596
124627
  formData: {};
124597
124628
  jsonResponse: {
@@ -124618,6 +124649,15 @@ type Routes = {
124618
124649
  /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
124619
124650
  display_name: string;
124620
124651
  }[];
124652
+ /** Information about the current page of results. */
124653
+ pagination: {
124654
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
124655
+ next_page_cursor: string | null;
124656
+ /** Indicates whether there is another page of results after this one. */
124657
+ has_next_page: boolean;
124658
+ /** URL to get the next page of results. */
124659
+ next_page_url: string | null;
124660
+ };
124621
124661
  };
124622
124662
  };
124623
124663
  '/acs/encoders/scan_credential': {
@@ -131983,6 +132023,8 @@ type Routes = {
131983
132023
  starts_at?: string | undefined;
131984
132024
  /** Ending date and time for the access grant. */
131985
132025
  ends_at?: string | undefined;
132026
+ /** Preferred PIN code to use when creating access for this reservation. */
132027
+ preferred_code?: string | undefined;
131986
132028
  /** Your unique identifier for the reservation. */
131987
132029
  reservation_key: string;
131988
132030
  /** Guest key associated with the access grant. */
@@ -132020,6 +132062,8 @@ type Routes = {
132020
132062
  starts_at?: string | undefined;
132021
132063
  /** Ending date and time for the access grant. */
132022
132064
  ends_at?: string | undefined;
132065
+ /** Preferred PIN code to use when creating access for this reservation. */
132066
+ preferred_code?: string | undefined;
132023
132067
  /** Your unique identifier for the booking. */
132024
132068
  booking_key: string;
132025
132069
  /** Guest key associated with the access grant. */
@@ -132057,6 +132101,8 @@ type Routes = {
132057
132101
  starts_at?: string | undefined;
132058
132102
  /** Ending date and time for the access grant. */
132059
132103
  ends_at?: string | undefined;
132104
+ /** Preferred PIN code to use when creating access for this reservation. */
132105
+ preferred_code?: string | undefined;
132060
132106
  /** Your unique identifier for the access grant. */
132061
132107
  access_grant_key: string;
132062
132108
  /** Guest key associated with the access grant. */
@@ -132287,6 +132333,8 @@ type Routes = {
132287
132333
  starts_at?: string | undefined;
132288
132334
  /** Ending date and time for the access grant. */
132289
132335
  ends_at?: string | undefined;
132336
+ /** Preferred PIN code to use when creating access for this reservation. */
132337
+ preferred_code?: string | undefined;
132290
132338
  /** Your unique identifier for the reservation. */
132291
132339
  reservation_key: string;
132292
132340
  /** Guest key associated with the access grant. */
@@ -132324,6 +132372,8 @@ type Routes = {
132324
132372
  starts_at?: string | undefined;
132325
132373
  /** Ending date and time for the access grant. */
132326
132374
  ends_at?: string | undefined;
132375
+ /** Preferred PIN code to use when creating access for this reservation. */
132376
+ preferred_code?: string | undefined;
132327
132377
  /** Your unique identifier for the booking. */
132328
132378
  booking_key: string;
132329
132379
  /** Guest key associated with the access grant. */
@@ -132361,6 +132411,8 @@ type Routes = {
132361
132411
  starts_at?: string | undefined;
132362
132412
  /** Ending date and time for the access grant. */
132363
132413
  ends_at?: string | undefined;
132414
+ /** Preferred PIN code to use when creating access for this reservation. */
132415
+ preferred_code?: string | undefined;
132364
132416
  /** Your unique identifier for the access grant. */
132365
132417
  access_grant_key: string;
132366
132418
  /** Guest key associated with the access grant. */
package/dist/index.cjs CHANGED
@@ -35045,9 +35045,10 @@ var openapi_default = {
35045
35045
  items: { $ref: "#/components/schemas/acs_encoder" },
35046
35046
  type: "array"
35047
35047
  },
35048
- ok: { type: "boolean" }
35048
+ ok: { type: "boolean" },
35049
+ pagination: { $ref: "#/components/schemas/pagination" }
35049
35050
  },
35050
- required: ["acs_encoders", "ok"],
35051
+ required: ["acs_encoders", "pagination", "ok"],
35051
35052
  type: "object"
35052
35053
  }
35053
35054
  }
@@ -35077,56 +35078,58 @@ var openapi_default = {
35077
35078
  content: {
35078
35079
  "application/json": {
35079
35080
  schema: {
35080
- oneOf: [
35081
+ allOf: [
35081
35082
  {
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"
35083
+ oneOf: [
35084
+ {
35085
+ properties: {
35086
+ acs_system_id: {
35087
+ description: "ID of the access system for which you want to retrieve all encoders.",
35088
+ format: "uuid",
35089
+ type: "string"
35090
+ }
35091
+ },
35092
+ required: ["acs_system_id"],
35093
+ type: "object"
35087
35094
  },
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"
35095
+ {
35096
+ properties: {
35097
+ acs_system_ids: {
35098
+ description: "IDs of the access systems for which you want to retrieve all encoders.",
35099
+ items: { format: "uuid", type: "string" },
35100
+ type: "array"
35101
+ }
35102
+ },
35103
+ required: ["acs_system_ids"],
35104
+ type: "object"
35104
35105
  },
35105
- limit: {
35106
- default: 500,
35107
- description: "Number of encoders to return.",
35108
- format: "float",
35109
- type: "number"
35106
+ {
35107
+ properties: {
35108
+ acs_encoder_ids: {
35109
+ description: "IDs of the encoders that you want to retrieve.",
35110
+ items: { format: "uuid", type: "string" },
35111
+ type: "array"
35112
+ }
35113
+ },
35114
+ required: ["acs_encoder_ids"],
35115
+ type: "object"
35110
35116
  }
35111
- },
35112
- required: ["acs_system_ids"],
35113
- type: "object"
35117
+ ]
35114
35118
  },
35115
35119
  {
35116
35120
  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
35121
  limit: {
35123
35122
  default: 500,
35124
35123
  description: "Number of encoders to return.",
35125
35124
  format: "float",
35126
35125
  type: "number"
35126
+ },
35127
+ page_cursor: {
35128
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
35129
+ nullable: true,
35130
+ type: "string"
35127
35131
  }
35128
35132
  },
35129
- required: ["acs_encoder_ids"],
35130
35133
  type: "object"
35131
35134
  }
35132
35135
  ]
@@ -35144,9 +35147,10 @@ var openapi_default = {
35144
35147
  items: { $ref: "#/components/schemas/acs_encoder" },
35145
35148
  type: "array"
35146
35149
  },
35147
- ok: { type: "boolean" }
35150
+ ok: { type: "boolean" },
35151
+ pagination: { $ref: "#/components/schemas/pagination" }
35148
35152
  },
35149
- required: ["acs_encoders", "ok"],
35153
+ required: ["acs_encoders", "pagination", "ok"],
35150
35154
  type: "object"
35151
35155
  }
35152
35156
  }
@@ -40570,6 +40574,10 @@ var openapi_default = {
40570
40574
  description: "Your name for this access grant resource.",
40571
40575
  type: "string"
40572
40576
  },
40577
+ preferred_code: {
40578
+ description: "Preferred PIN code to use when creating access for this reservation.",
40579
+ type: "string"
40580
+ },
40573
40581
  property_keys: {
40574
40582
  description: "Property keys associated with the access grant.",
40575
40583
  items: { type: "string" },
@@ -40656,6 +40664,10 @@ var openapi_default = {
40656
40664
  description: "Your name for this access grant resource.",
40657
40665
  type: "string"
40658
40666
  },
40667
+ preferred_code: {
40668
+ description: "Preferred PIN code to use when creating access for this reservation.",
40669
+ type: "string"
40670
+ },
40659
40671
  property_keys: {
40660
40672
  description: "Property keys associated with the access grant.",
40661
40673
  items: { type: "string" },
@@ -40876,6 +40888,10 @@ var openapi_default = {
40876
40888
  description: "Your name for this access grant resource.",
40877
40889
  type: "string"
40878
40890
  },
40891
+ preferred_code: {
40892
+ description: "Preferred PIN code to use when creating access for this reservation.",
40893
+ type: "string"
40894
+ },
40879
40895
  property_keys: {
40880
40896
  description: "Property keys associated with the access grant.",
40881
40897
  items: { type: "string" },
@@ -41493,6 +41509,10 @@ var openapi_default = {
41493
41509
  description: "Your name for this access grant resource.",
41494
41510
  type: "string"
41495
41511
  },
41512
+ preferred_code: {
41513
+ description: "Preferred PIN code to use when creating access for this reservation.",
41514
+ type: "string"
41515
+ },
41496
41516
  property_keys: {
41497
41517
  description: "Property keys associated with the access grant.",
41498
41518
  items: { type: "string" },
@@ -41579,6 +41599,10 @@ var openapi_default = {
41579
41599
  description: "Your name for this access grant resource.",
41580
41600
  type: "string"
41581
41601
  },
41602
+ preferred_code: {
41603
+ description: "Preferred PIN code to use when creating access for this reservation.",
41604
+ type: "string"
41605
+ },
41582
41606
  property_keys: {
41583
41607
  description: "Property keys associated with the access grant.",
41584
41608
  items: { type: "string" },
@@ -41799,6 +41823,10 @@ var openapi_default = {
41799
41823
  description: "Your name for this access grant resource.",
41800
41824
  type: "string"
41801
41825
  },
41826
+ preferred_code: {
41827
+ description: "Preferred PIN code to use when creating access for this reservation.",
41828
+ type: "string"
41829
+ },
41802
41830
  property_keys: {
41803
41831
  description: "Property keys associated with the access grant.",
41804
41832
  items: { type: "string" },