@seamapi/types 1.559.0 → 1.561.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
@@ -51577,6 +51577,406 @@ var openapi_default = {
51577
51577
  "x-undocumented": "Internal endpoint for customer portals."
51578
51578
  }
51579
51579
  },
51580
+ "/seam/customer/v1/reservations/get": {
51581
+ get: {
51582
+ description: "Returns a single reservation for a specific customer by reservation ID.",
51583
+ operationId: "seamCustomerV1ReservationsGetGet",
51584
+ parameters: [
51585
+ {
51586
+ in: "query",
51587
+ name: "reservation_id",
51588
+ schema: {
51589
+ description: "ID of the reservation to retrieve.",
51590
+ format: "uuid",
51591
+ type: "string"
51592
+ }
51593
+ },
51594
+ {
51595
+ in: "query",
51596
+ name: "reservation_key",
51597
+ schema: {
51598
+ description: "Key of the reservation to retrieve.",
51599
+ type: "string"
51600
+ }
51601
+ }
51602
+ ],
51603
+ responses: {
51604
+ 200: {
51605
+ content: {
51606
+ "application/json": {
51607
+ schema: {
51608
+ properties: {
51609
+ ok: { type: "boolean" },
51610
+ reservation: {
51611
+ properties: {
51612
+ access_methods: {
51613
+ items: { $ref: "#/components/schemas/access_method" },
51614
+ type: "array"
51615
+ },
51616
+ created_at: { format: "date-time", type: "string" },
51617
+ ends_at: {
51618
+ format: "date-time",
51619
+ nullable: true,
51620
+ type: "string"
51621
+ },
51622
+ guest_name: { nullable: true, type: "string" },
51623
+ name: { nullable: true, type: "string" },
51624
+ reservation_id: { format: "uuid", type: "string" },
51625
+ reservation_key: { type: "string" },
51626
+ starts_at: {
51627
+ format: "date-time",
51628
+ nullable: true,
51629
+ type: "string"
51630
+ }
51631
+ },
51632
+ required: [
51633
+ "reservation_id",
51634
+ "reservation_key",
51635
+ "name",
51636
+ "starts_at",
51637
+ "ends_at",
51638
+ "created_at",
51639
+ "guest_name",
51640
+ "access_methods"
51641
+ ],
51642
+ type: "object"
51643
+ }
51644
+ },
51645
+ required: ["reservation", "ok"],
51646
+ type: "object"
51647
+ }
51648
+ }
51649
+ },
51650
+ description: "OK"
51651
+ },
51652
+ 400: { description: "Bad Request" },
51653
+ 401: { description: "Unauthorized" }
51654
+ },
51655
+ security: [{ client_session_with_customer: [] }],
51656
+ summary: "/seam/customer/v1/reservations/get",
51657
+ tags: [],
51658
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51659
+ "x-fern-sdk-method-name": "get",
51660
+ "x-fern-sdk-return-value": "reservation",
51661
+ "x-response-key": "reservation",
51662
+ "x-title": "Get Reservation for Customer",
51663
+ "x-undocumented": "Internal endpoint for customer portals."
51664
+ },
51665
+ post: {
51666
+ description: "Returns a single reservation for a specific customer by reservation ID.",
51667
+ operationId: "seamCustomerV1ReservationsGetPost",
51668
+ requestBody: {
51669
+ content: {
51670
+ "application/json": {
51671
+ schema: {
51672
+ properties: {
51673
+ reservation_id: {
51674
+ description: "ID of the reservation to retrieve.",
51675
+ format: "uuid",
51676
+ type: "string"
51677
+ },
51678
+ reservation_key: {
51679
+ description: "Key of the reservation to retrieve.",
51680
+ type: "string"
51681
+ }
51682
+ },
51683
+ type: "object"
51684
+ }
51685
+ }
51686
+ }
51687
+ },
51688
+ responses: {
51689
+ 200: {
51690
+ content: {
51691
+ "application/json": {
51692
+ schema: {
51693
+ properties: {
51694
+ ok: { type: "boolean" },
51695
+ reservation: {
51696
+ properties: {
51697
+ access_methods: {
51698
+ items: { $ref: "#/components/schemas/access_method" },
51699
+ type: "array"
51700
+ },
51701
+ created_at: { format: "date-time", type: "string" },
51702
+ ends_at: {
51703
+ format: "date-time",
51704
+ nullable: true,
51705
+ type: "string"
51706
+ },
51707
+ guest_name: { nullable: true, type: "string" },
51708
+ name: { nullable: true, type: "string" },
51709
+ reservation_id: { format: "uuid", type: "string" },
51710
+ reservation_key: { type: "string" },
51711
+ starts_at: {
51712
+ format: "date-time",
51713
+ nullable: true,
51714
+ type: "string"
51715
+ }
51716
+ },
51717
+ required: [
51718
+ "reservation_id",
51719
+ "reservation_key",
51720
+ "name",
51721
+ "starts_at",
51722
+ "ends_at",
51723
+ "created_at",
51724
+ "guest_name",
51725
+ "access_methods"
51726
+ ],
51727
+ type: "object"
51728
+ }
51729
+ },
51730
+ required: ["reservation", "ok"],
51731
+ type: "object"
51732
+ }
51733
+ }
51734
+ },
51735
+ description: "OK"
51736
+ },
51737
+ 400: { description: "Bad Request" },
51738
+ 401: { description: "Unauthorized" }
51739
+ },
51740
+ security: [{ client_session_with_customer: [] }],
51741
+ summary: "/seam/customer/v1/reservations/get",
51742
+ tags: [],
51743
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51744
+ "x-fern-sdk-method-name": "get",
51745
+ "x-fern-sdk-return-value": "reservation",
51746
+ "x-response-key": "reservation",
51747
+ "x-title": "Get Reservation for Customer",
51748
+ "x-undocumented": "Internal endpoint for customer portals."
51749
+ }
51750
+ },
51751
+ "/seam/customer/v1/reservations/list": {
51752
+ get: {
51753
+ description: "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.",
51754
+ operationId: "seamCustomerV1ReservationsListGet",
51755
+ parameters: [
51756
+ {
51757
+ in: "query",
51758
+ name: "space_key",
51759
+ schema: {
51760
+ description: "Filter reservations by space key.",
51761
+ type: "string"
51762
+ }
51763
+ },
51764
+ {
51765
+ in: "query",
51766
+ name: "space_id",
51767
+ schema: {
51768
+ description: "Filter reservations by space ID (UUID).",
51769
+ format: "uuid",
51770
+ type: "string"
51771
+ }
51772
+ },
51773
+ {
51774
+ in: "query",
51775
+ name: "limit",
51776
+ schema: {
51777
+ default: 500,
51778
+ description: "Maximum number of records to return per page.",
51779
+ exclusiveMinimum: true,
51780
+ minimum: 0,
51781
+ type: "integer"
51782
+ }
51783
+ },
51784
+ {
51785
+ in: "query",
51786
+ name: "created_before",
51787
+ schema: {
51788
+ description: "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.",
51789
+ format: "date-time",
51790
+ type: "string"
51791
+ }
51792
+ },
51793
+ {
51794
+ in: "query",
51795
+ name: "page_cursor",
51796
+ schema: {
51797
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
51798
+ nullable: true,
51799
+ type: "string"
51800
+ }
51801
+ }
51802
+ ],
51803
+ responses: {
51804
+ 200: {
51805
+ content: {
51806
+ "application/json": {
51807
+ schema: {
51808
+ properties: {
51809
+ ok: { type: "boolean" },
51810
+ pagination: { $ref: "#/components/schemas/pagination" },
51811
+ reservations: {
51812
+ items: {
51813
+ properties: {
51814
+ access_methods: {
51815
+ items: {
51816
+ $ref: "#/components/schemas/access_method"
51817
+ },
51818
+ type: "array"
51819
+ },
51820
+ created_at: { format: "date-time", type: "string" },
51821
+ ends_at: {
51822
+ format: "date-time",
51823
+ nullable: true,
51824
+ type: "string"
51825
+ },
51826
+ guest_name: { nullable: true, type: "string" },
51827
+ name: { nullable: true, type: "string" },
51828
+ reservation_id: { format: "uuid", type: "string" },
51829
+ reservation_key: { type: "string" },
51830
+ starts_at: {
51831
+ format: "date-time",
51832
+ nullable: true,
51833
+ type: "string"
51834
+ }
51835
+ },
51836
+ required: [
51837
+ "reservation_id",
51838
+ "reservation_key",
51839
+ "name",
51840
+ "starts_at",
51841
+ "ends_at",
51842
+ "created_at",
51843
+ "guest_name",
51844
+ "access_methods"
51845
+ ],
51846
+ type: "object"
51847
+ },
51848
+ type: "array"
51849
+ }
51850
+ },
51851
+ required: ["reservations", "pagination", "ok"],
51852
+ type: "object"
51853
+ }
51854
+ }
51855
+ },
51856
+ description: "OK"
51857
+ },
51858
+ 400: { description: "Bad Request" },
51859
+ 401: { description: "Unauthorized" }
51860
+ },
51861
+ security: [{ client_session_with_customer: [] }],
51862
+ summary: "/seam/customer/v1/reservations/list",
51863
+ tags: [],
51864
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51865
+ "x-fern-sdk-method-name": "list",
51866
+ "x-fern-sdk-return-value": "reservations",
51867
+ "x-response-key": "reservations",
51868
+ "x-title": "List Reservations for Customer Space",
51869
+ "x-undocumented": "Internal endpoint for customer portals."
51870
+ },
51871
+ post: {
51872
+ description: "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.",
51873
+ operationId: "seamCustomerV1ReservationsListPost",
51874
+ requestBody: {
51875
+ content: {
51876
+ "application/json": {
51877
+ schema: {
51878
+ properties: {
51879
+ created_before: {
51880
+ description: "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.",
51881
+ format: "date-time",
51882
+ type: "string"
51883
+ },
51884
+ limit: {
51885
+ default: 500,
51886
+ description: "Maximum number of records to return per page.",
51887
+ exclusiveMinimum: true,
51888
+ minimum: 0,
51889
+ type: "integer"
51890
+ },
51891
+ page_cursor: {
51892
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
51893
+ nullable: true,
51894
+ type: "string"
51895
+ },
51896
+ space_id: {
51897
+ description: "Filter reservations by space ID (UUID).",
51898
+ format: "uuid",
51899
+ type: "string"
51900
+ },
51901
+ space_key: {
51902
+ description: "Filter reservations by space key.",
51903
+ type: "string"
51904
+ }
51905
+ },
51906
+ type: "object"
51907
+ }
51908
+ }
51909
+ }
51910
+ },
51911
+ responses: {
51912
+ 200: {
51913
+ content: {
51914
+ "application/json": {
51915
+ schema: {
51916
+ properties: {
51917
+ ok: { type: "boolean" },
51918
+ pagination: { $ref: "#/components/schemas/pagination" },
51919
+ reservations: {
51920
+ items: {
51921
+ properties: {
51922
+ access_methods: {
51923
+ items: {
51924
+ $ref: "#/components/schemas/access_method"
51925
+ },
51926
+ type: "array"
51927
+ },
51928
+ created_at: { format: "date-time", type: "string" },
51929
+ ends_at: {
51930
+ format: "date-time",
51931
+ nullable: true,
51932
+ type: "string"
51933
+ },
51934
+ guest_name: { nullable: true, type: "string" },
51935
+ name: { nullable: true, type: "string" },
51936
+ reservation_id: { format: "uuid", type: "string" },
51937
+ reservation_key: { type: "string" },
51938
+ starts_at: {
51939
+ format: "date-time",
51940
+ nullable: true,
51941
+ type: "string"
51942
+ }
51943
+ },
51944
+ required: [
51945
+ "reservation_id",
51946
+ "reservation_key",
51947
+ "name",
51948
+ "starts_at",
51949
+ "ends_at",
51950
+ "created_at",
51951
+ "guest_name",
51952
+ "access_methods"
51953
+ ],
51954
+ type: "object"
51955
+ },
51956
+ type: "array"
51957
+ }
51958
+ },
51959
+ required: ["reservations", "pagination", "ok"],
51960
+ type: "object"
51961
+ }
51962
+ }
51963
+ },
51964
+ description: "OK"
51965
+ },
51966
+ 400: { description: "Bad Request" },
51967
+ 401: { description: "Unauthorized" }
51968
+ },
51969
+ security: [{ client_session_with_customer: [] }],
51970
+ summary: "/seam/customer/v1/reservations/list",
51971
+ tags: [],
51972
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51973
+ "x-fern-sdk-method-name": "list",
51974
+ "x-fern-sdk-return-value": "reservations",
51975
+ "x-response-key": "reservations",
51976
+ "x-title": "List Reservations for Customer Space",
51977
+ "x-undocumented": "Internal endpoint for customer portals."
51978
+ }
51979
+ },
51580
51980
  "/seam/customer/v1/settings/get": {
51581
51981
  get: {
51582
51982
  description: "Retrieves the settings for a customer portal workspace.",