@seamapi/types 1.599.0 → 1.600.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.
@@ -93491,6 +93491,218 @@ declare const _default: {
93491
93491
  'x-undocumented': string;
93492
93492
  };
93493
93493
  };
93494
+ '/seam/customer/v1/connectors/create': {
93495
+ post: {
93496
+ description: string;
93497
+ operationId: string;
93498
+ requestBody: {
93499
+ content: {
93500
+ 'application/json': {
93501
+ schema: {
93502
+ properties: {
93503
+ config: {
93504
+ description: string;
93505
+ oneOf: ({
93506
+ properties: {
93507
+ access_token: {
93508
+ minLength: number;
93509
+ type: string;
93510
+ };
93511
+ client: {
93512
+ minLength: number;
93513
+ type: string;
93514
+ };
93515
+ client_token: {
93516
+ minLength: number;
93517
+ type: string;
93518
+ };
93519
+ enterprise_ids: {
93520
+ items: {
93521
+ format: string;
93522
+ type: string;
93523
+ };
93524
+ type: string;
93525
+ };
93526
+ };
93527
+ required: string[];
93528
+ type: string;
93529
+ } | {
93530
+ properties: {
93531
+ access_token?: never;
93532
+ client?: never;
93533
+ client_token?: never;
93534
+ enterprise_ids?: never;
93535
+ };
93536
+ type: string;
93537
+ required?: never;
93538
+ })[];
93539
+ };
93540
+ connector_type: {
93541
+ description: string;
93542
+ enum: string[];
93543
+ type: string;
93544
+ };
93545
+ customer_key: {
93546
+ description: string;
93547
+ minLength: number;
93548
+ type: string;
93549
+ };
93550
+ };
93551
+ required: string[];
93552
+ type: string;
93553
+ };
93554
+ };
93555
+ };
93556
+ };
93557
+ responses: {
93558
+ 200: {
93559
+ content: {
93560
+ 'application/json': {
93561
+ schema: {
93562
+ properties: {
93563
+ connector: {
93564
+ properties: {
93565
+ connector_id: {
93566
+ type: string;
93567
+ };
93568
+ connector_type: {
93569
+ type: string;
93570
+ };
93571
+ error: {
93572
+ type: string;
93573
+ };
93574
+ status: {
93575
+ enum: string[];
93576
+ type: string;
93577
+ };
93578
+ webhook_subscription: {
93579
+ properties: {
93580
+ events: {
93581
+ items: {
93582
+ type: string;
93583
+ };
93584
+ type: string;
93585
+ };
93586
+ status: {
93587
+ enum: string[];
93588
+ type: string;
93589
+ };
93590
+ subscription_id: {
93591
+ type: string;
93592
+ };
93593
+ webhook_url: {
93594
+ type: string;
93595
+ };
93596
+ };
93597
+ required: string[];
93598
+ type: string;
93599
+ };
93600
+ };
93601
+ required: string[];
93602
+ type: string;
93603
+ };
93604
+ ok: {
93605
+ type: string;
93606
+ };
93607
+ };
93608
+ required: string[];
93609
+ type: string;
93610
+ };
93611
+ };
93612
+ };
93613
+ description: string;
93614
+ };
93615
+ 400: {
93616
+ description: string;
93617
+ };
93618
+ 401: {
93619
+ description: string;
93620
+ };
93621
+ };
93622
+ security: {
93623
+ api_key: never[];
93624
+ }[];
93625
+ summary: string;
93626
+ tags: never[];
93627
+ 'x-fern-sdk-group-name': string[];
93628
+ 'x-fern-sdk-method-name': string;
93629
+ 'x-fern-sdk-return-value': string;
93630
+ 'x-response-key': string;
93631
+ 'x-title': string;
93632
+ };
93633
+ };
93634
+ '/seam/customer/v1/connectors/sync': {
93635
+ post: {
93636
+ description: string;
93637
+ operationId: string;
93638
+ requestBody: {
93639
+ content: {
93640
+ 'application/json': {
93641
+ schema: {
93642
+ properties: {
93643
+ connector_id: {
93644
+ description: string;
93645
+ format: string;
93646
+ type: string;
93647
+ };
93648
+ };
93649
+ required: string[];
93650
+ type: string;
93651
+ };
93652
+ };
93653
+ };
93654
+ };
93655
+ responses: {
93656
+ 200: {
93657
+ content: {
93658
+ 'application/json': {
93659
+ schema: {
93660
+ properties: {
93661
+ connector_sync: {
93662
+ properties: {
93663
+ connector_id: {
93664
+ type: string;
93665
+ };
93666
+ message: {
93667
+ type: string;
93668
+ };
93669
+ status: {
93670
+ type: string;
93671
+ };
93672
+ };
93673
+ required: string[];
93674
+ type: string;
93675
+ };
93676
+ ok: {
93677
+ type: string;
93678
+ };
93679
+ };
93680
+ required: string[];
93681
+ type: string;
93682
+ };
93683
+ };
93684
+ };
93685
+ description: string;
93686
+ };
93687
+ 400: {
93688
+ description: string;
93689
+ };
93690
+ 401: {
93691
+ description: string;
93692
+ };
93693
+ };
93694
+ security: {
93695
+ api_key: never[];
93696
+ }[];
93697
+ summary: string;
93698
+ tags: never[];
93699
+ 'x-fern-sdk-group-name': string[];
93700
+ 'x-fern-sdk-method-name': string;
93701
+ 'x-fern-sdk-return-value': string;
93702
+ 'x-response-key': string;
93703
+ 'x-title': string;
93704
+ };
93705
+ };
93494
93706
  '/seam/customer/v1/events/list': {
93495
93707
  get: {
93496
93708
  description: string;
@@ -95552,6 +95764,75 @@ declare const _default: {
95552
95764
  'x-title': string;
95553
95765
  };
95554
95766
  };
95767
+ '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
95768
+ post: {
95769
+ description: string;
95770
+ operationId: string;
95771
+ requestBody: {
95772
+ content: {
95773
+ 'application/json': {
95774
+ schema: {
95775
+ properties: {};
95776
+ type: string;
95777
+ };
95778
+ };
95779
+ };
95780
+ };
95781
+ responses: {
95782
+ 200: {
95783
+ content: {
95784
+ 'application/json': {
95785
+ schema: {
95786
+ properties: {
95787
+ error: {
95788
+ type: string;
95789
+ };
95790
+ ok: {
95791
+ type: string;
95792
+ };
95793
+ processed_events: {
95794
+ format: string;
95795
+ type: string;
95796
+ };
95797
+ success: {
95798
+ type: string;
95799
+ };
95800
+ };
95801
+ required: string[];
95802
+ type: string;
95803
+ };
95804
+ };
95805
+ };
95806
+ description: string;
95807
+ };
95808
+ 400: {
95809
+ description: string;
95810
+ };
95811
+ 401: {
95812
+ description: string;
95813
+ };
95814
+ };
95815
+ security: ({
95816
+ pat_with_workspace: never[];
95817
+ console_session_with_workspace?: never;
95818
+ api_key?: never;
95819
+ } | {
95820
+ console_session_with_workspace: never[];
95821
+ pat_with_workspace?: never;
95822
+ api_key?: never;
95823
+ } | {
95824
+ api_key: never[];
95825
+ pat_with_workspace?: never;
95826
+ console_session_with_workspace?: never;
95827
+ })[];
95828
+ summary: string;
95829
+ tags: string[];
95830
+ 'x-fern-sdk-group-name': string[];
95831
+ 'x-fern-sdk-method-name': string;
95832
+ 'x-response-key': null;
95833
+ 'x-title': string;
95834
+ };
95835
+ };
95555
95836
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
95556
95837
  post: {
95557
95838
  description: string;
@@ -164495,6 +164776,58 @@ type Routes = {
164495
164776
  formData: {};
164496
164777
  jsonResponse: {};
164497
164778
  };
164779
+ '/seam/customer/v1/connectors/create': {
164780
+ route: '/seam/customer/v1/connectors/create';
164781
+ method: 'POST';
164782
+ queryParams: {};
164783
+ jsonBody: {
164784
+ /** Type of connector to create */
164785
+ connector_type: 'mews' | 'mock';
164786
+ /** Key identifying the customer */
164787
+ customer_key: string;
164788
+ /** Instance-specific configuration for the connector */
164789
+ config: {
164790
+ client_token: string;
164791
+ access_token: string;
164792
+ client: string;
164793
+ enterprise_ids?: string[] | undefined;
164794
+ } | {};
164795
+ };
164796
+ commonParams: {};
164797
+ formData: {};
164798
+ jsonResponse: {
164799
+ connector: {
164800
+ connector_id: string;
164801
+ connector_type: string;
164802
+ status: 'active' | 'inactive' | 'error';
164803
+ webhook_subscription?: {
164804
+ subscription_id: string;
164805
+ webhook_url: string;
164806
+ events: string[];
164807
+ status: 'active' | 'inactive' | 'error';
164808
+ } | undefined;
164809
+ error?: string | undefined;
164810
+ };
164811
+ };
164812
+ };
164813
+ '/seam/customer/v1/connectors/sync': {
164814
+ route: '/seam/customer/v1/connectors/sync';
164815
+ method: 'POST';
164816
+ queryParams: {};
164817
+ jsonBody: {};
164818
+ commonParams: {
164819
+ /** ID of the connector to sync */
164820
+ connector_id: string;
164821
+ };
164822
+ formData: {};
164823
+ jsonResponse: {
164824
+ connector_sync: {
164825
+ connector_id: string;
164826
+ status: string;
164827
+ message: string;
164828
+ };
164829
+ };
164830
+ };
164498
164831
  '/seam/customer/v1/events/list': {
164499
164832
  route: '/seam/customer/v1/events/list';
164500
164833
  method: 'GET' | 'POST';
@@ -166697,6 +167030,19 @@ type Routes = {
166697
167030
  }[];
166698
167031
  };
166699
167032
  };
