@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.
@@ -95801,6 +95801,180 @@ declare const _default: {
95801
95801
  'x-undocumented': string;
95802
95802
  };
95803
95803
  };
95804
+ '/seam/customer/v1/connectors/connector_types': {
95805
+ get: {
95806
+ description: string;
95807
+ operationId: string;
95808
+ responses: {
95809
+ 200: {
95810
+ content: {
95811
+ 'application/json': {
95812
+ schema: {
95813
+ properties: {
95814
+ connector_types: {
95815
+ items: {
95816
+ properties: {
95817
+ connector_type: {
95818
+ type: string;
95819
+ };
95820
+ description: {
95821
+ type: string;
95822
+ };
95823
+ display_name: {
95824
+ type: string;
95825
+ };
95826
+ instance_config_schema: {
95827
+ $ref: string;
95828
+ };
95829
+ static_config: {
95830
+ properties: {
95831
+ base_api_url: {
95832
+ type: string;
95833
+ };
95834
+ polling_enabled: {
95835
+ type: string;
95836
+ };
95837
+ polling_frequency_minutes: {
95838
+ format: string;
95839
+ type: string;
95840
+ };
95841
+ };
95842
+ required: string[];
95843
+ type: string;
95844
+ };
95845
+ };
95846
+ required: string[];
95847
+ type: string;
95848
+ };
95849
+ type: string;
95850
+ };
95851
+ ok: {
95852
+ type: string;
95853
+ };
95854
+ };
95855
+ required: string[];
95856
+ type: string;
95857
+ };
95858
+ };
95859
+ };
95860
+ description: string;
95861
+ };
95862
+ 400: {
95863
+ description: string;
95864
+ };
95865
+ 401: {
95866
+ description: string;
95867
+ };
95868
+ };
95869
+ security: ({
95870
+ api_key: never[];
95871
+ client_session?: never;
95872
+ console_session_with_workspace?: never;
95873
+ } | {
95874
+ client_session: never[];
95875
+ api_key?: never;
95876
+ console_session_with_workspace?: never;
95877
+ } | {
95878
+ console_session_with_workspace: never[];
95879
+ api_key?: never;
95880
+ client_session?: never;
95881
+ })[];
95882
+ summary: string;
95883
+ tags: never[];
95884
+ 'x-fern-sdk-group-name': string[];
95885
+ 'x-fern-sdk-method-name': string;
95886
+ 'x-fern-sdk-return-value': string;
95887
+ 'x-response-key': string;
95888
+ 'x-title': string;
95889
+ 'x-undocumented': string;
95890
+ };
95891
+ post: {
95892
+ description: string;
95893
+ operationId: string;
95894
+ responses: {
95895
+ 200: {
95896
+ content: {
95897
+ 'application/json': {
95898
+ schema: {
95899
+ properties: {
95900
+ connector_types: {
95901
+ items: {
95902
+ properties: {
95903
+ connector_type: {
95904
+ type: string;
95905
+ };
95906
+ description: {
95907
+ type: string;
95908
+ };
95909
+ display_name: {
95910
+ type: string;
95911
+ };
95912
+ instance_config_schema: {
95913
+ $ref: string;
95914
+ };
95915
+ static_config: {
95916
+ properties: {
95917
+ base_api_url: {
95918
+ type: string;
95919
+ };
95920
+ polling_enabled: {
95921
+ type: string;
95922
+ };
95923
+ polling_frequency_minutes: {
95924
+ format: string;
95925
+ type: string;
95926
+ };
95927
+ };
95928
+ required: string[];
95929
+ type: string;
95930
+ };
95931
+ };
95932
+ required: string[];
95933
+ type: string;
95934
+ };
95935
+ type: string;
95936
+ };
95937
+ ok: {
95938
+ type: string;
95939
+ };
95940
+ };
95941
+ required: string[];
95942
+ type: string;
95943
+ };
95944
+ };
95945
+ };
95946
+ description: string;
95947
+ };
95948
+ 400: {
95949
+ description: string;
95950
+ };
95951
+ 401: {
95952
+ description: string;
95953
+ };
95954
+ };
95955
+ security: ({
95956
+ api_key: never[];
95957
+ client_session?: never;
95958
+ console_session_with_workspace?: never;
95959
+ } | {
95960
+ client_session: never[];
95961
+ api_key?: never;
95962
+ console_session_with_workspace?: never;
95963
+ } | {
95964
+ console_session_with_workspace: never[];
95965
+ api_key?: never;
95966
+ client_session?: never;
95967
+ })[];
95968
+ summary: string;
95969
+ tags: never[];
95970
+ 'x-fern-sdk-group-name': string[];
95971
+ 'x-fern-sdk-method-name': string;
95972
+ 'x-fern-sdk-return-value': string;
95973
+ 'x-response-key': string;
95974
+ 'x-title': string;
95975
+ 'x-undocumented': string;
95976
+ };
95977
+ };
95804
95978
  '/seam/customer/v1/connectors/create': {
95805
95979
  post: {
95806
95980
  description: string;
@@ -95811,45 +95985,9 @@ declare const _default: {
95811
95985
  schema: {
95812
95986
  properties: {
95813
95987
  config: {
95988
+ additionalProperties: {};
95814
95989
  description: string;
95815
- oneOf: ({
95816
- properties: {
95817
- access_token: {
95818
- minLength: number;
95819
- type: string;
95820
- };
95821
- client: {
95822
- default: string;
95823
- minLength: number;
95824
- type: string;
95825
- };
95826
- client_token: {
95827
- minLength: number;
95828
- type: string;
95829
- };
95830
- enterprise_id: {
95831
- format: string;
95832
- type: string;
95833
- };
95834
- enterprise_ids: {
95835
- items: {
95836
- format: string;
95837
- type: string;
95838
- };
95839
- type: string;
95840
- };
95841
- };
95842
- type: string;
95843
- } | {
95844
- properties: {
95845
- access_token?: never;
95846
- client?: never;
95847
- client_token?: never;
95848
- enterprise_id?: never;
95849
- enterprise_ids?: never;
95850
- };
95851
- type: string;
95852
- })[];
95990
+ type: string;
95853
95991
  };
95854
95992
  connector_type: {
95855
95993
  description: string;
@@ -96291,6 +96429,19 @@ declare const _default: {
96291
96429
  config: {
96292
96430
  description: string;
96293
96431
  oneOf: ({
96432
+ properties: {
96433
+ access_token?: never;
96434
+ client?: never;
96435
+ client_token?: never;
96436
+ enterprise_id?: never;
96437
+ enterprise_ids?: never;
96438
+ client_id?: never;
96439
+ client_password?: never;
96440
+ property_id?: never;
96441
+ };
96442
+ type: string;
96443
+ required?: never;
96444
+ } | {
96294
96445
  properties: {
96295
96446
  access_token: {
96296
96447
  minLength: number;
@@ -96306,26 +96457,49 @@ declare const _default: {
96306
96457
  type: string;
96307
96458
  };
96308
96459
  enterprise_id: {
96309
- format: string;
96310
96460
  type: string;
96311
96461
  };
96312
96462
  enterprise_ids: {
96313
96463
  items: {
96314
- format: string;
96315
96464
  type: string;
96316
96465
  };
96317
96466
  type: string;
96318
96467
  };
96468
+ client_id?: never;
96469
+ client_password?: never;
96470
+ property_id?: never;
96319
96471
  };
96320
96472
  type: string;
96473
+ required?: never;
96321
96474
  } | {
96322
96475
  properties: {
96476
+ client_id: {
96477
+ description: string;
96478
+ minLength: number;
96479
+ type: string;
96480
+ };
96481
+ client_password: {
96482
+ description: string;
96483
+ minLength: number;
96484
+ type: string;
96485
+ };
96486
+ property_id: {
96487
+ description: string;
96488
+ oneOf: ({
96489
+ type: string;
96490
+ format?: never;
96491
+ } | {
96492
+ format: string;
96493
+ type: string;
96494
+ })[];
96495
+ };
96323
96496
  access_token?: never;
96324
96497
  client?: never;
96325
96498
  client_token?: never;
96326
96499
  enterprise_id?: never;
96327
96500
  enterprise_ids?: never;
96328
96501
  };
96502
+ required: string[];
96329
96503
  type: string;
96330
96504
  })[];
96331
96505
  };
@@ -168942,23 +169116,40 @@ type Routes = {
168942
169116
  formData: {};
168943
169117
  jsonResponse: {};
168944
169118
  };
169119
+ '/seam/customer/v1/connectors/connector_types': {
169120
+ route: '/seam/customer/v1/connectors/connector_types';
169121
+ method: 'GET' | 'POST';
169122
+ queryParams: {};
169123
+ jsonBody: {};
169124
+ commonParams: {};
169125
+ formData: {};
169126
+ jsonResponse: {
169127
+ connector_types: {
169128
+ connector_type: string;
169129
+ display_name: string;
169130
+ description?: string | undefined;
169131
+ instance_config_schema?: any;
169132
+ static_config: {
169133
+ base_api_url: string;
169134
+ polling_enabled: boolean;
169135
+ polling_frequency_minutes: number;
169136
+ };
169137
+ }[];
169138
+ };
169139
+ };
168945
169140
  '/seam/customer/v1/connectors/create': {
168946
169141
  route: '/seam/customer/v1/connectors/create';
168947
169142
  method: 'POST';
168948
169143
  queryParams: {};
168949
169144
  jsonBody: {
168950
169145
  /** Type of connector to create */
168951
- connector_type: 'mews' | 'mock';
169146
+ connector_type: 'mock' | 'mews' | 'rms';
168952
169147
  /** Key identifying the customer */
168953
169148
  customer_key?: string | undefined;
168954
169149
  /** Instance-specific configuration for the connector */
168955
169150
  config: {
168956
- client_token?: string | undefined;
168957
- access_token?: string | undefined;
168958
- client?: string;
168959
- enterprise_ids?: string[] | undefined;
168960
- enterprise_id?: string | undefined;
168961
- } | {};
169151
+ [x: string]: unknown;
169152
+ };
168962
169153
  };
168963
169154
  commonParams: {};
168964
169155
  formData: {};
@@ -169043,13 +169234,20 @@ type Routes = {
169043
169234
  /** Key identifying the customer */
169044
169235
  customer_key?: string | undefined;
169045
169236
  /** Instance-specific configuration for the connector */
169046
- config: {
169237
+ config: {} | {
169047
169238
  client_token?: string | undefined;
169048
169239
  access_token?: string | undefined;
169049
169240
  client?: string;
169050
169241
  enterprise_ids?: string[] | undefined;
169051
169242
  enterprise_id?: string | undefined;
169052
- } | {};
169243
+ } | {
169244
+ /** RMS client ID for authentication */
169245
+ client_id: string;
169246
+ /** RMS client password for authentication */
169247
+ client_password: string;
169248
+ /** Optional property ID for single-property connectors */
169249
+ property_id?: (string | number) | undefined;
169250
+ };
169053
169251
  };
169054
169252
  commonParams: {};
169055
169253
  formData: {};
package/dist/index.cjs CHANGED
@@ -54482,9 +54482,151 @@ var openapi_default = {
54482
54482
  "x-undocumented": "Internal endpoint for customer portals."
54483
54483
  }
54484
54484
  },
54485
+ "/seam/customer/v1/connectors/connector_types": {
54486
+ get: {
54487
+ description: "Lists all available connector types and their required instance configuration schemas.",
54488
+ operationId: "seamCustomerV1ConnectorsConnectorTypesGet",
54489
+ responses: {
54490
+ 200: {
54491
+ content: {
54492
+ "application/json": {
54493
+ schema: {
54494
+ properties: {
54495
+ connector_types: {
54496
+ items: {
54497
+ properties: {
54498
+ connector_type: { type: "string" },
54499
+ description: { type: "string" },
54500
+ display_name: { type: "string" },
54501
+ instance_config_schema: {
54502
+ $ref: "#/components/schemas/access_code"
54503
+ },
54504
+ static_config: {
54505
+ properties: {
54506
+ base_api_url: { type: "string" },
54507
+ polling_enabled: { type: "boolean" },
54508
+ polling_frequency_minutes: {
54509
+ format: "float",
54510
+ type: "number"
54511
+ }
54512
+ },
54513
+ required: [
54514
+ "base_api_url",
54515
+ "polling_enabled",
54516
+ "polling_frequency_minutes"
54517
+ ],
54518
+ type: "object"
54519
+ }
54520
+ },
54521
+ required: [
54522
+ "connector_type",
54523
+ "display_name",
54524
+ "static_config"
54525
+ ],
54526
+ type: "object"
54527
+ },
54528
+ type: "array"
54529
+ },
54530
+ ok: { type: "boolean" }
54531
+ },
54532
+ required: ["connector_types", "ok"],
54533
+ type: "object"
54534
+ }
54535
+ }
54536
+ },
54537
+ description: "OK"
54538
+ },
54539
+ 400: { description: "Bad Request" },
54540
+ 401: { description: "Unauthorized" }
54541
+ },
54542
+ security: [
54543
+ { api_key: [] },
54544
+ { client_session: [] },
54545
+ { console_session_with_workspace: [] }
54546
+ ],
54547
+ summary: "/seam/customer/v1/connectors/connector_types",
54548
+ tags: [],
54549
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
54550
+ "x-fern-sdk-method-name": "connector_types",
54551
+ "x-fern-sdk-return-value": "connector_types",
54552
+ "x-response-key": "connector_types",
54553
+ "x-title": "List Connector Types",
54554
+ "x-undocumented": "Internal endpoint for Console."
54555
+ },
54556
+ post: {
54557
+ description: "Lists all available connector types and their required instance configuration schemas.",
54558
+ operationId: "seamCustomerV1ConnectorsConnectorTypesPost",
54559
+ responses: {
54560
+ 200: {
54561
+ content: {
54562
+ "application/json": {
54563
+ schema: {
54564
+ properties: {
54565
+ connector_types: {
54566
+ items: {
54567
+ properties: {
54568
+ connector_type: { type: "string" },
54569
+ description: { type: "string" },
54570
+ display_name: { type: "string" },
54571
+ instance_config_schema: {
54572
+ $ref: "#/components/schemas/access_code"
54573
+ },
54574
+ static_config: {
54575
+ properties: {
54576
+ base_api_url: { type: "string" },
54577
+ polling_enabled: { type: "boolean" },
54578
+ polling_frequency_minutes: {
54579
+ format: "float",
54580
+ type: "number"
54581
+ }
54582
+ },
54583
+ required: [
54584
+ "base_api_url",
54585
+ "polling_enabled",
54586
+ "polling_frequency_minutes"
54587
+ ],
54588
+ type: "object"
54589
+ }
54590
+ },
54591
+ required: [
54592
+ "connector_type",
54593
+ "display_name",
54594
+ "static_config"
54595
+ ],
54596
+ type: "object"
54597
+ },
54598
+ type: "array"
54599
+ },
54600
+ ok: { type: "boolean" }
54601
+ },
54602
+ required: ["connector_types", "ok"],
54603
+ type: "object"
54604
+ }
54605
+ }
54606
+ },
54607
+ description: "OK"
54608
+ },
54609
+ 400: { description: "Bad Request" },
54610
+ 401: { description: "Unauthorized" }
54611
+ },
54612
+ security: [
54613
+ { api_key: [] },
54614
+ { client_session: [] },
54615
+ { console_session_with_workspace: [] }
54616
+ ],
54617
+ summary: "/seam/customer/v1/connectors/connector_types",
54618
+ tags: [],
54619
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
54620
+ "x-fern-sdk-method-name": "connector_types",
54621
+ "x-fern-sdk-return-value": "connector_types",
54622
+ "x-response-key": "connector_types",
54623
+ "x-title": "List Connector Types",
54624
+ "x-undocumented": "Internal endpoint for Console."
54625
+ }
54626
+ },
54485
54627
  "/seam/customer/v1/connectors/create": {
54486
54628
  post: {
54487
- 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.",
54629
+ 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.",
54488
54630
  operationId: "seamCustomerV1ConnectorsCreatePost",
54489
54631
  requestBody: {
54490
54632
  content: {
@@ -54492,31 +54634,13 @@ var openapi_default = {
54492
54634
  schema: {
54493
54635
  properties: {
54494
54636
  config: {
54637
+ additionalProperties: {},
54495
54638
  description: "Instance-specific configuration for the connector",
54496
- oneOf: [
54497
- {
54498
- properties: {
54499
- access_token: { minLength: 1, type: "string" },
54500
- client: {
54501
- default: "seam",
54502
- minLength: 1,
54503
- type: "string"
54504
- },
54505
- client_token: { minLength: 1, type: "string" },
54506
- enterprise_id: { format: "uuid", type: "string" },
54507
- enterprise_ids: {
54508
- items: { format: "uuid", type: "string" },
54509
- type: "array"
54510
- }
54511
- },
54512
- type: "object"
54513
- },
54514
- { properties: {}, type: "object" }
54515
- ]
54639
+ type: "object"
54516
54640
  },
54517
54641
  connector_type: {
54518
54642
  description: "Type of connector to create",
54519
- enum: ["mews", "mock"],
54643
+ enum: ["mock", "mews", "rms"],
54520
54644
  type: "string"
54521
54645
  },
54522
54646
  customer_key: {
@@ -54864,6 +54988,7 @@ var openapi_default = {
54864
54988
  config: {
54865
54989
  description: "Instance-specific configuration for the connector",
54866
54990
  oneOf: [
54991
+ { properties: {}, type: "object" },
54867
54992
  {
54868
54993
  properties: {
54869
54994
  access_token: { minLength: 1, type: "string" },
@@ -54873,15 +54998,37 @@ var openapi_default = {
54873
54998
  type: "string"
54874
54999
  },
54875
55000
  client_token: { minLength: 1, type: "string" },
54876
- enterprise_id: { format: "uuid", type: "string" },
55001
+ enterprise_id: { type: "string" },
54877
55002
  enterprise_ids: {
54878
- items: { format: "uuid", type: "string" },
55003
+ items: { type: "string" },
54879
55004
  type: "array"
54880
55005
  }
54881
55006
  },
54882
55007
  type: "object"
54883
55008
  },
54884
- { properties: {}, type: "object" }
55009
+ {
55010
+ properties: {
55011
+ client_id: {
55012
+ description: "RMS client ID for authentication",
55013
+ minLength: 1,
55014
+ type: "string"
55015
+ },
55016
+ client_password: {
55017
+ description: "RMS client password for authentication",
55018
+ minLength: 1,
55019
+ type: "string"
55020
+ },
55021
+ property_id: {
55022
+ description: "Optional property ID for single-property connectors",
55023
+ oneOf: [
55024
+ { type: "string" },
55025
+ { format: "float", type: "number" }
55026
+ ]
55027
+ }
55028
+ },
55029
+ required: ["client_id", "client_password"],
55030
+ type: "object"
55031
+ }
54885
55032
  ]
54886
55033
  },
54887
55034
  connector_id: {