@seamapi/types 1.590.0 → 1.592.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.
Files changed (16) hide show
  1. package/dist/connect.cjs +94 -2
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +111 -3
  4. package/dist/index.cjs +94 -2
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/customer/customer-portal.d.ts +7 -0
  7. package/lib/seam/connect/models/customer/customer-portal.js +4 -0
  8. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  9. package/lib/seam/connect/openapi.d.ts +106 -0
  10. package/lib/seam/connect/openapi.js +94 -2
  11. package/lib/seam/connect/openapi.js.map +1 -1
  12. package/lib/seam/connect/route-types.d.ts +5 -3
  13. package/package.json +1 -1
  14. package/src/lib/seam/connect/models/customer/customer-portal.ts +6 -0
  15. package/src/lib/seam/connect/openapi.ts +102 -2
  16. package/src/lib/seam/connect/route-types.ts +5 -3
package/lib/seam/connect/models/customer/customer-portal.d.ts CHANGED
@@ -4,11 +4,14 @@ export declare const portal_configuration: z.ZodDefault<z.ZodObject<{
4
4
  connect: z.ZodDefault<z.ZodObject<{
5
5
  exclude: z.ZodDefault<z.ZodBoolean>;
6
6
  } & {
7
+ accepted_providers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
7
8
  excluded_providers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
8
9
  }, "strip", z.ZodTypeAny, {
9
10
  exclude: boolean;
11
+ accepted_providers?: string[] | undefined;
10
12
  excluded_providers?: string[] | undefined;
11
13
  }, {
14
+ accepted_providers?: string[] | undefined;
12
15
  exclude?: boolean | undefined;
13
16
  excluded_providers?: string[] | undefined;
14
17
  }>>;
@@ -43,6 +46,7 @@ export declare const portal_configuration: z.ZodDefault<z.ZodObject<{
43
46
  }, "strip", z.ZodTypeAny, {
44
47
  connect: {
45
48
  exclude: boolean;
49
+ accepted_providers?: string[] | undefined;
46
50
  excluded_providers?: string[] | undefined;
47
51
  };
48
52
  manage_devices: {
@@ -58,6 +62,7 @@ export declare const portal_configuration: z.ZodDefault<z.ZodObject<{
58
62
  };
59
63
  }, {
60
64
  connect?: {
65
+ accepted_providers?: string[] | undefined;
61
66
  exclude?: boolean | undefined;
62
67
  excluded_providers?: string[] | undefined;
63
68
  } | undefined;
@@ -215,6 +220,7 @@ export declare const portal_configuration: z.ZodDefault<z.ZodObject<{
215
220
  features: {
216
221
  connect: {
217
222
  exclude: boolean;
223
+ accepted_providers?: string[] | undefined;
218
224
  excluded_providers?: string[] | undefined;
219
225
  };
220
226
  manage_devices: {
@@ -262,6 +268,7 @@ export declare const portal_configuration: z.ZodDefault<z.ZodObject<{
262
268
  }, {
263
269
  features?: {
264
270
  connect?: {
271
+ accepted_providers?: string[] | undefined;
265
272
  exclude?: boolean | undefined;
266
273
  excluded_providers?: string[] | undefined;
267
274
  } | undefined;
package/lib/seam/connect/models/customer/customer-portal.js CHANGED
@@ -8,6 +8,10 @@ const base_feature = z.object({
8
8
  .describe('Whether to exclude this feature from the portal.'),
9
9
  });
10
10
  const base_connect_feature = base_feature.extend({
11
+ accepted_providers: z
12
+ .array(z.string())
13
+ .optional()
14
+ .describe('List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.'),
11
15
  excluded_providers: z
12
16
  .array(z.string())
13
17
  .optional()
package/lib/seam/connect/models/customer/customer-portal.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"customer-portal.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/customer/customer-portal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE9D,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,kDAAkD,CAAC;CAChE,CAAC,CAAA;AAEF,MAAM,oBAAoB,GAAG,YAAY,CAAC,MAAM,CAAC;IAC/C,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,6IAA6I,CAC9I;CACJ,CAAC,CAAA;AACF,MAAM,2BAA2B,GAAG,YAAY,CAAA;AAChD,MAAM,qBAAqB,GAAG,YAAY,CAAA;AAE1C,MAAM,sBAAsB,GAAG,YAAY,CAAC,MAAM,CAAC;IACjD,0CAA0C,EAAE,CAAC;SAC1C,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,gGAAgG,CACjG;IACH,+BAA+B,EAAE,CAAC;SAC/B,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,4FAA4F,CAC7F;CACJ,CAAC,CAAA;AAEF,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,OAAO,EAAE,oBAAoB;SAC1B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,cAAc,EAAE,2BAA2B;SACxC,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,QAAQ,EAAE,qBAAqB;SAC5B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,yCAAyC,CAAC;IACtD,SAAS,EAAE,sBAAsB;SAC9B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,0CAA0C,CAAC;CACxD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,wDAAwD,CAAC;IACrE,YAAY,EAAE,CAAC;SACZ,MAAM,CAAC;QACN,MAAM,EAAE,CAAC;aACN,KAAK,CAAC,CAAC,oBAAoB,EAAE,wBAAwB,CAAC,CAAC;aACvD,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,2DAA2D,CAAC;CACzE,CAAC;KACD,OAAO,CAAC;IACP,QAAQ,EAAE;QACR,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAC3B,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAC5B,cAAc,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAClC,SAAS,EAAE;YACT,OAAO,EAAE,KAAK;YACd,+BAA+B,EAAE,KAAK,EAAE,UAAU;YAClD,0CAA0C,EAAE,KAAK,EAAE,UAAU;SAC9D;KACF;IACD,WAAW,EAAE,KAAK;CACnB,CAAC;KACD,QAAQ,CAAC,qCAAqC,CAAC,CAAA"}
1
+ {"version":3,"file":"customer-portal.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/customer/customer-portal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE9D,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,kDAAkD,CAAC;CAChE,CAAC,CAAA;AAEF,MAAM,oBAAoB,GAAG,YAAY,CAAC,MAAM,CAAC;IAC/C,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,sIAAsI,CACvI;IACH,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CACP,6IAA6I,CAC9I;CACJ,CAAC,CAAA;AACF,MAAM,2BAA2B,GAAG,YAAY,CAAA;AAChD,MAAM,qBAAqB,GAAG,YAAY,CAAA;AAE1C,MAAM,sBAAsB,GAAG,YAAY,CAAC,MAAM,CAAC;IACjD,0CAA0C,EAAE,CAAC;SAC1C,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,gGAAgG,CACjG;IACH,+BAA+B,EAAE,CAAC;SAC/B,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CACP,4FAA4F,CAC7F;CACJ,CAAC,CAAA;AAEF,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,OAAO,EAAE,oBAAoB;SAC1B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,cAAc,EAAE,2BAA2B;SACxC,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,QAAQ,EAAE,qBAAqB;SAC5B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,yCAAyC,CAAC;IACtD,SAAS,EAAE,sBAAsB;SAC9B,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,0CAA0C,CAAC;CACxD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,OAAO,CAAC,KAAK,CAAC;SACd,QAAQ,CAAC,wDAAwD,CAAC;IACrE,YAAY,EAAE,CAAC;SACZ,MAAM,CAAC;QACN,MAAM,EAAE,CAAC;aACN,KAAK,CAAC,CAAC,oBAAoB,EAAE,wBAAwB,CAAC,CAAC;aACvD,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,2DAA2D,CAAC;CACzE,CAAC;KACD,OAAO,CAAC;IACP,QAAQ,EAAE;QACR,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAC3B,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAC5B,cAAc,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAClC,SAAS,EAAE;YACT,OAAO,EAAE,KAAK;YACd,+BAA+B,EAAE,KAAK,EAAE,UAAU;YAClD,0CAA0C,EAAE,KAAK,EAAE,UAAU;SAC9D;KACF;IACD,WAAW,EAAE,KAAK;CACnB,CAAC;KACD,QAAQ,CAAC,qCAAqC,CAAC,CAAA"}
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -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;
@@ -31230,6 +31329,13 @@ declare const _default: {
31230
31329
  default: {};
31231
31330
  description: string;
31232
31331
  properties: {
31332
+ accepted_providers: {
31333
+ description: string;
31334
+ items: {
31335
+ type: string;
31336
+ };
31337
+ type: string;
31338
+ };
31233
31339
  exclude: {
31234
31340
  default: boolean;
31235
31341
  description: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -35779,7 +35779,7 @@ export default {
35779
35779
  type: 'string',
35780
35780
  },
35781
35781
  customer_key: {
35782
- description: 'Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key.',
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
  },
@@ -36826,6 +36913,11 @@ export default {
36826
36913
  default: {},
36827
36914
  description: 'Configuration for the connect accounts feature.',
36828
36915
  properties: {
36916
+ accepted_providers: {
36917
+ description: 'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
36918
+ items: { type: 'string' },
36919
+ type: 'array',
36920
+ },
36829
36921
  exclude: {
36830
36922
  default: false,
36831
36923
  description: 'Whether to exclude this feature from the portal.',