167033
+ '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
167034
+ route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
167035
+ method: 'POST';
167036
+ queryParams: {};
167037
+ jsonBody: {};
167038
+ commonParams: {};
167039
+ formData: {};
167040
+ jsonResponse: {
167041
+ success: boolean;
167042
+ processed_events: number;
167043
+ error?: string | undefined;
167044
+ };
167045
+ };
166700
167046
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
166701
167047
  route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
166702
167048
  method: 'POST';
package/dist/index.cjs CHANGED
@@ -52988,6 +52988,171 @@ var openapi_default = {
52988
52988
  "x-undocumented": "Internal endpoint for customer portals."
52989
52989
  }
52990
52990
  },
52991
+ "/seam/customer/v1/connectors/create": {
52992
+ post: {
52993
+ description: "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.",
52994
+ operationId: "seamCustomerV1ConnectorsCreatePost",
52995
+ requestBody: {
52996
+ content: {
52997
+ "application/json": {
52998
+ schema: {
52999
+ properties: {
53000
+ config: {
53001
+ description: "Instance-specific configuration for the connector",
53002
+ oneOf: [
53003
+ {
53004
+ properties: {
53005
+ access_token: { minLength: 1, type: "string" },
53006
+ client: { minLength: 1, type: "string" },
53007
+ client_token: { minLength: 1, type: "string" },
53008
+ enterprise_ids: {
53009
+ items: { format: "uuid", type: "string" },
53010
+ type: "array"
53011
+ }
53012
+ },
53013
+ required: ["client_token", "access_token", "client"],
53014
+ type: "object"
53015
+ },
53016
+ { properties: {}, type: "object" }
53017
+ ]
53018
+ },
53019
+ connector_type: {
53020
+ description: "Type of connector to create",
53021
+ enum: ["mews", "mock"],
53022
+ type: "string"
53023
+ },
53024
+ customer_key: {
53025
+ description: "Key identifying the customer",
53026
+ minLength: 1,
53027
+ type: "string"
53028
+ }
53029
+ },
53030
+ required: ["connector_type", "customer_key", "config"],
53031
+ type: "object"
53032
+ }
53033
+ }
53034
+ }
53035
+ },
53036
+ responses: {
53037
+ 200: {
53038
+ content: {
53039
+ "application/json": {
53040
+ schema: {
53041
+ properties: {
53042
+ connector: {
53043
+ properties: {
53044
+ connector_id: { type: "string" },
53045
+ connector_type: { type: "string" },
53046
+ error: { type: "string" },
53047
+ status: {
53048
+ enum: ["active", "inactive", "error"],
53049
+ type: "string"
53050
+ },
53051
+ webhook_subscription: {
53052
+ properties: {
53053
+ events: {
53054
+ items: { type: "string" },
53055
+ type: "array"
53056
+ },
53057
+ status: {
53058
+ enum: ["active", "inactive", "error"],
53059
+ type: "string"
53060
+ },
53061
+ subscription_id: { type: "string" },
53062
+ webhook_url: { type: "string" }
53063
+ },
53064
+ required: [
53065
+ "subscription_id",
53066
+ "webhook_url",
53067
+ "events",
53068
+ "status"
53069
+ ],
53070
+ type: "object"
53071
+ }
53072
+ },
53073
+ required: ["connector_id", "connector_type", "status"],
53074
+ type: "object"
53075
+ },
53076
+ ok: { type: "boolean" }
53077
+ },
53078
+ required: ["connector", "ok"],
53079
+ type: "object"
53080
+ }
53081
+ }
53082
+ },
53083
+ description: "OK"
53084
+ },
53085
+ 400: { description: "Bad Request" },
53086
+ 401: { description: "Unauthorized" }
53087
+ },
53088
+ security: [{ api_key: [] }],
53089
+ summary: "/seam/customer/v1/connectors/create",
53090
+ tags: [],
53091
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
53092
+ "x-fern-sdk-method-name": "create",
53093
+ "x-fern-sdk-return-value": "connector",
53094
+ "x-response-key": "connector",
53095
+ "x-title": "Create Connector"
53096
+ }
53097
+ },
53098
+ "/seam/customer/v1/connectors/sync": {
53099
+ post: {
53100
+ description: "Triggers an immediate data sync for a connector by scheduling a polling task.",
53101
+ operationId: "seamCustomerV1ConnectorsSyncPost",
53102
+ requestBody: {
53103
+ content: {
53104
+ "application/json": {
53105
+ schema: {
53106
+ properties: {
53107
+ connector_id: {
53108
+ description: "ID of the connector to sync",
53109
+ format: "uuid",
53110
+ type: "string"
53111
+ }
53112
+ },
53113
+ required: ["connector_id"],
53114
+ type: "object"
53115
+ }
53116
+ }
53117
+ }
53118
+ },
53119
+ responses: {
53120
+ 200: {
53121
+ content: {
53122
+ "application/json": {
53123
+ schema: {
53124
+ properties: {
53125
+ connector_sync: {
53126
+ properties: {
53127
+ connector_id: { type: "string" },
53128
+ message: { type: "string" },
53129
+ status: { type: "string" }
53130
+ },
53131
+ required: ["connector_id", "status", "message"],
53132
+ type: "object"
53133
+ },
53134
+ ok: { type: "boolean" }
53135
+ },
53136
+ required: ["connector_sync", "ok"],
53137
+ type: "object"
53138
+ }
53139
+ }
53140
+ },
53141
+ description: "OK"
53142
+ },
53143
+ 400: { description: "Bad Request" },
53144
+ 401: { description: "Unauthorized" }
53145
+ },
53146
+ security: [{ api_key: [] }],
53147
+ summary: "/seam/customer/v1/connectors/sync",
53148
+ tags: [],
53149
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
53150
+ "x-fern-sdk-method-name": "sync",
53151
+ "x-fern-sdk-return-value": "connector_sync",
53152
+ "x-response-key": "connector_sync",
53153
+ "x-title": "Sync Connector Data"
53154
+ }
53155
+ },
52991
53156
  "/seam/customer/v1/events/list": {
52992
53157
  get: {
52993
53158
  description: "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.",
@@ -54990,6 +55155,56 @@ var openapi_default = {
54990
55155
  "x-title": "List Spaces"
54991
55156
  }
54992
55157
  },
55158
+ "/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]": {
55159
+ post: {
55160
+ description: "Receives webhook events from external connector APIs and processes them into partner resources.",
55161
+ operationId: "seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost",
55162
+ requestBody: {
55163
+ content: {
55164
+ "application/json": { schema: { properties: {}, type: "object" } }
55165
+ }
55166
+ },
55167
+ responses: {
55168
+ 200: {
55169
+ content: {
55170
+ "application/json": {
55171
+ schema: {
55172
+ properties: {
55173
+ error: { type: "string" },
55174
+ ok: { type: "boolean" },
55175
+ processed_events: { format: "float", type: "number" },
55176
+ success: { type: "boolean" }
55177
+ },
55178
+ required: ["success", "processed_events", "ok"],
55179
+ type: "object"
55180
+ }
55181
+ }
55182
+ },
55183
+ description: "OK"
55184
+ },
55185
+ 400: { description: "Bad Request" },
55186
+ 401: { description: "Unauthorized" }
55187
+ },
55188
+ security: [
55189
+ { pat_with_workspace: [] },
55190
+ { console_session_with_workspace: [] },
55191
+ { api_key: [] }
55192
+ ],
55193
+ summary: "/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]",
55194
+ tags: ["/webhooks"],
55195
+ "x-fern-sdk-group-name": [
55196
+ "seam",
55197
+ "customer",
55198
+ "v1",
55199
+ "webhooks",
55200
+ "connectors",
55201
+ "[workspace_id]"
55202
+ ],
55203
+ "x-fern-sdk-method-name": "by_connector_id",
55204
+ "x-response-key": null,
55205
+ "x-title": "Connector Webhook Endpoint"
55206
+ }
55207
+ },
54993
55208
  "/seam/instant_key/v1/client_sessions/exchange_short_code": {
54994
55209
  post: {
54995
55210
  description: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",