@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.
@@ -58017,6 +58017,48 @@ export type Routes = {
58017
58017
  };
58018
58018
  };
58019
58019
  };
58020
+ '/seam/customer/v1/reservations/list': {
58021
+ route: '/seam/customer/v1/reservations/list';
58022
+ method: 'GET' | 'POST';
58023
+ queryParams: {};
58024
+ jsonBody: {};
58025
+ commonParams: {
58026
+ /** Filter reservations by space key. */
58027
+ space_key?: string | undefined;
58028
+ /** Maximum number of records to return per page. */
58029
+ limit?: number;
58030
+ /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */
58031
+ created_before?: Date | undefined;
58032
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
58033
+ page_cursor?: ((string | undefined) | null) | undefined;
58034
+ };
58035
+ formData: {};
58036
+ jsonResponse: {
58037
+ reservations: {
58038
+ reservation_id: string;
58039
+ reservation_key: string;
58040
+ name: string | null;
58041
+ starts_at: string | null;
58042
+ ends_at: string | null;
58043
+ created_at: string;
58044
+ guest_name: string | null;
58045
+ access_methods: {
58046
+ access_method_id: string;
58047
+ mode: string;
58048
+ is_issued: boolean;
58049
+ }[];
58050
+ }[];
58051
+ /** Information about the current page of results. */
58052
+ pagination: {
58053
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
58054
+ next_page_cursor: string | null;
58055
+ /** Indicates whether there is another page of results after this one. */
58056
+ has_next_page: boolean;
58057
+ /** URL to get the next page of results. */
58058
+ next_page_url: string | null;
58059
+ };
58060
+ };
58061
+ };
58020
58062
  '/seam/customer/v1/settings/get': {
58021
58063
  route: '/seam/customer/v1/settings/get';
58022
58064
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.559.0",
3
+ "version": "1.560.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -49837,6 +49837,228 @@ export default {
49837
49837
  'x-undocumented': 'Internal endpoint for customer portals.',
49838
49838
  },
49839
49839
  },
