@nemphi/sdk 0.8.6830 → 0.8.6887
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/block-kit-state.d.ts +3 -3
- package/dist/block-kit-state.d.ts.map +1 -1
- package/dist/block-kit-state.js +33 -17
- package/dist/block-kit-state.js.map +1 -1
- package/dist/block-kit.d.ts +46 -46
- package/dist/block-kit.d.ts.map +1 -1
- package/dist/block-kit.js +10 -5
- package/dist/block-kit.js.map +1 -1
- package/dist/index.d.ts +670 -644
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +179 -113
- package/dist/index.js.map +1 -1
- package/dist/reactions.d.ts +1 -1
- package/dist/reactions.d.ts.map +1 -1
- package/dist/reactions.js +10 -5
- package/dist/reactions.js.map +1 -1
- package/dist/ui-spec.d.ts +3 -3
- package/dist/ui-spec.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -111,7 +111,7 @@ export interface Membership {
|
|
|
111
111
|
* A page offers an action (and a picker its «Crear…») only when its
|
|
112
112
|
* tool is here. Absent for built-in roles. The pipeline still decides.
|
|
113
113
|
*/
|
|
114
|
-
tools?: string
|
|
114
|
+
tools?: Array<string>;
|
|
115
115
|
/**
|
|
116
116
|
* When the workspace finished the profiling gate, or null while it
|
|
117
117
|
* still owes it answers. The app redirects to onboarding on null:
|
|
@@ -150,11 +150,11 @@ export interface WorkspaceProfile {
|
|
|
150
150
|
bookkeeping?: "none" | "spreadsheet" | "accountant" | "software";
|
|
151
151
|
has_employees: boolean;
|
|
152
152
|
/** Customer channels the business already uses (whatsapp, instagram, …). */
|
|
153
|
-
channels?: string
|
|
153
|
+
channels?: Array<string>;
|
|
154
154
|
/** Personal workspaces only. */
|
|
155
155
|
household?: string;
|
|
156
156
|
income?: string;
|
|
157
|
-
goals: string
|
|
157
|
+
goals: Array<string>;
|
|
158
158
|
autonomy: WorkspaceAutonomy;
|
|
159
159
|
guidance: WorkspaceGuidance;
|
|
160
160
|
}
|
|
@@ -167,24 +167,24 @@ export interface OnboardingQuestion {
|
|
|
167
167
|
/** Stable id; the dictionary keys its wording by this. */
|
|
168
168
|
id: string;
|
|
169
169
|
/** Option values, keyed "<id>.<option>" in the dictionary. */
|
|
170
|
-
options: string
|
|
170
|
+
options: Array<string>;
|
|
171
171
|
/** Several answers allowed. */
|
|
172
172
|
multiple?: boolean;
|
|
173
173
|
/** Asked once the workspace is open rather than by the gate. */
|
|
174
174
|
later?: boolean;
|
|
175
175
|
/** What has been answered so far. */
|
|
176
|
-
answers?: string
|
|
176
|
+
answers?: Array<string>;
|
|
177
177
|
}
|
|
178
178
|
/** The profiling gate's state: what applies, what is answered, what it means. */
|
|
179
179
|
export interface OnboardingState {
|
|
180
180
|
completed: boolean;
|
|
181
181
|
completed_at?: string;
|
|
182
|
-
questions: OnboardingQuestion
|
|
182
|
+
questions: Array<OnboardingQuestion>;
|
|
183
183
|
/** The gate's question ids still unanswered — the gate stays shut while non-empty. */
|
|
184
|
-
missing: string
|
|
184
|
+
missing: Array<string>;
|
|
185
185
|
profile: WorkspaceProfile;
|
|
186
186
|
/** Tool modules worth setting up for this workspace. */
|
|
187
|
-
modules: string
|
|
187
|
+
modules: Array<string>;
|
|
188
188
|
/** The autonomy level shown pre-selected: always the most cautious one. */
|
|
189
189
|
recommended_autonomy: WorkspaceAutonomy;
|
|
190
190
|
/**
|
|
@@ -193,7 +193,7 @@ export interface OnboardingState {
|
|
|
193
193
|
* until there is data to put in them.
|
|
194
194
|
*/
|
|
195
195
|
preview: {
|
|
196
|
-
blocks: CanvasBlock
|
|
196
|
+
blocks: Array<CanvasBlock>;
|
|
197
197
|
};
|
|
198
198
|
/** Set by onboarding.complete: autonomy rules written, canvas built. */
|
|
199
199
|
policies_seeded?: number;
|
|
@@ -211,18 +211,18 @@ export interface WorkspaceRole {
|
|
|
211
211
|
id: string;
|
|
212
212
|
name: string;
|
|
213
213
|
description?: string;
|
|
214
|
-
grants: RoleGrant
|
|
214
|
+
grants: Array<RoleGrant>;
|
|
215
215
|
members: number;
|
|
216
216
|
pending_invites: number;
|
|
217
217
|
created_at: string;
|
|
218
218
|
updated_at: string;
|
|
219
219
|
}
|
|
220
220
|
export interface RoleList {
|
|
221
|
-
builtin: {
|
|
221
|
+
builtin: Array<{
|
|
222
222
|
role: string;
|
|
223
223
|
access: string;
|
|
224
|
-
}
|
|
225
|
-
roles: WorkspaceRole
|
|
224
|
+
}>;
|
|
225
|
+
roles: Array<WorkspaceRole>;
|
|
226
226
|
}
|
|
227
227
|
export interface SessionResponse {
|
|
228
228
|
user: User;
|
|
@@ -238,7 +238,7 @@ export interface MfaChallenge {
|
|
|
238
238
|
/** Bearer token for completing this login, and nothing else. */
|
|
239
239
|
challenge: string;
|
|
240
240
|
expires_at: string;
|
|
241
|
-
methods: SecondFactor
|
|
241
|
+
methods: Array<SecondFactor>;
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
244
244
|
* What every first factor answers with — password, magic link, passkey
|
|
@@ -297,7 +297,7 @@ export interface SsoTarget {
|
|
|
297
297
|
export interface SsoLookup {
|
|
298
298
|
sso: SsoTarget | null;
|
|
299
299
|
/** Platform-wide social providers this deployment can offer. */
|
|
300
|
-
providers?:
|
|
300
|
+
providers?: Array<"google" | "microsoft">;
|
|
301
301
|
}
|
|
302
302
|
/** An identity provider connected to the current account. */
|
|
303
303
|
export interface ConnectedIdentity {
|
|
@@ -342,7 +342,7 @@ export interface OAuthConnectedApp {
|
|
|
342
342
|
logo_uri?: string;
|
|
343
343
|
tenant_id: string;
|
|
344
344
|
tenant_name: string;
|
|
345
|
-
scopes: string
|
|
345
|
+
scopes: Array<string>;
|
|
346
346
|
resource?: string;
|
|
347
347
|
access_expires_at: string;
|
|
348
348
|
refresh_expires_at?: string;
|
|
@@ -417,7 +417,7 @@ export interface RunQuestion {
|
|
|
417
417
|
question: string;
|
|
418
418
|
description?: string;
|
|
419
419
|
/** Choices to pick from; absent means a free-text answer. */
|
|
420
|
-
options?: RunQuestionOption
|
|
420
|
+
options?: Array<RunQuestionOption>;
|
|
421
421
|
/** Allow selecting more than one option. */
|
|
422
422
|
multiple?: boolean;
|
|
423
423
|
}
|
|
@@ -425,7 +425,7 @@ export interface RunQuestion {
|
|
|
425
425
|
export interface RunAnswer {
|
|
426
426
|
question: string;
|
|
427
427
|
/** Selected option labels, or a single free-text value. Empty = skipped. */
|
|
428
|
-
answer: string
|
|
428
|
+
answer: Array<string>;
|
|
429
429
|
}
|
|
430
430
|
/**
|
|
431
431
|
* A whole agent trace: every run of one delegation tree, each with its
|
|
@@ -451,7 +451,7 @@ export interface RunTrace {
|
|
|
451
451
|
/** True when the tree hit the server's run or step cap and spans were left out. */
|
|
452
452
|
truncated: boolean;
|
|
453
453
|
/** Every run of the tree, roots first, each with `steps` and `agent_name` set. */
|
|
454
|
-
runs: Run
|
|
454
|
+
runs: Array<Run>;
|
|
455
455
|
}
|
|
456
456
|
export interface AnswerResult {
|
|
457
457
|
run_id: string;
|
|
@@ -496,9 +496,9 @@ export interface Run {
|
|
|
496
496
|
max_duration_ms: number;
|
|
497
497
|
/** Working time consumed so far: LLM turns plus tool calls, excluding parked time. */
|
|
498
498
|
used_duration_ms: number;
|
|
499
|
-
steps?: RunStep
|
|
499
|
+
steps?: Array<RunStep>;
|
|
500
500
|
/** Set on the run detail endpoint: child runs this run spawned (agents.delegate / agents.ask). */
|
|
501
|
-
children?: Run
|
|
501
|
+
children?: Array<Run>;
|
|
502
502
|
/** Position in the delegation tree; omitted (0) for roots. */
|
|
503
503
|
depth?: number;
|
|
504
504
|
/** The run whose delegate call spawned this one. */
|
|
@@ -514,7 +514,7 @@ export interface Run {
|
|
|
514
514
|
* they wanted mailed about). Empty means in-app only, which is where
|
|
515
515
|
* every run reports regardless.
|
|
516
516
|
*/
|
|
517
|
-
notify_channels?: NotificationChannel
|
|
517
|
+
notify_channels?: Array<NotificationChannel>;
|
|
518
518
|
/** W3C trace id of the run's OpenTelemetry trace: every span of the run and its delegation tree shares it. Set once the first traced span exists. */
|
|
519
519
|
trace_id?: string;
|
|
520
520
|
created_at: string;
|
|
@@ -541,7 +541,7 @@ export interface Routine {
|
|
|
541
541
|
tool_pattern: string;
|
|
542
542
|
event_filter: RoutineFilter;
|
|
543
543
|
webhook_key_hint: string;
|
|
544
|
-
notify_channels: NotificationChannel
|
|
544
|
+
notify_channels: Array<NotificationChannel>;
|
|
545
545
|
created_at: string;
|
|
546
546
|
updated_at: string;
|
|
547
547
|
}
|
|
@@ -555,7 +555,7 @@ export interface RoutineRun {
|
|
|
555
555
|
error: string;
|
|
556
556
|
}
|
|
557
557
|
export interface RoutineDetail extends Routine {
|
|
558
|
-
runs: RoutineRun
|
|
558
|
+
runs: Array<RoutineRun>;
|
|
559
559
|
}
|
|
560
560
|
export interface RoutineListInput {
|
|
561
561
|
agent?: string;
|
|
@@ -574,7 +574,7 @@ export interface SaveRoutineInput {
|
|
|
574
574
|
cron?: string;
|
|
575
575
|
tool_pattern?: string;
|
|
576
576
|
filter?: RoutineFilter;
|
|
577
|
-
notify_channels?: NotificationChannel
|
|
577
|
+
notify_channels?: Array<NotificationChannel>;
|
|
578
578
|
enabled?: boolean;
|
|
579
579
|
}
|
|
580
580
|
export interface ApprovalDecision {
|
|
@@ -613,7 +613,7 @@ export interface Notification {
|
|
|
613
613
|
approval_id?: string;
|
|
614
614
|
data?: unknown;
|
|
615
615
|
/** External channels the raising task asked for, on top of the member's own destination. */
|
|
616
|
-
channels?: NotificationChannel
|
|
616
|
+
channels?: Array<NotificationChannel>;
|
|
617
617
|
read: boolean;
|
|
618
618
|
resolved: boolean;
|
|
619
619
|
created_at: string;
|
|
@@ -667,7 +667,8 @@ export type RealtimeEvent = {
|
|
|
667
667
|
type: "notification";
|
|
668
668
|
user_id: string;
|
|
669
669
|
id: string;
|
|
670
|
-
|
|
670
|
+
/** A {@link NotificationKind}, or a kind this SDK does not know yet. */
|
|
671
|
+
kind: string;
|
|
671
672
|
} | {
|
|
672
673
|
type: "marketing";
|
|
673
674
|
conversation_id: string;
|
|
@@ -687,7 +688,7 @@ export type RealtimeEvent = {
|
|
|
687
688
|
} | {
|
|
688
689
|
type: "presence";
|
|
689
690
|
/** Member ids with at least one open connection to the workspace. */
|
|
690
|
-
users: string
|
|
691
|
+
users: Array<string>;
|
|
691
692
|
} | {
|
|
692
693
|
type: "change";
|
|
693
694
|
/**
|
|
@@ -788,7 +789,7 @@ export interface InboxApproval {
|
|
|
788
789
|
}
|
|
789
790
|
export interface InboxQuestion {
|
|
790
791
|
run_id: string;
|
|
791
|
-
questions: RunQuestion
|
|
792
|
+
questions: Array<RunQuestion> | null;
|
|
792
793
|
goal: string;
|
|
793
794
|
/** What the run is about as a person reads it ("" when it names nothing). */
|
|
794
795
|
title?: string;
|
|
@@ -818,10 +819,10 @@ export interface Inbox {
|
|
|
818
819
|
* row's own `can_decide`: follow the row.
|
|
819
820
|
*/
|
|
820
821
|
can_decide: boolean;
|
|
821
|
-
pending_approvals: InboxApproval
|
|
822
|
-
pending_questions: InboxQuestion
|
|
823
|
-
policy_suggestions: PolicySuggestion
|
|
824
|
-
notifications: Notification
|
|
822
|
+
pending_approvals: Array<InboxApproval>;
|
|
823
|
+
pending_questions: Array<InboxQuestion>;
|
|
824
|
+
policy_suggestions: Array<PolicySuggestion>;
|
|
825
|
+
notifications: Array<Notification>;
|
|
825
826
|
unread: number;
|
|
826
827
|
}
|
|
827
828
|
export type NotificationChannel = "email" | "whatsapp";
|
|
@@ -851,7 +852,7 @@ export interface MessageNotifyPrefs {
|
|
|
851
852
|
mobile?: MessageGlobalNotifyPref;
|
|
852
853
|
suppress_channel_mentions?: boolean;
|
|
853
854
|
threads_everything?: boolean;
|
|
854
|
-
highlight_words?: string
|
|
855
|
+
highlight_words?: Array<string>;
|
|
855
856
|
mark_channel_read_on_desktop?: boolean;
|
|
856
857
|
dnd?: MessageDnDPrefs;
|
|
857
858
|
}
|
|
@@ -859,16 +860,16 @@ export interface NotificationPrefs {
|
|
|
859
860
|
/** Per-kind delivery: app (default), email, WhatsApp, both, or none (muted). */
|
|
860
861
|
destinations: Partial<Record<NotificationKind, NotificationDestination>>;
|
|
861
862
|
/** Derived: union of channels across destinations (legacy). */
|
|
862
|
-
channels: NotificationChannel
|
|
863
|
+
channels: Array<NotificationChannel>;
|
|
863
864
|
/** Derived: kinds whose destination is not none. */
|
|
864
|
-
kinds: NotificationKind
|
|
865
|
+
kinds: Array<NotificationKind>;
|
|
865
866
|
/** Kinds this member may enable (owners/admins: all; members: the workspace allowlist). */
|
|
866
|
-
available_kinds: NotificationKind
|
|
867
|
+
available_kinds: Array<NotificationKind>;
|
|
867
868
|
/** Kinds this member cannot turn off (approvals/questions for owners/admins). */
|
|
868
|
-
locked_kinds: NotificationKind
|
|
869
|
+
locked_kinds: Array<NotificationKind>;
|
|
869
870
|
phone: string | null;
|
|
870
871
|
phone_verified: boolean;
|
|
871
|
-
available_channels: NotificationChannel
|
|
872
|
+
available_channels: Array<NotificationChannel>;
|
|
872
873
|
whatsapp_enabled: boolean;
|
|
873
874
|
/** Chat notification decision dials (mute/DnD/mentions/threads). */
|
|
874
875
|
message_notify: MessageNotifyPrefs;
|
|
@@ -876,9 +877,9 @@ export interface NotificationPrefs {
|
|
|
876
877
|
/** Workspace-level notification settings (owner/admin only). */
|
|
877
878
|
export interface WorkspaceNotificationSettings {
|
|
878
879
|
/** Kinds plain members may receive; owners/admins always have the full set. */
|
|
879
|
-
member_kinds: NotificationKind
|
|
880
|
+
member_kinds: Array<NotificationKind>;
|
|
880
881
|
/** Every kind the platform knows, in display order. */
|
|
881
|
-
kinds: NotificationKind
|
|
882
|
+
kinds: Array<NotificationKind>;
|
|
882
883
|
}
|
|
883
884
|
export interface BankTransaction {
|
|
884
885
|
id: string;
|
|
@@ -895,7 +896,7 @@ export interface BankTransaction {
|
|
|
895
896
|
matched_id?: string;
|
|
896
897
|
payment_id?: string;
|
|
897
898
|
created_at: string;
|
|
898
|
-
candidates?: BankCandidate
|
|
899
|
+
candidates?: Array<BankCandidate>;
|
|
899
900
|
}
|
|
900
901
|
export interface BankCandidate {
|
|
901
902
|
kind: "invoice" | "bill";
|
|
@@ -918,7 +919,7 @@ export interface BankSummary {
|
|
|
918
919
|
oldest_unmatched?: string | null;
|
|
919
920
|
}
|
|
920
921
|
export interface BankTransactionsResponse {
|
|
921
|
-
transactions: BankTransaction
|
|
922
|
+
transactions: Array<BankTransaction>;
|
|
922
923
|
summary: BankSummary;
|
|
923
924
|
}
|
|
924
925
|
export type FixedAssetCategory = "land" | "building" | "machinery" | "vehicle" | "computer" | "furniture" | "intangible" | "other";
|
|
@@ -996,7 +997,7 @@ export interface FixedAssetSummaryRow {
|
|
|
996
997
|
export interface FixedAssetSummary {
|
|
997
998
|
as_of: string;
|
|
998
999
|
currency: string;
|
|
999
|
-
categories: FixedAssetSummaryRow
|
|
1000
|
+
categories: Array<FixedAssetSummaryRow>;
|
|
1000
1001
|
totals: {
|
|
1001
1002
|
asset_count: number;
|
|
1002
1003
|
cost_cents: number;
|
|
@@ -1028,7 +1029,7 @@ export interface DepreciationRunResult {
|
|
|
1028
1029
|
period: string;
|
|
1029
1030
|
currency: string;
|
|
1030
1031
|
journal_entry: JournalEntry | null;
|
|
1031
|
-
depreciated: {
|
|
1032
|
+
depreciated: Array<{
|
|
1032
1033
|
asset_id: string;
|
|
1033
1034
|
name: string;
|
|
1034
1035
|
code: string | null;
|
|
@@ -1037,7 +1038,7 @@ export interface DepreciationRunResult {
|
|
|
1037
1038
|
accumulated_cents: number;
|
|
1038
1039
|
book_value_cents: number;
|
|
1039
1040
|
fully_depreciated: boolean;
|
|
1040
|
-
}
|
|
1041
|
+
}>;
|
|
1041
1042
|
skipped: number;
|
|
1042
1043
|
total_cents: number;
|
|
1043
1044
|
}
|
|
@@ -1138,8 +1139,8 @@ export interface Liquidation {
|
|
|
1138
1139
|
base_prestaciones_cents: number;
|
|
1139
1140
|
indemnity_days: number;
|
|
1140
1141
|
seniority_days: number;
|
|
1141
|
-
steps: string
|
|
1142
|
-
warnings?: string
|
|
1142
|
+
steps: Array<string>;
|
|
1143
|
+
warnings?: Array<string>;
|
|
1143
1144
|
params_source: string;
|
|
1144
1145
|
termination_reason: string;
|
|
1145
1146
|
}
|
|
@@ -1218,11 +1219,11 @@ export interface PayslipTrace {
|
|
|
1218
1219
|
bracket: string;
|
|
1219
1220
|
tax_uvt: number;
|
|
1220
1221
|
tax_cents: number;
|
|
1221
|
-
steps: string
|
|
1222
|
+
steps: Array<string>;
|
|
1222
1223
|
};
|
|
1223
|
-
steps: string
|
|
1224
|
-
warnings?: string
|
|
1225
|
-
notes?: string
|
|
1224
|
+
steps: Array<string>;
|
|
1225
|
+
warnings?: Array<string>;
|
|
1226
|
+
notes?: Array<string>;
|
|
1226
1227
|
period_days: number;
|
|
1227
1228
|
contract_type: ContractType;
|
|
1228
1229
|
salary_type: SalaryType;
|
|
@@ -1296,7 +1297,7 @@ export interface PayrollParameters {
|
|
|
1296
1297
|
year: number;
|
|
1297
1298
|
currency: string;
|
|
1298
1299
|
source?: string;
|
|
1299
|
-
notes?: string
|
|
1300
|
+
notes?: Array<string>;
|
|
1300
1301
|
smmlv_cents: number;
|
|
1301
1302
|
transport_allowance_cents: number;
|
|
1302
1303
|
uvt_cents: number;
|
|
@@ -1312,15 +1313,15 @@ export interface PayrollParameters {
|
|
|
1312
1313
|
health_employer_rate: number;
|
|
1313
1314
|
pension_employee_rate: number;
|
|
1314
1315
|
pension_employer_rate: number;
|
|
1315
|
-
arl_rates: number
|
|
1316
|
+
arl_rates: Array<number>;
|
|
1316
1317
|
sena_rate: number;
|
|
1317
1318
|
icbf_rate: number;
|
|
1318
1319
|
ccf_rate: number;
|
|
1319
|
-
solidarity_fund: {
|
|
1320
|
+
solidarity_fund: Array<{
|
|
1320
1321
|
from_smmlv: number;
|
|
1321
1322
|
to_smmlv: number;
|
|
1322
1323
|
rate: number;
|
|
1323
|
-
}
|
|
1324
|
+
}>;
|
|
1324
1325
|
cesantias_rate: number;
|
|
1325
1326
|
intereses_cesantias_rate: number;
|
|
1326
1327
|
prima_rate: number;
|
|
@@ -1343,12 +1344,12 @@ export interface PayrollParameters {
|
|
|
1343
1344
|
exempt_cap_uvt_annual: number;
|
|
1344
1345
|
total_cap_rate: number;
|
|
1345
1346
|
total_cap_uvt_annual: number;
|
|
1346
|
-
brackets: {
|
|
1347
|
+
brackets: Array<{
|
|
1347
1348
|
from_uvt: number;
|
|
1348
1349
|
to_uvt: number;
|
|
1349
1350
|
rate: number;
|
|
1350
1351
|
add_uvt: number;
|
|
1351
|
-
}
|
|
1352
|
+
}>;
|
|
1352
1353
|
};
|
|
1353
1354
|
indemnity: {
|
|
1354
1355
|
low_first_year_days: number;
|
|
@@ -1377,12 +1378,12 @@ export interface PayrollParametersResult {
|
|
|
1377
1378
|
country: string;
|
|
1378
1379
|
year: number;
|
|
1379
1380
|
/** Keys the workspace overrides on top of the built-in defaults. */
|
|
1380
|
-
override_keys: string
|
|
1381
|
+
override_keys: Array<string> | null;
|
|
1381
1382
|
overrides: JsonObject;
|
|
1382
|
-
known_default_years: number
|
|
1383
|
-
keys: string
|
|
1383
|
+
known_default_years: Array<number> | null;
|
|
1384
|
+
keys: Array<string>;
|
|
1384
1385
|
/** The dial catalog, in display order. */
|
|
1385
|
-
schema: PayrollParamField
|
|
1386
|
+
schema: Array<PayrollParamField>;
|
|
1386
1387
|
/** The year's values with no workspace overrides (country defaults + platform row). */
|
|
1387
1388
|
defaults?: PayrollParameters;
|
|
1388
1389
|
effective?: PayrollParameters;
|
|
@@ -1404,19 +1405,19 @@ export interface PayslipSummary {
|
|
|
1404
1405
|
export interface PayrollCalculateResult {
|
|
1405
1406
|
run: PayrollRun;
|
|
1406
1407
|
totals: PayrollRunTotals;
|
|
1407
|
-
payslips: PayslipSummary
|
|
1408
|
-
skipped: {
|
|
1408
|
+
payslips: Array<PayslipSummary>;
|
|
1409
|
+
skipped: Array<{
|
|
1409
1410
|
employee_id: string;
|
|
1410
1411
|
name: string;
|
|
1411
1412
|
reason: string;
|
|
1412
|
-
}
|
|
1413
|
-
warnings: {
|
|
1413
|
+
}> | null;
|
|
1414
|
+
warnings: Array<{
|
|
1414
1415
|
employee_id: string;
|
|
1415
1416
|
name: string;
|
|
1416
1417
|
warning: string;
|
|
1417
|
-
}
|
|
1418
|
+
}> | null;
|
|
1418
1419
|
parameters_source: string;
|
|
1419
|
-
parameter_notes: string
|
|
1420
|
+
parameter_notes: Array<string> | null;
|
|
1420
1421
|
}
|
|
1421
1422
|
export interface PayrollPostResult {
|
|
1422
1423
|
run: PayrollRun;
|
|
@@ -1444,7 +1445,7 @@ export interface PayrollPayResult {
|
|
|
1444
1445
|
employee?: Employee;
|
|
1445
1446
|
journal_entry: JournalEntry;
|
|
1446
1447
|
total_cents: number;
|
|
1447
|
-
payments: PayrollPaymentRow
|
|
1448
|
+
payments: Array<PayrollPaymentRow>;
|
|
1448
1449
|
remaining_unpaid?: number;
|
|
1449
1450
|
payment_date?: string;
|
|
1450
1451
|
}
|
|
@@ -1484,9 +1485,9 @@ export interface PilaRow {
|
|
|
1484
1485
|
export interface PilaSummary {
|
|
1485
1486
|
period: string;
|
|
1486
1487
|
currency: string;
|
|
1487
|
-
runs: string
|
|
1488
|
-
draft_runs: string
|
|
1489
|
-
employees: PilaRow
|
|
1488
|
+
runs: Array<string>;
|
|
1489
|
+
draft_runs: Array<string> | null;
|
|
1490
|
+
employees: Array<PilaRow> | null;
|
|
1490
1491
|
totals: PilaRow;
|
|
1491
1492
|
/** Ready-to-upload CSV for the PILA operator. */
|
|
1492
1493
|
csv: string;
|
|
@@ -1562,7 +1563,7 @@ export interface BudgetLine {
|
|
|
1562
1563
|
starts_on: string;
|
|
1563
1564
|
ends_on: string | null;
|
|
1564
1565
|
archived: boolean;
|
|
1565
|
-
months: BudgetMonth
|
|
1566
|
+
months: Array<BudgetMonth>;
|
|
1566
1567
|
}
|
|
1567
1568
|
/** The budget planner's year (`budget.overview`). */
|
|
1568
1569
|
export interface BudgetOverview {
|
|
@@ -1570,7 +1571,7 @@ export interface BudgetOverview {
|
|
|
1570
1571
|
today: string;
|
|
1571
1572
|
/** Caja y bancos at the close of the day before the year opens. */
|
|
1572
1573
|
opening_cash_cents: number;
|
|
1573
|
-
lines: BudgetLine
|
|
1574
|
+
lines: Array<BudgetLine>;
|
|
1574
1575
|
}
|
|
1575
1576
|
export interface RecurringDocument {
|
|
1576
1577
|
id: string;
|
|
@@ -1611,7 +1612,7 @@ export interface Policy {
|
|
|
1611
1612
|
updated_at: string;
|
|
1612
1613
|
}
|
|
1613
1614
|
export interface PolicyList {
|
|
1614
|
-
policies: Policy
|
|
1615
|
+
policies: Array<Policy>;
|
|
1615
1616
|
/** The platform's default per tool when no policy matches, the class policy included. */
|
|
1616
1617
|
defaults: Record<string, "allow" | "require_approval">;
|
|
1617
1618
|
/**
|
|
@@ -1625,7 +1626,7 @@ export interface PolicyList {
|
|
|
1625
1626
|
* covers them: under "up to an amount" they always ask. Absent from an
|
|
1626
1627
|
* older platform.
|
|
1627
1628
|
*/
|
|
1628
|
-
amountless?: string
|
|
1629
|
+
amountless?: Array<string>;
|
|
1629
1630
|
}
|
|
1630
1631
|
export interface ActionPreview {
|
|
1631
1632
|
action: "approve" | "deny";
|
|
@@ -1665,7 +1666,7 @@ export interface LiveDocumentFile {
|
|
|
1665
1666
|
* the run the reading started (`/dashboard/runs/{run_id}`).
|
|
1666
1667
|
*/
|
|
1667
1668
|
export interface LiveDocumentFileWork {
|
|
1668
|
-
actions: ThreadActionRow
|
|
1669
|
+
actions: Array<ThreadActionRow>;
|
|
1669
1670
|
more: number;
|
|
1670
1671
|
run_id: string;
|
|
1671
1672
|
run_status: string;
|
|
@@ -1673,11 +1674,11 @@ export interface LiveDocumentFileWork {
|
|
|
1673
1674
|
/** What the books keep a document as support of: deleting its Docs file keeps it. */
|
|
1674
1675
|
export interface DocumentSupport {
|
|
1675
1676
|
/** Bills filed or made from it. */
|
|
1676
|
-
bills: {
|
|
1677
|
+
bills: Array<{
|
|
1677
1678
|
id: string;
|
|
1678
1679
|
number: string;
|
|
1679
1680
|
vendor: string;
|
|
1680
|
-
}
|
|
1681
|
+
}>;
|
|
1681
1682
|
/** Bank movements imported from it. */
|
|
1682
1683
|
bank_transactions: number;
|
|
1683
1684
|
/** Whether it is an e-invoice artifact the DIAN validated. */
|
|
@@ -1696,9 +1697,9 @@ export interface DocumentWorkRun {
|
|
|
1696
1697
|
/** What Nemphi did with a document after reading it (`documents.work`). */
|
|
1697
1698
|
export interface DocumentWork {
|
|
1698
1699
|
document_id: string;
|
|
1699
|
-
runs: DocumentWorkRun
|
|
1700
|
+
runs: Array<DocumentWorkRun>;
|
|
1700
1701
|
/** Every record its runs made or changed, oldest first. */
|
|
1701
|
-
actions: ThreadActionRow
|
|
1702
|
+
actions: Array<ThreadActionRow>;
|
|
1702
1703
|
support: DocumentSupport;
|
|
1703
1704
|
}
|
|
1704
1705
|
/** A document the books keep as support outside Docs, as `documents.support` lists it. */
|
|
@@ -1713,7 +1714,7 @@ export interface SupportDocument {
|
|
|
1713
1714
|
}
|
|
1714
1715
|
/** The documents kept as support outside Docs (`documents.support`), at most 50. */
|
|
1715
1716
|
export interface SupportDocuments {
|
|
1716
|
-
documents: SupportDocument
|
|
1717
|
+
documents: Array<SupportDocument>;
|
|
1717
1718
|
/** More are kept than listed. */
|
|
1718
1719
|
more: boolean;
|
|
1719
1720
|
}
|
|
@@ -1775,7 +1776,7 @@ export interface LiveDocument {
|
|
|
1775
1776
|
file: LiveDocumentFile | null;
|
|
1776
1777
|
/** Whether the caller owns it: a personal document they created. */
|
|
1777
1778
|
owned: boolean;
|
|
1778
|
-
tags: LiveDocumentTag
|
|
1779
|
+
tags: Array<LiveDocumentTag>;
|
|
1779
1780
|
created_at: string;
|
|
1780
1781
|
updated_at: string;
|
|
1781
1782
|
/** When it went to the trash; null while it is on a shelf. */
|
|
@@ -1848,7 +1849,7 @@ export interface FileSyncMoveInput {
|
|
|
1848
1849
|
}
|
|
1849
1850
|
/** A page of `filesync.changes`: keep calling with `cursor` while `has_more`; `reset` means list again. */
|
|
1850
1851
|
export interface FileSyncPage {
|
|
1851
|
-
items: FileSyncItem
|
|
1852
|
+
items: Array<FileSyncItem>;
|
|
1852
1853
|
cursor: string;
|
|
1853
1854
|
has_more: boolean;
|
|
1854
1855
|
reset: boolean;
|
|
@@ -1859,11 +1860,11 @@ export interface LiveDocumentShares {
|
|
|
1859
1860
|
space: LiveDocumentSpace;
|
|
1860
1861
|
owner_id: string | null;
|
|
1861
1862
|
owned: boolean;
|
|
1862
|
-
shares: {
|
|
1863
|
+
shares: Array<{
|
|
1863
1864
|
user_id: string;
|
|
1864
1865
|
name: string;
|
|
1865
1866
|
email: string;
|
|
1866
|
-
}
|
|
1867
|
+
}>;
|
|
1867
1868
|
}
|
|
1868
1869
|
/** What a comment's @-mentions told (`knowledge.mention_in_comment`). */
|
|
1869
1870
|
export interface LiveDocumentMentions {
|
|
@@ -1871,17 +1872,17 @@ export interface LiveDocumentMentions {
|
|
|
1871
1872
|
thread_id: string;
|
|
1872
1873
|
comment_id: string;
|
|
1873
1874
|
/** The members named who can open the document. */
|
|
1874
|
-
mentioned: string
|
|
1875
|
+
mentioned: Array<string>;
|
|
1875
1876
|
/** Those this comment had not told before, now notified. */
|
|
1876
|
-
notified: string
|
|
1877
|
+
notified: Array<string>;
|
|
1877
1878
|
/** Members the document is closed to, told nothing. */
|
|
1878
|
-
skipped: string
|
|
1879
|
+
skipped: Array<string>;
|
|
1879
1880
|
}
|
|
1880
1881
|
/** One comment's mentions, as `mentionInLiveDocumentComment` sends them. */
|
|
1881
1882
|
export interface LiveDocumentMentionInput {
|
|
1882
1883
|
thread_id: string;
|
|
1883
1884
|
comment_id: string;
|
|
1884
|
-
user_ids: string
|
|
1885
|
+
user_ids: Array<string>;
|
|
1885
1886
|
/** The comment's words, quoted in the notification. */
|
|
1886
1887
|
text?: string;
|
|
1887
1888
|
}
|
|
@@ -1889,7 +1890,7 @@ export interface LiveDocumentMentionInput {
|
|
|
1889
1890
|
export type TransferExpiryDays = 1 | 3 | 7 | 14 | 30;
|
|
1890
1891
|
/** What `createTransfer` sends (`transfers.create`). */
|
|
1891
1892
|
export interface TransferInput {
|
|
1892
|
-
live_document_ids: string
|
|
1893
|
+
live_document_ids: Array<string>;
|
|
1893
1894
|
/** The first document's title by default. */
|
|
1894
1895
|
title?: string;
|
|
1895
1896
|
message?: string;
|
|
@@ -1898,7 +1899,7 @@ export interface TransferInput {
|
|
|
1898
1899
|
/** 6 to 72 characters; none by default. */
|
|
1899
1900
|
password?: string;
|
|
1900
1901
|
/** Addresses mailed the link. */
|
|
1901
|
-
recipients?: string
|
|
1902
|
+
recipients?: Array<string>;
|
|
1902
1903
|
}
|
|
1903
1904
|
/** One document a transfer carries. */
|
|
1904
1905
|
export interface TransferItem {
|
|
@@ -1915,8 +1916,8 @@ export interface CreatedTransfer {
|
|
|
1915
1916
|
title: string;
|
|
1916
1917
|
expires_at: string;
|
|
1917
1918
|
locked: boolean;
|
|
1918
|
-
items: TransferItem
|
|
1919
|
-
recipients: string
|
|
1919
|
+
items: Array<TransferItem>;
|
|
1920
|
+
recipients: Array<string>;
|
|
1920
1921
|
}
|
|
1921
1922
|
/** One of the caller's transfers (`transfers.list`). The link is not kept. */
|
|
1922
1923
|
export interface Transfer {
|
|
@@ -1931,7 +1932,7 @@ export interface Transfer {
|
|
|
1931
1932
|
revoked_at: string | null;
|
|
1932
1933
|
download_count: number;
|
|
1933
1934
|
created_at: string;
|
|
1934
|
-
items: TransferItem
|
|
1935
|
+
items: Array<TransferItem>;
|
|
1935
1936
|
}
|
|
1936
1937
|
/** One document on a transfer's public page. */
|
|
1937
1938
|
export interface PublicTransferItem {
|
|
@@ -1948,12 +1949,12 @@ export interface PublicTransfer {
|
|
|
1948
1949
|
sender_name: string;
|
|
1949
1950
|
expires_at: string;
|
|
1950
1951
|
locked: boolean;
|
|
1951
|
-
items?: PublicTransferItem
|
|
1952
|
+
items?: Array<PublicTransferItem>;
|
|
1952
1953
|
}
|
|
1953
1954
|
/** An unlocked transfer: the key its downloads carry for an hour. */
|
|
1954
1955
|
export interface UnlockedTransfer {
|
|
1955
1956
|
key: string;
|
|
1956
|
-
items: PublicTransferItem
|
|
1957
|
+
items: Array<PublicTransferItem>;
|
|
1957
1958
|
}
|
|
1958
1959
|
/** One of the workspace's document tags and what it means. */
|
|
1959
1960
|
export interface LiveDocumentWorkspaceTag {
|
|
@@ -2076,8 +2077,8 @@ export interface CompanyProfile {
|
|
|
2076
2077
|
person_type: "natural" | "juridica" | "";
|
|
2077
2078
|
legal_form: string;
|
|
2078
2079
|
ciiu_primary: string;
|
|
2079
|
-
ciiu_secondary: string
|
|
2080
|
-
fiscal_responsibilities: string
|
|
2080
|
+
ciiu_secondary: Array<string>;
|
|
2081
|
+
fiscal_responsibilities: Array<string>;
|
|
2081
2082
|
municipality_code: string;
|
|
2082
2083
|
city: string;
|
|
2083
2084
|
address: string;
|
|
@@ -2096,14 +2097,14 @@ export interface CompanyProfile {
|
|
|
2096
2097
|
export interface CompanyProfileResponse {
|
|
2097
2098
|
profile: CompanyProfile;
|
|
2098
2099
|
/** Identity fields still unknown (legal_name, tax_id, person_type, legal_form, ciiu_primary). */
|
|
2099
|
-
missing: string
|
|
2100
|
+
missing: Array<string>;
|
|
2100
2101
|
/** Which registration document to ask the owner for, by tenant country. */
|
|
2101
2102
|
document_request: {
|
|
2102
2103
|
document: string;
|
|
2103
2104
|
kind: CompanyDocumentKind;
|
|
2104
2105
|
why: string;
|
|
2105
2106
|
};
|
|
2106
|
-
warnings: string
|
|
2107
|
+
warnings: Array<string>;
|
|
2107
2108
|
}
|
|
2108
2109
|
/** Result of uploading a company logo (`POST /v1/company/logo`). */
|
|
2109
2110
|
export interface CompanyLogo {
|
|
@@ -2175,7 +2176,7 @@ export interface SupportTicketSummary extends SupportTicket {
|
|
|
2175
2176
|
}
|
|
2176
2177
|
/** support.tickets: one tab's tickets and how many each tab holds. */
|
|
2177
2178
|
export interface SupportTicketList {
|
|
2178
|
-
tickets: SupportTicketSummary
|
|
2179
|
+
tickets: Array<SupportTicketSummary>;
|
|
2179
2180
|
counts?: {
|
|
2180
2181
|
open: number;
|
|
2181
2182
|
closed: number;
|
|
@@ -2195,7 +2196,7 @@ export interface SupportMessage {
|
|
|
2195
2196
|
created_at: string;
|
|
2196
2197
|
}
|
|
2197
2198
|
export interface SupportThread extends SupportTicket {
|
|
2198
|
-
messages: SupportMessage
|
|
2199
|
+
messages: Array<SupportMessage>;
|
|
2199
2200
|
}
|
|
2200
2201
|
/** Hosted websites (`sites.*` tools): {slug}.site.nemphi.app + custom domains. */
|
|
2201
2202
|
export type SiteStatus = "draft" | "published" | "pending_deletion";
|
|
@@ -2206,7 +2207,8 @@ export interface Site {
|
|
|
2206
2207
|
tenant_id: string;
|
|
2207
2208
|
slug: string;
|
|
2208
2209
|
name: string;
|
|
2209
|
-
|
|
2210
|
+
/** A {@link SiteStatus}, or a value this SDK does not know yet. */
|
|
2211
|
+
status: string;
|
|
2210
2212
|
default_path: string;
|
|
2211
2213
|
/** Serving revision: advances with every file put/delete and publish. */
|
|
2212
2214
|
content_version?: number;
|
|
@@ -2244,15 +2246,17 @@ export interface SiteDomain {
|
|
|
2244
2246
|
tenant_id: string;
|
|
2245
2247
|
site_id: string;
|
|
2246
2248
|
hostname: string;
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
+
/** A {@link SiteDomainKind}, or a value this SDK does not know yet. */
|
|
2250
|
+
kind: string;
|
|
2251
|
+
/** A {@link SiteDomainStatus}, or a value this SDK does not know yet. */
|
|
2252
|
+
status: string;
|
|
2249
2253
|
is_primary: boolean;
|
|
2250
2254
|
/** Provider attachment ID, such as a Cloudflare custom hostname ID. */
|
|
2251
2255
|
edge_ref: string | null;
|
|
2252
2256
|
/** Stored provider name; current attachments use "cloudflare". */
|
|
2253
2257
|
edge_provider: string | null;
|
|
2254
2258
|
/** JSON bytes from Go — usually a base64 string of SiteDNSRecord[]. */
|
|
2255
|
-
dns_records: string | SiteDNSRecord
|
|
2259
|
+
dns_records: string | Array<SiteDNSRecord> | null;
|
|
2256
2260
|
purchase_registrar: string | null;
|
|
2257
2261
|
purchase_order_id: string | null;
|
|
2258
2262
|
/** The one-year registration price the approver authorized. */
|
|
@@ -2273,7 +2277,8 @@ export interface SiteDomain {
|
|
|
2273
2277
|
export interface SiteDomainListing extends SiteDomain {
|
|
2274
2278
|
site_name: string;
|
|
2275
2279
|
site_slug: string;
|
|
2276
|
-
|
|
2280
|
+
/** A {@link SiteStatus}, or a value this SDK does not know yet. */
|
|
2281
|
+
site_status: string;
|
|
2277
2282
|
}
|
|
2278
2283
|
/** Cloudflare's DNS record types the zone editor offers. */
|
|
2279
2284
|
export type SiteZoneRecordType = "A" | "AAAA" | "CNAME" | "TXT" | "MX" | "NS" | "SRV" | "CAA";
|
|
@@ -2290,7 +2295,8 @@ export interface SiteZoneRecord {
|
|
|
2290
2295
|
zone_name: string;
|
|
2291
2296
|
/** Cloudflare's record id; empty until the record reaches the provider. */
|
|
2292
2297
|
provider_ref: string;
|
|
2293
|
-
|
|
2298
|
+
/** A {@link SiteZoneRecordType}, or a value this SDK does not know yet. */
|
|
2299
|
+
type: string;
|
|
2294
2300
|
/** Fully-qualified record name, e.g. "www.acme.com". */
|
|
2295
2301
|
name: string;
|
|
2296
2302
|
content: string;
|
|
@@ -2299,7 +2305,8 @@ export interface SiteZoneRecord {
|
|
|
2299
2305
|
priority: number | null;
|
|
2300
2306
|
proxied: boolean;
|
|
2301
2307
|
comment: string;
|
|
2302
|
-
|
|
2308
|
+
/** A {@link SiteZoneRecordStatus}, or a value this SDK does not know yet. */
|
|
2309
|
+
status: string;
|
|
2303
2310
|
/** false for the records that keep the site reachable; the manager shows them read-only. */
|
|
2304
2311
|
editable: boolean;
|
|
2305
2312
|
last_error: string | null;
|
|
@@ -2317,7 +2324,7 @@ export interface SiteZone {
|
|
|
2317
2324
|
export interface SiteZoneRecords {
|
|
2318
2325
|
domain: SiteDomain;
|
|
2319
2326
|
zone: SiteZone | null;
|
|
2320
|
-
records: SiteZoneRecord
|
|
2327
|
+
records: Array<SiteZoneRecord>;
|
|
2321
2328
|
}
|
|
2322
2329
|
/** Registrar answer inside `sites.check_domain` output. */
|
|
2323
2330
|
export interface SiteDomainAvailability {
|
|
@@ -2364,7 +2371,8 @@ export interface SiteFile {
|
|
|
2364
2371
|
/** Traffic and publish stats from `sites.stats`. */
|
|
2365
2372
|
export interface SiteStats {
|
|
2366
2373
|
site_id: string;
|
|
2367
|
-
|
|
2374
|
+
/** A {@link SiteStatus}, or a value this SDK does not know yet. */
|
|
2375
|
+
status: string;
|
|
2368
2376
|
published_at: string | null;
|
|
2369
2377
|
visits: {
|
|
2370
2378
|
last_7d: number;
|
|
@@ -2476,7 +2484,7 @@ export interface SiteCreated {
|
|
|
2476
2484
|
/** Platform wrote the locked llm.chat key to managed site config. */
|
|
2477
2485
|
gateway_configured: boolean;
|
|
2478
2486
|
gateway_base_url: string;
|
|
2479
|
-
gateway_scopes: string
|
|
2487
|
+
gateway_scopes: Array<string>;
|
|
2480
2488
|
}
|
|
2481
2489
|
/** Workspace messaging (team chat): DM, group, or project room. */
|
|
2482
2490
|
/** `session`: a member's conversation with the orchestrator opened as a session, listed under its project. */
|
|
@@ -2533,7 +2541,7 @@ export interface MessageThreadFile {
|
|
|
2533
2541
|
* independent of page_size; `next_cursor` asks for the shares after this page.
|
|
2534
2542
|
*/
|
|
2535
2543
|
export interface MessageThreadFileList {
|
|
2536
|
-
files: MessageThreadFile
|
|
2544
|
+
files: Array<MessageThreadFile>;
|
|
2537
2545
|
next_cursor: string | null;
|
|
2538
2546
|
total: number;
|
|
2539
2547
|
}
|
|
@@ -2554,7 +2562,7 @@ export interface MessageReaction {
|
|
|
2554
2562
|
emoji: string;
|
|
2555
2563
|
count: number;
|
|
2556
2564
|
/** Capped server-side on a very busy message; `count` is the whole tally. */
|
|
2557
|
-
actors: MessageReactionActor
|
|
2565
|
+
actors: Array<MessageReactionActor>;
|
|
2558
2566
|
}
|
|
2559
2567
|
/** Enough of the parent for a reply to quote it without a second read. */
|
|
2560
2568
|
export interface MessageReplyPreview {
|
|
@@ -2577,7 +2585,7 @@ export interface MessagingMessage {
|
|
|
2577
2585
|
author_name: string;
|
|
2578
2586
|
body: string;
|
|
2579
2587
|
/** Block Kit blocks rendered under the body, when the message carries any. */
|
|
2580
|
-
blocks?: MessageBlock
|
|
2588
|
+
blocks?: Array<MessageBlock>;
|
|
2581
2589
|
/**
|
|
2582
2590
|
* The json-render spec an agent's answer drew. When present it is the
|
|
2583
2591
|
* message's UI, and `blocks` is its Block Kit reading for readers that
|
|
@@ -2596,10 +2604,10 @@ export interface MessagingMessage {
|
|
|
2596
2604
|
edited_at?: string;
|
|
2597
2605
|
/** Soft-deleted by messages.delete: the body and blocks are masked. */
|
|
2598
2606
|
deleted?: boolean;
|
|
2599
|
-
attachments: MessagingAttachment
|
|
2600
|
-
mentions: MessageMention
|
|
2607
|
+
attachments: Array<MessagingAttachment>;
|
|
2608
|
+
mentions: Array<MessageMention>;
|
|
2601
2609
|
/** Emoji reactions grouped by emoji, in the order they first appeared. */
|
|
2602
|
-
reactions: MessageReaction
|
|
2610
|
+
reactions: Array<MessageReaction>;
|
|
2603
2611
|
}
|
|
2604
2612
|
/** What messages.react and messages.unreact answer with. */
|
|
2605
2613
|
export interface MessageReactionResult {
|
|
@@ -2609,7 +2617,7 @@ export interface MessageReactionResult {
|
|
|
2609
2617
|
count: number;
|
|
2610
2618
|
/** Whether the caller's own reaction stands after the call. */
|
|
2611
2619
|
reacted: boolean;
|
|
2612
|
-
actors: MessageReactionActor
|
|
2620
|
+
actors: Array<MessageReactionActor>;
|
|
2613
2621
|
}
|
|
2614
2622
|
export interface MessageThread {
|
|
2615
2623
|
id: string;
|
|
@@ -2632,8 +2640,8 @@ export interface MessageThread {
|
|
|
2632
2640
|
archived_at: string | null;
|
|
2633
2641
|
created_at: string;
|
|
2634
2642
|
updated_at: string;
|
|
2635
|
-
participants: MessageParticipant
|
|
2636
|
-
messages?: MessagingMessage
|
|
2643
|
+
participants: Array<MessageParticipant>;
|
|
2644
|
+
messages?: Array<MessagingMessage>;
|
|
2637
2645
|
message_count?: number;
|
|
2638
2646
|
unread?: boolean;
|
|
2639
2647
|
unread_count?: number;
|
|
@@ -2644,7 +2652,7 @@ export interface MessageThread {
|
|
|
2644
2652
|
}
|
|
2645
2653
|
/** Result of messages.list_threads. unread_total is open-thread unread, independent of page_size. */
|
|
2646
2654
|
export interface MessageThreadList {
|
|
2647
|
-
threads: MessageThread
|
|
2655
|
+
threads: Array<MessageThread>;
|
|
2648
2656
|
unread_total: number;
|
|
2649
2657
|
}
|
|
2650
2658
|
/**
|
|
@@ -2663,7 +2671,7 @@ export interface MessageThreadPage {
|
|
|
2663
2671
|
* page exists on either side. `before`/`after` take a message id.
|
|
2664
2672
|
*/
|
|
2665
2673
|
export interface MessagePage {
|
|
2666
|
-
messages: MessagingMessage
|
|
2674
|
+
messages: Array<MessagingMessage>;
|
|
2667
2675
|
has_more_before: boolean;
|
|
2668
2676
|
has_more_after: boolean;
|
|
2669
2677
|
}
|
|
@@ -2677,7 +2685,7 @@ export interface MessageSearchHit {
|
|
|
2677
2685
|
thread_kind: MessageThreadKind;
|
|
2678
2686
|
thread_title: string;
|
|
2679
2687
|
thread_status: MessageThreadStatus;
|
|
2680
|
-
participants: MessageParticipant
|
|
2688
|
+
participants: Array<MessageParticipant>;
|
|
2681
2689
|
message_id: string;
|
|
2682
2690
|
author_type: MessageAuthorType;
|
|
2683
2691
|
author_id: string | null;
|
|
@@ -2691,8 +2699,8 @@ export interface MessageSearchHit {
|
|
|
2691
2699
|
* people match, and the messages whose body does.
|
|
2692
2700
|
*/
|
|
2693
2701
|
export interface MessageSearchResult {
|
|
2694
|
-
threads: MessageThread
|
|
2695
|
-
messages: MessageSearchHit
|
|
2702
|
+
threads: Array<MessageThread>;
|
|
2703
|
+
messages: Array<MessageSearchHit>;
|
|
2696
2704
|
}
|
|
2697
2705
|
export type MessageCallMode = "audio" | "video";
|
|
2698
2706
|
export type MessageCallStatus = "pending" | "provisioning" | "active" | "ending" | "ended" | "failed";
|
|
@@ -2776,7 +2784,7 @@ export interface CallTasksCreated {
|
|
|
2776
2784
|
assignee_user_id: string | null;
|
|
2777
2785
|
due_on: string | null;
|
|
2778
2786
|
}>;
|
|
2779
|
-
items: CallActionItem
|
|
2787
|
+
items: Array<CallActionItem>;
|
|
2780
2788
|
}
|
|
2781
2789
|
/** A standalone call: a meeting with a shareable link, tied to no chat, person, agent or group. */
|
|
2782
2790
|
export interface CallRecording {
|
|
@@ -2820,27 +2828,27 @@ export interface Call {
|
|
|
2820
2828
|
summary: string | null;
|
|
2821
2829
|
summarized_at: string | null;
|
|
2822
2830
|
/** Documents the summary heard referenced, resolved to workspace documents where a filename matched. */
|
|
2823
|
-
summary_references: CallSummaryReference
|
|
2831
|
+
summary_references: Array<CallSummaryReference>;
|
|
2824
2832
|
/** File the summary's action items as project tasks as soon as it is written. */
|
|
2825
2833
|
auto_tasks: boolean;
|
|
2826
2834
|
/** Who may share their screen on this call. */
|
|
2827
2835
|
present_policy: CallPresentPolicy;
|
|
2828
2836
|
/** With `present_policy: "chosen"`: the built-in workspace roles that may present. */
|
|
2829
|
-
present_roles: string
|
|
2837
|
+
present_roles: Array<string>;
|
|
2830
2838
|
/** With `present_policy: "chosen"`: the custom roles that may present. */
|
|
2831
|
-
present_role_ids: string
|
|
2839
|
+
present_role_ids: Array<string>;
|
|
2832
2840
|
/** With `present_policy: "chosen"`: the people who may present whatever their role. */
|
|
2833
|
-
present_user_ids: string
|
|
2841
|
+
present_user_ids: Array<string>;
|
|
2834
2842
|
/** When a scheduled call starts; null for a call started on the spot. */
|
|
2835
2843
|
scheduled_for: string | null;
|
|
2836
2844
|
/** How long a scheduled call is planned to run, in minutes. */
|
|
2837
2845
|
scheduled_minutes: number | null;
|
|
2838
2846
|
/** Everyone seated or invited, the creator first: what an untitled call is called by. */
|
|
2839
|
-
people: string
|
|
2847
|
+
people: Array<string>;
|
|
2840
2848
|
/** Whether the caller may share their screen; only `getCall` returns it. */
|
|
2841
2849
|
can_present?: boolean;
|
|
2842
2850
|
/** The summary's action items; only `getCall` returns them. */
|
|
2843
|
-
action_items?: CallActionItem
|
|
2851
|
+
action_items?: Array<CallActionItem>;
|
|
2844
2852
|
/** The orchestrator session the call's record opened, once the summary is written; only `getCall` returns it. */
|
|
2845
2853
|
session_id?: string | null;
|
|
2846
2854
|
/** The capability behind `/call/{join_token}`; only `getCall` returns it. */
|
|
@@ -2913,7 +2921,7 @@ export interface BookingType {
|
|
|
2913
2921
|
location_kind: BookingLocationKind | null;
|
|
2914
2922
|
status: "active" | "paused";
|
|
2915
2923
|
publishes_to_calendar: boolean;
|
|
2916
|
-
ranges: BookingRange
|
|
2924
|
+
ranges: Array<BookingRange>;
|
|
2917
2925
|
created_at: string;
|
|
2918
2926
|
updated_at: string;
|
|
2919
2927
|
}
|
|
@@ -2930,7 +2938,7 @@ export interface BookingSlots {
|
|
|
2930
2938
|
location: string;
|
|
2931
2939
|
from: string;
|
|
2932
2940
|
to: string;
|
|
2933
|
-
slots: BookingSlot
|
|
2941
|
+
slots: Array<BookingSlot>;
|
|
2934
2942
|
}
|
|
2935
2943
|
/** An appointment somebody took out of a page's ranges. */
|
|
2936
2944
|
export interface Booking {
|
|
@@ -2975,7 +2983,7 @@ export interface PublicBookingSlots {
|
|
|
2975
2983
|
to: string | null;
|
|
2976
2984
|
duration_minutes: number | null;
|
|
2977
2985
|
time_zone: string | null;
|
|
2978
|
-
slots: BookingSlot
|
|
2986
|
+
slots: Array<BookingSlot>;
|
|
2979
2987
|
}
|
|
2980
2988
|
/** The confirmation a guest gets, with their own capability over it. */
|
|
2981
2989
|
export interface PublicBookingConfirmation {
|
|
@@ -3165,17 +3173,17 @@ export interface ThreadDecisionRow {
|
|
|
3165
3173
|
}
|
|
3166
3174
|
/** Result of messages.activity: the thread's live runs plus the delegates below them. */
|
|
3167
3175
|
export interface MessageThreadActivity {
|
|
3168
|
-
activity: ThreadActivityRow
|
|
3176
|
+
activity: Array<ThreadActivityRow>;
|
|
3169
3177
|
/** Newest 20, oldest first. */
|
|
3170
|
-
delegates: ThreadDelegateRow
|
|
3178
|
+
delegates: Array<ThreadDelegateRow>;
|
|
3171
3179
|
/** What the thread's recent runs changed, oldest first. */
|
|
3172
|
-
actions?: ThreadActionRow
|
|
3180
|
+
actions?: Array<ThreadActionRow>;
|
|
3173
3181
|
/** What the thread's recent runs looked at, oldest first. */
|
|
3174
|
-
reads?: ThreadReadRow
|
|
3182
|
+
reads?: Array<ThreadReadRow>;
|
|
3175
3183
|
/** The messages sent while an agent was at work, the last day's, newest first. */
|
|
3176
|
-
queued?: ThreadQueuedRow
|
|
3184
|
+
queued?: Array<ThreadQueuedRow>;
|
|
3177
3185
|
/** The approvals decided for the thread's recent runs, newest first. */
|
|
3178
|
-
decisions?: ThreadDecisionRow
|
|
3186
|
+
decisions?: Array<ThreadDecisionRow>;
|
|
3179
3187
|
}
|
|
3180
3188
|
/** What kind of capability a usage row describes. */
|
|
3181
3189
|
export type FeatureKind = "tool" | "page" | "agent";
|
|
@@ -3205,7 +3213,7 @@ export interface FeatureUsageRow {
|
|
|
3205
3213
|
/** Workspaces that ever reached it; platform-wide reports only. */
|
|
3206
3214
|
tenants?: number;
|
|
3207
3215
|
/** Surfaces the windowed calls came through. */
|
|
3208
|
-
surfaces?: UsageSurface
|
|
3216
|
+
surfaces?: Array<UsageSurface>;
|
|
3209
3217
|
last_used_at?: string;
|
|
3210
3218
|
}
|
|
3211
3219
|
/** Headline adoption numbers for one kind of capability. */
|
|
@@ -3233,8 +3241,8 @@ export interface UsageSurfaceRow {
|
|
|
3233
3241
|
export interface FeatureUsageResponse {
|
|
3234
3242
|
window_days: number;
|
|
3235
3243
|
totals: Partial<Record<FeatureKind, FeatureUsageTotals>>;
|
|
3236
|
-
surfaces: UsageSurfaceRow
|
|
3237
|
-
features: FeatureUsageRow
|
|
3244
|
+
surfaces: Array<UsageSurfaceRow>;
|
|
3245
|
+
features: Array<FeatureUsageRow>;
|
|
3238
3246
|
}
|
|
3239
3247
|
export interface ApiKey {
|
|
3240
3248
|
id: string;
|
|
@@ -3245,7 +3253,7 @@ export interface ApiKey {
|
|
|
3245
3253
|
* Tool patterns the key may invoke ("ar.%", "%:read", "tool.name:full").
|
|
3246
3254
|
* Empty = unrestricted.
|
|
3247
3255
|
*/
|
|
3248
|
-
scopes: string
|
|
3256
|
+
scopes: Array<string>;
|
|
3249
3257
|
created_at: string;
|
|
3250
3258
|
last_used_at: string | null;
|
|
3251
3259
|
revoked_at: string | null;
|
|
@@ -3262,11 +3270,11 @@ export interface ApiKeyUsage {
|
|
|
3262
3270
|
window_days: number;
|
|
3263
3271
|
/** Ledger actions ever recorded for this key (reads are not ledgered). */
|
|
3264
3272
|
total_actions: number;
|
|
3265
|
-
tools: {
|
|
3273
|
+
tools: Array<{
|
|
3266
3274
|
tool: string;
|
|
3267
3275
|
invocations: number;
|
|
3268
3276
|
last_invoked_at: string;
|
|
3269
|
-
}
|
|
3277
|
+
}>;
|
|
3270
3278
|
}
|
|
3271
3279
|
/** What the OAuth consent page shows a signed-in member. */
|
|
3272
3280
|
export interface OAuthConsent {
|
|
@@ -3277,7 +3285,7 @@ export interface OAuthConsent {
|
|
|
3277
3285
|
logo_uri?: string;
|
|
3278
3286
|
redirect_uri: string;
|
|
3279
3287
|
/** High-level scopes the client asked for (tools / tools:read / patterns). */
|
|
3280
|
-
scopes: string
|
|
3288
|
+
scopes: Array<string>;
|
|
3281
3289
|
resource?: string;
|
|
3282
3290
|
tenants: Array<{
|
|
3283
3291
|
id: string;
|
|
@@ -3339,7 +3347,7 @@ export interface Bill {
|
|
|
3339
3347
|
reason_code: string | null;
|
|
3340
3348
|
reason: string | null;
|
|
3341
3349
|
/** Present on create/update/get responses. */
|
|
3342
|
-
lines?: DocumentLine
|
|
3350
|
+
lines?: Array<DocumentLine>;
|
|
3343
3351
|
/** Present on list rows. */
|
|
3344
3352
|
lines_count?: number;
|
|
3345
3353
|
/**
|
|
@@ -3471,7 +3479,7 @@ export interface StockLevel {
|
|
|
3471
3479
|
updated_at: string;
|
|
3472
3480
|
}
|
|
3473
3481
|
export interface StockLevels {
|
|
3474
|
-
levels: StockLevel
|
|
3482
|
+
levels: Array<StockLevel>;
|
|
3475
3483
|
total_value_cents: number;
|
|
3476
3484
|
low_stock_count: number;
|
|
3477
3485
|
currency: string;
|
|
@@ -3500,7 +3508,7 @@ export interface StockMovement {
|
|
|
3500
3508
|
balance_value_cents: number;
|
|
3501
3509
|
}
|
|
3502
3510
|
export interface StockMovements {
|
|
3503
|
-
movements: StockMovement
|
|
3511
|
+
movements: Array<StockMovement>;
|
|
3504
3512
|
opening_quantity: number;
|
|
3505
3513
|
opening_value_cents: number;
|
|
3506
3514
|
closing_quantity: number;
|
|
@@ -3521,11 +3529,11 @@ export interface InventoryValuationRow {
|
|
|
3521
3529
|
}
|
|
3522
3530
|
export interface InventoryValuation {
|
|
3523
3531
|
as_of: string;
|
|
3524
|
-
items: InventoryValuationRow
|
|
3525
|
-
warehouses: {
|
|
3532
|
+
items: Array<InventoryValuationRow>;
|
|
3533
|
+
warehouses: Array<{
|
|
3526
3534
|
warehouse_code: string;
|
|
3527
3535
|
value_cents: number;
|
|
3528
|
-
}
|
|
3536
|
+
}>;
|
|
3529
3537
|
stock_value_cents: number;
|
|
3530
3538
|
currency: string;
|
|
3531
3539
|
/** Only when every warehouse is valued (the ledger covers them all). */
|
|
@@ -3543,7 +3551,7 @@ export interface InventoryOverviewLevel extends StockLevel {
|
|
|
3543
3551
|
month_in: number;
|
|
3544
3552
|
month_out: number;
|
|
3545
3553
|
/** The owned quantity at each of the last twelve week ends, oldest first; the last is today. */
|
|
3546
|
-
trend: number
|
|
3554
|
+
trend: Array<number>;
|
|
3547
3555
|
}
|
|
3548
3556
|
/** A month's movements of one type in one warehouse, summed. */
|
|
3549
3557
|
export interface InventoryOverviewFlow {
|
|
@@ -3579,11 +3587,11 @@ export interface InventoryOverviewCount {
|
|
|
3579
3587
|
warehouse_id: string;
|
|
3580
3588
|
counted_on: string;
|
|
3581
3589
|
reference: string | null;
|
|
3582
|
-
lines: {
|
|
3590
|
+
lines: Array<{
|
|
3583
3591
|
item_id: string;
|
|
3584
3592
|
expected_quantity: number;
|
|
3585
3593
|
counted_quantity: number | null;
|
|
3586
|
-
}
|
|
3594
|
+
}>;
|
|
3587
3595
|
}
|
|
3588
3596
|
/** The inventory page in one read (`inventory.overview`). Values in cents. */
|
|
3589
3597
|
export interface InventoryOverview {
|
|
@@ -3591,43 +3599,43 @@ export interface InventoryOverview {
|
|
|
3591
3599
|
/** YYYY-MM whose movements and flows these are. */
|
|
3592
3600
|
month: string;
|
|
3593
3601
|
currency: string;
|
|
3594
|
-
warehouses: {
|
|
3602
|
+
warehouses: Array<{
|
|
3595
3603
|
id: string;
|
|
3596
3604
|
code: string;
|
|
3597
3605
|
name: string;
|
|
3598
3606
|
is_default: boolean;
|
|
3599
3607
|
active: boolean;
|
|
3600
|
-
}
|
|
3608
|
+
}>;
|
|
3601
3609
|
/** The active items that keep stock. */
|
|
3602
|
-
items: {
|
|
3610
|
+
items: Array<{
|
|
3603
3611
|
id: string;
|
|
3604
3612
|
code: string | null;
|
|
3605
3613
|
name: string;
|
|
3606
3614
|
unit_code: string;
|
|
3607
3615
|
reorder_point: number | null;
|
|
3608
|
-
}
|
|
3609
|
-
levels: InventoryOverviewLevel
|
|
3610
|
-
flows: InventoryOverviewFlow
|
|
3611
|
-
movements: InventoryOverviewMovement
|
|
3616
|
+
}>;
|
|
3617
|
+
levels: Array<InventoryOverviewLevel>;
|
|
3618
|
+
flows: Array<InventoryOverviewFlow>;
|
|
3619
|
+
movements: Array<InventoryOverviewMovement>;
|
|
3612
3620
|
/** Twelve months per warehouse ending with `month`: value in, out and at close. */
|
|
3613
|
-
history: {
|
|
3621
|
+
history: Array<{
|
|
3614
3622
|
warehouse_id: string;
|
|
3615
|
-
months: {
|
|
3623
|
+
months: Array<{
|
|
3616
3624
|
month: string;
|
|
3617
3625
|
in_cents: number;
|
|
3618
3626
|
out_cents: number;
|
|
3619
3627
|
closing_cents: number;
|
|
3620
|
-
}
|
|
3621
|
-
}
|
|
3628
|
+
}>;
|
|
3629
|
+
}>;
|
|
3622
3630
|
stock_value_cents: number;
|
|
3623
3631
|
ledger_balance_cents: number;
|
|
3624
3632
|
difference_cents: number;
|
|
3625
3633
|
low_stock_count: number;
|
|
3626
3634
|
reorder: {
|
|
3627
3635
|
estimated_total_cost_cents: number;
|
|
3628
|
-
suggestions: ReorderSuggestion
|
|
3636
|
+
suggestions: Array<ReorderSuggestion>;
|
|
3629
3637
|
};
|
|
3630
|
-
open_counts: InventoryOverviewCount
|
|
3638
|
+
open_counts: Array<InventoryOverviewCount>;
|
|
3631
3639
|
/** Whether there were more levels or movements than the page carries. */
|
|
3632
3640
|
truncated: boolean;
|
|
3633
3641
|
/** Which of the page's writes the caller's role reaches. */
|
|
@@ -3684,7 +3692,7 @@ export interface InventoryCountLine {
|
|
|
3684
3692
|
}
|
|
3685
3693
|
export interface InventoryCountDetail {
|
|
3686
3694
|
count: InventoryCount;
|
|
3687
|
-
lines: InventoryCountLine
|
|
3695
|
+
lines: Array<InventoryCountLine>;
|
|
3688
3696
|
net_difference_cents: number;
|
|
3689
3697
|
currency: string;
|
|
3690
3698
|
}
|
|
@@ -3717,7 +3725,7 @@ export interface NoteInput {
|
|
|
3717
3725
|
reason: string;
|
|
3718
3726
|
/** Credit notes: mirror every line of the original. */
|
|
3719
3727
|
full?: boolean;
|
|
3720
|
-
lines?: LineInput
|
|
3728
|
+
lines?: Array<LineInput>;
|
|
3721
3729
|
subtotal?: number;
|
|
3722
3730
|
tax?: number;
|
|
3723
3731
|
total?: number;
|
|
@@ -3783,7 +3791,7 @@ export interface EinvoiceSubmissionView {
|
|
|
3783
3791
|
qr_url?: string;
|
|
3784
3792
|
public_url?: string;
|
|
3785
3793
|
/** DIAN rule messages ("Regla: FAJ44b, Notificación: …"). */
|
|
3786
|
-
messages?: string
|
|
3794
|
+
messages?: Array<string>;
|
|
3787
3795
|
last_error?: string;
|
|
3788
3796
|
attempts: number;
|
|
3789
3797
|
provider?: string;
|
|
@@ -3794,7 +3802,7 @@ export interface EinvoiceSubmissionView {
|
|
|
3794
3802
|
updated_at: string;
|
|
3795
3803
|
}
|
|
3796
3804
|
export interface EinvoiceSubmissionList {
|
|
3797
|
-
submissions: EinvoiceSubmissionView
|
|
3805
|
+
submissions: Array<EinvoiceSubmissionView>;
|
|
3798
3806
|
/** Row count per state, for badges. */
|
|
3799
3807
|
counts: Partial<Record<EinvoiceState, number>>;
|
|
3800
3808
|
}
|
|
@@ -3814,17 +3822,18 @@ export interface EinvoiceDownload {
|
|
|
3814
3822
|
number?: string;
|
|
3815
3823
|
authority_uid?: string;
|
|
3816
3824
|
public_url?: string;
|
|
3817
|
-
artifacts: EinvoiceArtifact
|
|
3825
|
+
artifacts: Array<EinvoiceArtifact>;
|
|
3818
3826
|
}
|
|
3819
3827
|
export interface EinvoiceLiveStatus {
|
|
3820
3828
|
/** Absent when the document never reached the facturador (`reason`). */
|
|
3821
3829
|
submission_id?: string;
|
|
3822
|
-
|
|
3830
|
+
/** A {@link EinvoiceState}, or a value this SDK does not know yet. */
|
|
3831
|
+
state: string;
|
|
3823
3832
|
/** The facturador that answered: factus, siigo or alegra. */
|
|
3824
3833
|
provider?: string;
|
|
3825
3834
|
authority_uid?: string;
|
|
3826
3835
|
number?: string;
|
|
3827
|
-
messages?: string
|
|
3836
|
+
messages?: Array<string>;
|
|
3828
3837
|
public_url?: string;
|
|
3829
3838
|
qr_url?: string;
|
|
3830
3839
|
/** What we have on file, for comparison. */
|
|
@@ -3859,7 +3868,7 @@ export interface Party {
|
|
|
3859
3868
|
person_type?: "natural" | "juridica" | null;
|
|
3860
3869
|
legal_form?: string | null;
|
|
3861
3870
|
ciiu_primary?: string | null;
|
|
3862
|
-
ciiu_secondary?: string
|
|
3871
|
+
ciiu_secondary?: Array<string> | null;
|
|
3863
3872
|
city?: string | null;
|
|
3864
3873
|
/** DIAN identity for electronic invoicing (parties.update). */
|
|
3865
3874
|
identification_document_code?: string | null;
|
|
@@ -3868,7 +3877,7 @@ export interface Party {
|
|
|
3868
3877
|
tribute_code?: string | null;
|
|
3869
3878
|
municipality_code?: string | null;
|
|
3870
3879
|
trade_name?: string | null;
|
|
3871
|
-
fiscal_responsibilities?: string
|
|
3880
|
+
fiscal_responsibilities?: Array<string> | null;
|
|
3872
3881
|
crm_company_id?: string | null;
|
|
3873
3882
|
/** When parties.archive hid it from lists and pickers; null while it is listed. */
|
|
3874
3883
|
archived_at?: string | null;
|
|
@@ -3897,11 +3906,11 @@ export type CRMCompanySize = "any" | "micro" | "small" | "medium" | "large" | "e
|
|
|
3897
3906
|
/** The workspace's ideal customer profile (crm.save_prospecting_profile). */
|
|
3898
3907
|
export interface CRMProspectingProfile {
|
|
3899
3908
|
description: string;
|
|
3900
|
-
industries: string
|
|
3909
|
+
industries: Array<string>;
|
|
3901
3910
|
/** ISO 3166-1 alpha-2; "" searches everywhere. */
|
|
3902
3911
|
country: string;
|
|
3903
3912
|
company_size: CRMCompanySize;
|
|
3904
|
-
tags: string
|
|
3913
|
+
tags: Array<string>;
|
|
3905
3914
|
/** Companies one search adds at most: 5, 10 or 25. */
|
|
3906
3915
|
run_size: number;
|
|
3907
3916
|
/** Pipeline key new deals open in; "" is the workspace's first. */
|
|
@@ -3946,8 +3955,8 @@ export interface CRMProspect {
|
|
|
3946
3955
|
}
|
|
3947
3956
|
export interface CRMProspecting {
|
|
3948
3957
|
profile: CRMProspectingProfile | null;
|
|
3949
|
-
runs: CRMProspectRun
|
|
3950
|
-
prospects: CRMProspect
|
|
3958
|
+
runs: Array<CRMProspectRun>;
|
|
3959
|
+
prospects: Array<CRMProspect>;
|
|
3951
3960
|
}
|
|
3952
3961
|
export interface PartyUpdateInput {
|
|
3953
3962
|
party_id: string;
|
|
@@ -3962,7 +3971,7 @@ export interface PartyUpdateInput {
|
|
|
3962
3971
|
person_type?: "natural" | "juridica" | "";
|
|
3963
3972
|
legal_form?: string;
|
|
3964
3973
|
ciiu_primary?: string;
|
|
3965
|
-
ciiu_secondary?: string
|
|
3974
|
+
ciiu_secondary?: Array<string>;
|
|
3966
3975
|
city?: string;
|
|
3967
3976
|
}
|
|
3968
3977
|
/**
|
|
@@ -4015,7 +4024,7 @@ export interface PartyMergeResult {
|
|
|
4015
4024
|
}
|
|
4016
4025
|
/** What parties.find_matches answers: the duplicates, and the company a work email binds to. */
|
|
4017
4026
|
export interface PartyMatches {
|
|
4018
|
-
matches: PartyMatch
|
|
4027
|
+
matches: Array<PartyMatch>;
|
|
4019
4028
|
company: {
|
|
4020
4029
|
domain: string;
|
|
4021
4030
|
name: string;
|
|
@@ -4032,8 +4041,8 @@ export interface GlobalCompany {
|
|
|
4032
4041
|
person_type: string;
|
|
4033
4042
|
legal_form: string;
|
|
4034
4043
|
ciiu_primary: string;
|
|
4035
|
-
ciiu_secondary: string
|
|
4036
|
-
fiscal_responsibilities: string
|
|
4044
|
+
ciiu_secondary: Array<string>;
|
|
4045
|
+
fiscal_responsibilities: Array<string>;
|
|
4037
4046
|
municipality_code: string;
|
|
4038
4047
|
city: string;
|
|
4039
4048
|
source: string;
|
|
@@ -4063,7 +4072,7 @@ export interface PaymentFormat {
|
|
|
4063
4072
|
description: string;
|
|
4064
4073
|
content_type: string;
|
|
4065
4074
|
extension: string;
|
|
4066
|
-
required_party_fields: string
|
|
4075
|
+
required_party_fields: Array<string> | null;
|
|
4067
4076
|
requires_payer: boolean;
|
|
4068
4077
|
verified: boolean;
|
|
4069
4078
|
}
|
|
@@ -4071,7 +4080,8 @@ export interface PaymentRunPayer {
|
|
|
4071
4080
|
name?: string;
|
|
4072
4081
|
tax_id?: string;
|
|
4073
4082
|
account_number?: string;
|
|
4074
|
-
|
|
4083
|
+
/** "savings" or "checking", or a value this SDK does not know yet. */
|
|
4084
|
+
account_type?: string;
|
|
4075
4085
|
}
|
|
4076
4086
|
export type PaymentRunStatus = "draft" | "exported" | "settled" | "cancelled";
|
|
4077
4087
|
/**
|
|
@@ -4146,11 +4156,11 @@ export interface PaymentRunMissingDetails {
|
|
|
4146
4156
|
bill_id: string;
|
|
4147
4157
|
party_id?: string;
|
|
4148
4158
|
vendor_name: string;
|
|
4149
|
-
missing: string
|
|
4159
|
+
missing: Array<string>;
|
|
4150
4160
|
party_resolved: boolean;
|
|
4151
4161
|
}
|
|
4152
4162
|
export interface PaymentRunCreateInput {
|
|
4153
|
-
bill_ids?: string
|
|
4163
|
+
bill_ids?: Array<string>;
|
|
4154
4164
|
due_by?: string;
|
|
4155
4165
|
amounts?: Record<string, number>;
|
|
4156
4166
|
currency?: string;
|
|
@@ -4161,13 +4171,13 @@ export interface PaymentRunCreateInput {
|
|
|
4161
4171
|
}
|
|
4162
4172
|
export interface PaymentRunCreateResult {
|
|
4163
4173
|
run: PaymentRun;
|
|
4164
|
-
items: PaymentRunItem
|
|
4165
|
-
missing_bank_details: PaymentRunMissingDetails
|
|
4166
|
-
skipped: {
|
|
4174
|
+
items: Array<PaymentRunItem>;
|
|
4175
|
+
missing_bank_details: Array<PaymentRunMissingDetails> | null;
|
|
4176
|
+
skipped: Array<{
|
|
4167
4177
|
bill_id: string;
|
|
4168
4178
|
vendor_name: string;
|
|
4169
4179
|
reason: string;
|
|
4170
|
-
}
|
|
4180
|
+
}> | null;
|
|
4171
4181
|
format: PaymentFormat;
|
|
4172
4182
|
warning?: string;
|
|
4173
4183
|
}
|
|
@@ -4182,18 +4192,18 @@ export interface PaymentRunExportResult {
|
|
|
4182
4192
|
}
|
|
4183
4193
|
export interface PaymentRunSettleResult {
|
|
4184
4194
|
run: PaymentRun;
|
|
4185
|
-
settled: {
|
|
4195
|
+
settled: Array<{
|
|
4186
4196
|
item_id: string;
|
|
4187
4197
|
bill_id: string;
|
|
4188
4198
|
payment_id: string;
|
|
4189
4199
|
journal_entry_id: string;
|
|
4190
4200
|
amount_cents: number;
|
|
4191
4201
|
bank_transaction_id?: string;
|
|
4192
|
-
}
|
|
4193
|
-
skipped: {
|
|
4202
|
+
}> | null;
|
|
4203
|
+
skipped: Array<{
|
|
4194
4204
|
item_id: string;
|
|
4195
4205
|
status: string;
|
|
4196
|
-
}
|
|
4206
|
+
}> | null;
|
|
4197
4207
|
pending_items: number;
|
|
4198
4208
|
}
|
|
4199
4209
|
export interface StatementImportResult {
|
|
@@ -4203,10 +4213,10 @@ export interface StatementImportResult {
|
|
|
4203
4213
|
currency: string;
|
|
4204
4214
|
parsed: number;
|
|
4205
4215
|
skipped_rows: number;
|
|
4206
|
-
warnings: string
|
|
4216
|
+
warnings: Array<string> | null;
|
|
4207
4217
|
imported?: number;
|
|
4208
4218
|
skipped?: number;
|
|
4209
|
-
transaction_ids?: string
|
|
4219
|
+
transaction_ids?: Array<string>;
|
|
4210
4220
|
}
|
|
4211
4221
|
export interface Account {
|
|
4212
4222
|
id: string;
|
|
@@ -4251,7 +4261,7 @@ export interface Tag {
|
|
|
4251
4261
|
created_at: string;
|
|
4252
4262
|
}
|
|
4253
4263
|
export interface TagDimensionWithTags extends TagDimension {
|
|
4254
|
-
tags: Tag
|
|
4264
|
+
tags: Array<Tag>;
|
|
4255
4265
|
}
|
|
4256
4266
|
/** Journal-line tag selection: stable dimension key -> stable tag code. */
|
|
4257
4267
|
export type LineTags = Record<string, string>;
|
|
@@ -4273,11 +4283,11 @@ export interface JournalLine {
|
|
|
4273
4283
|
debit_cents: number;
|
|
4274
4284
|
credit_cents: number;
|
|
4275
4285
|
memo: string | null;
|
|
4276
|
-
tags: JournalLineTag
|
|
4286
|
+
tags: Array<JournalLineTag>;
|
|
4277
4287
|
}
|
|
4278
4288
|
export interface JournalEntryDetail {
|
|
4279
4289
|
entry: JournalEntry;
|
|
4280
|
-
lines: JournalLine
|
|
4290
|
+
lines: Array<JournalLine>;
|
|
4281
4291
|
}
|
|
4282
4292
|
export interface ProfitabilityMetrics {
|
|
4283
4293
|
income_cents: number;
|
|
@@ -4297,7 +4307,7 @@ export interface ProfitabilityReport {
|
|
|
4297
4307
|
to: string;
|
|
4298
4308
|
dimension_key: string;
|
|
4299
4309
|
totals: ProfitabilityMetrics;
|
|
4300
|
-
rows: ProfitabilityRow
|
|
4310
|
+
rows: Array<ProfitabilityRow>;
|
|
4301
4311
|
unassigned: ProfitabilityMetrics | null;
|
|
4302
4312
|
}
|
|
4303
4313
|
export interface TrialBalanceRow {
|
|
@@ -4314,7 +4324,7 @@ export interface BalanceSheetAccount {
|
|
|
4314
4324
|
balance_cents: number;
|
|
4315
4325
|
}
|
|
4316
4326
|
export interface BalanceSheetSection {
|
|
4317
|
-
accounts: BalanceSheetAccount
|
|
4327
|
+
accounts: Array<BalanceSheetAccount>;
|
|
4318
4328
|
total_cents: number;
|
|
4319
4329
|
}
|
|
4320
4330
|
export interface BalanceSheet {
|
|
@@ -4347,11 +4357,11 @@ export interface IncomeStatement {
|
|
|
4347
4357
|
to: string;
|
|
4348
4358
|
currency: string;
|
|
4349
4359
|
income: {
|
|
4350
|
-
accounts: IncomeStatementAccount
|
|
4360
|
+
accounts: Array<IncomeStatementAccount>;
|
|
4351
4361
|
total_cents: number;
|
|
4352
4362
|
};
|
|
4353
4363
|
expense: {
|
|
4354
|
-
accounts: IncomeStatementAccount
|
|
4364
|
+
accounts: Array<IncomeStatementAccount>;
|
|
4355
4365
|
total_cents: number;
|
|
4356
4366
|
};
|
|
4357
4367
|
income_cents: number;
|
|
@@ -4359,7 +4369,7 @@ export interface IncomeStatement {
|
|
|
4359
4369
|
net_cents: number;
|
|
4360
4370
|
breakdown?: {
|
|
4361
4371
|
dimension_key: string;
|
|
4362
|
-
rows: IncomeStatementBreakdownRow
|
|
4372
|
+
rows: Array<IncomeStatementBreakdownRow>;
|
|
4363
4373
|
unassigned: IncomeStatementBreakdownRow | null;
|
|
4364
4374
|
};
|
|
4365
4375
|
}
|
|
@@ -4387,7 +4397,7 @@ export interface AccountStatement {
|
|
|
4387
4397
|
to: string;
|
|
4388
4398
|
currency: string;
|
|
4389
4399
|
opening_balance_cents: number;
|
|
4390
|
-
movements: AccountMovement
|
|
4400
|
+
movements: Array<AccountMovement>;
|
|
4391
4401
|
debits_cents: number;
|
|
4392
4402
|
credits_cents: number;
|
|
4393
4403
|
closing_balance_cents: number;
|
|
@@ -4417,13 +4427,13 @@ export interface AgingParty {
|
|
|
4417
4427
|
party_id: string;
|
|
4418
4428
|
party_name: string;
|
|
4419
4429
|
buckets: AgingBuckets;
|
|
4420
|
-
documents: AgingDocument
|
|
4430
|
+
documents: Array<AgingDocument>;
|
|
4421
4431
|
}
|
|
4422
4432
|
export interface AgingReport {
|
|
4423
4433
|
kind: "receivable" | "payable";
|
|
4424
4434
|
as_of: string;
|
|
4425
4435
|
currency: string;
|
|
4426
|
-
parties: AgingParty
|
|
4436
|
+
parties: Array<AgingParty>;
|
|
4427
4437
|
totals: AgingBuckets;
|
|
4428
4438
|
documents: number;
|
|
4429
4439
|
}
|
|
@@ -4451,7 +4461,7 @@ export interface PartyStatement {
|
|
|
4451
4461
|
to: string;
|
|
4452
4462
|
currency: string;
|
|
4453
4463
|
opening_balance_cents: number;
|
|
4454
|
-
rows: PartyStatementRow
|
|
4464
|
+
rows: Array<PartyStatementRow>;
|
|
4455
4465
|
debits_cents: number;
|
|
4456
4466
|
credits_cents: number;
|
|
4457
4467
|
closing_balance_cents: number;
|
|
@@ -4531,7 +4541,7 @@ export interface Invoice {
|
|
|
4531
4541
|
reason_code: string | null;
|
|
4532
4542
|
reason: string | null;
|
|
4533
4543
|
/** Present on create/update/get responses. */
|
|
4534
|
-
lines?: DocumentLine
|
|
4544
|
+
lines?: Array<DocumentLine>;
|
|
4535
4545
|
/** Present on list rows. */
|
|
4536
4546
|
lines_count?: number;
|
|
4537
4547
|
/** Posted documents: total − payments − posted credit notes (document currency); credit notes read 0. */
|
|
@@ -4539,9 +4549,9 @@ export interface Invoice {
|
|
|
4539
4549
|
}
|
|
4540
4550
|
export interface InvoiceDetail {
|
|
4541
4551
|
invoice: Invoice;
|
|
4542
|
-
lines: DocumentLine
|
|
4543
|
-
payments: Payment
|
|
4544
|
-
notes: NoteSummary
|
|
4552
|
+
lines: Array<DocumentLine>;
|
|
4553
|
+
payments: Array<Payment>;
|
|
4554
|
+
notes: Array<NoteSummary>;
|
|
4545
4555
|
balance: DocumentBalance;
|
|
4546
4556
|
einvoice: EinvoiceSubmission | null;
|
|
4547
4557
|
related_invoice?: Invoice;
|
|
@@ -4553,9 +4563,9 @@ export interface InvoiceDetail {
|
|
|
4553
4563
|
}
|
|
4554
4564
|
export interface BillDetail {
|
|
4555
4565
|
bill: Bill;
|
|
4556
|
-
lines: DocumentLine
|
|
4557
|
-
payments: Payment
|
|
4558
|
-
notes: NoteSummary
|
|
4566
|
+
lines: Array<DocumentLine>;
|
|
4567
|
+
payments: Array<Payment>;
|
|
4568
|
+
notes: Array<NoteSummary>;
|
|
4559
4569
|
balance: DocumentBalance;
|
|
4560
4570
|
related_bill?: Bill;
|
|
4561
4571
|
reason_label?: string;
|
|
@@ -4577,7 +4587,8 @@ export interface EinvoiceSubmission {
|
|
|
4577
4587
|
bill_id?: string | null;
|
|
4578
4588
|
document_kind?: EinvoiceDocumentKind;
|
|
4579
4589
|
country: string;
|
|
4580
|
-
|
|
4590
|
+
/** A {@link EinvoiceState}, or a value this SDK does not know yet. */
|
|
4591
|
+
state: string;
|
|
4581
4592
|
/** CUFE / CUDE / CUDS — set once the authority validates the document. */
|
|
4582
4593
|
authority_uid: string | null;
|
|
4583
4594
|
/** The consecutive the authority assigned (SETP990000550). */
|
|
@@ -4630,9 +4641,9 @@ export interface FxRatesResponse {
|
|
|
4630
4641
|
/** The tenant currency the quotes are relative to. */
|
|
4631
4642
|
base: string;
|
|
4632
4643
|
as_of: string;
|
|
4633
|
-
rates: FxQuote
|
|
4644
|
+
rates: Array<FxQuote>;
|
|
4634
4645
|
/** Requested codes with no rate on file. */
|
|
4635
|
-
missing: string
|
|
4646
|
+
missing: Array<string>;
|
|
4636
4647
|
feed: {
|
|
4637
4648
|
/** When the provider feed last wrote rates (RFC 3339), null if never. */
|
|
4638
4649
|
last_refresh: string | null;
|
|
@@ -4684,8 +4695,8 @@ export interface UserUsageRow {
|
|
|
4684
4695
|
tools: number;
|
|
4685
4696
|
}
|
|
4686
4697
|
export interface LLMUsageResponse {
|
|
4687
|
-
usage: LLMUsageRow
|
|
4688
|
-
by_user: UserUsageRow
|
|
4698
|
+
usage: Array<LLMUsageRow>;
|
|
4699
|
+
by_user: Array<UserUsageRow>;
|
|
4689
4700
|
/** Tenant currency the cost_cents fields are denominated in. */
|
|
4690
4701
|
currency: string;
|
|
4691
4702
|
}
|
|
@@ -4742,10 +4753,10 @@ export interface MetricResult {
|
|
|
4742
4753
|
/** Summary key stat cards show by default. */
|
|
4743
4754
|
primary: string;
|
|
4744
4755
|
summary: Record<string, number>;
|
|
4745
|
-
series?: MetricPoint
|
|
4756
|
+
series?: Array<MetricPoint>;
|
|
4746
4757
|
/** Value keys charts should plot by default (set by forecast metrics whose series mixes keys). */
|
|
4747
|
-
series_keys?: string
|
|
4748
|
-
rows?: JsonObject
|
|
4758
|
+
series_keys?: Array<string>;
|
|
4759
|
+
rows?: Array<JsonObject>;
|
|
4749
4760
|
window?: {
|
|
4750
4761
|
from?: string;
|
|
4751
4762
|
to?: string;
|
|
@@ -4762,7 +4773,7 @@ export interface MetricResult {
|
|
|
4762
4773
|
/** Move from `previous`, in basis points; a key is absent when the baseline is zero. */
|
|
4763
4774
|
change_bps?: Record<string, number>;
|
|
4764
4775
|
/** The baseline's own buckets, for a chart that draws both lines. */
|
|
4765
|
-
previous_series?: MetricPoint
|
|
4776
|
+
previous_series?: Array<MetricPoint>;
|
|
4766
4777
|
compare_window?: {
|
|
4767
4778
|
from?: string;
|
|
4768
4779
|
to?: string;
|
|
@@ -4790,7 +4801,7 @@ export interface AnalyticsFilter {
|
|
|
4790
4801
|
/** The operand of every op but in, not_in, is_set and not_set. */
|
|
4791
4802
|
value?: string;
|
|
4792
4803
|
/** The operands of in and not_in. */
|
|
4793
|
-
values?: string
|
|
4804
|
+
values?: Array<string>;
|
|
4794
4805
|
}
|
|
4795
4806
|
/** One sort key: a result column (`period`, a dimension, `count` or `<property>_<kind>`). */
|
|
4796
4807
|
export interface AnalyticsOrder {
|
|
@@ -4802,13 +4813,13 @@ export interface SavedMetricQuery {
|
|
|
4802
4813
|
/** The event stream, a name from `analytics.catalog`. */
|
|
4803
4814
|
stream: string;
|
|
4804
4815
|
/** Default one count. */
|
|
4805
|
-
measures?: AnalyticsMeasure
|
|
4816
|
+
measures?: Array<AnalyticsMeasure>;
|
|
4806
4817
|
/** Properties to group by; each becomes a column named without a leading `$`. */
|
|
4807
|
-
dimensions?: string
|
|
4818
|
+
dimensions?: Array<string>;
|
|
4808
4819
|
/** Adds a first column `period` (YYYY-MM-DD, or YYYY-MM-DD HH:00 by hour). */
|
|
4809
4820
|
bucket?: "hour" | "day" | "week" | "month";
|
|
4810
|
-
filters?: AnalyticsFilter
|
|
4811
|
-
order?: AnalyticsOrder
|
|
4821
|
+
filters?: Array<AnalyticsFilter>;
|
|
4822
|
+
order?: Array<AnalyticsOrder>;
|
|
4812
4823
|
}
|
|
4813
4824
|
/**
|
|
4814
4825
|
* A structured question over the workspace's own event streams. The
|
|
@@ -4828,8 +4839,8 @@ export interface AnalyticsResultColumn {
|
|
|
4828
4839
|
type: string;
|
|
4829
4840
|
}
|
|
4830
4841
|
export interface AnalyticsResult {
|
|
4831
|
-
columns: AnalyticsResultColumn
|
|
4832
|
-
rows: unknown
|
|
4842
|
+
columns: Array<AnalyticsResultColumn>;
|
|
4843
|
+
rows: Array<Array<unknown>>;
|
|
4833
4844
|
/** The HogQL that ran, for display only. */
|
|
4834
4845
|
sql: string;
|
|
4835
4846
|
row_count: number;
|
|
@@ -4846,12 +4857,12 @@ export interface AnalyticsProperty {
|
|
|
4846
4857
|
export interface AnalyticsStream {
|
|
4847
4858
|
name: string;
|
|
4848
4859
|
doc: string;
|
|
4849
|
-
properties: AnalyticsProperty
|
|
4860
|
+
properties: Array<AnalyticsProperty>;
|
|
4850
4861
|
}
|
|
4851
4862
|
export interface AnalyticsCatalog {
|
|
4852
4863
|
/** False until the platform has a PostHog query key. */
|
|
4853
4864
|
configured: boolean;
|
|
4854
|
-
streams: AnalyticsStream
|
|
4865
|
+
streams: Array<AnalyticsStream>;
|
|
4855
4866
|
}
|
|
4856
4867
|
export interface CanvasStat {
|
|
4857
4868
|
label: string;
|
|
@@ -4874,7 +4885,7 @@ export interface CanvasStat {
|
|
|
4874
4885
|
/** The query's goal, for the progress bar under the number. */
|
|
4875
4886
|
target?: number;
|
|
4876
4887
|
/** The displayed key's own buckets (grouped to at most 24), for the trend line. */
|
|
4877
|
-
spark?: number
|
|
4888
|
+
spark?: Array<number>;
|
|
4878
4889
|
}
|
|
4879
4890
|
/** Selects one live record source with optional filters (records blocks). */
|
|
4880
4891
|
export interface RecordsQuery {
|
|
@@ -4930,7 +4941,7 @@ export interface RecordsRowAction {
|
|
|
4930
4941
|
/** Tool input property that receives the row's id. */
|
|
4931
4942
|
id_field: string;
|
|
4932
4943
|
/** Row `status` values the action applies to (absent = every row). */
|
|
4933
|
-
statuses?: string
|
|
4944
|
+
statuses?: Array<string>;
|
|
4934
4945
|
variant?: CanvasAction["variant"];
|
|
4935
4946
|
icon?: CanvasIcon;
|
|
4936
4947
|
/** Question the viewer must accept before the tool runs. */
|
|
@@ -4950,15 +4961,15 @@ export interface RecordsRowAction {
|
|
|
4950
4961
|
*/
|
|
4951
4962
|
export interface RecordsResult {
|
|
4952
4963
|
source: RecordsQuery["source"];
|
|
4953
|
-
columns: RecordsColumn
|
|
4954
|
-
rows: JsonObject
|
|
4964
|
+
columns: Array<RecordsColumn>;
|
|
4965
|
+
rows: Array<JsonObject>;
|
|
4955
4966
|
currency?: string;
|
|
4956
4967
|
/** App path of the page listing these records. */
|
|
4957
4968
|
link?: string;
|
|
4958
4969
|
/** Per-record detail path with `{id}` standing for the row's id. */
|
|
4959
4970
|
link_template?: string;
|
|
4960
4971
|
/** Row-level tool actions this source supports. */
|
|
4961
|
-
actions?: RecordsRowAction
|
|
4972
|
+
actions?: Array<RecordsRowAction>;
|
|
4962
4973
|
}
|
|
4963
4974
|
/**
|
|
4964
4975
|
* One tool-backed quick action in an actions block: a button whose form
|
|
@@ -5011,8 +5022,8 @@ export interface CanvasProfile {
|
|
|
5011
5022
|
person_type?: string;
|
|
5012
5023
|
legal_form?: string;
|
|
5013
5024
|
ciiu_primary?: string;
|
|
5014
|
-
ciiu_secondary?: string
|
|
5015
|
-
fiscal_responsibilities?: string
|
|
5025
|
+
ciiu_secondary?: Array<string>;
|
|
5026
|
+
fiscal_responsibilities?: Array<string>;
|
|
5016
5027
|
city?: string;
|
|
5017
5028
|
address?: string;
|
|
5018
5029
|
email?: string;
|
|
@@ -5085,7 +5096,7 @@ export interface CRMDealEvent {
|
|
|
5085
5096
|
stage_name?: string;
|
|
5086
5097
|
status?: "open" | "won" | "lost";
|
|
5087
5098
|
/** The fields an edit changed. */
|
|
5088
|
-
fields?: string
|
|
5099
|
+
fields?: Array<string>;
|
|
5089
5100
|
/** What a conversion made. */
|
|
5090
5101
|
document_kind?: "quote" | "invoice";
|
|
5091
5102
|
document_id?: string;
|
|
@@ -5094,7 +5105,7 @@ export interface CRMDealEvent {
|
|
|
5094
5105
|
/** A deal's history, newest first (crm.deal_history). */
|
|
5095
5106
|
export interface CRMDealHistory {
|
|
5096
5107
|
deal_id: string;
|
|
5097
|
-
events: CRMDealEvent
|
|
5108
|
+
events: Array<CRMDealEvent>;
|
|
5098
5109
|
}
|
|
5099
5110
|
/** One kanban column: a pipeline stage and the deals sitting in it. */
|
|
5100
5111
|
export interface CRMBoardColumn {
|
|
@@ -5106,7 +5117,7 @@ export interface CRMBoardColumn {
|
|
|
5106
5117
|
count: number;
|
|
5107
5118
|
/** Sum of the column's deal amounts (integer cents). */
|
|
5108
5119
|
total_cents: number;
|
|
5109
|
-
deals: CRMDeal
|
|
5120
|
+
deals: Array<CRMDeal>;
|
|
5110
5121
|
}
|
|
5111
5122
|
/**
|
|
5112
5123
|
* The hydrated shape of a kanban block (crm.board): stages as ordered
|
|
@@ -5116,12 +5127,12 @@ export interface CRMBoardColumn {
|
|
|
5116
5127
|
export interface CRMBoardResult {
|
|
5117
5128
|
pipeline: string;
|
|
5118
5129
|
pipeline_name: string;
|
|
5119
|
-
pipelines: {
|
|
5130
|
+
pipelines: Array<{
|
|
5120
5131
|
key: string;
|
|
5121
5132
|
name: string;
|
|
5122
|
-
}
|
|
5133
|
+
}>;
|
|
5123
5134
|
currency: string;
|
|
5124
|
-
columns: CRMBoardColumn
|
|
5135
|
+
columns: Array<CRMBoardColumn>;
|
|
5125
5136
|
link?: string;
|
|
5126
5137
|
move_tool?: string;
|
|
5127
5138
|
}
|
|
@@ -5131,7 +5142,7 @@ export interface CRMFieldDef {
|
|
|
5131
5142
|
key: string;
|
|
5132
5143
|
label: string;
|
|
5133
5144
|
type: "text" | "number" | "date" | "select" | "multiselect" | "bool" | "url";
|
|
5134
|
-
options?: string
|
|
5145
|
+
options?: Array<string>;
|
|
5135
5146
|
required: boolean;
|
|
5136
5147
|
position: number;
|
|
5137
5148
|
active: boolean;
|
|
@@ -5155,7 +5166,7 @@ export interface CRMGridQuery {
|
|
|
5155
5166
|
/** party: only the archived contacts. */
|
|
5156
5167
|
archived?: boolean;
|
|
5157
5168
|
search?: string;
|
|
5158
|
-
filters?: CRMGridFilter
|
|
5169
|
+
filters?: Array<CRMGridFilter>;
|
|
5159
5170
|
sort?: string;
|
|
5160
5171
|
dir?: "asc" | "desc";
|
|
5161
5172
|
offset?: number;
|
|
@@ -5169,7 +5180,7 @@ export interface CRMGridColumn {
|
|
|
5169
5180
|
key: string;
|
|
5170
5181
|
kind: "text" | "number" | "money" | "count" | "date" | "datetime" | "status" | "stage" | "avatar" | "url" | "domain" | "tags" | "chips" | "select" | "multiselect" | "bool";
|
|
5171
5182
|
label?: string;
|
|
5172
|
-
options?: string
|
|
5183
|
+
options?: Array<string>;
|
|
5173
5184
|
custom?: boolean;
|
|
5174
5185
|
ai?: boolean;
|
|
5175
5186
|
field?: string;
|
|
@@ -5177,8 +5188,8 @@ export interface CRMGridColumn {
|
|
|
5177
5188
|
/** One page of the CRM grid plus what its toolbar needs. */
|
|
5178
5189
|
export interface CRMGridResult {
|
|
5179
5190
|
entity: "party" | "deal";
|
|
5180
|
-
columns: CRMGridColumn
|
|
5181
|
-
rows: JsonObject
|
|
5191
|
+
columns: Array<CRMGridColumn>;
|
|
5192
|
+
rows: Array<JsonObject>;
|
|
5182
5193
|
total: number;
|
|
5183
5194
|
/**
|
|
5184
5195
|
* How many records each tab holds, before search and filters: parties by
|
|
@@ -5188,19 +5199,19 @@ export interface CRMGridResult {
|
|
|
5188
5199
|
offset: number;
|
|
5189
5200
|
limit: number;
|
|
5190
5201
|
currency: string;
|
|
5191
|
-
fields: CRMFieldDef
|
|
5192
|
-
tags?: CRMPartyTag
|
|
5193
|
-
pipelines?: {
|
|
5202
|
+
fields: Array<CRMFieldDef>;
|
|
5203
|
+
tags?: Array<CRMPartyTag>;
|
|
5204
|
+
pipelines?: Array<{
|
|
5194
5205
|
key: string;
|
|
5195
5206
|
name: string;
|
|
5196
|
-
}
|
|
5197
|
-
stages?: {
|
|
5207
|
+
}>;
|
|
5208
|
+
stages?: Array<{
|
|
5198
5209
|
key: string;
|
|
5199
5210
|
name: string;
|
|
5200
5211
|
kind: string;
|
|
5201
5212
|
pipeline: string;
|
|
5202
|
-
}
|
|
5203
|
-
actions?: RecordsRowAction
|
|
5213
|
+
}>;
|
|
5214
|
+
actions?: Array<RecordsRowAction>;
|
|
5204
5215
|
link_template?: string;
|
|
5205
5216
|
}
|
|
5206
5217
|
/** How a workflow starts. */
|
|
@@ -5231,7 +5242,7 @@ export interface WorkflowCondition {
|
|
|
5231
5242
|
/** What a step is gated on. */
|
|
5232
5243
|
export interface WorkflowWhen {
|
|
5233
5244
|
match: "all" | "any";
|
|
5234
|
-
conditions: WorkflowCondition
|
|
5245
|
+
conditions: Array<WorkflowCondition>;
|
|
5235
5246
|
}
|
|
5236
5247
|
/** What a step does when its conditions do not hold. */
|
|
5237
5248
|
export type WorkflowOtherwise = "skip" | "stop" | "fail";
|
|
@@ -5253,7 +5264,7 @@ export interface WorkflowStep {
|
|
|
5253
5264
|
/** loop: the list to walk, as a template ({{steps.0.output.invoices}}). */
|
|
5254
5265
|
each?: string;
|
|
5255
5266
|
/** loop: what runs for each item, reading {{loop.item}} and {{loop.index}}. */
|
|
5256
|
-
steps?: WorkflowStep
|
|
5267
|
+
steps?: Array<WorkflowStep>;
|
|
5257
5268
|
/** loop: how many items at most (1-100, 25 by default). */
|
|
5258
5269
|
max_iterations?: number;
|
|
5259
5270
|
/** loop: whether one item's failure ends the run or is recorded and stepped over. */
|
|
@@ -5298,7 +5309,7 @@ export interface WorkflowRun {
|
|
|
5298
5309
|
started_at: string;
|
|
5299
5310
|
finished_at?: string;
|
|
5300
5311
|
updated_at: string;
|
|
5301
|
-
steps: WorkflowRunStep
|
|
5312
|
+
steps: Array<WorkflowRunStep>;
|
|
5302
5313
|
/** What the run knows (workflows.runs only): the triggering event, the input, each step's output. */
|
|
5303
5314
|
context?: JsonObject;
|
|
5304
5315
|
}
|
|
@@ -5308,7 +5319,7 @@ export interface Workflow {
|
|
|
5308
5319
|
name: string;
|
|
5309
5320
|
description: string;
|
|
5310
5321
|
trigger: WorkflowTrigger;
|
|
5311
|
-
steps: WorkflowStep
|
|
5322
|
+
steps: Array<WorkflowStep>;
|
|
5312
5323
|
live: boolean;
|
|
5313
5324
|
run_count: number;
|
|
5314
5325
|
next_run_at?: string;
|
|
@@ -5317,14 +5328,14 @@ export interface Workflow {
|
|
|
5317
5328
|
stats: WorkflowStats;
|
|
5318
5329
|
last_run?: WorkflowRun;
|
|
5319
5330
|
/** Recent runs (workflows.get only). */
|
|
5320
|
-
runs?: WorkflowRun
|
|
5331
|
+
runs?: Array<WorkflowRun>;
|
|
5321
5332
|
}
|
|
5322
5333
|
export interface SaveWorkflowInput {
|
|
5323
5334
|
key?: string;
|
|
5324
5335
|
name: string;
|
|
5325
5336
|
description?: string;
|
|
5326
5337
|
trigger: WorkflowTrigger;
|
|
5327
|
-
steps: WorkflowStep
|
|
5338
|
+
steps: Array<WorkflowStep>;
|
|
5328
5339
|
live?: boolean;
|
|
5329
5340
|
}
|
|
5330
5341
|
/** One project task as carried on the board, timeline, and projects.* outputs. */
|
|
@@ -5346,7 +5357,7 @@ export interface ProjectTask {
|
|
|
5346
5357
|
assignee_agent_id?: string;
|
|
5347
5358
|
start_on?: string;
|
|
5348
5359
|
due_on?: string;
|
|
5349
|
-
depends_on?: string
|
|
5360
|
+
depends_on?: Array<string>;
|
|
5350
5361
|
position: number;
|
|
5351
5362
|
completed_at?: string;
|
|
5352
5363
|
created_at: string;
|
|
@@ -5358,7 +5369,7 @@ export interface ProjectBoardColumn {
|
|
|
5358
5369
|
name: string;
|
|
5359
5370
|
kind: "open" | "done";
|
|
5360
5371
|
count: number;
|
|
5361
|
-
tasks: ProjectTask
|
|
5372
|
+
tasks: Array<ProjectTask>;
|
|
5362
5373
|
}
|
|
5363
5374
|
/** One project in a switcher, with the chat room it is talked about in. */
|
|
5364
5375
|
export interface ProjectRef {
|
|
@@ -5372,8 +5383,8 @@ export interface ProjectRef {
|
|
|
5372
5383
|
export interface ProjectBoardResult {
|
|
5373
5384
|
project: string;
|
|
5374
5385
|
project_name: string;
|
|
5375
|
-
projects: ProjectRef
|
|
5376
|
-
columns: ProjectBoardColumn
|
|
5386
|
+
projects: Array<ProjectRef>;
|
|
5387
|
+
columns: Array<ProjectBoardColumn>;
|
|
5377
5388
|
link?: string;
|
|
5378
5389
|
move_tool?: string;
|
|
5379
5390
|
}
|
|
@@ -5389,13 +5400,13 @@ export interface Project {
|
|
|
5389
5400
|
description?: string;
|
|
5390
5401
|
status: "active" | "completed" | "archived";
|
|
5391
5402
|
thread_id?: string;
|
|
5392
|
-
columns?: ProjectColumn
|
|
5393
|
-
members?: {
|
|
5403
|
+
columns?: Array<ProjectColumn>;
|
|
5404
|
+
members?: Array<{
|
|
5394
5405
|
user_id: string;
|
|
5395
5406
|
name: string;
|
|
5396
5407
|
email: string;
|
|
5397
5408
|
role: string;
|
|
5398
|
-
}
|
|
5409
|
+
}>;
|
|
5399
5410
|
created_at: string;
|
|
5400
5411
|
updated_at: string;
|
|
5401
5412
|
}
|
|
@@ -5425,11 +5436,11 @@ export interface ProjectTaskDetail extends ProjectTask {
|
|
|
5425
5436
|
created_by_name?: string;
|
|
5426
5437
|
/** The session the orchestrator works the task in, once it was handed the task. */
|
|
5427
5438
|
session_id?: string;
|
|
5428
|
-
columns: ProjectColumn
|
|
5439
|
+
columns: Array<ProjectColumn>;
|
|
5429
5440
|
/** The tasks this one waits on (finish-to-start). */
|
|
5430
|
-
depends_on_tasks: ProjectTaskLink
|
|
5441
|
+
depends_on_tasks: Array<ProjectTaskLink>;
|
|
5431
5442
|
/** The tasks waiting on this one. */
|
|
5432
|
-
blocks: ProjectTaskLink
|
|
5443
|
+
blocks: Array<ProjectTaskLink>;
|
|
5433
5444
|
}
|
|
5434
5445
|
export interface ProjectTimelineEdge {
|
|
5435
5446
|
task_id: string;
|
|
@@ -5439,11 +5450,11 @@ export interface ProjectTimelineEdge {
|
|
|
5439
5450
|
export interface ProjectTimelineResult {
|
|
5440
5451
|
project: string;
|
|
5441
5452
|
project_name: string;
|
|
5442
|
-
projects: ProjectRef
|
|
5453
|
+
projects: Array<ProjectRef>;
|
|
5443
5454
|
from?: string;
|
|
5444
5455
|
to?: string;
|
|
5445
|
-
tasks: ProjectTask
|
|
5446
|
-
edges: ProjectTimelineEdge
|
|
5456
|
+
tasks: Array<ProjectTask>;
|
|
5457
|
+
edges: Array<ProjectTimelineEdge>;
|
|
5447
5458
|
link?: string;
|
|
5448
5459
|
}
|
|
5449
5460
|
/**
|
|
@@ -5466,7 +5477,7 @@ export interface MyWorkResult {
|
|
|
5466
5477
|
/** The bucket tasks holds; counts always covers all of them. */
|
|
5467
5478
|
bucket: MyWorkBucket;
|
|
5468
5479
|
counts: Record<MyWorkBucket, number>;
|
|
5469
|
-
tasks: MyWorkTask
|
|
5480
|
+
tasks: Array<MyWorkTask>;
|
|
5470
5481
|
/** More near-term tasks exist than one read returns: the counts are floors. */
|
|
5471
5482
|
truncated: boolean;
|
|
5472
5483
|
link?: string;
|
|
@@ -5493,7 +5504,7 @@ export interface CRMInteraction {
|
|
|
5493
5504
|
source: "manual" | "gmail" | "outlook" | "whatsapp" | "web";
|
|
5494
5505
|
counterpart_email?: string | null;
|
|
5495
5506
|
external_thread_id?: string | null;
|
|
5496
|
-
participants?: string
|
|
5507
|
+
participants?: Array<string>;
|
|
5497
5508
|
created_at: string;
|
|
5498
5509
|
}
|
|
5499
5510
|
/** An address writing to us with no contact yet (crm.list_interactions unmatched=true). */
|
|
@@ -5503,8 +5514,8 @@ export interface UnmatchedInteractionEmail {
|
|
|
5503
5514
|
last_at: string;
|
|
5504
5515
|
}
|
|
5505
5516
|
export interface CRMInteractionsResult {
|
|
5506
|
-
interactions: CRMInteraction
|
|
5507
|
-
unmatched_emails?: UnmatchedInteractionEmail
|
|
5517
|
+
interactions: Array<CRMInteraction>;
|
|
5518
|
+
unmatched_emails?: Array<UnmatchedInteractionEmail>;
|
|
5508
5519
|
}
|
|
5509
5520
|
/** A connected mailbox syncing into the CRM timeline (email.list_accounts). */
|
|
5510
5521
|
export interface EmailAccount {
|
|
@@ -5648,7 +5659,7 @@ export interface MarketingConversation {
|
|
|
5648
5659
|
}
|
|
5649
5660
|
/** `marketing.list_conversations`: one page of conversations, and how many are unread overall. */
|
|
5650
5661
|
export interface MarketingConversationList {
|
|
5651
|
-
conversations: MarketingConversation
|
|
5662
|
+
conversations: Array<MarketingConversation>;
|
|
5652
5663
|
/** Conversations with unread messages across every channel, whatever the filters and limit. */
|
|
5653
5664
|
unread_total?: number;
|
|
5654
5665
|
}
|
|
@@ -5757,11 +5768,11 @@ export interface CallCenterQueue {
|
|
|
5757
5768
|
voice_agent: CallCenterVoiceAgent;
|
|
5758
5769
|
/** What the team tells the voice agent about the business. */
|
|
5759
5770
|
voice_agent_instructions: string;
|
|
5760
|
-
members: {
|
|
5771
|
+
members: Array<{
|
|
5761
5772
|
user_id: string;
|
|
5762
5773
|
name: string;
|
|
5763
5774
|
email: string;
|
|
5764
|
-
}
|
|
5775
|
+
}>;
|
|
5765
5776
|
created_at: string;
|
|
5766
5777
|
updated_at: string;
|
|
5767
5778
|
}
|
|
@@ -5800,14 +5811,14 @@ export interface PublicCallCenterAgentPull {
|
|
|
5800
5811
|
/** One person's call-center desk (`callcenter.desk`). */
|
|
5801
5812
|
export interface CallCenterDesk {
|
|
5802
5813
|
status: CallCenterStatus;
|
|
5803
|
-
queues: CallCenterQueue
|
|
5814
|
+
queues: Array<CallCenterQueue>;
|
|
5804
5815
|
/** Unanswered calls in the person's queues, while they are available. */
|
|
5805
|
-
ringing: MarketingCall
|
|
5816
|
+
ringing: Array<MarketingCall>;
|
|
5806
5817
|
/** The call the person holds. */
|
|
5807
5818
|
current: MarketingCall | null;
|
|
5808
|
-
recent: MarketingCall
|
|
5819
|
+
recent: Array<MarketingCall>;
|
|
5809
5820
|
/** Web callers waiting to be called back: from the person's queues, or every queue for an owner or admin. */
|
|
5810
|
-
callbacks?: MarketingCall
|
|
5821
|
+
callbacks?: Array<MarketingCall>;
|
|
5811
5822
|
}
|
|
5812
5823
|
export interface CallCenterAgent {
|
|
5813
5824
|
user_id: string;
|
|
@@ -5866,17 +5877,17 @@ export interface CallCenterToolCall {
|
|
|
5866
5877
|
}
|
|
5867
5878
|
/** Everything a call's log shows (`callcenter.transcript`). */
|
|
5868
5879
|
export interface CallCenterCallLog {
|
|
5869
|
-
lines: CallCenterTranscriptLine
|
|
5870
|
-
recordings: CallCenterRecording
|
|
5871
|
-
tool_calls: CallCenterToolCall
|
|
5880
|
+
lines: Array<CallCenterTranscriptLine>;
|
|
5881
|
+
recordings: Array<CallCenterRecording>;
|
|
5882
|
+
tool_calls: Array<CallCenterToolCall>;
|
|
5872
5883
|
}
|
|
5873
5884
|
/** The supervisor board (`callcenter.board`). */
|
|
5874
5885
|
export interface CallCenterBoard {
|
|
5875
|
-
queues: CallCenterQueue
|
|
5876
|
-
agents: CallCenterAgent
|
|
5877
|
-
live: MarketingCall
|
|
5878
|
-
stats: CallCenterQueueStats
|
|
5879
|
-
recent: MarketingCall
|
|
5886
|
+
queues: Array<CallCenterQueue>;
|
|
5887
|
+
agents: Array<CallCenterAgent>;
|
|
5888
|
+
live: Array<MarketingCall>;
|
|
5889
|
+
stats: Array<CallCenterQueueStats>;
|
|
5890
|
+
recent: Array<MarketingCall>;
|
|
5880
5891
|
}
|
|
5881
5892
|
/** Aggregated delivery counts for a WhatsApp template campaign. */
|
|
5882
5893
|
export interface MarketingCampaignStats {
|
|
@@ -5897,8 +5908,10 @@ export interface MarketingCampaign {
|
|
|
5897
5908
|
/** Meta template category used for cost estimation. */
|
|
5898
5909
|
template_category?: string;
|
|
5899
5910
|
tag_id?: string;
|
|
5900
|
-
|
|
5901
|
-
|
|
5911
|
+
/** The template's body parameters as stored, normally a list of strings. */
|
|
5912
|
+
body_params?: unknown;
|
|
5913
|
+
/** "queued", "sending", "completed" or "cancelled", or a value this SDK does not know yet. */
|
|
5914
|
+
status: string;
|
|
5902
5915
|
queued_count: number;
|
|
5903
5916
|
skipped_no_phone: number;
|
|
5904
5917
|
/** Count of billable delivered messages settled so far. */
|
|
@@ -5996,9 +6009,9 @@ export interface MarketingMediaFilter {
|
|
|
5996
6009
|
offset?: number;
|
|
5997
6010
|
}
|
|
5998
6011
|
export interface MarketingMediaPage {
|
|
5999
|
-
media:
|
|
6012
|
+
media: Array<MarketingMediaUpload & {
|
|
6000
6013
|
created_at: string;
|
|
6001
|
-
}
|
|
6014
|
+
}>;
|
|
6002
6015
|
next_offset: number | null;
|
|
6003
6016
|
}
|
|
6004
6017
|
export type MarketingPostPermissions = Record<"create" | "draft" | "submit" | "review" | "schedule" | "cancel", boolean>;
|
|
@@ -6019,34 +6032,34 @@ export interface MarketingPostRevision {
|
|
|
6019
6032
|
provider: string;
|
|
6020
6033
|
caption: string;
|
|
6021
6034
|
media_type: MarketingPost["media_type"];
|
|
6022
|
-
media_urls: string
|
|
6035
|
+
media_urls: Array<string>;
|
|
6023
6036
|
editor_name: string | null;
|
|
6024
6037
|
actor_type: string | null;
|
|
6025
6038
|
saved_at: string;
|
|
6026
6039
|
}
|
|
6027
6040
|
export interface MarketingPostHistory {
|
|
6028
|
-
revisions: MarketingPostRevision
|
|
6041
|
+
revisions: Array<MarketingPostRevision>;
|
|
6029
6042
|
before_version: number | null;
|
|
6030
6043
|
}
|
|
6031
6044
|
export interface MarketingHistory {
|
|
6032
6045
|
import: {
|
|
6033
6046
|
id: string;
|
|
6034
6047
|
started_at: string;
|
|
6035
|
-
sources: string
|
|
6048
|
+
sources: Array<string>;
|
|
6036
6049
|
} | null;
|
|
6037
|
-
sources: {
|
|
6050
|
+
sources: Array<{
|
|
6038
6051
|
source: string;
|
|
6039
6052
|
status: "collecting" | "complete" | "partial" | "failed";
|
|
6040
6053
|
pages: number;
|
|
6041
|
-
}
|
|
6042
|
-
pages: {
|
|
6054
|
+
}>;
|
|
6055
|
+
pages: Array<{
|
|
6043
6056
|
id: string;
|
|
6044
6057
|
source: string;
|
|
6045
6058
|
cursor: string;
|
|
6046
6059
|
next_cursor: string | null;
|
|
6047
6060
|
data: JsonObject;
|
|
6048
6061
|
observed_at: string;
|
|
6049
|
-
}
|
|
6062
|
+
}>;
|
|
6050
6063
|
next_cursor: string | null;
|
|
6051
6064
|
}
|
|
6052
6065
|
export interface MarketingPostStats {
|
|
@@ -6063,7 +6076,7 @@ export interface MarketingPost {
|
|
|
6063
6076
|
batch_id?: string;
|
|
6064
6077
|
media_type: "image" | "video" | "carousel" | "text" | "reels" | "story";
|
|
6065
6078
|
caption: string;
|
|
6066
|
-
media_urls: string
|
|
6079
|
+
media_urls: Array<string>;
|
|
6067
6080
|
status: "draft" | "in_review" | "approved" | "scheduled" | "publishing" | "published" | "failed" | "cancelled";
|
|
6068
6081
|
review_note?: string;
|
|
6069
6082
|
updated_at?: string;
|
|
@@ -6080,19 +6093,19 @@ export interface MarketingPost {
|
|
|
6080
6093
|
/** The Instagram and Facebook extras: first comment, alt text, collaborators. */
|
|
6081
6094
|
details?: MarketingPostDetails | null;
|
|
6082
6095
|
/** The workspace's own labels for the post; never published. */
|
|
6083
|
-
tags?: string
|
|
6096
|
+
tags?: Array<string>;
|
|
6084
6097
|
}
|
|
6085
6098
|
/** What an Instagram or Facebook post carries beside its caption. */
|
|
6086
6099
|
export interface MarketingPostDetails {
|
|
6087
6100
|
first_comment?: string;
|
|
6088
6101
|
alt_text?: string;
|
|
6089
|
-
collaborators?: string
|
|
6102
|
+
collaborators?: Array<string>;
|
|
6090
6103
|
}
|
|
6091
6104
|
/** The extras `marketing.create_post` and `marketing.save_post_draft` take. */
|
|
6092
6105
|
export interface MarketingPostDetailChoices {
|
|
6093
6106
|
first_comment?: string;
|
|
6094
6107
|
alt_text?: string;
|
|
6095
|
-
collaborators?: string
|
|
6108
|
+
collaborators?: Array<string>;
|
|
6096
6109
|
}
|
|
6097
6110
|
/** A caption the AI wrote for one network. */
|
|
6098
6111
|
export interface MarketingCaptionSuggestion {
|
|
@@ -6105,8 +6118,8 @@ export interface MarketingCaptionDraft {
|
|
|
6105
6118
|
status: "queued" | "done" | "failed";
|
|
6106
6119
|
brief: string;
|
|
6107
6120
|
tone: string;
|
|
6108
|
-
providers: string
|
|
6109
|
-
suggestions: MarketingCaptionSuggestion
|
|
6121
|
+
providers: Array<string>;
|
|
6122
|
+
suggestions: Array<MarketingCaptionSuggestion>;
|
|
6110
6123
|
/** Starts with a code: allowance_used, not_configured or failed. */
|
|
6111
6124
|
error: string;
|
|
6112
6125
|
created_at: string;
|
|
@@ -6131,7 +6144,7 @@ export interface MarketingPostScheduleSlot {
|
|
|
6131
6144
|
export interface MarketingPostSchedule {
|
|
6132
6145
|
channel_id: string;
|
|
6133
6146
|
time_zone: string | null;
|
|
6134
|
-
slots: MarketingPostScheduleSlot
|
|
6147
|
+
slots: Array<MarketingPostScheduleSlot>;
|
|
6135
6148
|
next_slot: string | null;
|
|
6136
6149
|
}
|
|
6137
6150
|
/** A weekday and hour an account's published posts drew the most interactions at. */
|
|
@@ -6145,7 +6158,7 @@ export interface MarketingBestTime {
|
|
|
6145
6158
|
export interface MarketingBestTimes {
|
|
6146
6159
|
time_zone: string;
|
|
6147
6160
|
sample: number;
|
|
6148
|
-
times: MarketingBestTime
|
|
6161
|
+
times: Array<MarketingBestTime>;
|
|
6149
6162
|
}
|
|
6150
6163
|
/** Who can view a TikTok video, as TikTok's creator info offers the levels. */
|
|
6151
6164
|
export type TikTokPrivacyLevel = "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY";
|
|
@@ -6172,7 +6185,7 @@ export interface TikTokCreatorInfo {
|
|
|
6172
6185
|
creator_avatar_url: string;
|
|
6173
6186
|
creator_username: string;
|
|
6174
6187
|
creator_nickname: string;
|
|
6175
|
-
privacy_level_options: TikTokPrivacyLevel
|
|
6188
|
+
privacy_level_options: Array<TikTokPrivacyLevel>;
|
|
6176
6189
|
comment_disabled: boolean;
|
|
6177
6190
|
duet_disabled: boolean;
|
|
6178
6191
|
stitch_disabled: boolean;
|
|
@@ -6192,7 +6205,8 @@ export interface MarketingAdAccount {
|
|
|
6192
6205
|
}
|
|
6193
6206
|
/** Email marketing: the workspace's sender identity and SES tenant state (marketing.email_status). */
|
|
6194
6207
|
export interface EmailMarketingSettings {
|
|
6195
|
-
|
|
6208
|
+
/** "pending", "active", "paused" or "error", or a value this SDK does not know yet. */
|
|
6209
|
+
status: string;
|
|
6196
6210
|
from_name: string;
|
|
6197
6211
|
from_email: string;
|
|
6198
6212
|
reply_to: string;
|
|
@@ -6242,7 +6256,7 @@ export interface EmailSesReputation {
|
|
|
6242
6256
|
ses_cause: string;
|
|
6243
6257
|
customer_status: string;
|
|
6244
6258
|
customer_cause: string;
|
|
6245
|
-
findings: EmailReputationFinding
|
|
6259
|
+
findings: Array<EmailReputationFinding>;
|
|
6246
6260
|
}
|
|
6247
6261
|
/**
|
|
6248
6262
|
* How the workspace's sending looks to SES (marketing.email_reputation):
|
|
@@ -6278,7 +6292,7 @@ export interface EmailSpamFinding {
|
|
|
6278
6292
|
export interface EmailSpamReview {
|
|
6279
6293
|
/** 0–100; 100 is nothing to fix. */
|
|
6280
6294
|
score: number;
|
|
6281
|
-
findings: EmailSpamFinding
|
|
6295
|
+
findings: Array<EmailSpamFinding>;
|
|
6282
6296
|
html: string;
|
|
6283
6297
|
text: string;
|
|
6284
6298
|
}
|
|
@@ -6293,18 +6307,18 @@ export interface EmailFixProposal {
|
|
|
6293
6307
|
subject: string;
|
|
6294
6308
|
preheader: string;
|
|
6295
6309
|
design: unknown;
|
|
6296
|
-
fixed: string
|
|
6310
|
+
fixed: Array<string>;
|
|
6297
6311
|
score: number;
|
|
6298
|
-
findings: EmailSpamFinding
|
|
6312
|
+
findings: Array<EmailSpamFinding>;
|
|
6299
6313
|
suggested: boolean;
|
|
6300
6314
|
suggestions: {
|
|
6301
6315
|
subject?: string;
|
|
6302
6316
|
preheader?: string;
|
|
6303
|
-
blocks: {
|
|
6317
|
+
blocks: Array<{
|
|
6304
6318
|
id: string;
|
|
6305
6319
|
alt?: string;
|
|
6306
6320
|
text?: string;
|
|
6307
|
-
}
|
|
6321
|
+
}>;
|
|
6308
6322
|
};
|
|
6309
6323
|
}
|
|
6310
6324
|
/** A reusable email design (marketing.save_email_template). `design` is the builder document. */
|
|
@@ -6314,7 +6328,7 @@ export interface EmailTemplate {
|
|
|
6314
6328
|
subject: string;
|
|
6315
6329
|
preheader: string;
|
|
6316
6330
|
spam_score: number;
|
|
6317
|
-
spam_findings: EmailSpamFinding
|
|
6331
|
+
spam_findings: Array<EmailSpamFinding>;
|
|
6318
6332
|
design?: unknown;
|
|
6319
6333
|
html?: string;
|
|
6320
6334
|
text?: string;
|
|
@@ -6344,7 +6358,7 @@ export interface EmailTemplateRevision {
|
|
|
6344
6358
|
design?: unknown;
|
|
6345
6359
|
html?: string;
|
|
6346
6360
|
text?: string;
|
|
6347
|
-
spam_findings?: EmailSpamFinding
|
|
6361
|
+
spam_findings?: Array<EmailSpamFinding>;
|
|
6348
6362
|
}
|
|
6349
6363
|
/**
|
|
6350
6364
|
* A group of blocks a workspace keeps to use again (marketing.list_email_rows):
|
|
@@ -6386,8 +6400,10 @@ export interface EmailCampaign {
|
|
|
6386
6400
|
from_email: string;
|
|
6387
6401
|
reply_to: string;
|
|
6388
6402
|
tag_id: string | null;
|
|
6389
|
-
|
|
6390
|
-
|
|
6403
|
+
/** The targeted party ids as stored, normally a list of strings. */
|
|
6404
|
+
party_ids: unknown;
|
|
6405
|
+
/** A {@link EmailCampaignStatus}, or a value this SDK does not know yet. */
|
|
6406
|
+
status: string;
|
|
6391
6407
|
scheduled_at: string | null;
|
|
6392
6408
|
started_at: string | null;
|
|
6393
6409
|
completed_at: string | null;
|
|
@@ -6401,7 +6417,11 @@ export interface EmailCampaignRecipient {
|
|
|
6401
6417
|
party_id: string | null;
|
|
6402
6418
|
email: string;
|
|
6403
6419
|
name: string;
|
|
6404
|
-
|
|
6420
|
+
/**
|
|
6421
|
+
* "pending", "sending", "sent", "delivered", "bounced", "complained",
|
|
6422
|
+
* "failed" or "skipped", or a value this SDK does not know yet.
|
|
6423
|
+
*/
|
|
6424
|
+
status: string;
|
|
6405
6425
|
opens: number;
|
|
6406
6426
|
clicks: number;
|
|
6407
6427
|
first_opened_at: string | null;
|
|
@@ -6417,17 +6437,17 @@ export interface EmailCampaignDetail {
|
|
|
6417
6437
|
/** Hourly buckets per event type (open, click, delivery, bounce, unsubscribe). */
|
|
6418
6438
|
/** The visits this campaign's links brought to the workspace's own sites. */
|
|
6419
6439
|
site_visits: AttributedSiteVisits;
|
|
6420
|
-
timeline: {
|
|
6440
|
+
timeline: Array<{
|
|
6421
6441
|
hour: string;
|
|
6422
6442
|
type: string;
|
|
6423
6443
|
count: number;
|
|
6424
|
-
}
|
|
6425
|
-
links: {
|
|
6444
|
+
}>;
|
|
6445
|
+
links: Array<{
|
|
6426
6446
|
link: string;
|
|
6427
6447
|
clicks: number;
|
|
6428
6448
|
recipients: number;
|
|
6429
|
-
}
|
|
6430
|
-
recipients: EmailCampaignRecipient
|
|
6449
|
+
}>;
|
|
6450
|
+
recipients: Array<EmailCampaignRecipient>;
|
|
6431
6451
|
}
|
|
6432
6452
|
export interface EmailUnsubscribe {
|
|
6433
6453
|
email: string;
|
|
@@ -6436,7 +6456,7 @@ export interface EmailUnsubscribe {
|
|
|
6436
6456
|
created_at: string;
|
|
6437
6457
|
}
|
|
6438
6458
|
export interface MarketingAdAccounts {
|
|
6439
|
-
accounts: MarketingAdAccount
|
|
6459
|
+
accounts: Array<MarketingAdAccount>;
|
|
6440
6460
|
can_manage: boolean;
|
|
6441
6461
|
}
|
|
6442
6462
|
/** The window every marketing analytics answer echoes back, as YYYY-MM-DD. */
|
|
@@ -6450,7 +6470,7 @@ export interface MarketingWindow {
|
|
|
6450
6470
|
export interface MarketingChannelMetric {
|
|
6451
6471
|
metric: string;
|
|
6452
6472
|
/** "daily" (that day's value) or "account" (a lifetime counter as it stood). */
|
|
6453
|
-
basis:
|
|
6473
|
+
basis: string;
|
|
6454
6474
|
/** Whether summing across days means anything. False for reach and every counter. */
|
|
6455
6475
|
additive: boolean;
|
|
6456
6476
|
/** The sum over the window — only meaningful when `additive`. */
|
|
@@ -6476,7 +6496,7 @@ export interface MarketingAccountComparison {
|
|
|
6476
6496
|
audience: number | null;
|
|
6477
6497
|
audience_change: number | null;
|
|
6478
6498
|
posts_published: number;
|
|
6479
|
-
metrics: MarketingChannelMetric
|
|
6499
|
+
metrics: Array<MarketingChannelMetric>;
|
|
6480
6500
|
}
|
|
6481
6501
|
export interface MarketingAdComparison {
|
|
6482
6502
|
ad_account_id: string;
|
|
@@ -6511,23 +6531,24 @@ export interface MarketingPublication {
|
|
|
6511
6531
|
date: string;
|
|
6512
6532
|
}
|
|
6513
6533
|
export interface MarketingAccountsComparison extends MarketingWindow {
|
|
6514
|
-
channels: MarketingAccountComparison
|
|
6515
|
-
ad_accounts: MarketingAdComparison
|
|
6534
|
+
channels: Array<MarketingAccountComparison>;
|
|
6535
|
+
ad_accounts: Array<MarketingAdComparison>;
|
|
6516
6536
|
/** Every post published inside the window, oldest first. */
|
|
6517
|
-
publications: MarketingPublication
|
|
6537
|
+
publications: Array<MarketingPublication>;
|
|
6518
6538
|
}
|
|
6519
6539
|
export interface MarketingChannelSeries {
|
|
6520
6540
|
channel_id: string;
|
|
6521
|
-
|
|
6541
|
+
/** "daily" or "account", or a value this SDK does not know yet. */
|
|
6542
|
+
basis: string;
|
|
6522
6543
|
additive: boolean;
|
|
6523
|
-
points: {
|
|
6544
|
+
points: Array<{
|
|
6524
6545
|
date: string;
|
|
6525
6546
|
value: number;
|
|
6526
|
-
}
|
|
6547
|
+
}>;
|
|
6527
6548
|
}
|
|
6528
6549
|
export interface MarketingChannelTrend extends MarketingWindow {
|
|
6529
6550
|
metric: string;
|
|
6530
|
-
series: MarketingChannelSeries
|
|
6551
|
+
series: Array<MarketingChannelSeries>;
|
|
6531
6552
|
}
|
|
6532
6553
|
export interface MarketingAdPoint {
|
|
6533
6554
|
ad_account_id: string;
|
|
@@ -6542,7 +6563,7 @@ export interface MarketingAdPoint {
|
|
|
6542
6563
|
reach: number | null;
|
|
6543
6564
|
}
|
|
6544
6565
|
export interface MarketingAdTrend extends MarketingWindow {
|
|
6545
|
-
points: MarketingAdPoint
|
|
6566
|
+
points: Array<MarketingAdPoint>;
|
|
6546
6567
|
}
|
|
6547
6568
|
export interface MarketingTopPost {
|
|
6548
6569
|
post_id: string;
|
|
@@ -6561,7 +6582,7 @@ export interface MarketingTopPost {
|
|
|
6561
6582
|
metrics: Record<string, number>;
|
|
6562
6583
|
}
|
|
6563
6584
|
export interface MarketingTopPosts extends MarketingWindow {
|
|
6564
|
-
posts: MarketingTopPost
|
|
6585
|
+
posts: Array<MarketingTopPost>;
|
|
6565
6586
|
}
|
|
6566
6587
|
export interface MarketingMetricSnapshot {
|
|
6567
6588
|
id: string;
|
|
@@ -6582,8 +6603,8 @@ export interface EmailMessage {
|
|
|
6582
6603
|
from: string;
|
|
6583
6604
|
/** The From header's display name ("Anthropic"); absent when it names no one, or on mail synced before it was kept. */
|
|
6584
6605
|
from_name?: string;
|
|
6585
|
-
to: string
|
|
6586
|
-
cc?: string
|
|
6606
|
+
to: Array<string>;
|
|
6607
|
+
cc?: Array<string>;
|
|
6587
6608
|
subject: string;
|
|
6588
6609
|
snippet: string;
|
|
6589
6610
|
unread: boolean;
|
|
@@ -6645,7 +6666,7 @@ export interface WhatsAppMessageTemplate {
|
|
|
6645
6666
|
}
|
|
6646
6667
|
/** email.list_messages result: one page plus the caller's unread total. */
|
|
6647
6668
|
export interface EmailInbox {
|
|
6648
|
-
messages: EmailMessage
|
|
6669
|
+
messages: Array<EmailMessage>;
|
|
6649
6670
|
unread_count: number;
|
|
6650
6671
|
}
|
|
6651
6672
|
/** What a member writes from their mailbox: a new message, or an answer to or forward of one. */
|
|
@@ -6664,8 +6685,8 @@ export interface EmailSend {
|
|
|
6664
6685
|
/** The inbox message it answers or forwards; absent for a new message. */
|
|
6665
6686
|
message_id?: string;
|
|
6666
6687
|
mode: EmailComposeMode;
|
|
6667
|
-
to: string
|
|
6668
|
-
cc: string
|
|
6688
|
+
to: Array<string>;
|
|
6689
|
+
cc: Array<string>;
|
|
6669
6690
|
subject: string;
|
|
6670
6691
|
status: "queued" | "sending" | "sent" | "failed";
|
|
6671
6692
|
error?: EmailSendFailure;
|
|
@@ -6679,15 +6700,15 @@ export interface EmailComposeInput {
|
|
|
6679
6700
|
message_id?: string;
|
|
6680
6701
|
/** The mailbox to write from; an answer defaults to the one that received the message. */
|
|
6681
6702
|
account_id?: string;
|
|
6682
|
-
to: string
|
|
6683
|
-
cc?: string
|
|
6703
|
+
to: Array<string>;
|
|
6704
|
+
cc?: Array<string>;
|
|
6684
6705
|
/** Defaults to the original's with Re: or Fwd: for an answer or forward. */
|
|
6685
6706
|
subject?: string;
|
|
6686
6707
|
/** Plain text; the mailbox's signature is added under it unless `signature` is false. */
|
|
6687
6708
|
body: string;
|
|
6688
6709
|
signature?: boolean;
|
|
6689
6710
|
/** Files uploaded with uploadEmailAttachment, at most 10 MB together. */
|
|
6690
|
-
attachment_ids?: string
|
|
6711
|
+
attachment_ids?: Array<string>;
|
|
6691
6712
|
}
|
|
6692
6713
|
/** POST /v1/email/attachments result: a file waiting in the composer. */
|
|
6693
6714
|
export interface EmailAttachmentUpload {
|
|
@@ -6704,8 +6725,8 @@ export interface EmailMessageBody {
|
|
|
6704
6725
|
from: string;
|
|
6705
6726
|
/** The From header's display name; empty when it names no one. */
|
|
6706
6727
|
from_name: string;
|
|
6707
|
-
to: string
|
|
6708
|
-
cc?: string
|
|
6728
|
+
to: Array<string>;
|
|
6729
|
+
cc?: Array<string>;
|
|
6709
6730
|
subject: string;
|
|
6710
6731
|
at: string;
|
|
6711
6732
|
/** Plain-text body (always present when the message had one). */
|
|
@@ -6717,7 +6738,7 @@ export interface EmailMessageBody {
|
|
|
6717
6738
|
*/
|
|
6718
6739
|
body_html?: string;
|
|
6719
6740
|
/** What the member wrote in answer that is still queued, failed, or sent but not yet synced back. */
|
|
6720
|
-
sends?: EmailSend
|
|
6741
|
+
sends?: Array<EmailSend>;
|
|
6721
6742
|
}
|
|
6722
6743
|
/**
|
|
6723
6744
|
* The calendar: what the workspace owes, on one timeline. `events` are
|
|
@@ -6744,8 +6765,8 @@ export interface AgendaQuery {
|
|
|
6744
6765
|
/** Window length in days from `from` when `to` is not given. */
|
|
6745
6766
|
days?: number;
|
|
6746
6767
|
/** Lanes to merge; all of them when omitted (events-only in a personal workspace). */
|
|
6747
|
-
sources?: AgendaSource
|
|
6748
|
-
kinds?: CalendarKind
|
|
6768
|
+
sources?: Array<AgendaSource>;
|
|
6769
|
+
kinds?: Array<CalendarKind>;
|
|
6749
6770
|
/** Entry cap (default 100; max 400). */
|
|
6750
6771
|
limit?: number;
|
|
6751
6772
|
/**
|
|
@@ -6777,7 +6798,7 @@ export interface CalendarConnection {
|
|
|
6777
6798
|
status: "active" | "error";
|
|
6778
6799
|
last_synced_at: string | null;
|
|
6779
6800
|
last_error: string | null;
|
|
6780
|
-
calendars: ConnectedCalendar
|
|
6801
|
+
calendars: Array<ConnectedCalendar>;
|
|
6781
6802
|
}
|
|
6782
6803
|
/** A drive a member connects, mirrored into their personal Docs. */
|
|
6783
6804
|
export type DriveProvider = "google" | "onedrive";
|
|
@@ -6865,7 +6886,7 @@ export interface CalendarRepeat {
|
|
|
6865
6886
|
/** Every how many days, weeks, months or years. */
|
|
6866
6887
|
interval: number;
|
|
6867
6888
|
/** For a weekly rule, the weekdays it falls on; empty otherwise. */
|
|
6868
|
-
weekdays: CalendarWeekday
|
|
6889
|
+
weekdays: Array<CalendarWeekday>;
|
|
6869
6890
|
/** The last day it may happen on (YYYY-MM-DD), when it ends on a date. */
|
|
6870
6891
|
until?: string;
|
|
6871
6892
|
/** How many times it happens in all, when it ends after a count. */
|
|
@@ -6880,12 +6901,12 @@ export type CalendarScope = "this" | "following" | "all";
|
|
|
6880
6901
|
export interface AgendaResult {
|
|
6881
6902
|
from: string;
|
|
6882
6903
|
to: string;
|
|
6883
|
-
entries: AgendaEntry
|
|
6904
|
+
entries: Array<AgendaEntry>;
|
|
6884
6905
|
/** Entries per source, before the limit was applied. */
|
|
6885
6906
|
counts: Record<string, number>;
|
|
6886
6907
|
/** Set when the limit dropped entries inside the window. */
|
|
6887
6908
|
truncated: boolean;
|
|
6888
|
-
warnings?: string
|
|
6909
|
+
warnings?: Array<string>;
|
|
6889
6910
|
}
|
|
6890
6911
|
/**
|
|
6891
6912
|
* The single entry an `event` block highlights: either one pinned stored
|
|
@@ -6941,7 +6962,7 @@ export interface CalendarEvent {
|
|
|
6941
6962
|
export interface CalendarEventList {
|
|
6942
6963
|
from: string;
|
|
6943
6964
|
to: string;
|
|
6944
|
-
events: CalendarEvent
|
|
6965
|
+
events: Array<CalendarEvent>;
|
|
6945
6966
|
}
|
|
6946
6967
|
/** Fields shared by calendar.create and calendar.update. */
|
|
6947
6968
|
export interface CalendarEventInput {
|
|
@@ -6965,7 +6986,7 @@ export interface CalendarEventInput {
|
|
|
6965
6986
|
/** Make it repeat ("none" stops a repeat); the rule travels whole. */
|
|
6966
6987
|
repeat?: CalendarRepeatFrequency | "none";
|
|
6967
6988
|
repeat_interval?: number;
|
|
6968
|
-
repeat_weekdays?: CalendarWeekday
|
|
6989
|
+
repeat_weekdays?: Array<CalendarWeekday>;
|
|
6969
6990
|
/** The last day it may happen on, YYYY-MM-DD. */
|
|
6970
6991
|
repeat_until?: string;
|
|
6971
6992
|
repeat_count?: number;
|
|
@@ -7020,7 +7041,7 @@ export interface CanvasParam {
|
|
|
7020
7041
|
/** Hint shown under the control. */
|
|
7021
7042
|
help?: string;
|
|
7022
7043
|
/** Choices (type="select"). */
|
|
7023
|
-
options?: CanvasParamOption
|
|
7044
|
+
options?: Array<CanvasParamOption>;
|
|
7024
7045
|
/** Records source the picker lists (type="record"). */
|
|
7025
7046
|
source?: string;
|
|
7026
7047
|
/** Blocks reading this param wait until it has a value. */
|
|
@@ -7039,8 +7060,12 @@ export interface CanvasParam {
|
|
|
7039
7060
|
* selector block (`block`/`field`).
|
|
7040
7061
|
*/
|
|
7041
7062
|
export interface CanvasInput {
|
|
7042
|
-
/**
|
|
7043
|
-
|
|
7063
|
+
/**
|
|
7064
|
+
* Query field — or, on a control block, tool input — receiving the value:
|
|
7065
|
+
* a {@link CanvasMetricTarget} or {@link CanvasRecordTarget} on a query
|
|
7066
|
+
* block, a {@link CanvasControlTarget} (any tool input name) on a control block.
|
|
7067
|
+
*/
|
|
7068
|
+
target: string;
|
|
7044
7069
|
/** Params-block key that supplies the value. */
|
|
7045
7070
|
param?: string;
|
|
7046
7071
|
/** Selector block key whose selected row supplies the value. */
|
|
@@ -7058,13 +7083,13 @@ export interface CanvasBlock {
|
|
|
7058
7083
|
*/
|
|
7059
7084
|
span?: number;
|
|
7060
7085
|
/** Nested blocks (container types); under `tabs` each child's title is its tab label. */
|
|
7061
|
-
children?: CanvasBlock
|
|
7086
|
+
children?: Array<CanvasBlock>;
|
|
7062
7087
|
/** Rendering variant: callout tone, heading level, or "collapsed" on a section. */
|
|
7063
7088
|
variant?: string;
|
|
7064
|
-
items?: CanvasStat
|
|
7089
|
+
items?: Array<CanvasStat>;
|
|
7065
7090
|
chart?: "line" | "area" | "bar" | "pie";
|
|
7066
7091
|
/** Value keys to plot; defaults to the metric's primary. */
|
|
7067
|
-
series?: string
|
|
7092
|
+
series?: Array<string>;
|
|
7068
7093
|
query?: MetricQuery;
|
|
7069
7094
|
/** Hydrated by the server. */
|
|
7070
7095
|
data?: MetricResult | null;
|
|
@@ -7077,7 +7102,7 @@ export interface CanvasBlock {
|
|
|
7077
7102
|
* buttons in a card, `button` as bare buttons, and `form` and `toggle`
|
|
7078
7103
|
* carry exactly one (rendered inline / as a switch).
|
|
7079
7104
|
*/
|
|
7080
|
-
actions?: CanvasAction
|
|
7105
|
+
actions?: Array<CanvasAction>;
|
|
7081
7106
|
markdown?: string;
|
|
7082
7107
|
/** Hydrated by the server (type=profile). */
|
|
7083
7108
|
profile?: CanvasProfile | null;
|
|
@@ -7094,7 +7119,7 @@ export interface CanvasBlock {
|
|
|
7094
7119
|
/** Hydrated by the server. */
|
|
7095
7120
|
event_data?: EventHighlight | null;
|
|
7096
7121
|
/** Viewer controls (type=params) whose values feed other blocks' inputs. */
|
|
7097
|
-
params?: CanvasParam
|
|
7122
|
+
params?: Array<CanvasParam>;
|
|
7098
7123
|
/** Read tool whose answer the block renders (type=result). */
|
|
7099
7124
|
result?: CanvasResultQuery;
|
|
7100
7125
|
/** Hydrated by the server. */
|
|
@@ -7110,7 +7135,7 @@ export interface CanvasBlock {
|
|
|
7110
7135
|
/** Follow another records block's selected row — shorthand for a single input. */
|
|
7111
7136
|
bind?: CanvasBind;
|
|
7112
7137
|
/** Query fields fed from a params control or another block's selection. */
|
|
7113
|
-
inputs?: CanvasInput
|
|
7138
|
+
inputs?: Array<CanvasInput>;
|
|
7114
7139
|
/**
|
|
7115
7140
|
* Set by the server on a block it deliberately did not hydrate: the
|
|
7116
7141
|
* panels of a tabs block behind the first. The client runs its query
|
|
@@ -7124,7 +7149,7 @@ export interface CanvasBlock {
|
|
|
7124
7149
|
* block naming its modules re-queries when one lands instead of
|
|
7125
7150
|
* waiting for a reload.
|
|
7126
7151
|
*/
|
|
7127
|
-
live?: string
|
|
7152
|
+
live?: Array<string>;
|
|
7128
7153
|
}
|
|
7129
7154
|
/**
|
|
7130
7155
|
* The Read tool a result block renders. Only tools that declare a canvas
|
|
@@ -7148,19 +7173,19 @@ export interface CanvasResultField {
|
|
|
7148
7173
|
export interface CanvasResultPart {
|
|
7149
7174
|
kind: "fields" | "table";
|
|
7150
7175
|
title?: string;
|
|
7151
|
-
fields?: CanvasResultField
|
|
7152
|
-
columns?: RecordsColumn
|
|
7153
|
-
rows?: JsonObject
|
|
7176
|
+
fields?: Array<CanvasResultField>;
|
|
7177
|
+
columns?: Array<RecordsColumn>;
|
|
7178
|
+
rows?: Array<JsonObject>;
|
|
7154
7179
|
}
|
|
7155
7180
|
/** A result block's hydrated payload. */
|
|
7156
7181
|
export interface CanvasResult {
|
|
7157
7182
|
tool: string;
|
|
7158
7183
|
/** Tenant functional currency, for the money columns. */
|
|
7159
7184
|
currency?: string;
|
|
7160
|
-
parts: CanvasResultPart
|
|
7185
|
+
parts: Array<CanvasResultPart>;
|
|
7161
7186
|
}
|
|
7162
7187
|
export interface CanvasSpec {
|
|
7163
|
-
blocks: CanvasBlock
|
|
7188
|
+
blocks: Array<CanvasBlock>;
|
|
7164
7189
|
}
|
|
7165
7190
|
export interface DashboardSummary {
|
|
7166
7191
|
id: string;
|
|
@@ -7265,7 +7290,7 @@ export interface SessionAsk {
|
|
|
7265
7290
|
/** The answer's json-render spec, when it drew one. */
|
|
7266
7291
|
ui?: UISpec;
|
|
7267
7292
|
/** The answer's Block Kit blocks, when it laid some out. */
|
|
7268
|
-
blocks?: MessageBlock
|
|
7293
|
+
blocks?: Array<MessageBlock>;
|
|
7269
7294
|
/**
|
|
7270
7295
|
* The action that waits for a person: decide it with `approveRun` /
|
|
7271
7296
|
* `denyRun` on `run_id`, the run that holds it (the session's own, or a
|
|
@@ -7278,7 +7303,7 @@ export interface SessionAsk {
|
|
|
7278
7303
|
input: Json;
|
|
7279
7304
|
};
|
|
7280
7305
|
/** The questions the run asked: answer with `answerRun`, or by writing in the thread. */
|
|
7281
|
-
questions?: RunQuestion
|
|
7306
|
+
questions?: Array<RunQuestion>;
|
|
7282
7307
|
/** What the run waits on was pending before this message: the message waits behind it. */
|
|
7283
7308
|
queued: boolean;
|
|
7284
7309
|
/** Why the run failed: `ai_allowance_used` when the plan refused the model. */
|
|
@@ -7296,10 +7321,10 @@ export interface ConversationTurn {
|
|
|
7296
7321
|
/** The json-render spec of an assistant turn. */
|
|
7297
7322
|
ui?: UISpec;
|
|
7298
7323
|
/** Block Kit blocks of an assistant turn. */
|
|
7299
|
-
message?: MessageBlock
|
|
7300
|
-
blocks?: CanvasBlock
|
|
7301
|
-
attachments?: ChatAttachment
|
|
7302
|
-
questions?: RunQuestion
|
|
7324
|
+
message?: Array<MessageBlock>;
|
|
7325
|
+
blocks?: Array<CanvasBlock>;
|
|
7326
|
+
attachments?: Array<ChatAttachment>;
|
|
7327
|
+
questions?: Array<RunQuestion>;
|
|
7303
7328
|
/** An in-chat authorization that was still undecided when saved. */
|
|
7304
7329
|
approval?: ChatApproval;
|
|
7305
7330
|
/** The member's answer to an authorization, on the user turn that sent it. */
|
|
@@ -7356,8 +7381,8 @@ export interface AgentSessionRun {
|
|
|
7356
7381
|
}
|
|
7357
7382
|
export interface AgentSessionDetail {
|
|
7358
7383
|
session: AgentSession;
|
|
7359
|
-
runs: AgentSessionRun
|
|
7360
|
-
pending_approvals: {
|
|
7384
|
+
runs: Array<AgentSessionRun>;
|
|
7385
|
+
pending_approvals: Array<{
|
|
7361
7386
|
approval_id: string;
|
|
7362
7387
|
run_id: string;
|
|
7363
7388
|
tool: string;
|
|
@@ -7365,17 +7390,17 @@ export interface AgentSessionDetail {
|
|
|
7365
7390
|
created_at: string;
|
|
7366
7391
|
/** Whether the caller may approve or deny this call (`InboxApproval.can_decide`'s rule). */
|
|
7367
7392
|
can_decide: boolean;
|
|
7368
|
-
}
|
|
7369
|
-
pending_questions: {
|
|
7393
|
+
}>;
|
|
7394
|
+
pending_questions: Array<{
|
|
7370
7395
|
run_id: string;
|
|
7371
|
-
questions: RunQuestion
|
|
7396
|
+
questions: Array<RunQuestion> | null;
|
|
7372
7397
|
created_at: string;
|
|
7373
|
-
}
|
|
7398
|
+
}>;
|
|
7374
7399
|
/** The member's own page-chat transcript; null for other origins or other members' chats. */
|
|
7375
7400
|
conversation: {
|
|
7376
7401
|
id: string;
|
|
7377
7402
|
title: string;
|
|
7378
|
-
thread: ConversationTurn
|
|
7403
|
+
thread: Array<ConversationTurn>;
|
|
7379
7404
|
} | null;
|
|
7380
7405
|
}
|
|
7381
7406
|
export interface ConversationSummary {
|
|
@@ -7391,7 +7416,7 @@ export interface ConversationSummary {
|
|
|
7391
7416
|
export interface Conversation {
|
|
7392
7417
|
id: string;
|
|
7393
7418
|
title: string;
|
|
7394
|
-
thread: ConversationTurn
|
|
7419
|
+
thread: Array<ConversationTurn>;
|
|
7395
7420
|
created_at: string;
|
|
7396
7421
|
updated_at: string;
|
|
7397
7422
|
}
|
|
@@ -7422,9 +7447,9 @@ export interface VoiceSession {
|
|
|
7422
7447
|
url: string;
|
|
7423
7448
|
}
|
|
7424
7449
|
export interface OverviewSuggestionsResponse {
|
|
7425
|
-
suggestions: OverviewSuggestion
|
|
7450
|
+
suggestions: Array<OverviewSuggestion>;
|
|
7426
7451
|
/** The first steps; absent from an API that predates them. */
|
|
7427
|
-
checklist?: OverviewChecklistStep
|
|
7452
|
+
checklist?: Array<OverviewChecklistStep>;
|
|
7428
7453
|
/** Tenant currency for formatting `_cents` params. */
|
|
7429
7454
|
currency: string;
|
|
7430
7455
|
}
|
|
@@ -7473,21 +7498,21 @@ export interface TaxConceptOverride {
|
|
|
7473
7498
|
export interface TaxProfileResponse {
|
|
7474
7499
|
profile: TaxProfile;
|
|
7475
7500
|
/** Keys the requested year overrides on top of the base profile. */
|
|
7476
|
-
year_override_keys: string
|
|
7501
|
+
year_override_keys: Array<string> | null;
|
|
7477
7502
|
/** Years that carry their own settings (tax.set_profile with year). */
|
|
7478
|
-
overridden_years: number
|
|
7479
|
-
concepts: TaxConcept
|
|
7503
|
+
overridden_years: Array<number>;
|
|
7504
|
+
concepts: Array<TaxConcept>;
|
|
7480
7505
|
overrides: Record<string, TaxConceptOverride>;
|
|
7481
7506
|
reteiva_rate_bps: number;
|
|
7482
|
-
ica_defaults: {
|
|
7507
|
+
ica_defaults: Array<{
|
|
7483
7508
|
municipality: string;
|
|
7484
7509
|
dane_code: string;
|
|
7485
7510
|
commerce_ppm: number;
|
|
7486
7511
|
services_ppm: number;
|
|
7487
7512
|
industrial_ppm: number;
|
|
7488
|
-
}
|
|
7489
|
-
exogena_formats: string
|
|
7490
|
-
warnings: string
|
|
7513
|
+
}>;
|
|
7514
|
+
exogena_formats: Array<string>;
|
|
7515
|
+
warnings: Array<string>;
|
|
7491
7516
|
}
|
|
7492
7517
|
/** A third party's tax regime — what decides how much we withhold. */
|
|
7493
7518
|
export interface PartyTaxProfile {
|
|
@@ -7523,8 +7548,8 @@ export interface WithholdingSuggestion {
|
|
|
7523
7548
|
reteica_municipality?: string;
|
|
7524
7549
|
total_withheld_cents: number;
|
|
7525
7550
|
net_payable_cents: number;
|
|
7526
|
-
rationale: string
|
|
7527
|
-
warnings?: string
|
|
7551
|
+
rationale: Array<string>;
|
|
7552
|
+
warnings?: Array<string>;
|
|
7528
7553
|
}
|
|
7529
7554
|
export interface WithholdingSuggestResponse {
|
|
7530
7555
|
suggestion: WithholdingSuggestion;
|
|
@@ -7546,7 +7571,7 @@ export interface TaxRateBucket {
|
|
|
7546
7571
|
documents: number;
|
|
7547
7572
|
}
|
|
7548
7573
|
export interface TaxRateSection {
|
|
7549
|
-
by_rate: TaxRateBucket
|
|
7574
|
+
by_rate: Array<TaxRateBucket>;
|
|
7550
7575
|
total_base_cents: number;
|
|
7551
7576
|
total_tax_cents: number;
|
|
7552
7577
|
documents: number;
|
|
@@ -7593,7 +7618,7 @@ export interface IvaReport {
|
|
|
7593
7618
|
};
|
|
7594
7619
|
/** Formulario 300 boxes the books can fill, keyed by renglón. */
|
|
7595
7620
|
renglones: Record<string, number>;
|
|
7596
|
-
warnings: string
|
|
7621
|
+
warnings: Array<string>;
|
|
7597
7622
|
}
|
|
7598
7623
|
export interface WithholdingPartyRow {
|
|
7599
7624
|
party_id?: string;
|
|
@@ -7614,12 +7639,12 @@ export interface WithholdingReport {
|
|
|
7614
7639
|
period_end: string;
|
|
7615
7640
|
currency: string;
|
|
7616
7641
|
practicadas: {
|
|
7617
|
-
rows: WithholdingPartyRow
|
|
7642
|
+
rows: Array<WithholdingPartyRow>;
|
|
7618
7643
|
base_cents: number;
|
|
7619
7644
|
retefuente_cents: number;
|
|
7620
7645
|
reteiva_cents: number;
|
|
7621
7646
|
reteica_cents: number;
|
|
7622
|
-
payroll: {
|
|
7647
|
+
payroll: Array<{
|
|
7623
7648
|
employee_id: string;
|
|
7624
7649
|
name: string;
|
|
7625
7650
|
document_type: string;
|
|
@@ -7627,20 +7652,20 @@ export interface WithholdingReport {
|
|
|
7627
7652
|
gross_cents: number;
|
|
7628
7653
|
withholding_cents: number;
|
|
7629
7654
|
payslips: number;
|
|
7630
|
-
}
|
|
7655
|
+
}>;
|
|
7631
7656
|
payroll_base_cents: number;
|
|
7632
7657
|
payroll_withholding_cents: number;
|
|
7633
7658
|
total_cents: number;
|
|
7634
7659
|
};
|
|
7635
7660
|
sufridas: {
|
|
7636
|
-
rows: {
|
|
7661
|
+
rows: Array<{
|
|
7637
7662
|
party_id?: string;
|
|
7638
7663
|
party_name: string;
|
|
7639
7664
|
party_tax_id?: string;
|
|
7640
7665
|
amount_cents: number;
|
|
7641
7666
|
withheld_cents: number;
|
|
7642
7667
|
payments: number;
|
|
7643
|
-
}
|
|
7668
|
+
}>;
|
|
7644
7669
|
total_cents: number;
|
|
7645
7670
|
};
|
|
7646
7671
|
ledger: {
|
|
@@ -7648,7 +7673,7 @@ export interface WithholdingReport {
|
|
|
7648
7673
|
withholding_receivable: TaxAccountTie;
|
|
7649
7674
|
ties: boolean;
|
|
7650
7675
|
};
|
|
7651
|
-
warnings: string
|
|
7676
|
+
warnings: Array<string>;
|
|
7652
7677
|
}
|
|
7653
7678
|
export interface WithholdingCertificate {
|
|
7654
7679
|
party_id?: string;
|
|
@@ -7657,7 +7682,7 @@ export interface WithholdingCertificate {
|
|
|
7657
7682
|
party_tax_id_type?: string;
|
|
7658
7683
|
party_country?: string;
|
|
7659
7684
|
person_type: string;
|
|
7660
|
-
lines: {
|
|
7685
|
+
lines: Array<{
|
|
7661
7686
|
concept: string;
|
|
7662
7687
|
concept_name: string;
|
|
7663
7688
|
concept_certain: boolean;
|
|
@@ -7667,7 +7692,7 @@ export interface WithholdingCertificate {
|
|
|
7667
7692
|
reteiva_cents: number;
|
|
7668
7693
|
reteica_cents: number;
|
|
7669
7694
|
documents: number;
|
|
7670
|
-
}
|
|
7695
|
+
}>;
|
|
7671
7696
|
base_cents: number;
|
|
7672
7697
|
retefuente_cents: number;
|
|
7673
7698
|
reteiva_cents: number;
|
|
@@ -7683,8 +7708,8 @@ export interface WithholdingCertificatesReport {
|
|
|
7683
7708
|
nit_check_digit: string;
|
|
7684
7709
|
country: string;
|
|
7685
7710
|
};
|
|
7686
|
-
certificates: WithholdingCertificate
|
|
7687
|
-
warnings: string
|
|
7711
|
+
certificates: Array<WithholdingCertificate>;
|
|
7712
|
+
warnings: Array<string>;
|
|
7688
7713
|
}
|
|
7689
7714
|
export interface IcaReport {
|
|
7690
7715
|
period_start: string;
|
|
@@ -7693,7 +7718,7 @@ export interface IcaReport {
|
|
|
7693
7718
|
ica_period: string;
|
|
7694
7719
|
home_municipality: string;
|
|
7695
7720
|
rate_per_mil: number;
|
|
7696
|
-
municipalities: {
|
|
7721
|
+
municipalities: Array<{
|
|
7697
7722
|
municipality: string;
|
|
7698
7723
|
base_cents: number;
|
|
7699
7724
|
returns_cents: number;
|
|
@@ -7701,31 +7726,31 @@ export interface IcaReport {
|
|
|
7701
7726
|
rate_source: string;
|
|
7702
7727
|
tax_cents: number;
|
|
7703
7728
|
documents: number;
|
|
7704
|
-
}
|
|
7729
|
+
}>;
|
|
7705
7730
|
total_base_cents: number;
|
|
7706
7731
|
total_tax_cents: number;
|
|
7707
7732
|
reteica_practicada_cents: number;
|
|
7708
|
-
warnings: string
|
|
7733
|
+
warnings: Array<string>;
|
|
7709
7734
|
}
|
|
7710
7735
|
export interface ExogenaFormat {
|
|
7711
7736
|
code: string;
|
|
7712
7737
|
name: string;
|
|
7713
7738
|
version: string;
|
|
7714
|
-
columns: string
|
|
7739
|
+
columns: Array<string>;
|
|
7715
7740
|
source: string;
|
|
7716
7741
|
note?: string;
|
|
7717
7742
|
}
|
|
7718
7743
|
export interface ExogenaReport {
|
|
7719
7744
|
year: number;
|
|
7720
7745
|
format: ExogenaFormat;
|
|
7721
|
-
columns: string
|
|
7746
|
+
columns: Array<string>;
|
|
7722
7747
|
/** Rows aligned to `columns`; amounts are whole pesos. */
|
|
7723
|
-
rows: string
|
|
7748
|
+
rows: Array<Array<string>>;
|
|
7724
7749
|
row_count: number;
|
|
7725
7750
|
/** The same rows as a BOM-prefixed CSV, ready to download. */
|
|
7726
7751
|
csv: string;
|
|
7727
7752
|
currency: string;
|
|
7728
|
-
warnings: string
|
|
7753
|
+
warnings: Array<string>;
|
|
7729
7754
|
}
|
|
7730
7755
|
/** One upcoming filing. `verified` is always false — confirm with DIAN. */
|
|
7731
7756
|
export interface TaxObligation {
|
|
@@ -7743,9 +7768,9 @@ export interface TaxObligation {
|
|
|
7743
7768
|
}
|
|
7744
7769
|
export interface TaxCalendar {
|
|
7745
7770
|
as_of: string;
|
|
7746
|
-
obligations: TaxObligation
|
|
7771
|
+
obligations: Array<TaxObligation>;
|
|
7747
7772
|
profile: TaxProfile;
|
|
7748
|
-
warnings: string
|
|
7773
|
+
warnings: Array<string>;
|
|
7749
7774
|
}
|
|
7750
7775
|
export interface ClientOptions {
|
|
7751
7776
|
/** Base URL of the API, e.g. `https://api.nemphi.com`. */
|
|
@@ -7845,7 +7870,7 @@ export interface SalesDocument {
|
|
|
7845
7870
|
created_at: string;
|
|
7846
7871
|
updated_at: string;
|
|
7847
7872
|
/** Present on create/update/get responses. */
|
|
7848
|
-
lines?: OrderLine
|
|
7873
|
+
lines?: Array<OrderLine>;
|
|
7849
7874
|
/** Present on list rows. */
|
|
7850
7875
|
lines_count?: number;
|
|
7851
7876
|
/** Quotes only: valid_until has passed while the quote was still open. */
|
|
@@ -7873,7 +7898,7 @@ export interface PurchaseOrder {
|
|
|
7873
7898
|
delivery_address?: Record<string, string>;
|
|
7874
7899
|
created_at: string;
|
|
7875
7900
|
updated_at: string;
|
|
7876
|
-
lines?: OrderLine
|
|
7901
|
+
lines?: Array<OrderLine>;
|
|
7877
7902
|
lines_count?: number;
|
|
7878
7903
|
}
|
|
7879
7904
|
/** Create shape of quotes.create / sales_orders.create. */
|
|
@@ -7887,7 +7912,7 @@ export interface SalesDocumentInput {
|
|
|
7887
7912
|
currency?: string;
|
|
7888
7913
|
notes?: string;
|
|
7889
7914
|
terms?: string;
|
|
7890
|
-
lines: LineInput
|
|
7915
|
+
lines: Array<LineInput>;
|
|
7891
7916
|
}
|
|
7892
7917
|
export interface PurchaseOrderInput {
|
|
7893
7918
|
party_id: string;
|
|
@@ -7897,7 +7922,7 @@ export interface PurchaseOrderInput {
|
|
|
7897
7922
|
notes?: string;
|
|
7898
7923
|
terms?: string;
|
|
7899
7924
|
delivery_address?: Record<string, string>;
|
|
7900
|
-
lines: LineInput
|
|
7925
|
+
lines: Array<LineInput>;
|
|
7901
7926
|
}
|
|
7902
7927
|
/** "Take this much of that line" — partial invoicing, receiving, billing. */
|
|
7903
7928
|
export interface QuantitySelection {
|
|
@@ -7914,10 +7939,10 @@ export interface SalesDocumentDetail {
|
|
|
7914
7939
|
document: SalesDocument;
|
|
7915
7940
|
party: Party;
|
|
7916
7941
|
/** Invoices created from this quote or order. */
|
|
7917
|
-
invoices: Invoice
|
|
7942
|
+
invoices: Array<Invoice>;
|
|
7918
7943
|
related_quote?: SalesDocument;
|
|
7919
7944
|
/** Quotes: the orders they were converted into. */
|
|
7920
|
-
sales_orders?: SalesDocument
|
|
7945
|
+
sales_orders?: Array<SalesDocument>;
|
|
7921
7946
|
}
|
|
7922
7947
|
export interface PurchaseReceipt {
|
|
7923
7948
|
id: string;
|
|
@@ -7940,9 +7965,9 @@ export interface PurchaseReceiptLine {
|
|
|
7940
7965
|
export interface PurchaseOrderDetail {
|
|
7941
7966
|
purchase_order: PurchaseOrder;
|
|
7942
7967
|
party: Party;
|
|
7943
|
-
receipts: PurchaseReceipt
|
|
7944
|
-
receipt_lines: PurchaseReceiptLine
|
|
7945
|
-
bills: Bill
|
|
7968
|
+
receipts: Array<PurchaseReceipt>;
|
|
7969
|
+
receipt_lines: Array<PurchaseReceiptLine>;
|
|
7970
|
+
bills: Array<Bill>;
|
|
7946
7971
|
}
|
|
7947
7972
|
/**
|
|
7948
7973
|
* Three-way match verdict. `unreceived` is the blocking one: the vendor
|
|
@@ -7974,8 +7999,8 @@ export interface MatchReport {
|
|
|
7974
7999
|
party_id: string;
|
|
7975
8000
|
};
|
|
7976
8001
|
verdict: MatchVerdict;
|
|
7977
|
-
lines: MatchLine
|
|
7978
|
-
bills: Bill
|
|
8002
|
+
lines: Array<MatchLine>;
|
|
8003
|
+
bills: Array<Bill>;
|
|
7979
8004
|
unbilled_lines: number;
|
|
7980
8005
|
summary: string;
|
|
7981
8006
|
bill_id?: string;
|
|
@@ -8074,7 +8099,7 @@ export interface NemphiClient {
|
|
|
8074
8099
|
}): Promise<void>;
|
|
8075
8100
|
me(): Promise<{
|
|
8076
8101
|
user: User;
|
|
8077
|
-
memberships: Membership
|
|
8102
|
+
memberships: Array<Membership>;
|
|
8078
8103
|
session?: SessionInfo;
|
|
8079
8104
|
platform?: PlatformInfo;
|
|
8080
8105
|
}>;
|
|
@@ -8148,15 +8173,15 @@ export interface NemphiClient {
|
|
|
8148
8173
|
startTotpEnrollment(): Promise<TotpEnrollment>;
|
|
8149
8174
|
/** Prove the app holds the secret; returns the recovery codes, once. */
|
|
8150
8175
|
confirmTotpEnrollment(code: string): Promise<{
|
|
8151
|
-
recovery_codes: string
|
|
8176
|
+
recovery_codes: Array<string>;
|
|
8152
8177
|
}>;
|
|
8153
8178
|
/** Remove the authenticator and its recovery codes. Needs a current code. */
|
|
8154
8179
|
disableTotp(code: string): Promise<void>;
|
|
8155
8180
|
/** Replace the recovery codes; the old set stops working. */
|
|
8156
8181
|
regenerateRecoveryCodes(code: string): Promise<{
|
|
8157
|
-
recovery_codes: string
|
|
8182
|
+
recovery_codes: Array<string>;
|
|
8158
8183
|
}>;
|
|
8159
|
-
listPasskeys(): Promise<Passkey
|
|
8184
|
+
listPasskeys(): Promise<Array<Passkey>>;
|
|
8160
8185
|
beginPasskeyRegistration(): Promise<PasskeyChallenge>;
|
|
8161
8186
|
finishPasskeyRegistration(input: {
|
|
8162
8187
|
token: string;
|
|
@@ -8166,7 +8191,7 @@ export interface NemphiClient {
|
|
|
8166
8191
|
renamePasskey(id: string, name: string): Promise<void>;
|
|
8167
8192
|
deletePasskey(id: string): Promise<void>;
|
|
8168
8193
|
/** Identity providers connected to this account. */
|
|
8169
|
-
listIdentities(): Promise<ConnectedIdentity
|
|
8194
|
+
listIdentities(): Promise<Array<ConnectedIdentity>>;
|
|
8170
8195
|
/** Begin attaching a provider to this account rather than signing in. */
|
|
8171
8196
|
startIdentityLink(input: {
|
|
8172
8197
|
provider?: string;
|
|
@@ -8177,7 +8202,7 @@ export interface NemphiClient {
|
|
|
8177
8202
|
}>;
|
|
8178
8203
|
unlinkIdentity(id: string): Promise<void>;
|
|
8179
8204
|
/** List the user's live sessions; the one behind this call is flagged `current`. */
|
|
8180
|
-
listMySessions(): Promise<UserSession
|
|
8205
|
+
listMySessions(): Promise<Array<UserSession>>;
|
|
8181
8206
|
/** Revoke one session by id (revoking the current one acts as a logout). */
|
|
8182
8207
|
revokeMySession(id: string): Promise<{
|
|
8183
8208
|
revoked: boolean;
|
|
@@ -8187,19 +8212,19 @@ export interface NemphiClient {
|
|
|
8187
8212
|
revoked: number;
|
|
8188
8213
|
}>;
|
|
8189
8214
|
/** OAuth apps the member authorized (MCP clients and similar). */
|
|
8190
|
-
listMyOAuthApps(): Promise<OAuthConnectedApp
|
|
8215
|
+
listMyOAuthApps(): Promise<Array<OAuthConnectedApp>>;
|
|
8191
8216
|
/** Revoke one OAuth grant so that app can no longer call with its tokens. */
|
|
8192
8217
|
revokeMyOAuthApp(id: string): Promise<{
|
|
8193
8218
|
revoked: boolean;
|
|
8194
8219
|
}>;
|
|
8195
8220
|
listCalendarConnections(): Promise<{
|
|
8196
|
-
accounts: CalendarConnection
|
|
8221
|
+
accounts: Array<CalendarConnection>;
|
|
8197
8222
|
}>;
|
|
8198
8223
|
listConnectedCalendarEvents(input: {
|
|
8199
8224
|
from: string;
|
|
8200
8225
|
to: string;
|
|
8201
8226
|
}): Promise<{
|
|
8202
|
-
events: ConnectedCalendarEvent
|
|
8227
|
+
events: Array<ConnectedCalendarEvent>;
|
|
8203
8228
|
truncated: boolean;
|
|
8204
8229
|
}>;
|
|
8205
8230
|
connectCalendarAccount(input: {
|
|
@@ -8207,7 +8232,7 @@ export interface NemphiClient {
|
|
|
8207
8232
|
}): Promise<{
|
|
8208
8233
|
auth_url: string;
|
|
8209
8234
|
}>;
|
|
8210
|
-
listEmailAccounts(): Promise<EmailAccount
|
|
8235
|
+
listEmailAccounts(): Promise<Array<EmailAccount>>;
|
|
8211
8236
|
/** Start the OAuth handshake; open `auth_url` in the browser to finish. */
|
|
8212
8237
|
connectEmailAccount(input: {
|
|
8213
8238
|
provider: "gmail" | "outlook";
|
|
@@ -8245,7 +8270,7 @@ export interface NemphiClient {
|
|
|
8245
8270
|
filename?: string;
|
|
8246
8271
|
}): Promise<EmailAttachmentUpload>;
|
|
8247
8272
|
/** Ask the AI to label these inbox messages now (email.label_with_ai). */
|
|
8248
|
-
labelEmailWithAi(messageIds: string
|
|
8273
|
+
labelEmailWithAi(messageIds: Array<string>): Promise<{
|
|
8249
8274
|
queued: number;
|
|
8250
8275
|
}>;
|
|
8251
8276
|
crmSettings(): Promise<CRMSettings>;
|
|
@@ -8259,8 +8284,8 @@ export interface NemphiClient {
|
|
|
8259
8284
|
findProspects(): Promise<CRMProspectRun>;
|
|
8260
8285
|
/** The CRM as a spreadsheet: one page of contacts or deals with custom fields (crm.grid). */
|
|
8261
8286
|
crmGrid(query: CRMGridQuery): Promise<CRMGridResult>;
|
|
8262
|
-
listCRMFields(entity?: "deal" | "party"): Promise<CRMFieldDef
|
|
8263
|
-
listWorkflows(): Promise<Workflow
|
|
8287
|
+
listCRMFields(entity?: "deal" | "party"): Promise<Array<CRMFieldDef>>;
|
|
8288
|
+
listWorkflows(): Promise<Array<Workflow>>;
|
|
8264
8289
|
getWorkflow(key: string): Promise<Workflow>;
|
|
8265
8290
|
saveWorkflow(input: SaveWorkflowInput, opts?: InvokeOpts): Promise<Workflow>;
|
|
8266
8291
|
setWorkflowLive(key: string, live: boolean): Promise<Workflow>;
|
|
@@ -8268,9 +8293,9 @@ export interface NemphiClient {
|
|
|
8268
8293
|
deleteWorkflow(key: string): Promise<{
|
|
8269
8294
|
deleted: string;
|
|
8270
8295
|
}>;
|
|
8271
|
-
listWorkflowRuns(key: string, limit?: number): Promise<WorkflowRun
|
|
8296
|
+
listWorkflowRuns(key: string, limit?: number): Promise<Array<WorkflowRun>>;
|
|
8272
8297
|
cancelWorkflowRun(runId: string): Promise<WorkflowRun>;
|
|
8273
|
-
listMarketingChannels(): Promise<MarketingChannel
|
|
8298
|
+
listMarketingChannels(): Promise<Array<MarketingChannel>>;
|
|
8274
8299
|
connectWhatsApp(input: {
|
|
8275
8300
|
mode: "coexistence" | "dedicated";
|
|
8276
8301
|
return_to?: string;
|
|
@@ -8371,14 +8396,14 @@ export interface NemphiClient {
|
|
|
8371
8396
|
}>;
|
|
8372
8397
|
listEmailTemplates(input?: {
|
|
8373
8398
|
limit?: number;
|
|
8374
|
-
}): Promise<EmailTemplate
|
|
8399
|
+
}): Promise<Array<EmailTemplate>>;
|
|
8375
8400
|
getEmailTemplate(templateId: string): Promise<{
|
|
8376
8401
|
template: EmailTemplate;
|
|
8377
8402
|
}>;
|
|
8378
8403
|
deleteEmailTemplate(templateId: string): Promise<{
|
|
8379
8404
|
deleted: boolean;
|
|
8380
8405
|
}>;
|
|
8381
|
-
listEmailRows(): Promise<EmailSavedRow
|
|
8406
|
+
listEmailRows(): Promise<Array<EmailSavedRow>>;
|
|
8382
8407
|
saveEmailRow(input: {
|
|
8383
8408
|
row_id?: string;
|
|
8384
8409
|
name: string;
|
|
@@ -8393,7 +8418,7 @@ export interface NemphiClient {
|
|
|
8393
8418
|
template_id: string;
|
|
8394
8419
|
before_version?: number;
|
|
8395
8420
|
}): Promise<{
|
|
8396
|
-
revisions: EmailTemplateRevision
|
|
8421
|
+
revisions: Array<EmailTemplateRevision>;
|
|
8397
8422
|
before_version: number | null;
|
|
8398
8423
|
}>;
|
|
8399
8424
|
getEmailTemplateRevision(input: {
|
|
@@ -8421,7 +8446,7 @@ export interface NemphiClient {
|
|
|
8421
8446
|
template_id: string;
|
|
8422
8447
|
subject?: string;
|
|
8423
8448
|
tag_id?: string;
|
|
8424
|
-
party_ids?: string
|
|
8449
|
+
party_ids?: Array<string>;
|
|
8425
8450
|
}): Promise<{
|
|
8426
8451
|
campaign: EmailCampaign;
|
|
8427
8452
|
estimated_recipients: number;
|
|
@@ -8432,7 +8457,7 @@ export interface NemphiClient {
|
|
|
8432
8457
|
template_id?: string;
|
|
8433
8458
|
subject?: string;
|
|
8434
8459
|
tag_id?: string;
|
|
8435
|
-
party_ids?: string
|
|
8460
|
+
party_ids?: Array<string>;
|
|
8436
8461
|
}): Promise<{
|
|
8437
8462
|
campaign: EmailCampaign | null;
|
|
8438
8463
|
}>;
|
|
@@ -8451,12 +8476,12 @@ export interface NemphiClient {
|
|
|
8451
8476
|
limit?: number;
|
|
8452
8477
|
}): Promise<{
|
|
8453
8478
|
permissions: EmailMarketingPermissions;
|
|
8454
|
-
campaigns: EmailCampaign
|
|
8479
|
+
campaigns: Array<EmailCampaign>;
|
|
8455
8480
|
}>;
|
|
8456
8481
|
getEmailCampaign(campaignId: string, recipientsLimit?: number): Promise<EmailCampaignDetail>;
|
|
8457
8482
|
listEmailUnsubscribes(input?: {
|
|
8458
8483
|
limit?: number;
|
|
8459
|
-
}): Promise<EmailUnsubscribe
|
|
8484
|
+
}): Promise<Array<EmailUnsubscribe>>;
|
|
8460
8485
|
unsubscribeEmail(email: string): Promise<{
|
|
8461
8486
|
email: string;
|
|
8462
8487
|
unsubscribed: boolean;
|
|
@@ -8478,11 +8503,11 @@ export interface NemphiClient {
|
|
|
8478
8503
|
from?: string;
|
|
8479
8504
|
to?: string;
|
|
8480
8505
|
limit?: number;
|
|
8481
|
-
}): Promise<MarketingMetricSnapshot
|
|
8506
|
+
}): Promise<Array<MarketingMetricSnapshot>>;
|
|
8482
8507
|
createMarketingPost(input: {
|
|
8483
|
-
channel_ids: string
|
|
8508
|
+
channel_ids: Array<string>;
|
|
8484
8509
|
caption?: string;
|
|
8485
|
-
media_urls?: string
|
|
8510
|
+
media_urls?: Array<string>;
|
|
8486
8511
|
media_type?: MarketingPost["media_type"];
|
|
8487
8512
|
scheduled_at?: string;
|
|
8488
8513
|
/** Per-account captions keyed by channel id; an account named here gets its own text. */
|
|
@@ -8491,13 +8516,13 @@ export interface NemphiClient {
|
|
|
8491
8516
|
queue?: boolean;
|
|
8492
8517
|
} & TikTokPostChoices & MarketingPostDetailChoices): Promise<{
|
|
8493
8518
|
batch_id: string;
|
|
8494
|
-
posts: MarketingPost
|
|
8519
|
+
posts: Array<MarketingPost>;
|
|
8495
8520
|
note?: string;
|
|
8496
8521
|
}>;
|
|
8497
8522
|
getTikTokCreatorInfo(channelId: string): Promise<TikTokCreatorInfo>;
|
|
8498
8523
|
writeMarketingCaptions(input: {
|
|
8499
8524
|
brief: string;
|
|
8500
|
-
providers: string
|
|
8525
|
+
providers: Array<string>;
|
|
8501
8526
|
tone?: "friendly" | "professional" | "playful" | "bold";
|
|
8502
8527
|
language?: string;
|
|
8503
8528
|
current_caption?: string;
|
|
@@ -8510,12 +8535,12 @@ export interface NemphiClient {
|
|
|
8510
8535
|
listMarketingGenerations(input?: {
|
|
8511
8536
|
kind?: "image" | "video";
|
|
8512
8537
|
status?: MarketingGeneration["status"];
|
|
8513
|
-
}): Promise<MarketingGeneration
|
|
8514
|
-
listMarketingPostSchedules(): Promise<MarketingPostSchedule
|
|
8538
|
+
}): Promise<Array<MarketingGeneration>>;
|
|
8539
|
+
listMarketingPostSchedules(): Promise<Array<MarketingPostSchedule>>;
|
|
8515
8540
|
setMarketingPostSchedule(input: {
|
|
8516
8541
|
channel_id: string;
|
|
8517
8542
|
time_zone: string;
|
|
8518
|
-
slots: MarketingPostScheduleSlot
|
|
8543
|
+
slots: Array<MarketingPostScheduleSlot>;
|
|
8519
8544
|
}): Promise<MarketingPostSchedule>;
|
|
8520
8545
|
getMarketingBestPostTimes(input: {
|
|
8521
8546
|
channel_id: string;
|
|
@@ -8523,16 +8548,16 @@ export interface NemphiClient {
|
|
|
8523
8548
|
}): Promise<MarketingBestTimes>;
|
|
8524
8549
|
setMarketingPostTags(input: {
|
|
8525
8550
|
post_id: string;
|
|
8526
|
-
tags: string
|
|
8551
|
+
tags: Array<string>;
|
|
8527
8552
|
}): Promise<MarketingPost>;
|
|
8528
|
-
listMarketingPostNotes(postId: string): Promise<MarketingPostNote
|
|
8553
|
+
listMarketingPostNotes(postId: string): Promise<Array<MarketingPostNote>>;
|
|
8529
8554
|
addMarketingPostNote(input: {
|
|
8530
8555
|
post_id: string;
|
|
8531
8556
|
body: string;
|
|
8532
8557
|
}): Promise<MarketingPostNote>;
|
|
8533
8558
|
listMarketingSnippets(input?: {
|
|
8534
8559
|
kind?: MarketingSnippet["kind"];
|
|
8535
|
-
}): Promise<MarketingSnippet
|
|
8560
|
+
}): Promise<Array<MarketingSnippet>>;
|
|
8536
8561
|
saveMarketingSnippet(input: {
|
|
8537
8562
|
id?: string;
|
|
8538
8563
|
kind: MarketingSnippet["kind"];
|
|
@@ -8540,7 +8565,7 @@ export interface NemphiClient {
|
|
|
8540
8565
|
body: string;
|
|
8541
8566
|
}): Promise<MarketingSnippet>;
|
|
8542
8567
|
deleteMarketingSnippet(id: string): Promise<MarketingSnippet>;
|
|
8543
|
-
listMarketingIdeas(): Promise<MarketingIdea
|
|
8568
|
+
listMarketingIdeas(): Promise<Array<MarketingIdea>>;
|
|
8544
8569
|
saveMarketingIdea(input: {
|
|
8545
8570
|
id?: string;
|
|
8546
8571
|
title: string;
|
|
@@ -8558,7 +8583,7 @@ export interface NemphiClient {
|
|
|
8558
8583
|
}): Promise<MarketingHistory>;
|
|
8559
8584
|
listMarketingMedia(input?: MarketingMediaFilter): Promise<MarketingMediaPage>;
|
|
8560
8585
|
listMarketingPostBoard(input?: MarketingPostFilter): Promise<{
|
|
8561
|
-
posts: MarketingPost
|
|
8586
|
+
posts: Array<MarketingPost>;
|
|
8562
8587
|
permissions: MarketingPostPermissions;
|
|
8563
8588
|
}>;
|
|
8564
8589
|
listMarketingPosts(input?: {
|
|
@@ -8567,13 +8592,13 @@ export interface NemphiClient {
|
|
|
8567
8592
|
from?: string;
|
|
8568
8593
|
until?: string;
|
|
8569
8594
|
limit?: number;
|
|
8570
|
-
}): Promise<MarketingPost
|
|
8595
|
+
}): Promise<Array<MarketingPost>>;
|
|
8571
8596
|
saveMarketingPostDraft(input: {
|
|
8572
8597
|
post_id?: string;
|
|
8573
8598
|
channel_id: string;
|
|
8574
8599
|
caption?: string;
|
|
8575
8600
|
media_type?: MarketingPost["media_type"];
|
|
8576
|
-
media_urls?: string
|
|
8601
|
+
media_urls?: Array<string>;
|
|
8577
8602
|
} & TikTokPostChoices & MarketingPostDetailChoices): Promise<{
|
|
8578
8603
|
post: MarketingPost;
|
|
8579
8604
|
}>;
|
|
@@ -8613,8 +8638,8 @@ export interface NemphiClient {
|
|
|
8613
8638
|
needs_person_only?: boolean;
|
|
8614
8639
|
hot_leads_only?: boolean;
|
|
8615
8640
|
limit?: number;
|
|
8616
|
-
}): Promise<MarketingConversation
|
|
8617
|
-
listMarketingInboxTopics(): Promise<MarketingInboxTopic
|
|
8641
|
+
}): Promise<Array<MarketingConversation>>;
|
|
8642
|
+
listMarketingInboxTopics(): Promise<Array<MarketingInboxTopic>>;
|
|
8618
8643
|
saveMarketingInboxTopic(input: {
|
|
8619
8644
|
topic_id?: string;
|
|
8620
8645
|
name: string;
|
|
@@ -8641,7 +8666,7 @@ export interface NemphiClient {
|
|
|
8641
8666
|
limit?: number;
|
|
8642
8667
|
}): Promise<{
|
|
8643
8668
|
conversation: MarketingConversation;
|
|
8644
|
-
messages: MarketingMessage
|
|
8669
|
+
messages: Array<MarketingMessage>;
|
|
8645
8670
|
}>;
|
|
8646
8671
|
markMarketingConversationRead(conversationId: string): Promise<{
|
|
8647
8672
|
conversation: MarketingConversation;
|
|
@@ -8659,7 +8684,7 @@ export interface NemphiClient {
|
|
|
8659
8684
|
channel_id?: string;
|
|
8660
8685
|
post_id?: string;
|
|
8661
8686
|
limit?: number;
|
|
8662
|
-
}): Promise<MarketingComment
|
|
8687
|
+
}): Promise<Array<MarketingComment>>;
|
|
8663
8688
|
replyToMarketingComment(input: {
|
|
8664
8689
|
comment_id: string;
|
|
8665
8690
|
body: string;
|
|
@@ -8672,7 +8697,7 @@ export interface NemphiClient {
|
|
|
8672
8697
|
conversation_id: string;
|
|
8673
8698
|
assignee_user_id?: string;
|
|
8674
8699
|
}): Promise<MarketingConversation>;
|
|
8675
|
-
listMarketingConversationNotes(conversationId: string): Promise<MarketingConversationNote
|
|
8700
|
+
listMarketingConversationNotes(conversationId: string): Promise<Array<MarketingConversationNote>>;
|
|
8676
8701
|
addMarketingConversationNote(input: {
|
|
8677
8702
|
conversation_id: string;
|
|
8678
8703
|
body: string;
|
|
@@ -8688,7 +8713,7 @@ export interface NemphiClient {
|
|
|
8688
8713
|
status?: MarketingCallStatus;
|
|
8689
8714
|
party_id?: string;
|
|
8690
8715
|
limit?: number;
|
|
8691
|
-
}): Promise<MarketingCall
|
|
8716
|
+
}): Promise<Array<MarketingCall>>;
|
|
8692
8717
|
getMarketingCall(callId: string): Promise<{
|
|
8693
8718
|
call: MarketingCall;
|
|
8694
8719
|
}>;
|
|
@@ -8732,7 +8757,7 @@ export interface NemphiClient {
|
|
|
8732
8757
|
}>;
|
|
8733
8758
|
callCenterDesk(): Promise<CallCenterDesk>;
|
|
8734
8759
|
callCenterBoard(): Promise<CallCenterBoard>;
|
|
8735
|
-
listCallCenterQueues(): Promise<CallCenterQueue
|
|
8760
|
+
listCallCenterQueues(): Promise<Array<CallCenterQueue>>;
|
|
8736
8761
|
saveCallCenterQueue(input: {
|
|
8737
8762
|
queue_id?: string;
|
|
8738
8763
|
name: string;
|
|
@@ -8744,7 +8769,7 @@ export interface NemphiClient {
|
|
|
8744
8769
|
voice_agent?: CallCenterVoiceAgent;
|
|
8745
8770
|
/** What the voice agent should know; left out keeps it. */
|
|
8746
8771
|
voice_agent_instructions?: string;
|
|
8747
|
-
user_ids?: string
|
|
8772
|
+
user_ids?: Array<string>;
|
|
8748
8773
|
}): Promise<{
|
|
8749
8774
|
queue: CallCenterQueue | null;
|
|
8750
8775
|
}>;
|
|
@@ -8767,7 +8792,7 @@ export interface NemphiClient {
|
|
|
8767
8792
|
setCallCenterStatus(status: CallCenterStatus): Promise<{
|
|
8768
8793
|
status: CallCenterStatus;
|
|
8769
8794
|
}>;
|
|
8770
|
-
callCenterTranscript(callId: string): Promise<CallCenterTranscriptLine
|
|
8795
|
+
callCenterTranscript(callId: string): Promise<Array<CallCenterTranscriptLine>>;
|
|
8771
8796
|
/** A call's transcript with its recordings and the tools a voice agent called. */
|
|
8772
8797
|
callCenterCallLog(callId: string): Promise<CallCenterCallLog>;
|
|
8773
8798
|
addCallCenterTranscript(input: {
|
|
@@ -8788,28 +8813,28 @@ export interface NemphiClient {
|
|
|
8788
8813
|
}>;
|
|
8789
8814
|
/** Streams a call-center recording; pass the Range header to seek. */
|
|
8790
8815
|
downloadCallCenterRecording(recordingId: string, range?: string): Promise<Response>;
|
|
8791
|
-
listWhatsAppTemplates(channelId: string): Promise<WhatsAppMessageTemplate
|
|
8816
|
+
listWhatsAppTemplates(channelId: string): Promise<Array<WhatsAppMessageTemplate>>;
|
|
8792
8817
|
sendWhatsAppTemplate(input: {
|
|
8793
8818
|
channel_id: string;
|
|
8794
8819
|
template_name: string;
|
|
8795
8820
|
language: string;
|
|
8796
8821
|
template_category?: string;
|
|
8797
8822
|
tag_id?: string;
|
|
8798
|
-
party_ids?: string
|
|
8799
|
-
body_params?: string
|
|
8823
|
+
party_ids?: Array<string>;
|
|
8824
|
+
body_params?: Array<string>;
|
|
8800
8825
|
name?: string;
|
|
8801
8826
|
}): Promise<SendWhatsAppTemplateResult>;
|
|
8802
8827
|
listMarketingCampaigns(input?: {
|
|
8803
8828
|
channel_id?: string;
|
|
8804
8829
|
limit?: number;
|
|
8805
|
-
}): Promise<MarketingCampaign
|
|
8830
|
+
}): Promise<Array<MarketingCampaign>>;
|
|
8806
8831
|
getMarketingCampaign(campaignId: string): Promise<{
|
|
8807
8832
|
campaign: MarketingCampaign;
|
|
8808
|
-
messages: MarketingMessage
|
|
8833
|
+
messages: Array<MarketingMessage>;
|
|
8809
8834
|
}>;
|
|
8810
8835
|
listCRMPartyTags(input?: {
|
|
8811
8836
|
party_id?: string;
|
|
8812
|
-
}): Promise<CRMPartyTag
|
|
8837
|
+
}): Promise<Array<CRMPartyTag>>;
|
|
8813
8838
|
saveCRMPartyTag(input: {
|
|
8814
8839
|
tag_id?: string;
|
|
8815
8840
|
name: string;
|
|
@@ -8823,15 +8848,15 @@ export interface NemphiClient {
|
|
|
8823
8848
|
deleteCRMPartyTag(tagId: string): Promise<{
|
|
8824
8849
|
deleted: boolean;
|
|
8825
8850
|
}>;
|
|
8826
|
-
setPartyTags(partyId: string, tagIds: string
|
|
8851
|
+
setPartyTags(partyId: string, tagIds: Array<string>): Promise<{
|
|
8827
8852
|
party_id: string;
|
|
8828
|
-
tags: CRMPartyTag
|
|
8853
|
+
tags: Array<CRMPartyTag>;
|
|
8829
8854
|
}>;
|
|
8830
8855
|
listPartiesByTag(input: {
|
|
8831
8856
|
tag_id: string;
|
|
8832
8857
|
with_phone?: boolean;
|
|
8833
8858
|
limit?: number;
|
|
8834
|
-
}): Promise<Party
|
|
8859
|
+
}): Promise<Array<Party>>;
|
|
8835
8860
|
listCRMInteractions(input?: {
|
|
8836
8861
|
party_id?: string;
|
|
8837
8862
|
/** One deal's timeline: what was logged on it, and its contact's touchpoints on no deal. */
|
|
@@ -8845,7 +8870,7 @@ export interface NemphiClient {
|
|
|
8845
8870
|
listProjects(input?: {
|
|
8846
8871
|
status?: "active" | "archived";
|
|
8847
8872
|
limit?: number;
|
|
8848
|
-
}): Promise<Project
|
|
8873
|
+
}): Promise<Array<Project>>;
|
|
8849
8874
|
/** Kanban board of one project (empty project key → first active). */
|
|
8850
8875
|
projectBoard(input?: {
|
|
8851
8876
|
project?: string;
|
|
@@ -8888,9 +8913,9 @@ export interface NemphiClient {
|
|
|
8888
8913
|
limit?: number;
|
|
8889
8914
|
}): Promise<EmailInbox>;
|
|
8890
8915
|
/** The BIMI logos of the given sender domains (each a message's `sender_logo_domain`); domains without one are left out. */
|
|
8891
|
-
emailSenderLogos(domains: string
|
|
8916
|
+
emailSenderLogos(domains: Array<string>): Promise<Array<EmailSenderLogo>>;
|
|
8892
8917
|
/** The caller's mail tags with per-tag message counts. */
|
|
8893
|
-
listEmailTags(): Promise<EmailTag
|
|
8918
|
+
listEmailTags(): Promise<Array<EmailTag>>;
|
|
8894
8919
|
/**
|
|
8895
8920
|
* Create (or update, with tag_id) a mail tag.
|
|
8896
8921
|
*
|
|
@@ -8921,7 +8946,7 @@ export interface NemphiClient {
|
|
|
8921
8946
|
readEmailMessage(messageId: string): Promise<EmailMessageBody>;
|
|
8922
8947
|
/** Mark inbox messages read. Mailboxes with read sync enabled also push the state to the provider. */
|
|
8923
8948
|
markEmailMessagesRead(input: {
|
|
8924
|
-
message_ids?: string
|
|
8949
|
+
message_ids?: Array<string>;
|
|
8925
8950
|
all?: boolean;
|
|
8926
8951
|
}): Promise<{
|
|
8927
8952
|
updated: number;
|
|
@@ -8942,10 +8967,10 @@ export interface NemphiClient {
|
|
|
8942
8967
|
}, opts?: InvokeOpts): Promise<Tenant>;
|
|
8943
8968
|
createApiKey(tenantId: string, input: {
|
|
8944
8969
|
name: string;
|
|
8945
|
-
scopes?: string
|
|
8970
|
+
scopes?: Array<string>;
|
|
8946
8971
|
expires_at?: string;
|
|
8947
8972
|
}): Promise<ApiKeyCreated>;
|
|
8948
|
-
listApiKeys(tenantId: string): Promise<ApiKey
|
|
8973
|
+
listApiKeys(tenantId: string): Promise<Array<ApiKey>>;
|
|
8949
8974
|
revokeApiKey(tenantId: string, keyId: string): Promise<{
|
|
8950
8975
|
revoked: boolean;
|
|
8951
8976
|
id: string;
|
|
@@ -8960,7 +8985,7 @@ export interface NemphiClient {
|
|
|
8960
8985
|
request_id: string;
|
|
8961
8986
|
approve: boolean;
|
|
8962
8987
|
tenant_id?: string;
|
|
8963
|
-
scopes?: string
|
|
8988
|
+
scopes?: Array<string>;
|
|
8964
8989
|
}): Promise<{
|
|
8965
8990
|
redirect_to: string;
|
|
8966
8991
|
}>;
|
|
@@ -8970,10 +8995,10 @@ export interface NemphiClient {
|
|
|
8970
8995
|
* schemas instead of the whole registry.
|
|
8971
8996
|
*/
|
|
8972
8997
|
listTools(opts?: {
|
|
8973
|
-
names?: string
|
|
8998
|
+
names?: Array<string>;
|
|
8974
8999
|
/** Only the tools the caller's role may call: what a page offers as its actions. */
|
|
8975
9000
|
callable?: boolean;
|
|
8976
|
-
}): Promise<ToolInfo
|
|
9001
|
+
}): Promise<Array<ToolInfo>>;
|
|
8977
9002
|
/**
|
|
8978
9003
|
* Calls any tool by name. `input` is the object the tool's own
|
|
8979
9004
|
* `input_schema` describes — the same value the action ledger records, so
|
|
@@ -9001,14 +9026,14 @@ export interface NemphiClient {
|
|
|
9001
9026
|
* Where to reach the member about this run beyond the app chat —
|
|
9002
9027
|
* only when they asked to be emailed or messaged about it.
|
|
9003
9028
|
*/
|
|
9004
|
-
notify_channels?: NotificationChannel
|
|
9029
|
+
notify_channels?: Array<NotificationChannel>;
|
|
9005
9030
|
}): Promise<Run>;
|
|
9006
9031
|
/** Cancel a run and every subagent it spawned; a cancelled child unblocks its waiting parent. */
|
|
9007
9032
|
cancelRun(id: string): Promise<{
|
|
9008
9033
|
run_id: string;
|
|
9009
|
-
cancelled: string
|
|
9034
|
+
cancelled: Array<string>;
|
|
9010
9035
|
}>;
|
|
9011
|
-
listRuns(): Promise<Run
|
|
9036
|
+
listRuns(): Promise<Array<Run>>;
|
|
9012
9037
|
getRun(id: string): Promise<Run>;
|
|
9013
9038
|
/**
|
|
9014
9039
|
* The full trace for a run: its whole delegation tree with every
|
|
@@ -9033,9 +9058,9 @@ export interface NemphiClient {
|
|
|
9033
9058
|
}): Promise<ApprovalDecision>;
|
|
9034
9059
|
denyRun(id: string): Promise<ApprovalDecision>;
|
|
9035
9060
|
/** Answer a run parked on `user.ask` (status `awaiting_input`) and resume it. */
|
|
9036
|
-
answerRun(id: string, answers: RunAnswer
|
|
9061
|
+
answerRun(id: string, answers: Array<RunAnswer>): Promise<AnswerResult>;
|
|
9037
9062
|
/** The workspace's routines, optionally narrowed by teammate, project or kind. */
|
|
9038
|
-
listRoutines(input?: RoutineListInput): Promise<Routine
|
|
9063
|
+
listRoutines(input?: RoutineListInput): Promise<Array<Routine>>;
|
|
9039
9064
|
/** One routine with its recent runs (status, trigger, result). */
|
|
9040
9065
|
getRoutine(id: string): Promise<RoutineDetail>;
|
|
9041
9066
|
/** Create (no `routine`) or update a routine; omitted fields keep their value and the kind cannot change. */
|
|
@@ -9071,15 +9096,15 @@ export interface NemphiClient {
|
|
|
9071
9096
|
getNotificationPrefs(): Promise<NotificationPrefs>;
|
|
9072
9097
|
updateNotificationPrefs(input: {
|
|
9073
9098
|
destinations?: Partial<Record<NotificationKind, NotificationDestination>>;
|
|
9074
|
-
channels?: NotificationChannel
|
|
9075
|
-
kinds?: NotificationKind
|
|
9099
|
+
channels?: Array<NotificationChannel>;
|
|
9100
|
+
kinds?: Array<NotificationKind>;
|
|
9076
9101
|
phone?: string | null;
|
|
9077
9102
|
message_notify?: MessageNotifyPrefs;
|
|
9078
9103
|
}): Promise<NotificationPrefs>;
|
|
9079
9104
|
/** Workspace notification settings: which kinds members may receive (owner/admin only). */
|
|
9080
9105
|
getNotificationSettings(): Promise<WorkspaceNotificationSettings>;
|
|
9081
9106
|
updateNotificationSettings(input: {
|
|
9082
|
-
member_kinds: NotificationKind
|
|
9107
|
+
member_kinds: Array<NotificationKind>;
|
|
9083
9108
|
}): Promise<WorkspaceNotificationSettings>;
|
|
9084
9109
|
/** Send a WhatsApp OTP to the saved phone so this account can act from it. */
|
|
9085
9110
|
startPhoneVerification(): Promise<{
|
|
@@ -9098,14 +9123,14 @@ export interface NemphiClient {
|
|
|
9098
9123
|
dismissed: string;
|
|
9099
9124
|
}>;
|
|
9100
9125
|
listPolicies(): Promise<PolicyList>;
|
|
9101
|
-
listRecurringDocuments(): Promise<RecurringDocument
|
|
9126
|
+
listRecurringDocuments(): Promise<Array<RecurringDocument>>;
|
|
9102
9127
|
budgetOverview(year?: number): Promise<BudgetOverview>;
|
|
9103
9128
|
createInvite(input: {
|
|
9104
9129
|
email: string;
|
|
9105
9130
|
role: "admin" | "member" | "viewer" | "custom";
|
|
9106
9131
|
role_id?: string;
|
|
9107
9132
|
}): Promise<Invitation>;
|
|
9108
|
-
listInvites(): Promise<Invitation
|
|
9133
|
+
listInvites(): Promise<Array<Invitation>>;
|
|
9109
9134
|
deleteInvite(id: string): Promise<{
|
|
9110
9135
|
deleted: string;
|
|
9111
9136
|
}>;
|
|
@@ -9126,13 +9151,13 @@ export interface NemphiClient {
|
|
|
9126
9151
|
createRole(input: {
|
|
9127
9152
|
name: string;
|
|
9128
9153
|
description?: string;
|
|
9129
|
-
grants?: RoleGrant
|
|
9154
|
+
grants?: Array<RoleGrant>;
|
|
9130
9155
|
}): Promise<WorkspaceRole>;
|
|
9131
9156
|
updateRole(input: {
|
|
9132
9157
|
role_id: string;
|
|
9133
9158
|
name?: string;
|
|
9134
9159
|
description?: string;
|
|
9135
|
-
grants?: RoleGrant
|
|
9160
|
+
grants?: Array<RoleGrant>;
|
|
9136
9161
|
}): Promise<WorkspaceRole>;
|
|
9137
9162
|
deleteRole(roleId: string): Promise<{
|
|
9138
9163
|
deleted: string;
|
|
@@ -9152,18 +9177,18 @@ export interface NemphiClient {
|
|
|
9152
9177
|
getParty(partyId: string): Promise<Party>;
|
|
9153
9178
|
updateParty(input: PartyUpdateInput): Promise<Party>;
|
|
9154
9179
|
setPartyBankDetails(input: PartyBankDetailsInput, opts?: InvokeOpts): Promise<Party>;
|
|
9155
|
-
listBanks(): Promise<BankInfo
|
|
9180
|
+
listBanks(): Promise<Array<BankInfo>>;
|
|
9156
9181
|
listPaymentFormats(): Promise<{
|
|
9157
|
-
formats: PaymentFormat
|
|
9158
|
-
banks: BankInfo
|
|
9182
|
+
formats: Array<PaymentFormat>;
|
|
9183
|
+
banks: Array<BankInfo>;
|
|
9159
9184
|
}>;
|
|
9160
9185
|
listPaymentRuns(input?: {
|
|
9161
9186
|
status?: PaymentRunStatus;
|
|
9162
9187
|
limit?: number;
|
|
9163
|
-
}): Promise<PaymentRun
|
|
9188
|
+
}): Promise<Array<PaymentRun>>;
|
|
9164
9189
|
getPaymentRun(runId: string): Promise<{
|
|
9165
9190
|
run: PaymentRun;
|
|
9166
|
-
items: PaymentRunItem
|
|
9191
|
+
items: Array<PaymentRunItem>;
|
|
9167
9192
|
}>;
|
|
9168
9193
|
createPaymentRun(input: PaymentRunCreateInput, opts?: InvokeOpts): Promise<PaymentRunCreateResult>;
|
|
9169
9194
|
exportPaymentRun(input: {
|
|
@@ -9174,13 +9199,13 @@ export interface NemphiClient {
|
|
|
9174
9199
|
settlePaymentRun(input: {
|
|
9175
9200
|
run_id: string;
|
|
9176
9201
|
payment_date?: string;
|
|
9177
|
-
item_ids?: string
|
|
9202
|
+
item_ids?: Array<string>;
|
|
9178
9203
|
bank_transaction_ids?: Record<string, string>;
|
|
9179
9204
|
memo?: string;
|
|
9180
9205
|
}, opts?: InvokeOpts): Promise<PaymentRunSettleResult>;
|
|
9181
9206
|
cancelPaymentRun(runId: string, opts?: InvokeOpts): Promise<{
|
|
9182
9207
|
run: PaymentRun;
|
|
9183
|
-
items: PaymentRunItem
|
|
9208
|
+
items: Array<PaymentRunItem>;
|
|
9184
9209
|
}>;
|
|
9185
9210
|
createFixedAsset(input: CreateFixedAssetInput): Promise<FixedAsset>;
|
|
9186
9211
|
updateFixedAsset(input: {
|
|
@@ -9190,14 +9215,14 @@ export interface NemphiClient {
|
|
|
9190
9215
|
status?: FixedAssetStatus;
|
|
9191
9216
|
category?: FixedAssetCategory;
|
|
9192
9217
|
limit?: number;
|
|
9193
|
-
}): Promise<FixedAsset
|
|
9218
|
+
}): Promise<Array<FixedAsset>>;
|
|
9194
9219
|
getFixedAsset(assetId: string): Promise<{
|
|
9195
9220
|
asset: FixedAsset;
|
|
9196
|
-
depreciations: FixedAssetDepreciation
|
|
9221
|
+
depreciations: Array<FixedAssetDepreciation>;
|
|
9197
9222
|
}>;
|
|
9198
9223
|
getFixedAssetSchedule(assetId: string): Promise<{
|
|
9199
9224
|
asset: FixedAsset;
|
|
9200
|
-
schedule: FixedAssetScheduleRow
|
|
9225
|
+
schedule: Array<FixedAssetScheduleRow>;
|
|
9201
9226
|
currency: string;
|
|
9202
9227
|
}>;
|
|
9203
9228
|
fixedAssetSummary(asOf?: string): Promise<FixedAssetSummary>;
|
|
@@ -9230,7 +9255,7 @@ export interface NemphiClient {
|
|
|
9230
9255
|
status?: EmployeeStatus;
|
|
9231
9256
|
q?: string;
|
|
9232
9257
|
limit?: number;
|
|
9233
|
-
}): Promise<Employee
|
|
9258
|
+
}): Promise<Array<Employee>>;
|
|
9234
9259
|
getEmployee(employeeId: string): Promise<Employee>;
|
|
9235
9260
|
createEmployee(input: CreateEmployeeInput, opts?: InvokeOpts): Promise<Employee>;
|
|
9236
9261
|
updateEmployee(input: UpdateEmployeeInput, opts?: InvokeOpts): Promise<Employee>;
|
|
@@ -9253,7 +9278,7 @@ export interface NemphiClient {
|
|
|
9253
9278
|
from?: string;
|
|
9254
9279
|
to?: string;
|
|
9255
9280
|
limit?: number;
|
|
9256
|
-
}): Promise<PayrollNovelty
|
|
9281
|
+
}): Promise<Array<PayrollNovelty>>;
|
|
9257
9282
|
deletePayrollNovelty(noveltyId: string, opts?: InvokeOpts): Promise<{
|
|
9258
9283
|
deleted: string;
|
|
9259
9284
|
}>;
|
|
@@ -9267,19 +9292,19 @@ export interface NemphiClient {
|
|
|
9267
9292
|
}, opts?: InvokeOpts): Promise<PayrollCalculateResult>;
|
|
9268
9293
|
payrollRun(runId: string): Promise<{
|
|
9269
9294
|
run: PayrollRun;
|
|
9270
|
-
payslips: Payslip
|
|
9295
|
+
payslips: Array<Payslip>;
|
|
9271
9296
|
}>;
|
|
9272
9297
|
listPayrollRuns(input?: {
|
|
9273
9298
|
status?: PayrollRunStatus;
|
|
9274
9299
|
limit?: number;
|
|
9275
|
-
}): Promise<PayrollRun
|
|
9300
|
+
}): Promise<Array<PayrollRun>>;
|
|
9276
9301
|
postPayrollRun(input: {
|
|
9277
9302
|
run_id: string;
|
|
9278
9303
|
date?: string;
|
|
9279
9304
|
}, opts?: InvokeOpts): Promise<PayrollPostResult>;
|
|
9280
9305
|
payPayroll(input: {
|
|
9281
9306
|
run_id?: string;
|
|
9282
|
-
employee_ids?: string
|
|
9307
|
+
employee_ids?: Array<string>;
|
|
9283
9308
|
liquidation_employee_id?: string;
|
|
9284
9309
|
payment_date?: string;
|
|
9285
9310
|
cash_account_code?: string;
|
|
@@ -9300,7 +9325,7 @@ export interface NemphiClient {
|
|
|
9300
9325
|
run_id?: string;
|
|
9301
9326
|
state?: PayrollSubmission["state"];
|
|
9302
9327
|
limit?: number;
|
|
9303
|
-
}): Promise<PayrollSubmission
|
|
9328
|
+
}): Promise<Array<PayrollSubmission>>;
|
|
9304
9329
|
/** Re-uploading bytes already filed for the tenant returns the existing
|
|
9305
9330
|
* document with `duplicate: true` instead of storing a second copy. */
|
|
9306
9331
|
/** With `partyId` (requires `kind`), the registration document fills that
|
|
@@ -9351,7 +9376,7 @@ export interface NemphiClient {
|
|
|
9351
9376
|
country?: string;
|
|
9352
9377
|
}): Promise<{
|
|
9353
9378
|
country: string;
|
|
9354
|
-
matches: GlobalCompany
|
|
9379
|
+
matches: Array<GlobalCompany>;
|
|
9355
9380
|
}>;
|
|
9356
9381
|
/** The contacts a new one would duplicate (parties.find_matches). */
|
|
9357
9382
|
findPartyMatches(input: {
|
|
@@ -9360,7 +9385,7 @@ export interface NemphiClient {
|
|
|
9360
9385
|
phone?: string;
|
|
9361
9386
|
tax_id?: string;
|
|
9362
9387
|
}): Promise<PartyMatches>;
|
|
9363
|
-
listDocuments(): Promise<Document
|
|
9388
|
+
listDocuments(): Promise<Array<Document>>;
|
|
9364
9389
|
getDocument(id: string): Promise<Document>;
|
|
9365
9390
|
/** The document with the whole text its extraction read, as Markdown. */
|
|
9366
9391
|
readDocumentText(id: string): Promise<DocumentText>;
|
|
@@ -9376,7 +9401,7 @@ export interface NemphiClient {
|
|
|
9376
9401
|
documentWork(id: string): Promise<DocumentWork>;
|
|
9377
9402
|
/** The documents the books keep as support outside Docs (`documents.support`). */
|
|
9378
9403
|
listSupportDocuments(): Promise<SupportDocuments>;
|
|
9379
|
-
listLiveDocuments(filter?: LiveDocumentFilter): Promise<LiveDocument
|
|
9404
|
+
listLiveDocuments(filter?: LiveDocumentFilter): Promise<Array<LiveDocument>>;
|
|
9380
9405
|
createLiveDocument(title: string, kind?: LiveDocumentKind, place?: LiveDocumentPlace): Promise<LiveDocument>;
|
|
9381
9406
|
/** Files a document in a folder (empty: the top level) or moves it to another space. */
|
|
9382
9407
|
moveLiveDocument(id: string, place: LiveDocumentPlace): Promise<LiveDocument>;
|
|
@@ -9393,7 +9418,7 @@ export interface NemphiClient {
|
|
|
9393
9418
|
mentionInLiveDocumentComment(id: string, mention: LiveDocumentMentionInput): Promise<LiveDocumentMentions>;
|
|
9394
9419
|
shareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
|
|
9395
9420
|
unshareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
|
|
9396
|
-
listLiveDocumentFolders(space: LiveDocumentSpace): Promise<LiveDocumentFolder
|
|
9421
|
+
listLiveDocumentFolders(space: LiveDocumentSpace): Promise<Array<LiveDocumentFolder>>;
|
|
9397
9422
|
createLiveDocumentFolder(name: string, space: LiveDocumentSpace, parentId?: string): Promise<LiveDocumentFolder>;
|
|
9398
9423
|
renameLiveDocumentFolder(id: string, name: string): Promise<LiveDocumentFolder>;
|
|
9399
9424
|
deleteLiveDocumentFolder(id: string): Promise<{
|
|
@@ -9402,7 +9427,7 @@ export interface NemphiClient {
|
|
|
9402
9427
|
}>;
|
|
9403
9428
|
/** Puts a folder inside another folder of its space (empty: the top level). */
|
|
9404
9429
|
moveLiveDocumentFolder(id: string, parentId: string): Promise<LiveDocumentFolder>;
|
|
9405
|
-
listLiveDocumentTags(): Promise<LiveDocumentWorkspaceTag
|
|
9430
|
+
listLiveDocumentTags(): Promise<Array<LiveDocumentWorkspaceTag>>;
|
|
9406
9431
|
/** Puts a tag on a document by name; a new name adds the tag to the workspace. */
|
|
9407
9432
|
tagLiveDocument(id: string, tag: string): Promise<LiveDocument>;
|
|
9408
9433
|
/** Takes a tag off a document; Clef does not put it back. */
|
|
@@ -9420,7 +9445,7 @@ export interface NemphiClient {
|
|
|
9420
9445
|
}>;
|
|
9421
9446
|
/** A document's version history, newest first, without the states. */
|
|
9422
9447
|
listLiveDocumentVersions(id: string): Promise<{
|
|
9423
|
-
versions: LiveDocumentVersion
|
|
9448
|
+
versions: Array<LiveDocumentVersion>;
|
|
9424
9449
|
}>;
|
|
9425
9450
|
/** Keeps the document as it is now as a version, named when `name` is not empty. */
|
|
9426
9451
|
createLiveDocumentVersion(id: string, name: string): Promise<LiveDocumentVersion>;
|
|
@@ -9469,7 +9494,7 @@ export interface NemphiClient {
|
|
|
9469
9494
|
/** Sends documents through a public link, mailed to any recipients. */
|
|
9470
9495
|
createTransfer(input: TransferInput): Promise<CreatedTransfer>;
|
|
9471
9496
|
/** The caller's transfers (an owner or admin: the workspace's), newest first. */
|
|
9472
|
-
listTransfers(): Promise<Transfer
|
|
9497
|
+
listTransfers(): Promise<Array<Transfer>>;
|
|
9473
9498
|
/** How many of the caller's transfers still work (an owner's or admin's: the workspace's). */
|
|
9474
9499
|
countActiveTransfers(): Promise<number>;
|
|
9475
9500
|
/** Stops a transfer's link working, for everyone. */
|
|
@@ -9486,7 +9511,7 @@ export interface NemphiClient {
|
|
|
9486
9511
|
/** Every document of a transfer as one zip, streamed. */
|
|
9487
9512
|
downloadPublicTransferZip(token: string, key?: string): Promise<Response>;
|
|
9488
9513
|
/** The member's connected Google Drive and OneDrive accounts. */
|
|
9489
|
-
listDriveAccounts(): Promise<DriveAccount
|
|
9514
|
+
listDriveAccounts(): Promise<Array<DriveAccount>>;
|
|
9490
9515
|
/** Starts connecting a drive: open `auth_url`; the provider returns to `returnTo`. */
|
|
9491
9516
|
connectDriveAccount(input: {
|
|
9492
9517
|
provider: DriveProvider;
|
|
@@ -9515,7 +9540,7 @@ export interface NemphiClient {
|
|
|
9515
9540
|
/** Only this actor's rows (a user, agent or API key id). */
|
|
9516
9541
|
actor_id?: string;
|
|
9517
9542
|
}): Promise<{
|
|
9518
|
-
actions: Action
|
|
9543
|
+
actions: Array<Action>;
|
|
9519
9544
|
cursor: number;
|
|
9520
9545
|
next_before?: number;
|
|
9521
9546
|
}>;
|
|
@@ -9590,9 +9615,9 @@ export interface NemphiClient {
|
|
|
9590
9615
|
/** The profiling gate: what this workspace has said about itself. */
|
|
9591
9616
|
onboardingState(): Promise<OnboardingState>;
|
|
9592
9617
|
/** Record answers (merged with what is stored). Owners and admins only. */
|
|
9593
|
-
answerOnboarding(answers: Record<string, string
|
|
9618
|
+
answerOnboarding(answers: Record<string, Array<string>>): Promise<OnboardingState>;
|
|
9594
9619
|
/** Close the gate and configure the workspace from the answers. */
|
|
9595
|
-
completeOnboarding(answers?: Record<string, string
|
|
9620
|
+
completeOnboarding(answers?: Record<string, Array<string>>): Promise<OnboardingState>;
|
|
9596
9621
|
sendEmail(input: {
|
|
9597
9622
|
to: string;
|
|
9598
9623
|
subject: string;
|
|
@@ -9606,7 +9631,7 @@ export interface NemphiClient {
|
|
|
9606
9631
|
limit?: number;
|
|
9607
9632
|
mode?: "hybrid" | "fts" | "vector";
|
|
9608
9633
|
}): Promise<{
|
|
9609
|
-
results: KnowledgeResult
|
|
9634
|
+
results: Array<KnowledgeResult>;
|
|
9610
9635
|
mode: string;
|
|
9611
9636
|
}>;
|
|
9612
9637
|
createBillDraft(input: {
|
|
@@ -9625,7 +9650,7 @@ export interface NemphiClient {
|
|
|
9625
9650
|
retefuente?: number;
|
|
9626
9651
|
reteiva?: number;
|
|
9627
9652
|
reteica?: number;
|
|
9628
|
-
lines?: LineInput
|
|
9653
|
+
lines?: Array<LineInput>;
|
|
9629
9654
|
/** Colombia: posting emits our own documento soporte (DIAN 05). */
|
|
9630
9655
|
support_document?: boolean;
|
|
9631
9656
|
}): Promise<Bill>;
|
|
@@ -9645,7 +9670,7 @@ export interface NemphiClient {
|
|
|
9645
9670
|
reteiva?: number;
|
|
9646
9671
|
reteica?: number;
|
|
9647
9672
|
/** Replaces all lines when present ([] strips them). */
|
|
9648
|
-
lines?: LineInput
|
|
9673
|
+
lines?: Array<LineInput>;
|
|
9649
9674
|
}): Promise<Bill>;
|
|
9650
9675
|
deleteBillDraft(billId: string): Promise<{
|
|
9651
9676
|
deleted: boolean;
|
|
@@ -9663,7 +9688,7 @@ export interface NemphiClient {
|
|
|
9663
9688
|
/** Only the bills filed from this source document. */
|
|
9664
9689
|
document_id?: string;
|
|
9665
9690
|
limit?: number;
|
|
9666
|
-
}): Promise<Bill
|
|
9691
|
+
}): Promise<Array<Bill>>;
|
|
9667
9692
|
getBill(billId: string): Promise<BillDetail>;
|
|
9668
9693
|
createBillCreditNote(input: NoteInput & {
|
|
9669
9694
|
bill_id: string;
|
|
@@ -9681,7 +9706,7 @@ export interface NemphiClient {
|
|
|
9681
9706
|
kind?: "product" | "service";
|
|
9682
9707
|
active?: boolean;
|
|
9683
9708
|
limit?: number;
|
|
9684
|
-
}): Promise<Item
|
|
9709
|
+
}): Promise<Array<Item>>;
|
|
9685
9710
|
getItem(input: {
|
|
9686
9711
|
item_id?: string;
|
|
9687
9712
|
code?: string;
|
|
@@ -9702,7 +9727,7 @@ export interface NemphiClient {
|
|
|
9702
9727
|
}): Promise<Warehouse>;
|
|
9703
9728
|
listWarehouses(input?: {
|
|
9704
9729
|
active?: boolean;
|
|
9705
|
-
}): Promise<Warehouse
|
|
9730
|
+
}): Promise<Array<Warehouse>>;
|
|
9706
9731
|
stockLevels(input?: {
|
|
9707
9732
|
item_id?: string;
|
|
9708
9733
|
warehouse_id?: string;
|
|
@@ -9726,7 +9751,7 @@ export interface NemphiClient {
|
|
|
9726
9751
|
reorderSuggestions(input?: {
|
|
9727
9752
|
warehouse_id?: string;
|
|
9728
9753
|
limit?: number;
|
|
9729
|
-
}): Promise<ReorderSuggestion
|
|
9754
|
+
}): Promise<Array<ReorderSuggestion>>;
|
|
9730
9755
|
/** The inventory page in one read; `month` is YYYY-MM, this month when omitted. */
|
|
9731
9756
|
inventoryOverview(month?: string): Promise<InventoryOverview>;
|
|
9732
9757
|
adjustStock(input: {
|
|
@@ -9760,31 +9785,31 @@ export interface NemphiClient {
|
|
|
9760
9785
|
inventoryOpeningBalance(input: {
|
|
9761
9786
|
date?: string;
|
|
9762
9787
|
memo?: string;
|
|
9763
|
-
lines: {
|
|
9788
|
+
lines: Array<{
|
|
9764
9789
|
item_id: string;
|
|
9765
9790
|
warehouse_id?: string;
|
|
9766
9791
|
quantity: number;
|
|
9767
9792
|
unit_cost?: number;
|
|
9768
|
-
}
|
|
9793
|
+
}>;
|
|
9769
9794
|
}, opts?: InvokeOpts): Promise<{
|
|
9770
|
-
movements: StockMovement
|
|
9795
|
+
movements: Array<StockMovement>;
|
|
9771
9796
|
journal_entry: JournalEntry;
|
|
9772
9797
|
total_value_cents: number;
|
|
9773
9798
|
}>;
|
|
9774
9799
|
startInventoryCount(input?: {
|
|
9775
9800
|
warehouse_id?: string;
|
|
9776
|
-
item_ids?: string
|
|
9801
|
+
item_ids?: Array<string>;
|
|
9777
9802
|
counted_on?: string;
|
|
9778
9803
|
reference?: string;
|
|
9779
9804
|
notes?: string;
|
|
9780
9805
|
}): Promise<InventoryCountDetail>;
|
|
9781
9806
|
recordInventoryCount(input: {
|
|
9782
9807
|
count_id: string;
|
|
9783
|
-
lines: {
|
|
9808
|
+
lines: Array<{
|
|
9784
9809
|
item_id: string;
|
|
9785
9810
|
quantity: number;
|
|
9786
9811
|
notes?: string;
|
|
9787
|
-
}
|
|
9812
|
+
}>;
|
|
9788
9813
|
}): Promise<InventoryCountDetail>;
|
|
9789
9814
|
postInventoryCount(input: {
|
|
9790
9815
|
count_id: string;
|
|
@@ -9793,14 +9818,14 @@ export interface NemphiClient {
|
|
|
9793
9818
|
}, opts?: InvokeOpts): Promise<{
|
|
9794
9819
|
count: InventoryCount;
|
|
9795
9820
|
status: string;
|
|
9796
|
-
movements: StockMovement
|
|
9821
|
+
movements: Array<StockMovement>;
|
|
9797
9822
|
net_difference_cents: number;
|
|
9798
9823
|
journal_entry?: JournalEntry;
|
|
9799
9824
|
}>;
|
|
9800
9825
|
listInventoryCounts(input?: {
|
|
9801
9826
|
status?: "open" | "posted" | "cancelled";
|
|
9802
9827
|
limit?: number;
|
|
9803
|
-
}): Promise<InventoryCount
|
|
9828
|
+
}): Promise<Array<InventoryCount>>;
|
|
9804
9829
|
getInventoryCount(countId: string): Promise<InventoryCountDetail>;
|
|
9805
9830
|
inventorySettings(): Promise<InventorySettings>;
|
|
9806
9831
|
configureInventory(input: {
|
|
@@ -9816,12 +9841,12 @@ export interface NemphiClient {
|
|
|
9816
9841
|
email?: string;
|
|
9817
9842
|
phone?: string;
|
|
9818
9843
|
}): Promise<Party>;
|
|
9819
|
-
listParties(): Promise<Party
|
|
9820
|
-
listAccounts(): Promise<Account
|
|
9844
|
+
listParties(): Promise<Array<Party>>;
|
|
9845
|
+
listAccounts(): Promise<Array<Account>>;
|
|
9821
9846
|
postEntry(input: {
|
|
9822
9847
|
date?: string;
|
|
9823
9848
|
memo?: string;
|
|
9824
|
-
lines: EntryLine
|
|
9849
|
+
lines: Array<EntryLine>;
|
|
9825
9850
|
}, opts?: InvokeOpts): Promise<JournalEntry>;
|
|
9826
9851
|
reverseEntry(input: {
|
|
9827
9852
|
entry_id: string;
|
|
@@ -9829,7 +9854,7 @@ export interface NemphiClient {
|
|
|
9829
9854
|
date?: string;
|
|
9830
9855
|
}, opts?: InvokeOpts): Promise<JournalEntry>;
|
|
9831
9856
|
trialBalance(): Promise<{
|
|
9832
|
-
accounts: TrialBalanceRow
|
|
9857
|
+
accounts: Array<TrialBalanceRow>;
|
|
9833
9858
|
currency: string;
|
|
9834
9859
|
}>;
|
|
9835
9860
|
balanceSheet(input?: {
|
|
@@ -9862,7 +9887,7 @@ export interface NemphiClient {
|
|
|
9862
9887
|
listPeriods(input?: {
|
|
9863
9888
|
months?: number;
|
|
9864
9889
|
}): Promise<{
|
|
9865
|
-
periods: AccountingPeriod
|
|
9890
|
+
periods: Array<AccountingPeriod>;
|
|
9866
9891
|
currency: string;
|
|
9867
9892
|
}>;
|
|
9868
9893
|
closePeriod(input: {
|
|
@@ -9878,7 +9903,7 @@ export interface NemphiClient {
|
|
|
9878
9903
|
period: JsonObject;
|
|
9879
9904
|
reversal_entry: JournalEntry | null;
|
|
9880
9905
|
}>;
|
|
9881
|
-
listEntries(): Promise<JournalEntry
|
|
9906
|
+
listEntries(): Promise<Array<JournalEntry>>;
|
|
9882
9907
|
getEntry(entryId: string): Promise<JournalEntryDetail>;
|
|
9883
9908
|
taxProfile(input?: {
|
|
9884
9909
|
year?: number;
|
|
@@ -9908,7 +9933,7 @@ export interface NemphiClient {
|
|
|
9908
9933
|
partyTaxProfile(partyId: string): Promise<{
|
|
9909
9934
|
profile: PartyTaxProfile;
|
|
9910
9935
|
}>;
|
|
9911
|
-
listPartyTaxProfiles(): Promise<PartyTaxProfile
|
|
9936
|
+
listPartyTaxProfiles(): Promise<Array<PartyTaxProfile>>;
|
|
9912
9937
|
setPartyTaxProfile(input: {
|
|
9913
9938
|
party_id: string;
|
|
9914
9939
|
person_type?: "natural" | "juridica";
|
|
@@ -9998,7 +10023,7 @@ export interface NemphiClient {
|
|
|
9998
10023
|
listTags(input?: {
|
|
9999
10024
|
dimension_key?: string;
|
|
10000
10025
|
include_inactive?: boolean;
|
|
10001
|
-
}): Promise<TagDimensionWithTags
|
|
10026
|
+
}): Promise<Array<TagDimensionWithTags>>;
|
|
10002
10027
|
profitability(input: {
|
|
10003
10028
|
dimension_key?: string;
|
|
10004
10029
|
from?: string;
|
|
@@ -10014,7 +10039,7 @@ export interface NemphiClient {
|
|
|
10014
10039
|
/** invoice (default) | credit_note | debit_note. */
|
|
10015
10040
|
kind?: DocumentKind;
|
|
10016
10041
|
}): Promise<NumberingRange>;
|
|
10017
|
-
listNumberingRanges(): Promise<NumberingRange
|
|
10042
|
+
listNumberingRanges(): Promise<Array<NumberingRange>>;
|
|
10018
10043
|
createInvoiceDraft(input: {
|
|
10019
10044
|
party_id: string;
|
|
10020
10045
|
issue_date?: string;
|
|
@@ -10024,7 +10049,7 @@ export interface NemphiClient {
|
|
|
10024
10049
|
subtotal?: number;
|
|
10025
10050
|
tax?: number;
|
|
10026
10051
|
total?: number;
|
|
10027
|
-
lines?: LineInput
|
|
10052
|
+
lines?: Array<LineInput>;
|
|
10028
10053
|
}): Promise<Invoice>;
|
|
10029
10054
|
updateInvoiceDraft(input: {
|
|
10030
10055
|
invoice_id: string;
|
|
@@ -10036,7 +10061,7 @@ export interface NemphiClient {
|
|
|
10036
10061
|
tax?: number;
|
|
10037
10062
|
total?: number;
|
|
10038
10063
|
/** Replaces all lines when present ([] strips them). */
|
|
10039
|
-
lines?: LineInput
|
|
10064
|
+
lines?: Array<LineInput>;
|
|
10040
10065
|
}): Promise<Invoice>;
|
|
10041
10066
|
deleteInvoiceDraft(invoiceId: string): Promise<{
|
|
10042
10067
|
deleted: boolean;
|
|
@@ -10054,7 +10079,7 @@ export interface NemphiClient {
|
|
|
10054
10079
|
kind?: DocumentKind;
|
|
10055
10080
|
party_id?: string;
|
|
10056
10081
|
limit?: number;
|
|
10057
|
-
}): Promise<Invoice
|
|
10082
|
+
}): Promise<Array<Invoice>>;
|
|
10058
10083
|
getInvoice(invoiceId: string): Promise<InvoiceDetail>;
|
|
10059
10084
|
createInvoiceCreditNote(input: NoteInput & {
|
|
10060
10085
|
invoice_id: string;
|
|
@@ -10093,7 +10118,7 @@ export interface NemphiClient {
|
|
|
10093
10118
|
}>;
|
|
10094
10119
|
/** Rates relative to the tenant currency (a common set unless `currencies` is given). */
|
|
10095
10120
|
fxRates(input?: {
|
|
10096
|
-
currencies?: string
|
|
10121
|
+
currencies?: Array<string>;
|
|
10097
10122
|
date?: string;
|
|
10098
10123
|
}): Promise<FxRatesResponse>;
|
|
10099
10124
|
fxConvert(input: {
|
|
@@ -10128,7 +10153,7 @@ export interface NemphiClient {
|
|
|
10128
10153
|
text?: string;
|
|
10129
10154
|
thread_id?: string;
|
|
10130
10155
|
context?: string;
|
|
10131
|
-
document_ids?: string
|
|
10156
|
+
document_ids?: Array<string>;
|
|
10132
10157
|
wait_ms?: number;
|
|
10133
10158
|
}): Promise<SessionAsk>;
|
|
10134
10159
|
/** Suggested prompts ranked from the tenant's live data. */
|
|
@@ -10139,22 +10164,22 @@ export interface NemphiClient {
|
|
|
10139
10164
|
*/
|
|
10140
10165
|
voiceSession(): Promise<VoiceSession>;
|
|
10141
10166
|
/** The caller's saved chat conversations, newest first. */
|
|
10142
|
-
listConversations(): Promise<ConversationSummary
|
|
10167
|
+
listConversations(): Promise<Array<ConversationSummary>>;
|
|
10143
10168
|
/** One saved conversation with its full thread. */
|
|
10144
10169
|
getConversation(id: string): Promise<Conversation>;
|
|
10145
10170
|
/** Creates (no id) or updates (with id) a saved conversation from the chat thread. */
|
|
10146
10171
|
saveConversation(input: {
|
|
10147
10172
|
id?: string;
|
|
10148
|
-
thread: ConversationTurn
|
|
10173
|
+
thread: Array<ConversationTurn>;
|
|
10149
10174
|
}): Promise<ConversationSummary>;
|
|
10150
10175
|
deleteConversation(id: string): Promise<void>;
|
|
10151
10176
|
/** The newest turns of the member's DM with the orchestrator, which Inicio opens on. */
|
|
10152
|
-
overviewThread(): Promise<ConversationTurn
|
|
10177
|
+
overviewThread(): Promise<Array<ConversationTurn>>;
|
|
10153
10178
|
/** Copies the turns of one finished Inicio round trip into that DM. */
|
|
10154
|
-
mirrorOverviewThread(turns: ConversationTurn
|
|
10179
|
+
mirrorOverviewThread(turns: Array<ConversationTurn>): Promise<{
|
|
10155
10180
|
thread_id: string;
|
|
10156
10181
|
}>;
|
|
10157
|
-
listDashboards(): Promise<DashboardSummary
|
|
10182
|
+
listDashboards(): Promise<Array<DashboardSummary>>;
|
|
10158
10183
|
/**
|
|
10159
10184
|
* Fetches one dashboard with every block's metric query re-run (live data).
|
|
10160
10185
|
* An optional range (YYYY-MM-DD, inclusive) re-runs every block over that
|
|
@@ -10177,7 +10202,7 @@ export interface NemphiClient {
|
|
|
10177
10202
|
spec: CanvasSpec;
|
|
10178
10203
|
}>;
|
|
10179
10204
|
/** Appends blocks to an existing dashboard without replacing its current canvas. */
|
|
10180
|
-
appendDashboard(slug: string, blocks: CanvasBlock
|
|
10205
|
+
appendDashboard(slug: string, blocks: Array<CanvasBlock>, opts?: InvokeOpts): Promise<DashboardSummary & {
|
|
10181
10206
|
spec: CanvasSpec;
|
|
10182
10207
|
}>;
|
|
10183
10208
|
deleteDashboard(slug: string, opts?: InvokeOpts): Promise<{
|
|
@@ -10187,9 +10212,9 @@ export interface NemphiClient {
|
|
|
10187
10212
|
listMembers(opts?: {
|
|
10188
10213
|
q?: string;
|
|
10189
10214
|
limit?: number;
|
|
10190
|
-
}): Promise<TenantMember
|
|
10215
|
+
}): Promise<Array<TenantMember>>;
|
|
10191
10216
|
/** Who a dashboard is shared with. Requires edit rights on it. */
|
|
10192
|
-
listDashboardShares(slug: string): Promise<DashboardShare
|
|
10217
|
+
listDashboardShares(slug: string): Promise<Array<DashboardShare>>;
|
|
10193
10218
|
/** Grants a member view-only access to a dashboard you can edit. */
|
|
10194
10219
|
shareDashboard(slug: string, userId: string): Promise<void>;
|
|
10195
10220
|
/** Removes a member's view access to a dashboard you can edit. */
|
|
@@ -10203,7 +10228,7 @@ export interface NemphiClient {
|
|
|
10203
10228
|
to: string;
|
|
10204
10229
|
}): Promise<DashboardSnapshot>;
|
|
10205
10230
|
/** Active public links for a dashboard you can edit. */
|
|
10206
|
-
listDashboardSnapshots(slug: string): Promise<DashboardSnapshot
|
|
10231
|
+
listDashboardSnapshots(slug: string): Promise<Array<DashboardSnapshot>>;
|
|
10207
10232
|
/** Kills a public link; the frozen copy stops being served immediately. */
|
|
10208
10233
|
revokeDashboardSnapshot(slug: string, snapshotId: string): Promise<void>;
|
|
10209
10234
|
/** Fetches a published snapshot by token. Unauthenticated. */
|
|
@@ -10223,17 +10248,17 @@ export interface NemphiClient {
|
|
|
10223
10248
|
title?: string;
|
|
10224
10249
|
duration_minutes?: number;
|
|
10225
10250
|
time_zone?: string;
|
|
10226
|
-
user_ids?: string
|
|
10251
|
+
user_ids?: Array<string>;
|
|
10227
10252
|
/** People outside the workspace, emailed the call's guest link. */
|
|
10228
|
-
emails?: string
|
|
10253
|
+
emails?: Array<string>;
|
|
10229
10254
|
auto_tasks?: boolean;
|
|
10230
10255
|
}, opts?: InvokeOpts): Promise<{
|
|
10231
10256
|
call: Call;
|
|
10232
|
-
invited: {
|
|
10257
|
+
invited: Array<{
|
|
10233
10258
|
user_id: string;
|
|
10234
10259
|
name: string;
|
|
10235
|
-
}
|
|
10236
|
-
emailed: string
|
|
10260
|
+
}>;
|
|
10261
|
+
emailed: Array<string>;
|
|
10237
10262
|
}>;
|
|
10238
10263
|
/** Renames a call (creator or owner/admin); an empty title names it after its people again. */
|
|
10239
10264
|
renameCall(input: {
|
|
@@ -10245,11 +10270,11 @@ export interface NemphiClient {
|
|
|
10245
10270
|
/** Recent standalone calls, newest first, without join links. */
|
|
10246
10271
|
storageUsage(): Promise<WorkspaceStorageUsage>;
|
|
10247
10272
|
listCallRecordings(callId: string): Promise<{
|
|
10248
|
-
recordings: CallRecording
|
|
10273
|
+
recordings: Array<CallRecording>;
|
|
10249
10274
|
complete: boolean;
|
|
10250
10275
|
}>;
|
|
10251
10276
|
downloadCallRecording(recordingId: string, range?: string): Promise<Response>;
|
|
10252
|
-
listCalls(): Promise<Call
|
|
10277
|
+
listCalls(): Promise<Array<Call>>;
|
|
10253
10278
|
/** One standalone call, including its join link and the caller's media token when ready. */
|
|
10254
10279
|
getCall(callId: string): Promise<Call>;
|
|
10255
10280
|
/** Readies the caller's media token for a call they were invited to. */
|
|
@@ -10257,30 +10282,30 @@ export interface NemphiClient {
|
|
|
10257
10282
|
call: Call;
|
|
10258
10283
|
}>;
|
|
10259
10284
|
/** Everyone on a call and everyone invited to it, oldest seat first. */
|
|
10260
|
-
listCallParticipants(callId: string): Promise<CallParticipantSeat
|
|
10285
|
+
listCallParticipants(callId: string): Promise<Array<CallParticipantSeat>>;
|
|
10261
10286
|
/**
|
|
10262
10287
|
* Invites people to a running or scheduled call: members are notified with a link to the room,
|
|
10263
10288
|
* and each address in `emails` is emailed the call's guest link.
|
|
10264
10289
|
*/
|
|
10265
10290
|
inviteToCall(input: {
|
|
10266
10291
|
call_id: string;
|
|
10267
|
-
user_ids?: string
|
|
10268
|
-
emails?: string
|
|
10292
|
+
user_ids?: Array<string>;
|
|
10293
|
+
emails?: Array<string>;
|
|
10269
10294
|
}, opts?: InvokeOpts): Promise<{
|
|
10270
10295
|
call: Call;
|
|
10271
|
-
invited: {
|
|
10296
|
+
invited: Array<{
|
|
10272
10297
|
user_id: string;
|
|
10273
10298
|
name: string;
|
|
10274
|
-
}
|
|
10275
|
-
emailed: string
|
|
10299
|
+
}>;
|
|
10300
|
+
emailed: Array<string>;
|
|
10276
10301
|
}>;
|
|
10277
10302
|
/** Decides who may share their screen on a call (creator or owner/admin). */
|
|
10278
10303
|
setCallPresenters(input: {
|
|
10279
10304
|
call_id: string;
|
|
10280
10305
|
policy: CallPresentPolicy;
|
|
10281
|
-
roles?: string
|
|
10282
|
-
role_ids?: string
|
|
10283
|
-
user_ids?: string
|
|
10306
|
+
roles?: Array<string>;
|
|
10307
|
+
role_ids?: Array<string>;
|
|
10308
|
+
user_ids?: Array<string>;
|
|
10284
10309
|
}, opts?: InvokeOpts): Promise<{
|
|
10285
10310
|
call: Call;
|
|
10286
10311
|
}>;
|
|
@@ -10295,7 +10320,7 @@ export interface NemphiClient {
|
|
|
10295
10320
|
/** Files the call's suggested action items as project tasks; every suggested one without `items`. */
|
|
10296
10321
|
createCallTasks(input: {
|
|
10297
10322
|
call_id: string;
|
|
10298
|
-
items?: CallTaskPick
|
|
10323
|
+
items?: Array<CallTaskPick>;
|
|
10299
10324
|
project_id?: string;
|
|
10300
10325
|
project?: string;
|
|
10301
10326
|
}, opts?: InvokeOpts): Promise<CallTasksCreated>;
|
|
@@ -10309,14 +10334,14 @@ export interface NemphiClient {
|
|
|
10309
10334
|
listBookingTypes(input?: {
|
|
10310
10335
|
status?: "active" | "paused";
|
|
10311
10336
|
}): Promise<{
|
|
10312
|
-
booking_types: BookingType
|
|
10337
|
+
booking_types: Array<BookingType>;
|
|
10313
10338
|
}>;
|
|
10314
10339
|
createBookingType(input: {
|
|
10315
10340
|
name: string;
|
|
10316
10341
|
duration_minutes: number;
|
|
10317
10342
|
host_user_id?: string;
|
|
10318
10343
|
slug?: string;
|
|
10319
|
-
days?: BookingWeekday
|
|
10344
|
+
days?: Array<BookingWeekday>;
|
|
10320
10345
|
start_time?: string;
|
|
10321
10346
|
end_time?: string;
|
|
10322
10347
|
description?: string;
|
|
@@ -10354,7 +10379,7 @@ export interface NemphiClient {
|
|
|
10354
10379
|
/** Set one weekly window across the days it covers; `replace` false adds it to days that already have one. */
|
|
10355
10380
|
setBookingRanges(input: {
|
|
10356
10381
|
booking_type_id: string;
|
|
10357
|
-
days: BookingWeekday
|
|
10382
|
+
days: Array<BookingWeekday>;
|
|
10358
10383
|
start_time: string;
|
|
10359
10384
|
end_time: string;
|
|
10360
10385
|
replace?: boolean;
|
|
@@ -10363,7 +10388,7 @@ export interface NemphiClient {
|
|
|
10363
10388
|
}>;
|
|
10364
10389
|
clearBookingRanges(input: {
|
|
10365
10390
|
booking_type_id: string;
|
|
10366
|
-
days?: BookingWeekday
|
|
10391
|
+
days?: Array<BookingWeekday>;
|
|
10367
10392
|
}, opts?: InvokeOpts): Promise<{
|
|
10368
10393
|
booking_type: BookingType;
|
|
10369
10394
|
removed: number;
|
|
@@ -10399,7 +10424,7 @@ export interface NemphiClient {
|
|
|
10399
10424
|
}): Promise<{
|
|
10400
10425
|
from: string;
|
|
10401
10426
|
to: string;
|
|
10402
|
-
bookings: Booking
|
|
10427
|
+
bookings: Array<Booking>;
|
|
10403
10428
|
}>;
|
|
10404
10429
|
cancelBooking(input: {
|
|
10405
10430
|
booking_id: string;
|
|
@@ -10464,27 +10489,27 @@ export interface NemphiClient {
|
|
|
10464
10489
|
postCallMessage(input: {
|
|
10465
10490
|
call_id: string;
|
|
10466
10491
|
body: string;
|
|
10467
|
-
document_ids?: string
|
|
10492
|
+
document_ids?: Array<string>;
|
|
10468
10493
|
}, opts?: InvokeOpts): Promise<{
|
|
10469
10494
|
message: CallMessage;
|
|
10470
10495
|
}>;
|
|
10471
10496
|
/** The call's chat room, oldest first; `after` reads only what arrived since that instant. */
|
|
10472
|
-
listCallMessages(callId: string, after?: string): Promise<CallMessage
|
|
10497
|
+
listCallMessages(callId: string, after?: string): Promise<Array<CallMessage>>;
|
|
10473
10498
|
/** Store the calling member's own final utterances, as the provider transcribed them. */
|
|
10474
10499
|
recordCallTranscript(input: {
|
|
10475
10500
|
call_id: string;
|
|
10476
|
-
segments: CallTranscriptSegmentInput
|
|
10501
|
+
segments: Array<CallTranscriptSegmentInput>;
|
|
10477
10502
|
}, opts?: InvokeOpts): Promise<{
|
|
10478
10503
|
recorded: number;
|
|
10479
10504
|
}>;
|
|
10480
10505
|
/** The call's transcript in speaking order; `after` reads only what was said since that instant. */
|
|
10481
|
-
listCallTranscript(callId: string, after?: string): Promise<CallTranscriptSegment
|
|
10482
|
-
listPublicCallMessages(token: string, participantId: string, secret: string, after?: string): Promise<CallMessage
|
|
10506
|
+
listCallTranscript(callId: string, after?: string): Promise<Array<CallTranscriptSegment>>;
|
|
10507
|
+
listPublicCallMessages(token: string, participantId: string, secret: string, after?: string): Promise<Array<CallMessage>>;
|
|
10483
10508
|
postPublicCallMessage(token: string, participantId: string, secret: string, body: string): Promise<{
|
|
10484
10509
|
message: CallMessage;
|
|
10485
10510
|
}>;
|
|
10486
|
-
listPublicCallTranscript(token: string, participantId: string, secret: string, after?: string): Promise<CallTranscriptSegment
|
|
10487
|
-
recordPublicCallTranscript(token: string, participantId: string, secret: string, segments: CallTranscriptSegmentInput
|
|
10511
|
+
listPublicCallTranscript(token: string, participantId: string, secret: string, after?: string): Promise<Array<CallTranscriptSegment>>;
|
|
10512
|
+
recordPublicCallTranscript(token: string, participantId: string, secret: string, segments: Array<CallTranscriptSegmentInput>): Promise<{
|
|
10488
10513
|
recorded: number;
|
|
10489
10514
|
}>;
|
|
10490
10515
|
queryMetric(input: MetricQuery): Promise<MetricResult>;
|
|
@@ -10499,7 +10524,7 @@ export interface NemphiClient {
|
|
|
10499
10524
|
* when one filter change moves many blocks. A query that failed comes
|
|
10500
10525
|
* back as an error in its own slot rather than failing the batch.
|
|
10501
10526
|
*/
|
|
10502
|
-
queryMetricsBatch(queries: MetricQuery
|
|
10527
|
+
queryMetricsBatch(queries: Array<MetricQuery>): Promise<{
|
|
10503
10528
|
results: Array<{
|
|
10504
10529
|
result?: MetricResult;
|
|
10505
10530
|
error?: string;
|
|
@@ -10553,7 +10578,7 @@ export interface NemphiClient {
|
|
|
10553
10578
|
}, opts?: InvokeOpts): Promise<{
|
|
10554
10579
|
connection: Connection;
|
|
10555
10580
|
}>;
|
|
10556
|
-
listConnections(): Promise<Connection
|
|
10581
|
+
listConnections(): Promise<Array<Connection>>;
|
|
10557
10582
|
deleteConnection(connectionId: string, opts?: InvokeOpts): Promise<{
|
|
10558
10583
|
deleted: boolean;
|
|
10559
10584
|
}>;
|
|
@@ -10603,7 +10628,7 @@ export interface NemphiClient {
|
|
|
10603
10628
|
status?: QuoteStatus;
|
|
10604
10629
|
party_id?: string;
|
|
10605
10630
|
limit?: number;
|
|
10606
|
-
}): Promise<SalesDocument
|
|
10631
|
+
}): Promise<Array<SalesDocument>>;
|
|
10607
10632
|
getQuote(quoteId: string): Promise<SalesDocumentDetail>;
|
|
10608
10633
|
createQuote(input: SalesDocumentInput, opts?: InvokeOpts): Promise<SalesDocument>;
|
|
10609
10634
|
updateQuote(input: {
|
|
@@ -10642,7 +10667,7 @@ export interface NemphiClient {
|
|
|
10642
10667
|
status?: SalesOrderStatus;
|
|
10643
10668
|
party_id?: string;
|
|
10644
10669
|
limit?: number;
|
|
10645
|
-
}): Promise<SalesDocument
|
|
10670
|
+
}): Promise<Array<SalesDocument>>;
|
|
10646
10671
|
getSalesOrder(salesOrderId: string): Promise<SalesDocumentDetail>;
|
|
10647
10672
|
createSalesOrder(input: SalesDocumentInput, opts?: InvokeOpts): Promise<SalesDocument>;
|
|
10648
10673
|
updateSalesOrder(input: {
|
|
@@ -10653,7 +10678,7 @@ export interface NemphiClient {
|
|
|
10653
10678
|
/** Draft invoice for all outstanding quantities, or the given subset. */
|
|
10654
10679
|
invoiceSalesOrder(input: {
|
|
10655
10680
|
sales_order_id: string;
|
|
10656
|
-
lines?: QuantitySelection
|
|
10681
|
+
lines?: Array<QuantitySelection>;
|
|
10657
10682
|
issue_date?: string;
|
|
10658
10683
|
due_date?: string;
|
|
10659
10684
|
}, opts?: InvokeOpts): Promise<{
|
|
@@ -10664,7 +10689,7 @@ export interface NemphiClient {
|
|
|
10664
10689
|
status?: PurchaseOrderStatus;
|
|
10665
10690
|
party_id?: string;
|
|
10666
10691
|
limit?: number;
|
|
10667
|
-
}): Promise<PurchaseOrder
|
|
10692
|
+
}): Promise<Array<PurchaseOrder>>;
|
|
10668
10693
|
getPurchaseOrder(purchaseOrderId: string): Promise<PurchaseOrderDetail>;
|
|
10669
10694
|
createPurchaseOrder(input: PurchaseOrderInput, opts?: InvokeOpts): Promise<PurchaseOrder>;
|
|
10670
10695
|
updatePurchaseOrder(input: {
|
|
@@ -10683,15 +10708,15 @@ export interface NemphiClient {
|
|
|
10683
10708
|
received_at?: string;
|
|
10684
10709
|
reference?: string;
|
|
10685
10710
|
notes?: string;
|
|
10686
|
-
lines?: QuantitySelection
|
|
10711
|
+
lines?: Array<QuantitySelection>;
|
|
10687
10712
|
}, opts?: InvokeOpts): Promise<{
|
|
10688
10713
|
receipt: PurchaseReceipt;
|
|
10689
|
-
receipt_lines: PurchaseReceiptLine
|
|
10714
|
+
receipt_lines: Array<PurchaseReceiptLine>;
|
|
10690
10715
|
purchase_order: PurchaseOrder;
|
|
10691
10716
|
}>;
|
|
10692
10717
|
billPurchaseOrder(input: {
|
|
10693
10718
|
purchase_order_id: string;
|
|
10694
|
-
lines?: QuantitySelection
|
|
10719
|
+
lines?: Array<QuantitySelection>;
|
|
10695
10720
|
from?: "received" | "ordered";
|
|
10696
10721
|
invoice_number?: string;
|
|
10697
10722
|
issue_date?: string;
|
|
@@ -10714,11 +10739,11 @@ export type WhatsAppCallMedia = {
|
|
|
10714
10739
|
error: string;
|
|
10715
10740
|
} | {
|
|
10716
10741
|
status: "ready";
|
|
10717
|
-
ice_servers: {
|
|
10718
|
-
urls: string
|
|
10742
|
+
ice_servers: Array<{
|
|
10743
|
+
urls: Array<string>;
|
|
10719
10744
|
username?: string;
|
|
10720
10745
|
credential?: string;
|
|
10721
|
-
}
|
|
10746
|
+
}>;
|
|
10722
10747
|
expires_at: string;
|
|
10723
10748
|
};
|
|
10724
10749
|
/**
|
|
@@ -10738,7 +10763,7 @@ export interface CustomApp {
|
|
|
10738
10763
|
slug: string;
|
|
10739
10764
|
name: string;
|
|
10740
10765
|
description: string;
|
|
10741
|
-
grants: string
|
|
10766
|
+
grants: Array<string>;
|
|
10742
10767
|
agent_access: CustomAppAgentAccess;
|
|
10743
10768
|
version?: number;
|
|
10744
10769
|
live_version?: number;
|
|
@@ -10768,13 +10793,13 @@ export interface CustomAppDetail extends CustomApp {
|
|
|
10768
10793
|
/** Whether the files or grants hold changes no version has saved yet. */
|
|
10769
10794
|
draft_changed: boolean;
|
|
10770
10795
|
created_at: string;
|
|
10771
|
-
files: CustomAppFile
|
|
10772
|
-
collections: {
|
|
10796
|
+
files: Array<CustomAppFile>;
|
|
10797
|
+
collections: Array<{
|
|
10773
10798
|
collection: string;
|
|
10774
10799
|
records: number;
|
|
10775
|
-
}
|
|
10800
|
+
}>;
|
|
10776
10801
|
/** The collections kept in sync with a live spreadsheet (`apps.link_sheet`). */
|
|
10777
|
-
sheets?: CustomAppSheet
|
|
10802
|
+
sheets?: Array<CustomAppSheet>;
|
|
10778
10803
|
}
|
|
10779
10804
|
/**
|
|
10780
10805
|
* A collection kept in sync with a live spreadsheet, both ways
|
|
@@ -10815,18 +10840,18 @@ export interface CustomAppFileContent {
|
|
|
10815
10840
|
*/
|
|
10816
10841
|
export interface CustomAppExportPage {
|
|
10817
10842
|
app: CustomApp;
|
|
10818
|
-
files: {
|
|
10843
|
+
files: Array<{
|
|
10819
10844
|
path: string;
|
|
10820
10845
|
content: string;
|
|
10821
10846
|
updated_at: string;
|
|
10822
|
-
}
|
|
10823
|
-
records: {
|
|
10847
|
+
}>;
|
|
10848
|
+
records: Array<{
|
|
10824
10849
|
collection: string;
|
|
10825
10850
|
id: string;
|
|
10826
10851
|
data: unknown;
|
|
10827
10852
|
created_at: string;
|
|
10828
10853
|
updated_at: string;
|
|
10829
|
-
}
|
|
10854
|
+
}>;
|
|
10830
10855
|
next_cursor?: string;
|
|
10831
10856
|
}
|
|
10832
10857
|
/** One saved version of an app. */
|
|
@@ -10834,7 +10859,7 @@ export interface CustomAppVersion {
|
|
|
10834
10859
|
version: number;
|
|
10835
10860
|
message: string;
|
|
10836
10861
|
files: number;
|
|
10837
|
-
grants: string
|
|
10862
|
+
grants: Array<string>;
|
|
10838
10863
|
author_type: string | null;
|
|
10839
10864
|
author_id: string | null;
|
|
10840
10865
|
live: boolean;
|
|
@@ -10846,20 +10871,21 @@ export interface CustomAppHistory {
|
|
|
10846
10871
|
version: number | null;
|
|
10847
10872
|
live_version: number | null;
|
|
10848
10873
|
draft_changed: boolean;
|
|
10849
|
-
versions: CustomAppVersion
|
|
10874
|
+
versions: Array<CustomAppVersion>;
|
|
10850
10875
|
}
|
|
10851
10876
|
/** What changed between two versions, or since the latest (`apps.diff`). */
|
|
10852
10877
|
export interface CustomAppDiff {
|
|
10853
10878
|
app: string;
|
|
10854
10879
|
from: number | null;
|
|
10855
10880
|
to: number | null;
|
|
10856
|
-
files: {
|
|
10881
|
+
files: Array<{
|
|
10857
10882
|
path: string;
|
|
10858
|
-
|
|
10883
|
+
/** "added", "modified" or "deleted", or a value this SDK does not know yet. */
|
|
10884
|
+
change: string;
|
|
10859
10885
|
patch: string;
|
|
10860
|
-
}
|
|
10861
|
-
grants_added: string
|
|
10862
|
-
grants_removed: string
|
|
10886
|
+
}>;
|
|
10887
|
+
grants_added: Array<string>;
|
|
10888
|
+
grants_removed: Array<string>;
|
|
10863
10889
|
truncated: boolean;
|
|
10864
10890
|
}
|
|
10865
10891
|
/**
|
|
@@ -10881,7 +10907,7 @@ export interface CustomAppRun {
|
|
|
10881
10907
|
ok: boolean;
|
|
10882
10908
|
result?: Json;
|
|
10883
10909
|
error?: string;
|
|
10884
|
-
logs: string
|
|
10910
|
+
logs: Array<string>;
|
|
10885
10911
|
calls: number;
|
|
10886
10912
|
truncated?: boolean;
|
|
10887
10913
|
}
|
|
@@ -10902,7 +10928,7 @@ export interface CustomAppRecord {
|
|
|
10902
10928
|
/** A page of one collection's records, newest first (`apps.records_query`). */
|
|
10903
10929
|
export interface CustomAppRecords {
|
|
10904
10930
|
collection: string;
|
|
10905
|
-
records: CustomAppRecord
|
|
10931
|
+
records: Array<CustomAppRecord>;
|
|
10906
10932
|
}
|
|
10907
10933
|
/**
|
|
10908
10934
|
* One row of a member's main sidebar (`sidebar.get`): a place by its key,
|
|
@@ -10916,7 +10942,7 @@ export interface SidebarEntry {
|
|
|
10916
10942
|
}
|
|
10917
10943
|
/** The member's whole main sidebar, in order; `customized` is false until they change it. */
|
|
10918
10944
|
export interface SidebarLayout {
|
|
10919
|
-
entries: SidebarEntry
|
|
10945
|
+
entries: Array<SidebarEntry>;
|
|
10920
10946
|
customized: boolean;
|
|
10921
10947
|
}
|
|
10922
10948
|
//# sourceMappingURL=index.d.ts.map
|