@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.
@@ -45679,6 +45679,280 @@ export default {
45679
45679
  'x-undocumented': 'Seam Instant Key only.',
45680
45680
  },
45681
45681
  },
45682
+ '/seam/instant_key/v1/preview/get': {
45683
+ get: {
45684
+ operationId: 'seamInstantKeyV1PreviewGetGet',
45685
+ requestBody: {
45686
+ content: {
45687
+ 'application/json': {
45688
+ schema: {
45689
+ properties: {
45690
+ instant_key_url: {
45691
+ description: 'The short code of the instant key to preview.',
45692
+ type: 'string',
45693
+ },
45694
+ },
45695
+ required: ['instant_key_url'],
45696
+ type: 'object',
45697
+ },
45698
+ },
45699
+ },
45700
+ },
45701
+ responses: {
45702
+ 200: {
45703
+ content: {
45704
+ 'application/json': {
45705
+ schema: {
45706
+ properties: {
45707
+ instant_key_preview: {
45708
+ description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
45709
+ properties: {
45710
+ access: {
45711
+ items: {
45712
+ properties: {
45713
+ available: { type: 'boolean' },
45714
+ hours: { type: 'string' },
45715
+ icon: { type: 'string' },
45716
+ location: { type: 'string' },
45717
+ name: { type: 'string' },
45718
+ },
45719
+ required: ['name', 'icon', 'available'],
45720
+ type: 'object',
45721
+ },
45722
+ type: 'array',
45723
+ },
45724
+ created_at: { type: 'string' },
45725
+ expires_at: { type: 'string' },
45726
+ guest: {
45727
+ properties: {
45728
+ check_in_date: { type: 'string' },
45729
+ check_out_date: { type: 'string' },
45730
+ email: { type: 'string' },
45731
+ first_name: { type: 'string' },
45732
+ full_name: { type: 'string' },
45733
+ last_name: { type: 'string' },
45734
+ },
45735
+ required: [
45736
+ 'first_name',
45737
+ 'last_name',
45738
+ 'full_name',
45739
+ 'email',
45740
+ 'check_in_date',
45741
+ 'check_out_date',
45742
+ ],
45743
+ type: 'object',
45744
+ },
45745
+ hotel: {
45746
+ properties: {
45747
+ accent_color: { type: 'string' },
45748
+ hotel_name: { type: 'string' },
45749
+ logo_url: { type: 'string' },
45750
+ primary_color: { type: 'string' },
45751
+ secondary_color: { type: 'string' },
45752
+ verified: { type: 'boolean' },
45753
+ },
45754
+ required: [
45755
+ 'hotel_name',
45756
+ 'primary_color',
45757
+ 'accent_color',
45758
+ 'secondary_color',
45759
+ 'verified',
45760
+ ],
45761
+ type: 'object',
45762
+ },
45763
+ key_status: {
45764
+ enum: ['ready', 'expired', 'used'],
45765
+ type: 'string',
45766
+ },
45767
+ room: {
45768
+ properties: {
45769
+ floor: { format: 'float', type: 'number' },
45770
+ room_number: { type: 'string' },
45771
+ room_type: { type: 'string' },
45772
+ },
45773
+ required: ['room_number', 'room_type', 'floor'],
45774
+ type: 'object',
45775
+ },
45776
+ shortcode: { type: 'string' },
45777
+ support_email: { type: 'string' },
45778
+ support_phone: { type: 'string' },
45779
+ updated_at: { type: 'string' },
45780
+ },
45781
+ required: [
45782
+ 'shortcode',
45783
+ 'hotel',
45784
+ 'guest',
45785
+ 'room',
45786
+ 'access',
45787
+ 'key_status',
45788
+ 'support_phone',
45789
+ 'support_email',
45790
+ 'created_at',
45791
+ 'updated_at',
45792
+ 'expires_at',
45793
+ ],
45794
+ type: 'object',
45795
+ 'x-route-path': '/instant_keys/preview',
45796
+ },
45797
+ ok: { type: 'boolean' },
45798
+ },
45799
+ required: ['instant_key_preview', 'ok'],
45800
+ type: 'object',
45801
+ },
45802
+ },
45803
+ },
45804
+ description: 'OK',
45805
+ },
45806
+ 400: { description: 'Bad Request' },
45807
+ 401: { description: 'Unauthorized' },
45808
+ },
45809
+ security: [{ certified_client: [] }],
45810
+ summary: '/seam/instant_key/v1/preview/get',
45811
+ tags: [],
45812
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
45813
+ 'x-fern-sdk-method-name': 'get',
45814
+ 'x-fern-sdk-return-value': 'instant_key_preview',
45815
+ 'x-response-key': 'instant_key_preview',
45816
+ 'x-title': 'Preview Instant Key',
45817
+ 'x-undocumented': 'Seam Instant Key only.',
45818
+ },
45819
+ post: {
45820
+ operationId: 'seamInstantKeyV1PreviewGetPost',
45821
+ requestBody: {
45822
+ content: {
45823
+ 'application/json': {
45824
+ schema: {
45825
+ properties: {
45826
+ instant_key_url: {
45827
+ description: 'The short code of the instant key to preview.',
45828
+ type: 'string',
45829
+ },
45830
+ },
45831
+ required: ['instant_key_url'],
45832
+ type: 'object',
45833
+ },
45834
+ },
45835
+ },
45836
+ },
45837
+ responses: {
45838
+ 200: {
45839
+ content: {
45840
+ 'application/json': {
45841
+ schema: {
45842
+ properties: {
45843
+ instant_key_preview: {
45844
+ description: 'Represents a preview of an Instant Key with hotel, guest, and access information.',
45845
+ properties: {
45846
+ access: {
45847
+ items: {
45848
+ properties: {
45849
+ available: { type: 'boolean' },
45850
+ hours: { type: 'string' },
45851
+ icon: { type: 'string' },
45852
+ location: { type: 'string' },
45853
+ name: { type: 'string' },
45854
+ },
45855
+ required: ['name', 'icon', 'available'],
45856
+ type: 'object',
45857
+ },
45858
+ type: 'array',
45859
+ },
45860
+ created_at: { type: 'string' },
45861
+ expires_at: { type: 'string' },
45862
+ guest: {
45863
+ properties: {
45864
+ check_in_date: { type: 'string' },
45865
+ check_out_date: { type: 'string' },
45866
+ email: { type: 'string' },
45867
+ first_name: { type: 'string' },
45868
+ full_name: { type: 'string' },
45869
+ last_name: { type: 'string' },
45870
+ },
45871
+ required: [
45872
+ 'first_name',
45873
+ 'last_name',
45874
+ 'full_name',
45875
+ 'email',
45876
+ 'check_in_date',
45877
+ 'check_out_date',
45878
+ ],
45879
+ type: 'object',
45880
+ },
45881
+ hotel: {
45882
+ properties: {
45883
+ accent_color: { type: 'string' },
45884
+ hotel_name: { type: 'string' },
45885
+ logo_url: { type: 'string' },
45886
+ primary_color: { type: 'string' },
45887
+ secondary_color: { type: 'string' },
45888
+ verified: { type: 'boolean' },
45889
+ },
45890
+ required: [
45891
+ 'hotel_name',
45892
+ 'primary_color',
45893
+ 'accent_color',
45894
+ 'secondary_color',
45895
+ 'verified',
45896
+ ],
45897
+ type: 'object',
45898
+ },
45899
+ key_status: {
45900
+ enum: ['ready', 'expired', 'used'],
45901
+ type: 'string',
45902
+ },
45903
+ room: {
45904
+ properties: {
45905
+ floor: { format: 'float', type: 'number' },
45906
+ room_number: { type: 'string' },
45907
+ room_type: { type: 'string' },
45908
+ },
45909
+ required: ['room_number', 'room_type', 'floor'],
45910
+ type: 'object',
45911
+ },
45912
+ shortcode: { type: 'string' },
45913
+ support_email: { type: 'string' },
45914
+ support_phone: { type: 'string' },
45915
+ updated_at: { type: 'string' },
45916
+ },
45917
+ required: [
45918
+ 'shortcode',
45919
+ 'hotel',
45920
+ 'guest',
45921
+ 'room',
45922
+ 'access',
45923
+ 'key_status',
45924
+ 'support_phone',
45925
+ 'support_email',
45926
+ 'created_at',
45927
+ 'updated_at',
45928
+ 'expires_at',
45929
+ ],
45930
+ type: 'object',
45931
+ 'x-route-path': '/instant_keys/preview',
45932
+ },
45933
+ ok: { type: 'boolean' },
45934
+ },
45935
+ required: ['instant_key_preview', 'ok'],
45936
+ type: 'object',
45937
+ },
45938
+ },
45939
+ },
45940
+ description: 'OK',
45941
+ },
45942
+ 400: { description: 'Bad Request' },
45943
+ 401: { description: 'Unauthorized' },
45944
+ },
45945
+ security: [{ certified_client: [] }],
45946
+ summary: '/seam/instant_key/v1/preview/get',
45947
+ tags: [],
45948
+ 'x-fern-sdk-group-name': ['seam', 'instant_key', 'v1', 'preview'],
45949
+ 'x-fern-sdk-method-name': 'get',
45950
+ 'x-fern-sdk-return-value': 'instant_key_preview',
45951
+ 'x-response-key': 'instant_key_preview',
45952
+ 'x-title': 'Preview Instant Key',
45953
+ 'x-undocumented': 'Seam Instant Key only.',
45954
+ },
45955
+ },
45682
45956
  '/seam/mobile_sdk/v1/acs/credentials/list': {
45683
45957
  get: {
45684
45958
  description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',