@seamapi/types 1.535.0 → 1.536.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.
@@ -57749,6 +57749,57 @@ export type Routes = {
57749
57749
  };
57750
57750
  };
57751
57751
  };
57752
+ '/seam/instant_key/v1/preview/get': {
57753
+ route: '/seam/instant_key/v1/preview/get';
57754
+ method: 'GET' | 'POST';
57755
+ queryParams: {};
57756
+ jsonBody: {
57757
+ /** The short code of the instant key to preview. */
57758
+ instant_key_url: string;
57759
+ };
57760
+ commonParams: {};
57761
+ formData: {};
57762
+ jsonResponse: {
57763
+ /** Represents a preview of an Instant Key with hotel, guest, and access information. */
57764
+ instant_key_preview: {
57765
+ shortcode: string;
57766
+ hotel: {
57767
+ hotel_name: string;
57768
+ primary_color: string;
57769
+ accent_color: string;
57770
+ secondary_color: string;
57771
+ logo_url?: string | undefined;
57772
+ verified: boolean;
57773
+ };
57774
+ guest: {
57775
+ first_name: string;
57776
+ last_name: string;
57777
+ full_name: string;
57778
+ email: string;
57779
+ check_in_date: string;
57780
+ check_out_date: string;
57781
+ };
57782
+ room: {
57783
+ room_number: string;
57784
+ room_type: string;
57785
+ floor: number;
57786
+ };
57787
+ access: {
57788
+ name: string;
57789
+ icon: string;
57790
+ hours?: string | undefined;
57791
+ location?: string | undefined;
57792
+ available: boolean;
57793
+ }[];
57794
+ key_status: 'ready' | 'expired' | 'used';
57795
+ support_phone: string;
57796
+ support_email: string;
57797
+ created_at: string;
57798
+ updated_at: string;
57799
+ expires_at: string;
57800
+ };
57801
+ };
57802
+ };
57752
57803
  '/seam/mobile_sdk/v1/acs/credentials/list': {
57753
57804
  route: '/seam/mobile_sdk/v1/acs/credentials/list';
57754
57805
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.535.0",
3
+ "version": "1.536.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -51,6 +51,7 @@ export {
51
51
  fan_mode_setting,
52
52
  guest_resource,
53
53
  instant_key,
54
+ instant_key_preview,
54
55
  listing_resource,
55
56
  lock_device_type,
56
57
  magic_link,
@@ -1 +1,2 @@
1
1
  export * from './instant-key.js'
2
+ export * from './instant-key-preview.js'
@@ -0,0 +1,58 @@
1
+ import { z } from 'zod'
2
+
3
+ const instant_key_preview_hotel = z.object({
4
+ hotel_name: z.string(),
5
+ primary_color: z.string(),
6
+ accent_color: z.string(),
7
+ secondary_color: z.string(),
8
+ logo_url: z.string().optional(),
9
+ verified: z.boolean(),
10
+ })
11
+
12
+ const instant_key_preview_guest = z.object({
13
+ first_name: z.string(),
14
+ last_name: z.string(),
15
+ full_name: z.string(),
16
+ email: z.string(),
17
+ check_in_date: z.string(),
18
+ check_out_date: z.string(),
19
+ })
20
+
21
+ const instant_key_preview_room = z.object({
22
+ room_number: z.string(),
23
+ room_type: z.string(),
24
+ floor: z.number(),
25
+ })
26
+
27
+ const instant_key_preview_access = z.object({
28
+ name: z.string(),
29
+ icon: z.string(),
30
+ hours: z.string().optional(),
31
+ location: z.string().optional(),
32
+ available: z.boolean(),
33
+ })
34
+
35
+ export const instant_key_preview = z.object({
36
+ shortcode: z.string(),
37
+ hotel: instant_key_preview_hotel,
38
+ guest: instant_key_preview_guest,
39
+ room: instant_key_preview_room,
40
+ access: z.array(instant_key_preview_access),
41
+ key_status: z.enum(['ready', 'expired', 'used']),
42
+ support_phone: z.string(),
43
+ support_email: z.string(),
44
+ created_at: z.string(),
45
+ updated_at: z.string(),
46
+ expires_at: z.string(),
47
+ }).describe(`
48
+ ---
49
+ route_path: /instant_keys/preview
50
+ ---
51
+ Represents a preview of an Instant Key with hotel, guest, and access information.
52
+ `)
53
+
54
+ export type InstantKeyPreview = z.infer<typeof instant_key_preview>
55
+ export type InstantKeyPreviewHotel = z.infer<typeof instant_key_preview_hotel>
56
+ export type InstantKeyPreviewGuest = z.infer<typeof instant_key_preview_guest>
57
+ export type InstantKeyPreviewRoom = z.infer<typeof instant_key_preview_room>
58
+ export type InstantKeyPreviewAccess = z.infer<typeof instant_key_preview_access>
@@ -49601,6 +49601,284 @@ export default {
49601
49601
  'x-undocumented': 'Seam Instant Key only.',
49602
49602
  },
49603
49603
  },
