@seamapi/types 1.559.0 → 1.560.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.
@@ -91743,6 +91743,261 @@ declare const _default: {
91743
91743
  'x-undocumented': string;
91744
91744
  };
91745
91745
  };
91746
+ '/seam/customer/v1/reservations/list': {
91747
+ get: {
91748
+ description: string;
91749
+ operationId: string;
91750
+ parameters: ({
91751
+ in: string;
91752
+ name: string;
91753
+ schema: {
91754
+ description: string;
91755
+ type: string;
91756
+ default?: never;
91757
+ exclusiveMinimum?: never;
91758
+ minimum?: never;
91759
+ format?: never;
91760
+ nullable?: never;
91761
+ };
91762
+ } | {
91763
+ in: string;
91764
+ name: string;
91765
+ schema: {
91766
+ default: number;
91767
+ description: string;
91768
+ exclusiveMinimum: boolean;
91769
+ minimum: number;
91770
+ type: string;
91771
+ format?: never;
91772
+ nullable?: never;
91773
+ };
91774
+ } | {
91775
+ in: string;
91776
+ name: string;
91777
+ schema: {
91778
+ description: string;
91779
+ format: string;
91780
+ type: string;
91781
+ default?: never;
91782
+ exclusiveMinimum?: never;
91783
+ minimum?: never;
91784
+ nullable?: never;
91785
+ };
91786
+ } | {
91787
+ in: string;
91788
+ name: string;
91789
+ schema: {
91790
+ description: string;
91791
+ nullable: boolean;
91792
+ type: string;
91793
+ default?: never;
91794
+ exclusiveMinimum?: never;
91795
+ minimum?: never;
91796
+ format?: never;
91797
+ };
91798
+ })[];
91799
+ responses: {
91800
+ 200: {
91801
+ content: {
91802
+ 'application/json': {
91803
+ schema: {
91804
+ properties: {
91805
+ ok: {
91806
+ type: string;
91807
+ };
91808
+ pagination: {
91809
+ $ref: string;
91810
+ };
91811
+ reservations: {
91812
+ items: {
91813
+ properties: {
91814
+ access_methods: {
91815
+ items: {
91816
+ $ref: string;
91817
+ };
91818
+ type: string;
91819
+ };
91820
+ created_at: {
91821
+ format: string;
91822
+ type: string;
91823
+ };
91824
+ ends_at: {
91825
+ format: string;
91826
+ nullable: boolean;
91827
+ type: string;
91828
+ };
91829
+ guest_name: {
91830
+ nullable: boolean;
91831
+ type: string;
91832
+ };
91833
+ name: {
91834
+ nullable: boolean;
91835
+ type: string;
91836
+ };
91837
+ reservation_id: {
91838
+ format: string;
91839
+ type: string;
91840
+ };
91841
+ reservation_key: {
91842
+ type: string;
91843
+ };
91844
+ starts_at: {
91845
+ format: string;
91846
+ nullable: boolean;
91847
+ type: string;
91848
+ };
91849
+ };
91850
+ required: string[];
91851
+ type: string;
91852
+ };
91853
+ type: string;
91854
+ };
91855
+ };
91856
+ required: string[];
91857
+ type: string;
91858
+ };
91859
+ };
91860
+ };
91861
+ description: string;
91862
+ };
91863
+ 400: {
91864
+ description: string;
91865
+ };
91866
+ 401: {
91867
+ description: string;
91868
+ };
91869
+ };
91870
+ security: {
91871
+ client_session_with_customer: never[];
91872
+ }[];
91873
+ summary: string;
91874
+ tags: never[];
91875
+ 'x-fern-sdk-group-name': string[];
91876
+ 'x-fern-sdk-method-name': string;
91877
+ 'x-fern-sdk-return-value': string;
91878
+ 'x-response-key': string;
91879
+ 'x-title': string;
91880
+ 'x-undocumented': string;
91881
+ };
91882
+ post: {
91883
+ description: string;
91884
+ operationId: string;
91885
+ requestBody: {
91886
+ content: {
91887
+ 'application/json': {
91888
+ schema: {
91889
+ properties: {
91890
+ created_before: {
91891
+ description: string;
91892
+ format: string;
91893
+ type: string;
91894
+ };
91895
+ limit: {
91896
+ default: number;
91897
+ description: string;
91898
+ exclusiveMinimum: boolean;
91899
+ minimum: number;
91900
+ type: string;
91901
+ };
91902
+ page_cursor: {
91903
+ description: string;
91904
+ nullable: boolean;
91905
+ type: string;
91906
+ };
91907
+ space_key: {
91908
+ description: string;
91909
+ type: string;
91910
+ };
91911
+ };
91912
+ type: string;
91913
+ };
91914
+ };
91915
+ };
91916
+ };
91917
+ responses: {
91918
+ 200: {
91919
+ content: {
91920
+ 'application/json': {
91921
+ schema: {
91922
+ properties: {
91923
+ ok: {
91924
+ type: string;
91925
+ };
91926
+ pagination: {
91927
+ $ref: string;
91928
+ };
91929
+ reservations: {
91930
+ items: {
91931
+ properties: {
91932
+ access_methods: {
91933
+ items: {
91934
+ $ref: string;
91935
+ };
91936
+ type: string;
91937
+ };
91938
+ created_at: {
91939
+ format: string;
91940
+ type: string;
91941
+ };
91942
+ ends_at: {
91943
+ format: string;
91944
+ nullable: boolean;
91945
+ type: string;
91946
+ };
91947
+ guest_name: {
91948
+ nullable: boolean;
91949
+ type: string;
91950
+ };
91951
+ name: {
91952
+ nullable: boolean;
91953
+ type: string;
91954
+ };
91955
+ reservation_id: {
91956
+ format: string;
91957
+ type: string;
91958
+ };
91959
+ reservation_key: {
91960
+ type: string;
91961
+ };
91962
+ starts_at: {
91963
+ format: string;
91964
+ nullable: boolean;
91965
+ type: string;
91966
+ };
91967
+ };
91968
+ required: string[];
91969
+ type: string;
91970
+ };
91971
+ type: string;
91972
+ };
91973
+ };
91974
+ required: string[];
91975
+ type: string;
91976
+ };
91977
+ };
91978
+ };
91979
+ description: string;
91980
+ };
91981
+ 400: {
91982
+ description: string;
91983
+ };
91984
+ 401: {
91985
+ description: string;
91986
+ };
91987
+ };
91988
+ security: {
91989
+ client_session_with_customer: never[];
91990
+ }[];
91991
+ summary: string;
91992
+ tags: never[];
91993
+ 'x-fern-sdk-group-name': string[];
91994
+ 'x-fern-sdk-method-name': string;
91995
+ 'x-fern-sdk-return-value': string;
91996
+ 'x-response-key': string;
91997
+ 'x-title': string;
91998
+ 'x-undocumented': string;
91999
+ };
92000
+ };
91746
92001
  '/seam/customer/v1/settings/get': {
91747
92002
  get: {
91748
92003
  description: string;
@@ -161289,6 +161544,48 @@ type Routes = {
161289
161544
  };
161290
161545
  };
161291
161546
  };
