@seamapi/types 1.598.0 → 1.600.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.
@@ -82958,10 +82958,11 @@ declare const _default: {
82958
82958
  connect: {
82959
82959
  exclude: boolean;
82960
82960
  };
82961
- manage_devices: {
82961
+ manage: {
82962
82962
  exclude: boolean;
82963
+ exclude_reservation_management: boolean;
82963
82964
  };
82964
- manage_reservations: {
82965
+ manage_devices: {
82965
82966
  exclude: boolean;
82966
82967
  };
82967
82968
  organize: {
@@ -83023,33 +83024,24 @@ declare const _default: {
83023
83024
  };
83024
83025
  type: string;
83025
83026
  };
83026
- manage_devices: {
83027
+ manage: {
83027
83028
  default: {};
83028
83029
  description: string;
83029
83030
  properties: {
83030
- accepted_providers: {
83031
- description: string;
83032
- items: {
83033
- type: string;
83034
- };
83035
- type: string;
83036
- };
83037
83031
  exclude: {
83038
83032
  default: boolean;
83039
83033
  description: string;
83040
83034
  type: string;
83041
83035
  };
83042
- excluded_providers: {
83036
+ exclude_reservation_management: {
83037
+ default: boolean;
83043
83038
  description: string;
83044
- items: {
83045
- type: string;
83046
- };
83047
83039
  type: string;
83048
83040
  };
83049
83041
  };
83050
83042
  type: string;
83051
83043
  };
83052
- manage_reservations: {
83044
+ manage_devices: {
83053
83045
  default: {};
83054
83046
  description: string;
83055
83047
  properties: {
@@ -83058,20 +83050,6 @@ declare const _default: {
83058
83050
  description: string;
83059
83051
  type: string;
83060
83052
  };
83061
- reservations: {
83062
- default: {
83063
- exclude: boolean;
83064
- };
83065
- description: string;
83066
- properties: {
83067
- exclude: {
83068
- default: boolean;
83069
- description: string;
83070
- type: string;
83071
- };
83072
- };
83073
- type: string;
83074
- };
83075
83053
  };
83076
83054
  type: string;
83077
83055
  };
@@ -93513,6 +93491,218 @@ declare const _default: {
93513
93491
  'x-undocumented': string;
93514
93492
  };
93515
93493
  };
93494
+ '/seam/customer/v1/connectors/create': {
93495
+ post: {
93496
+ description: string;
93497
+ operationId: string;
93498
+ requestBody: {
93499
+ content: {
93500
+ 'application/json': {
93501
+ schema: {
93502
+ properties: {
93503
+ config: {
93504
+ description: string;
93505
+ oneOf: ({
93506
+ properties: {
93507
+ access_token: {
93508
+ minLength: number;
93509
+ type: string;
93510
+ };
93511
+ client: {
93512
+ minLength: number;
93513
+ type: string;
93514
+ };
93515
+ client_token: {
93516
+ minLength: number;
93517
+ type: string;
93518
+ };
93519
+ enterprise_ids: {
93520
+ items: {
93521
+ format: string;
93522
+ type: string;
93523
+ };
93524
+ type: string;
93525
+ };
93526
+ };
93527
+ required: string[];
93528
+ type: string;
93529
+ } | {
93530
+ properties: {
93531
+ access_token?: never;
93532
+ client?: never;
93533
+ client_token?: never;
93534
+ enterprise_ids?: never;
93535
+ };
93536
+ type: string;
93537
+ required?: never;
93538
+ })[];
93539
+ };
93540
+ connector_type: {
93541
+ description: string;
93542
+ enum: string[];
93543
+ type: string;
93544
+ };
93545
+ customer_key: {
93546
+ description: string;
93547
+ minLength: number;
93548
+ type: string;
93549
+ };
93550
+ };
93551
+ required: string[];
93552
+ type: string;
93553
+ };
93554
+ };
93555
+ };
93556
+ };
93557
+ responses: {
93558
+ 200: {
93559
+ content: {
93560
+ 'application/json': {
93561
+ schema: {
93562
+ properties: {
93563
+ connector: {
93564
+ properties: {
93565
+ connector_id: {
93566
+ type: string;
93567
+ };
93568
+ connector_type: {
93569
+ type: string;
93570
+ };
93571
+ error: {
93572
+ type: string;
93573
+ };
93574
+ status: {
93575
+ enum: string[];
93576
+ type: string;
93577
+ };
93578
+ webhook_subscription: {
93579
+ properties: {
93580
+ events: {
93581
+ items: {
93582
+ type: string;
93583
+ };
93584
+ type: string;
93585
+ };
93586
+ status: {
93587
+ enum: string[];
93588
+ type: string;
93589
+ };
93590
+ subscription_id: {
93591
+ type: string;
93592
+ };
93593
+ webhook_url: {
93594
+ type: string;
93595
+ };
93596
+ };
93597
+ required: string[];
93598
+ type: string;
93599
+ };
93600
+ };
93601
+ required: string[];
93602
+ type: string;
93603
+ };
93604
+ ok: {
93605
+ type: string;
93606
+ };
93607
+ };
93608
+ required: string[];
93609
+ type: string;
93610
+ };
93611
+ };
93612
+ };
93613
+ description: string;
93614
+ };
93615
+ 400: {
93616
+ description: string;
93617
+ };
93618
+ 401: {
93619
+ description: string;
93620
+ };
93621
+ };
93622
+ security: {
93623
+ api_key: never[];
93624
+ }[];
93625
+ summary: string;
93626
+ tags: never[];
93627
+ 'x-fern-sdk-group-name': string[];
93628
+ 'x-fern-sdk-method-name': string;
93629
+ 'x-fern-sdk-return-value': string;
93630
+ 'x-response-key': string;
93631
+ 'x-title': string;
93632
+ };
93633
+ };
93634
+ '/seam/customer/v1/connectors/sync': {
93635
+ post: {
93636
+ description: string;
93637
+ operationId: string;
93638
+ requestBody: {
93639
+ content: {
93640
+ 'application/json': {
93641
+ schema: {
93642
+ properties: {
93643
+ connector_id: {
93644
+ description: string;
93645
+ format: string;
93646
+ type: string;
93647
+ };
93648
+ };
93649
+ required: string[];
93650
+ type: string;
93651
+ };
93652
+ };
93653
+ };
93654
+ };
93655
+ responses: {
93656
+ 200: {
93657
+ content: {
93658
+ 'application/json': {
93659
+ schema: {
93660
+ properties: {
93661
+ connector_sync: {
93662
+ properties: {
93663
+ connector_id: {
93664
+ type: string;
93665
+ };
93666
+ message: {
93667
+ type: string;
93668
+ };
93669
+ status: {
93670
+ type: string;
93671
+ };
93672
+ };
93673
+ required: string[];
93674
+ type: string;
93675
+ };
93676
+ ok: {
93677
+ type: string;
93678
+ };
93679
+ };
93680
+ required: string[];
93681
+ type: string;
93682
+ };
93683
+ };
93684
+ };
93685
+ description: string;
93686
+ };
93687
+ 400: {
93688
+ description: string;
93689
+ };
93690
+ 401: {
93691
+ description: string;
93692
+ };
93693
+ };
93694
+ security: {
93695
+ api_key: never[];
93696
+ }[];
93697
+ summary: string;
93698
+ tags: never[];
93699
+ 'x-fern-sdk-group-name': string[];
93700
+ 'x-fern-sdk-method-name': string;
93701
+ 'x-fern-sdk-return-value': string;
93702
+ 'x-response-key': string;
93703
+ 'x-title': string;
93704
+ };
93705
+ };
93516
93706
  '/seam/customer/v1/events/list': {
93517
93707
  get: {
93518
93708
  description: string;
@@ -93843,35 +94033,26 @@ declare const _default: {
93843
94033
  };
93844
94034
  type: string;
93845
94035
  };
93846
- manage_devices: {
94036
+ manage: {
93847
94037
  default: {
93848
94038
  $ref: string;
93849
94039
  };
93850
94040
  description: string;
93851
94041
  properties: {
93852
- accepted_providers: {
93853
- description: string;
93854
- items: {
93855
- type: string;
93856
- };
93857
- type: string;
93858
- };
93859
94042
  exclude: {
93860
94043
  default: boolean;
93861
94044
  description: string;
93862
94045
  type: string;
93863
94046
  };
93864
- excluded_providers: {
94047
+ exclude_reservation_management: {
94048
+ default: boolean;
93865
94049
  description: string;
93866
- items: {
93867
- type: string;
93868
- };
93869
94050
  type: string;
93870
94051
  };
93871
94052
  };
93872
94053
  type: string;
93873
94054
  };
93874
- manage_reservations: {
94055
+ manage_devices: {
93875
94056
  default: {
93876
94057
  $ref: string;
93877
94058
  };
@@ -93882,20 +94063,6 @@ declare const _default: {
93882
94063
  description: string;
93883
94064
  type: string;
93884
94065
  };
93885
- reservations: {
93886
- default: {
93887
- exclude: boolean;
93888
- };
93889
- description: string;
93890
- properties: {
93891
- exclude: {
93892
- default: boolean;
93893
- description: string;
93894
- type: string;
93895
- };
93896
- };
93897
- type: string;
93898
- };
93899
94066
  };
93900
94067
  type: string;
93901
94068
  };
@@ -94257,35 +94424,26 @@ declare const _default: {
94257
94424
  };
94258
94425
  type: string;
94259
94426
  };
94260
- manage_devices: {
94427
+ manage: {
94261
94428
  default: {
94262
94429
  $ref: string;
94263
94430
  };
94264
94431
  description: string;
94265
94432
  properties: {
94266
- accepted_providers: {
94267
- description: string;
94268
- items: {
94269
- type: string;
94270
- };
94271
- type: string;
94272
- };
94273
94433
  exclude: {
94274
94434
  default: boolean;
94275
94435
  description: string;
94276
94436
  type: string;
94277
94437
  };
94278
- excluded_providers: {
94438
+ exclude_reservation_management: {
94439
+ default: boolean;
94279
94440
  description: string;
94280
- items: {
94281
- type: string;
94282
- };
94283
94441
  type: string;
94284
94442
  };
94285
94443
  };
94286
94444
  type: string;
94287
94445
  };
94288
- manage_reservations: {
94446
+ manage_devices: {
94289
94447
  default: {
94290
94448
  $ref: string;
94291
94449
  };
@@ -94296,20 +94454,6 @@ declare const _default: {
94296
94454
  description: string;
94297
94455
  type: string;
94298
94456
  };
94299
- reservations: {
94300
- default: {
94301
- exclude: boolean;
94302
- };
94303
- description: string;
94304
- properties: {
94305
- exclude: {
94306
- default: boolean;
94307
- description: string;
94308
- type: string;
94309
- };
94310
- };
94311
- type: string;
94312
- };
94313
94457
  };
94314
94458
  type: string;
94315
94459
  };
@@ -95620,6 +95764,75 @@ declare const _default: {
95620
95764
  'x-title': string;
95621
95765
  };
95622
95766
  };
95767
+ '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
95768
+ post: {
95769
+ description: string;
95770
+ operationId: string;
95771
+ requestBody: {
95772
+ content: {
95773
+ 'application/json': {
95774
+ schema: {
95775
+ properties: {};
95776
+ type: string;
95777
+ };
95778
+ };
95779
+ };
95780
+ };
95781
+ responses: {
95782
+ 200: {
95783
+ content: {
95784
+ 'application/json': {
95785
+ schema: {
95786
+ properties: {
95787
+ error: {
95788
+ type: string;
95789
+ };
95790
+ ok: {
95791
+ type: string;
95792
+ };
95793
+ processed_events: {
95794
+ format: string;
95795
+ type: string;
95796
+ };
95797
+ success: {
95798
+ type: string;
95799
+ };
95800
+ };
95801
+ required: string[];
95802
+ type: string;
95803
+ };
95804
+ };
95805
+ };
95806
+ description: string;
95807
+ };
95808
+ 400: {
95809
+ description: string;
95810
+ };
95811
+ 401: {
95812
+ description: string;
95813
+ };
95814
+ };
95815
+ security: ({
95816
+ pat_with_workspace: never[];
95817
+ console_session_with_workspace?: never;
95818
+ api_key?: never;
95819
+ } | {
95820
+ console_session_with_workspace: never[];
95821
+ pat_with_workspace?: never;
95822
+ api_key?: never;
95823
+ } | {
95824
+ api_key: never[];
95825
+ pat_with_workspace?: never;
95826
+ console_session_with_workspace?: never;
95827
+ })[];
95828
+ summary: string;
95829
+ tags: string[];
95830
+ 'x-fern-sdk-group-name': string[];
95831
+ 'x-fern-sdk-method-name': string;
95832
+ 'x-response-key': null;
95833
+ 'x-title': string;
95834
+ };
95835
+ };
95623
95836
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
95624
95837
  post: {
95625
95838
  description: string;
@@ -139356,24 +139569,20 @@ type Routes = {
139356
139569
  /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
139357
139570
  excluded_providers?: string[] | undefined;
139358
139571
  };
139359
- /** Configuration for the manage reservations feature. */
139360
- manage_reservations?: {
139572
+ /** Configuration for the manage feature. */
139573
+ manage?: {
139361
139574
  /** Whether to exclude this feature from the portal. */
139362
139575
  exclude?: boolean;
139363
- /** Configuration for the reservations feature. */
139364
- reservations?: {
139365
- /** Indicates whether the customer can view reservations for their properties. */
139366
- exclude?: boolean;
139367
- };
139576
+ /** Indicates whether the customer can manage reservations for their properties. */
139577
+ exclude_reservation_management?: boolean;
139368
139578
  };
139369
- /** Configuration for the manage devices feature. */
139579
+ /** Configuration for the manage devices feature.
139580
+ ---
139581
+ deprecated: Use `manage` instead.
139582
+ --- */
139370
139583
  manage_devices?: {
139371
139584
  /** Whether to exclude this feature from the portal. */
139372
139585
  exclude?: boolean;
139373
- /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
139374
- accepted_providers?: string[] | undefined;
139375
- /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
139376
- excluded_providers?: string[] | undefined;
139377
139586
  };
139378
139587
  /** Configuration for the organize feature. */
139379
139588
  organize?: {
@@ -164567,6 +164776,58 @@ type Routes = {
164567
164776
  formData: {};
164568
164777
  jsonResponse: {};
164569
164778
  };
164779
+ '/seam/customer/v1/connectors/create': {
164780
+ route: '/seam/customer/v1/connectors/create';
164781
+ method: 'POST';
164782
+ queryParams: {};
164783
+ jsonBody: {
164784
+ /** Type of connector to create */
164785
+ connector_type: 'mews' | 'mock';
164786
+ /** Key identifying the customer */
164787
+ customer_key: string;
164788
+ /** Instance-specific configuration for the connector */
164789
+ config: {
164790
+ client_token: string;
164791
+ access_token: string;
164792
+ client: string;
164793
+ enterprise_ids?: string[] | undefined;
164794
+ } | {};
164795
+ };
164796
+ commonParams: {};
164797
+ formData: {};
164798
+ jsonResponse: {
164799
+ connector: {
164800
+ connector_id: string;
164801
+ connector_type: string;
164802
+ status: 'active' | 'inactive' | 'error';
164803
+ webhook_subscription?: {
164804
+ subscription_id: string;
164805
+ webhook_url: string;
164806
+ events: string[];
164807
+ status: 'active' | 'inactive' | 'error';
164808
+ } | undefined;
164809
+ error?: string | undefined;
164810
+ };
164811
+ };
164812
+ };
164813
+ '/seam/customer/v1/connectors/sync': {
164814
+ route: '/seam/customer/v1/connectors/sync';
164815
+ method: 'POST';
164816
+ queryParams: {};
164817
+ jsonBody: {};
164818
+ commonParams: {
164819
+ /** ID of the connector to sync */
164820
+ connector_id: string;
164821
+ };
164822
+ formData: {};
164823
+ jsonResponse: {
164824
+ connector_sync: {
164825
+ connector_id: string;
164826
+ status: string;
164827
+ message: string;
164828
+ };
164829
+ };
164830
+ };
164570
164831
  '/seam/customer/v1/events/list': {
164571
164832
  route: '/seam/customer/v1/events/list';
164572
164833
  method: 'GET' | 'POST';
@@ -166508,24 +166769,20 @@ type Routes = {
166508
166769
  /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
166509
166770
  excluded_providers?: string[] | undefined;
166510
166771
  };
166511
- /** Configuration for the manage reservations feature. */
166512
- manage_reservations?: {
166772
+ /** Configuration for the manage feature. */
166773
+ manage?: {
166513
166774
  /** Whether to exclude this feature from the portal. */
166514
166775
  exclude?: boolean;
166515
- /** Configuration for the reservations feature. */
166516
- reservations?: {
166517
- /** Indicates whether the customer can view reservations for their properties. */
166518
- exclude?: boolean;
166519
- };
166776
+ /** Indicates whether the customer can manage reservations for their properties. */
166777
+ exclude_reservation_management?: boolean;
166520
166778
  };
166521
- /** Configuration for the manage devices feature. */
166779
+ /** Configuration for the manage devices feature.
166780
+ ---
166781
+ deprecated: Use `manage` instead.
166782
+ --- */
166522
166783
  manage_devices?: {
166523
166784
  /** Whether to exclude this feature from the portal. */
166524
166785
  exclude?: boolean;
166525
- /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
166526
- accepted_providers?: string[] | undefined;
166527
- /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
166528
- excluded_providers?: string[] | undefined;
166529
166786
  };
166530
166787
  /** Configuration for the organize feature. */
166531
166788
  organize?: {
@@ -166773,6 +167030,19 @@ type Routes = {
166773
167030
  }[];
166774
167031
  };
166775
167032
  };
167033
+ '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
167034
+ route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
167035
+ method: 'POST';
167036
+ queryParams: {};
167037
+ jsonBody: {};
167038
+ commonParams: {};
167039
+ formData: {};
167040
+ jsonResponse: {
167041
+ success: boolean;
167042
+ processed_events: number;
167043
+ error?: string | undefined;
167044
+ };
167045
+ };
166776
167046
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
166777
167047
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
166778
167048
  method: 'POST';