49604
+ '/seam/instant_key/v1/preview/get': {
49605
+ get: {
49606
+ operationId: 'seamInstantKeyV1PreviewGetGet',
49607
+ requestBody: {
49608
+ content: {
49609
+ 'application/json': {
49610
+ schema: {
49611
+ properties: {
49612
+ instant_key_url: {
49613
+ description:
49614
+ 'The short code of the instant key to preview.',
49615
+ type: 'string',
49616
+ },
49617
+ },
49618
+ required: ['instant_key_url'],
49619
+ type: 'object',
49620
+ },
49621
+ },
49622
+ },
49623
+ },
49624
+ responses: {
49625
+ 200: {
49626
+ content: {
49627
+ 'application/json': {
49628
+ schema: {
49629
+ properties: {
49630
+ instant_key_preview: {
49631
+ description:
49632
+ 'Represents a preview of an Instant Key with hotel, guest, and access information.',
49633
+ properties: {
49634
+ access: {
49635
+ items: {
49636
+ properties: {
49637
+ available: { type: 'boolean' },
49638
+ hours: { type: 'string' },
49639
+ icon: { type: 'string' },
49640
+ location: { type: 'string' },
49641
+ name: { type: 'string' },
49642
+ },
49643
+ required: ['name', 'icon', 'available'],
49644
+ type: 'object',
49645
+ },
49646
+ type: 'array',
49647
+ },
49648
+ created_at: { type: 'string' },
49649
+ expires_at: { type: 'string' },
49650
+ guest: {
49651
+ properties: {
49652
+ check_in_date: { type: 'string' },
49653
+ check_out_date: { type: 'string' },
49654
+ email: { type: 'string' },
49655
+ first_name: { type: 'string' },
49656
+ full_name: { type: 'string' },
49657
+ last_name: { type: 'string' },
49658
+ },
49659
+ required: [
49660
+ 'first_name',
49661
+ 'last_name',
49662
+ 'full_name',
49663
+ 'email',
49664
+ 'check_in_date',
49665
+ 'check_out_date',
49666
+ ],
49667
+ type: 'object',
49668
+ },
49669
+ hotel: {
49670
+ properties: {
49671
+ accent_color: { type: 'string' },
49672
+ hotel_name: { type: 'string' },
49673
+ logo_url: { type: 'string' },
49674
+ primary_color: { type: 'string' },
49675
+ secondary_color: { type: 'string' },
49676
+ verified: { type: 'boolean' },
49677
+ },
49678
+ required: [
49679
+ 'hotel_name',
49680
+ 'primary_color',
49681
+ 'accent_color',
49682
+ 'secondary_color',
49683
+ 'verified',
49684
+ ],
49685
+ type: 'object',
49686
+ },
49687
+ key_status: {
49688
+ enum: ['ready', 'expired', 'used'],
49689
+ type: 'string',
49690
+ },
49691
+ room: {
49692
+ properties: {
49693
+ floor: { format: 'float', type: 'number' },
49694
+ room_number: { type: 'string' },
49695
+ room_type: { type: 'string' },
49696
+ },
49697
+ required: ['room_number', 'room_type', 'floor'],
49698
+ type: 'object',
49699
+ },
49700
+ shortcode: { type: 'string' },
49701
+ support_email: { type: 'string' },
49702
+ support_phone: { type: 'string' },
49703
+ updated_at: { type: 'string' },
49704
+ },
49705
+ required: [
49706
+ 'shortcode',
49707
+ 'hotel',
49708
+ 'guest',
49709
+ 'room',
49710
+ 'access',
49711
+ 'key_status',
49712
+ 'support_phone',
49713
+ 'support_email',
49714
+ 'created_at',
49715
+ 'updated_at',
49716
+ 'expires_at',
49717
+ ],
49718
+ type: 'object',
49719
+ 'x-route-path': '/instant_keys/preview',
49720
+ },
49721
+ ok: { type: 'boolean' },
49722
+ },
49723
+ required: ['instant_key_preview', 'ok'],
49724
+ type: 'object',
49725
+ },
49726
+ },
49727
+ },
49728
+ description: 'OK',
49729
+ },
49730
+ 400: { description: 'Bad Request' },
49731
+ 401: { description: 'Unauthorized' },
49732
+ },
49733
+ security: [{ certified_client: [] }],
49734
+ summary: '/seam/instant_key/v1/preview/get',
49735
+ tags: [],
49736
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
49737
+ 'x-fern-sdk-method-name': 'get',
49738
+ 'x-fern-sdk-return-value': 'instant_key_preview',
49739
+ 'x-response-key': 'instant_key_preview',
49740
+ 'x-title': 'Preview Instant Key',
49741
+ 'x-undocumented': 'Seam Instant Key only.',
49742
+ },
49743
+ post: {
49744
+ operationId: 'seamInstantKeyV1PreviewGetPost',
49745
+ requestBody: {
49746
+ content: {
49747
+ 'application/json': {
49748
+ schema: {
49749
+ properties: {
49750
+ instant_key_url: {
49751
+ description:
49752
+ 'The short code of the instant key to preview.',
49753
+ type: 'string',
49754
+ },
49755
+ },
49756
+ required: ['instant_key_url'],
49757
+ type: 'object',
49758
+ },
49759
+ },
49760
+ },
49761
+ },
49762
+ responses: {
49763
+ 200: {
49764
+ content: {
49765
+ 'application/json': {
49766
+ schema: {
49767
+ properties: {
49768
+ instant_key_preview: {
49769
+ description:
49770
+ 'Represents a preview of an Instant Key with hotel, guest, and access information.',
49771
+ properties: {
49772
+ access: {
49773
+ items: {
49774
+ properties: {
49775
+ available: { type: 'boolean' },
49776
+ hours: { type: 'string' },
49777
+ icon: { type: 'string' },
49778
+ location: { type: 'string' },
49779
+ name: { type: 'string' },
49780
+ },
49781
+ required: ['name', 'icon', 'available'],
49782
+ type: 'object',
49783
+ },
49784
+ type: 'array',
49785
+ },
49786
+ created_at: { type: 'string' },
49787
+ expires_at: { type: 'string' },
49788
+ guest: {
49789
+ properties: {
49790
+ check_in_date: { type: 'string' },
49791
+ check_out_date: { type: 'string' },
49792
+ email: { type: 'string' },
49793
+ first_name: { type: 'string' },
49794
+ full_name: { type: 'string' },
49795
+ last_name: { type: 'string' },
49796
+ },
49797
+ required: [
49798
+ 'first_name',
49799
+ 'last_name',
49800
+ 'full_name',
49801
+ 'email',
49802
+ 'check_in_date',
49803
+ 'check_out_date',
49804
+ ],
49805
+ type: 'object',
49806
+ },
49807
+ hotel: {
49808
+ properties: {
49809
+ accent_color: { type: 'string' },
49810
+ hotel_name: { type: 'string' },
49811
+ logo_url: { type: 'string' },
49812
+ primary_color: { type: 'string' },
49813
+ secondary_color: { type: 'string' },
49814
+ verified: { type: 'boolean' },
49815
+ },
49816
+ required: [
49817
+ 'hotel_name',
49818
+ 'primary_color',
49819
+ 'accent_color',
49820
+ 'secondary_color',
49821
+ 'verified',
49822
+ ],
49823
+ type: 'object',
49824
+ },
49825
+ key_status: {
49826
+ enum: ['ready', 'expired', 'used'],
49827
+ type: 'string',
49828
+ },
49829
+ room: {
49830
+ properties: {
49831
+ floor: { format: 'float', type: 'number' },
49832
+ room_number: { type: 'string' },
49833
+ room_type: { type: 'string' },
49834
+ },
49835
+ required: ['room_number', 'room_type', 'floor'],
49836
+ type: 'object',
49837
+ },
49838
+ shortcode: { type: 'string' },
49839
+ support_email: { type: 'string' },
49840
+ support_phone: { type: 'string' },
49841
+ updated_at: { type: 'string' },
49842
+ },
49843
+ required: [
49844
+ 'shortcode',
49845
+ 'hotel',
49846
+ 'guest',
49847
+ 'room',
49848
+ 'access',
49849
+ 'key_status',
49850
+ 'support_phone',
49851
+ 'support_email',
49852
+ 'created_at',
49853
+ 'updated_at',
49854
+ 'expires_at',
49855
+ ],
49856
+ type: 'object',
49857
+ 'x-route-path': '/instant_keys/preview',
49858
+ },
49859
+ ok: { type: 'boolean' },
49860
+ },
49861
+ required: ['instant_key_preview', 'ok'],
49862
+ type: 'object',
49863
+ },
49864
+ },
49865
+ },
49866
+ description: 'OK',
49867
+ },
49868
+ 400: { description: 'Bad Request' },
49869
+ 401: { description: 'Unauthorized' },
49870
+ },
49871
+ security: [{ certified_client: [] }],
49872
+ summary: '/seam/instant_key/v1/preview/get',
49873
+ tags: [],
49874
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
49875
+ 'x-fern-sdk-method-name': 'get',
49876
+ 'x-fern-sdk-return-value': 'instant_key_preview',
49877
+ 'x-response-key': 'instant_key_preview',
49878
+ 'x-title': 'Preview Instant Key',
49879
+ 'x-undocumented': 'Seam Instant Key only.',
49880
+ },
49881
+ },
49604
49882
  '/seam/mobile_sdk/v1/acs/credentials/list': {
49605
49883
  get: {
49606
49884
  description:
@@ -68720,6 +68720,57 @@ export type Routes = {
68720
68720
  }
68721
68721
  }
68722
68722
  }
