@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.
@@ -32014,6 +32014,71 @@ declare const _default: {
32014
32014
  'x-title': string;
32015
32015
  };
32016
32016
  };
32017
+ '/connected_accounts/simulate/disconnect': {
32018
+ post: {
32019
+ description: string;
32020
+ operationId: string;
32021
+ requestBody: {
32022
+ content: {
32023
+ 'application/json': {
32024
+ schema: {
32025
+ properties: {
32026
+ connected_account_id: {
32027
+ format: string;
32028
+ type: string;
32029
+ };
32030
+ };
32031
+ required: string[];
32032
+ type: string;
32033
+ };
32034
+ };
32035
+ };
32036
+ };
32037
+ responses: {
32038
+ 200: {
32039
+ content: {
32040
+ 'application/json': {
32041
+ schema: {
32042
+ properties: {
32043
+ ok: {
32044
+ type: string;
32045
+ };
32046
+ };
32047
+ required: string[];
32048
+ type: string;
32049
+ };
32050
+ };
32051
+ };
32052
+ description: string;
32053
+ };
32054
+ 400: {
32055
+ description: string;
32056
+ };
32057
+ 401: {
32058
+ description: string;
32059
+ };
32060
+ };
32061
+ security: ({
32062
+ api_key: never[];
32063
+ pat_with_workspace?: never;
32064
+ console_session_with_workspace?: never;
32065
+ } | {
32066
+ pat_with_workspace: never[];
32067
+ api_key?: never;
32068
+ console_session_with_workspace?: never;
32069
+ } | {
32070
+ console_session_with_workspace: never[];
32071
+ api_key?: never;
32072
+ pat_with_workspace?: never;
32073
+ })[];
32074
+ summary: string;
32075
+ tags: string[];
32076
+ 'x-fern-sdk-group-name': string[];
32077
+ 'x-fern-sdk-method-name': string;
32078
+ 'x-response-key': null;
32079
+ 'x-title': string;
32080
+ };
32081
+ };
32017
32082
  '/connected_accounts/sync': {
32018
32083
  post: {
32019
32084
  description: string;
@@ -43725,6 +43790,180 @@ declare const _default: {
43725
43790
  'x-undocumented': string;
43726
43791
  };
43727
43792
  };
43793
+ '/seam/customer/v1/connectors/connector_types': {
43794
+ get: {
43795
+ description: string;
43796
+ operationId: string;
43797
+ responses: {
43798
+ 200: {
43799
+ content: {
43800
+ 'application/json': {
43801
+ schema: {
43802
+ properties: {
43803
+ connector_types: {
43804
+ items: {
43805
+ properties: {
43806
+ connector_type: {
43807
+ type: string;
43808
+ };
43809
+ description: {
43810
+ type: string;
43811
+ };
43812
+ display_name: {
43813
+ type: string;
43814
+ };
43815
+ instance_config_schema: {
43816
+ $ref: string;
43817
+ };
43818
+ static_config: {
43819
+ properties: {
43820
+ base_api_url: {
43821
+ type: string;
43822
+ };
43823
+ polling_enabled: {
43824
+ type: string;
43825
+ };
43826
+ polling_frequency_minutes: {
43827
+ format: string;
43828
+ type: string;
43829
+ };
43830
+ };
43831
+ required: string[];
43832
+ type: string;
43833
+ };
43834
+ };
43835
+ required: string[];
43836
+ type: string;
43837
+ };
43838
+ type: string;
43839
+ };
43840
+ ok: {
43841
+ type: string;
43842
+ };
43843
+ };
43844
+ required: string[];
43845
+ type: string;
43846
+ };
43847
+ };
43848
+ };
43849
+ description: string;
43850
+ };
43851
+ 400: {
43852
+ description: string;
43853
+ };
43854
+ 401: {
43855
+ description: string;
43856
+ };
43857
+ };
43858
+ security: ({
43859
+ api_key: never[];
43860
+ client_session?: never;
43861
+ console_session_with_workspace?: never;
43862
+ } | {
43863
+ client_session: never[];
43864
+ api_key?: never;
43865
+ console_session_with_workspace?: never;
43866
+ } | {
43867
+ console_session_with_workspace: never[];
43868
+ api_key?: never;
43869
+ client_session?: never;
43870
+ })[];
43871
+ summary: string;
43872
+ tags: never[];
43873
+ 'x-fern-sdk-group-name': string[];
43874
+ 'x-fern-sdk-method-name': string;
43875
+ 'x-fern-sdk-return-value': string;
43876
+ 'x-response-key': string;
43877
+ 'x-title': string;
43878
+ 'x-undocumented': string;
43879
+ };
43880
+ post: {
43881
+ description: string;
43882
+ operationId: string;
43883
+ responses: {
43884
+ 200: {
43885
+ content: {
43886
+ 'application/json': {
43887
+ schema: {
43888
+ properties: {
43889
+ connector_types: {
43890
+ items: {
43891
+ properties: {
43892
+ connector_type: {
43893
+ type: string;
43894
+ };
43895
+ description: {
43896
+ type: string;
43897
+ };
43898
+ display_name: {
43899
+ type: string;
43900
+ };
43901
+ instance_config_schema: {
43902
+ $ref: string;
43903
+ };
43904
+ static_config: {
43905
+ properties: {
43906
+ base_api_url: {
43907
+ type: string;
43908
+ };
43909
+ polling_enabled: {
43910
+ type: string;
43911
+ };
43912
+ polling_frequency_minutes: {
43913
+ format: string;
43914
+ type: string;
43915
+ };
43916
+ };
43917
+ required: string[];
43918
+ type: string;
43919
+ };
43920
+ };
43921
+ required: string[];
43922
+ type: string;
43923
+ };
43924
+ type: string;
43925
+ };
43926
+ ok: {
43927
+ type: string;
43928
+ };
43929
+ };
43930
+ required: string[];
43931
+ type: string;
43932
+ };
43933
+ };
43934
+ };
43935
+ description: string;
43936
+ };
43937
+ 400: {
43938
+ description: string;
43939
+ };
43940
+ 401: {
43941
+ description: string;
43942
+ };
43943
+ };
43944
+ security: ({
43945
+ api_key: never[];
43946
+ client_session?: never;
43947
+ console_session_with_workspace?: never;
43948
+ } | {
43949
+ client_session: never[];
43950
+ api_key?: never;
43951
+ console_session_with_workspace?: never;
43952
+ } | {
43953
+ console_session_with_workspace: never[];
43954
+ api_key?: never;
43955
+ client_session?: never;
43956
+ })[];
43957
+ summary: string;
43958
+ tags: never[];
43959
+ 'x-fern-sdk-group-name': string[];
43960
+ 'x-fern-sdk-method-name': string;
43961
+ 'x-fern-sdk-return-value': string;
43962
+ 'x-response-key': string;
43963
+ 'x-title': string;
43964
+ 'x-undocumented': string;
43965
+ };
43966
+ };
43728
43967
  '/seam/customer/v1/connectors/create': {
43729
43968
  post: {
43730
43969
  description: string;
@@ -43735,45 +43974,9 @@ declare const _default: {
43735
43974
  schema: {
43736
43975
  properties: {
43737
43976
  config: {
43977
+ additionalProperties: {};
43738
43978
  description: string;
43739
- oneOf: ({
43740
- properties: {
43741
- access_token: {
43742
- minLength: number;
43743
- type: string;
43744
- };
43745
- client: {
43746
- default: string;
43747
- minLength: number;
43748
- type: string;
43749
- };
43750
- client_token: {
43751
- minLength: number;
43752
- type: string;
43753
- };
43754
- enterprise_id: {
43755
- format: string;
43756
- type: string;
43757
- };
43758
- enterprise_ids: {
43759
- items: {
43760
- format: string;
43761
- type: string;
43762
- };
43763
- type: string;
43764
- };
43765
- };
43766
- type: string;
43767
- } | {
43768
- properties: {
43769
- access_token?: never;
43770
- client?: never;
43771
- client_token?: never;
43772
- enterprise_id?: never;
43773
- enterprise_ids?: never;
43774
- };
43775
- type: string;
43776
- })[];
43979
+ type: string;
43777
43980
  };
43778
43981
  connector_type: {
43779
43982
  description: string;
@@ -44215,6 +44418,19 @@ declare const _default: {
44215
44418
  config: {
44216
44419
  description: string;
44217
44420
  oneOf: ({
44421
+ properties: {
44422
+ access_token?: never;
44423
+ client?: never;
44424
+ client_token?: never;
44425
+ enterprise_id?: never;
44426
+ enterprise_ids?: never;
44427
+ client_id?: never;
44428
+ client_password?: never;
44429
+ property_id?: never;
44430
+ };
44431
+ type: string;
44432
+ required?: never;
44433
+ } | {
44218
44434
  properties: {
44219
44435
  access_token: {
44220
44436
  minLength: number;
@@ -44230,26 +44446,49 @@ declare const _default: {
44230
44446
  type: string;
44231
44447
  };
44232
44448
  enterprise_id: {
44233
- format: string;
44234
44449
  type: string;
44235
44450
  };
44236
44451
  enterprise_ids: {
44237
44452
  items: {
44238
- format: string;
44239
44453
  type: string;
44240
44454
  };
44241
44455
  type: string;
44242
44456
  };
44457
+ client_id?: never;
44458
+ client_password?: never;
44459
+ property_id?: never;
44243
44460
  };
44244
44461
  type: string;
44462
+ required?: never;
44245
44463
  } | {
44246
44464
  properties: {
44465
+ client_id: {
44466
+ description: string;
44467
+ minLength: number;
44468
+ type: string;
44469
+ };
44470
+ client_password: {
44471
+ description: string;
44472
+ minLength: number;
44473
+ type: string;
44474
+ };
44475
+ property_id: {
44476
+ description: string;
44477
+ oneOf: ({
44478
+ type: string;
44479
+ format?: never;
44480
+ } | {
44481
+ format: string;
44482
+ type: string;
44483
+ })[];
44484
+ };
44247
44485
  access_token?: never;
44248
44486
  client?: never;
44249
44487
  client_token?: never;
44250
44488
  enterprise_id?: never;
44251
44489
  enterprise_ids?: never;
44252
44490
  };
44491
+ required: string[];
44253
44492
  type: string;
44254
44493
  })[];
44255
44494
  };
@@ -37339,6 +37339,52 @@ export default {
37339
37339
  'x-title': 'List Connected Accounts',
37340
37340
  },
37341
37341
  },
37342
+ '/connected_accounts/simulate/disconnect': {
37343
+ post: {
37344
+ description: 'Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
37345
+ operationId: 'connectedAccountsSimulateDisconnectPost',
37346
+ requestBody: {
37347
+ content: {
37348
+ 'application/json': {
37349
+ schema: {
37350
+ properties: {
37351
+ connected_account_id: { format: 'uuid', type: 'string' },
37352
+ },
37353
+ required: ['connected_account_id'],
37354
+ type: 'object',
37355
+ },
37356
+ },
37357
+ },
37358
+ },
37359
+ responses: {
37360
+ 200: {
37361
+ content: {
37362
+ 'application/json': {
37363
+ schema: {
37364
+ properties: { ok: { type: 'boolean' } },
37365
+ required: ['ok'],
37366
+ type: 'object',
37367
+ },
37368
+ },
37369
+ },
37370
+ description: 'OK',
37371
+ },
37372
+ 400: { description: 'Bad Request' },
37373
+ 401: { description: 'Unauthorized' },
37374
+ },
37375
+ security: [
37376
+ { api_key: [] },
37377
+ { pat_with_workspace: [] },
37378
+ { console_session_with_workspace: [] },
37379
+ ],
37380
+ summary: '/connected_accounts/simulate/disconnect',
37381
+ tags: ['/connected_accounts'],
37382
+ 'x-fern-sdk-group-name': ['connected_accounts', 'simulate'],
37383
+ 'x-fern-sdk-method-name': 'disconnect',
37384
+ 'x-response-key': null,
37385
+ 'x-title': 'Simulate Connected Account Disconnection',
37386
+ },
37387
+ },
37342
37388
  '/connected_accounts/sync': {
37343
37389
  post: {
37344
37390
  description: 'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.',
@@ -48588,9 +48634,151 @@ export default {
48588
48634
  'x-undocumented': 'Internal endpoint for customer portals.',
48589
48635
  },
48590
48636
  },
48637
+ '/seam/customer/v1/connectors/connector_types': {
48638
+ get: {
48639
+ description: 'Lists all available connector types and their required instance configuration schemas.',
48640
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesGet',
48641
+ responses: {
48642
+ 200: {
48643
+ content: {
48644
+ 'application/json': {
48645
+ schema: {
48646
+ properties: {
48647
+ connector_types: {
48648
+ items: {
48649
+ properties: {
48650
+ connector_type: { type: 'string' },
48651
+ description: { type: 'string' },
48652
+ display_name: { type: 'string' },
48653
+ instance_config_schema: {
48654
+ $ref: '#/components/schemas/access_code',
48655
+ },
48656
+ static_config: {
48657
+ properties: {
48658
+ base_api_url: { type: 'string' },
48659
+ polling_enabled: { type: 'boolean' },
48660
+ polling_frequency_minutes: {
48661
+ format: 'float',
48662
+ type: 'number',
48663
+ },
48664
+ },
48665
+ required: [
48666
+ 'base_api_url',
48667
+ 'polling_enabled',
48668
+ 'polling_frequency_minutes',
48669
+ ],
48670
+ type: 'object',
48671
+ },
48672
+ },
48673
+ required: [
48674
+ 'connector_type',
48675
+ 'display_name',
48676
+ 'static_config',
48677
+ ],
48678
+ type: 'object',
48679
+ },
48680
+ type: 'array',
48681
+ },
48682
+ ok: { type: 'boolean' },
48683
+ },
48684
+ required: ['connector_types', 'ok'],
48685
+ type: 'object',
48686
+ },
48687
+ },
48688
+ },
48689
+ description: 'OK',
48690
+ },
48691
+ 400: { description: 'Bad Request' },
48692
+ 401: { description: 'Unauthorized' },
48693
+ },
48694
+ security: [
48695
+ { api_key: [] },
48696
+ { client_session: [] },
48697
+ { console_session_with_workspace: [] },
48698
+ ],
48699
+ summary: '/seam/customer/v1/connectors/connector_types',
48700
+ tags: [],
48701
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
48702
+ 'x-fern-sdk-method-name': 'connector_types',
48703
+ 'x-fern-sdk-return-value': 'connector_types',
48704
+ 'x-response-key': 'connector_types',
48705
+ 'x-title': 'List Connector Types',
48706
+ 'x-undocumented': 'Internal endpoint for Console.',
48707
+ },
48708
+ post: {
48709
+ description: 'Lists all available connector types and their required instance configuration schemas.',
48710
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesPost',
48711
+ responses: {
48712
+ 200: {
48713
+ content: {
48714
+ 'application/json': {
48715
+ schema: {
48716
+ properties: {
48717
+ connector_types: {
48718
+ items: {
48719
+ properties: {
48720
+ connector_type: { type: 'string' },
48721
+ description: { type: 'string' },
48722
+ display_name: { type: 'string' },
48723
+ instance_config_schema: {
48724
+ $ref: '#/components/schemas/access_code',
48725
+ },
48726
+ static_config: {
48727
+ properties: {
48728
+ base_api_url: { type: 'string' },
48729
+ polling_enabled: { type: 'boolean' },
48730
+ polling_frequency_minutes: {
48731
+ format: 'float',
48732
+ type: 'number',
48733
+ },
48734
+ },
48735
+ required: [
48736
+ 'base_api_url',
48737
+ 'polling_enabled',
48738
+ 'polling_frequency_minutes',
48739
+ ],
48740
+ type: 'object',
48741
+ },
48742
+ },
48743
+ required: [
48744
+ 'connector_type',
48745
+ 'display_name',
48746
+ 'static_config',
48747
+ ],
48748
+ type: 'object',
48749
+ },
48750
+ type: 'array',
48751
+ },
48752
+ ok: { type: 'boolean' },
48753
+ },
48754
+ required: ['connector_types', 'ok'],
48755
+ type: 'object',
48756
+ },
48757
+ },
48758
+ },
48759
+ description: 'OK',
48760
+ },
48761
+ 400: { description: 'Bad Request' },
48762
+ 401: { description: 'Unauthorized' },
48763
+ },
48764
+ security: [
48765
+ { api_key: [] },
48766
+ { client_session: [] },
48767
+ { console_session_with_workspace: [] },
48768
+ ],
48769
+ summary: '/seam/customer/v1/connectors/connector_types',
48770
+ tags: [],
48771
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
48772
+ 'x-fern-sdk-method-name': 'connector_types',
48773
+ 'x-fern-sdk-return-value': 'connector_types',
48774
+ 'x-response-key': 'connector_types',
48775
+ 'x-title': 'List Connector Types',
48776
+ 'x-undocumented': 'Internal endpoint for Console.',
48777
+ },
48778
+ },
48591
48779
  '/seam/customer/v1/connectors/create': {
48592
48780
  post: {
48593
- description: '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.',
48781
+ description: '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.',
48594
48782
  operationId: 'seamCustomerV1ConnectorsCreatePost',
48595
48783
  requestBody: {
48596
48784
  content: {
@@ -48598,31 +48786,13 @@ export default {
48598
48786
  schema: {
48599
48787
  properties: {
48600
48788
  config: {
48789
+ additionalProperties: {},
48601
48790
  description: 'Instance-specific configuration for the connector',
48602
- oneOf: [
48603
- {
48604
- properties: {
48605
- access_token: { minLength: 1, type: 'string' },
48606
- client: {
48607
- default: 'seam',
48608
- minLength: 1,
48609
- type: 'string',
48610
- },
48611
- client_token: { minLength: 1, type: 'string' },
48612
- enterprise_id: { format: 'uuid', type: 'string' },
48613
- enterprise_ids: {
48614
- items: { format: 'uuid', type: 'string' },
48615
- type: 'array',
48616
- },
48617
- },
48618
- type: 'object',
48619
- },
48620
- { properties: {}, type: 'object' },
48621
- ],
48791
+ type: 'object',
48622
48792
  },
48623
48793
  connector_type: {
48624
48794
  description: 'Type of connector to create',
48625
- enum: ['mews', 'mock'],
48795
+ enum: ['mock', 'mews', 'rms'],
48626
48796
  type: 'string',
48627
48797
  },
48628
48798
  customer_key: {
@@ -48970,6 +49140,7 @@ export default {
48970
49140
  config: {
48971
49141
  description: 'Instance-specific configuration for the connector',
48972
49142
  oneOf: [
49143
+ { properties: {}, type: 'object' },
48973
49144
  {
48974
49145
  properties: {
48975
49146
  access_token: { minLength: 1, type: 'string' },
@@ -48979,15 +49150,37 @@ export default {
48979
49150
  type: 'string',
48980
49151
  },
48981
49152
  client_token: { minLength: 1, type: 'string' },
48982
- enterprise_id: { format: 'uuid', type: 'string' },
49153
+ enterprise_id: { type: 'string' },
48983
49154
  enterprise_ids: {
48984
- items: { format: 'uuid', type: 'string' },
49155
+ items: { type: 'string' },
48985
49156
  type: 'array',
48986
49157
  },
48987
49158
  },
48988
49159
  type: 'object',
48989
49160
  },
48990
- { properties: {}, type: 'object' },
49161
+ {
49162
+ properties: {
49163
+ client_id: {
49164
+ description: 'RMS client ID for authentication',
49165
+ minLength: 1,
49166
+ type: 'string',
49167
+ },
49168
+ client_password: {
49169
+ description: 'RMS client password for authentication',
49170
+ minLength: 1,
49171
+ type: 'string',
49172
+ },
49173
+ property_id: {
49174
+ description: 'Optional property ID for single-property connectors',
49175
+ oneOf: [
49176
+ { type: 'string' },
49177
+ { format: 'float', type: 'number' },
49178
+ ],
49179
+ },
49180
+ },
49181
+ required: ['client_id', 'client_password'],
49182
+ type: 'object',
49183
+ },
48991
49184
  ],
48992
49185
  },
48993
49186
  connector_id: {