@seamapi/types 1.590.0 → 1.591.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.
- package/dist/connect.cjs +89 -2
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +102 -3
- package/dist/index.cjs +89 -2
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +99 -0
- package/lib/seam/connect/openapi.js +89 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3 -3
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +96 -2
- package/src/lib/seam/connect/route-types.ts +3 -3
|
@@ -31071,6 +31071,105 @@ declare const _default: {
|
|
|
31071
31071
|
};
|
|
31072
31072
|
};
|
|
31073
31073
|
'/connected_accounts/update': {
|
|
31074
|
+
patch: {
|
|
31075
|
+
description: string;
|
|
31076
|
+
operationId: string;
|
|
31077
|
+
requestBody: {
|
|
31078
|
+
content: {
|
|
31079
|
+
'application/json': {
|
|
31080
|
+
schema: {
|
|
31081
|
+
properties: {
|
|
31082
|
+
accepted_capabilities: {
|
|
31083
|
+
description: string;
|
|
31084
|
+
items: {
|
|
31085
|
+
description: string;
|
|
31086
|
+
enum: string[];
|
|
31087
|
+
type: string;
|
|
31088
|
+
};
|
|
31089
|
+
type: string;
|
|
31090
|
+
};
|
|
31091
|
+
automatically_manage_new_devices: {
|
|
31092
|
+
description: string;
|
|
31093
|
+
type: string;
|
|
31094
|
+
};
|
|
31095
|
+
connected_account_id: {
|
|
31096
|
+
description: string;
|
|
31097
|
+
format: string;
|
|
31098
|
+
type: string;
|
|
31099
|
+
};
|
|
31100
|
+
custom_metadata: {
|
|
31101
|
+
additionalProperties: {
|
|
31102
|
+
nullable: boolean;
|
|
31103
|
+
oneOf: ({
|
|
31104
|
+
maxLength: number;
|
|
31105
|
+
type: string;
|
|
31106
|
+
} | {
|
|
31107
|
+
type: string;
|
|
31108
|
+
maxLength?: never;
|
|
31109
|
+
})[];
|
|
31110
|
+
};
|
|
31111
|
+
description: string;
|
|
31112
|
+
type: string;
|
|
31113
|
+
};
|
|
31114
|
+
customer_key: {
|
|
31115
|
+
description: string;
|
|
31116
|
+
minLength: number;
|
|
31117
|
+
type: string;
|
|
31118
|
+
};
|
|
31119
|
+
};
|
|
31120
|
+
required: string[];
|
|
31121
|
+
type: string;
|
|
31122
|
+
};
|
|
31123
|
+
};
|
|
31124
|
+
};
|
|
31125
|
+
};
|
|
31126
|
+
responses: {
|
|
31127
|
+
200: {
|
|
31128
|
+
content: {
|
|
31129
|
+
'application/json': {
|
|
31130
|
+
schema: {
|
|
31131
|
+
properties: {
|
|
31132
|
+
connected_account: {
|
|
31133
|
+
$ref: string;
|
|
31134
|
+
};
|
|
31135
|
+
ok: {
|
|
31136
|
+
type: string;
|
|
31137
|
+
};
|
|
31138
|
+
};
|
|
31139
|
+
required: string[];
|
|
31140
|
+
type: string;
|
|
31141
|
+
};
|
|
31142
|
+
};
|
|
31143
|
+
};
|
|
31144
|
+
description: string;
|
|
31145
|
+
};
|
|
31146
|
+
400: {
|
|
31147
|
+
description: string;
|
|
31148
|
+
};
|
|
31149
|
+
401: {
|
|
31150
|
+
description: string;
|
|
31151
|
+
};
|
|
31152
|
+
};
|
|
31153
|
+
security: ({
|
|
31154
|
+
pat_with_workspace: never[];
|
|
31155
|
+
console_session_with_workspace?: never;
|
|
31156
|
+
api_key?: never;
|
|
31157
|
+
} | {
|
|
31158
|
+
console_session_with_workspace: never[];
|
|
31159
|
+
pat_with_workspace?: never;
|
|
31160
|
+
api_key?: never;
|
|
31161
|
+
} | {
|
|
31162
|
+
api_key: never[];
|
|
31163
|
+
pat_with_workspace?: never;
|
|
31164
|
+
console_session_with_workspace?: never;
|
|
31165
|
+
})[];
|
|
31166
|
+
summary: string;
|
|
31167
|
+
tags: string[];
|
|
31168
|
+
'x-fern-sdk-group-name': string[];
|
|
31169
|
+
'x-fern-sdk-method-name': string;
|
|
31170
|
+
'x-response-key': null;
|
|
31171
|
+
'x-title': string;
|
|
31172
|
+
};
|
|
31074
31173
|
post: {
|
|
31075
31174
|
description: string;
|
|
31076
31175
|
operationId: string;
|
|
@@ -35779,7 +35779,7 @@ export default {
|
|
|
35779
35779
|
type: 'string',
|
|
35780
35780
|
},
|
|
35781
35781
|
customer_key: {
|
|
35782
|
-
description: '
|
|
35782
|
+
description: 'Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.',
|
|
35783
35783
|
type: 'string',
|
|
35784
35784
|
},
|
|
35785
35785
|
device_selection_mode: {
|
|
@@ -36684,6 +36684,93 @@ export default {
|
|
|
36684
36684
|
},
|
|
36685
36685
|
},
|
|
36686
36686
|
'/connected_accounts/update': {
|
|
36687
|
+
patch: {
|
|
36688
|
+
description: 'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
36689
|
+
operationId: 'connectedAccountsUpdatePatch',
|
|
36690
|
+
requestBody: {
|
|
36691
|
+
content: {
|
|
36692
|
+
'application/json': {
|
|
36693
|
+
schema: {
|
|
36694
|
+
properties: {
|
|
36695
|
+
accepted_capabilities: {
|
|
36696
|
+
description: 'List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.',
|
|
36697
|
+
items: {
|
|
36698
|
+
description: '\n High-level device capabilities that can be restricted in connect webviews.\n These represent the main device categories that customers can opt into.\n',
|
|
36699
|
+
enum: [
|
|
36700
|
+
'lock',
|
|
36701
|
+
'thermostat',
|
|
36702
|
+
'noise_sensor',
|
|
36703
|
+
'access_control',
|
|
36704
|
+
],
|
|
36705
|
+
type: 'string',
|
|
36706
|
+
},
|
|
36707
|
+
type: 'array',
|
|
36708
|
+
},
|
|
36709
|
+
automatically_manage_new_devices: {
|
|
36710
|
+
description: 'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
|
|
36711
|
+
type: 'boolean',
|
|
36712
|
+
},
|
|
36713
|
+
connected_account_id: {
|
|
36714
|
+
description: 'ID of the connected account that you want to update.',
|
|
36715
|
+
format: 'uuid',
|
|
36716
|
+
type: 'string',
|
|
36717
|
+
},
|
|
36718
|
+
custom_metadata: {
|
|
36719
|
+
additionalProperties: {
|
|
36720
|
+
nullable: true,
|
|
36721
|
+
oneOf: [
|
|
36722
|
+
{ maxLength: 500, type: 'string' },
|
|
36723
|
+
{ type: 'boolean' },
|
|
36724
|
+
],
|
|
36725
|
+
},
|
|
36726
|
+
description: 'Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).',
|
|
36727
|
+
type: 'object',
|
|
36728
|
+
},
|
|
36729
|
+
customer_key: {
|
|
36730
|
+
description: 'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.',
|
|
36731
|
+
minLength: 1,
|
|
36732
|
+
type: 'string',
|
|
36733
|
+
},
|
|
36734
|
+
},
|
|
36735
|
+
required: ['connected_account_id'],
|
|
36736
|
+
type: 'object',
|
|
36737
|
+
},
|
|
36738
|
+
},
|
|
36739
|
+
},
|
|
36740
|
+
},
|
|
36741
|
+
responses: {
|
|
36742
|
+
200: {
|
|
36743
|
+
content: {
|
|
36744
|
+
'application/json': {
|
|
36745
|
+
schema: {
|
|
36746
|
+
properties: {
|
|
36747
|
+
connected_account: {
|
|
36748
|
+
$ref: '#/components/schemas/connected_account',
|
|
36749
|
+
},
|
|
36750
|
+
ok: { type: 'boolean' },
|
|
36751
|
+
},
|
|
36752
|
+
required: ['connected_account', 'ok'],
|
|
36753
|
+
type: 'object',
|
|
36754
|
+
},
|
|
36755
|
+
},
|
|
36756
|
+
},
|
|
36757
|
+
description: 'OK',
|
|
36758
|
+
},
|
|
36759
|
+
400: { description: 'Bad Request' },
|
|
36760
|
+
401: { description: 'Unauthorized' },
|
|
36761
|
+
},
|
|
36762
|
+
security: [
|
|
36763
|
+
{ pat_with_workspace: [] },
|
|
36764
|
+
{ console_session_with_workspace: [] },
|
|
36765
|
+
{ api_key: [] },
|
|
36766
|
+
],
|
|
36767
|
+
summary: '/connected_accounts/update',
|
|
36768
|
+
tags: ['/connected_accounts'],
|
|
36769
|
+
'x-fern-sdk-group-name': ['connected_accounts'],
|
|
36770
|
+
'x-fern-sdk-method-name': 'update',
|
|
36771
|
+
'x-response-key': null,
|
|
36772
|
+
'x-title': 'Update a Connected Account',
|
|
36773
|
+
},
|
|
36687
36774
|
post: {
|
|
36688
36775
|
description: 'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
36689
36776
|
operationId: 'connectedAccountsUpdatePost',
|
|
@@ -36727,7 +36814,7 @@ export default {
|
|
|
36727
36814
|
type: 'object',
|
|
36728
36815
|
},
|
|
36729
36816
|
customer_key: {
|
|
36730
|
-
description: 'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. ',
|
|
36817
|
+
description: 'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.',
|
|
36731
36818
|
minLength: 1,
|
|
36732
36819
|
type: 'string',
|
|
36733
36820
|
},
|