@seamapi/types 1.642.0 → 1.644.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.
@@ -31665,6 +31665,17 @@ export type Routes = {
31665
31665
  };
31666
31666
  };
31667
31667
  };
31668
+ '/connected_accounts/simulate/disconnect': {
31669
+ route: '/connected_accounts/simulate/disconnect';
31670
+ method: 'POST';
31671
+ queryParams: {};
31672
+ jsonBody: {
31673
+ connected_account_id: string;
31674
+ };
31675
+ commonParams: {};
31676
+ formData: {};
31677
+ jsonResponse: {};
31678
+ };
31668
31679
  '/connected_accounts/sync': {
31669
31680
  route: '/connected_accounts/sync';
31670
31681
  method: 'POST';
@@ -57456,23 +57467,40 @@ export type Routes = {
57456
57467
  formData: {};
57457
57468
  jsonResponse: {};
57458
57469
  };
57470
+ '/seam/customer/v1/connectors/connector_types': {
57471
+ route: '/seam/customer/v1/connectors/connector_types';
57472
+ method: 'GET' | 'POST';
57473
+ queryParams: {};
57474
+ jsonBody: {};
57475
+ commonParams: {};
57476
+ formData: {};
57477
+ jsonResponse: {
57478
+ connector_types: {
57479
+ connector_type: string;
57480
+ display_name: string;
57481
+ description?: string | undefined;
57482
+ instance_config_schema?: any;
57483
+ static_config: {
57484
+ base_api_url: string;
57485
+ polling_enabled: boolean;
57486
+ polling_frequency_minutes: number;
57487
+ };
57488
+ }[];
57489
+ };
57490
+ };
57459
57491
  '/seam/customer/v1/connectors/create': {
57460
57492
  route: '/seam/customer/v1/connectors/create';
57461
57493
  method: 'POST';
57462
57494
  queryParams: {};
57463
57495
  jsonBody: {
57464
57496
  /** Type of connector to create */
57465
- connector_type: 'mews' | 'mock';
57497
+ connector_type: 'mock' | 'mews' | 'rms';
57466
57498
  /** Key identifying the customer */
57467
57499
  customer_key?: string | undefined;
57468
57500
  /** Instance-specific configuration for the connector */
57469
57501
  config: {
57470
- client_token?: string | undefined;
57471
- access_token?: string | undefined;
57472
- client?: string;
57473
- enterprise_ids?: string[] | undefined;
57474
- enterprise_id?: string | undefined;
57475
- } | {};
57502
+ [x: string]: unknown;
57503
+ };
57476
57504
  };
57477
57505
  commonParams: {};
57478
57506
  formData: {};
@@ -57557,13 +57585,20 @@ export type Routes = {
57557
57585
  /** Key identifying the customer */
57558
57586
  customer_key?: string | undefined;
57559
57587
  /** Instance-specific configuration for the connector */
57560
- config: {
57588
+ config: {} | {
57561
57589
  client_token?: string | undefined;
57562
57590
  access_token?: string | undefined;
57563
57591
  client?: string;
57564
57592
  enterprise_ids?: string[] | undefined;
57565
57593
  enterprise_id?: string | undefined;
57566
- } | {};
57594
+ } | {
57595
+ /** RMS client ID for authentication */
57596
+ client_id: string;
57597
+ /** RMS client password for authentication */
57598
+ client_password: string;
57599
+ /** Optional property ID for single-property connectors */
57600
+ property_id?: (string | number) | undefined;
57601
+ };
57567
57602
  };
57568
57603
  commonParams: {};
57569
57604
  formData: {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.642.0",
3
+ "version": "1.644.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -40947,6 +40947,53 @@ export default {
40947
40947
  'x-title': 'List Connected Accounts',
40948
40948
  },
40949
40949
  },
