@datviet/nbp-sdk 0.0.317
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/README.md +121 -0
- package/auth.d.ts +54 -0
- package/auth.js +213 -0
- package/client.d.ts +7 -0
- package/client.js +25 -0
- package/gen/client/client.gen.d.ts +2 -0
- package/gen/client/client.gen.js +165 -0
- package/gen/client/index.d.ts +7 -0
- package/gen/client/index.js +5 -0
- package/gen/client/types.gen.d.ts +127 -0
- package/gen/client/types.gen.js +2 -0
- package/gen/client/utils.gen.d.ts +38 -0
- package/gen/client/utils.gen.js +226 -0
- package/gen/client.gen.d.ts +12 -0
- package/gen/client.gen.js +5 -0
- package/gen/core/auth.gen.d.ts +18 -0
- package/gen/core/auth.gen.js +14 -0
- package/gen/core/bodySerializer.gen.d.ts +17 -0
- package/gen/core/bodySerializer.gen.js +57 -0
- package/gen/core/params.gen.d.ts +33 -0
- package/gen/core/params.gen.js +89 -0
- package/gen/core/pathSerializer.gen.d.ts +33 -0
- package/gen/core/pathSerializer.gen.js +106 -0
- package/gen/core/serverSentEvents.gen.d.ts +59 -0
- package/gen/core/serverSentEvents.gen.js +117 -0
- package/gen/core/types.gen.d.ts +78 -0
- package/gen/core/types.gen.js +2 -0
- package/gen/core/utils.gen.d.ts +14 -0
- package/gen/core/utils.gen.js +69 -0
- package/gen/sdk.gen.d.ts +403 -0
- package/gen/sdk.gen.js +881 -0
- package/gen/types.gen.d.ts +3372 -0
- package/gen/types.gen.js +2 -0
- package/index.d.ts +10 -0
- package/index.js +16 -0
- package/package.json +47 -0
- package/server.d.ts +23 -0
- package/server.js +94 -0
- package/v2/client.d.ts +7 -0
- package/v2/client.js +27 -0
- package/v2/gen/client/client.gen.d.ts +2 -0
- package/v2/gen/client/client.gen.js +225 -0
- package/v2/gen/client/index.d.ts +8 -0
- package/v2/gen/client/index.js +6 -0
- package/v2/gen/client/types.gen.d.ts +117 -0
- package/v2/gen/client/types.gen.js +2 -0
- package/v2/gen/client/utils.gen.d.ts +33 -0
- package/v2/gen/client/utils.gen.js +226 -0
- package/v2/gen/client.gen.d.ts +12 -0
- package/v2/gen/client.gen.js +3 -0
- package/v2/gen/core/auth.gen.d.ts +18 -0
- package/v2/gen/core/auth.gen.js +14 -0
- package/v2/gen/core/bodySerializer.gen.d.ts +25 -0
- package/v2/gen/core/bodySerializer.gen.js +57 -0
- package/v2/gen/core/params.gen.d.ts +43 -0
- package/v2/gen/core/params.gen.js +102 -0
- package/v2/gen/core/pathSerializer.gen.d.ts +33 -0
- package/v2/gen/core/pathSerializer.gen.js +106 -0
- package/v2/gen/core/queryKeySerializer.gen.d.ts +18 -0
- package/v2/gen/core/queryKeySerializer.gen.js +93 -0
- package/v2/gen/core/serverSentEvents.gen.d.ts +71 -0
- package/v2/gen/core/serverSentEvents.gen.js +131 -0
- package/v2/gen/core/types.gen.d.ts +78 -0
- package/v2/gen/core/types.gen.js +2 -0
- package/v2/gen/core/utils.gen.d.ts +19 -0
- package/v2/gen/core/utils.gen.js +87 -0
- package/v2/gen/sdk.gen.d.ts +2959 -0
- package/v2/gen/sdk.gen.js +4537 -0
- package/v2/gen/types.gen.d.ts +9316 -0
- package/v2/gen/types.gen.js +2 -0
- package/v2/index.d.ts +10 -0
- package/v2/index.js +16 -0
- package/v2/server.d.ts +23 -0
- package/v2/server.js +94 -0
|
@@ -0,0 +1,2959 @@
|
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from "./client/index.js";
|
|
2
|
+
import type { AgentListResponses, AgentPartInput, AgentStatsErrors, AgentStatsResponses, AppLogErrors, AppLogResponses, Auth as Auth2, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config2, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, DeleteInstructionsIdResponses, EntityPartInput, EventSubscribeResponses, ExperimentalResourceListResponses, FileListResponses, FilePartInput, FilePartSource, FileReadResponses, FileStatusResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GetInstructionsResponses, GetWorkspacesIdAuditResponses, GlobalDisposeResponses, GlobalEventResponses, GlobalHealthResponses, InstanceDisposeResponses, InternalAccountsListResponses, InternalAccountsUpdateFeaturesResponses, InternalCacheInvalidateAllResponses, InternalCacheInvalidateResponses, InternalCacheStatsResponses, InternalEmailSegmentsResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, NbpClientRelationsCreateResponses, NbpClientRelationsDeleteResponses, NbpClientRelationsListResponses, NbpClientsAddInteractionErrors, NbpClientsAddInteractionResponses, NbpClientsCreateErrors, NbpClientsCreateResponses, NbpClientsDeleteErrors, NbpClientsDeleteResponses, NbpClientsExportErrors, NbpClientsExportResponses, NbpClientsGetErrors, NbpClientsGetResponses, NbpClientsHistoryResponses, NbpClientsHotResponses, NbpClientsInteractionsFeedResponses, NbpClientsListResponses, NbpClientsMatchesResponses, NbpClientsStatsResponses, NbpClientsUpdateErrors, NbpClientsUpdateResponses, NbpContactsListingsResponses, NbpContactsPhoneLinkResponses, NbpContactsPhonesResponses, NbpContactsPhoneUnlinkResponses, NbpDangerPurgeConfirmErrors, NbpDangerPurgeConfirmResponses, NbpDangerPurgeRequestResponses, NbpDivisionsListResponses, NbpListingsAddInteractionErrors, NbpListingsAddInteractionResponses, NbpListingsBulkUpsertErrors, NbpListingsBulkUpsertResponses, NbpListingsClustersResponses, NbpListingsCreateErrors, NbpListingsCreateResponses, NbpListingsDeleteErrors, NbpListingsDeleteResponses, NbpListingsExportDataErrors, NbpListingsExportDataResponses, NbpListingsExportErrors, NbpListingsExportResponses, NbpListingsGeoResponses, NbpListingsGetErrors, NbpListingsGetResponses, NbpListingsHistoryResponses, NbpListingsImagesByCodesErrors, NbpListingsImagesByCodesResponses, NbpListingsListResponses, NbpListingsMatchesResponses, NbpListingsQueryErrors, NbpListingsQueryResponses, NbpListingsStatsResponses, NbpListingsUnmaskPhoneErrors, NbpListingsUnmaskPhoneResponses, NbpListingsUpdateErrors, NbpListingsUpdateLocationErrors, NbpListingsUpdateLocationResponses, NbpListingsUpdateResponses, NbpPropertiesCreateErrors, NbpPropertiesCreateResponses, NbpPropertiesDeleteErrors, NbpPropertiesDeleteResponses, NbpPropertiesGetErrors, NbpPropertiesGetResponses, NbpPropertiesListingsErrors, NbpPropertiesListingsResponses, NbpPropertiesListResponses, NbpPropertiesUpdateErrors, NbpPropertiesUpdateResponses, NbpSearchClientsResponses, NbpSearchGlobalResponses, NbpSearchListingsResponses, NbpSearchQuickResponses, NbpTagsClientsDefaultsResponses, NbpTagsClientsResetResponses, NbpTagsClientsResponses, NbpTagsClientsSaveErrors, NbpTagsClientsSaveResponses, NbpTagsListingsDefaultsResponses, NbpTagsListingsResetResponses, NbpTagsListingsResponses, NbpTagsListingsSaveErrors, NbpTagsListingsSaveResponses, NbpTasksCreateResponses, NbpTasksDeleteResponses, NbpTasksGetErrors, NbpTasksGetResponses, NbpTasksListResponses, NbpTasksTodayResponses, NbpTasksUpdateErrors, NbpTasksUpdateResponses, NbpViewsGetErrors, NbpViewsGetResponses, NbpViewsResetPersonalErrors, NbpViewsResetPersonalResponses, NbpViewsSavePersonalErrors, NbpViewsSavePersonalResponses, NbpViewsSaveWorkspaceErrors, NbpViewsSaveWorkspaceResponses, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PatchInstructionsIdResponses, PatchInstructionsIdToggleResponses, PatchMapAdminPartnersIdResponses, PatchWorkspacesIdBrandingResponses, PatchWorkspacesIdGeocodingResponses, PatchWorkspacesIdMembersMemberIdResponses, PatchWorkspacesIdRolesRoleIdResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, PostAccountAcquisitionResponses, PostAffiliateBindResponses, PostAffiliateClickResponses, PostInstructionsResponses, PostMapAdminAffiliatePayoutsSettleResponses, PostMapAdminAffiliatesBindResponses, PostMapAdminAffiliatesResponses, PostMapAdminAffiliatesToggleResponses, PostMapAdminCustomCheckoutResponses, PostMapAdminGrantResponses, PostMapAdminPartnersIdCreditLimitResponses, PostMapAdminPartnersIdKeysResponses, PostMapAdminPartnersResponses, PostMapAdminReferralsRevokeResponses, PostMapAdminSetAccessResponses, PostMapAdminWalletCreditResponses, PostMapBrochureChargeResponses, PostMapClaimResponses, PostMapEventsResponses, PostMapPayCheckoutResponses, PostMapReferralRedeemResponses, PostMapWalletTopupResponses, PostWorkspacesIdBrandingUploadUrlResponses, PostWorkspacesIdGeocodingTestResponses, PostWorkspacesIdInviteResponses, PostWorkspacesIdRolesResponses, PostWorkspacesIdTransferOwnershipResponses, ProjectCurrentResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeResponses, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyUpdateErrors, PtyUpdateResponses, PutAccountMeResponses, PutAccountPhoneResponses, PutAffiliateBankResponses, PutWorkspacesIdMembersMemberIdRolesResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteResponses, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionInitErrors, SessionInitResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShareErrors, SessionShareResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUnshareErrors, SessionUnshareResponses, SessionUpdateErrors, SessionUpdateResponses, SessionUsageResponses, SubtaskPartInput, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, VcsGetResponses, WorkspacesApiKeysCreateErrors, WorkspacesApiKeysCreateResponses, WorkspacesApiKeysListErrors, WorkspacesApiKeysListResponses, WorkspacesApiKeysRevokeErrors, WorkspacesApiKeysRevokeResponses, WorkspacesCreateResponses, WorkspacesGetErrors, WorkspacesGetResponses, WorkspacesIntegrationsOriginsListErrors, WorkspacesIntegrationsOriginsListResponses, WorkspacesIntegrationsOriginsReplaceErrors, WorkspacesIntegrationsOriginsReplaceResponses, WorkspacesListResponses, WorkspacesUpdateErrors, WorkspacesUpdateResponses, WorkspacesUsageResponses, WorktreeCreateErrors, WorktreeCreateResponses, WorktreeListResponses } from "./types.gen.js";
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
declare class HeyApiClient {
|
|
17
|
+
protected client: Client;
|
|
18
|
+
constructor(args?: {
|
|
19
|
+
client?: Client;
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
declare class HeyApiRegistry<T> {
|
|
23
|
+
private readonly defaultKey;
|
|
24
|
+
private readonly instances;
|
|
25
|
+
get(key?: string): T;
|
|
26
|
+
set(value: T, key?: string): void;
|
|
27
|
+
}
|
|
28
|
+
export declare class Global extends HeyApiClient {
|
|
29
|
+
/**
|
|
30
|
+
* Get health
|
|
31
|
+
*
|
|
32
|
+
* Get health information about the NBP server.
|
|
33
|
+
*/
|
|
34
|
+
health<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalHealthResponses, unknown, ThrowOnError, "fields">;
|
|
35
|
+
/**
|
|
36
|
+
* Get global events
|
|
37
|
+
*
|
|
38
|
+
* Subscribe to global events from the NBP system using server-sent events.
|
|
39
|
+
*/
|
|
40
|
+
event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<GlobalEventResponses, unknown>>;
|
|
41
|
+
/**
|
|
42
|
+
* Dispose instance
|
|
43
|
+
*
|
|
44
|
+
* Clean up and dispose all NBP instances, releasing all resources.
|
|
45
|
+
*/
|
|
46
|
+
dispose<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
47
|
+
}
|
|
48
|
+
export declare class ApiKeys extends HeyApiClient {
|
|
49
|
+
/**
|
|
50
|
+
* List workspace API keys
|
|
51
|
+
*
|
|
52
|
+
* List active API keys (prefix only — the raw key is never returned again)
|
|
53
|
+
*/
|
|
54
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
55
|
+
id: string;
|
|
56
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesApiKeysListResponses, WorkspacesApiKeysListErrors, ThrowOnError, "fields">;
|
|
57
|
+
/**
|
|
58
|
+
* Create workspace API key
|
|
59
|
+
*
|
|
60
|
+
* Create an API key. The raw key is returned ONCE and cannot be retrieved later.
|
|
61
|
+
*/
|
|
62
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
63
|
+
id: string;
|
|
64
|
+
name?: string;
|
|
65
|
+
role?: "member" | "admin";
|
|
66
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesApiKeysCreateResponses, WorkspacesApiKeysCreateErrors, ThrowOnError, "fields">;
|
|
67
|
+
/**
|
|
68
|
+
* Revoke workspace API key
|
|
69
|
+
*
|
|
70
|
+
* Revoke an API key. Requests using it fail immediately.
|
|
71
|
+
*/
|
|
72
|
+
revoke<ThrowOnError extends boolean = false>(parameters: {
|
|
73
|
+
id: string;
|
|
74
|
+
keyId: string;
|
|
75
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesApiKeysRevokeResponses, WorkspacesApiKeysRevokeErrors, ThrowOnError, "fields">;
|
|
76
|
+
}
|
|
77
|
+
export declare class Origins extends HeyApiClient {
|
|
78
|
+
/**
|
|
79
|
+
* List allowed browser origins
|
|
80
|
+
*
|
|
81
|
+
* Origins allowed to call the API from a browser with this workspace's credentials
|
|
82
|
+
*/
|
|
83
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
84
|
+
id: string;
|
|
85
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesIntegrationsOriginsListResponses, WorkspacesIntegrationsOriginsListErrors, ThrowOnError, "fields">;
|
|
86
|
+
/**
|
|
87
|
+
* Replace allowed browser origins
|
|
88
|
+
*
|
|
89
|
+
* Replace the whole list. Only https:// (or http:// on localhost) is accepted.
|
|
90
|
+
*/
|
|
91
|
+
replace<ThrowOnError extends boolean = false>(parameters: {
|
|
92
|
+
id: string;
|
|
93
|
+
origins?: Array<string>;
|
|
94
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesIntegrationsOriginsReplaceResponses, WorkspacesIntegrationsOriginsReplaceErrors, ThrowOnError, "fields">;
|
|
95
|
+
}
|
|
96
|
+
export declare class Integrations extends HeyApiClient {
|
|
97
|
+
origins: Origins;
|
|
98
|
+
}
|
|
99
|
+
export declare class Workspaces extends HeyApiClient {
|
|
100
|
+
/**
|
|
101
|
+
* List workspaces
|
|
102
|
+
*
|
|
103
|
+
* Get all workspaces the current user has access to
|
|
104
|
+
*/
|
|
105
|
+
list<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesListResponses, unknown, ThrowOnError, "fields">;
|
|
106
|
+
/**
|
|
107
|
+
* Create workspace
|
|
108
|
+
*
|
|
109
|
+
* Create a new workspace with the current user as owner
|
|
110
|
+
*/
|
|
111
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
112
|
+
name?: string;
|
|
113
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesCreateResponses, unknown, ThrowOnError, "fields">;
|
|
114
|
+
/**
|
|
115
|
+
* Get workspace
|
|
116
|
+
*
|
|
117
|
+
* Get details of a specific workspace
|
|
118
|
+
*/
|
|
119
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
120
|
+
id: string;
|
|
121
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesGetResponses, WorkspacesGetErrors, ThrowOnError, "fields">;
|
|
122
|
+
/**
|
|
123
|
+
* Update workspace
|
|
124
|
+
*
|
|
125
|
+
* Update workspace name (owner/admin only)
|
|
126
|
+
*/
|
|
127
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
128
|
+
id: string;
|
|
129
|
+
name?: string;
|
|
130
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesUpdateResponses, WorkspacesUpdateErrors, ThrowOnError, "fields">;
|
|
131
|
+
/**
|
|
132
|
+
* Workspace usage
|
|
133
|
+
*
|
|
134
|
+
* Plan limits and current usage (listings, clients, sessions) for a workspace
|
|
135
|
+
*/
|
|
136
|
+
usage<ThrowOnError extends boolean = false>(parameters: {
|
|
137
|
+
id: string;
|
|
138
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorkspacesUsageResponses, unknown, ThrowOnError, "fields">;
|
|
139
|
+
apiKeys: ApiKeys;
|
|
140
|
+
integrations: Integrations;
|
|
141
|
+
}
|
|
142
|
+
export declare class Project extends HeyApiClient {
|
|
143
|
+
/**
|
|
144
|
+
* List all projects
|
|
145
|
+
*
|
|
146
|
+
* Get a list of projects that have been opened with NBP.
|
|
147
|
+
*/
|
|
148
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
149
|
+
directory?: string;
|
|
150
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectListResponses, unknown, ThrowOnError, "fields">;
|
|
151
|
+
/**
|
|
152
|
+
* Get current project
|
|
153
|
+
*
|
|
154
|
+
* Retrieve the currently active project that NBP is working with.
|
|
155
|
+
*/
|
|
156
|
+
current<ThrowOnError extends boolean = false>(parameters?: {
|
|
157
|
+
directory?: string;
|
|
158
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectCurrentResponses, unknown, ThrowOnError, "fields">;
|
|
159
|
+
/**
|
|
160
|
+
* Update project
|
|
161
|
+
*
|
|
162
|
+
* Update project properties such as name, icon and color.
|
|
163
|
+
*/
|
|
164
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
165
|
+
projectID: string;
|
|
166
|
+
directory?: string;
|
|
167
|
+
name?: string;
|
|
168
|
+
icon?: {
|
|
169
|
+
url?: string;
|
|
170
|
+
color?: string;
|
|
171
|
+
};
|
|
172
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectUpdateResponses, ProjectUpdateErrors, ThrowOnError, "fields">;
|
|
173
|
+
}
|
|
174
|
+
export declare class Cache extends HeyApiClient {
|
|
175
|
+
/**
|
|
176
|
+
* Invalidate subscription cache
|
|
177
|
+
*
|
|
178
|
+
* Invalidate cached subscription data for a workspace. Called by Console after Stripe webhook.
|
|
179
|
+
*/
|
|
180
|
+
invalidate<ThrowOnError extends boolean = false>(parameters?: {
|
|
181
|
+
directory?: string;
|
|
182
|
+
workspaceId?: string;
|
|
183
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalCacheInvalidateResponses, unknown, ThrowOnError, "fields">;
|
|
184
|
+
/**
|
|
185
|
+
* Invalidate all subscription caches
|
|
186
|
+
*
|
|
187
|
+
* Clear all cached subscription data. Use sparingly.
|
|
188
|
+
*/
|
|
189
|
+
invalidateAll<ThrowOnError extends boolean = false>(parameters?: {
|
|
190
|
+
directory?: string;
|
|
191
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalCacheInvalidateAllResponses, unknown, ThrowOnError, "fields">;
|
|
192
|
+
/**
|
|
193
|
+
* Get cache statistics
|
|
194
|
+
*
|
|
195
|
+
* Get subscription cache statistics for debugging.
|
|
196
|
+
*/
|
|
197
|
+
stats<ThrowOnError extends boolean = false>(parameters?: {
|
|
198
|
+
directory?: string;
|
|
199
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalCacheStatsResponses, unknown, ThrowOnError, "fields">;
|
|
200
|
+
}
|
|
201
|
+
export declare class Accounts extends HeyApiClient {
|
|
202
|
+
/**
|
|
203
|
+
* List all accounts
|
|
204
|
+
*
|
|
205
|
+
* List all accounts with features. Used by Console admin.
|
|
206
|
+
*/
|
|
207
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
208
|
+
directory?: string;
|
|
209
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalAccountsListResponses, unknown, ThrowOnError, "fields">;
|
|
210
|
+
/**
|
|
211
|
+
* Update account features
|
|
212
|
+
*
|
|
213
|
+
* Toggle account features (outTrinh, etc.). Used by Console admin.
|
|
214
|
+
*/
|
|
215
|
+
updateFeatures<ThrowOnError extends boolean = false>(parameters: {
|
|
216
|
+
id: string;
|
|
217
|
+
directory?: string;
|
|
218
|
+
outTrinh?: boolean;
|
|
219
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalAccountsUpdateFeaturesResponses, unknown, ThrowOnError, "fields">;
|
|
220
|
+
}
|
|
221
|
+
export declare class Internal extends HeyApiClient {
|
|
222
|
+
/**
|
|
223
|
+
* Email lifecycle segments
|
|
224
|
+
*
|
|
225
|
+
* Users bucketed by map-access expiry (VN days): 1Y at -14/-3/-1, 1M/3M at -3, trial expired yesterday. Called daily by the Ankapong email cron.
|
|
226
|
+
*/
|
|
227
|
+
emailSegments<ThrowOnError extends boolean = false>(parameters?: {
|
|
228
|
+
directory?: string;
|
|
229
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InternalEmailSegmentsResponses, unknown, ThrowOnError, "fields">;
|
|
230
|
+
cache: Cache;
|
|
231
|
+
accounts: Accounts;
|
|
232
|
+
}
|
|
233
|
+
export declare class Listings extends HeyApiClient {
|
|
234
|
+
/**
|
|
235
|
+
* Get listings statistics
|
|
236
|
+
*
|
|
237
|
+
* Get aggregate statistics about listings
|
|
238
|
+
*/
|
|
239
|
+
stats<ThrowOnError extends boolean = false>(parameters?: {
|
|
240
|
+
directory?: string;
|
|
241
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsStatsResponses, unknown, ThrowOnError, "fields">;
|
|
242
|
+
/**
|
|
243
|
+
* List listings
|
|
244
|
+
*
|
|
245
|
+
* Get listings with optional filters for category, price range, area, etc.
|
|
246
|
+
*/
|
|
247
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
248
|
+
directory?: string;
|
|
249
|
+
propertyId?: string;
|
|
250
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
251
|
+
minPrice?: number;
|
|
252
|
+
maxPrice?: number;
|
|
253
|
+
ward?: string;
|
|
254
|
+
provinceId?: string;
|
|
255
|
+
districtId?: string;
|
|
256
|
+
wardId?: string;
|
|
257
|
+
category?: "sale" | "rent";
|
|
258
|
+
property_type?: string;
|
|
259
|
+
location_type?: string;
|
|
260
|
+
legal_status?: string;
|
|
261
|
+
building_condition?: string;
|
|
262
|
+
furnishing_status?: string;
|
|
263
|
+
facing_direction?: string;
|
|
264
|
+
planning_status?: string;
|
|
265
|
+
district?: string;
|
|
266
|
+
street?: string;
|
|
267
|
+
minArea?: number;
|
|
268
|
+
maxArea?: number;
|
|
269
|
+
bedrooms?: number;
|
|
270
|
+
bathrooms?: number;
|
|
271
|
+
floors?: number;
|
|
272
|
+
minWidth?: number;
|
|
273
|
+
maxWidth?: number;
|
|
274
|
+
minLength?: number;
|
|
275
|
+
maxLength?: number;
|
|
276
|
+
createdBy?: string;
|
|
277
|
+
updatedAt?: string;
|
|
278
|
+
updatedWithinDays?: number;
|
|
279
|
+
phone?: string;
|
|
280
|
+
priceDirection?: "up" | "down";
|
|
281
|
+
hasPhotos?: string;
|
|
282
|
+
source?: "own" | "market" | "all";
|
|
283
|
+
search?: string;
|
|
284
|
+
sortBy?: "price" | "area" | "time_updated" | "time_created" | "code" | "bedrooms";
|
|
285
|
+
sortDirection?: "asc" | "desc";
|
|
286
|
+
limit?: number;
|
|
287
|
+
offset?: number;
|
|
288
|
+
bboxMinLat?: number;
|
|
289
|
+
bboxMaxLat?: number;
|
|
290
|
+
bboxMinLon?: number;
|
|
291
|
+
bboxMaxLon?: number;
|
|
292
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsListResponses, unknown, ThrowOnError, "fields">;
|
|
293
|
+
/**
|
|
294
|
+
* Create listing
|
|
295
|
+
*
|
|
296
|
+
* Create a new property listing
|
|
297
|
+
*/
|
|
298
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
299
|
+
directory?: string;
|
|
300
|
+
propertyId?: string;
|
|
301
|
+
code?: string;
|
|
302
|
+
price?: number;
|
|
303
|
+
openPrice?: number;
|
|
304
|
+
ward?: string;
|
|
305
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
306
|
+
tags?: {
|
|
307
|
+
category: "sale" | "rent";
|
|
308
|
+
property_type?: string;
|
|
309
|
+
address?: string;
|
|
310
|
+
ward?: string;
|
|
311
|
+
district?: string;
|
|
312
|
+
province?: string;
|
|
313
|
+
street?: string;
|
|
314
|
+
house_number?: string;
|
|
315
|
+
unit_number?: string;
|
|
316
|
+
lot_number?: string;
|
|
317
|
+
floor_number?: number;
|
|
318
|
+
block?: string;
|
|
319
|
+
building_name?: string;
|
|
320
|
+
room_number?: string;
|
|
321
|
+
location_type?: string;
|
|
322
|
+
area?: number;
|
|
323
|
+
width?: number;
|
|
324
|
+
length?: number;
|
|
325
|
+
rear_width?: number;
|
|
326
|
+
road_width?: number;
|
|
327
|
+
floors?: number;
|
|
328
|
+
bedrooms?: number;
|
|
329
|
+
bathrooms?: number;
|
|
330
|
+
facing_direction?: string;
|
|
331
|
+
ownership_type?: string;
|
|
332
|
+
broker_fee_percent?: number;
|
|
333
|
+
construction_raw?: string;
|
|
334
|
+
legal_status?: string;
|
|
335
|
+
building_condition?: string;
|
|
336
|
+
furnishing_status?: string;
|
|
337
|
+
year_built?: number;
|
|
338
|
+
amenities?: Array<string>;
|
|
339
|
+
highlights?: Array<string>;
|
|
340
|
+
contact?: {
|
|
341
|
+
name?: string;
|
|
342
|
+
phone?: string;
|
|
343
|
+
role?: string;
|
|
344
|
+
};
|
|
345
|
+
images?: Array<string> | {
|
|
346
|
+
photos?: Array<string>;
|
|
347
|
+
legal?: Array<string>;
|
|
348
|
+
history?: Array<string>;
|
|
349
|
+
};
|
|
350
|
+
videos?: Array<string>;
|
|
351
|
+
notes?: string;
|
|
352
|
+
source?: {
|
|
353
|
+
platform?: string;
|
|
354
|
+
url?: string;
|
|
355
|
+
imported_at?: string;
|
|
356
|
+
external_id?: string;
|
|
357
|
+
external_code?: string;
|
|
358
|
+
phone_token?: string;
|
|
359
|
+
phone_masked?: string;
|
|
360
|
+
phone?: string;
|
|
361
|
+
phone_alt?: string;
|
|
362
|
+
lat?: number;
|
|
363
|
+
long?: number;
|
|
364
|
+
legacy?: boolean;
|
|
365
|
+
image_urls?: Array<string>;
|
|
366
|
+
legal_urls?: Array<string>;
|
|
367
|
+
price_history?: Array<{
|
|
368
|
+
[key: string]: unknown;
|
|
369
|
+
}>;
|
|
370
|
+
content_hash?: string;
|
|
371
|
+
[key: string]: unknown | string | number | boolean | Array<string> | Array<string> | Array<{
|
|
372
|
+
[key: string]: unknown;
|
|
373
|
+
}> | undefined;
|
|
374
|
+
};
|
|
375
|
+
brokerage_fee?: {
|
|
376
|
+
percentage?: number;
|
|
377
|
+
amount?: number;
|
|
378
|
+
paid_by?: string;
|
|
379
|
+
};
|
|
380
|
+
availability?: {
|
|
381
|
+
status?: string;
|
|
382
|
+
date?: string;
|
|
383
|
+
notes?: string;
|
|
384
|
+
};
|
|
385
|
+
seller_profile?: {
|
|
386
|
+
motivation?: string;
|
|
387
|
+
urgency?: string;
|
|
388
|
+
decision_maker?: string;
|
|
389
|
+
other_stakeholders?: Array<string>;
|
|
390
|
+
ownership_duration?: string;
|
|
391
|
+
};
|
|
392
|
+
price_negotiation?: {
|
|
393
|
+
listed_price?: number;
|
|
394
|
+
bottom_price?: number;
|
|
395
|
+
flexibility?: string;
|
|
396
|
+
price_history?: Array<{
|
|
397
|
+
date: string;
|
|
398
|
+
price: number;
|
|
399
|
+
reason?: string;
|
|
400
|
+
}>;
|
|
401
|
+
confidence?: number;
|
|
402
|
+
};
|
|
403
|
+
interactions?: Array<{
|
|
404
|
+
id: string;
|
|
405
|
+
date: string;
|
|
406
|
+
type: "call" | "meeting" | "message" | "site_visit" | "photo_session" | "contract_sign" | "note";
|
|
407
|
+
with_whom?: "owner" | "spouse" | "broker" | "family" | "other";
|
|
408
|
+
notes: string;
|
|
409
|
+
insights?: {
|
|
410
|
+
signals?: Array<string>;
|
|
411
|
+
concerns?: Array<string>;
|
|
412
|
+
price_hints?: Array<string>;
|
|
413
|
+
action_items?: Array<string>;
|
|
414
|
+
};
|
|
415
|
+
outcome?: "positive" | "neutral" | "negative";
|
|
416
|
+
}>;
|
|
417
|
+
viewings?: Array<{
|
|
418
|
+
id: string;
|
|
419
|
+
date: string;
|
|
420
|
+
client_id: string;
|
|
421
|
+
client_name: string;
|
|
422
|
+
attendees?: Array<string>;
|
|
423
|
+
duration_minutes?: number;
|
|
424
|
+
client_feedback?: {
|
|
425
|
+
interest_level?: "very_interested" | "interested" | "neutral" | "not_interested";
|
|
426
|
+
likes?: Array<string>;
|
|
427
|
+
dislikes?: Array<string>;
|
|
428
|
+
questions?: Array<string>;
|
|
429
|
+
objections?: Array<string>;
|
|
430
|
+
price_reaction?: "acceptable" | "high" | "very_high" | "will_negotiate";
|
|
431
|
+
};
|
|
432
|
+
follow_up?: {
|
|
433
|
+
status?: "pending" | "scheduled" | "done" | "no_interest";
|
|
434
|
+
next_action?: string;
|
|
435
|
+
next_date?: string;
|
|
436
|
+
};
|
|
437
|
+
}>;
|
|
438
|
+
interested_clients?: Array<{
|
|
439
|
+
client_id: string;
|
|
440
|
+
client_name: string;
|
|
441
|
+
interest_date: string;
|
|
442
|
+
status: string;
|
|
443
|
+
offered_price?: number;
|
|
444
|
+
rejection_reason?: string;
|
|
445
|
+
}>;
|
|
446
|
+
exclusivity?: {
|
|
447
|
+
type?: string;
|
|
448
|
+
start_date?: string;
|
|
449
|
+
end_date?: string;
|
|
450
|
+
commission_rate?: number;
|
|
451
|
+
other_brokers?: Array<string>;
|
|
452
|
+
};
|
|
453
|
+
[key: string]: unknown | "sale" | "rent" | string | number | Array<string> | Array<string> | {
|
|
454
|
+
name?: string;
|
|
455
|
+
phone?: string;
|
|
456
|
+
role?: string;
|
|
457
|
+
} | Array<string> | {
|
|
458
|
+
photos?: Array<string>;
|
|
459
|
+
legal?: Array<string>;
|
|
460
|
+
history?: Array<string>;
|
|
461
|
+
} | Array<string> | {
|
|
462
|
+
platform?: string;
|
|
463
|
+
url?: string;
|
|
464
|
+
imported_at?: string;
|
|
465
|
+
external_id?: string;
|
|
466
|
+
external_code?: string;
|
|
467
|
+
phone_token?: string;
|
|
468
|
+
phone_masked?: string;
|
|
469
|
+
phone?: string;
|
|
470
|
+
phone_alt?: string;
|
|
471
|
+
lat?: number;
|
|
472
|
+
long?: number;
|
|
473
|
+
legacy?: boolean;
|
|
474
|
+
image_urls?: Array<string>;
|
|
475
|
+
legal_urls?: Array<string>;
|
|
476
|
+
price_history?: Array<{
|
|
477
|
+
[key: string]: unknown;
|
|
478
|
+
}>;
|
|
479
|
+
content_hash?: string;
|
|
480
|
+
[key: string]: unknown | string | number | boolean | Array<string> | Array<string> | Array<{
|
|
481
|
+
[key: string]: unknown;
|
|
482
|
+
}> | undefined;
|
|
483
|
+
} | {
|
|
484
|
+
percentage?: number;
|
|
485
|
+
amount?: number;
|
|
486
|
+
paid_by?: string;
|
|
487
|
+
} | {
|
|
488
|
+
status?: string;
|
|
489
|
+
date?: string;
|
|
490
|
+
notes?: string;
|
|
491
|
+
} | {
|
|
492
|
+
motivation?: string;
|
|
493
|
+
urgency?: string;
|
|
494
|
+
decision_maker?: string;
|
|
495
|
+
other_stakeholders?: Array<string>;
|
|
496
|
+
ownership_duration?: string;
|
|
497
|
+
} | {
|
|
498
|
+
listed_price?: number;
|
|
499
|
+
bottom_price?: number;
|
|
500
|
+
flexibility?: string;
|
|
501
|
+
price_history?: Array<{
|
|
502
|
+
date: string;
|
|
503
|
+
price: number;
|
|
504
|
+
reason?: string;
|
|
505
|
+
}>;
|
|
506
|
+
confidence?: number;
|
|
507
|
+
} | Array<{
|
|
508
|
+
id: string;
|
|
509
|
+
date: string;
|
|
510
|
+
type: "call" | "meeting" | "message" | "site_visit" | "photo_session" | "contract_sign" | "note";
|
|
511
|
+
with_whom?: "owner" | "spouse" | "broker" | "family" | "other";
|
|
512
|
+
notes: string;
|
|
513
|
+
insights?: {
|
|
514
|
+
signals?: Array<string>;
|
|
515
|
+
concerns?: Array<string>;
|
|
516
|
+
price_hints?: Array<string>;
|
|
517
|
+
action_items?: Array<string>;
|
|
518
|
+
};
|
|
519
|
+
outcome?: "positive" | "neutral" | "negative";
|
|
520
|
+
}> | Array<{
|
|
521
|
+
id: string;
|
|
522
|
+
date: string;
|
|
523
|
+
client_id: string;
|
|
524
|
+
client_name: string;
|
|
525
|
+
attendees?: Array<string>;
|
|
526
|
+
duration_minutes?: number;
|
|
527
|
+
client_feedback?: {
|
|
528
|
+
interest_level?: "very_interested" | "interested" | "neutral" | "not_interested";
|
|
529
|
+
likes?: Array<string>;
|
|
530
|
+
dislikes?: Array<string>;
|
|
531
|
+
questions?: Array<string>;
|
|
532
|
+
objections?: Array<string>;
|
|
533
|
+
price_reaction?: "acceptable" | "high" | "very_high" | "will_negotiate";
|
|
534
|
+
};
|
|
535
|
+
follow_up?: {
|
|
536
|
+
status?: "pending" | "scheduled" | "done" | "no_interest";
|
|
537
|
+
next_action?: string;
|
|
538
|
+
next_date?: string;
|
|
539
|
+
};
|
|
540
|
+
}> | Array<{
|
|
541
|
+
client_id: string;
|
|
542
|
+
client_name: string;
|
|
543
|
+
interest_date: string;
|
|
544
|
+
status: string;
|
|
545
|
+
offered_price?: number;
|
|
546
|
+
rejection_reason?: string;
|
|
547
|
+
}> | {
|
|
548
|
+
type?: string;
|
|
549
|
+
start_date?: string;
|
|
550
|
+
end_date?: string;
|
|
551
|
+
commission_rate?: number;
|
|
552
|
+
other_brokers?: Array<string>;
|
|
553
|
+
} | undefined;
|
|
554
|
+
};
|
|
555
|
+
contacts?: Array<{
|
|
556
|
+
name?: string;
|
|
557
|
+
phone: string;
|
|
558
|
+
role?: "owner" | "broker" | "agent";
|
|
559
|
+
isPrimary?: boolean;
|
|
560
|
+
}>;
|
|
561
|
+
createdAt?: string;
|
|
562
|
+
updatedAt?: string;
|
|
563
|
+
createdBy?: string;
|
|
564
|
+
divisionId?: string;
|
|
565
|
+
oldDivisionId?: string;
|
|
566
|
+
provinceId?: string;
|
|
567
|
+
districtId?: string;
|
|
568
|
+
wardId?: string;
|
|
569
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsCreateResponses, NbpListingsCreateErrors, ThrowOnError, "fields">;
|
|
570
|
+
/**
|
|
571
|
+
* Get listing geo points
|
|
572
|
+
*
|
|
573
|
+
* Columnar geo data for map pins. Returns all geocoded listings.
|
|
574
|
+
*/
|
|
575
|
+
geo<ThrowOnError extends boolean = false>(parameters?: {
|
|
576
|
+
directory?: string;
|
|
577
|
+
category?: "sale" | "rent";
|
|
578
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
579
|
+
property_type?: string;
|
|
580
|
+
location_type?: string;
|
|
581
|
+
minPrice?: number;
|
|
582
|
+
maxPrice?: number;
|
|
583
|
+
provinceId?: string;
|
|
584
|
+
districtId?: string;
|
|
585
|
+
wardId?: string;
|
|
586
|
+
search?: string;
|
|
587
|
+
bboxMinLat?: number;
|
|
588
|
+
bboxMaxLat?: number;
|
|
589
|
+
bboxMinLon?: number;
|
|
590
|
+
bboxMaxLon?: number;
|
|
591
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsGeoResponses, unknown, ThrowOnError, "fields">;
|
|
592
|
+
/**
|
|
593
|
+
* Get aggregated map clusters
|
|
594
|
+
*
|
|
595
|
+
* GROUP BY province/district/ward; returns count + AVG centroid + bounds per cell. Level chosen from zoom (province <10, district 10-12, ward ≥13).
|
|
596
|
+
*/
|
|
597
|
+
clusters<ThrowOnError extends boolean = false>(parameters: {
|
|
598
|
+
directory?: string;
|
|
599
|
+
zoom: number;
|
|
600
|
+
category?: "sale" | "rent";
|
|
601
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
602
|
+
property_type?: string;
|
|
603
|
+
location_type?: string;
|
|
604
|
+
minPrice?: number;
|
|
605
|
+
maxPrice?: number;
|
|
606
|
+
provinceId?: string;
|
|
607
|
+
districtId?: string;
|
|
608
|
+
wardId?: string;
|
|
609
|
+
bboxMinLat?: number;
|
|
610
|
+
bboxMaxLat?: number;
|
|
611
|
+
bboxMinLon?: number;
|
|
612
|
+
bboxMaxLon?: number;
|
|
613
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsClustersResponses, unknown, ThrowOnError, "fields">;
|
|
614
|
+
/**
|
|
615
|
+
* Get listing image URLs by codes
|
|
616
|
+
*
|
|
617
|
+
* Batch lookup full CDN URLs for listings referenced by code (e.g. TS-67106). Used by chat UI to render inline thumbnails without leaking URLs into AI context.
|
|
618
|
+
*/
|
|
619
|
+
imagesByCodes<ThrowOnError extends boolean = false>(parameters?: {
|
|
620
|
+
directory?: string;
|
|
621
|
+
codes?: Array<string>;
|
|
622
|
+
size?: "raw" | "thumbnail" | "large";
|
|
623
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsImagesByCodesResponses, NbpListingsImagesByCodesErrors, ThrowOnError, "fields">;
|
|
624
|
+
/**
|
|
625
|
+
* Delete listing
|
|
626
|
+
*
|
|
627
|
+
* Delete a listing
|
|
628
|
+
*/
|
|
629
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
630
|
+
id: string;
|
|
631
|
+
directory?: string;
|
|
632
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsDeleteResponses, NbpListingsDeleteErrors, ThrowOnError, "fields">;
|
|
633
|
+
/**
|
|
634
|
+
* Get listing
|
|
635
|
+
*
|
|
636
|
+
* Get a single listing by ID
|
|
637
|
+
*/
|
|
638
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
639
|
+
id: string;
|
|
640
|
+
directory?: string;
|
|
641
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsGetResponses, NbpListingsGetErrors, ThrowOnError, "fields">;
|
|
642
|
+
/**
|
|
643
|
+
* Update listing
|
|
644
|
+
*
|
|
645
|
+
* Update an existing listing
|
|
646
|
+
*/
|
|
647
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
648
|
+
id: string;
|
|
649
|
+
directory?: string;
|
|
650
|
+
propertyId?: string;
|
|
651
|
+
code?: string;
|
|
652
|
+
price?: number;
|
|
653
|
+
openPrice?: number;
|
|
654
|
+
ward?: string;
|
|
655
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
656
|
+
tags?: {
|
|
657
|
+
category: "sale" | "rent";
|
|
658
|
+
property_type?: string;
|
|
659
|
+
address?: string;
|
|
660
|
+
ward?: string;
|
|
661
|
+
district?: string;
|
|
662
|
+
province?: string;
|
|
663
|
+
street?: string;
|
|
664
|
+
house_number?: string;
|
|
665
|
+
unit_number?: string;
|
|
666
|
+
lot_number?: string;
|
|
667
|
+
floor_number?: number;
|
|
668
|
+
block?: string;
|
|
669
|
+
building_name?: string;
|
|
670
|
+
room_number?: string;
|
|
671
|
+
location_type?: string;
|
|
672
|
+
area?: number;
|
|
673
|
+
width?: number;
|
|
674
|
+
length?: number;
|
|
675
|
+
rear_width?: number;
|
|
676
|
+
road_width?: number;
|
|
677
|
+
floors?: number;
|
|
678
|
+
bedrooms?: number;
|
|
679
|
+
bathrooms?: number;
|
|
680
|
+
facing_direction?: string;
|
|
681
|
+
ownership_type?: string;
|
|
682
|
+
broker_fee_percent?: number;
|
|
683
|
+
construction_raw?: string;
|
|
684
|
+
legal_status?: string;
|
|
685
|
+
building_condition?: string;
|
|
686
|
+
furnishing_status?: string;
|
|
687
|
+
year_built?: number;
|
|
688
|
+
amenities?: Array<string>;
|
|
689
|
+
highlights?: Array<string>;
|
|
690
|
+
contact?: {
|
|
691
|
+
name?: string;
|
|
692
|
+
phone?: string;
|
|
693
|
+
role?: string;
|
|
694
|
+
};
|
|
695
|
+
images?: Array<string> | {
|
|
696
|
+
photos?: Array<string>;
|
|
697
|
+
legal?: Array<string>;
|
|
698
|
+
history?: Array<string>;
|
|
699
|
+
};
|
|
700
|
+
videos?: Array<string>;
|
|
701
|
+
notes?: string;
|
|
702
|
+
source?: {
|
|
703
|
+
platform?: string;
|
|
704
|
+
url?: string;
|
|
705
|
+
imported_at?: string;
|
|
706
|
+
external_id?: string;
|
|
707
|
+
external_code?: string;
|
|
708
|
+
phone_token?: string;
|
|
709
|
+
phone_masked?: string;
|
|
710
|
+
phone?: string;
|
|
711
|
+
phone_alt?: string;
|
|
712
|
+
lat?: number;
|
|
713
|
+
long?: number;
|
|
714
|
+
legacy?: boolean;
|
|
715
|
+
image_urls?: Array<string>;
|
|
716
|
+
legal_urls?: Array<string>;
|
|
717
|
+
price_history?: Array<{
|
|
718
|
+
[key: string]: unknown;
|
|
719
|
+
}>;
|
|
720
|
+
content_hash?: string;
|
|
721
|
+
[key: string]: unknown | string | number | boolean | Array<string> | Array<string> | Array<{
|
|
722
|
+
[key: string]: unknown;
|
|
723
|
+
}> | undefined;
|
|
724
|
+
};
|
|
725
|
+
brokerage_fee?: {
|
|
726
|
+
percentage?: number;
|
|
727
|
+
amount?: number;
|
|
728
|
+
paid_by?: string;
|
|
729
|
+
};
|
|
730
|
+
availability?: {
|
|
731
|
+
status?: string;
|
|
732
|
+
date?: string;
|
|
733
|
+
notes?: string;
|
|
734
|
+
};
|
|
735
|
+
seller_profile?: {
|
|
736
|
+
motivation?: string;
|
|
737
|
+
urgency?: string;
|
|
738
|
+
decision_maker?: string;
|
|
739
|
+
other_stakeholders?: Array<string>;
|
|
740
|
+
ownership_duration?: string;
|
|
741
|
+
};
|
|
742
|
+
price_negotiation?: {
|
|
743
|
+
listed_price?: number;
|
|
744
|
+
bottom_price?: number;
|
|
745
|
+
flexibility?: string;
|
|
746
|
+
price_history?: Array<{
|
|
747
|
+
date: string;
|
|
748
|
+
price: number;
|
|
749
|
+
reason?: string;
|
|
750
|
+
}>;
|
|
751
|
+
confidence?: number;
|
|
752
|
+
};
|
|
753
|
+
interactions?: Array<{
|
|
754
|
+
id: string;
|
|
755
|
+
date: string;
|
|
756
|
+
type: "call" | "meeting" | "message" | "site_visit" | "photo_session" | "contract_sign" | "note";
|
|
757
|
+
with_whom?: "owner" | "spouse" | "broker" | "family" | "other";
|
|
758
|
+
notes: string;
|
|
759
|
+
insights?: {
|
|
760
|
+
signals?: Array<string>;
|
|
761
|
+
concerns?: Array<string>;
|
|
762
|
+
price_hints?: Array<string>;
|
|
763
|
+
action_items?: Array<string>;
|
|
764
|
+
};
|
|
765
|
+
outcome?: "positive" | "neutral" | "negative";
|
|
766
|
+
}>;
|
|
767
|
+
viewings?: Array<{
|
|
768
|
+
id: string;
|
|
769
|
+
date: string;
|
|
770
|
+
client_id: string;
|
|
771
|
+
client_name: string;
|
|
772
|
+
attendees?: Array<string>;
|
|
773
|
+
duration_minutes?: number;
|
|
774
|
+
client_feedback?: {
|
|
775
|
+
interest_level?: "very_interested" | "interested" | "neutral" | "not_interested";
|
|
776
|
+
likes?: Array<string>;
|
|
777
|
+
dislikes?: Array<string>;
|
|
778
|
+
questions?: Array<string>;
|
|
779
|
+
objections?: Array<string>;
|
|
780
|
+
price_reaction?: "acceptable" | "high" | "very_high" | "will_negotiate";
|
|
781
|
+
};
|
|
782
|
+
follow_up?: {
|
|
783
|
+
status?: "pending" | "scheduled" | "done" | "no_interest";
|
|
784
|
+
next_action?: string;
|
|
785
|
+
next_date?: string;
|
|
786
|
+
};
|
|
787
|
+
}>;
|
|
788
|
+
interested_clients?: Array<{
|
|
789
|
+
client_id: string;
|
|
790
|
+
client_name: string;
|
|
791
|
+
interest_date: string;
|
|
792
|
+
status: string;
|
|
793
|
+
offered_price?: number;
|
|
794
|
+
rejection_reason?: string;
|
|
795
|
+
}>;
|
|
796
|
+
exclusivity?: {
|
|
797
|
+
type?: string;
|
|
798
|
+
start_date?: string;
|
|
799
|
+
end_date?: string;
|
|
800
|
+
commission_rate?: number;
|
|
801
|
+
other_brokers?: Array<string>;
|
|
802
|
+
};
|
|
803
|
+
[key: string]: unknown | "sale" | "rent" | string | number | Array<string> | Array<string> | {
|
|
804
|
+
name?: string;
|
|
805
|
+
phone?: string;
|
|
806
|
+
role?: string;
|
|
807
|
+
} | Array<string> | {
|
|
808
|
+
photos?: Array<string>;
|
|
809
|
+
legal?: Array<string>;
|
|
810
|
+
history?: Array<string>;
|
|
811
|
+
} | Array<string> | {
|
|
812
|
+
platform?: string;
|
|
813
|
+
url?: string;
|
|
814
|
+
imported_at?: string;
|
|
815
|
+
external_id?: string;
|
|
816
|
+
external_code?: string;
|
|
817
|
+
phone_token?: string;
|
|
818
|
+
phone_masked?: string;
|
|
819
|
+
phone?: string;
|
|
820
|
+
phone_alt?: string;
|
|
821
|
+
lat?: number;
|
|
822
|
+
long?: number;
|
|
823
|
+
legacy?: boolean;
|
|
824
|
+
image_urls?: Array<string>;
|
|
825
|
+
legal_urls?: Array<string>;
|
|
826
|
+
price_history?: Array<{
|
|
827
|
+
[key: string]: unknown;
|
|
828
|
+
}>;
|
|
829
|
+
content_hash?: string;
|
|
830
|
+
[key: string]: unknown | string | number | boolean | Array<string> | Array<string> | Array<{
|
|
831
|
+
[key: string]: unknown;
|
|
832
|
+
}> | undefined;
|
|
833
|
+
} | {
|
|
834
|
+
percentage?: number;
|
|
835
|
+
amount?: number;
|
|
836
|
+
paid_by?: string;
|
|
837
|
+
} | {
|
|
838
|
+
status?: string;
|
|
839
|
+
date?: string;
|
|
840
|
+
notes?: string;
|
|
841
|
+
} | {
|
|
842
|
+
motivation?: string;
|
|
843
|
+
urgency?: string;
|
|
844
|
+
decision_maker?: string;
|
|
845
|
+
other_stakeholders?: Array<string>;
|
|
846
|
+
ownership_duration?: string;
|
|
847
|
+
} | {
|
|
848
|
+
listed_price?: number;
|
|
849
|
+
bottom_price?: number;
|
|
850
|
+
flexibility?: string;
|
|
851
|
+
price_history?: Array<{
|
|
852
|
+
date: string;
|
|
853
|
+
price: number;
|
|
854
|
+
reason?: string;
|
|
855
|
+
}>;
|
|
856
|
+
confidence?: number;
|
|
857
|
+
} | Array<{
|
|
858
|
+
id: string;
|
|
859
|
+
date: string;
|
|
860
|
+
type: "call" | "meeting" | "message" | "site_visit" | "photo_session" | "contract_sign" | "note";
|
|
861
|
+
with_whom?: "owner" | "spouse" | "broker" | "family" | "other";
|
|
862
|
+
notes: string;
|
|
863
|
+
insights?: {
|
|
864
|
+
signals?: Array<string>;
|
|
865
|
+
concerns?: Array<string>;
|
|
866
|
+
price_hints?: Array<string>;
|
|
867
|
+
action_items?: Array<string>;
|
|
868
|
+
};
|
|
869
|
+
outcome?: "positive" | "neutral" | "negative";
|
|
870
|
+
}> | Array<{
|
|
871
|
+
id: string;
|
|
872
|
+
date: string;
|
|
873
|
+
client_id: string;
|
|
874
|
+
client_name: string;
|
|
875
|
+
attendees?: Array<string>;
|
|
876
|
+
duration_minutes?: number;
|
|
877
|
+
client_feedback?: {
|
|
878
|
+
interest_level?: "very_interested" | "interested" | "neutral" | "not_interested";
|
|
879
|
+
likes?: Array<string>;
|
|
880
|
+
dislikes?: Array<string>;
|
|
881
|
+
questions?: Array<string>;
|
|
882
|
+
objections?: Array<string>;
|
|
883
|
+
price_reaction?: "acceptable" | "high" | "very_high" | "will_negotiate";
|
|
884
|
+
};
|
|
885
|
+
follow_up?: {
|
|
886
|
+
status?: "pending" | "scheduled" | "done" | "no_interest";
|
|
887
|
+
next_action?: string;
|
|
888
|
+
next_date?: string;
|
|
889
|
+
};
|
|
890
|
+
}> | Array<{
|
|
891
|
+
client_id: string;
|
|
892
|
+
client_name: string;
|
|
893
|
+
interest_date: string;
|
|
894
|
+
status: string;
|
|
895
|
+
offered_price?: number;
|
|
896
|
+
rejection_reason?: string;
|
|
897
|
+
}> | {
|
|
898
|
+
type?: string;
|
|
899
|
+
start_date?: string;
|
|
900
|
+
end_date?: string;
|
|
901
|
+
commission_rate?: number;
|
|
902
|
+
other_brokers?: Array<string>;
|
|
903
|
+
} | undefined;
|
|
904
|
+
};
|
|
905
|
+
contacts?: Array<{
|
|
906
|
+
name?: string;
|
|
907
|
+
phone: string;
|
|
908
|
+
role?: "owner" | "broker" | "agent";
|
|
909
|
+
isPrimary?: boolean;
|
|
910
|
+
}>;
|
|
911
|
+
createdAt?: string;
|
|
912
|
+
updatedAt?: string;
|
|
913
|
+
createdBy?: string;
|
|
914
|
+
divisionId?: string;
|
|
915
|
+
oldDivisionId?: string;
|
|
916
|
+
provinceId?: string;
|
|
917
|
+
districtId?: string;
|
|
918
|
+
wardId?: string;
|
|
919
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsUpdateResponses, NbpListingsUpdateErrors, ThrowOnError, "fields">;
|
|
920
|
+
/**
|
|
921
|
+
* Update listing location
|
|
922
|
+
*
|
|
923
|
+
* Set the geographic coordinates for a listing's property
|
|
924
|
+
*/
|
|
925
|
+
updateLocation<ThrowOnError extends boolean = false>(parameters: {
|
|
926
|
+
id: string;
|
|
927
|
+
directory?: string;
|
|
928
|
+
lat?: number;
|
|
929
|
+
lon?: number;
|
|
930
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsUpdateLocationResponses, NbpListingsUpdateLocationErrors, ThrowOnError, "fields">;
|
|
931
|
+
/**
|
|
932
|
+
* Unmask listing phone
|
|
933
|
+
*
|
|
934
|
+
* Reveal + persist the real phone of a masked crawler-sourced listing (owner/admin).
|
|
935
|
+
*/
|
|
936
|
+
unmaskPhone<ThrowOnError extends boolean = false>(parameters: {
|
|
937
|
+
id: string;
|
|
938
|
+
directory?: string;
|
|
939
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsUnmaskPhoneResponses, NbpListingsUnmaskPhoneErrors, ThrowOnError, "fields">;
|
|
940
|
+
/**
|
|
941
|
+
* Add listing interaction
|
|
942
|
+
*
|
|
943
|
+
* Add an interaction log to a listing (seller-side timeline)
|
|
944
|
+
*/
|
|
945
|
+
addInteraction<ThrowOnError extends boolean = false>(parameters: {
|
|
946
|
+
id: string;
|
|
947
|
+
directory?: string;
|
|
948
|
+
date?: string;
|
|
949
|
+
type?: "call" | "meeting" | "message" | "site_visit" | "photo_session" | "contract_sign" | "note";
|
|
950
|
+
with_whom?: "owner" | "spouse" | "broker" | "family" | "other";
|
|
951
|
+
notes?: string;
|
|
952
|
+
outcome?: "positive" | "neutral" | "negative";
|
|
953
|
+
insights?: {
|
|
954
|
+
signals?: Array<string>;
|
|
955
|
+
concerns?: Array<string>;
|
|
956
|
+
price_hints?: Array<string>;
|
|
957
|
+
action_items?: Array<string>;
|
|
958
|
+
};
|
|
959
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsAddInteractionResponses, NbpListingsAddInteractionErrors, ThrowOnError, "fields">;
|
|
960
|
+
/**
|
|
961
|
+
* Execute SQL query
|
|
962
|
+
*
|
|
963
|
+
* Execute a raw SQL query on the listings database
|
|
964
|
+
*/
|
|
965
|
+
query<ThrowOnError extends boolean = false>(parameters?: {
|
|
966
|
+
directory?: string;
|
|
967
|
+
sql?: string;
|
|
968
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsQueryResponses, NbpListingsQueryErrors, ThrowOnError, "fields">;
|
|
969
|
+
/**
|
|
970
|
+
* Bulk upsert listings
|
|
971
|
+
*
|
|
972
|
+
* Idempotent batch insert/update of listings. Matches existing records by tags.source.external_id (default) or code. Server normalizes enum values, runs Properties.findOrCreate for dedup, and resolves divisions automatically. Max 500 records/call.
|
|
973
|
+
*/
|
|
974
|
+
bulkUpsert<ThrowOnError extends boolean = false>(parameters?: {
|
|
975
|
+
directory?: string;
|
|
976
|
+
records?: Array<{
|
|
977
|
+
[key: string]: unknown;
|
|
978
|
+
}>;
|
|
979
|
+
idempotency_key?: "external_id" | "code";
|
|
980
|
+
dry_run?: boolean;
|
|
981
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsBulkUpsertResponses, NbpListingsBulkUpsertErrors, ThrowOnError, "fields">;
|
|
982
|
+
/**
|
|
983
|
+
* Find matching clients for a listing
|
|
984
|
+
*
|
|
985
|
+
* Find clients whose budget matches the listing price
|
|
986
|
+
*/
|
|
987
|
+
matches<ThrowOnError extends boolean = false>(parameters: {
|
|
988
|
+
id: string;
|
|
989
|
+
directory?: string;
|
|
990
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsMatchesResponses, unknown, ThrowOnError, "fields">;
|
|
991
|
+
/**
|
|
992
|
+
* Export listings data as JSON
|
|
993
|
+
*
|
|
994
|
+
* Returns masked listing data + column definitions for client-side file generation. Owner/admin only.
|
|
995
|
+
*/
|
|
996
|
+
exportData<ThrowOnError extends boolean = false>(parameters?: {
|
|
997
|
+
directory?: string;
|
|
998
|
+
propertyId?: string;
|
|
999
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
1000
|
+
minPrice?: number;
|
|
1001
|
+
maxPrice?: number;
|
|
1002
|
+
ward?: string;
|
|
1003
|
+
provinceId?: string;
|
|
1004
|
+
districtId?: string;
|
|
1005
|
+
wardId?: string;
|
|
1006
|
+
category?: "sale" | "rent";
|
|
1007
|
+
property_type?: string;
|
|
1008
|
+
location_type?: string;
|
|
1009
|
+
legal_status?: string;
|
|
1010
|
+
building_condition?: string;
|
|
1011
|
+
furnishing_status?: string;
|
|
1012
|
+
facing_direction?: string;
|
|
1013
|
+
planning_status?: string;
|
|
1014
|
+
district?: string;
|
|
1015
|
+
street?: string;
|
|
1016
|
+
minArea?: number;
|
|
1017
|
+
maxArea?: number;
|
|
1018
|
+
bedrooms?: number;
|
|
1019
|
+
bathrooms?: number;
|
|
1020
|
+
floors?: number;
|
|
1021
|
+
minWidth?: number;
|
|
1022
|
+
maxWidth?: number;
|
|
1023
|
+
minLength?: number;
|
|
1024
|
+
maxLength?: number;
|
|
1025
|
+
createdBy?: string;
|
|
1026
|
+
updatedAt?: string;
|
|
1027
|
+
updatedWithinDays?: number;
|
|
1028
|
+
phone?: string;
|
|
1029
|
+
priceDirection?: "up" | "down";
|
|
1030
|
+
hasPhotos?: boolean;
|
|
1031
|
+
source?: "own" | "market" | "all";
|
|
1032
|
+
search?: string;
|
|
1033
|
+
sortBy?: "price" | "area" | "time_updated" | "time_created" | "code" | "bedrooms";
|
|
1034
|
+
sortDirection?: "asc" | "desc";
|
|
1035
|
+
limit?: number;
|
|
1036
|
+
offset?: number;
|
|
1037
|
+
bboxMinLat?: number;
|
|
1038
|
+
bboxMaxLat?: number;
|
|
1039
|
+
bboxMinLon?: number;
|
|
1040
|
+
bboxMaxLon?: number;
|
|
1041
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsExportDataResponses, NbpListingsExportDataErrors, ThrowOnError, "fields">;
|
|
1042
|
+
/**
|
|
1043
|
+
* Export listings to Excel
|
|
1044
|
+
*
|
|
1045
|
+
* Export listings matching filters to .xlsx file. Use mode=s3 for large datasets (returns presigned download URL).
|
|
1046
|
+
*/
|
|
1047
|
+
export<ThrowOnError extends boolean = false>(parameters?: {
|
|
1048
|
+
directory?: string;
|
|
1049
|
+
propertyId?: string;
|
|
1050
|
+
status?: "active" | "inactive" | "sold" | "rented";
|
|
1051
|
+
minPrice?: number;
|
|
1052
|
+
maxPrice?: number;
|
|
1053
|
+
ward?: string;
|
|
1054
|
+
provinceId?: string;
|
|
1055
|
+
districtId?: string;
|
|
1056
|
+
wardId?: string;
|
|
1057
|
+
category?: "sale" | "rent";
|
|
1058
|
+
property_type?: string;
|
|
1059
|
+
location_type?: string;
|
|
1060
|
+
legal_status?: string;
|
|
1061
|
+
building_condition?: string;
|
|
1062
|
+
furnishing_status?: string;
|
|
1063
|
+
facing_direction?: string;
|
|
1064
|
+
planning_status?: string;
|
|
1065
|
+
district?: string;
|
|
1066
|
+
street?: string;
|
|
1067
|
+
minArea?: number;
|
|
1068
|
+
maxArea?: number;
|
|
1069
|
+
bedrooms?: number;
|
|
1070
|
+
bathrooms?: number;
|
|
1071
|
+
floors?: number;
|
|
1072
|
+
minWidth?: number;
|
|
1073
|
+
maxWidth?: number;
|
|
1074
|
+
minLength?: number;
|
|
1075
|
+
maxLength?: number;
|
|
1076
|
+
createdBy?: string;
|
|
1077
|
+
updatedAt?: string;
|
|
1078
|
+
updatedWithinDays?: number;
|
|
1079
|
+
phone?: string;
|
|
1080
|
+
priceDirection?: "up" | "down";
|
|
1081
|
+
hasPhotos?: boolean;
|
|
1082
|
+
source?: "own" | "market" | "all";
|
|
1083
|
+
search?: string;
|
|
1084
|
+
sortBy?: "price" | "area" | "time_updated" | "time_created" | "code" | "bedrooms";
|
|
1085
|
+
sortDirection?: "asc" | "desc";
|
|
1086
|
+
limit?: number;
|
|
1087
|
+
offset?: number;
|
|
1088
|
+
bboxMinLat?: number;
|
|
1089
|
+
bboxMaxLat?: number;
|
|
1090
|
+
bboxMinLon?: number;
|
|
1091
|
+
bboxMaxLon?: number;
|
|
1092
|
+
mode?: "s3";
|
|
1093
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsExportResponses, NbpListingsExportErrors, ThrowOnError, "fields">;
|
|
1094
|
+
/**
|
|
1095
|
+
* Save custom listing tags
|
|
1096
|
+
*
|
|
1097
|
+
* Full replace custom listing tag definitions (admin only)
|
|
1098
|
+
*/
|
|
1099
|
+
save<ThrowOnError extends boolean = false>(parameters?: {
|
|
1100
|
+
directory?: string;
|
|
1101
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsListingsSaveResponses, NbpTagsListingsSaveErrors, ThrowOnError, "fields">;
|
|
1102
|
+
/**
|
|
1103
|
+
* Get default listing tags
|
|
1104
|
+
*
|
|
1105
|
+
* Get embedded default listing tag definitions
|
|
1106
|
+
*/
|
|
1107
|
+
defaults<ThrowOnError extends boolean = false>(parameters?: {
|
|
1108
|
+
directory?: string;
|
|
1109
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsListingsDefaultsResponses, unknown, ThrowOnError, "fields">;
|
|
1110
|
+
/**
|
|
1111
|
+
* Reset listing tags to defaults
|
|
1112
|
+
*
|
|
1113
|
+
* Remove custom listing tags, revert to embedded defaults (admin only)
|
|
1114
|
+
*/
|
|
1115
|
+
reset<ThrowOnError extends boolean = false>(parameters?: {
|
|
1116
|
+
directory?: string;
|
|
1117
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsListingsResetResponses, unknown, ThrowOnError, "fields">;
|
|
1118
|
+
/**
|
|
1119
|
+
* Get listing audit history
|
|
1120
|
+
*
|
|
1121
|
+
* Get audit trail for a specific listing
|
|
1122
|
+
*/
|
|
1123
|
+
history<ThrowOnError extends boolean = false>(parameters: {
|
|
1124
|
+
id: string;
|
|
1125
|
+
directory?: string;
|
|
1126
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpListingsHistoryResponses, unknown, ThrowOnError, "fields">;
|
|
1127
|
+
}
|
|
1128
|
+
export declare class Properties extends HeyApiClient {
|
|
1129
|
+
/**
|
|
1130
|
+
* List properties
|
|
1131
|
+
*
|
|
1132
|
+
* Get properties with optional filters
|
|
1133
|
+
*/
|
|
1134
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1135
|
+
directory?: string;
|
|
1136
|
+
ward?: string;
|
|
1137
|
+
district?: string;
|
|
1138
|
+
propertyType?: string;
|
|
1139
|
+
search?: string;
|
|
1140
|
+
limit?: number;
|
|
1141
|
+
offset?: number;
|
|
1142
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesListResponses, unknown, ThrowOnError, "fields">;
|
|
1143
|
+
/**
|
|
1144
|
+
* Create property
|
|
1145
|
+
*
|
|
1146
|
+
* Create a new property
|
|
1147
|
+
*/
|
|
1148
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
1149
|
+
directory?: string;
|
|
1150
|
+
propertyType?: string;
|
|
1151
|
+
district?: string;
|
|
1152
|
+
ward?: string;
|
|
1153
|
+
street?: string;
|
|
1154
|
+
houseNumber?: string;
|
|
1155
|
+
buildingName?: string;
|
|
1156
|
+
unitNumber?: string;
|
|
1157
|
+
lotNumber?: string;
|
|
1158
|
+
floorNumber?: number;
|
|
1159
|
+
roomNumber?: string;
|
|
1160
|
+
address?: string;
|
|
1161
|
+
tags?: {
|
|
1162
|
+
area?: number;
|
|
1163
|
+
width?: number;
|
|
1164
|
+
length?: number;
|
|
1165
|
+
rear_width?: number;
|
|
1166
|
+
floors?: number;
|
|
1167
|
+
bedrooms?: number;
|
|
1168
|
+
bathrooms?: number;
|
|
1169
|
+
facing_direction?: string;
|
|
1170
|
+
building_condition?: string;
|
|
1171
|
+
year_built?: number;
|
|
1172
|
+
location_type?: string;
|
|
1173
|
+
legal_status?: string;
|
|
1174
|
+
amenities?: Array<string>;
|
|
1175
|
+
highlights?: Array<string>;
|
|
1176
|
+
images?: Array<string>;
|
|
1177
|
+
videos?: Array<string>;
|
|
1178
|
+
garden_area?: number;
|
|
1179
|
+
planning_status?: string;
|
|
1180
|
+
road_width?: number;
|
|
1181
|
+
[key: string]: unknown | number | string | Array<string> | Array<string> | Array<string> | Array<string> | undefined;
|
|
1182
|
+
};
|
|
1183
|
+
divisionId?: string;
|
|
1184
|
+
oldDivisionId?: string;
|
|
1185
|
+
geom?: string;
|
|
1186
|
+
provinceId?: string;
|
|
1187
|
+
districtId?: string;
|
|
1188
|
+
wardId?: string;
|
|
1189
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesCreateResponses, NbpPropertiesCreateErrors, ThrowOnError, "fields">;
|
|
1190
|
+
/**
|
|
1191
|
+
* Delete property
|
|
1192
|
+
*
|
|
1193
|
+
* Delete a property
|
|
1194
|
+
*/
|
|
1195
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1196
|
+
id: string;
|
|
1197
|
+
directory?: string;
|
|
1198
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesDeleteResponses, NbpPropertiesDeleteErrors, ThrowOnError, "fields">;
|
|
1199
|
+
/**
|
|
1200
|
+
* Get property
|
|
1201
|
+
*
|
|
1202
|
+
* Get a single property by ID
|
|
1203
|
+
*/
|
|
1204
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1205
|
+
id: string;
|
|
1206
|
+
directory?: string;
|
|
1207
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesGetResponses, NbpPropertiesGetErrors, ThrowOnError, "fields">;
|
|
1208
|
+
/**
|
|
1209
|
+
* Update property
|
|
1210
|
+
*
|
|
1211
|
+
* Update an existing property
|
|
1212
|
+
*/
|
|
1213
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1214
|
+
id: string;
|
|
1215
|
+
directory?: string;
|
|
1216
|
+
propertyType?: string;
|
|
1217
|
+
district?: string;
|
|
1218
|
+
ward?: string;
|
|
1219
|
+
street?: string;
|
|
1220
|
+
houseNumber?: string;
|
|
1221
|
+
buildingName?: string;
|
|
1222
|
+
unitNumber?: string;
|
|
1223
|
+
lotNumber?: string;
|
|
1224
|
+
floorNumber?: number;
|
|
1225
|
+
roomNumber?: string;
|
|
1226
|
+
address?: string;
|
|
1227
|
+
tags?: {
|
|
1228
|
+
area?: number;
|
|
1229
|
+
width?: number;
|
|
1230
|
+
length?: number;
|
|
1231
|
+
rear_width?: number;
|
|
1232
|
+
floors?: number;
|
|
1233
|
+
bedrooms?: number;
|
|
1234
|
+
bathrooms?: number;
|
|
1235
|
+
facing_direction?: string;
|
|
1236
|
+
building_condition?: string;
|
|
1237
|
+
year_built?: number;
|
|
1238
|
+
location_type?: string;
|
|
1239
|
+
legal_status?: string;
|
|
1240
|
+
amenities?: Array<string>;
|
|
1241
|
+
highlights?: Array<string>;
|
|
1242
|
+
images?: Array<string>;
|
|
1243
|
+
videos?: Array<string>;
|
|
1244
|
+
garden_area?: number;
|
|
1245
|
+
planning_status?: string;
|
|
1246
|
+
road_width?: number;
|
|
1247
|
+
[key: string]: unknown | number | string | Array<string> | Array<string> | Array<string> | Array<string> | undefined;
|
|
1248
|
+
};
|
|
1249
|
+
divisionId?: string;
|
|
1250
|
+
oldDivisionId?: string;
|
|
1251
|
+
geom?: string;
|
|
1252
|
+
geomAccuracy?: string;
|
|
1253
|
+
provinceId?: string;
|
|
1254
|
+
districtId?: string;
|
|
1255
|
+
wardId?: string;
|
|
1256
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesUpdateResponses, NbpPropertiesUpdateErrors, ThrowOnError, "fields">;
|
|
1257
|
+
/**
|
|
1258
|
+
* Get listings for property
|
|
1259
|
+
*
|
|
1260
|
+
* Get all listings (transaction history) associated with a property
|
|
1261
|
+
*/
|
|
1262
|
+
listings<ThrowOnError extends boolean = false>(parameters: {
|
|
1263
|
+
id: string;
|
|
1264
|
+
directory?: string;
|
|
1265
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpPropertiesListingsResponses, NbpPropertiesListingsErrors, ThrowOnError, "fields">;
|
|
1266
|
+
listings2: Listings;
|
|
1267
|
+
}
|
|
1268
|
+
export declare class Search extends HeyApiClient {
|
|
1269
|
+
/**
|
|
1270
|
+
* Quick search for autocomplete
|
|
1271
|
+
*
|
|
1272
|
+
* Fast autocomplete search across listings and clients
|
|
1273
|
+
*/
|
|
1274
|
+
quick<ThrowOnError extends boolean = false>(parameters: {
|
|
1275
|
+
directory?: string;
|
|
1276
|
+
q: string;
|
|
1277
|
+
limit?: number;
|
|
1278
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpSearchQuickResponses, unknown, ThrowOnError, "fields">;
|
|
1279
|
+
/**
|
|
1280
|
+
* Search listings
|
|
1281
|
+
*
|
|
1282
|
+
* Search listings with filters
|
|
1283
|
+
*/
|
|
1284
|
+
listings<ThrowOnError extends boolean = false>(parameters?: {
|
|
1285
|
+
directory?: string;
|
|
1286
|
+
q?: string;
|
|
1287
|
+
category?: "sale" | "rent";
|
|
1288
|
+
minPrice?: number;
|
|
1289
|
+
maxPrice?: number;
|
|
1290
|
+
limit?: number;
|
|
1291
|
+
offset?: number;
|
|
1292
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpSearchListingsResponses, unknown, ThrowOnError, "fields">;
|
|
1293
|
+
/**
|
|
1294
|
+
* Search clients
|
|
1295
|
+
*
|
|
1296
|
+
* Search clients with filters
|
|
1297
|
+
*/
|
|
1298
|
+
clients<ThrowOnError extends boolean = false>(parameters?: {
|
|
1299
|
+
directory?: string;
|
|
1300
|
+
q?: string;
|
|
1301
|
+
readiness?: "cold" | "warm" | "hot";
|
|
1302
|
+
status?: "new" | "active" | "negotiating" | "closed_won" | "closed_lost" | "inactive";
|
|
1303
|
+
limit?: number;
|
|
1304
|
+
offset?: number;
|
|
1305
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpSearchClientsResponses, unknown, ThrowOnError, "fields">;
|
|
1306
|
+
/**
|
|
1307
|
+
* Global search
|
|
1308
|
+
*
|
|
1309
|
+
* Search across listings and clients
|
|
1310
|
+
*/
|
|
1311
|
+
global<ThrowOnError extends boolean = false>(parameters: {
|
|
1312
|
+
directory?: string;
|
|
1313
|
+
q: string;
|
|
1314
|
+
types?: string;
|
|
1315
|
+
limit?: number;
|
|
1316
|
+
offset?: number;
|
|
1317
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpSearchGlobalResponses, unknown, ThrowOnError, "fields">;
|
|
1318
|
+
}
|
|
1319
|
+
export declare class Clients extends HeyApiClient {
|
|
1320
|
+
/**
|
|
1321
|
+
* Find matching listings for a client
|
|
1322
|
+
*
|
|
1323
|
+
* Find listings whose price matches the client budget
|
|
1324
|
+
*/
|
|
1325
|
+
matches<ThrowOnError extends boolean = false>(parameters: {
|
|
1326
|
+
id: string;
|
|
1327
|
+
directory?: string;
|
|
1328
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsMatchesResponses, unknown, ThrowOnError, "fields">;
|
|
1329
|
+
/**
|
|
1330
|
+
* Get clients statistics
|
|
1331
|
+
*
|
|
1332
|
+
* Get aggregate statistics about clients
|
|
1333
|
+
*/
|
|
1334
|
+
stats<ThrowOnError extends boolean = false>(parameters?: {
|
|
1335
|
+
directory?: string;
|
|
1336
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsStatsResponses, unknown, ThrowOnError, "fields">;
|
|
1337
|
+
/**
|
|
1338
|
+
* Get hot clients
|
|
1339
|
+
*
|
|
1340
|
+
* Get clients with hot readiness level
|
|
1341
|
+
*/
|
|
1342
|
+
hot<ThrowOnError extends boolean = false>(parameters?: {
|
|
1343
|
+
directory?: string;
|
|
1344
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsHotResponses, unknown, ThrowOnError, "fields">;
|
|
1345
|
+
/**
|
|
1346
|
+
* Global interactions feed
|
|
1347
|
+
*
|
|
1348
|
+
* Every interaction across the owner's clients, newest first
|
|
1349
|
+
*/
|
|
1350
|
+
interactionsFeed<ThrowOnError extends boolean = false>(parameters?: {
|
|
1351
|
+
directory?: string;
|
|
1352
|
+
limit?: number;
|
|
1353
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsInteractionsFeedResponses, unknown, ThrowOnError, "fields">;
|
|
1354
|
+
/**
|
|
1355
|
+
* List clients
|
|
1356
|
+
*
|
|
1357
|
+
* Get clients with optional filters
|
|
1358
|
+
*/
|
|
1359
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1360
|
+
directory?: string;
|
|
1361
|
+
status?: "new" | "active" | "negotiating" | "closed_won" | "closed_lost" | "inactive";
|
|
1362
|
+
readiness?: "cold" | "warm" | "hot";
|
|
1363
|
+
type?: string;
|
|
1364
|
+
name?: string;
|
|
1365
|
+
phone?: string;
|
|
1366
|
+
source_channel?: string;
|
|
1367
|
+
referrer?: string;
|
|
1368
|
+
district?: string;
|
|
1369
|
+
relatedTo?: string;
|
|
1370
|
+
minBudget?: number;
|
|
1371
|
+
maxBudget?: number;
|
|
1372
|
+
search?: string;
|
|
1373
|
+
limit?: number;
|
|
1374
|
+
offset?: number;
|
|
1375
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsListResponses, unknown, ThrowOnError, "fields">;
|
|
1376
|
+
/**
|
|
1377
|
+
* Create client
|
|
1378
|
+
*
|
|
1379
|
+
* Create a new client
|
|
1380
|
+
*/
|
|
1381
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
1382
|
+
directory?: string;
|
|
1383
|
+
name?: string;
|
|
1384
|
+
phone?: string;
|
|
1385
|
+
type?: "buyer" | "seller" | "landlord" | "agent" | "other";
|
|
1386
|
+
contactId?: string;
|
|
1387
|
+
status?: "new" | "active" | "negotiating" | "closed_won" | "closed_lost" | "inactive";
|
|
1388
|
+
readiness?: "cold" | "warm" | "hot";
|
|
1389
|
+
tags?: {
|
|
1390
|
+
email?: string;
|
|
1391
|
+
age?: number;
|
|
1392
|
+
occupation?: string;
|
|
1393
|
+
source?: {
|
|
1394
|
+
channel?: string;
|
|
1395
|
+
campaign?: string;
|
|
1396
|
+
referrer?: string;
|
|
1397
|
+
first_contact?: string;
|
|
1398
|
+
first_message?: string;
|
|
1399
|
+
};
|
|
1400
|
+
budget?: {
|
|
1401
|
+
min: number;
|
|
1402
|
+
max: number;
|
|
1403
|
+
confidence?: number;
|
|
1404
|
+
notes?: string;
|
|
1405
|
+
};
|
|
1406
|
+
requirements?: Array<string>;
|
|
1407
|
+
preferences?: Array<string>;
|
|
1408
|
+
dealbreakers?: Array<string>;
|
|
1409
|
+
decision_process?: {
|
|
1410
|
+
main_contact?: string;
|
|
1411
|
+
decision_maker?: string;
|
|
1412
|
+
influencers?: Array<string>;
|
|
1413
|
+
};
|
|
1414
|
+
timeline?: {
|
|
1415
|
+
urgency?: "urgent" | "soon" | "flexible" | "exploring";
|
|
1416
|
+
deadline?: string;
|
|
1417
|
+
notes?: string;
|
|
1418
|
+
};
|
|
1419
|
+
notes?: string;
|
|
1420
|
+
interactions?: Array<{
|
|
1421
|
+
id: string;
|
|
1422
|
+
date: string;
|
|
1423
|
+
type: "call" | "meeting" | "message" | "email" | "viewing" | "note";
|
|
1424
|
+
notes: string;
|
|
1425
|
+
summary?: string;
|
|
1426
|
+
insights?: {
|
|
1427
|
+
signals?: Array<string>;
|
|
1428
|
+
objections?: Array<string>;
|
|
1429
|
+
action_items?: Array<string>;
|
|
1430
|
+
};
|
|
1431
|
+
listing_codes?: Array<string>;
|
|
1432
|
+
}>;
|
|
1433
|
+
[key: string]: unknown | string | number | {
|
|
1434
|
+
channel?: string;
|
|
1435
|
+
campaign?: string;
|
|
1436
|
+
referrer?: string;
|
|
1437
|
+
first_contact?: string;
|
|
1438
|
+
first_message?: string;
|
|
1439
|
+
} | {
|
|
1440
|
+
min: number;
|
|
1441
|
+
max: number;
|
|
1442
|
+
confidence?: number;
|
|
1443
|
+
notes?: string;
|
|
1444
|
+
} | Array<string> | Array<string> | Array<string> | {
|
|
1445
|
+
main_contact?: string;
|
|
1446
|
+
decision_maker?: string;
|
|
1447
|
+
influencers?: Array<string>;
|
|
1448
|
+
} | {
|
|
1449
|
+
urgency?: "urgent" | "soon" | "flexible" | "exploring";
|
|
1450
|
+
deadline?: string;
|
|
1451
|
+
notes?: string;
|
|
1452
|
+
} | Array<{
|
|
1453
|
+
id: string;
|
|
1454
|
+
date: string;
|
|
1455
|
+
type: "call" | "meeting" | "message" | "email" | "viewing" | "note";
|
|
1456
|
+
notes: string;
|
|
1457
|
+
summary?: string;
|
|
1458
|
+
insights?: {
|
|
1459
|
+
signals?: Array<string>;
|
|
1460
|
+
objections?: Array<string>;
|
|
1461
|
+
action_items?: Array<string>;
|
|
1462
|
+
};
|
|
1463
|
+
listing_codes?: Array<string>;
|
|
1464
|
+
}> | undefined;
|
|
1465
|
+
};
|
|
1466
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsCreateResponses, NbpClientsCreateErrors, ThrowOnError, "fields">;
|
|
1467
|
+
/**
|
|
1468
|
+
* Delete client
|
|
1469
|
+
*
|
|
1470
|
+
* Delete a client
|
|
1471
|
+
*/
|
|
1472
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1473
|
+
id: string;
|
|
1474
|
+
directory?: string;
|
|
1475
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsDeleteResponses, NbpClientsDeleteErrors, ThrowOnError, "fields">;
|
|
1476
|
+
/**
|
|
1477
|
+
* Get client
|
|
1478
|
+
*
|
|
1479
|
+
* Get a single client by ID
|
|
1480
|
+
*/
|
|
1481
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1482
|
+
id: string;
|
|
1483
|
+
directory?: string;
|
|
1484
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsGetResponses, NbpClientsGetErrors, ThrowOnError, "fields">;
|
|
1485
|
+
/**
|
|
1486
|
+
* Update client
|
|
1487
|
+
*
|
|
1488
|
+
* Update an existing client
|
|
1489
|
+
*/
|
|
1490
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1491
|
+
id: string;
|
|
1492
|
+
directory?: string;
|
|
1493
|
+
name?: string;
|
|
1494
|
+
phone?: string;
|
|
1495
|
+
type?: "buyer" | "seller" | "landlord" | "agent" | "other";
|
|
1496
|
+
contactId?: string;
|
|
1497
|
+
status?: "new" | "active" | "negotiating" | "closed_won" | "closed_lost" | "inactive";
|
|
1498
|
+
readiness?: "cold" | "warm" | "hot";
|
|
1499
|
+
tags?: {
|
|
1500
|
+
email?: string;
|
|
1501
|
+
age?: number;
|
|
1502
|
+
occupation?: string;
|
|
1503
|
+
source?: {
|
|
1504
|
+
channel?: string;
|
|
1505
|
+
campaign?: string;
|
|
1506
|
+
referrer?: string;
|
|
1507
|
+
first_contact?: string;
|
|
1508
|
+
first_message?: string;
|
|
1509
|
+
};
|
|
1510
|
+
budget?: {
|
|
1511
|
+
min: number;
|
|
1512
|
+
max: number;
|
|
1513
|
+
confidence?: number;
|
|
1514
|
+
notes?: string;
|
|
1515
|
+
};
|
|
1516
|
+
requirements?: Array<string>;
|
|
1517
|
+
preferences?: Array<string>;
|
|
1518
|
+
dealbreakers?: Array<string>;
|
|
1519
|
+
decision_process?: {
|
|
1520
|
+
main_contact?: string;
|
|
1521
|
+
decision_maker?: string;
|
|
1522
|
+
influencers?: Array<string>;
|
|
1523
|
+
};
|
|
1524
|
+
timeline?: {
|
|
1525
|
+
urgency?: "urgent" | "soon" | "flexible" | "exploring";
|
|
1526
|
+
deadline?: string;
|
|
1527
|
+
notes?: string;
|
|
1528
|
+
};
|
|
1529
|
+
notes?: string;
|
|
1530
|
+
interactions?: Array<{
|
|
1531
|
+
id: string;
|
|
1532
|
+
date: string;
|
|
1533
|
+
type: "call" | "meeting" | "message" | "email" | "viewing" | "note";
|
|
1534
|
+
notes: string;
|
|
1535
|
+
summary?: string;
|
|
1536
|
+
insights?: {
|
|
1537
|
+
signals?: Array<string>;
|
|
1538
|
+
objections?: Array<string>;
|
|
1539
|
+
action_items?: Array<string>;
|
|
1540
|
+
};
|
|
1541
|
+
listing_codes?: Array<string>;
|
|
1542
|
+
}>;
|
|
1543
|
+
[key: string]: unknown | string | number | {
|
|
1544
|
+
channel?: string;
|
|
1545
|
+
campaign?: string;
|
|
1546
|
+
referrer?: string;
|
|
1547
|
+
first_contact?: string;
|
|
1548
|
+
first_message?: string;
|
|
1549
|
+
} | {
|
|
1550
|
+
min: number;
|
|
1551
|
+
max: number;
|
|
1552
|
+
confidence?: number;
|
|
1553
|
+
notes?: string;
|
|
1554
|
+
} | Array<string> | Array<string> | Array<string> | {
|
|
1555
|
+
main_contact?: string;
|
|
1556
|
+
decision_maker?: string;
|
|
1557
|
+
influencers?: Array<string>;
|
|
1558
|
+
} | {
|
|
1559
|
+
urgency?: "urgent" | "soon" | "flexible" | "exploring";
|
|
1560
|
+
deadline?: string;
|
|
1561
|
+
notes?: string;
|
|
1562
|
+
} | Array<{
|
|
1563
|
+
id: string;
|
|
1564
|
+
date: string;
|
|
1565
|
+
type: "call" | "meeting" | "message" | "email" | "viewing" | "note";
|
|
1566
|
+
notes: string;
|
|
1567
|
+
summary?: string;
|
|
1568
|
+
insights?: {
|
|
1569
|
+
signals?: Array<string>;
|
|
1570
|
+
objections?: Array<string>;
|
|
1571
|
+
action_items?: Array<string>;
|
|
1572
|
+
};
|
|
1573
|
+
listing_codes?: Array<string>;
|
|
1574
|
+
}> | undefined;
|
|
1575
|
+
};
|
|
1576
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsUpdateResponses, NbpClientsUpdateErrors, ThrowOnError, "fields">;
|
|
1577
|
+
/**
|
|
1578
|
+
* Add client interaction
|
|
1579
|
+
*
|
|
1580
|
+
* Add an interaction log to a client
|
|
1581
|
+
*/
|
|
1582
|
+
addInteraction<ThrowOnError extends boolean = false>(parameters: {
|
|
1583
|
+
id: string;
|
|
1584
|
+
directory?: string;
|
|
1585
|
+
date?: string;
|
|
1586
|
+
type?: "call" | "meeting" | "email" | "message" | "viewing" | "note";
|
|
1587
|
+
notes?: string;
|
|
1588
|
+
summary?: string;
|
|
1589
|
+
insights?: {
|
|
1590
|
+
signals?: Array<string>;
|
|
1591
|
+
objections?: Array<string>;
|
|
1592
|
+
action_items?: Array<string>;
|
|
1593
|
+
};
|
|
1594
|
+
listing_codes?: Array<string>;
|
|
1595
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsAddInteractionResponses, NbpClientsAddInteractionErrors, ThrowOnError, "fields">;
|
|
1596
|
+
/**
|
|
1597
|
+
* Export clients to Excel
|
|
1598
|
+
*
|
|
1599
|
+
* Export clients matching filters to .xlsx file
|
|
1600
|
+
*/
|
|
1601
|
+
export<ThrowOnError extends boolean = false>(parameters?: {
|
|
1602
|
+
directory?: string;
|
|
1603
|
+
status?: "new" | "active" | "negotiating" | "closed_won" | "closed_lost" | "inactive";
|
|
1604
|
+
readiness?: "cold" | "warm" | "hot";
|
|
1605
|
+
type?: string;
|
|
1606
|
+
name?: string;
|
|
1607
|
+
phone?: string;
|
|
1608
|
+
source_channel?: string;
|
|
1609
|
+
referrer?: string;
|
|
1610
|
+
district?: string;
|
|
1611
|
+
relatedTo?: string;
|
|
1612
|
+
minBudget?: number;
|
|
1613
|
+
maxBudget?: number;
|
|
1614
|
+
search?: string;
|
|
1615
|
+
limit?: number;
|
|
1616
|
+
offset?: number;
|
|
1617
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsExportResponses, NbpClientsExportErrors, ThrowOnError, "fields">;
|
|
1618
|
+
/**
|
|
1619
|
+
* Save custom client tags
|
|
1620
|
+
*
|
|
1621
|
+
* Full replace custom client tag definitions (admin only)
|
|
1622
|
+
*/
|
|
1623
|
+
save<ThrowOnError extends boolean = false>(parameters?: {
|
|
1624
|
+
directory?: string;
|
|
1625
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsClientsSaveResponses, NbpTagsClientsSaveErrors, ThrowOnError, "fields">;
|
|
1626
|
+
/**
|
|
1627
|
+
* Get default client tags
|
|
1628
|
+
*
|
|
1629
|
+
* Get embedded default client tag definitions
|
|
1630
|
+
*/
|
|
1631
|
+
defaults<ThrowOnError extends boolean = false>(parameters?: {
|
|
1632
|
+
directory?: string;
|
|
1633
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsClientsDefaultsResponses, unknown, ThrowOnError, "fields">;
|
|
1634
|
+
/**
|
|
1635
|
+
* Reset client tags to defaults
|
|
1636
|
+
*
|
|
1637
|
+
* Remove custom client tags, revert to embedded defaults (admin only)
|
|
1638
|
+
*/
|
|
1639
|
+
reset<ThrowOnError extends boolean = false>(parameters?: {
|
|
1640
|
+
directory?: string;
|
|
1641
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsClientsResetResponses, unknown, ThrowOnError, "fields">;
|
|
1642
|
+
/**
|
|
1643
|
+
* Get client audit history
|
|
1644
|
+
*
|
|
1645
|
+
* Get audit trail for a specific client
|
|
1646
|
+
*/
|
|
1647
|
+
history<ThrowOnError extends boolean = false>(parameters: {
|
|
1648
|
+
id: string;
|
|
1649
|
+
directory?: string;
|
|
1650
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientsHistoryResponses, unknown, ThrowOnError, "fields">;
|
|
1651
|
+
}
|
|
1652
|
+
export declare class Tasks extends HeyApiClient {
|
|
1653
|
+
/**
|
|
1654
|
+
* Tasks due today + overdue
|
|
1655
|
+
*/
|
|
1656
|
+
today<ThrowOnError extends boolean = false>(parameters?: {
|
|
1657
|
+
directory?: string;
|
|
1658
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksTodayResponses, unknown, ThrowOnError, "fields">;
|
|
1659
|
+
/**
|
|
1660
|
+
* List tasks
|
|
1661
|
+
*/
|
|
1662
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1663
|
+
directory?: string;
|
|
1664
|
+
status?: "open" | "done" | "snoozed";
|
|
1665
|
+
clientId?: string;
|
|
1666
|
+
listingId?: string;
|
|
1667
|
+
limit?: number;
|
|
1668
|
+
offset?: number;
|
|
1669
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksListResponses, unknown, ThrowOnError, "fields">;
|
|
1670
|
+
/**
|
|
1671
|
+
* Create task
|
|
1672
|
+
*/
|
|
1673
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
1674
|
+
directory?: string;
|
|
1675
|
+
type?: "call" | "meeting" | "viewing" | "followup" | "other";
|
|
1676
|
+
title?: string;
|
|
1677
|
+
dueAt?: string | null;
|
|
1678
|
+
status?: "open" | "done" | "snoozed";
|
|
1679
|
+
note?: string;
|
|
1680
|
+
clientId?: string | null;
|
|
1681
|
+
listingId?: string | null;
|
|
1682
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksCreateResponses, unknown, ThrowOnError, "fields">;
|
|
1683
|
+
/**
|
|
1684
|
+
* Delete task
|
|
1685
|
+
*/
|
|
1686
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1687
|
+
id: string;
|
|
1688
|
+
directory?: string;
|
|
1689
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
1690
|
+
/**
|
|
1691
|
+
* Get task
|
|
1692
|
+
*/
|
|
1693
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1694
|
+
id: string;
|
|
1695
|
+
directory?: string;
|
|
1696
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksGetResponses, NbpTasksGetErrors, ThrowOnError, "fields">;
|
|
1697
|
+
/**
|
|
1698
|
+
* Update task
|
|
1699
|
+
*/
|
|
1700
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1701
|
+
id: string;
|
|
1702
|
+
directory?: string;
|
|
1703
|
+
type?: "call" | "meeting" | "viewing" | "followup" | "other";
|
|
1704
|
+
title?: string;
|
|
1705
|
+
dueAt?: string | null;
|
|
1706
|
+
status?: "open" | "done" | "snoozed";
|
|
1707
|
+
note?: string;
|
|
1708
|
+
clientId?: string | null;
|
|
1709
|
+
listingId?: string | null;
|
|
1710
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTasksUpdateResponses, NbpTasksUpdateErrors, ThrowOnError, "fields">;
|
|
1711
|
+
}
|
|
1712
|
+
export declare class ClientRelations extends HeyApiClient {
|
|
1713
|
+
/**
|
|
1714
|
+
* List a client's relationships
|
|
1715
|
+
*/
|
|
1716
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
1717
|
+
id: string;
|
|
1718
|
+
directory?: string;
|
|
1719
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientRelationsListResponses, unknown, ThrowOnError, "fields">;
|
|
1720
|
+
/**
|
|
1721
|
+
* Add a client relationship
|
|
1722
|
+
*/
|
|
1723
|
+
create<ThrowOnError extends boolean = false>(parameters: {
|
|
1724
|
+
id: string;
|
|
1725
|
+
directory?: string;
|
|
1726
|
+
clientB?: string;
|
|
1727
|
+
type?: "spouse" | "family" | "colleague" | "referrer" | "partner" | "other";
|
|
1728
|
+
note?: string | null;
|
|
1729
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientRelationsCreateResponses, unknown, ThrowOnError, "fields">;
|
|
1730
|
+
/**
|
|
1731
|
+
* Delete a client relationship
|
|
1732
|
+
*/
|
|
1733
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1734
|
+
id: string;
|
|
1735
|
+
directory?: string;
|
|
1736
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpClientRelationsDeleteResponses, unknown, ThrowOnError, "fields">;
|
|
1737
|
+
}
|
|
1738
|
+
export declare class Contacts extends HeyApiClient {
|
|
1739
|
+
/**
|
|
1740
|
+
* Listings for a contact phone (360°)
|
|
1741
|
+
*/
|
|
1742
|
+
listings<ThrowOnError extends boolean = false>(parameters: {
|
|
1743
|
+
directory?: string;
|
|
1744
|
+
phone: string;
|
|
1745
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpContactsListingsResponses, unknown, ThrowOnError, "fields">;
|
|
1746
|
+
/**
|
|
1747
|
+
* All phones of a person
|
|
1748
|
+
*/
|
|
1749
|
+
phones<ThrowOnError extends boolean = false>(parameters: {
|
|
1750
|
+
directory?: string;
|
|
1751
|
+
phone: string;
|
|
1752
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpContactsPhonesResponses, unknown, ThrowOnError, "fields">;
|
|
1753
|
+
/**
|
|
1754
|
+
* Link an alternate phone to a person
|
|
1755
|
+
*/
|
|
1756
|
+
phoneLink<ThrowOnError extends boolean = false>(parameters?: {
|
|
1757
|
+
directory?: string;
|
|
1758
|
+
anchorPhone?: string;
|
|
1759
|
+
addPhone?: string;
|
|
1760
|
+
name?: string;
|
|
1761
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpContactsPhoneLinkResponses, unknown, ThrowOnError, "fields">;
|
|
1762
|
+
/**
|
|
1763
|
+
* Detach a phone from its person
|
|
1764
|
+
*/
|
|
1765
|
+
phoneUnlink<ThrowOnError extends boolean = false>(parameters?: {
|
|
1766
|
+
directory?: string;
|
|
1767
|
+
phone?: string;
|
|
1768
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpContactsPhoneUnlinkResponses, unknown, ThrowOnError, "fields">;
|
|
1769
|
+
}
|
|
1770
|
+
export declare class Tags extends HeyApiClient {
|
|
1771
|
+
/**
|
|
1772
|
+
* Get listing tags
|
|
1773
|
+
*
|
|
1774
|
+
* Get listing tag definitions (custom or defaults)
|
|
1775
|
+
*/
|
|
1776
|
+
listings<ThrowOnError extends boolean = false>(parameters?: {
|
|
1777
|
+
directory?: string;
|
|
1778
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsListingsResponses, unknown, ThrowOnError, "fields">;
|
|
1779
|
+
/**
|
|
1780
|
+
* Get client tags
|
|
1781
|
+
*
|
|
1782
|
+
* Get client tag definitions (custom or defaults)
|
|
1783
|
+
*/
|
|
1784
|
+
clients<ThrowOnError extends boolean = false>(parameters?: {
|
|
1785
|
+
directory?: string;
|
|
1786
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpTagsClientsResponses, unknown, ThrowOnError, "fields">;
|
|
1787
|
+
listings2: Listings;
|
|
1788
|
+
clients2: Clients;
|
|
1789
|
+
}
|
|
1790
|
+
export declare class Views extends HeyApiClient {
|
|
1791
|
+
/**
|
|
1792
|
+
* Get resolved view config
|
|
1793
|
+
*
|
|
1794
|
+
* Get view config with 3-level resolution: personal > workspace > embedded default
|
|
1795
|
+
*/
|
|
1796
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1797
|
+
entityType: string;
|
|
1798
|
+
directory?: string;
|
|
1799
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpViewsGetResponses, NbpViewsGetErrors, ThrowOnError, "fields">;
|
|
1800
|
+
/**
|
|
1801
|
+
* Save personal view override
|
|
1802
|
+
*
|
|
1803
|
+
* Save personal view configuration (overrides workspace default)
|
|
1804
|
+
*/
|
|
1805
|
+
savePersonal<ThrowOnError extends boolean = false>(parameters: {
|
|
1806
|
+
entityType: string;
|
|
1807
|
+
directory?: string;
|
|
1808
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpViewsSavePersonalResponses, NbpViewsSavePersonalErrors, ThrowOnError, "fields">;
|
|
1809
|
+
/**
|
|
1810
|
+
* Save workspace view default
|
|
1811
|
+
*
|
|
1812
|
+
* Save workspace-level default view configuration (admin only)
|
|
1813
|
+
*/
|
|
1814
|
+
saveWorkspace<ThrowOnError extends boolean = false>(parameters: {
|
|
1815
|
+
entityType: string;
|
|
1816
|
+
directory?: string;
|
|
1817
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpViewsSaveWorkspaceResponses, NbpViewsSaveWorkspaceErrors, ThrowOnError, "fields">;
|
|
1818
|
+
/**
|
|
1819
|
+
* Reset personal view to workspace/default
|
|
1820
|
+
*
|
|
1821
|
+
* Remove personal view override, falling back to workspace default or embedded
|
|
1822
|
+
*/
|
|
1823
|
+
resetPersonal<ThrowOnError extends boolean = false>(parameters: {
|
|
1824
|
+
entityType: string;
|
|
1825
|
+
directory?: string;
|
|
1826
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpViewsResetPersonalResponses, NbpViewsResetPersonalErrors, ThrowOnError, "fields">;
|
|
1827
|
+
}
|
|
1828
|
+
export declare class Divisions extends HeyApiClient {
|
|
1829
|
+
/**
|
|
1830
|
+
* List divisions
|
|
1831
|
+
*
|
|
1832
|
+
* List Vietnamese administrative divisions (provinces, districts, wards) with optional parent filter
|
|
1833
|
+
*/
|
|
1834
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
1835
|
+
directory?: string;
|
|
1836
|
+
type: "province" | "district" | "ward";
|
|
1837
|
+
parentId?: string;
|
|
1838
|
+
version?: "old" | "new";
|
|
1839
|
+
active?: "true" | "false" | "all";
|
|
1840
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpDivisionsListResponses, unknown, ThrowOnError, "fields">;
|
|
1841
|
+
}
|
|
1842
|
+
export declare class Danger extends HeyApiClient {
|
|
1843
|
+
/**
|
|
1844
|
+
* Request purge confirmation
|
|
1845
|
+
*
|
|
1846
|
+
* Request a confirmation token to purge all listings and properties. Owner only. Token expires in 5 minutes.
|
|
1847
|
+
*/
|
|
1848
|
+
purgeRequest<ThrowOnError extends boolean = false>(parameters?: {
|
|
1849
|
+
directory?: string;
|
|
1850
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpDangerPurgeRequestResponses, unknown, ThrowOnError, "fields">;
|
|
1851
|
+
/**
|
|
1852
|
+
* Confirm and execute purge
|
|
1853
|
+
*
|
|
1854
|
+
* Execute purge of all listings and properties. Requires valid confirmation token and exact workspace slug.
|
|
1855
|
+
*/
|
|
1856
|
+
purgeConfirm<ThrowOnError extends boolean = false>(parameters?: {
|
|
1857
|
+
directory?: string;
|
|
1858
|
+
confirmationToken?: string;
|
|
1859
|
+
workspaceSlug?: string;
|
|
1860
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<NbpDangerPurgeConfirmResponses, NbpDangerPurgeConfirmErrors, ThrowOnError, "fields">;
|
|
1861
|
+
}
|
|
1862
|
+
export declare class Nbp extends HeyApiClient {
|
|
1863
|
+
listings: Listings;
|
|
1864
|
+
properties: Properties;
|
|
1865
|
+
search: Search;
|
|
1866
|
+
clients: Clients;
|
|
1867
|
+
tasks: Tasks;
|
|
1868
|
+
clientRelations: ClientRelations;
|
|
1869
|
+
contacts: Contacts;
|
|
1870
|
+
tags: Tags;
|
|
1871
|
+
views: Views;
|
|
1872
|
+
divisions: Divisions;
|
|
1873
|
+
danger: Danger;
|
|
1874
|
+
}
|
|
1875
|
+
export declare class Agent extends HeyApiClient {
|
|
1876
|
+
/**
|
|
1877
|
+
* List agents
|
|
1878
|
+
*
|
|
1879
|
+
* Get a list of all available AI agents in the NBP system.
|
|
1880
|
+
*/
|
|
1881
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1882
|
+
directory?: string;
|
|
1883
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AgentListResponses, unknown, ThrowOnError, "fields">;
|
|
1884
|
+
/**
|
|
1885
|
+
* Get cloud agent statistics
|
|
1886
|
+
*
|
|
1887
|
+
* Get statistics about active cloud AI sessions.
|
|
1888
|
+
*/
|
|
1889
|
+
stats<ThrowOnError extends boolean = false>(parameters?: {
|
|
1890
|
+
directory?: string;
|
|
1891
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AgentStatsResponses, AgentStatsErrors, ThrowOnError, "fields">;
|
|
1892
|
+
}
|
|
1893
|
+
export declare class Pty extends HeyApiClient {
|
|
1894
|
+
/**
|
|
1895
|
+
* List PTY sessions
|
|
1896
|
+
*
|
|
1897
|
+
* Get a list of all active pseudo-terminal (PTY) sessions managed by NBP.
|
|
1898
|
+
*/
|
|
1899
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1900
|
+
directory?: string;
|
|
1901
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyListResponses, unknown, ThrowOnError, "fields">;
|
|
1902
|
+
/**
|
|
1903
|
+
* Create PTY session
|
|
1904
|
+
*
|
|
1905
|
+
* Create a new pseudo-terminal (PTY) session for running shell commands and processes.
|
|
1906
|
+
*/
|
|
1907
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
1908
|
+
directory?: string;
|
|
1909
|
+
command?: string;
|
|
1910
|
+
args?: Array<string>;
|
|
1911
|
+
cwd?: string;
|
|
1912
|
+
title?: string;
|
|
1913
|
+
env?: {
|
|
1914
|
+
[key: string]: string;
|
|
1915
|
+
};
|
|
1916
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError, "fields">;
|
|
1917
|
+
/**
|
|
1918
|
+
* Remove PTY session
|
|
1919
|
+
*
|
|
1920
|
+
* Remove and terminate a specific pseudo-terminal (PTY) session.
|
|
1921
|
+
*/
|
|
1922
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
1923
|
+
ptyID: string;
|
|
1924
|
+
directory?: string;
|
|
1925
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError, "fields">;
|
|
1926
|
+
/**
|
|
1927
|
+
* Get PTY session
|
|
1928
|
+
*
|
|
1929
|
+
* Retrieve detailed information about a specific pseudo-terminal (PTY) session.
|
|
1930
|
+
*/
|
|
1931
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
1932
|
+
ptyID: string;
|
|
1933
|
+
directory?: string;
|
|
1934
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyGetResponses, PtyGetErrors, ThrowOnError, "fields">;
|
|
1935
|
+
/**
|
|
1936
|
+
* Update PTY session
|
|
1937
|
+
*
|
|
1938
|
+
* Update properties of an existing pseudo-terminal (PTY) session.
|
|
1939
|
+
*/
|
|
1940
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1941
|
+
ptyID: string;
|
|
1942
|
+
directory?: string;
|
|
1943
|
+
title?: string;
|
|
1944
|
+
size?: {
|
|
1945
|
+
rows: number;
|
|
1946
|
+
cols: number;
|
|
1947
|
+
};
|
|
1948
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError, "fields">;
|
|
1949
|
+
/**
|
|
1950
|
+
* Connect to PTY session
|
|
1951
|
+
*
|
|
1952
|
+
* Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
|
|
1953
|
+
*/
|
|
1954
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
1955
|
+
ptyID: string;
|
|
1956
|
+
directory?: string;
|
|
1957
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyConnectResponses, PtyConnectErrors, ThrowOnError, "fields">;
|
|
1958
|
+
}
|
|
1959
|
+
export declare class Config extends HeyApiClient {
|
|
1960
|
+
/**
|
|
1961
|
+
* Get configuration
|
|
1962
|
+
*
|
|
1963
|
+
* Retrieve the current NBP configuration settings and preferences.
|
|
1964
|
+
*/
|
|
1965
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
1966
|
+
directory?: string;
|
|
1967
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigGetResponses, unknown, ThrowOnError, "fields">;
|
|
1968
|
+
/**
|
|
1969
|
+
* Update configuration
|
|
1970
|
+
*
|
|
1971
|
+
* Update NBP configuration settings and preferences.
|
|
1972
|
+
*/
|
|
1973
|
+
update<ThrowOnError extends boolean = false>(parameters?: {
|
|
1974
|
+
directory?: string;
|
|
1975
|
+
config?: Config2;
|
|
1976
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError, "fields">;
|
|
1977
|
+
/**
|
|
1978
|
+
* List config providers
|
|
1979
|
+
*
|
|
1980
|
+
* Get a list of all configured AI providers and their default models.
|
|
1981
|
+
*/
|
|
1982
|
+
providers<ThrowOnError extends boolean = false>(parameters?: {
|
|
1983
|
+
directory?: string;
|
|
1984
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigProvidersResponses, unknown, ThrowOnError, "fields">;
|
|
1985
|
+
}
|
|
1986
|
+
export declare class Tool extends HeyApiClient {
|
|
1987
|
+
/**
|
|
1988
|
+
* List tool IDs
|
|
1989
|
+
*
|
|
1990
|
+
* Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
|
|
1991
|
+
*/
|
|
1992
|
+
ids<ThrowOnError extends boolean = false>(parameters?: {
|
|
1993
|
+
directory?: string;
|
|
1994
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolIdsResponses, ToolIdsErrors, ThrowOnError, "fields">;
|
|
1995
|
+
/**
|
|
1996
|
+
* List tools
|
|
1997
|
+
*
|
|
1998
|
+
* Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
|
|
1999
|
+
*/
|
|
2000
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2001
|
+
directory?: string;
|
|
2002
|
+
provider: string;
|
|
2003
|
+
model: string;
|
|
2004
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolListResponses, ToolListErrors, ThrowOnError, "fields">;
|
|
2005
|
+
}
|
|
2006
|
+
export declare class Instance extends HeyApiClient {
|
|
2007
|
+
/**
|
|
2008
|
+
* Dispose instance
|
|
2009
|
+
*
|
|
2010
|
+
* Clean up and dispose the current NBP instance, releasing all resources.
|
|
2011
|
+
*/
|
|
2012
|
+
dispose<ThrowOnError extends boolean = false>(parameters?: {
|
|
2013
|
+
directory?: string;
|
|
2014
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InstanceDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
2015
|
+
}
|
|
2016
|
+
export declare class Path extends HeyApiClient {
|
|
2017
|
+
/**
|
|
2018
|
+
* Get paths
|
|
2019
|
+
*
|
|
2020
|
+
* Retrieve the current working directory and related path information for the NBP instance.
|
|
2021
|
+
*/
|
|
2022
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
2023
|
+
directory?: string;
|
|
2024
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PathGetResponses, unknown, ThrowOnError, "fields">;
|
|
2025
|
+
}
|
|
2026
|
+
export declare class Worktree extends HeyApiClient {
|
|
2027
|
+
/**
|
|
2028
|
+
* List worktrees
|
|
2029
|
+
*
|
|
2030
|
+
* List all sandbox worktrees for the current project.
|
|
2031
|
+
*/
|
|
2032
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2033
|
+
directory?: string;
|
|
2034
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeListResponses, unknown, ThrowOnError, "fields">;
|
|
2035
|
+
/**
|
|
2036
|
+
* Create worktree
|
|
2037
|
+
*
|
|
2038
|
+
* Create a new git worktree for the current project.
|
|
2039
|
+
*/
|
|
2040
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
2041
|
+
directory?: string;
|
|
2042
|
+
name?: string;
|
|
2043
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeCreateResponses, WorktreeCreateErrors, ThrowOnError, "fields">;
|
|
2044
|
+
}
|
|
2045
|
+
export declare class Vcs extends HeyApiClient {
|
|
2046
|
+
/**
|
|
2047
|
+
* Get VCS info
|
|
2048
|
+
*
|
|
2049
|
+
* Retrieve version control system (VCS) information for the current project, such as git branch.
|
|
2050
|
+
*/
|
|
2051
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
2052
|
+
directory?: string;
|
|
2053
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsGetResponses, unknown, ThrowOnError, "fields">;
|
|
2054
|
+
}
|
|
2055
|
+
export declare class Session extends HeyApiClient {
|
|
2056
|
+
/**
|
|
2057
|
+
* Get AI usage
|
|
2058
|
+
*
|
|
2059
|
+
* Get current AI token and session usage with tier limits.
|
|
2060
|
+
*/
|
|
2061
|
+
usage<ThrowOnError extends boolean = false>(parameters?: {
|
|
2062
|
+
directory?: string;
|
|
2063
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUsageResponses, unknown, ThrowOnError, "fields">;
|
|
2064
|
+
/**
|
|
2065
|
+
* List sessions
|
|
2066
|
+
*
|
|
2067
|
+
* Get a list of all NBP sessions, sorted by most recently updated.
|
|
2068
|
+
*/
|
|
2069
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2070
|
+
directory?: string;
|
|
2071
|
+
start?: number;
|
|
2072
|
+
search?: string;
|
|
2073
|
+
limit?: number;
|
|
2074
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionListResponses, unknown, ThrowOnError, "fields">;
|
|
2075
|
+
/**
|
|
2076
|
+
* Create session
|
|
2077
|
+
*
|
|
2078
|
+
* Create a new NBP session for interacting with AI assistants and managing conversations.
|
|
2079
|
+
*/
|
|
2080
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
2081
|
+
directory?: string;
|
|
2082
|
+
parentID?: string;
|
|
2083
|
+
title?: string;
|
|
2084
|
+
permission?: PermissionRuleset;
|
|
2085
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError, "fields">;
|
|
2086
|
+
/**
|
|
2087
|
+
* Get session status
|
|
2088
|
+
*
|
|
2089
|
+
* Retrieve the current status of all sessions, including active, idle, and completed states.
|
|
2090
|
+
*/
|
|
2091
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
2092
|
+
directory?: string;
|
|
2093
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionStatusResponses, SessionStatusErrors, ThrowOnError, "fields">;
|
|
2094
|
+
/**
|
|
2095
|
+
* Delete session
|
|
2096
|
+
*
|
|
2097
|
+
* Delete a session and permanently remove all associated data, including messages and history.
|
|
2098
|
+
*/
|
|
2099
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
2100
|
+
sessionID: string;
|
|
2101
|
+
directory?: string;
|
|
2102
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError, "fields">;
|
|
2103
|
+
/**
|
|
2104
|
+
* Get session
|
|
2105
|
+
*
|
|
2106
|
+
* Retrieve detailed information about a specific NBP session.
|
|
2107
|
+
*/
|
|
2108
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
2109
|
+
sessionID: string;
|
|
2110
|
+
directory?: string;
|
|
2111
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionGetResponses, SessionGetErrors, ThrowOnError, "fields">;
|
|
2112
|
+
/**
|
|
2113
|
+
* Update session
|
|
2114
|
+
*
|
|
2115
|
+
* Update properties of an existing session, such as title or other metadata.
|
|
2116
|
+
*/
|
|
2117
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2118
|
+
sessionID: string;
|
|
2119
|
+
directory?: string;
|
|
2120
|
+
title?: string;
|
|
2121
|
+
time?: {
|
|
2122
|
+
archived?: number;
|
|
2123
|
+
};
|
|
2124
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError, "fields">;
|
|
2125
|
+
/**
|
|
2126
|
+
* Get session children
|
|
2127
|
+
*
|
|
2128
|
+
* Retrieve all child sessions that were forked from the specified parent session.
|
|
2129
|
+
*/
|
|
2130
|
+
children<ThrowOnError extends boolean = false>(parameters: {
|
|
2131
|
+
sessionID: string;
|
|
2132
|
+
directory?: string;
|
|
2133
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError, "fields">;
|
|
2134
|
+
/**
|
|
2135
|
+
* Get session todos
|
|
2136
|
+
*
|
|
2137
|
+
* Retrieve the todo list associated with a specific session, showing tasks and action items.
|
|
2138
|
+
*/
|
|
2139
|
+
todo<ThrowOnError extends boolean = false>(parameters: {
|
|
2140
|
+
sessionID: string;
|
|
2141
|
+
directory?: string;
|
|
2142
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionTodoResponses, SessionTodoErrors, ThrowOnError, "fields">;
|
|
2143
|
+
/**
|
|
2144
|
+
* Initialize session
|
|
2145
|
+
*
|
|
2146
|
+
* Analyze the current application and create an AGENTS.md file with project-specific agent configurations.
|
|
2147
|
+
*/
|
|
2148
|
+
init<ThrowOnError extends boolean = false>(parameters: {
|
|
2149
|
+
sessionID: string;
|
|
2150
|
+
directory?: string;
|
|
2151
|
+
modelID?: string;
|
|
2152
|
+
providerID?: string;
|
|
2153
|
+
messageID?: string;
|
|
2154
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionInitResponses, SessionInitErrors, ThrowOnError, "fields">;
|
|
2155
|
+
/**
|
|
2156
|
+
* Fork session
|
|
2157
|
+
*
|
|
2158
|
+
* Create a new session by forking an existing session at a specific message point.
|
|
2159
|
+
*/
|
|
2160
|
+
fork<ThrowOnError extends boolean = false>(parameters: {
|
|
2161
|
+
sessionID: string;
|
|
2162
|
+
directory?: string;
|
|
2163
|
+
messageID?: string;
|
|
2164
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionForkResponses, unknown, ThrowOnError, "fields">;
|
|
2165
|
+
/**
|
|
2166
|
+
* Abort session
|
|
2167
|
+
*
|
|
2168
|
+
* Abort an active session and stop any ongoing AI processing or command execution.
|
|
2169
|
+
*/
|
|
2170
|
+
abort<ThrowOnError extends boolean = false>(parameters: {
|
|
2171
|
+
sessionID: string;
|
|
2172
|
+
directory?: string;
|
|
2173
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionAbortResponses, SessionAbortErrors, ThrowOnError, "fields">;
|
|
2174
|
+
/**
|
|
2175
|
+
* Unshare session
|
|
2176
|
+
*
|
|
2177
|
+
* Remove the shareable link for a session, making it private again.
|
|
2178
|
+
*/
|
|
2179
|
+
unshare<ThrowOnError extends boolean = false>(parameters: {
|
|
2180
|
+
sessionID: string;
|
|
2181
|
+
directory?: string;
|
|
2182
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError, "fields">;
|
|
2183
|
+
/**
|
|
2184
|
+
* Share session
|
|
2185
|
+
*
|
|
2186
|
+
* Create a shareable link for a session, allowing others to view the conversation.
|
|
2187
|
+
*/
|
|
2188
|
+
share<ThrowOnError extends boolean = false>(parameters: {
|
|
2189
|
+
sessionID: string;
|
|
2190
|
+
directory?: string;
|
|
2191
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShareResponses, SessionShareErrors, ThrowOnError, "fields">;
|
|
2192
|
+
/**
|
|
2193
|
+
* Get message diff
|
|
2194
|
+
*
|
|
2195
|
+
* Get the file changes (diff) that resulted from a specific user message in the session.
|
|
2196
|
+
*/
|
|
2197
|
+
diff<ThrowOnError extends boolean = false>(parameters: {
|
|
2198
|
+
sessionID: string;
|
|
2199
|
+
directory?: string;
|
|
2200
|
+
messageID?: string;
|
|
2201
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDiffResponses, unknown, ThrowOnError, "fields">;
|
|
2202
|
+
/**
|
|
2203
|
+
* Summarize session
|
|
2204
|
+
*
|
|
2205
|
+
* Generate a concise summary of the session using AI compaction to preserve key information.
|
|
2206
|
+
*/
|
|
2207
|
+
summarize<ThrowOnError extends boolean = false>(parameters: {
|
|
2208
|
+
sessionID: string;
|
|
2209
|
+
directory?: string;
|
|
2210
|
+
providerID?: string;
|
|
2211
|
+
modelID?: string;
|
|
2212
|
+
auto?: boolean;
|
|
2213
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError, "fields">;
|
|
2214
|
+
/**
|
|
2215
|
+
* Get session messages
|
|
2216
|
+
*
|
|
2217
|
+
* Retrieve all messages in a session, including user prompts and AI responses.
|
|
2218
|
+
*/
|
|
2219
|
+
messages<ThrowOnError extends boolean = false>(parameters: {
|
|
2220
|
+
sessionID: string;
|
|
2221
|
+
directory?: string;
|
|
2222
|
+
limit?: number;
|
|
2223
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessagesResponses, SessionMessagesErrors, ThrowOnError, "fields">;
|
|
2224
|
+
/**
|
|
2225
|
+
* Send message
|
|
2226
|
+
*
|
|
2227
|
+
* Create and send a new message to a session, streaming the AI response.
|
|
2228
|
+
*/
|
|
2229
|
+
prompt<ThrowOnError extends boolean = false>(parameters: {
|
|
2230
|
+
sessionID: string;
|
|
2231
|
+
directory?: string;
|
|
2232
|
+
messageID?: string;
|
|
2233
|
+
model?: {
|
|
2234
|
+
providerID: string;
|
|
2235
|
+
modelID: string;
|
|
2236
|
+
};
|
|
2237
|
+
agent?: string;
|
|
2238
|
+
noReply?: boolean;
|
|
2239
|
+
tools?: {
|
|
2240
|
+
[key: string]: boolean;
|
|
2241
|
+
};
|
|
2242
|
+
system?: string;
|
|
2243
|
+
variant?: string;
|
|
2244
|
+
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput | EntityPartInput>;
|
|
2245
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptResponses, SessionPromptErrors, ThrowOnError, "fields">;
|
|
2246
|
+
/**
|
|
2247
|
+
* Get message
|
|
2248
|
+
*
|
|
2249
|
+
* Retrieve a specific message from a session by its message ID.
|
|
2250
|
+
*/
|
|
2251
|
+
message<ThrowOnError extends boolean = false>(parameters: {
|
|
2252
|
+
sessionID: string;
|
|
2253
|
+
messageID: string;
|
|
2254
|
+
directory?: string;
|
|
2255
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessageResponses, SessionMessageErrors, ThrowOnError, "fields">;
|
|
2256
|
+
/**
|
|
2257
|
+
* Send async message
|
|
2258
|
+
*
|
|
2259
|
+
* Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.
|
|
2260
|
+
*/
|
|
2261
|
+
promptAsync<ThrowOnError extends boolean = false>(parameters: {
|
|
2262
|
+
sessionID: string;
|
|
2263
|
+
directory?: string;
|
|
2264
|
+
messageID?: string;
|
|
2265
|
+
model?: {
|
|
2266
|
+
providerID: string;
|
|
2267
|
+
modelID: string;
|
|
2268
|
+
};
|
|
2269
|
+
agent?: string;
|
|
2270
|
+
noReply?: boolean;
|
|
2271
|
+
tools?: {
|
|
2272
|
+
[key: string]: boolean;
|
|
2273
|
+
};
|
|
2274
|
+
system?: string;
|
|
2275
|
+
variant?: string;
|
|
2276
|
+
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput | EntityPartInput>;
|
|
2277
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptAsyncResponses, SessionPromptAsyncErrors, ThrowOnError, "fields">;
|
|
2278
|
+
/**
|
|
2279
|
+
* Send command
|
|
2280
|
+
*
|
|
2281
|
+
* Send a new command to a session for execution by the AI assistant.
|
|
2282
|
+
*/
|
|
2283
|
+
command<ThrowOnError extends boolean = false>(parameters: {
|
|
2284
|
+
sessionID: string;
|
|
2285
|
+
directory?: string;
|
|
2286
|
+
messageID?: string;
|
|
2287
|
+
agent?: string;
|
|
2288
|
+
model?: string;
|
|
2289
|
+
arguments?: string;
|
|
2290
|
+
command?: string;
|
|
2291
|
+
variant?: string;
|
|
2292
|
+
parts?: Array<{
|
|
2293
|
+
id?: string;
|
|
2294
|
+
type: "file";
|
|
2295
|
+
mime: string;
|
|
2296
|
+
filename?: string;
|
|
2297
|
+
url: string;
|
|
2298
|
+
source?: FilePartSource;
|
|
2299
|
+
}>;
|
|
2300
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCommandResponses, SessionCommandErrors, ThrowOnError, "fields">;
|
|
2301
|
+
/**
|
|
2302
|
+
* Run shell command
|
|
2303
|
+
*
|
|
2304
|
+
* Execute a shell command within the session context and return the AI's response.
|
|
2305
|
+
*/
|
|
2306
|
+
shell<ThrowOnError extends boolean = false>(parameters: {
|
|
2307
|
+
sessionID: string;
|
|
2308
|
+
directory?: string;
|
|
2309
|
+
agent?: string;
|
|
2310
|
+
model?: {
|
|
2311
|
+
providerID: string;
|
|
2312
|
+
modelID: string;
|
|
2313
|
+
};
|
|
2314
|
+
command?: string;
|
|
2315
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShellResponses, SessionShellErrors, ThrowOnError, "fields">;
|
|
2316
|
+
/**
|
|
2317
|
+
* Revert message
|
|
2318
|
+
*
|
|
2319
|
+
* Revert a specific message in a session, undoing its effects and restoring the previous state.
|
|
2320
|
+
*/
|
|
2321
|
+
revert<ThrowOnError extends boolean = false>(parameters: {
|
|
2322
|
+
sessionID: string;
|
|
2323
|
+
directory?: string;
|
|
2324
|
+
messageID?: string;
|
|
2325
|
+
partID?: string;
|
|
2326
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError, "fields">;
|
|
2327
|
+
/**
|
|
2328
|
+
* Restore reverted messages
|
|
2329
|
+
*
|
|
2330
|
+
* Restore all previously reverted messages in a session.
|
|
2331
|
+
*/
|
|
2332
|
+
unrevert<ThrowOnError extends boolean = false>(parameters: {
|
|
2333
|
+
sessionID: string;
|
|
2334
|
+
directory?: string;
|
|
2335
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError, "fields">;
|
|
2336
|
+
}
|
|
2337
|
+
export declare class Part extends HeyApiClient {
|
|
2338
|
+
/**
|
|
2339
|
+
* Delete a part from a message
|
|
2340
|
+
*/
|
|
2341
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
2342
|
+
sessionID: string;
|
|
2343
|
+
messageID: string;
|
|
2344
|
+
partID: string;
|
|
2345
|
+
directory?: string;
|
|
2346
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartDeleteResponses, PartDeleteErrors, ThrowOnError, "fields">;
|
|
2347
|
+
/**
|
|
2348
|
+
* Update a part in a message
|
|
2349
|
+
*/
|
|
2350
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
2351
|
+
sessionID: string;
|
|
2352
|
+
messageID: string;
|
|
2353
|
+
partID: string;
|
|
2354
|
+
directory?: string;
|
|
2355
|
+
part?: Part2;
|
|
2356
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartUpdateResponses, PartUpdateErrors, ThrowOnError, "fields">;
|
|
2357
|
+
}
|
|
2358
|
+
export declare class Permission extends HeyApiClient {
|
|
2359
|
+
/**
|
|
2360
|
+
* Respond to permission
|
|
2361
|
+
*
|
|
2362
|
+
* Approve or deny a permission request from the AI assistant.
|
|
2363
|
+
*
|
|
2364
|
+
* @deprecated
|
|
2365
|
+
*/
|
|
2366
|
+
respond<ThrowOnError extends boolean = false>(parameters: {
|
|
2367
|
+
sessionID: string;
|
|
2368
|
+
permissionID: string;
|
|
2369
|
+
directory?: string;
|
|
2370
|
+
response?: "once" | "always" | "reject";
|
|
2371
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError, "fields">;
|
|
2372
|
+
/**
|
|
2373
|
+
* Respond to permission request
|
|
2374
|
+
*
|
|
2375
|
+
* Approve or deny a permission request from the AI assistant.
|
|
2376
|
+
*/
|
|
2377
|
+
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
2378
|
+
requestID: string;
|
|
2379
|
+
directory?: string;
|
|
2380
|
+
reply?: "once" | "always" | "reject";
|
|
2381
|
+
message?: string;
|
|
2382
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionReplyResponses, PermissionReplyErrors, ThrowOnError, "fields">;
|
|
2383
|
+
/**
|
|
2384
|
+
* List pending permissions
|
|
2385
|
+
*
|
|
2386
|
+
* Get all pending permission requests across all sessions.
|
|
2387
|
+
*/
|
|
2388
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2389
|
+
directory?: string;
|
|
2390
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionListResponses, unknown, ThrowOnError, "fields">;
|
|
2391
|
+
}
|
|
2392
|
+
export declare class Question extends HeyApiClient {
|
|
2393
|
+
/**
|
|
2394
|
+
* List pending questions
|
|
2395
|
+
*
|
|
2396
|
+
* Get all pending question requests across all sessions.
|
|
2397
|
+
*/
|
|
2398
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2399
|
+
directory?: string;
|
|
2400
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionListResponses, unknown, ThrowOnError, "fields">;
|
|
2401
|
+
/**
|
|
2402
|
+
* Reply to question request
|
|
2403
|
+
*
|
|
2404
|
+
* Provide answers to a question request from the AI assistant.
|
|
2405
|
+
*/
|
|
2406
|
+
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
2407
|
+
requestID: string;
|
|
2408
|
+
directory?: string;
|
|
2409
|
+
answers?: Array<QuestionAnswer>;
|
|
2410
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionReplyResponses, QuestionReplyErrors, ThrowOnError, "fields">;
|
|
2411
|
+
/**
|
|
2412
|
+
* Reject question request
|
|
2413
|
+
*
|
|
2414
|
+
* Reject a question request from the AI assistant.
|
|
2415
|
+
*/
|
|
2416
|
+
reject<ThrowOnError extends boolean = false>(parameters: {
|
|
2417
|
+
requestID: string;
|
|
2418
|
+
directory?: string;
|
|
2419
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionRejectResponses, QuestionRejectErrors, ThrowOnError, "fields">;
|
|
2420
|
+
}
|
|
2421
|
+
export declare class Command extends HeyApiClient {
|
|
2422
|
+
/**
|
|
2423
|
+
* List commands
|
|
2424
|
+
*
|
|
2425
|
+
* Get a list of all available commands in the NBP system.
|
|
2426
|
+
*/
|
|
2427
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2428
|
+
directory?: string;
|
|
2429
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<CommandListResponses, unknown, ThrowOnError, "fields">;
|
|
2430
|
+
}
|
|
2431
|
+
export declare class Oauth extends HeyApiClient {
|
|
2432
|
+
/**
|
|
2433
|
+
* OAuth authorize
|
|
2434
|
+
*
|
|
2435
|
+
* Initiate OAuth authorization for a specific AI provider to get an authorization URL.
|
|
2436
|
+
*/
|
|
2437
|
+
authorize<ThrowOnError extends boolean = false>(parameters: {
|
|
2438
|
+
providerID: string;
|
|
2439
|
+
directory?: string;
|
|
2440
|
+
method?: number;
|
|
2441
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthAuthorizeResponses, unknown, ThrowOnError, "fields">;
|
|
2442
|
+
/**
|
|
2443
|
+
* OAuth callback
|
|
2444
|
+
*
|
|
2445
|
+
* Handle the OAuth callback from a provider after user authorization.
|
|
2446
|
+
*/
|
|
2447
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
2448
|
+
providerID: string;
|
|
2449
|
+
directory?: string;
|
|
2450
|
+
method?: number;
|
|
2451
|
+
code?: string;
|
|
2452
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthCallbackResponses, unknown, ThrowOnError, "fields">;
|
|
2453
|
+
}
|
|
2454
|
+
export declare class Provider extends HeyApiClient {
|
|
2455
|
+
/**
|
|
2456
|
+
* List providers
|
|
2457
|
+
*
|
|
2458
|
+
* Get a list of all available AI providers, including both available and connected ones.
|
|
2459
|
+
*/
|
|
2460
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2461
|
+
directory?: string;
|
|
2462
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderListResponses, unknown, ThrowOnError, "fields">;
|
|
2463
|
+
/**
|
|
2464
|
+
* Get provider auth methods
|
|
2465
|
+
*
|
|
2466
|
+
* Retrieve available authentication methods for all AI providers.
|
|
2467
|
+
*/
|
|
2468
|
+
auth<ThrowOnError extends boolean = false>(parameters?: {
|
|
2469
|
+
directory?: string;
|
|
2470
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderAuthResponses, unknown, ThrowOnError, "fields">;
|
|
2471
|
+
oauth: Oauth;
|
|
2472
|
+
}
|
|
2473
|
+
export declare class Find extends HeyApiClient {
|
|
2474
|
+
/**
|
|
2475
|
+
* Find text
|
|
2476
|
+
*
|
|
2477
|
+
* Search for text patterns across files in the project using ripgrep.
|
|
2478
|
+
*/
|
|
2479
|
+
text<ThrowOnError extends boolean = false>(parameters: {
|
|
2480
|
+
directory?: string;
|
|
2481
|
+
pattern: string;
|
|
2482
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindTextResponses, unknown, ThrowOnError, "fields">;
|
|
2483
|
+
/**
|
|
2484
|
+
* Find files
|
|
2485
|
+
*
|
|
2486
|
+
* Search for files or directories by name or pattern in the project directory.
|
|
2487
|
+
*/
|
|
2488
|
+
files<ThrowOnError extends boolean = false>(parameters: {
|
|
2489
|
+
directory?: string;
|
|
2490
|
+
query: string;
|
|
2491
|
+
dirs?: "true" | "false";
|
|
2492
|
+
type?: "file" | "directory";
|
|
2493
|
+
limit?: number;
|
|
2494
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindFilesResponses, unknown, ThrowOnError, "fields">;
|
|
2495
|
+
/**
|
|
2496
|
+
* Find symbols
|
|
2497
|
+
*
|
|
2498
|
+
* Search for workspace symbols like functions, classes, and variables using LSP.
|
|
2499
|
+
*/
|
|
2500
|
+
symbols<ThrowOnError extends boolean = false>(parameters: {
|
|
2501
|
+
directory?: string;
|
|
2502
|
+
query: string;
|
|
2503
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindSymbolsResponses, unknown, ThrowOnError, "fields">;
|
|
2504
|
+
}
|
|
2505
|
+
export declare class File extends HeyApiClient {
|
|
2506
|
+
/**
|
|
2507
|
+
* List files
|
|
2508
|
+
*
|
|
2509
|
+
* List files and directories in a specified path.
|
|
2510
|
+
*/
|
|
2511
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
2512
|
+
directory?: string;
|
|
2513
|
+
path: string;
|
|
2514
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileListResponses, unknown, ThrowOnError, "fields">;
|
|
2515
|
+
/**
|
|
2516
|
+
* Read file
|
|
2517
|
+
*
|
|
2518
|
+
* Read the content of a specified file.
|
|
2519
|
+
*/
|
|
2520
|
+
read<ThrowOnError extends boolean = false>(parameters: {
|
|
2521
|
+
directory?: string;
|
|
2522
|
+
path: string;
|
|
2523
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReadResponses, unknown, ThrowOnError, "fields">;
|
|
2524
|
+
/**
|
|
2525
|
+
* Get file status
|
|
2526
|
+
*
|
|
2527
|
+
* Get the git status of all files in the project.
|
|
2528
|
+
*/
|
|
2529
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
2530
|
+
directory?: string;
|
|
2531
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileStatusResponses, unknown, ThrowOnError, "fields">;
|
|
2532
|
+
}
|
|
2533
|
+
export declare class App extends HeyApiClient {
|
|
2534
|
+
/**
|
|
2535
|
+
* Write log
|
|
2536
|
+
*
|
|
2537
|
+
* Write a log entry to the server logs with specified level and metadata.
|
|
2538
|
+
*/
|
|
2539
|
+
log<ThrowOnError extends boolean = false>(parameters?: {
|
|
2540
|
+
directory?: string;
|
|
2541
|
+
service?: string;
|
|
2542
|
+
level?: "debug" | "info" | "error" | "warn";
|
|
2543
|
+
message?: string;
|
|
2544
|
+
extra?: {
|
|
2545
|
+
[key: string]: unknown;
|
|
2546
|
+
};
|
|
2547
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AppLogResponses, AppLogErrors, ThrowOnError, "fields">;
|
|
2548
|
+
}
|
|
2549
|
+
export declare class Auth extends HeyApiClient {
|
|
2550
|
+
/**
|
|
2551
|
+
* Remove MCP OAuth
|
|
2552
|
+
*
|
|
2553
|
+
* Remove OAuth credentials for an MCP server
|
|
2554
|
+
*/
|
|
2555
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
2556
|
+
name: string;
|
|
2557
|
+
directory?: string;
|
|
2558
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError, "fields">;
|
|
2559
|
+
/**
|
|
2560
|
+
* Start MCP OAuth
|
|
2561
|
+
*
|
|
2562
|
+
* Start OAuth authentication flow for a Model Context Protocol (MCP) server.
|
|
2563
|
+
*/
|
|
2564
|
+
start<ThrowOnError extends boolean = false>(parameters: {
|
|
2565
|
+
name: string;
|
|
2566
|
+
directory?: string;
|
|
2567
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError, "fields">;
|
|
2568
|
+
/**
|
|
2569
|
+
* Complete MCP OAuth
|
|
2570
|
+
*
|
|
2571
|
+
* Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
|
|
2572
|
+
*/
|
|
2573
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
2574
|
+
name: string;
|
|
2575
|
+
directory?: string;
|
|
2576
|
+
code?: string;
|
|
2577
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError, "fields">;
|
|
2578
|
+
/**
|
|
2579
|
+
* Authenticate MCP OAuth
|
|
2580
|
+
*
|
|
2581
|
+
* Start OAuth flow and wait for callback (opens browser)
|
|
2582
|
+
*/
|
|
2583
|
+
authenticate<ThrowOnError extends boolean = false>(parameters: {
|
|
2584
|
+
name: string;
|
|
2585
|
+
directory?: string;
|
|
2586
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError, "fields">;
|
|
2587
|
+
/**
|
|
2588
|
+
* Set auth credentials
|
|
2589
|
+
*
|
|
2590
|
+
* Set authentication credentials
|
|
2591
|
+
*/
|
|
2592
|
+
set<ThrowOnError extends boolean = false>(parameters: {
|
|
2593
|
+
providerID: string;
|
|
2594
|
+
directory?: string;
|
|
2595
|
+
auth?: Auth2;
|
|
2596
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AuthSetResponses, AuthSetErrors, ThrowOnError, "fields">;
|
|
2597
|
+
}
|
|
2598
|
+
export declare class Mcp extends HeyApiClient {
|
|
2599
|
+
/**
|
|
2600
|
+
* Get MCP status
|
|
2601
|
+
*
|
|
2602
|
+
* Get the status of all Model Context Protocol (MCP) servers.
|
|
2603
|
+
*/
|
|
2604
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
2605
|
+
directory?: string;
|
|
2606
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpStatusResponses, unknown, ThrowOnError, "fields">;
|
|
2607
|
+
/**
|
|
2608
|
+
* Add MCP server
|
|
2609
|
+
*
|
|
2610
|
+
* Dynamically add a new Model Context Protocol (MCP) server to the system.
|
|
2611
|
+
*/
|
|
2612
|
+
add<ThrowOnError extends boolean = false>(parameters?: {
|
|
2613
|
+
directory?: string;
|
|
2614
|
+
name?: string;
|
|
2615
|
+
config?: McpLocalConfig | McpRemoteConfig;
|
|
2616
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAddResponses, McpAddErrors, ThrowOnError, "fields">;
|
|
2617
|
+
/**
|
|
2618
|
+
* Connect an MCP server
|
|
2619
|
+
*/
|
|
2620
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
2621
|
+
name: string;
|
|
2622
|
+
directory?: string;
|
|
2623
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpConnectResponses, unknown, ThrowOnError, "fields">;
|
|
2624
|
+
/**
|
|
2625
|
+
* Disconnect an MCP server
|
|
2626
|
+
*/
|
|
2627
|
+
disconnect<ThrowOnError extends boolean = false>(parameters: {
|
|
2628
|
+
name: string;
|
|
2629
|
+
directory?: string;
|
|
2630
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpDisconnectResponses, unknown, ThrowOnError, "fields">;
|
|
2631
|
+
auth: Auth;
|
|
2632
|
+
}
|
|
2633
|
+
export declare class Resource extends HeyApiClient {
|
|
2634
|
+
/**
|
|
2635
|
+
* Get MCP resources
|
|
2636
|
+
*
|
|
2637
|
+
* Get all available MCP resources from connected servers. Optionally filter by name.
|
|
2638
|
+
*/
|
|
2639
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
2640
|
+
directory?: string;
|
|
2641
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalResourceListResponses, unknown, ThrowOnError, "fields">;
|
|
2642
|
+
}
|
|
2643
|
+
export declare class Experimental extends HeyApiClient {
|
|
2644
|
+
resource: Resource;
|
|
2645
|
+
}
|
|
2646
|
+
export declare class Lsp extends HeyApiClient {
|
|
2647
|
+
/**
|
|
2648
|
+
* Get LSP status
|
|
2649
|
+
*
|
|
2650
|
+
* Get LSP server status
|
|
2651
|
+
*/
|
|
2652
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
2653
|
+
directory?: string;
|
|
2654
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<LspStatusResponses, unknown, ThrowOnError, "fields">;
|
|
2655
|
+
}
|
|
2656
|
+
export declare class Formatter extends HeyApiClient {
|
|
2657
|
+
/**
|
|
2658
|
+
* Get formatter status
|
|
2659
|
+
*
|
|
2660
|
+
* Get formatter status
|
|
2661
|
+
*/
|
|
2662
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
2663
|
+
directory?: string;
|
|
2664
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FormatterStatusResponses, unknown, ThrowOnError, "fields">;
|
|
2665
|
+
}
|
|
2666
|
+
export declare class Event extends HeyApiClient {
|
|
2667
|
+
/**
|
|
2668
|
+
* Subscribe to events
|
|
2669
|
+
*
|
|
2670
|
+
* Get events
|
|
2671
|
+
*/
|
|
2672
|
+
subscribe<ThrowOnError extends boolean = false>(parameters?: {
|
|
2673
|
+
directory?: string;
|
|
2674
|
+
}, options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<EventSubscribeResponses, unknown>>;
|
|
2675
|
+
}
|
|
2676
|
+
export declare class OpencodeClient extends HeyApiClient {
|
|
2677
|
+
static readonly __registry: HeyApiRegistry<OpencodeClient>;
|
|
2678
|
+
constructor(args?: {
|
|
2679
|
+
client?: Client;
|
|
2680
|
+
key?: string;
|
|
2681
|
+
});
|
|
2682
|
+
putAccountMe<ThrowOnError extends boolean = false>(parameters?: {
|
|
2683
|
+
name?: string;
|
|
2684
|
+
phone?: string;
|
|
2685
|
+
regionCode?: string;
|
|
2686
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutAccountMeResponses, unknown, ThrowOnError, "fields">;
|
|
2687
|
+
putAccountPhone<ThrowOnError extends boolean = false>(parameters?: {
|
|
2688
|
+
phone?: string;
|
|
2689
|
+
newsletterOptIn?: boolean;
|
|
2690
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutAccountPhoneResponses, unknown, ThrowOnError, "fields">;
|
|
2691
|
+
postAccountAcquisition<ThrowOnError extends boolean = false>(parameters?: {
|
|
2692
|
+
first?: {
|
|
2693
|
+
source?: string;
|
|
2694
|
+
medium?: string;
|
|
2695
|
+
campaign?: string;
|
|
2696
|
+
term?: string;
|
|
2697
|
+
content?: string;
|
|
2698
|
+
referrer?: string;
|
|
2699
|
+
gclid?: string;
|
|
2700
|
+
fbclid?: string;
|
|
2701
|
+
landing?: string;
|
|
2702
|
+
ts?: string;
|
|
2703
|
+
};
|
|
2704
|
+
last?: {
|
|
2705
|
+
source?: string;
|
|
2706
|
+
medium?: string;
|
|
2707
|
+
campaign?: string;
|
|
2708
|
+
term?: string;
|
|
2709
|
+
content?: string;
|
|
2710
|
+
referrer?: string;
|
|
2711
|
+
gclid?: string;
|
|
2712
|
+
fbclid?: string;
|
|
2713
|
+
landing?: string;
|
|
2714
|
+
ts?: string;
|
|
2715
|
+
};
|
|
2716
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostAccountAcquisitionResponses, unknown, ThrowOnError, "fields">;
|
|
2717
|
+
postMapBrochureCharge<ThrowOnError extends boolean = false>(parameters?: {
|
|
2718
|
+
ref?: string;
|
|
2719
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapBrochureChargeResponses, unknown, ThrowOnError, "fields">;
|
|
2720
|
+
postMapPayCheckout<ThrowOnError extends boolean = false>(parameters?: {
|
|
2721
|
+
plan?: string;
|
|
2722
|
+
coupon?: string;
|
|
2723
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapPayCheckoutResponses, unknown, ThrowOnError, "fields">;
|
|
2724
|
+
postMapWalletTopup<ThrowOnError extends boolean = false>(parameters?: {
|
|
2725
|
+
amount?: number;
|
|
2726
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapWalletTopupResponses, unknown, ThrowOnError, "fields">;
|
|
2727
|
+
postMapClaim<ThrowOnError extends boolean = false>(parameters?: {
|
|
2728
|
+
phone?: string;
|
|
2729
|
+
password?: string;
|
|
2730
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapClaimResponses, unknown, ThrowOnError, "fields">;
|
|
2731
|
+
postMapReferralRedeem<ThrowOnError extends boolean = false>(parameters?: {
|
|
2732
|
+
code?: string;
|
|
2733
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapReferralRedeemResponses, unknown, ThrowOnError, "fields">;
|
|
2734
|
+
postMapEvents<ThrowOnError extends boolean = false>(parameters?: {
|
|
2735
|
+
events?: Array<{
|
|
2736
|
+
event: string;
|
|
2737
|
+
params?: {
|
|
2738
|
+
[key: string]: unknown;
|
|
2739
|
+
} | null;
|
|
2740
|
+
at?: string | null;
|
|
2741
|
+
}>;
|
|
2742
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapEventsResponses, unknown, ThrowOnError, "fields">;
|
|
2743
|
+
postMapAdminWalletCredit<ThrowOnError extends boolean = false>(parameters?: {
|
|
2744
|
+
accountID?: string;
|
|
2745
|
+
amount?: number;
|
|
2746
|
+
reason?: "admin_adjust" | "refund";
|
|
2747
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminWalletCreditResponses, unknown, ThrowOnError, "fields">;
|
|
2748
|
+
postMapAdminReferralsRevoke<ThrowOnError extends boolean = false>(parameters?: {
|
|
2749
|
+
id?: string;
|
|
2750
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminReferralsRevokeResponses, unknown, ThrowOnError, "fields">;
|
|
2751
|
+
postMapAdminPartners<ThrowOnError extends boolean = false>(parameters?: {
|
|
2752
|
+
slug?: string;
|
|
2753
|
+
name?: string;
|
|
2754
|
+
billingEmail?: string;
|
|
2755
|
+
priceParcelDetail?: number;
|
|
2756
|
+
creditLimit?: number;
|
|
2757
|
+
webhookUrl?: string;
|
|
2758
|
+
tileScope?: "m2" | "all";
|
|
2759
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminPartnersResponses, unknown, ThrowOnError, "fields">;
|
|
2760
|
+
patchMapAdminPartnersId<ThrowOnError extends boolean = false>(parameters: {
|
|
2761
|
+
id: string;
|
|
2762
|
+
name?: string;
|
|
2763
|
+
billingEmail?: string;
|
|
2764
|
+
webhookUrl?: string | null;
|
|
2765
|
+
status?: "active" | "suspended";
|
|
2766
|
+
priceParcelDetail?: number;
|
|
2767
|
+
tileScope?: "m2" | "all";
|
|
2768
|
+
note?: string | null;
|
|
2769
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchMapAdminPartnersIdResponses, unknown, ThrowOnError, "fields">;
|
|
2770
|
+
postMapAdminPartnersIdKeys<ThrowOnError extends boolean = false>(parameters: {
|
|
2771
|
+
id: string;
|
|
2772
|
+
kind?: "secret" | "publishable";
|
|
2773
|
+
name?: string;
|
|
2774
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminPartnersIdKeysResponses, unknown, ThrowOnError, "fields">;
|
|
2775
|
+
postMapAdminPartnersIdCreditLimit<ThrowOnError extends boolean = false>(parameters: {
|
|
2776
|
+
id: string;
|
|
2777
|
+
creditLimit?: number;
|
|
2778
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminPartnersIdCreditLimitResponses, unknown, ThrowOnError, "fields">;
|
|
2779
|
+
postMapAdminAffiliates<ThrowOnError extends boolean = false>(parameters?: {
|
|
2780
|
+
code?: string;
|
|
2781
|
+
accountID?: string;
|
|
2782
|
+
displayName?: string | null;
|
|
2783
|
+
pctMonth?: number;
|
|
2784
|
+
pctYear?: number;
|
|
2785
|
+
windowDays?: number;
|
|
2786
|
+
note?: string | null;
|
|
2787
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminAffiliatesResponses, unknown, ThrowOnError, "fields">;
|
|
2788
|
+
postMapAdminAffiliatesToggle<ThrowOnError extends boolean = false>(parameters?: {
|
|
2789
|
+
code?: string;
|
|
2790
|
+
active?: boolean;
|
|
2791
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminAffiliatesToggleResponses, unknown, ThrowOnError, "fields">;
|
|
2792
|
+
postMapAdminAffiliatesBind<ThrowOnError extends boolean = false>(parameters?: {
|
|
2793
|
+
accountID?: string;
|
|
2794
|
+
code?: string;
|
|
2795
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminAffiliatesBindResponses, unknown, ThrowOnError, "fields">;
|
|
2796
|
+
postMapAdminAffiliatePayoutsSettle<ThrowOnError extends boolean = false>(parameters?: {
|
|
2797
|
+
id?: string;
|
|
2798
|
+
status?: "paid" | "rejected";
|
|
2799
|
+
note?: string;
|
|
2800
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminAffiliatePayoutsSettleResponses, unknown, ThrowOnError, "fields">;
|
|
2801
|
+
postMapAdminGrant<ThrowOnError extends boolean = false>(parameters?: {
|
|
2802
|
+
accountID?: string;
|
|
2803
|
+
days?: number;
|
|
2804
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminGrantResponses, unknown, ThrowOnError, "fields">;
|
|
2805
|
+
postMapAdminSetAccess<ThrowOnError extends boolean = false>(parameters?: {
|
|
2806
|
+
accountID?: string;
|
|
2807
|
+
accessUntil?: string;
|
|
2808
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminSetAccessResponses, unknown, ThrowOnError, "fields">;
|
|
2809
|
+
postMapAdminCustomCheckout<ThrowOnError extends boolean = false>(parameters?: {
|
|
2810
|
+
accountID?: string;
|
|
2811
|
+
amount?: number;
|
|
2812
|
+
plan?: string;
|
|
2813
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostMapAdminCustomCheckoutResponses, unknown, ThrowOnError, "fields">;
|
|
2814
|
+
postAffiliateClick<ThrowOnError extends boolean = false>(parameters?: {
|
|
2815
|
+
code?: string;
|
|
2816
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostAffiliateClickResponses, unknown, ThrowOnError, "fields">;
|
|
2817
|
+
postAffiliateBind<ThrowOnError extends boolean = false>(parameters?: {
|
|
2818
|
+
code?: string;
|
|
2819
|
+
via?: "link" | "manual";
|
|
2820
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostAffiliateBindResponses, unknown, ThrowOnError, "fields">;
|
|
2821
|
+
putAffiliateBank<ThrowOnError extends boolean = false>(parameters?: {
|
|
2822
|
+
bankAccount?: string;
|
|
2823
|
+
bankName?: string;
|
|
2824
|
+
bankHolder?: string;
|
|
2825
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutAffiliateBankResponses, unknown, ThrowOnError, "fields">;
|
|
2826
|
+
patchWorkspacesIdBranding<ThrowOnError extends boolean = false>(parameters: {
|
|
2827
|
+
id: string;
|
|
2828
|
+
logoKey?: string | null;
|
|
2829
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchWorkspacesIdBrandingResponses, unknown, ThrowOnError, "fields">;
|
|
2830
|
+
postWorkspacesIdBrandingUploadUrl<ThrowOnError extends boolean = false>(parameters: {
|
|
2831
|
+
id: string;
|
|
2832
|
+
filename?: string;
|
|
2833
|
+
size?: number;
|
|
2834
|
+
contentType?: string;
|
|
2835
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostWorkspacesIdBrandingUploadUrlResponses, unknown, ThrowOnError, "fields">;
|
|
2836
|
+
patchWorkspacesIdGeocoding<ThrowOnError extends boolean = false>(parameters: {
|
|
2837
|
+
id: string;
|
|
2838
|
+
provider?: "map-service" | "google";
|
|
2839
|
+
apiKey?: string;
|
|
2840
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchWorkspacesIdGeocodingResponses, unknown, ThrowOnError, "fields">;
|
|
2841
|
+
postWorkspacesIdGeocodingTest<ThrowOnError extends boolean = false>(parameters: {
|
|
2842
|
+
id: string;
|
|
2843
|
+
apiKey?: string;
|
|
2844
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostWorkspacesIdGeocodingTestResponses, unknown, ThrowOnError, "fields">;
|
|
2845
|
+
postWorkspacesIdInvite<ThrowOnError extends boolean = false>(parameters: {
|
|
2846
|
+
id: string;
|
|
2847
|
+
email?: string;
|
|
2848
|
+
role?: "member" | "admin";
|
|
2849
|
+
message?: string;
|
|
2850
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostWorkspacesIdInviteResponses, unknown, ThrowOnError, "fields">;
|
|
2851
|
+
patchWorkspacesIdMembersMemberId<ThrowOnError extends boolean = false>(parameters: {
|
|
2852
|
+
id: string;
|
|
2853
|
+
memberId: string;
|
|
2854
|
+
role?: "member" | "admin";
|
|
2855
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchWorkspacesIdMembersMemberIdResponses, unknown, ThrowOnError, "fields">;
|
|
2856
|
+
postWorkspacesIdTransferOwnership<ThrowOnError extends boolean = false>(parameters: {
|
|
2857
|
+
id: string;
|
|
2858
|
+
newOwnerID?: string;
|
|
2859
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostWorkspacesIdTransferOwnershipResponses, unknown, ThrowOnError, "fields">;
|
|
2860
|
+
postWorkspacesIdRoles<ThrowOnError extends boolean = false>(parameters: {
|
|
2861
|
+
id: string;
|
|
2862
|
+
name?: string;
|
|
2863
|
+
permissions?: Array<{
|
|
2864
|
+
resource: string;
|
|
2865
|
+
actions: Array<string>;
|
|
2866
|
+
tagFilter?: {
|
|
2867
|
+
[key: string]: Array<string>;
|
|
2868
|
+
} | null;
|
|
2869
|
+
hiddenFields?: Array<string> | null;
|
|
2870
|
+
}>;
|
|
2871
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostWorkspacesIdRolesResponses, unknown, ThrowOnError, "fields">;
|
|
2872
|
+
patchWorkspacesIdRolesRoleId<ThrowOnError extends boolean = false>(parameters: {
|
|
2873
|
+
id: string;
|
|
2874
|
+
roleId: string;
|
|
2875
|
+
name?: string;
|
|
2876
|
+
permissions?: Array<{
|
|
2877
|
+
resource: string;
|
|
2878
|
+
actions: Array<string>;
|
|
2879
|
+
tagFilter?: {
|
|
2880
|
+
[key: string]: Array<string>;
|
|
2881
|
+
} | null;
|
|
2882
|
+
hiddenFields?: Array<string> | null;
|
|
2883
|
+
}>;
|
|
2884
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchWorkspacesIdRolesRoleIdResponses, unknown, ThrowOnError, "fields">;
|
|
2885
|
+
putWorkspacesIdMembersMemberIdRoles<ThrowOnError extends boolean = false>(parameters: {
|
|
2886
|
+
id: string;
|
|
2887
|
+
memberId: string;
|
|
2888
|
+
roleIDs?: Array<string>;
|
|
2889
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutWorkspacesIdMembersMemberIdRolesResponses, unknown, ThrowOnError, "fields">;
|
|
2890
|
+
getWorkspacesIdAudit<ThrowOnError extends boolean = false>(parameters: {
|
|
2891
|
+
id: string;
|
|
2892
|
+
resource?: string;
|
|
2893
|
+
userID?: string;
|
|
2894
|
+
action?: string;
|
|
2895
|
+
from?: string;
|
|
2896
|
+
to?: string;
|
|
2897
|
+
search?: string;
|
|
2898
|
+
limit?: number;
|
|
2899
|
+
offset?: number;
|
|
2900
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetWorkspacesIdAuditResponses, unknown, ThrowOnError, "fields">;
|
|
2901
|
+
getInstructions<ThrowOnError extends boolean = false>(parameters?: {
|
|
2902
|
+
scope?: "workspace" | "user" | "user-workspace";
|
|
2903
|
+
source?: "user" | "agent";
|
|
2904
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetInstructionsResponses, unknown, ThrowOnError, "fields">;
|
|
2905
|
+
postInstructions<ThrowOnError extends boolean = false>(parameters?: {
|
|
2906
|
+
scope?: "workspace" | "user" | "user-workspace";
|
|
2907
|
+
name?: string;
|
|
2908
|
+
type?: "semantic" | "procedural" | "episodic";
|
|
2909
|
+
category?: "profile" | "preference" | "context" | "rule";
|
|
2910
|
+
content?: string;
|
|
2911
|
+
enabled?: boolean;
|
|
2912
|
+
source?: "user" | "agent";
|
|
2913
|
+
sessionID?: string;
|
|
2914
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostInstructionsResponses, unknown, ThrowOnError, "fields">;
|
|
2915
|
+
deleteInstructionsId<ThrowOnError extends boolean = false>(parameters: {
|
|
2916
|
+
id: string;
|
|
2917
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteInstructionsIdResponses, unknown, ThrowOnError, "fields">;
|
|
2918
|
+
patchInstructionsId<ThrowOnError extends boolean = false>(parameters: {
|
|
2919
|
+
id: string;
|
|
2920
|
+
name?: string;
|
|
2921
|
+
type?: "semantic" | "procedural" | "episodic";
|
|
2922
|
+
category?: "profile" | "preference" | "context" | "rule";
|
|
2923
|
+
content?: string;
|
|
2924
|
+
enabled?: boolean;
|
|
2925
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchInstructionsIdResponses, unknown, ThrowOnError, "fields">;
|
|
2926
|
+
patchInstructionsIdToggle<ThrowOnError extends boolean = false>(parameters: {
|
|
2927
|
+
id: string;
|
|
2928
|
+
enabled?: boolean;
|
|
2929
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchInstructionsIdToggleResponses, unknown, ThrowOnError, "fields">;
|
|
2930
|
+
global: Global;
|
|
2931
|
+
workspaces: Workspaces;
|
|
2932
|
+
project: Project;
|
|
2933
|
+
internal: Internal;
|
|
2934
|
+
nbp: Nbp;
|
|
2935
|
+
agent: Agent;
|
|
2936
|
+
pty: Pty;
|
|
2937
|
+
config: Config;
|
|
2938
|
+
tool: Tool;
|
|
2939
|
+
instance: Instance;
|
|
2940
|
+
path: Path;
|
|
2941
|
+
worktree: Worktree;
|
|
2942
|
+
vcs: Vcs;
|
|
2943
|
+
session: Session;
|
|
2944
|
+
part: Part;
|
|
2945
|
+
permission: Permission;
|
|
2946
|
+
question: Question;
|
|
2947
|
+
command: Command;
|
|
2948
|
+
provider: Provider;
|
|
2949
|
+
find: Find;
|
|
2950
|
+
file: File;
|
|
2951
|
+
app: App;
|
|
2952
|
+
mcp: Mcp;
|
|
2953
|
+
experimental: Experimental;
|
|
2954
|
+
lsp: Lsp;
|
|
2955
|
+
formatter: Formatter;
|
|
2956
|
+
auth: Auth;
|
|
2957
|
+
event: Event;
|
|
2958
|
+
}
|
|
2959
|
+
export {};
|