49840
+ '/seam/customer/v1/reservations/list': {
49841
+ get: {
49842
+ description:
49843
+ 'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
49844
+ operationId: 'seamCustomerV1ReservationsListGet',
49845
+ parameters: [
49846
+ {
49847
+ in: 'query',
49848
+ name: 'space_key',
49849
+ schema: {
49850
+ description: 'Filter reservations by space key.',
49851
+ type: 'string',
49852
+ },
49853
+ },
49854
+ {
49855
+ in: 'query',
49856
+ name: 'limit',
49857
+ schema: {
49858
+ default: 500,
49859
+ description: 'Maximum number of records to return per page.',
49860
+ exclusiveMinimum: true,
49861
+ minimum: 0,
49862
+ type: 'integer',
49863
+ },
49864
+ },
49865
+ {
49866
+ in: 'query',
49867
+ name: 'created_before',
49868
+ schema: {
49869
+ description:
49870
+ 'Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.',
49871
+ format: 'date-time',
49872
+ type: 'string',
49873
+ },
49874
+ },
49875
+ {
49876
+ in: 'query',
49877
+ name: 'page_cursor',
49878
+ schema: {
49879
+ description:
49880
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
49881
+ nullable: true,
49882
+ type: 'string',
49883
+ },
49884
+ },
49885
+ ],
49886
+ responses: {
49887
+ 200: {
49888
+ content: {
49889
+ 'application/json': {
49890
+ schema: {
49891
+ properties: {
49892
+ ok: { type: 'boolean' },
49893
+ pagination: { $ref: '#/components/schemas/pagination' },
49894
+ reservations: {
49895
+ items: {
49896
+ properties: {
49897
+ access_methods: {
49898
+ items: {
49899
+ $ref: '#/components/schemas/access_method',
49900
+ },
49901
+ type: 'array',
49902
+ },
49903
+ created_at: { format: 'date-time', type: 'string' },
49904
+ ends_at: {
49905
+ format: 'date-time',
49906
+ nullable: true,
49907
+ type: 'string',
49908
+ },
49909
+ guest_name: { nullable: true, type: 'string' },
49910
+ name: { nullable: true, type: 'string' },
49911
+ reservation_id: { format: 'uuid', type: 'string' },
49912
+ reservation_key: { type: 'string' },
49913
+ starts_at: {
49914
+ format: 'date-time',
49915
+ nullable: true,
49916
+ type: 'string',
49917
+ },
49918
+ },
49919
+ required: [
49920
+ 'reservation_id',
49921
+ 'reservation_key',
49922
+ 'name',
49923
+ 'starts_at',
49924
+ 'ends_at',
49925
+ 'created_at',
49926
+ 'guest_name',
49927
+ 'access_methods',
49928
+ ],
49929
+ type: 'object',
49930
+ },
49931
+ type: 'array',
49932
+ },
49933
+ },
49934
+ required: ['reservations', 'pagination', 'ok'],
49935
+ type: 'object',
49936
+ },
49937
+ },
49938
+ },
49939
+ description: 'OK',
49940
+ },
49941
+ 400: { description: 'Bad Request' },
49942
+ 401: { description: 'Unauthorized' },
49943
+ },
49944
+ security: [{ client_session_with_customer: [] }],
49945
+ summary: '/seam/customer/v1/reservations/list',
49946
+ tags: [],
49947
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
49948
+ 'x-fern-sdk-method-name': 'list',
49949
+ 'x-fern-sdk-return-value': 'reservations',
49950
+ 'x-response-key': 'reservations',
49951
+ 'x-title': 'List Reservations for Customer Space',
49952
+ 'x-undocumented': 'Internal endpoint for customer portals.',
49953
+ },
49954
+ post: {
49955
+ description:
49956
+ 'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
49957
+ operationId: 'seamCustomerV1ReservationsListPost',
49958
+ requestBody: {
49959
+ content: {
49960
+ 'application/json': {
49961
+ schema: {
49962
+ properties: {
49963
+ created_before: {
49964
+ description:
49965
+ 'Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.',
49966
+ format: 'date-time',
49967
+ type: 'string',
49968
+ },
49969
+ limit: {
49970
+ default: 500,
49971
+ description:
49972
+ 'Maximum number of records to return per page.',
49973
+ exclusiveMinimum: true,
49974
+ minimum: 0,
49975
+ type: 'integer',
49976
+ },
49977
+ page_cursor: {
49978
+ description:
49979
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
49980
+ nullable: true,
49981
+ type: 'string',
49982
+ },
49983
+ space_key: {
49984
+ description: 'Filter reservations by space key.',
49985
+ type: 'string',
49986
+ },
49987
+ },
49988
+ type: 'object',
49989
+ },
49990
+ },
49991
+ },
49992
+ },
49993
+ responses: {
49994
+ 200: {
49995
+ content: {
49996
+ 'application/json': {
49997
+ schema: {
49998
+ properties: {
49999
+ ok: { type: 'boolean' },
50000
+ pagination: { $ref: '#/components/schemas/pagination' },
50001
+ reservations: {
50002
+ items: {
50003
+ properties: {
50004
+ access_methods: {
50005
+ items: {
50006
+ $ref: '#/components/schemas/access_method',
50007
+ },
50008
+ type: 'array',
50009
+ },
50010
+ created_at: { format: 'date-time', type: 'string' },
50011
+ ends_at: {
50012
+ format: 'date-time',
50013
+ nullable: true,
50014
+ type: 'string',
50015
+ },
50016
+ guest_name: { nullable: true, type: 'string' },
50017
+ name: { nullable: true, type: 'string' },
50018
+ reservation_id: { format: 'uuid', type: 'string' },
50019
+ reservation_key: { type: 'string' },
50020
+ starts_at: {
50021
+ format: 'date-time',
50022
+ nullable: true,
50023
+ type: 'string',
50024
+ },
50025
+ },
50026
+ required: [
50027
+ 'reservation_id',
50028
+ 'reservation_key',
50029
+ 'name',
50030
+ 'starts_at',
50031
+ 'ends_at',
50032
+ 'created_at',
50033
+ 'guest_name',
50034
+ 'access_methods',
50035
+ ],
50036
+ type: 'object',
50037
+ },
50038
+ type: 'array',
50039
+ },
50040
+ },
50041
+ required: ['reservations', 'pagination', 'ok'],
50042
+ type: 'object',
50043
+ },
50044
+ },
50045
+ },
50046
+ description: 'OK',
50047
+ },
50048
+ 400: { description: 'Bad Request' },
50049
+ 401: { description: 'Unauthorized' },
50050
+ },
50051
+ security: [{ client_session_with_customer: [] }],
50052
+ summary: '/seam/customer/v1/reservations/list',
50053
+ tags: [],
50054
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
50055
+ 'x-fern-sdk-method-name': 'list',
50056
+ 'x-fern-sdk-return-value': 'reservations',
50057
+ 'x-response-key': 'reservations',
50058
+ 'x-title': 'List Reservations for Customer Space',
50059
+ 'x-undocumented': 'Internal endpoint for customer portals.',
50060
+ },
50061
+ },
49840
50062
  '/seam/customer/v1/settings/get': {
49841
50063
  get: {
49842
50064
  description: 'Retrieves the settings for a customer portal workspace.',
@@ -69109,6 +69109,48 @@ export type Routes = {
69109
69109
  }
69110
69110
  }
69111
69111
  }
69112
+ '/seam/customer/v1/reservations/list': {
69113
+ route: '/seam/customer/v1/reservations/list'
69114
+ method: 'GET' | 'POST'
69115
+ queryParams: {}
69116
+ jsonBody: {}
69117
+ commonParams: {
69118
+ /** Filter reservations by space key. */
69119
+ space_key?: string | undefined
69120
+ /** Maximum number of records to return per page. */
69121
+ limit?: number
69122
+ /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */
69123
+ created_before?: Date | undefined
69124
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
69125
+ page_cursor?: ((string | undefined) | null) | undefined
69126
+ }
69127
+ formData: {}
69128
+ jsonResponse: {
69129
+ reservations: {
69130
+ reservation_id: string
69131
+ reservation_key: string
69132
+ name: string | null
69133
+ starts_at: string | null
69134
+ ends_at: string | null
69135
+ created_at: string
69136
+ guest_name: string | null
69137
+ access_methods: {
69138
+ access_method_id: string
69139
+ mode: string
69140
+ is_issued: boolean
69141
+ }[]
69142
+ }[]
69143
+ /** Information about the current page of results. */
69144
+ pagination: {
69145
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
69146
+ next_page_cursor: string | null
69147
+ /** Indicates whether there is another page of results after this one. */
69148
+ has_next_page: boolean
69149
+ /** URL to get the next page of results. */
69150
+ next_page_url: string | null
69151
+ }
69152
+ }
69153
+ }
69112
69154
  '/seam/customer/v1/settings/get': {
69113
69155
  route: '/seam/customer/v1/settings/get'
69114
69156
  method: 'GET' | 'POST'