40950
+ '/connected_accounts/simulate/disconnect': {
40951
+ post: {
40952
+ description:
40953
+ 'Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
40954
+ operationId: 'connectedAccountsSimulateDisconnectPost',
40955
+ requestBody: {
40956
+ content: {
40957
+ 'application/json': {
40958
+ schema: {
40959
+ properties: {
40960
+ connected_account_id: { format: 'uuid', type: 'string' },
40961
+ },
40962
+ required: ['connected_account_id'],
40963
+ type: 'object',
40964
+ },
40965
+ },
40966
+ },
40967
+ },
40968
+ responses: {
40969
+ 200: {
40970
+ content: {
40971
+ 'application/json': {
40972
+ schema: {
40973
+ properties: { ok: { type: 'boolean' } },
40974
+ required: ['ok'],
40975
+ type: 'object',
40976
+ },
40977
+ },
40978
+ },
40979
+ description: 'OK',
40980
+ },
40981
+ 400: { description: 'Bad Request' },
40982
+ 401: { description: 'Unauthorized' },
40983
+ },
40984
+ security: [
40985
+ { api_key: [] },
40986
+ { pat_with_workspace: [] },
40987
+ { console_session_with_workspace: [] },
40988
+ ],
40989
+ summary: '/connected_accounts/simulate/disconnect',
40990
+ tags: ['/connected_accounts'],
40991
+ 'x-fern-sdk-group-name': ['connected_accounts', 'simulate'],
40992
+ 'x-fern-sdk-method-name': 'disconnect',
40993
+ 'x-response-key': null,
40994
+ 'x-title': 'Simulate Connected Account Disconnection',
40995
+ },
40996
+ },
40950
40997
  '/connected_accounts/sync': {
40951
40998
  post: {
40952
40999
  description:
@@ -52786,10 +52833,154 @@ export default {
52786
52833
  'x-undocumented': 'Internal endpoint for customer portals.',
52787
52834
  },
52788
52835
  },
52836
+ '/seam/customer/v1/connectors/connector_types': {
52837
+ get: {
52838
+ description:
52839
+ 'Lists all available connector types and their required instance configuration schemas.',
52840
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesGet',
52841
+ responses: {
52842
+ 200: {
52843
+ content: {
52844
+ 'application/json': {
52845
+ schema: {
52846
+ properties: {
52847
+ connector_types: {
52848
+ items: {
52849
+ properties: {
52850
+ connector_type: { type: 'string' },
52851
+ description: { type: 'string' },
52852
+ display_name: { type: 'string' },
52853
+ instance_config_schema: {
52854
+ $ref: '#/components/schemas/access_code',
52855
+ },
52856
+ static_config: {
52857
+ properties: {
52858
+ base_api_url: { type: 'string' },
52859
+ polling_enabled: { type: 'boolean' },
52860
+ polling_frequency_minutes: {
52861
+ format: 'float',
52862
+ type: 'number',
52863
+ },
52864
+ },
52865
+ required: [
52866
+ 'base_api_url',
52867
+ 'polling_enabled',
52868
+ 'polling_frequency_minutes',
52869
+ ],
52870
+ type: 'object',
52871
+ },
52872
+ },
52873
+ required: [
52874
+ 'connector_type',
52875
+ 'display_name',
52876
+ 'static_config',
52877
+ ],
52878
+ type: 'object',
52879
+ },
52880
+ type: 'array',
52881
+ },
52882
+ ok: { type: 'boolean' },
52883
+ },
52884
+ required: ['connector_types', 'ok'],
52885
+ type: 'object',
52886
+ },
52887
+ },
52888
+ },
52889
+ description: 'OK',
52890
+ },
52891
+ 400: { description: 'Bad Request' },
52892
+ 401: { description: 'Unauthorized' },
52893
+ },
52894
+ security: [
52895
+ { api_key: [] },
52896
+ { client_session: [] },
52897
+ { console_session_with_workspace: [] },
52898
+ ],
52899
+ summary: '/seam/customer/v1/connectors/connector_types',
52900
+ tags: [],
52901
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52902
+ 'x-fern-sdk-method-name': 'connector_types',
52903
+ 'x-fern-sdk-return-value': 'connector_types',
52904
+ 'x-response-key': 'connector_types',
52905
+ 'x-title': 'List Connector Types',
52906
+ 'x-undocumented': 'Internal endpoint for Console.',
52907
+ },
52908
+ post: {
52909
+ description:
52910
+ 'Lists all available connector types and their required instance configuration schemas.',
52911
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesPost',
52912
+ responses: {
52913
+ 200: {
52914
+ content: {
52915
+ 'application/json': {
52916
+ schema: {
52917
+ properties: {
52918
+ connector_types: {
52919
+ items: {
52920
+ properties: {
52921
+ connector_type: { type: 'string' },
52922
+ description: { type: 'string' },
52923
+ display_name: { type: 'string' },
52924
+ instance_config_schema: {
52925
+ $ref: '#/components/schemas/access_code',
52926
+ },
52927
+ static_config: {
52928
+ properties: {
52929
+ base_api_url: { type: 'string' },
52930
+ polling_enabled: { type: 'boolean' },
52931
+ polling_frequency_minutes: {
52932
+ format: 'float',
52933
+ type: 'number',
52934
+ },
52935
+ },
52936
+ required: [
52937
+ 'base_api_url',
52938
+ 'polling_enabled',
52939
+ 'polling_frequency_minutes',
52940
+ ],
52941
+ type: 'object',
52942
+ },
52943
+ },
52944
+ required: [
52945
+ 'connector_type',
52946
+ 'display_name',
52947
+ 'static_config',
52948
+ ],
52949
+ type: 'object',
52950
+ },
52951
+ type: 'array',
52952
+ },
52953
+ ok: { type: 'boolean' },
52954
+ },
52955
+ required: ['connector_types', 'ok'],
52956
+ type: 'object',
52957
+ },
52958
+ },
52959
+ },
52960
+ description: 'OK',
52961
+ },
52962
+ 400: { description: 'Bad Request' },
52963
+ 401: { description: 'Unauthorized' },
52964
+ },
52965
+ security: [
52966
+ { api_key: [] },
52967
+ { client_session: [] },
52968
+ { console_session_with_workspace: [] },
52969
+ ],
52970
+ summary: '/seam/customer/v1/connectors/connector_types',
52971
+ tags: [],
52972
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52973
+ 'x-fern-sdk-method-name': 'connector_types',
52974
+ 'x-fern-sdk-return-value': 'connector_types',
52975
+ 'x-response-key': 'connector_types',
52976
+ 'x-title': 'List Connector Types',
52977
+ 'x-undocumented': 'Internal endpoint for Console.',
52978
+ },
52979
+ },
52789
52980
  '/seam/customer/v1/connectors/create': {
52790
52981
  post: {
52791
52982
  description:
52792
- 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists with the same unique_provider_resource_key, it will be updated instead of creating a new one.',
52983
+ 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists for the same customer, it will be updated instead of creating a new one.',
52793
52984
  operationId: 'seamCustomerV1ConnectorsCreatePost',
52794
52985
  requestBody: {
52795
52986
  content: {
@@ -52797,32 +52988,14 @@ export default {
52797
52988
  schema: {
52798
52989
  properties: {
52799
52990
  config: {
52991
+ additionalProperties: {},
52800
52992
  description:
52801
52993
  'Instance-specific configuration for the connector',
52802
- oneOf: [
52803
- {
52804
- properties: {
52805
- access_token: { minLength: 1, type: 'string' },
52806
- client: {
52807
- default: 'seam',
52808
- minLength: 1,
52809
- type: 'string',
52810
- },
52811
- client_token: { minLength: 1, type: 'string' },
52812
- enterprise_id: { format: 'uuid', type: 'string' },
52813
- enterprise_ids: {
52814
- items: { format: 'uuid', type: 'string' },
52815
- type: 'array',
52816
- },
52817
- },
52818
- type: 'object',
52819
- },
52820
- { properties: {}, type: 'object' },
52821
- ],
52994
+ type: 'object',
52822
52995
  },
52823
52996
  connector_type: {
52824
52997
  description: 'Type of connector to create',
52825
- enum: ['mews', 'mock'],
52998
+ enum: ['mock', 'mews', 'rms'],
52826
52999
  type: 'string',
52827
53000
  },
52828
53001
  customer_key: {
@@ -53176,6 +53349,7 @@ export default {
53176
53349
  description:
53177
53350
  'Instance-specific configuration for the connector',
53178
53351
  oneOf: [
53352
+ { properties: {}, type: 'object' },
53179
53353
  {
53180
53354
  properties: {
53181
53355
  access_token: { minLength: 1, type: 'string' },
@@ -53185,15 +53359,39 @@ export default {
53185
53359
  type: 'string',
53186
53360
  },
53187
53361
  client_token: { minLength: 1, type: 'string' },
53188
- enterprise_id: { format: 'uuid', type: 'string' },
53362
+ enterprise_id: { type: 'string' },
53189
53363
  enterprise_ids: {
53190
- items: { format: 'uuid', type: 'string' },
53364
+ items: { type: 'string' },
53191
53365
  type: 'array',
53192
53366
  },
53193
53367
  },
53194
53368
  type: 'object',
53195
53369
  },
53196
- { properties: {}, type: 'object' },
53370
+ {
53371
+ properties: {
53372
+ client_id: {
53373
+ description: 'RMS client ID for authentication',
53374
+ minLength: 1,
53375
+ type: 'string',
53376
+ },
53377
+ client_password: {
53378
+ description:
53379
+ 'RMS client password for authentication',
53380
+ minLength: 1,
53381
+ type: 'string',
53382
+ },
53383
+ property_id: {
53384
+ description:
53385
+ 'Optional property ID for single-property connectors',
53386
+ oneOf: [
53387
+ { type: 'string' },
53388
+ { format: 'float', type: 'number' },
53389
+ ],
53390
+ },
53391
+ },
53392
+ required: ['client_id', 'client_password'],
53393
+ type: 'object',
53394
+ },
53197
53395
  ],
53198
53396
  },
53199
53397
  connector_id: {
@@ -36781,6 +36781,17 @@ export type Routes = {
36781
36781
  }
36782
36782
  }
36783
36783
  }
36784
+ '/connected_accounts/simulate/disconnect': {
36785
+ route: '/connected_accounts/simulate/disconnect'
36786
+ method: 'POST'
36787
+ queryParams: {}
36788
+ jsonBody: {
36789
+ connected_account_id: string
36790
+ }
36791
+ commonParams: {}
36792
+ formData: {}
36793
+ jsonResponse: {}
36794
+ }
36784
36795
  '/connected_accounts/sync': {
36785
36796
  route: '/connected_accounts/sync'
36786
36797
  method: 'POST'
@@ -68283,25 +68294,40 @@ export type Routes = {
68283
68294
  formData: {}
68284
68295
  jsonResponse: {}
68285
68296
  }
68297
+ '/seam/customer/v1/connectors/connector_types': {
68298
+ route: '/seam/customer/v1/connectors/connector_types'
68299
+ method: 'GET' | 'POST'
68300
+ queryParams: {}
68301
+ jsonBody: {}
68302
+ commonParams: {}
68303
+ formData: {}
68304
+ jsonResponse: {
68305
+ connector_types: {
68306
+ connector_type: string
68307
+ display_name: string
68308
+ description?: string | undefined
68309
+ instance_config_schema?: any
68310
+ static_config: {
68311
+ base_api_url: string
68312
+ polling_enabled: boolean
68313
+ polling_frequency_minutes: number
68314
+ }
68315
+ }[]
68316
+ }
68317
+ }
68286
68318
  '/seam/customer/v1/connectors/create': {
68287
68319
  route: '/seam/customer/v1/connectors/create'
68288
68320
  method: 'POST'
68289
68321
  queryParams: {}
68290
68322
  jsonBody: {
68291
68323
  /** Type of connector to create */
68292
- connector_type: 'mews' | 'mock'
68324
+ connector_type: 'mock' | 'mews' | 'rms'
68293
68325
  /** Key identifying the customer */
68294
68326
  customer_key?: string | undefined
68295
68327
  /** Instance-specific configuration for the connector */
68296
- config:
68297
- | {
68298
- client_token?: string | undefined
68299
- access_token?: string | undefined
68300
- client?: string
68301
- enterprise_ids?: string[] | undefined
68302
- enterprise_id?: string | undefined
68303
- }
68304
- | {}
68328
+ config: {
68329
+ [x: string]: unknown
68330
+ }
68305
68331
  }
68306
68332
  commonParams: {}
68307
68333
  formData: {}
@@ -68389,6 +68415,7 @@ export type Routes = {
68389
68415
  customer_key?: string | undefined
68390
68416
  /** Instance-specific configuration for the connector */
68391
68417
  config:
68418
+ | {}
68392
68419
  | {
68393
68420
  client_token?: string | undefined
68394
68421
  access_token?: string | undefined
@@ -68396,7 +68423,14 @@ export type Routes = {
68396
68423
  enterprise_ids?: string[] | undefined
68397
68424
  enterprise_id?: string | undefined
68398
68425
  }
68399
- | {}
68426
+ | {
68427
+ /** RMS client ID for authentication */
68428
+ client_id: string
68429
+ /** RMS client password for authentication */
68430
+ client_password: string
68431
+ /** Optional property ID for single-property connectors */
68432
+ property_id?: (string | number) | undefined
68433
+ }
68400
68434
  }
68401
68435
  commonParams: {}
68402
68436
  formData: {}