@seamapi/types 1.1030.0 → 1.1032.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.
@@ -41550,11 +41550,11 @@ export type Routes = {
41550
41550
  route: '/connect_webviews/delete';
41551
41551
  method: 'DELETE' | 'POST';
41552
41552
  queryParams: {};
41553
- jsonBody: {
41553
+ jsonBody: {};
41554
+ commonParams: {
41554
41555
  /** ID of the Connect Webview that you want to delete. */
41555
41556
  connect_webview_id: string;
41556
41557
  };
41557
- commonParams: {};
41558
41558
  formData: {};
41559
41559
  jsonResponse: {};
41560
41560
  maxDuration: undefined;
@@ -41719,13 +41719,13 @@ export type Routes = {
41719
41719
  route: '/connected_accounts/delete';
41720
41720
  method: 'DELETE' | 'POST';
41721
41721
  queryParams: {};
41722
- jsonBody: {
41722
+ jsonBody: {};
41723
+ commonParams: {
41723
41724
  /** ID of the connected account that you want to delete. */
41724
41725
  connected_account_id: string;
41725
41726
  /** */
41726
41727
  sync?: boolean;
41727
41728
  };
41728
- commonParams: {};
41729
41729
  formData: {};
41730
41730
  jsonResponse: {};
41731
41731
  maxDuration: undefined;
@@ -74855,7 +74855,8 @@ export type Routes = {
74855
74855
  route: '/noise_sensors/noise_thresholds/delete';
74856
74856
  method: 'DELETE' | 'POST';
74857
74857
  queryParams: {};
74858
- jsonBody: {
74858
+ jsonBody: {};
74859
+ commonParams: {
74859
74860
  /** ID of the noise threshold that you want to delete. */
74860
74861
  noise_threshold_id: string;
74861
74862
  /** ID of the device that contains the noise threshold that you want to delete. */
@@ -74863,7 +74864,6 @@ export type Routes = {
74863
74864
  /** */
74864
74865
  sync?: boolean;
74865
74866
  };
74866
- commonParams: {};
74867
74867
  formData: {};
74868
74868
  jsonResponse: {
74869
74869
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -78541,11 +78541,11 @@ export type Routes = {
78541
78541
  route: '/phones/deactivate';
78542
78542
  method: 'DELETE' | 'POST';
78543
78543
  queryParams: {};
78544
- jsonBody: {
78544
+ jsonBody: {};
78545
+ commonParams: {
78545
78546
  /** Device ID of the phone that you want to deactivate. */
78546
78547
  device_id: string;
78547
78548
  };
78548
- commonParams: {};
78549
78549
  formData: {};
78550
78550
  jsonResponse: {};
78551
78551
  maxDuration: undefined;
@@ -79899,11 +79899,11 @@ export type Routes = {
79899
79899
  route: '/seam/console/v1/sites/delete';
79900
79900
  method: 'DELETE' | 'POST';
79901
79901
  queryParams: {};
79902
- jsonBody: {
79902
+ jsonBody: {};
79903
+ commonParams: {
79903
79904
  /** ID of the site that you want to delete. */
79904
79905
  site_id: string;
79905
79906
  };
79906
- commonParams: {};
79907
79907
  formData: {};
79908
79908
  jsonResponse: {};
79909
79909
  maxDuration: undefined;
@@ -87954,11 +87954,11 @@ export type Routes = {
87954
87954
  route: '/seam/instant_key/v1/preview/get';
87955
87955
  method: 'GET' | 'POST';
87956
87956
  queryParams: {};
87957
- jsonBody: {
87957
+ jsonBody: {};
87958
+ commonParams: {
87958
87959
  /** The short code of the instant key to preview. */
87959
87960
  instant_key_url: string;
87960
87961
  };
87961
- commonParams: {};
87962
87962
  formData: {};
87963
87963
  jsonResponse: {
87964
87964
  /** Represents a preview of an Instant Key with hotel, guest, and access information. */
@@ -88835,11 +88835,11 @@ export type Routes = {
88835
88835
  route: '/spaces/delete';
88836
88836
  method: 'DELETE' | 'POST';
88837
88837
  queryParams: {};
88838
- jsonBody: {
88838
+ jsonBody: {};
88839
+ commonParams: {
88839
88840
  /** ID of the space that you want to delete. */
88840
88841
  space_id: string;
88841
88842
  };
88842
- commonParams: {};
88843
88843
  formData: {};
88844
88844
  jsonResponse: {};
88845
88845
  maxDuration: undefined;
@@ -96839,13 +96839,13 @@ export type Routes = {
96839
96839
  route: '/thermostats/delete_climate_preset';
96840
96840
  method: 'POST' | 'DELETE';
96841
96841
  queryParams: {};
96842
- jsonBody: {
96842
+ jsonBody: {};
96843
+ commonParams: {
96843
96844
  /** ID of the thermostat device for which you want to delete a climate preset. */
96844
96845
  device_id: string;
96845
96846
  /** Climate preset key of the climate preset that you want to delete. */
96846
96847
  climate_preset_key: string;
96847
96848
  };
96848
- commonParams: {};
96849
96849
  formData: {};
96850
96850
  jsonResponse: {};
96851
96851
  maxDuration: undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1030.0",
3
+ "version": "1.1032.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -52662,24 +52662,18 @@ const openapi: OpenAPISpec = {
52662
52662
  description:
52663
52663
  'Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.',
52664
52664
  operationId: 'connectWebviewsDeleteDelete',
52665
- requestBody: {
52666
- content: {
52667
- 'application/json': {
52668
- schema: {
52669
- properties: {
52670
- connect_webview_id: {
52671
- description:
52672
- 'ID of the Connect Webview that you want to delete.',
52673
- format: 'uuid',
52674
- type: 'string',
52675
- },
52676
- },
52677
- required: ['connect_webview_id'],
52678
- type: 'object',
52679
- },
52665
+ parameters: [
52666
+ {
52667
+ in: 'query',
52668
+ name: 'connect_webview_id',
52669
+ required: true,
52670
+ schema: {
52671
+ description: 'ID of the Connect Webview that you want to delete.',
52672
+ format: 'uuid',
52673
+ type: 'string',
52680
52674
  },
52681
52675
  },
52682
- },
52676
+ ],
52683
52677
  responses: {
52684
52678
  '200': {
52685
52679
  content: {
@@ -53086,29 +53080,29 @@ const openapi: OpenAPISpec = {
53086
53080
  description:
53087
53081
  'Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.',
53088
53082
  operationId: 'connectedAccountsDeleteDelete',
53089
- requestBody: {
53090
- content: {
53091
- 'application/json': {
53092
- schema: {
53093
- properties: {
53094
- connected_account_id: {
53095
- description:
53096
- 'ID of the connected account that you want to delete.',
53097
- format: 'uuid',
53098
- type: 'string',
53099
- },
53100
- sync: {
53101
- default: false,
53102
- type: 'boolean',
53103
- 'x-undocumented': 'Only used internally.',
53104
- },
53105
- },
53106
- required: ['connected_account_id'],
53107
- type: 'object',
53108
- },
53083
+ parameters: [
53084
+ {
53085
+ in: 'query',
53086
+ name: 'connected_account_id',
53087
+ required: true,
53088
+ schema: {
53089
+ description:
53090
+ 'ID of the connected account that you want to delete.',
53091
+ format: 'uuid',
53092
+ type: 'string',
53109
53093
  },
53110
53094
  },
53111
- },
53095
+ {
53096
+ in: 'query',
53097
+ name: 'sync',
53098
+ required: false,
53099
+ schema: {
53100
+ default: false,
53101
+ type: 'boolean',
53102
+ 'x-undocumented': 'Only used internally.',
53103
+ },
53104
+ },
53105
+ ],
53112
53106
  responses: {
53113
53107
  '200': {
53114
53108
  content: {
@@ -63467,35 +63461,39 @@ const openapi: OpenAPISpec = {
63467
63461
  description:
63468
63462
  'Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).',
63469
63463
  operationId: 'noiseSensorsNoiseThresholdsDeleteDelete',
63470
- requestBody: {
63471
- content: {
63472
- 'application/json': {
63473
- schema: {
63474
- properties: {
63475
- device_id: {
63476
- description:
63477
- 'ID of the device that contains the noise threshold that you want to delete.',
63478
- format: 'uuid',
63479
- type: 'string',
63480
- },
63481
- noise_threshold_id: {
63482
- description:
63483
- 'ID of the noise threshold that you want to delete.',
63484
- format: 'uuid',
63485
- type: 'string',
63486
- },
63487
- sync: {
63488
- default: false,
63489
- type: 'boolean',
63490
- 'x-undocumented': 'Only used internally.',
63491
- },
63492
- },
63493
- required: ['noise_threshold_id', 'device_id'],
63494
- type: 'object',
63495
- },
63464
+ parameters: [
63465
+ {
63466
+ in: 'query',
63467
+ name: 'noise_threshold_id',
63468
+ required: true,
63469
+ schema: {
63470
+ description: 'ID of the noise threshold that you want to delete.',
63471
+ format: 'uuid',
63472
+ type: 'string',
63496
63473
  },
63497
63474
  },
63498
- },
63475
+ {
63476
+ in: 'query',
63477
+ name: 'device_id',
63478
+ required: true,
63479
+ schema: {
63480
+ description:
63481
+ 'ID of the device that contains the noise threshold that you want to delete.',
63482
+ format: 'uuid',
63483
+ type: 'string',
63484
+ },
63485
+ },
63486
+ {
63487
+ in: 'query',
63488
+ name: 'sync',
63489
+ required: false,
63490
+ schema: {
63491
+ default: false,
63492
+ type: 'boolean',
63493
+ 'x-undocumented': 'Only used internally.',
63494
+ },
63495
+ },
63496
+ ],
63499
63497
  responses: {
63500
63498
  '200': {
63501
63499
  content: {
@@ -64183,23 +64181,18 @@ const openapi: OpenAPISpec = {
64183
64181
  description:
64184
64182
  'Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).',
64185
64183
  operationId: 'phonesDeactivateDelete',
64186
- requestBody: {
64187
- content: {
64188
- 'application/json': {
64189
- schema: {
64190
- properties: {
64191
- device_id: {
64192
- description:
64193
- 'Device ID of the phone that you want to deactivate.',
64194
- type: 'string',
64195
- },
64196
- },
64197
- required: ['device_id'],
64198
- type: 'object',
64199
- },
64184
+ parameters: [
64185
+ {
64186
+ in: 'query',
64187
+ name: 'device_id',
64188
+ required: true,
64189
+ schema: {
64190
+ description:
64191
+ 'Device ID of the phone that you want to deactivate.',
64192
+ type: 'string',
64200
64193
  },
64201
64194
  },
64202
- },
64195
+ ],
64203
64196
  responses: {
64204
64197
  '200': {
64205
64198
  content: {
@@ -67865,23 +67858,18 @@ const openapi: OpenAPISpec = {
67865
67858
  delete: {
67866
67859
  description: 'Deletes a site.',
67867
67860
  operationId: 'seamConsoleV1SitesDeleteDelete',
67868
- requestBody: {
67869
- content: {
67870
- 'application/json': {
67871
- schema: {
67872
- properties: {
67873
- site_id: {
67874
- description: 'ID of the site that you want to delete.',
67875
- format: 'uuid',
67876
- type: 'string',
67877
- },
67878
- },
67879
- required: ['site_id'],
67880
- type: 'object',
67881
- },
67861
+ parameters: [
67862
+ {
67863
+ in: 'query',
67864
+ name: 'site_id',
67865
+ required: true,
67866
+ schema: {
67867
+ description: 'ID of the site that you want to delete.',
67868
+ format: 'uuid',
67869
+ type: 'string',
67882
67870
  },
67883
67871
  },
67884
- },
67872
+ ],
67885
67873
  responses: {
67886
67874
  '200': {
67887
67875
  content: {
@@ -79725,23 +79713,17 @@ const openapi: OpenAPISpec = {
79725
79713
  '/seam/instant_key/v1/preview/get': {
79726
79714
  get: {
79727
79715
  operationId: 'seamInstantKeyV1PreviewGetGet',
79728
- requestBody: {
79729
- content: {
79730
- 'application/json': {
79731
- schema: {
79732
- properties: {
79733
- instant_key_url: {
79734
- description:
79735
- 'The short code of the instant key to preview.',
79736
- type: 'string',
79737
- },
79738
- },
79739
- required: ['instant_key_url'],
79740
- type: 'object',
79741
- },
79716
+ parameters: [
79717
+ {
79718
+ in: 'query',
79719
+ name: 'instant_key_url',
79720
+ required: true,
79721
+ schema: {
79722
+ description: 'The short code of the instant key to preview.',
79723
+ type: 'string',
79742
79724
  },
79743
79725
  },
79744
- },
79726
+ ],
79745
79727
  responses: {
79746
79728
  '200': {
79747
79729
  content: {
@@ -81099,23 +81081,18 @@ const openapi: OpenAPISpec = {
81099
81081
  delete: {
81100
81082
  description: 'Deletes a space.',
81101
81083
  operationId: 'spacesDeleteDelete',
81102
- requestBody: {
81103
- content: {
81104
- 'application/json': {
81105
- schema: {
81106
- properties: {
81107
- space_id: {
81108
- description: 'ID of the space that you want to delete.',
81109
- format: 'uuid',
81110
- type: 'string',
81111
- },
81112
- },
81113
- required: ['space_id'],
81114
- type: 'object',
81115
- },
81084
+ parameters: [
81085
+ {
81086
+ in: 'query',
81087
+ name: 'space_id',
81088
+ required: true,
81089
+ schema: {
81090
+ description: 'ID of the space that you want to delete.',
81091
+ format: 'uuid',
81092
+ type: 'string',
81116
81093
  },
81117
81094
  },
81118
- },
81095
+ ],
81119
81096
  responses: {
81120
81097
  '200': {
81121
81098
  content: {
@@ -83043,30 +83020,30 @@ const openapi: OpenAPISpec = {
83043
83020
  description:
83044
83021
  'Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).',
83045
83022
  operationId: 'thermostatsDeleteClimatePresetDelete',
83046
- requestBody: {
83047
- content: {
83048
- 'application/json': {
83049
- schema: {
83050
- properties: {
83051
- climate_preset_key: {
83052
- description:
83053
- 'Climate preset key of the climate preset that you want to delete.',
83054
- minLength: 1,
83055
- type: 'string',
83056
- },
83057
- device_id: {
83058
- description:
83059
- 'ID of the thermostat device for which you want to delete a climate preset.',
83060
- format: 'uuid',
83061
- type: 'string',
83062
- },
83063
- },
83064
- required: ['device_id', 'climate_preset_key'],
83065
- type: 'object',
83066
- },
83023
+ parameters: [
83024
+ {
83025
+ in: 'query',
83026
+ name: 'device_id',
83027
+ required: true,
83028
+ schema: {
83029
+ description:
83030
+ 'ID of the thermostat device for which you want to delete a climate preset.',
83031
+ format: 'uuid',
83032
+ type: 'string',
83067
83033
  },
83068
83034
  },
83069
- },
83035
+ {
83036
+ in: 'query',
83037
+ name: 'climate_preset_key',
83038
+ required: true,
83039
+ schema: {
83040
+ description:
83041
+ 'Climate preset key of the climate preset that you want to delete.',
83042
+ minLength: 1,
83043
+ type: 'string',
83044
+ },
83045
+ },
83046
+ ],
83070
83047
  responses: {
83071
83048
  '200': {
83072
83049
  content: {
@@ -48717,11 +48717,11 @@ export type Routes = {
48717
48717
  route: '/connect_webviews/delete'
48718
48718
  method: 'DELETE' | 'POST'
48719
48719
  queryParams: {}
48720
- jsonBody: {
48720
+ jsonBody: {}
48721
+ commonParams: {
48721
48722
  /** ID of the Connect Webview that you want to delete. */
48722
48723
  connect_webview_id: string
48723
48724
  }
48724
- commonParams: {}
48725
48725
  formData: {}
48726
48726
  jsonResponse: {}
48727
48727
  maxDuration: undefined
@@ -48892,13 +48892,13 @@ export type Routes = {
48892
48892
  route: '/connected_accounts/delete'
48893
48893
  method: 'DELETE' | 'POST'
48894
48894
  queryParams: {}
48895
- jsonBody: {
48895
+ jsonBody: {}
48896
+ commonParams: {
48896
48897
  /** ID of the connected account that you want to delete. */
48897
48898
  connected_account_id: string
48898
48899
  /** */
48899
48900
  sync?: boolean
48900
48901
  }
48901
- commonParams: {}
48902
48902
  formData: {}
48903
48903
  jsonResponse: {}
48904
48904
  maxDuration: undefined
@@ -90246,7 +90246,8 @@ export type Routes = {
90246
90246
  route: '/noise_sensors/noise_thresholds/delete'
90247
90247
  method: 'DELETE' | 'POST'
90248
90248
  queryParams: {}
90249
- jsonBody: {
90249
+ jsonBody: {}
90250
+ commonParams: {
90250
90251
  /** ID of the noise threshold that you want to delete. */
90251
90252
  noise_threshold_id: string
90252
90253
  /** ID of the device that contains the noise threshold that you want to delete. */
@@ -90254,7 +90255,6 @@ export type Routes = {
90254
90255
  /** */
90255
90256
  sync?: boolean
90256
90257
  }
90257
- commonParams: {}
90258
90258
  formData: {}
90259
90259
  jsonResponse: {
90260
90260
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -94540,11 +94540,11 @@ export type Routes = {
94540
94540
  route: '/phones/deactivate'
94541
94541
  method: 'DELETE' | 'POST'
94542
94542
  queryParams: {}
94543
- jsonBody: {
94543
+ jsonBody: {}
94544
+ commonParams: {
94544
94545
  /** Device ID of the phone that you want to deactivate. */
94545
94546
  device_id: string
94546
94547
  }
94547
- commonParams: {}
94548
94548
  formData: {}
94549
94549
  jsonResponse: {}
94550
94550
  maxDuration: undefined
@@ -95956,11 +95956,11 @@ export type Routes = {
95956
95956
  route: '/seam/console/v1/sites/delete'
95957
95957
  method: 'DELETE' | 'POST'
95958
95958
  queryParams: {}
95959
- jsonBody: {
95959
+ jsonBody: {}
95960
+ commonParams: {
95960
95961
  /** ID of the site that you want to delete. */
95961
95962
  site_id: string
95962
95963
  }
95963
- commonParams: {}
95964
95964
  formData: {}
95965
95965
  jsonResponse: {}
95966
95966
  maxDuration: undefined
@@ -105410,11 +105410,11 @@ export type Routes = {
105410
105410
  route: '/seam/instant_key/v1/preview/get'
105411
105411
  method: 'GET' | 'POST'
105412
105412
  queryParams: {}
105413
- jsonBody: {
105413
+ jsonBody: {}
105414
+ commonParams: {
105414
105415
  /** The short code of the instant key to preview. */
105415
105416
  instant_key_url: string
105416
105417
  }
105417
- commonParams: {}
105418
105418
  formData: {}
105419
105419
  jsonResponse: {
105420
105420
  /** Represents a preview of an Instant Key with hotel, guest, and access information. */
@@ -106433,11 +106433,11 @@ export type Routes = {
106433
106433
  route: '/spaces/delete'
106434
106434
  method: 'DELETE' | 'POST'
106435
106435
  queryParams: {}
106436
- jsonBody: {
106436
+ jsonBody: {}
106437
+ commonParams: {
106437
106438
  /** ID of the space that you want to delete. */
106438
106439
  space_id: string
106439
106440
  }
106440
- commonParams: {}
106441
106441
  formData: {}
106442
106442
  jsonResponse: {}
106443
106443
  maxDuration: undefined
@@ -115990,13 +115990,13 @@ export type Routes = {
115990
115990
  route: '/thermostats/delete_climate_preset'
115991
115991
  method: 'POST' | 'DELETE'
115992
115992
  queryParams: {}
115993
- jsonBody: {
115993
+ jsonBody: {}
115994
+ commonParams: {
115994
115995
  /** ID of the thermostat device for which you want to delete a climate preset. */
115995
115996
  device_id: string
115996
115997
  /** Climate preset key of the climate preset that you want to delete. */
115997
115998
  climate_preset_key: string
115998
115999
  }
115999
- commonParams: {}
116000
116000
  formData: {}
116001
116001
  jsonResponse: {}
116002
116002
  maxDuration: undefined