@gpt-platform/client 0.8.1 → 0.8.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +330 -20
- package/dist/index.d.ts +330 -20
- package/dist/index.js +712 -29
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +712 -29
- package/dist/index.mjs.map +1 -1
- package/llms.txt +25 -2
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -606,7 +606,7 @@ declare class BrowserApiKeyError extends Error {
|
|
|
606
606
|
}
|
|
607
607
|
|
|
608
608
|
/** SDK version — updated automatically by mix update.sdks */
|
|
609
|
-
declare const SDK_VERSION = "0.8.
|
|
609
|
+
declare const SDK_VERSION = "0.8.3";
|
|
610
610
|
/** Default API version sent in every request — updated automatically by mix update.sdks */
|
|
611
611
|
declare const DEFAULT_API_VERSION = "2026-03-11";
|
|
612
612
|
|
|
@@ -772,6 +772,32 @@ declare abstract class BaseClient {
|
|
|
772
772
|
* Clear the authentication token (e.g., on logout).
|
|
773
773
|
*/
|
|
774
774
|
clearToken(): void;
|
|
775
|
+
/**
|
|
776
|
+
* Switch the workspace context for all subsequent requests.
|
|
777
|
+
*
|
|
778
|
+
* Sets the `workspace_id` query parameter appended to every request.
|
|
779
|
+
* Use this after creating a new workspace or switching workspace context
|
|
780
|
+
* without constructing a new client instance.
|
|
781
|
+
*
|
|
782
|
+
* @param workspaceId - The workspace UUID to scope requests to, or
|
|
783
|
+
* `undefined` to clear workspace scoping.
|
|
784
|
+
*
|
|
785
|
+
* @example
|
|
786
|
+
* ```typescript
|
|
787
|
+
* const org = await sdk.platform.tenants.createOrg({ name: 'Acme' });
|
|
788
|
+
* const workspaces = await sdk.platform.workspaces.mine();
|
|
789
|
+
* const ws = workspaces.find(w => w.tenant_id === org.id);
|
|
790
|
+
*
|
|
791
|
+
* sdk.setWorkspaceId(ws.id);
|
|
792
|
+
* // All subsequent calls are scoped to the new workspace
|
|
793
|
+
* await sdk.scheduling.events.create({ ... });
|
|
794
|
+
* ```
|
|
795
|
+
*/
|
|
796
|
+
setWorkspaceId(workspaceId: string | undefined): void;
|
|
797
|
+
/**
|
|
798
|
+
* Get the current workspace ID, if set.
|
|
799
|
+
*/
|
|
800
|
+
getWorkspaceId(): string | undefined;
|
|
775
801
|
}
|
|
776
802
|
|
|
777
803
|
/**
|
|
@@ -4173,6 +4199,10 @@ type Plan = {
|
|
|
4173
4199
|
* Field included by default.
|
|
4174
4200
|
*/
|
|
4175
4201
|
created_at: unknown;
|
|
4202
|
+
/**
|
|
4203
|
+
* Credits allocated per seat at renewal. nil = falls back to monthly_credits. Field included by default.
|
|
4204
|
+
*/
|
|
4205
|
+
credits_per_seat?: number | null | unknown;
|
|
4176
4206
|
/**
|
|
4177
4207
|
* Human-readable feature list derived from capability_tiers, for pricing tables
|
|
4178
4208
|
*/
|
|
@@ -5828,6 +5858,10 @@ type Tenant = {
|
|
|
5828
5858
|
*/
|
|
5829
5859
|
contact_phone?: string | null | unknown;
|
|
5830
5860
|
credit_balance?: number | null | unknown;
|
|
5861
|
+
/**
|
|
5862
|
+
* Field included by default.
|
|
5863
|
+
*/
|
|
5864
|
+
deactivated_at?: unknown;
|
|
5831
5865
|
/**
|
|
5832
5866
|
* Field included by default.
|
|
5833
5867
|
*/
|
|
@@ -7313,7 +7347,7 @@ type ClinicalPracticeResource = {
|
|
|
7313
7347
|
/**
|
|
7314
7348
|
* Field included by default.
|
|
7315
7349
|
*/
|
|
7316
|
-
resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link";
|
|
7350
|
+
resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
|
|
7317
7351
|
/**
|
|
7318
7352
|
* Field included by default.
|
|
7319
7353
|
*/
|
|
@@ -14144,24 +14178,42 @@ declare function createPlatformNamespace(rb: RequestBuilder): {
|
|
|
14144
14178
|
*/
|
|
14145
14179
|
credit: (id: string, amount: number, description?: string, options?: RequestOptions) => Promise<Tenant>;
|
|
14146
14180
|
/**
|
|
14147
|
-
*
|
|
14181
|
+
* Deactivate a tenant (hide from user's account).
|
|
14182
|
+
*
|
|
14183
|
+
* Sets `deactivated_at` on the tenant. The tenant and its workspaces
|
|
14184
|
+
* disappear from `workspaces.mine()` and tenant listings. Billing and
|
|
14185
|
+
* data are completely unaffected. Reversible via `reactivate()`.
|
|
14148
14186
|
*
|
|
14149
|
-
*
|
|
14150
|
-
* billing records. This operation is irreversible. For a graceful
|
|
14151
|
-
* off-boarding, prefer `schedulePurge` which allows data export before
|
|
14152
|
-
* deletion.
|
|
14187
|
+
* Only the tenant owner can deactivate.
|
|
14153
14188
|
*
|
|
14154
|
-
* @param id - The UUID of the tenant to
|
|
14189
|
+
* @param id - The UUID of the tenant to deactivate.
|
|
14155
14190
|
* @param options - Optional request options.
|
|
14156
|
-
* @returns
|
|
14191
|
+
* @returns The updated tenant record.
|
|
14157
14192
|
*
|
|
14158
14193
|
* @example
|
|
14159
14194
|
* ```typescript
|
|
14160
|
-
*
|
|
14161
|
-
* await client.platform.tenants.delete('tenant_abc123');
|
|
14195
|
+
* await client.platform.tenants.deactivate('tenant_abc123');
|
|
14162
14196
|
* ```
|
|
14163
14197
|
*/
|
|
14164
|
-
|
|
14198
|
+
deactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
|
|
14199
|
+
/**
|
|
14200
|
+
* Reactivate a previously deactivated tenant.
|
|
14201
|
+
*
|
|
14202
|
+
* Clears `deactivated_at`, restoring the tenant and its workspaces
|
|
14203
|
+
* to the user's account. Only works on deactivated tenants.
|
|
14204
|
+
*
|
|
14205
|
+
* Only the tenant owner can reactivate.
|
|
14206
|
+
*
|
|
14207
|
+
* @param id - The UUID of the tenant to reactivate.
|
|
14208
|
+
* @param options - Optional request options.
|
|
14209
|
+
* @returns The updated tenant record.
|
|
14210
|
+
*
|
|
14211
|
+
* @example
|
|
14212
|
+
* ```typescript
|
|
14213
|
+
* await client.platform.tenants.reactivate('tenant_abc123');
|
|
14214
|
+
* ```
|
|
14215
|
+
*/
|
|
14216
|
+
reactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
|
|
14165
14217
|
/**
|
|
14166
14218
|
* Create a new tenant (ISV provisioning flow).
|
|
14167
14219
|
*
|
|
@@ -14415,6 +14467,39 @@ declare function createPlatformNamespace(rb: RequestBuilder): {
|
|
|
14415
14467
|
* ```
|
|
14416
14468
|
*/
|
|
14417
14469
|
resend: (id: string, applicationId?: string, options?: RequestOptions) => Promise<Invitation>;
|
|
14470
|
+
/**
|
|
14471
|
+
* List invitations visible to the current actor.
|
|
14472
|
+
*
|
|
14473
|
+
* Returns invitations where the actor is the inviter, the tenant owner,
|
|
14474
|
+
* or the recipient (matched by email). Use this to build admin views
|
|
14475
|
+
* of pending/accepted invitations for a tenant or workspace.
|
|
14476
|
+
*
|
|
14477
|
+
* @param options - Optional page number, page size, and request options.
|
|
14478
|
+
* @returns A page of `Invitation` records.
|
|
14479
|
+
*
|
|
14480
|
+
* @example
|
|
14481
|
+
* ```typescript
|
|
14482
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
14483
|
+
* const invites = await client.platform.invitations.list();
|
|
14484
|
+
* ```
|
|
14485
|
+
*/
|
|
14486
|
+
list: (options?: {
|
|
14487
|
+
page?: number;
|
|
14488
|
+
pageSize?: number;
|
|
14489
|
+
} & RequestOptions) => Promise<Invitation[]>;
|
|
14490
|
+
/**
|
|
14491
|
+
* List all invitations visible to the current actor, auto-paginating.
|
|
14492
|
+
*
|
|
14493
|
+
* @param options - Optional request options.
|
|
14494
|
+
* @returns All visible `Invitation` records as a flat array.
|
|
14495
|
+
*
|
|
14496
|
+
* @example
|
|
14497
|
+
* ```typescript
|
|
14498
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
14499
|
+
* const all = await client.platform.invitations.listAll();
|
|
14500
|
+
* ```
|
|
14501
|
+
*/
|
|
14502
|
+
listAll: (options?: RequestOptions) => Promise<Invitation[]>;
|
|
14418
14503
|
/**
|
|
14419
14504
|
* Look up a pending invitation by its raw token.
|
|
14420
14505
|
*
|
|
@@ -15102,6 +15187,32 @@ declare function createIdentityNamespace(rb: RequestBuilder, baseUrl?: string):
|
|
|
15102
15187
|
* invite-flow or SSO registrations where acceptance is handled separately.
|
|
15103
15188
|
*/
|
|
15104
15189
|
register: (email: string, password: string, passwordConfirmation: string, tenantName: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
|
|
15190
|
+
/**
|
|
15191
|
+
* Register a new user via invitation — skips personal tenant creation.
|
|
15192
|
+
*
|
|
15193
|
+
* Creates the user account, accepts the invitation (creating tenant/workspace
|
|
15194
|
+
* memberships), and returns the authenticated user with a session token.
|
|
15195
|
+
* The email must match the invitation's recipient email.
|
|
15196
|
+
*
|
|
15197
|
+
* @param email - Must match the invitation recipient email
|
|
15198
|
+
* @param password - Minimum 8 characters
|
|
15199
|
+
* @param passwordConfirmation - Must match password
|
|
15200
|
+
* @param invitationToken - Raw token from the invitation email link
|
|
15201
|
+
* @param attrs - Optional extra attributes (first_name, last_name)
|
|
15202
|
+
* @param options - Optional request options
|
|
15203
|
+
* @returns The newly created `User` with session token
|
|
15204
|
+
*
|
|
15205
|
+
* @example
|
|
15206
|
+
* ```typescript
|
|
15207
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
15208
|
+
* const user = await client.identity.registerViaInvitation(
|
|
15209
|
+
* 'invited@example.com', 'securepass', 'securepass', 'raw-token-from-email',
|
|
15210
|
+
* { first_name: 'Jane', last_name: 'Doe' },
|
|
15211
|
+
* );
|
|
15212
|
+
* console.log(user.token); // JWT session token
|
|
15213
|
+
* ```
|
|
15214
|
+
*/
|
|
15215
|
+
registerViaInvitation: (email: string, password: string, passwordConfirmation: string, invitationToken: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
|
|
15105
15216
|
/** Get the currently authenticated user */
|
|
15106
15217
|
me: (options?: RequestOptions) => Promise<User>;
|
|
15107
15218
|
/** Get the current user profile (alias for me()) */
|
|
@@ -19490,7 +19601,52 @@ declare function createBillingNamespace(rb: RequestBuilder): {
|
|
|
19490
19601
|
*/
|
|
19491
19602
|
list: (options?: RequestOptions) => Promise<FeatureSummary[]>;
|
|
19492
19603
|
};
|
|
19604
|
+
/**
|
|
19605
|
+
* Get capacity estimates for a plan's monthly credits.
|
|
19606
|
+
*
|
|
19607
|
+
* Returns how many of each ISV-defined feature the plan supports per month.
|
|
19608
|
+
* No Bearer token required — uses application key only.
|
|
19609
|
+
*
|
|
19610
|
+
* @param planSlug - The plan slug to calculate capacity for.
|
|
19611
|
+
* @param options - Optional request-level overrides.
|
|
19612
|
+
* @returns Plan details and capacity breakdown per composite operation.
|
|
19613
|
+
*
|
|
19614
|
+
* @example
|
|
19615
|
+
* ```typescript
|
|
19616
|
+
* const result = await client.billing.capacityCalculator("pro-plan");
|
|
19617
|
+
* console.log(`Plan: ${result.plan.name}`);
|
|
19618
|
+
* for (const item of result.capacity) {
|
|
19619
|
+
* console.log(`${item.display_name}: ~${item.estimated_monthly_count}/month`);
|
|
19620
|
+
* }
|
|
19621
|
+
* ```
|
|
19622
|
+
*/
|
|
19623
|
+
capacityCalculator: (planSlug: string, options?: RequestOptions) => Promise<CapacityCalculatorResponse>;
|
|
19493
19624
|
};
|
|
19625
|
+
/** Response from the capacity-calculator endpoint. */
|
|
19626
|
+
interface CapacityCalculatorResponse {
|
|
19627
|
+
plan: {
|
|
19628
|
+
slug: string;
|
|
19629
|
+
name: string;
|
|
19630
|
+
monthly_credits: number;
|
|
19631
|
+
};
|
|
19632
|
+
capacity: Array<{
|
|
19633
|
+
key: string;
|
|
19634
|
+
display_name: string;
|
|
19635
|
+
description: string | null;
|
|
19636
|
+
credits_per_use: number;
|
|
19637
|
+
estimated_monthly_count: number;
|
|
19638
|
+
is_estimate: boolean;
|
|
19639
|
+
components: Array<{
|
|
19640
|
+
operation_key: string;
|
|
19641
|
+
quantity: number;
|
|
19642
|
+
unit: string;
|
|
19643
|
+
credits_per_unit: number | null;
|
|
19644
|
+
total_credits: number;
|
|
19645
|
+
is_estimate: boolean;
|
|
19646
|
+
}>;
|
|
19647
|
+
}>;
|
|
19648
|
+
is_estimate: boolean;
|
|
19649
|
+
}
|
|
19494
19650
|
|
|
19495
19651
|
/** Response from a semantic search query. */
|
|
19496
19652
|
interface AiSearchResponse {
|
|
@@ -21601,7 +21757,7 @@ interface CreatePracticeResourceAttributes {
|
|
|
21601
21757
|
workspace_id: string;
|
|
21602
21758
|
title: string;
|
|
21603
21759
|
description?: string;
|
|
21604
|
-
resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
|
|
21760
|
+
resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
|
|
21605
21761
|
storage_key?: string;
|
|
21606
21762
|
url?: string;
|
|
21607
21763
|
tags?: string[];
|
|
@@ -21621,7 +21777,7 @@ interface CreatePracticeResourceAttributes {
|
|
|
21621
21777
|
interface UpdatePracticeResourceAttributes {
|
|
21622
21778
|
title?: string;
|
|
21623
21779
|
description?: string;
|
|
21624
|
-
resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
|
|
21780
|
+
resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
|
|
21625
21781
|
storage_key?: string;
|
|
21626
21782
|
url?: string;
|
|
21627
21783
|
tags?: string[];
|
|
@@ -21694,6 +21850,11 @@ interface PracticeToolCategory {
|
|
|
21694
21850
|
category: string;
|
|
21695
21851
|
tool_count: number;
|
|
21696
21852
|
}
|
|
21853
|
+
/** A practice resource category with usage count. */
|
|
21854
|
+
interface PracticeResourceCategory {
|
|
21855
|
+
category: string;
|
|
21856
|
+
resource_count: number;
|
|
21857
|
+
}
|
|
21697
21858
|
interface CreateClientResourceAssignmentAttributes {
|
|
21698
21859
|
workspace_id: string;
|
|
21699
21860
|
patient_id: string;
|
|
@@ -21909,6 +22070,24 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
|
|
|
21909
22070
|
* ```
|
|
21910
22071
|
*/
|
|
21911
22072
|
delete: (id: string, options?: RequestOptions) => Promise<true>;
|
|
22073
|
+
/**
|
|
22074
|
+
* Look up a patient by their CRM Contact ID.
|
|
22075
|
+
*
|
|
22076
|
+
* Most ISV apps work with CRM Contact IDs, not Clinical Patient UUIDs.
|
|
22077
|
+
* Use this to resolve the patient record for a given contact.
|
|
22078
|
+
*
|
|
22079
|
+
* @param contactId - CRM Contact UUID
|
|
22080
|
+
* @param options - Request options
|
|
22081
|
+
* @returns {@link ClinicalPatient} record linked to the contact
|
|
22082
|
+
* @throws {@link NotFoundError} if no patient exists for the contact
|
|
22083
|
+
*
|
|
22084
|
+
* @example
|
|
22085
|
+
* ```typescript
|
|
22086
|
+
* const patient = await client.clinical.patients.getByContact('c7da2056-...');
|
|
22087
|
+
* console.log(patient.id); // Clinical Patient UUID
|
|
22088
|
+
* ```
|
|
22089
|
+
*/
|
|
22090
|
+
getByContact: (contactId: string, options?: RequestOptions) => Promise<ClinicalPatient>;
|
|
21912
22091
|
/**
|
|
21913
22092
|
* List health metrics for a patient (related resource).
|
|
21914
22093
|
*
|
|
@@ -22445,6 +22624,42 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
|
|
|
22445
22624
|
filter?: Record<string, unknown>;
|
|
22446
22625
|
sort?: string;
|
|
22447
22626
|
}, options?: RequestOptions) => Promise<ClinicalPracticeResource[]>;
|
|
22627
|
+
/**
|
|
22628
|
+
* List distinct practice resource categories in a workspace.
|
|
22629
|
+
*
|
|
22630
|
+
* Returns unique `resource_type` values with their active resource counts,
|
|
22631
|
+
* sorted by count descending.
|
|
22632
|
+
*
|
|
22633
|
+
* @param params - Must include `workspace_id`
|
|
22634
|
+
* @param options - Request options
|
|
22635
|
+
* @returns Array of {@link PracticeResourceCategory} records
|
|
22636
|
+
*
|
|
22637
|
+
* @example
|
|
22638
|
+
* ```typescript
|
|
22639
|
+
* const categories = await client.clinical.practiceResources.listCategories({
|
|
22640
|
+
* workspace_id: "..."
|
|
22641
|
+
* });
|
|
22642
|
+
* // [{ category: "article", resource_count: 5 }, { category: "video", resource_count: 3 }]
|
|
22643
|
+
* ```
|
|
22644
|
+
*/
|
|
22645
|
+
listCategories: (params: {
|
|
22646
|
+
workspace_id: string;
|
|
22647
|
+
}, options?: RequestOptions) => Promise<PracticeResourceCategory[]>;
|
|
22648
|
+
/**
|
|
22649
|
+
* List distinct catalog practice resource categories.
|
|
22650
|
+
*
|
|
22651
|
+
* Returns unique `resource_type` values from application-level catalog resources.
|
|
22652
|
+
* Application ID is resolved from the API key context.
|
|
22653
|
+
*
|
|
22654
|
+
* @param options - Request options
|
|
22655
|
+
* @returns Array of {@link PracticeResourceCategory} records
|
|
22656
|
+
*
|
|
22657
|
+
* @example
|
|
22658
|
+
* ```typescript
|
|
22659
|
+
* const cats = await client.clinical.practiceResources.listCatalogCategories();
|
|
22660
|
+
* ```
|
|
22661
|
+
*/
|
|
22662
|
+
listCatalogCategories: (options?: RequestOptions) => Promise<PracticeResourceCategory[]>;
|
|
22448
22663
|
};
|
|
22449
22664
|
/**
|
|
22450
22665
|
* Manage practice-level assessment and therapeutic tools.
|
|
@@ -22523,6 +22738,21 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
|
|
|
22523
22738
|
filter?: Record<string, unknown>;
|
|
22524
22739
|
sort?: string;
|
|
22525
22740
|
}, options?: RequestOptions) => Promise<ClinicalPracticeTool[]>;
|
|
22741
|
+
/**
|
|
22742
|
+
* List distinct catalog practice tool categories.
|
|
22743
|
+
*
|
|
22744
|
+
* Returns unique `tool_type` values from application-level catalog tools.
|
|
22745
|
+
* Application ID is resolved from the API key context.
|
|
22746
|
+
*
|
|
22747
|
+
* @param options - Request options
|
|
22748
|
+
* @returns Array of {@link PracticeToolCategory} records
|
|
22749
|
+
*
|
|
22750
|
+
* @example
|
|
22751
|
+
* ```typescript
|
|
22752
|
+
* const cats = await client.clinical.practiceTools.listCatalogCategories();
|
|
22753
|
+
* ```
|
|
22754
|
+
*/
|
|
22755
|
+
listCatalogCategories: (options?: RequestOptions) => Promise<PracticeToolCategory[]>;
|
|
22526
22756
|
};
|
|
22527
22757
|
/**
|
|
22528
22758
|
* Manage assignments of practice resources to patients.
|
|
@@ -22729,6 +22959,21 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
|
|
|
22729
22959
|
filter?: Record<string, unknown>;
|
|
22730
22960
|
sort?: string;
|
|
22731
22961
|
}, options?: RequestOptions) => Promise<ClinicalGoalTemplate[]>;
|
|
22962
|
+
/**
|
|
22963
|
+
* List distinct catalog goal template categories.
|
|
22964
|
+
*
|
|
22965
|
+
* Returns unique `category` values from application-level catalog templates.
|
|
22966
|
+
* Application ID is resolved from the API key context.
|
|
22967
|
+
*
|
|
22968
|
+
* @param options - Request options
|
|
22969
|
+
* @returns Array of {@link ClinicalGoalTemplateCategory} records
|
|
22970
|
+
*
|
|
22971
|
+
* @example
|
|
22972
|
+
* ```typescript
|
|
22973
|
+
* const cats = await client.clinical.goalTemplates.listCatalogCategories();
|
|
22974
|
+
* ```
|
|
22975
|
+
*/
|
|
22976
|
+
listCatalogCategories: (options?: RequestOptions) => Promise<ClinicalGoalTemplateCategory[]>;
|
|
22732
22977
|
};
|
|
22733
22978
|
/**
|
|
22734
22979
|
* Recipe search via configured Edamam connector.
|
|
@@ -23013,6 +23258,7 @@ declare class GptClient extends BaseClient {
|
|
|
23013
23258
|
featureSummary: {
|
|
23014
23259
|
list: (options?: RequestOptions) => Promise<FeatureSummary[]>;
|
|
23015
23260
|
};
|
|
23261
|
+
capacityCalculator: (planSlug: string, options?: RequestOptions) => Promise<CapacityCalculatorResponse>;
|
|
23016
23262
|
};
|
|
23017
23263
|
/** Product catalog, inventory, pricing, and taxonomy */
|
|
23018
23264
|
readonly catalog: {
|
|
@@ -23407,7 +23653,7 @@ declare class GptClient extends BaseClient {
|
|
|
23407
23653
|
jobs: {
|
|
23408
23654
|
list: (options?: {
|
|
23409
23655
|
page?: number;
|
|
23410
|
-
pageSize
|
|
23656
|
+
pageSize?: number;
|
|
23411
23657
|
} & RequestOptions) => Promise<CrawlerJob[]>;
|
|
23412
23658
|
get: (id: string, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
23413
23659
|
create: (attributes: CreateCrawlerJobAttributes, options?: RequestOptions) => Promise<CrawlerJob>;
|
|
@@ -23552,6 +23798,65 @@ declare class GptClient extends BaseClient {
|
|
|
23552
23798
|
refreshUrl: (jobId: string, options?: RequestOptions) => Promise<CrmDataExportJob>;
|
|
23553
23799
|
};
|
|
23554
23800
|
};
|
|
23801
|
+
/** AI content generation — text, images, tone rewriting, hashtags, SEO */
|
|
23802
|
+
readonly content: {
|
|
23803
|
+
generateText: (attributes: {
|
|
23804
|
+
prompt: string;
|
|
23805
|
+
workspace_id: string;
|
|
23806
|
+
brand_identity_id?: string;
|
|
23807
|
+
task?: string;
|
|
23808
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23809
|
+
generateImage: (attributes: {
|
|
23810
|
+
prompt: string;
|
|
23811
|
+
workspace_id: string;
|
|
23812
|
+
style?: string;
|
|
23813
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23814
|
+
editImage: (attributes: {
|
|
23815
|
+
image_url: string;
|
|
23816
|
+
instructions: string;
|
|
23817
|
+
workspace_id: string;
|
|
23818
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23819
|
+
rewriteTone: (attributes: {
|
|
23820
|
+
text: string;
|
|
23821
|
+
target_tone: string;
|
|
23822
|
+
workspace_id: string;
|
|
23823
|
+
max_length?: number;
|
|
23824
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23825
|
+
shorten: (attributes: {
|
|
23826
|
+
text: string;
|
|
23827
|
+
max_chars: number;
|
|
23828
|
+
workspace_id: string;
|
|
23829
|
+
platform?: string;
|
|
23830
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23831
|
+
refine: (attributes: {
|
|
23832
|
+
text: string;
|
|
23833
|
+
instructions: string;
|
|
23834
|
+
workspace_id: string;
|
|
23835
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23836
|
+
suggestTopics: (attributes: {
|
|
23837
|
+
workspace_id: string;
|
|
23838
|
+
industry?: string;
|
|
23839
|
+
brand_identity_id? /** Pipeline trigger — execute multi-node agent pipelines */: string;
|
|
23840
|
+
count?: number;
|
|
23841
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23842
|
+
generateImagePrompt: (attributes: {
|
|
23843
|
+
marketing_copy: string;
|
|
23844
|
+
workspace_id: string;
|
|
23845
|
+
style?: string;
|
|
23846
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23847
|
+
generateHashtags: (attributes: {
|
|
23848
|
+
text: string;
|
|
23849
|
+
platform: string;
|
|
23850
|
+
workspace_id: string;
|
|
23851
|
+
industry?: string;
|
|
23852
|
+
count?: number;
|
|
23853
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23854
|
+
seoEnrich: (attributes: {
|
|
23855
|
+
text: string;
|
|
23856
|
+
target_keywords: string[];
|
|
23857
|
+
workspace_id: string;
|
|
23858
|
+
}, options?: RequestOptions) => Promise<unknown>;
|
|
23859
|
+
};
|
|
23555
23860
|
/** Email campaigns, recipients, AI generation, and sequences */
|
|
23556
23861
|
readonly campaigns: {
|
|
23557
23862
|
campaigns: {
|
|
@@ -23833,6 +24138,7 @@ declare class GptClient extends BaseClient {
|
|
|
23833
24138
|
readonly identity: {
|
|
23834
24139
|
login: (email: string, password: string, options?: RequestOptions) => Promise<User>;
|
|
23835
24140
|
register: (email: string, password: string, passwordConfirmation: string, tenantName: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
|
|
24141
|
+
registerViaInvitation: (email: string, password: string, passwordConfirmation: string, invitationToken: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
|
|
23836
24142
|
me: (options?: RequestOptions) => Promise<User>;
|
|
23837
24143
|
profile: (options?: RequestOptions) => Promise<User>;
|
|
23838
24144
|
list: (options?: {
|
|
@@ -23912,9 +24218,7 @@ declare class GptClient extends BaseClient {
|
|
|
23912
24218
|
get: (options?: RequestOptions) => Promise<PortalProfile>;
|
|
23913
24219
|
update: (params: {
|
|
23914
24220
|
avatar_url?: string;
|
|
23915
|
-
locale
|
|
23916
|
-
/** Document upload, processing, results, and exports */
|
|
23917
|
-
?: string;
|
|
24221
|
+
locale?: string;
|
|
23918
24222
|
timezone?: string;
|
|
23919
24223
|
notification_preferences?: Record<string, unknown>;
|
|
23920
24224
|
}, options?: RequestOptions) => Promise<{
|
|
@@ -24008,7 +24312,8 @@ declare class GptClient extends BaseClient {
|
|
|
24008
24312
|
} & RequestOptions) => Promise<Tenant[]>;
|
|
24009
24313
|
listAllDocumentStats: (tenantId: string, options?: RequestOptions) => Promise<Tenant[]>;
|
|
24010
24314
|
credit: (id: string, amount: number, description?: string, options?: RequestOptions) => Promise<Tenant>;
|
|
24011
|
-
|
|
24315
|
+
deactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
|
|
24316
|
+
reactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
|
|
24012
24317
|
create: (attributes: CreateTenantAttributes, options?: RequestOptions) => Promise<Tenant>;
|
|
24013
24318
|
update: (id: string, attributes: UpdateTenantAttributes, options?: RequestOptions) => Promise<Tenant>;
|
|
24014
24319
|
schedulePurge: (id: string, options?: RequestOptions) => Promise<Tenant>;
|
|
@@ -24037,6 +24342,11 @@ declare class GptClient extends BaseClient {
|
|
|
24037
24342
|
listAllMe: (options?: RequestOptions) => Promise<Invitation[]>;
|
|
24038
24343
|
create: (attributes: CreateInvitationAttributes, options?: RequestOptions) => Promise<Invitation>;
|
|
24039
24344
|
resend: (id: string, applicationId?: string, options?: RequestOptions) => Promise<Invitation>;
|
|
24345
|
+
list: (options?: {
|
|
24346
|
+
page?: number;
|
|
24347
|
+
pageSize?: number;
|
|
24348
|
+
} & RequestOptions) => Promise<Invitation[]>;
|
|
24349
|
+
listAll: (options?: RequestOptions) => Promise<Invitation[]>;
|
|
24040
24350
|
consumeByToken: (token: string, options?: RequestOptions) => Promise<Invitation | null>;
|
|
24041
24351
|
acceptByToken: (token: string, options?: RequestOptions) => Promise<Invitation>;
|
|
24042
24352
|
};
|
|
@@ -25015,4 +25325,4 @@ type SocialAPI = ReturnType<typeof createSocialNamespace>;
|
|
|
25015
25325
|
type ModelsAPI = ReturnType<typeof createModelsNamespace>;
|
|
25016
25326
|
type MemoryAPI = ReturnType<typeof createMemoryNamespace>;
|
|
25017
25327
|
|
|
25018
|
-
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentDeployment, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComplianceFrameworkReadiness, type CompliancePosture, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type ListPracticeToolsParams, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, type PracticeToolCategory, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type SocialAPI, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TrendingSnapshot, type TrendingSnapshotItem, type TrendingWatch, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type Workspace, type WorkspaceAgentConfig, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|
|
25328
|
+
export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentDeployment, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, type CapacityCalculatorResponse, CardDeclinedError, type CommunicationAPI, type ComplianceFrameworkReadiness, type CompliancePosture, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type ListPracticeToolsParams, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, type PracticeToolCategory, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type SocialAPI, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TrendingSnapshot, type TrendingSnapshotItem, type TrendingWatch, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type Workspace, type WorkspaceAgentConfig, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
|