161547
+ '/seam/customer/v1/reservations/list': {
161548
+ route: '/seam/customer/v1/reservations/list';
161549
+ method: 'GET' | 'POST';
161550
+ queryParams: {};
161551
+ jsonBody: {};
161552
+ commonParams: {
161553
+ /** Filter reservations by space key. */
161554
+ space_key?: string | undefined;
161555
+ /** Maximum number of records to return per page. */
161556
+ limit?: number;
161557
+ /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */
161558
+ created_before?: Date | undefined;
161559
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
161560
+ page_cursor?: ((string | undefined) | null) | undefined;
161561
+ };
161562
+ formData: {};
161563
+ jsonResponse: {
161564
+ reservations: {
161565
+ reservation_id: string;
161566
+ reservation_key: string;
161567
+ name: string | null;
161568
+ starts_at: string | null;
161569
+ ends_at: string | null;
161570
+ created_at: string;
161571
+ guest_name: string | null;
161572
+ access_methods: {
161573
+ access_method_id: string;
161574
+ mode: string;
161575
+ is_issued: boolean;
161576
+ }[];
161577
+ }[];
161578
+ /** Information about the current page of results. */
161579
+ pagination: {
161580
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
161581
+ next_page_cursor: string | null;
161582
+ /** Indicates whether there is another page of results after this one. */
161583
+ has_next_page: boolean;
161584
+ /** URL to get the next page of results. */
161585
+ next_page_url: string | null;
161586
+ };
161587
+ };
161588
+ };
161292
161589
  '/seam/customer/v1/settings/get': {
161293
161590
  route: '/seam/customer/v1/settings/get';
161294
161591
  method: 'GET' | 'POST';
package/dist/index.cjs CHANGED
@@ -51577,6 +51577,221 @@ var openapi_default = {
51577
51577
  "x-undocumented": "Internal endpoint for customer portals."
51578
51578
  }
51579
51579
  },
