@seamapi/types 1.642.0 → 1.643.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.
@@ -43725,6 +43725,180 @@ declare const _default: {
43725
43725
  'x-undocumented': string;
43726
43726
  };
43727
43727
  };
43728
+ '/seam/customer/v1/connectors/connector_types': {
43729
+ get: {
43730
+ description: string;
43731
+ operationId: string;
43732
+ responses: {
43733
+ 200: {
43734
+ content: {
43735
+ 'application/json': {
43736
+ schema: {
43737
+ properties: {
43738
+ connector_types: {
43739
+ items: {
43740
+ properties: {
43741
+ connector_type: {
43742
+ type: string;
43743
+ };
43744
+ description: {
43745
+ type: string;
43746
+ };
43747
+ display_name: {
43748
+ type: string;
43749
+ };
43750
+ instance_config_schema: {
43751
+ $ref: string;
43752
+ };
43753
+ static_config: {
43754
+ properties: {
43755
+ base_api_url: {
43756
+ type: string;
43757
+ };
43758
+ polling_enabled: {
43759
+ type: string;
43760
+ };
43761
+ polling_frequency_minutes: {
43762
+ format: string;
43763
+ type: string;
43764
+ };
43765
+ };
43766
+ required: string[];
43767
+ type: string;
43768
+ };
43769
+ };
43770
+ required: string[];
43771
+ type: string;
43772
+ };
43773
+ type: string;
43774
+ };
43775
+ ok: {
43776
+ type: string;
43777
+ };
43778
+ };
43779
+ required: string[];
43780
+ type: string;
43781
+ };
43782
+ };
43783
+ };
43784
+ description: string;
43785
+ };
43786
+ 400: {
43787
+ description: string;
43788
+ };
43789
+ 401: {
43790
+ description: string;
43791
+ };
43792
+ };
43793
+ security: ({
43794
+ api_key: never[];
43795
+ client_session?: never;
43796
+ console_session_with_workspace?: never;
43797
+ } | {
43798
+ client_session: never[];
43799
+ api_key?: never;
43800
+ console_session_with_workspace?: never;
43801
+ } | {
43802
+ console_session_with_workspace: never[];
43803
+ api_key?: never;
43804
+ client_session?: never;
43805
+ })[];
43806
+ summary: string;
43807
+ tags: never[];
43808
+ 'x-fern-sdk-group-name': string[];
43809
+ 'x-fern-sdk-method-name': string;
43810
+ 'x-fern-sdk-return-value': string;
43811
+ 'x-response-key': string;
43812
+ 'x-title': string;
43813
+ 'x-undocumented': string;
43814
+ };
43815
+ post: {
43816
+ description: string;
43817
+ operationId: string;
43818
+ responses: {
43819
+ 200: {
43820
+ content: {
43821
+ 'application/json': {
43822
+ schema: {
43823
+ properties: {
43824
+ connector_types: {
43825
+ items: {
43826
+ properties: {
43827
+ connector_type: {
43828
+ type: string;
43829
+ };
43830
+ description: {
43831
+ type: string;
43832
+ };
43833
+ display_name: {
43834
+ type: string;
43835
+ };
43836
+ instance_config_schema: {
43837
+ $ref: string;
43838
+ };
43839
+ static_config: {
43840
+ properties: {
43841
+ base_api_url: {
43842
+ type: string;
43843
+ };
43844
+ polling_enabled: {
43845
+ type: string;
43846
+ };
43847
+ polling_frequency_minutes: {
43848
+ format: string;
43849
+ type: string;
43850
+ };
43851
+ };
43852
+ required: string[];
43853
+ type: string;
43854
+ };
43855
+ };
43856
+ required: string[];
43857
+ type: string;
43858
+ };
43859
+ type: string;
43860
+ };
43861
+ ok: {
43862
+ type: string;
43863
+ };
43864
+ };
43865
+ required: string[];
43866
+ type: string;
43867
+ };
43868
+ };
43869
+ };
43870
+ description: string;
43871
+ };
43872
+ 400: {
43873
+ description: string;
43874
+ };
43875
+ 401: {
43876
+ description: string;
43877
+ };
43878
+ };
43879
+ security: ({
43880
+ api_key: never[];
43881
+ client_session?: never;
43882
+ console_session_with_workspace?: never;
43883
+ } | {
43884
+ client_session: never[];
43885
+ api_key?: never;
43886
+ console_session_with_workspace?: never;
43887
+ } | {
43888
+ console_session_with_workspace: never[];
43889
+ api_key?: never;
43890
+ client_session?: never;
43891
+ })[];
43892
+ summary: string;
43893
+ tags: never[];
43894
+ 'x-fern-sdk-group-name': string[];
43895
+ 'x-fern-sdk-method-name': string;
43896
+ 'x-fern-sdk-return-value': string;
43897
+ 'x-response-key': string;
43898
+ 'x-title': string;
43899
+ 'x-undocumented': string;
43900
+ };
43901
+ };
43728
43902
  '/seam/customer/v1/connectors/create': {
43729
43903
  post: {
43730
43904
  description: string;
@@ -43735,45 +43909,9 @@ declare const _default: {
43735
43909
  schema: {
43736
43910
  properties: {
43737
43911
  config: {
43912
+ additionalProperties: {};
43738
43913
  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
- })[];
43914
+ type: string;
43777
43915
  };
43778
43916
  connector_type: {
43779
43917
  description: string;
@@ -44215,6 +44353,19 @@ declare const _default: {
44215
44353
  config: {
44216
44354
  description: string;
44217
44355
  oneOf: ({
44356
+ properties: {
44357
+ access_token?: never;
44358
+ client?: never;
44359
+ client_token?: never;
44360
+ enterprise_id?: never;
44361
+ enterprise_ids?: never;
44362
+ client_id?: never;
44363
+ client_password?: never;
44364
+ property_id?: never;
44365
+ };
44366
+ type: string;
44367
+ required?: never;
44368
+ } | {
44218
44369
  properties: {
44219
44370
  access_token: {
44220
44371
  minLength: number;
@@ -44230,26 +44381,49 @@ declare const _default: {
44230
44381
  type: string;
44231
44382
  };
44232
44383
  enterprise_id: {
44233
- format: string;
44234
44384
  type: string;
44235
44385
  };
44236
44386
  enterprise_ids: {
44237
44387
  items: {
44238
- format: string;
44239
44388
  type: string;
44240
44389
  };
44241
44390
  type: string;
44242
44391
  };
44392
+ client_id?: never;
44393
+ client_password?: never;
44394
+ property_id?: never;
44243
44395
  };
44244
44396
  type: string;
44397
+ required?: never;
44245
44398
  } | {
44246
44399
  properties: {
44400
+ client_id: {
44401
+ description: string;
44402
+ minLength: number;
44403
+ type: string;
44404
+ };
44405
+ client_password: {
44406
+ description: string;
44407
+ minLength: number;
44408
+ type: string;
44409
+ };
44410
+ property_id: {
44411
+ description: string;
44412
+ oneOf: ({
44413
+ type: string;
44414
+ format?: never;
44415
+ } | {
44416
+ format: string;
44417
+ type: string;
44418
+ })[];
44419
+ };
44247
44420
  access_token?: never;
44248
44421
  client?: never;
44249
44422
  client_token?: never;
44250
44423
  enterprise_id?: never;
44251
44424
  enterprise_ids?: never;
44252
44425
  };
44426
+ required: string[];
44253
44427
  type: string;
44254
44428
  })[];
44255
44429
  };
@@ -48588,9 +48588,151 @@ export default {
48588
48588
  'x-undocumented': 'Internal endpoint for customer portals.',
48589
48589
  },
48590
48590
  },
48591
+ '/seam/customer/v1/connectors/connector_types': {
48592
+ get: {
48593
+ description: 'Lists all available connector types and their required instance configuration schemas.',
48594
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesGet',
48595
+ responses: {
48596
+ 200: {
48597
+ content: {
48598
+ 'application/json': {
48599
+ schema: {
48600
+ properties: {
48601
+ connector_types: {
48602
+ items: {
48603
+ properties: {
48604
+ connector_type: { type: 'string' },
48605
+ description: { type: 'string' },
48606
+ display_name: { type: 'string' },
48607
+ instance_config_schema: {
48608
+ $ref: '#/components/schemas/access_code',
48609
+ },
48610
+ static_config: {
48611
+ properties: {
48612
+ base_api_url: { type: 'string' },
48613
+ polling_enabled: { type: 'boolean' },
48614
+ polling_frequency_minutes: {
48615
+ format: 'float',
48616
+ type: 'number',
48617
+ },
48618
+ },
48619
+ required: [
48620
+ 'base_api_url',
48621
+ 'polling_enabled',
48622
+ 'polling_frequency_minutes',
48623
+ ],
48624
+ type: 'object',
48625
+ },
48626
+ },
48627
+ required: [
48628
+ 'connector_type',
48629
+ 'display_name',
48630
+ 'static_config',
48631
+ ],
48632
+ type: 'object',
48633
+ },
48634
+ type: 'array',
48635
+ },
48636
+ ok: { type: 'boolean' },
48637
+ },
48638
+ required: ['connector_types', 'ok'],
48639
+ type: 'object',
48640
+ },
48641
+ },
48642
+ },
48643
+ description: 'OK',
48644
+ },
48645
+ 400: { description: 'Bad Request' },
48646
+ 401: { description: 'Unauthorized' },
48647
+ },
48648
+ security: [
48649
+ { api_key: [] },
48650
+ { client_session: [] },
48651
+ { console_session_with_workspace: [] },
48652
+ ],
48653
+ summary: '/seam/customer/v1/connectors/connector_types',
48654
+ tags: [],
48655
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
48656
+ 'x-fern-sdk-method-name': 'connector_types',
48657
+ 'x-fern-sdk-return-value': 'connector_types',
48658
+ 'x-response-key': 'connector_types',
48659
+ 'x-title': 'List Connector Types',
48660
+ 'x-undocumented': 'Internal endpoint for Console.',
48661
+ },
48662
+ post: {
48663
+ description: 'Lists all available connector types and their required instance configuration schemas.',
48664
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesPost',
48665
+ responses: {
48666
+ 200: {
48667
+ content: {
48668
+ 'application/json': {
48669
+ schema: {
48670
+ properties: {
48671
+ connector_types: {
48672
+ items: {
48673
+ properties: {
48674
+ connector_type: { type: 'string' },
48675
+ description: { type: 'string' },
48676
+ display_name: { type: 'string' },
48677
+ instance_config_schema: {
48678
+ $ref: '#/components/schemas/access_code',
48679
+ },
48680
+ static_config: {
48681
+ properties: {
48682
+ base_api_url: { type: 'string' },
48683
+ polling_enabled: { type: 'boolean' },
48684
+ polling_frequency_minutes: {
48685
+ format: 'float',
48686
+ type: 'number',
48687
+ },
48688
+ },
48689
+ required: [
48690
+ 'base_api_url',
48691
+ 'polling_enabled',
48692
+ 'polling_frequency_minutes',
48693
+ ],
48694
+ type: 'object',
48695
+ },
48696
+ },
48697
+ required: [
48698
+ 'connector_type',
48699
+ 'display_name',
48700
+ 'static_config',
48701
+ ],
48702
+ type: 'object',
48703
+ },
48704
+ type: 'array',
48705
+ },
48706
+ ok: { type: 'boolean' },
48707
+ },
48708
+ required: ['connector_types', 'ok'],
48709
+ type: 'object',
48710
+ },
48711
+ },
48712
+ },
48713
+ description: 'OK',
48714
+ },
48715
+ 400: { description: 'Bad Request' },
48716
+ 401: { description: 'Unauthorized' },
48717
+ },
48718
+ security: [
48719
+ { api_key: [] },
48720
+ { client_session: [] },
48721
+ { console_session_with_workspace: [] },
48722
+ ],
48723
+ summary: '/seam/customer/v1/connectors/connector_types',
48724
+ tags: [],
48725
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
48726
+ 'x-fern-sdk-method-name': 'connector_types',
48727
+ 'x-fern-sdk-return-value': 'connector_types',
48728
+ 'x-response-key': 'connector_types',
48729
+ 'x-title': 'List Connector Types',
48730
+ 'x-undocumented': 'Internal endpoint for Console.',
48731
+ },
48732
+ },
48591
48733
  '/seam/customer/v1/connectors/create': {
48592
48734
  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.',
48735
+ 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
48736
  operationId: 'seamCustomerV1ConnectorsCreatePost',
48595
48737
  requestBody: {
48596
48738
  content: {
@@ -48598,31 +48740,13 @@ export default {
48598
48740
  schema: {
48599
48741
  properties: {
48600
48742
  config: {
48743
+ additionalProperties: {},
48601
48744
  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
- ],
48745
+ type: 'object',
48622
48746
  },
48623
48747
  connector_type: {
48624
48748
  description: 'Type of connector to create',
48625
- enum: ['mews', 'mock'],
48749
+ enum: ['mock', 'mews', 'rms'],
48626
48750
  type: 'string',
48627
48751
  },
48628
48752
  customer_key: {
@@ -48970,6 +49094,7 @@ export default {
48970
49094
  config: {
48971
49095
  description: 'Instance-specific configuration for the connector',
48972
49096
  oneOf: [
49097
+ { properties: {}, type: 'object' },
48973
49098
  {
48974
49099
  properties: {
48975
49100
  access_token: { minLength: 1, type: 'string' },
@@ -48979,15 +49104,37 @@ export default {
48979
49104
  type: 'string',
48980
49105
  },
48981
49106
  client_token: { minLength: 1, type: 'string' },
48982
- enterprise_id: { format: 'uuid', type: 'string' },
49107
+ enterprise_id: { type: 'string' },
48983
49108
  enterprise_ids: {
48984
- items: { format: 'uuid', type: 'string' },
49109
+ items: { type: 'string' },
48985
49110
  type: 'array',
48986
49111
  },
48987
49112
  },
48988
49113
  type: 'object',
48989
49114
  },
48990
- { properties: {}, type: 'object' },
49115
+ {
49116
+ properties: {
49117
+ client_id: {
49118
+ description: 'RMS client ID for authentication',
49119
+ minLength: 1,
49120
+ type: 'string',
49121
+ },
49122
+ client_password: {
49123
+ description: 'RMS client password for authentication',
49124
+ minLength: 1,
49125
+ type: 'string',
49126
+ },
49127
+ property_id: {
49128
+ description: 'Optional property ID for single-property connectors',
49129
+ oneOf: [
49130
+ { type: 'string' },
49131
+ { format: 'float', type: 'number' },
49132
+ ],
49133
+ },
49134
+ },
49135
+ required: ['client_id', 'client_password'],
49136
+ type: 'object',
49137
+ },
48991
49138
  ],
48992
49139
  },
48993
49140
  connector_id: {