68723
+ '/seam/instant_key/v1/preview/get': {
68724
+ route: '/seam/instant_key/v1/preview/get'
68725
+ method: 'GET' | 'POST'
68726
+ queryParams: {}
68727
+ jsonBody: {
68728
+ /** The short code of the instant key to preview. */
68729
+ instant_key_url: string
68730
+ }
68731
+ commonParams: {}
68732
+ formData: {}
68733
+ jsonResponse: {
68734
+ /** Represents a preview of an Instant Key with hotel, guest, and access information. */
68735
+ instant_key_preview: {
68736
+ shortcode: string
68737
+ hotel: {
68738
+ hotel_name: string
68739
+ primary_color: string
68740
+ accent_color: string
68741
+ secondary_color: string
68742
+ logo_url?: string | undefined
68743
+ verified: boolean
68744
+ }
68745
+ guest: {
68746
+ first_name: string
68747
+ last_name: string
68748
+ full_name: string
68749
+ email: string
68750
+ check_in_date: string
68751
+ check_out_date: string
68752
+ }
68753
+ room: {
68754
+ room_number: string
68755
+ room_type: string
68756
+ floor: number
68757
+ }
68758
+ access: {
68759
+ name: string
68760
+ icon: string
68761
+ hours?: string | undefined
68762
+ location?: string | undefined
68763
+ available: boolean
68764
+ }[]
68765
+ key_status: 'ready' | 'expired' | 'used'
68766
+ support_phone: string
68767
+ support_email: string
68768
+ created_at: string
68769
+ updated_at: string
68770
+ expires_at: string
68771
+ }
68772
+ }
68773
+ }
68723
68774
  '/seam/mobile_sdk/v1/acs/credentials/list': {
68724
68775
  route: '/seam/mobile_sdk/v1/acs/credentials/list'
68725
68776
  method: 'GET' | 'POST'