51580
+ "/seam/customer/v1/reservations/list": {
51581
+ get: {
51582
+ description: "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.",
51583
+ operationId: "seamCustomerV1ReservationsListGet",
51584
+ parameters: [
51585
+ {
51586
+ in: "query",
51587
+ name: "space_key",
51588
+ schema: {
51589
+ description: "Filter reservations by space key.",
51590
+ type: "string"
51591
+ }
51592
+ },
51593
+ {
51594
+ in: "query",
51595
+ name: "limit",
51596
+ schema: {
51597
+ default: 500,
51598
+ description: "Maximum number of records to return per page.",
51599
+ exclusiveMinimum: true,
51600
+ minimum: 0,
51601
+ type: "integer"
51602
+ }
51603
+ },
51604
+ {
51605
+ in: "query",
51606
+ name: "created_before",
51607
+ schema: {
51608
+ description: "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.",
51609
+ format: "date-time",
51610
+ type: "string"
51611
+ }
51612
+ },
51613
+ {
51614
+ in: "query",
51615
+ name: "page_cursor",
51616
+ schema: {
51617
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
51618
+ nullable: true,
51619
+ type: "string"
51620
+ }
51621
+ }
51622
+ ],
51623
+ responses: {
51624
+ 200: {
51625
+ content: {
51626
+ "application/json": {
51627
+ schema: {
51628
+ properties: {
51629
+ ok: { type: "boolean" },
51630
+ pagination: { $ref: "#/components/schemas/pagination" },
51631
+ reservations: {
51632
+ items: {
51633
+ properties: {
51634
+ access_methods: {
51635
+ items: {
51636
+ $ref: "#/components/schemas/access_method"
51637
+ },
51638
+ type: "array"
51639
+ },
51640
+ created_at: { format: "date-time", type: "string" },
51641
+ ends_at: {
51642
+ format: "date-time",
51643
+ nullable: true,
51644
+ type: "string"
51645
+ },
51646
+ guest_name: { nullable: true, type: "string" },
51647
+ name: { nullable: true, type: "string" },
51648
+ reservation_id: { format: "uuid", type: "string" },
51649
+ reservation_key: { type: "string" },
51650
+ starts_at: {
51651
+ format: "date-time",
51652
+ nullable: true,
51653
+ type: "string"
51654
+ }
51655
+ },
51656
+ required: [
51657
+ "reservation_id",
51658
+ "reservation_key",
51659
+ "name",
51660
+ "starts_at",
51661
+ "ends_at",
51662
+ "created_at",
51663
+ "guest_name",
51664
+ "access_methods"
51665
+ ],
51666
+ type: "object"
51667
+ },
51668
+ type: "array"
51669
+ }
51670
+ },
51671
+ required: ["reservations", "pagination", "ok"],
51672
+ type: "object"
51673
+ }
51674
+ }
51675
+ },
51676
+ description: "OK"
51677
+ },
51678
+ 400: { description: "Bad Request" },
51679
+ 401: { description: "Unauthorized" }
51680
+ },
51681
+ security: [{ client_session_with_customer: [] }],
51682
+ summary: "/seam/customer/v1/reservations/list",
51683
+ tags: [],
51684
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51685
+ "x-fern-sdk-method-name": "list",
51686
+ "x-fern-sdk-return-value": "reservations",
51687
+ "x-response-key": "reservations",
51688
+ "x-title": "List Reservations for Customer Space",
51689
+ "x-undocumented": "Internal endpoint for customer portals."
51690
+ },
51691
+ post: {
51692
+ description: "Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.",
51693
+ operationId: "seamCustomerV1ReservationsListPost",
51694
+ requestBody: {
51695
+ content: {
51696
+ "application/json": {
51697
+ schema: {
51698
+ properties: {
51699
+ created_before: {
51700
+ description: "Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.",
51701
+ format: "date-time",
51702
+ type: "string"
51703
+ },
51704
+ limit: {
51705
+ default: 500,
51706
+ description: "Maximum number of records to return per page.",
51707
+ exclusiveMinimum: true,
51708
+ minimum: 0,
51709
+ type: "integer"
51710
+ },
51711
+ page_cursor: {
51712
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
51713
+ nullable: true,
51714
+ type: "string"
51715
+ },
51716
+ space_key: {
51717
+ description: "Filter reservations by space key.",
51718
+ type: "string"
51719
+ }
51720
+ },
51721
+ type: "object"
51722
+ }
51723
+ }
51724
+ }
51725
+ },
51726
+ responses: {
51727
+ 200: {
51728
+ content: {
51729
+ "application/json": {
51730
+ schema: {
51731
+ properties: {
51732
+ ok: { type: "boolean" },
51733
+ pagination: { $ref: "#/components/schemas/pagination" },
51734
+ reservations: {
51735
+ items: {
51736
+ properties: {
51737
+ access_methods: {
51738
+ items: {
51739
+ $ref: "#/components/schemas/access_method"
51740
+ },
51741
+ type: "array"
51742
+ },
51743
+ created_at: { format: "date-time", type: "string" },
51744
+ ends_at: {
51745
+ format: "date-time",
51746
+ nullable: true,
51747
+ type: "string"
51748
+ },
51749
+ guest_name: { nullable: true, type: "string" },
51750
+ name: { nullable: true, type: "string" },
51751
+ reservation_id: { format: "uuid", type: "string" },
51752
+ reservation_key: { type: "string" },
51753
+ starts_at: {
51754
+ format: "date-time",
51755
+ nullable: true,
51756
+ type: "string"
51757
+ }
51758
+ },
51759
+ required: [
51760
+ "reservation_id",
51761
+ "reservation_key",
51762
+ "name",
51763
+ "starts_at",
51764
+ "ends_at",
51765
+ "created_at",
51766
+ "guest_name",
51767
+ "access_methods"
51768
+ ],
51769
+ type: "object"
51770
+ },
51771
+ type: "array"
51772
+ }
51773
+ },
51774
+ required: ["reservations", "pagination", "ok"],
51775
+ type: "object"
51776
+ }
51777
+ }
51778
+ },
51779
+ description: "OK"
51780
+ },
51781
+ 400: { description: "Bad Request" },
51782
+ 401: { description: "Unauthorized" }
51783
+ },
51784
+ security: [{ client_session_with_customer: [] }],
51785
+ summary: "/seam/customer/v1/reservations/list",
51786
+ tags: [],
51787
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "reservations"],
51788
+ "x-fern-sdk-method-name": "list",
51789
+ "x-fern-sdk-return-value": "reservations",
51790
+ "x-response-key": "reservations",
51791
+ "x-title": "List Reservations for Customer Space",
51792
+ "x-undocumented": "Internal endpoint for customer portals."
51793
+ }
51794
+ },
51580
51795
  "/seam/customer/v1/settings/get": {
51581
51796
  get: {
51582
51797
  description: "Retrieves the settings for a customer portal workspace.",