@seamapi/types 1.560.0 → 1.562.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.
package/dist/index.cjs CHANGED
@@ -1972,6 +1972,11 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
1972
1972
  }).describe(
1973
1973
  "Unable to confirm the deletion of the access code on Kwikset device."
1974
1974
  );
1975
+ var kwikset_insufficient_permissions = common_access_code_error.extend({
1976
+ error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
1977
+ }).describe(
1978
+ "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN."
1979
+ );
1975
1980
  var igloohome_offline_access_code_no_variance_available = common_access_code_error.extend({
1976
1981
  error_code: zod.z.literal("igloohome_offline_access_code_no_variance_available").describe(error_code_description3)
1977
1982
  }).describe("Lock has reached maximum amount of codes.");
@@ -2036,7 +2041,8 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
2036
2041
  hubitat_no_free_positions_available,
2037
2042
  wyze_duplicate_code_name,
2038
2043
  wyze_potential_duplicate_code,
2039
- dormakaba_oracode_no_valid_user_level
2044
+ dormakaba_oracode_no_valid_user_level,
2045
+ kwikset_insufficient_permissions
2040
2046
  ]).describe(
2041
2047
  "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2042
2048
  );
@@ -2054,6 +2060,7 @@ zod.z.object({
2054
2060
  igloohome_offline_access_code_no_variance_available: igloohome_offline_access_code_no_variance_available.optional().nullable(),
2055
2061
  kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code.optional().nullable(),
2056
2062
  kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion.optional().nullable(),
2063
+ kwikset_insufficient_permissions: kwikset_insufficient_permissions.optional().nullable(),
2057
2064
  code_modified_external_to_seam_error: code_modified_external_to_seam_error.optional().nullable(),
2058
2065
  august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
2059
2066
  august_device_programming_delay: august_device_programming_delay_error.optional().nullable(),
@@ -6359,6 +6366,32 @@ var openapi_default = {
6359
6366
  required: ["message", "is_access_code_error", "error_code"],
6360
6367
  type: "object"
6361
6368
  },
6369
+ {
6370
+ description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
6371
+ properties: {
6372
+ created_at: {
6373
+ description: "Date and time at which Seam created the error.",
6374
+ format: "date-time",
6375
+ type: "string"
6376
+ },
6377
+ error_code: {
6378
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
6379
+ enum: ["kwikset_insufficient_permissions"],
6380
+ type: "string"
6381
+ },
6382
+ is_access_code_error: {
6383
+ description: "Indicates that this is an access code error.",
6384
+ enum: [true],
6385
+ type: "boolean"
6386
+ },
6387
+ message: {
6388
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
6389
+ type: "string"
6390
+ }
6391
+ },
6392
+ required: ["message", "is_access_code_error", "error_code"],
6393
+ type: "object"
6394
+ },
6362
6395
  {
6363
6396
  description: "Indicates that the account is disconnected.",
6364
6397
  properties: {
@@ -25116,6 +25149,32 @@ var openapi_default = {
25116
25149
  required: ["message", "is_access_code_error", "error_code"],
25117
25150
  type: "object"
25118
25151
  },
25152
+ {
25153
+ description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
25154
+ properties: {
25155
+ created_at: {
25156
+ description: "Date and time at which Seam created the error.",
25157
+ format: "date-time",
25158
+ type: "string"
25159
+ },
25160
+ error_code: {
25161
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
25162
+ enum: ["kwikset_insufficient_permissions"],
25163
+ type: "string"
25164
+ },
25165
+ is_access_code_error: {
25166
+ description: "Indicates that this is an access code error.",
25167
+ enum: [true],
25168
+ type: "boolean"
25169
+ },
25170
+ message: {
25171
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
25172
+ type: "string"
25173
+ }
25174
+ },
25175
+ required: ["message", "is_access_code_error", "error_code"],
25176
+ type: "object"
25177
+ },
25119
25178
  {
25120
25179
  description: "Indicates that the account is disconnected.",
25121
25180
  properties: {
@@ -51577,6 +51636,177 @@ var openapi_default = {
51577
51636
  "x-undocumented": "Internal endpoint for customer portals."
51578
51637
  }
51579
51638
  },
51639
+ "/seam/customer/v1/reservations/get": {
51640
+ get: {
51641
+ description: "Returns a single reservation for a specific customer by reservation ID.",
51642
+ operationId: "seamCustomerV1ReservationsGetGet",
51643
+ parameters: [
51644
+ {
51645
+ in: "query",
51646
+ name: "reservation_id",
51647
+ schema: {
51648
+ description: "ID of the reservation to retrieve.",
51649
+ format: "uuid",
51650
+ type: "string"
51651
+ }
51652
+ },
51653
+ {
51654
+ in: "query",
51655
+ name: "reservation_key",
51656
+ schema: {
51657
+ description: "Key of the reservation to retrieve.",
51658
+ type: "string"
51659
+ }
51660
+ }
51661
+ ],
51662
+ responses: {
51663
+ 200: {
51664
+ content: {
51665
+ "application/json": {
51666
+ schema: {
51667
+ properties: {
51668
+ ok: { type: "boolean" },
51669
+ reservation: {
51670
+ properties: {
51671
+ access_methods: {
51672
+ items: { $ref: "#/components/schemas/access_method" },
51673
+ type: "array"
51674
+ },
51675
+ created_at: { format: "date-time", type: "string" },
51676
+ ends_at: {
51677
+ format: "date-time",
51678
+ nullable: true,
51679
+ type: "string"
51680
+ },
51681
+ guest_name: { nullable: true, type: "string" },
51682
+ name: { nullable: true, type: "string" },
51683
+ reservation_id: { format: "uuid", type: "string" },
51684
+ reservation_key: { type: "string" },
51685
+ starts_at: {
51686
+ format: "date-time",
51687
+ nullable: true,
51688
+ type: "string"
51689
+ }
51690
+ },
51691
+ required: [
51692
+ "reservation_id",
51693
+ "reservation_key",
51694
+ "name",
51695
+ "starts_at",
51696
+ "ends_at",
51697
+ "created_at",
51698
+ "guest_name",
51699
+ "access_methods"
51700
+ ],
51701
+ type: "object"
51702
+ }
51703
+ },
51704
+ required: ["reservation", "ok"],
51705
+ type: "object"
51706
+ }
51707
+ }
51708
+ },
51709
+ description: "OK"
51710
+ },
51711
+ 400: { description: "Bad Request" },
51712
+ 401: { description: "Unauthorized" }
51713
+ },
51714
+ security: [{ client_session_with_customer: [] }],
51715
+ summary: "/seam/customer/v1/reservations/get",
51716
+ tags: [],
51717
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51718
+ "x-fern-sdk-method-name": "get",
51719
+ "x-fern-sdk-return-value": "reservation",
51720
+ "x-response-key": "reservation",
51721
+ "x-title": "Get Reservation for Customer",
51722
+ "x-undocumented": "Internal endpoint for customer portals."
51723
+ },
51724
+ post: {
51725
+ description: "Returns a single reservation for a specific customer by reservation ID.",
51726
+ operationId: "seamCustomerV1ReservationsGetPost",
51727
+ requestBody: {
51728
+ content: {
51729
+ "application/json": {
51730
+ schema: {
51731
+ properties: {
51732
+ reservation_id: {
51733
+ description: "ID of the reservation to retrieve.",
51734
+ format: "uuid",
51735
+ type: "string"
51736
+ },
51737
+ reservation_key: {
51738
+ description: "Key of the reservation to retrieve.",
51739
+ type: "string"
51740
+ }
51741
+ },
51742
+ type: "object"
51743
+ }
51744
+ }
51745
+ }
51746
+ },
51747
+ responses: {
51748
+ 200: {
51749
+ content: {
51750
+ "application/json": {
51751
+ schema: {
51752
+ properties: {
51753
+ ok: { type: "boolean" },
51754
+ reservation: {
51755
+ properties: {
51756
+ access_methods: {
51757
+ items: { $ref: "#/components/schemas/access_method" },
51758
+ type: "array"
51759
+ },
51760
+ created_at: { format: "date-time", type: "string" },
51761
+ ends_at: {
51762
+ format: "date-time",
51763
+ nullable: true,
51764
+ type: "string"
51765
+ },
51766
+ guest_name: { nullable: true, type: "string" },
51767
+ name: { nullable: true, type: "string" },
51768
+ reservation_id: { format: "uuid", type: "string" },
51769
+ reservation_key: { type: "string" },
51770
+ starts_at: {
51771
+ format: "date-time",
51772
+ nullable: true,
51773
+ type: "string"
51774
+ }
51775
+ },
51776
+ required: [
51777
+ "reservation_id",
51778
+ "reservation_key",
51779
+ "name",
51780
+ "starts_at",
51781
+ "ends_at",
51782
+ "created_at",
51783
+ "guest_name",
51784
+ "access_methods"
51785
+ ],
51786
+ type: "object"
51787
+ }
51788
+ },
51789
+ required: ["reservation", "ok"],
51790
+ type: "object"
51791
+ }
51792
+ }
51793
+ },
51794
+ description: "OK"
51795
+ },
51796
+ 400: { description: "Bad Request" },
51797
+ 401: { description: "Unauthorized" }
51798
+ },
51799
+ security: [{ client_session_with_customer: [] }],
51800
+ summary: "/seam/customer/v1/reservations/get",
51801
+ tags: [],
51802
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51803
+ "x-fern-sdk-method-name": "get",
51804
+ "x-fern-sdk-return-value": "reservation",
51805
+ "x-response-key": "reservation",
51806
+ "x-title": "Get Reservation for Customer",
51807
+ "x-undocumented": "Internal endpoint for customer portals."
51808
+ }
51809
+ },
51580
51810
  "/seam/customer/v1/reservations/list": {
51581
51811
  get: {
51582
51812
  description: "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.",
@@ -51590,6 +51820,15 @@ var openapi_default = {
51590
51820
  type: "string"
51591
51821
  }
51592
51822
  },
51823
+ {
51824
+ in: "query",
51825
+ name: "space_id",
51826
+ schema: {
51827
+ description: "Filter reservations by space ID (UUID).",
51828
+ format: "uuid",
51829
+ type: "string"
51830
+ }
51831
+ },
51593
51832
  {
51594
51833
  in: "query",
51595
51834
  name: "limit",
@@ -51713,6 +51952,11 @@ var openapi_default = {
51713
51952
  nullable: true,
51714
51953
  type: "string"
51715
51954
  },
51955
+ space_id: {
51956
+ description: "Filter reservations by space ID (UUID).",
51957
+ format: "uuid",
51958
+ type: "string"
51959
+ },
51716
51960
  space_key: {
51717
51961
  description: "Filter reservations by space key.",
51718
51962
  type: "string"