@seamapi/types 1.598.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.
- package/dist/connect.cjs +243 -76
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +377 -107
- package/dist/index.cjs +243 -76
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +26 -92
- package/lib/seam/connect/models/customer/customer-portal.js +15 -16
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +296 -83
- package/lib/seam/connect/openapi.js +243 -76
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +81 -24
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +19 -18
- package/src/lib/seam/connect/openapi.ts +249 -85
- package/src/lib/seam/connect/route-types.ts +85 -24
package/dist/index.cjs
CHANGED
|
@@ -42830,8 +42830,11 @@ var openapi_default = {
|
|
|
42830
42830
|
exclude: false
|
|
42831
42831
|
},
|
|
42832
42832
|
connect: { exclude: false },
|
|
42833
|
+
manage: {
|
|
42834
|
+
exclude: false,
|
|
42835
|
+
exclude_reservation_management: false
|
|
42836
|
+
},
|
|
42833
42837
|
manage_devices: { exclude: false },
|
|
42834
|
-
manage_reservations: { exclude: false },
|
|
42835
42838
|
organize: { exclude: false }
|
|
42836
42839
|
},
|
|
42837
42840
|
is_embedded: false
|
|
@@ -42885,48 +42888,31 @@ var openapi_default = {
|
|
|
42885
42888
|
},
|
|
42886
42889
|
type: "object"
|
|
42887
42890
|
},
|
|
42888
|
-
|
|
42891
|
+
manage: {
|
|
42889
42892
|
default: {},
|
|
42890
|
-
description: "Configuration for the manage
|
|
42893
|
+
description: "Configuration for the manage feature.",
|
|
42891
42894
|
properties: {
|
|
42892
|
-
accepted_providers: {
|
|
42893
|
-
description: "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.",
|
|
42894
|
-
items: { type: "string" },
|
|
42895
|
-
type: "array"
|
|
42896
|
-
},
|
|
42897
42895
|
exclude: {
|
|
42898
42896
|
default: false,
|
|
42899
42897
|
description: "Whether to exclude this feature from the portal.",
|
|
42900
42898
|
type: "boolean"
|
|
42901
42899
|
},
|
|
42902
|
-
|
|
42903
|
-
|
|
42904
|
-
|
|
42905
|
-
type: "
|
|
42900
|
+
exclude_reservation_management: {
|
|
42901
|
+
default: false,
|
|
42902
|
+
description: "Indicates whether the customer can manage reservations for their properties.",
|
|
42903
|
+
type: "boolean"
|
|
42906
42904
|
}
|
|
42907
42905
|
},
|
|
42908
42906
|
type: "object"
|
|
42909
42907
|
},
|
|
42910
|
-
|
|
42908
|
+
manage_devices: {
|
|
42911
42909
|
default: {},
|
|
42912
|
-
description: "Configuration for the manage
|
|
42910
|
+
description: "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---",
|
|
42913
42911
|
properties: {
|
|
42914
42912
|
exclude: {
|
|
42915
42913
|
default: false,
|
|
42916
42914
|
description: "Whether to exclude this feature from the portal.",
|
|
42917
42915
|
type: "boolean"
|
|
42918
|
-
},
|
|
42919
|
-
reservations: {
|
|
42920
|
-
default: { exclude: false },
|
|
42921
|
-
description: "Configuration for the reservations feature.",
|
|
42922
|
-
properties: {
|
|
42923
|
-
exclude: {
|
|
42924
|
-
default: false,
|
|
42925
|
-
description: "Indicates whether the customer can view reservations for their properties.",
|
|
42926
|
-
type: "boolean"
|
|
42927
|
-
}
|
|
42928
|
-
},
|
|
42929
|
-
type: "object"
|
|
42930
42916
|
}
|
|
42931
42917
|
},
|
|
42932
42918
|
type: "object"
|
|
@@ -53002,6 +52988,171 @@ var openapi_default = {
|
|
|
53002
52988
|
"x-undocumented": "Internal endpoint for customer portals."
|
|
53003
52989
|
}
|
|
53004
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
|
+
},
|
|
53005
53156
|
"/seam/customer/v1/events/list": {
|
|
53006
53157
|
get: {
|
|
53007
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.",
|
|
@@ -53656,52 +53807,35 @@ var openapi_default = {
|
|
|
53656
53807
|
},
|
|
53657
53808
|
type: "object"
|
|
53658
53809
|
},
|
|
53659
|
-
|
|
53810
|
+
manage: {
|
|
53660
53811
|
default: {
|
|
53661
53812
|
$ref: "#/components/schemas/access_code"
|
|
53662
53813
|
},
|
|
53663
|
-
description: "Configuration for the manage
|
|
53814
|
+
description: "Configuration for the manage feature.",
|
|
53664
53815
|
properties: {
|
|
53665
|
-
accepted_providers: {
|
|
53666
|
-
description: "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.",
|
|
53667
|
-
items: { type: "string" },
|
|
53668
|
-
type: "array"
|
|
53669
|
-
},
|
|
53670
53816
|
exclude: {
|
|
53671
53817
|
default: false,
|
|
53672
53818
|
description: "Whether to exclude this feature from the portal.",
|
|
53673
53819
|
type: "boolean"
|
|
53674
53820
|
},
|
|
53675
|
-
|
|
53676
|
-
|
|
53677
|
-
|
|
53678
|
-
type: "
|
|
53821
|
+
exclude_reservation_management: {
|
|
53822
|
+
default: false,
|
|
53823
|
+
description: "Indicates whether the customer can manage reservations for their properties.",
|
|
53824
|
+
type: "boolean"
|
|
53679
53825
|
}
|
|
53680
53826
|
},
|
|
53681
53827
|
type: "object"
|
|
53682
53828
|
},
|
|
53683
|
-
|
|
53829
|
+
manage_devices: {
|
|
53684
53830
|
default: {
|
|
53685
53831
|
$ref: "#/components/schemas/access_code"
|
|
53686
53832
|
},
|
|
53687
|
-
description: "Configuration for the manage
|
|
53833
|
+
description: "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---",
|
|
53688
53834
|
properties: {
|
|
53689
53835
|
exclude: {
|
|
53690
53836
|
default: false,
|
|
53691
53837
|
description: "Whether to exclude this feature from the portal.",
|
|
53692
53838
|
type: "boolean"
|
|
53693
|
-
},
|
|
53694
|
-
reservations: {
|
|
53695
|
-
default: { exclude: false },
|
|
53696
|
-
description: "Configuration for the reservations feature.",
|
|
53697
|
-
properties: {
|
|
53698
|
-
exclude: {
|
|
53699
|
-
default: false,
|
|
53700
|
-
description: "Indicates whether the customer can view reservations for their properties.",
|
|
53701
|
-
type: "boolean"
|
|
53702
|
-
}
|
|
53703
|
-
},
|
|
53704
|
-
type: "object"
|
|
53705
53839
|
}
|
|
53706
53840
|
},
|
|
53707
53841
|
type: "object"
|
|
@@ -53954,52 +54088,35 @@ var openapi_default = {
|
|
|
53954
54088
|
},
|
|
53955
54089
|
type: "object"
|
|
53956
54090
|
},
|
|
53957
|
-
|
|
54091
|
+
manage: {
|
|
53958
54092
|
default: {
|
|
53959
54093
|
$ref: "#/components/schemas/access_code"
|
|
53960
54094
|
},
|
|
53961
|
-
description: "Configuration for the manage
|
|
54095
|
+
description: "Configuration for the manage feature.",
|
|
53962
54096
|
properties: {
|
|
53963
|
-
accepted_providers: {
|
|
53964
|
-
description: "List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.",
|
|
53965
|
-
items: { type: "string" },
|
|
53966
|
-
type: "array"
|
|
53967
|
-
},
|
|
53968
54097
|
exclude: {
|
|
53969
54098
|
default: false,
|
|
53970
54099
|
description: "Whether to exclude this feature from the portal.",
|
|
53971
54100
|
type: "boolean"
|
|
53972
54101
|
},
|
|
53973
|
-
|
|
53974
|
-
|
|
53975
|
-
|
|
53976
|
-
type: "
|
|
54102
|
+
exclude_reservation_management: {
|
|
54103
|
+
default: false,
|
|
54104
|
+
description: "Indicates whether the customer can manage reservations for their properties.",
|
|
54105
|
+
type: "boolean"
|
|
53977
54106
|
}
|
|
53978
54107
|
},
|
|
53979
54108
|
type: "object"
|
|
53980
54109
|
},
|
|
53981
|
-
|
|
54110
|
+
manage_devices: {
|
|
53982
54111
|
default: {
|
|
53983
54112
|
$ref: "#/components/schemas/access_code"
|
|
53984
54113
|
},
|
|
53985
|
-
description: "Configuration for the manage
|
|
54114
|
+
description: "Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---",
|
|
53986
54115
|
properties: {
|
|
53987
54116
|
exclude: {
|
|
53988
54117
|
default: false,
|
|
53989
54118
|
description: "Whether to exclude this feature from the portal.",
|
|
53990
54119
|
type: "boolean"
|
|
53991
|
-
},
|
|
53992
|
-
reservations: {
|
|
53993
|
-
default: { exclude: false },
|
|
53994
|
-
description: "Configuration for the reservations feature.",
|
|
53995
|
-
properties: {
|
|
53996
|
-
exclude: {
|
|
53997
|
-
default: false,
|
|
53998
|
-
description: "Indicates whether the customer can view reservations for their properties.",
|
|
53999
|
-
type: "boolean"
|
|
54000
|
-
}
|
|
54001
|
-
},
|
|
54002
|
-
type: "object"
|
|
54003
54120
|
}
|
|
54004
54121
|
},
|
|
54005
54122
|
type: "object"
|
|
@@ -55038,6 +55155,56 @@ var openapi_default = {
|
|
|
55038
55155
|
"x-title": "List Spaces"
|
|
55039
55156
|
}
|
|
55040
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
|
+
},
|
|
55041
55208
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
55042
55209
|
post: {
|
|
55043
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.",
|