@seamapi/types 1.560.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.
@@ -58017,6 +58017,35 @@ export type Routes = {
58017
58017
  };
58018
58018
  };
58019
58019
  };
58020
+ '/seam/customer/v1/reservations/get': {
58021
+ route: '/seam/customer/v1/reservations/get';
58022
+ method: 'GET' | 'POST';
58023
+ queryParams: {};
58024
+ jsonBody: {};
58025
+ commonParams: {
58026
+ /** ID of the reservation to retrieve. */
58027
+ reservation_id?: string | undefined;
58028
+ /** Key of the reservation to retrieve. */
58029
+ reservation_key?: string | undefined;
58030
+ };
58031
+ formData: {};
58032
+ jsonResponse: {
58033
+ reservation: {
58034
+ reservation_id: string;
58035
+ reservation_key: string;
58036
+ name: string | null;
58037
+ starts_at: string | null;
58038
+ ends_at: string | null;
58039
+ created_at: string;
58040
+ guest_name: string | null;
58041
+ access_methods: {
58042
+ access_method_id: string;
58043
+ mode: string;
58044
+ is_issued: boolean;
58045
+ }[];
58046
+ };
58047
+ };
58048
+ };
58020
58049
  '/seam/customer/v1/reservations/list': {
58021
58050
  route: '/seam/customer/v1/reservations/list';
58022
58051
  method: 'GET' | 'POST';
@@ -58025,6 +58054,8 @@ export type Routes = {
58025
58054
  commonParams: {
58026
58055
  /** Filter reservations by space key. */
58027
58056
  space_key?: string | undefined;
58057
+ /** Filter reservations by space ID (UUID). */
58058
+ space_id?: string | undefined;
58028
58059
  /** Maximum number of records to return per page. */
58029
58060
  limit?: number;
58030
58061
  /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.560.0",
3
+ "version": "1.561.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -49837,6 +49837,179 @@ export default {
49837
49837
  'x-undocumented': 'Internal endpoint for customer portals.',
49838
49838
  },
49839
49839
  },
49840
+ '/seam/customer/v1/reservations/get': {
49841
+ get: {
49842
+ description:
49843
+ 'Returns a single reservation for a specific customer by reservation ID.',
49844
+ operationId: 'seamCustomerV1ReservationsGetGet',
49845
+ parameters: [
49846
+ {
49847
+ in: 'query',
49848
+ name: 'reservation_id',
49849
+ schema: {
49850
+ description: 'ID of the reservation to retrieve.',
49851
+ format: 'uuid',
49852
+ type: 'string',
49853
+ },
49854
+ },
49855
+ {
49856
+ in: 'query',
49857
+ name: 'reservation_key',
49858
+ schema: {
49859
+ description: 'Key of the reservation to retrieve.',
49860
+ type: 'string',
49861
+ },
49862
+ },
49863
+ ],
49864
+ responses: {
49865
+ 200: {
49866
+ content: {
49867
+ 'application/json': {
49868
+ schema: {
49869
+ properties: {
49870
+ ok: { type: 'boolean' },
49871
+ reservation: {
49872
+ properties: {
49873
+ access_methods: {
49874
+ items: { $ref: '#/components/schemas/access_method' },
49875
+ type: 'array',
49876
+ },
49877
+ created_at: { format: 'date-time', type: 'string' },
49878
+ ends_at: {
49879
+ format: 'date-time',
49880
+ nullable: true,
49881
+ type: 'string',
49882
+ },
49883
+ guest_name: { nullable: true, type: 'string' },
49884
+ name: { nullable: true, type: 'string' },
49885
+ reservation_id: { format: 'uuid', type: 'string' },
49886
+ reservation_key: { type: 'string' },
49887
+ starts_at: {
49888
+ format: 'date-time',
49889
+ nullable: true,
49890
+ type: 'string',
49891
+ },
49892
+ },
49893
+ required: [
49894
+ 'reservation_id',
49895
+ 'reservation_key',
49896
+ 'name',
49897
+ 'starts_at',
49898
+ 'ends_at',
49899
+ 'created_at',
49900
+ 'guest_name',
49901
+ 'access_methods',
49902
+ ],
49903
+ type: 'object',
49904
+ },
49905
+ },
49906
+ required: ['reservation', 'ok'],
49907
+ type: 'object',
49908
+ },
49909
+ },
49910
+ },
49911
+ description: 'OK',
49912
+ },
49913
+ 400: { description: 'Bad Request' },
49914
+ 401: { description: 'Unauthorized' },
49915
+ },
49916
+ security: [{ client_session_with_customer: [] }],
49917
+ summary: '/seam/customer/v1/reservations/get',
49918
+ tags: [],
49919
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
49920
+ 'x-fern-sdk-method-name': 'get',
49921
+ 'x-fern-sdk-return-value': 'reservation',
49922
+ 'x-response-key': 'reservation',
49923
+ 'x-title': 'Get Reservation for Customer',
49924
+ 'x-undocumented': 'Internal endpoint for customer portals.',
49925
+ },
49926
+ post: {
49927
+ description:
49928
+ 'Returns a single reservation for a specific customer by reservation ID.',
49929
+ operationId: 'seamCustomerV1ReservationsGetPost',
49930
+ requestBody: {
49931
+ content: {
49932
+ 'application/json': {
49933
+ schema: {
49934
+ properties: {
49935
+ reservation_id: {
49936
+ description: 'ID of the reservation to retrieve.',
49937
+ format: 'uuid',
49938
+ type: 'string',
49939
+ },
49940
+ reservation_key: {
49941
+ description: 'Key of the reservation to retrieve.',
49942
+ type: 'string',
49943
+ },
49944
+ },
49945
+ type: 'object',
49946
+ },
49947
+ },
49948
+ },
49949
+ },
49950
+ responses: {
49951
+ 200: {
49952
+ content: {
49953
+ 'application/json': {
49954
+ schema: {
49955
+ properties: {
49956
+ ok: { type: 'boolean' },
49957
+ reservation: {
49958
+ properties: {
49959
+ access_methods: {
49960
+ items: { $ref: '#/components/schemas/access_method' },
49961
+ type: 'array',
49962
+ },
49963
+ created_at: { format: 'date-time', type: 'string' },
49964
+ ends_at: {
49965
+ format: 'date-time',
49966
+ nullable: true,
49967
+ type: 'string',
49968
+ },
49969
+ guest_name: { nullable: true, type: 'string' },
49970
+ name: { nullable: true, type: 'string' },
49971
+ reservation_id: { format: 'uuid', type: 'string' },
49972
+ reservation_key: { type: 'string' },
49973
+ starts_at: {
49974
+ format: 'date-time',
49975
+ nullable: true,
49976
+ type: 'string',
49977
+ },
49978
+ },
49979
+ required: [
49980
+ 'reservation_id',
49981
+ 'reservation_key',
49982
+ 'name',
49983
+ 'starts_at',
49984
+ 'ends_at',
49985
+ 'created_at',
49986
+ 'guest_name',
49987
+ 'access_methods',
49988
+ ],
49989
+ type: 'object',
49990
+ },
49991
+ },
49992
+ required: ['reservation', 'ok'],
49993
+ type: 'object',
49994
+ },
49995
+ },
49996
+ },
49997
+ description: 'OK',
49998
+ },
49999
+ 400: { description: 'Bad Request' },
50000
+ 401: { description: 'Unauthorized' },
50001
+ },
50002
+ security: [{ client_session_with_customer: [] }],
50003
+ summary: '/seam/customer/v1/reservations/get',
50004
+ tags: [],
50005
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
50006
+ 'x-fern-sdk-method-name': 'get',
50007
+ 'x-fern-sdk-return-value': 'reservation',
50008
+ 'x-response-key': 'reservation',
50009
+ 'x-title': 'Get Reservation for Customer',
50010
+ 'x-undocumented': 'Internal endpoint for customer portals.',
50011
+ },
50012
+ },
49840
50013
  '/seam/customer/v1/reservations/list': {
49841
50014
  get: {
49842
50015
  description:
@@ -49851,6 +50024,15 @@ export default {
49851
50024
  type: 'string',
49852
50025
  },
49853
50026
  },
50027
+ {
50028
+ in: 'query',
50029
+ name: 'space_id',
50030
+ schema: {
50031
+ description: 'Filter reservations by space ID (UUID).',
50032
+ format: 'uuid',
50033
+ type: 'string',
50034
+ },
50035
+ },
49854
50036
  {
49855
50037
  in: 'query',
49856
50038
  name: 'limit',
@@ -49980,6 +50162,11 @@ export default {
49980
50162
  nullable: true,
49981
50163
  type: 'string',
49982
50164
  },
50165
+ space_id: {
50166
+ description: 'Filter reservations by space ID (UUID).',
50167
+ format: 'uuid',
50168
+ type: 'string',
50169
+ },
49983
50170
  space_key: {
49984
50171
  description: 'Filter reservations by space key.',
49985
50172
  type: 'string',
@@ -69109,6 +69109,35 @@ export type Routes = {
69109
69109
  }
69110
69110
  }
69111
69111
  }
69112
+ '/seam/customer/v1/reservations/get': {
69113
+ route: '/seam/customer/v1/reservations/get'
69114
+ method: 'GET' | 'POST'
69115
+ queryParams: {}
69116
+ jsonBody: {}
69117
+ commonParams: {
69118
+ /** ID of the reservation to retrieve. */
69119
+ reservation_id?: string | undefined
69120
+ /** Key of the reservation to retrieve. */
69121
+ reservation_key?: string | undefined
69122
+ }
69123
+ formData: {}
69124
+ jsonResponse: {
69125
+ reservation: {
69126
+ reservation_id: string
69127
+ reservation_key: string
69128
+ name: string | null
69129
+ starts_at: string | null
69130
+ ends_at: string | null
69131
+ created_at: string
69132
+ guest_name: string | null
69133
+ access_methods: {
69134
+ access_method_id: string
69135
+ mode: string
69136
+ is_issued: boolean
69137
+ }[]
69138
+ }
69139
+ }
69140
+ }
69112
69141
  '/seam/customer/v1/reservations/list': {
69113
69142
  route: '/seam/customer/v1/reservations/list'
69114
69143
  method: 'GET' | 'POST'
@@ -69117,6 +69146,8 @@ export type Routes = {
69117
69146
  commonParams: {
69118
69147
  /** Filter reservations by space key. */
69119
69148
  space_key?: string | undefined
69149
+ /** Filter reservations by space ID (UUID). */
69150
+ space_id?: string | undefined
69120
69151
  /** Maximum number of records to return per page. */
69121
69152
  limit?: number
69122
69153
  /** Timestamp by which to limit returned reservations. Returns reservations created before this timestamp. */