@nemphi/sdk 0.8.5722 → 0.8.5953
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/generated/assets/client.d.ts +2 -2
- package/dist/generated/assets/client.d.ts.map +1 -1
- package/dist/generated/bank/client.d.ts +12 -4
- package/dist/generated/bank/client.d.ts.map +1 -1
- package/dist/generated/bank/client.js.map +1 -1
- package/dist/generated/bank/models.d.ts +3 -0
- package/dist/generated/bank/models.d.ts.map +1 -1
- package/dist/generated/bank/models.js +1 -0
- package/dist/generated/bank/models.js.map +1 -1
- package/dist/generated/calendar/client.d.ts +122 -14
- package/dist/generated/calendar/client.d.ts.map +1 -1
- package/dist/generated/calendar/client.js +2 -2
- package/dist/generated/calendar/client.js.map +1 -1
- package/dist/generated/calendar/index.d.ts +1 -1
- package/dist/generated/calendar/index.d.ts.map +1 -1
- package/dist/generated/calendar/models.d.ts +16 -0
- package/dist/generated/calendar/models.d.ts.map +1 -1
- package/dist/generated/calendar/models.js +9 -0
- package/dist/generated/calendar/models.js.map +1 -1
- package/dist/generated/company/client.d.ts +11 -5
- package/dist/generated/company/client.d.ts.map +1 -1
- package/dist/generated/company/client.js.map +1 -1
- package/dist/generated/crm/client.d.ts +58 -8
- package/dist/generated/crm/client.d.ts.map +1 -1
- package/dist/generated/crm/client.js +12 -3
- package/dist/generated/crm/client.js.map +1 -1
- package/dist/generated/crm/index.d.ts +2 -2
- package/dist/generated/crm/index.d.ts.map +1 -1
- package/dist/generated/crm/models.d.ts +25 -0
- package/dist/generated/crm/models.d.ts.map +1 -1
- package/dist/generated/crm/models.js +14 -0
- package/dist/generated/crm/models.js.map +1 -1
- package/dist/generated/documents/client.d.ts +4 -3
- package/dist/generated/documents/client.d.ts.map +1 -1
- package/dist/generated/documents/client.js.map +1 -1
- package/dist/generated/documents/models.d.ts +1 -0
- package/dist/generated/documents/models.d.ts.map +1 -1
- package/dist/generated/documents/models.js +1 -0
- package/dist/generated/documents/models.js.map +1 -1
- package/dist/generated/email/client.d.ts +78 -8
- package/dist/generated/email/client.d.ts.map +1 -1
- package/dist/generated/email/client.js +10 -1
- package/dist/generated/email/client.js.map +1 -1
- package/dist/generated/email/index.d.ts +2 -2
- package/dist/generated/email/index.d.ts.map +1 -1
- package/dist/generated/email/models.d.ts +21 -0
- package/dist/generated/email/models.d.ts.map +1 -1
- package/dist/generated/email/models.js +10 -0
- package/dist/generated/email/models.js.map +1 -1
- package/dist/generated/employees/client.d.ts +8 -8
- package/dist/generated/employees/client.d.ts.map +1 -1
- package/dist/generated/items/client.d.ts +23 -1
- package/dist/generated/items/client.d.ts.map +1 -1
- package/dist/generated/items/client.js +9 -1
- package/dist/generated/items/client.js.map +1 -1
- package/dist/generated/items/index.d.ts +2 -2
- package/dist/generated/items/index.d.ts.map +1 -1
- package/dist/generated/items/models.d.ts +19 -0
- package/dist/generated/items/models.d.ts.map +1 -1
- package/dist/generated/items/models.js +6 -0
- package/dist/generated/items/models.js.map +1 -1
- package/dist/generated/knowledge/client.d.ts +46 -1
- package/dist/generated/knowledge/client.d.ts.map +1 -1
- package/dist/generated/knowledge/client.js +10 -1
- package/dist/generated/knowledge/client.js.map +1 -1
- package/dist/generated/knowledge/index.d.ts +2 -2
- package/dist/generated/knowledge/index.d.ts.map +1 -1
- package/dist/generated/knowledge/models.d.ts +11 -0
- package/dist/generated/knowledge/models.d.ts.map +1 -1
- package/dist/generated/knowledge/models.js +5 -0
- package/dist/generated/knowledge/models.js.map +1 -1
- package/dist/generated/ledger/client.d.ts +3 -3
- package/dist/generated/models.d.ts +2 -0
- package/dist/generated/models.d.ts.map +1 -1
- package/dist/generated/models.js +2 -0
- package/dist/generated/models.js.map +1 -1
- package/dist/generated/onboarding/client.d.ts +4 -2
- package/dist/generated/onboarding/client.d.ts.map +1 -1
- package/dist/generated/onboarding/client.js.map +1 -1
- package/dist/generated/parties/client.d.ts +129 -14
- package/dist/generated/parties/client.d.ts.map +1 -1
- package/dist/generated/parties/client.js +29 -2
- package/dist/generated/parties/client.js.map +1 -1
- package/dist/generated/parties/index.d.ts +2 -2
- package/dist/generated/parties/index.d.ts.map +1 -1
- package/dist/generated/parties/models.d.ts +29 -0
- package/dist/generated/parties/models.d.ts.map +1 -1
- package/dist/generated/parties/models.js +17 -0
- package/dist/generated/parties/models.js.map +1 -1
- package/dist/generated/policies/client.d.ts +14 -6
- package/dist/generated/policies/client.d.ts.map +1 -1
- package/dist/generated/policies/client.js.map +1 -1
- package/dist/generated/policies/models.d.ts +1 -0
- package/dist/generated/policies/models.d.ts.map +1 -1
- package/dist/generated/policies/models.js.map +1 -1
- package/dist/generated/records/client.d.ts +2 -1
- package/dist/generated/records/client.d.ts.map +1 -1
- package/dist/generated/records/client.js.map +1 -1
- package/dist/generated/recurring/client.d.ts +5 -0
- package/dist/generated/recurring/client.d.ts.map +1 -1
- package/dist/generated/recurring/client.js +1 -1
- package/dist/generated/recurring/client.js.map +1 -1
- package/dist/generated/recurring/models.d.ts +1 -0
- package/dist/generated/recurring/models.d.ts.map +1 -1
- package/dist/generated/recurring/models.js +1 -0
- package/dist/generated/recurring/models.js.map +1 -1
- package/dist/generated/sidebar/client.d.ts +49 -1
- package/dist/generated/sidebar/client.d.ts.map +1 -1
- package/dist/generated/sidebar/client.js +16 -0
- package/dist/generated/sidebar/client.js.map +1 -1
- package/dist/generated/sidebar/index.d.ts +2 -2
- package/dist/generated/sidebar/index.d.ts.map +1 -1
- package/dist/generated/sidebar/models.d.ts +10 -0
- package/dist/generated/sidebar/models.d.ts.map +1 -1
- package/dist/generated/support/models.d.ts +5 -0
- package/dist/generated/support/models.d.ts.map +1 -1
- package/dist/generated/support/models.js.map +1 -1
- package/dist/generated/tax/client.d.ts +9 -5
- package/dist/generated/tax/client.d.ts.map +1 -1
- package/dist/generated/tax/client.js.map +1 -1
- package/dist/index.d.ts +246 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1507,6 +1507,8 @@ export interface RecurringDocument {
|
|
|
1507
1507
|
last_run_at?: string;
|
|
1508
1508
|
generated_count: number;
|
|
1509
1509
|
note?: string;
|
|
1510
|
+
/** The last day a copy may be issued (YYYY-MM-DD); absent runs with no end. */
|
|
1511
|
+
end_date?: string;
|
|
1510
1512
|
created_at: string;
|
|
1511
1513
|
}
|
|
1512
1514
|
export interface PolicyConditions {
|
|
@@ -1531,8 +1533,14 @@ export interface Policy {
|
|
|
1531
1533
|
}
|
|
1532
1534
|
export interface PolicyList {
|
|
1533
1535
|
policies: Policy[];
|
|
1534
|
-
/**
|
|
1536
|
+
/** The platform's default per tool when no policy matches, the class policy included. */
|
|
1535
1537
|
defaults: Record<string, "allow" | "require_approval">;
|
|
1538
|
+
/**
|
|
1539
|
+
* Each tool's risk class, which says which class policy (`tool_pattern`
|
|
1540
|
+
* `risk:financial`, `risk:external_effect`) reaches it. Absent from an
|
|
1541
|
+
* older platform.
|
|
1542
|
+
*/
|
|
1543
|
+
risks?: Record<string, RiskClass>;
|
|
1536
1544
|
}
|
|
1537
1545
|
export interface ActionPreview {
|
|
1538
1546
|
action: "approve" | "deny";
|
|
@@ -1557,7 +1565,17 @@ export interface LiveDocumentFile {
|
|
|
1557
1565
|
size_bytes: number;
|
|
1558
1566
|
/** The extraction's status: uploaded, processing, processed or failed. */
|
|
1559
1567
|
status: string;
|
|
1568
|
+
/** What reading the file classified it as (invoice, bank_statement, rut… or unknown). */
|
|
1569
|
+
kind?: string;
|
|
1570
|
+
/** How far reading it got; left out when the answer did not read it. */
|
|
1571
|
+
reading?: LiveDocumentReading;
|
|
1560
1572
|
}
|
|
1573
|
+
/**
|
|
1574
|
+
* How far reading a file got: `pending` (queued or being read), `read`
|
|
1575
|
+
* (its fields were extracted), `stored` (kept without reading: too large,
|
|
1576
|
+
* or nothing to read) or `failed`.
|
|
1577
|
+
*/
|
|
1578
|
+
export type LiveDocumentReading = "pending" | "read" | "stored" | "failed";
|
|
1561
1579
|
/**
|
|
1562
1580
|
* Where a live document lives: its owner's `personal` space (seen by the
|
|
1563
1581
|
* members it is shared with too) or the workspace's shared `team` space.
|
|
@@ -1617,6 +1635,13 @@ export interface LiveDocumentFilter {
|
|
|
1617
1635
|
tag?: string;
|
|
1618
1636
|
/** Only the documents this member (a user id) created. */
|
|
1619
1637
|
created_by?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* Only one kind of document (doc, sheet, slides) or, for files, what
|
|
1640
|
+
* reading classified them as (invoice, bank_statement, rut…).
|
|
1641
|
+
*/
|
|
1642
|
+
type?: string;
|
|
1643
|
+
/** Only the files whose reading got this far. */
|
|
1644
|
+
reading?: LiveDocumentReading;
|
|
1620
1645
|
}
|
|
1621
1646
|
/** A folder of documents; folders nest through `parent_id`. */
|
|
1622
1647
|
export interface LiveDocumentFolder {
|
|
@@ -1678,6 +1703,26 @@ export interface LiveDocumentShares {
|
|
|
1678
1703
|
email: string;
|
|
1679
1704
|
}[];
|
|
1680
1705
|
}
|
|
1706
|
+
/** What a comment's @-mentions told (`knowledge.mention_in_comment`). */
|
|
1707
|
+
export interface LiveDocumentMentions {
|
|
1708
|
+
live_document_id: string;
|
|
1709
|
+
thread_id: string;
|
|
1710
|
+
comment_id: string;
|
|
1711
|
+
/** The members named who can open the document. */
|
|
1712
|
+
mentioned: string[];
|
|
1713
|
+
/** Those this comment had not told before, now notified. */
|
|
1714
|
+
notified: string[];
|
|
1715
|
+
/** Members the document is closed to, told nothing. */
|
|
1716
|
+
skipped: string[];
|
|
1717
|
+
}
|
|
1718
|
+
/** One comment's mentions, as `mentionInLiveDocumentComment` sends them. */
|
|
1719
|
+
export interface LiveDocumentMentionInput {
|
|
1720
|
+
thread_id: string;
|
|
1721
|
+
comment_id: string;
|
|
1722
|
+
user_ids: string[];
|
|
1723
|
+
/** The comment's words, quoted in the notification. */
|
|
1724
|
+
text?: string;
|
|
1725
|
+
}
|
|
1681
1726
|
/** How many days a transfer's link works. */
|
|
1682
1727
|
export type TransferExpiryDays = 1 | 3 | 7 | 14 | 30;
|
|
1683
1728
|
/** What `createTransfer` sends (`transfers.create`). */
|
|
@@ -1806,6 +1851,8 @@ export interface Document {
|
|
|
1806
1851
|
*/
|
|
1807
1852
|
export interface DocumentText extends Document {
|
|
1808
1853
|
markdown: string;
|
|
1854
|
+
/** The file in Docs that stands for it, when the caller may open one (trashed included). */
|
|
1855
|
+
live_document_id?: string;
|
|
1809
1856
|
}
|
|
1810
1857
|
/** Upload kind hints that route a document to the company-profile parser. */
|
|
1811
1858
|
export type CompanyDocumentKind = "rut" | "company_registration";
|
|
@@ -1953,6 +2000,15 @@ export interface SupportTicket {
|
|
|
1953
2000
|
export interface SupportTicketSummary extends SupportTicket {
|
|
1954
2001
|
message_count: number;
|
|
1955
2002
|
}
|
|
2003
|
+
/** support.tickets: one tab's tickets and how many each tab holds. */
|
|
2004
|
+
export interface SupportTicketList {
|
|
2005
|
+
tickets: SupportTicketSummary[];
|
|
2006
|
+
counts?: {
|
|
2007
|
+
open: number;
|
|
2008
|
+
closed: number;
|
|
2009
|
+
all: number;
|
|
2010
|
+
};
|
|
2011
|
+
}
|
|
1956
2012
|
export interface SupportMessage {
|
|
1957
2013
|
id: string;
|
|
1958
2014
|
tenant_id: string;
|
|
@@ -3597,7 +3653,19 @@ export interface Party {
|
|
|
3597
3653
|
ciiu_primary?: string | null;
|
|
3598
3654
|
ciiu_secondary?: string[] | null;
|
|
3599
3655
|
city?: string | null;
|
|
3656
|
+
/** DIAN identity for electronic invoicing (parties.update). */
|
|
3657
|
+
identification_document_code?: string | null;
|
|
3658
|
+
dv?: string | null;
|
|
3659
|
+
legal_organization_code?: string | null;
|
|
3660
|
+
tribute_code?: string | null;
|
|
3661
|
+
municipality_code?: string | null;
|
|
3662
|
+
trade_name?: string | null;
|
|
3663
|
+
fiscal_responsibilities?: string[] | null;
|
|
3600
3664
|
crm_company_id?: string | null;
|
|
3665
|
+
/** When parties.archive hid it from lists and pickers; null while it is listed. */
|
|
3666
|
+
archived_at?: string | null;
|
|
3667
|
+
/** The party parties.merge folded this one into. */
|
|
3668
|
+
merged_into_id?: string | null;
|
|
3601
3669
|
company?: {
|
|
3602
3670
|
id: string;
|
|
3603
3671
|
domain: string;
|
|
@@ -3706,6 +3774,36 @@ export interface PartyMatch {
|
|
|
3706
3774
|
tax_id: string | null;
|
|
3707
3775
|
/** What it shares with the values given. */
|
|
3708
3776
|
reasons: Array<"email" | "phone" | "tax_id" | "name">;
|
|
3777
|
+
/** Archived (parties.archive): restore it rather than creating it again. */
|
|
3778
|
+
archived?: boolean;
|
|
3779
|
+
}
|
|
3780
|
+
/** How many rows of each kind parties.merge moved to the contact it kept. */
|
|
3781
|
+
export interface PartyMergeMoved {
|
|
3782
|
+
deals: number;
|
|
3783
|
+
sales_documents: number;
|
|
3784
|
+
purchase_orders: number;
|
|
3785
|
+
invoices: number;
|
|
3786
|
+
bills: number;
|
|
3787
|
+
interactions: number;
|
|
3788
|
+
email_addresses: number;
|
|
3789
|
+
prospects: number;
|
|
3790
|
+
bookings: number;
|
|
3791
|
+
marketing_conversations: number;
|
|
3792
|
+
marketing_calls: number;
|
|
3793
|
+
campaign_recipients: number;
|
|
3794
|
+
payment_links: number;
|
|
3795
|
+
employees: number;
|
|
3796
|
+
fixed_assets: number;
|
|
3797
|
+
tags: number;
|
|
3798
|
+
categorization_rules: number;
|
|
3799
|
+
tax_profile: number;
|
|
3800
|
+
campaigns: number;
|
|
3801
|
+
}
|
|
3802
|
+
/** What parties.merge answers: the contact kept, the one folded into it, and what moved. */
|
|
3803
|
+
export interface PartyMergeResult {
|
|
3804
|
+
party: Party;
|
|
3805
|
+
merged: Party;
|
|
3806
|
+
moved: PartyMergeMoved;
|
|
3709
3807
|
}
|
|
3710
3808
|
/** What parties.find_matches answers: the duplicates, and the company a work email binds to. */
|
|
3711
3809
|
export interface PartyMatches {
|
|
@@ -4748,6 +4846,34 @@ export interface CRMDeal {
|
|
|
4748
4846
|
created_at: string;
|
|
4749
4847
|
updated_at: string;
|
|
4750
4848
|
}
|
|
4849
|
+
/**
|
|
4850
|
+
* One change to a deal (crm.deal_history), read from the action ledger:
|
|
4851
|
+
* created, moved to a stage (won or lost when that stage closes it),
|
|
4852
|
+
* edited, or converted into a quote or an invoice.
|
|
4853
|
+
*/
|
|
4854
|
+
export interface CRMDealEvent {
|
|
4855
|
+
kind: "created" | "moved" | "edited" | "converted";
|
|
4856
|
+
at: string;
|
|
4857
|
+
actor_type: "user" | "api_key" | "oauth" | "agent" | "system";
|
|
4858
|
+
actor_id?: string;
|
|
4859
|
+
/** The member's or the agent's name, when one acted. */
|
|
4860
|
+
actor_name?: string;
|
|
4861
|
+
/** The stage the deal stood on after the change, and its status. */
|
|
4862
|
+
stage?: string;
|
|
4863
|
+
stage_name?: string;
|
|
4864
|
+
status?: "open" | "won" | "lost";
|
|
4865
|
+
/** The fields an edit changed. */
|
|
4866
|
+
fields?: string[];
|
|
4867
|
+
/** What a conversion made. */
|
|
4868
|
+
document_kind?: "quote" | "invoice";
|
|
4869
|
+
document_id?: string;
|
|
4870
|
+
document_number?: string;
|
|
4871
|
+
}
|
|
4872
|
+
/** A deal's history, newest first (crm.deal_history). */
|
|
4873
|
+
export interface CRMDealHistory {
|
|
4874
|
+
deal_id: string;
|
|
4875
|
+
events: CRMDealEvent[];
|
|
4876
|
+
}
|
|
4751
4877
|
/** One kanban column: a pipeline stage and the deals sitting in it. */
|
|
4752
4878
|
export interface CRMBoardColumn {
|
|
4753
4879
|
stage_id: string;
|
|
@@ -4802,6 +4928,10 @@ export interface CRMGridQuery {
|
|
|
4802
4928
|
pipeline?: string;
|
|
4803
4929
|
status?: "open" | "won" | "lost";
|
|
4804
4930
|
kind?: "customer" | "vendor" | "both";
|
|
4931
|
+
/** party: the seller's columns (default) or finance's fiscal ones. */
|
|
4932
|
+
view?: "contacts" | "fiscal";
|
|
4933
|
+
/** party: only the archived contacts. */
|
|
4934
|
+
archived?: boolean;
|
|
4805
4935
|
search?: string;
|
|
4806
4936
|
filters?: CRMGridFilter[];
|
|
4807
4937
|
sort?: string;
|
|
@@ -4828,6 +4958,11 @@ export interface CRMGridResult {
|
|
|
4828
4958
|
columns: CRMGridColumn[];
|
|
4829
4959
|
rows: JsonObject[];
|
|
4830
4960
|
total: number;
|
|
4961
|
+
/**
|
|
4962
|
+
* How many records each tab holds, before search and filters: parties by
|
|
4963
|
+
* kind (all, customer, vendor, both), deals by status (all, open, won, lost).
|
|
4964
|
+
*/
|
|
4965
|
+
counts?: Record<string, number>;
|
|
4831
4966
|
offset: number;
|
|
4832
4967
|
limit: number;
|
|
4833
4968
|
currency: string;
|
|
@@ -5123,6 +5258,9 @@ export interface CRMInteraction {
|
|
|
5123
5258
|
party_id: string | null;
|
|
5124
5259
|
/** Resolved party name when linked. */
|
|
5125
5260
|
party?: string;
|
|
5261
|
+
/** The deal it was logged on (crm.log_interaction deal_id), and its title. */
|
|
5262
|
+
deal_id?: string;
|
|
5263
|
+
deal?: string;
|
|
5126
5264
|
kind: "email" | "call" | "meeting" | "note" | "whatsapp" | "other";
|
|
5127
5265
|
direction: "inbound" | "outbound" | "none";
|
|
5128
5266
|
subject?: string;
|
|
@@ -5155,6 +5293,8 @@ export interface EmailAccount {
|
|
|
5155
5293
|
last_error?: string;
|
|
5156
5294
|
/** Owner opt-in: reading mail here also marks it read in the real mailbox (Gmail only). */
|
|
5157
5295
|
mark_read_in_provider: boolean;
|
|
5296
|
+
/** The owner's sign-off, added under what they write from this mailbox; absent until set. */
|
|
5297
|
+
signature?: string;
|
|
5158
5298
|
last_synced_at: string | null;
|
|
5159
5299
|
created_at: string;
|
|
5160
5300
|
}
|
|
@@ -6264,6 +6404,45 @@ export interface EmailInbox {
|
|
|
6264
6404
|
messages: EmailMessage[];
|
|
6265
6405
|
unread_count: number;
|
|
6266
6406
|
}
|
|
6407
|
+
/** What a member writes from their mailbox: a new message, or an answer to or forward of one. */
|
|
6408
|
+
export type EmailComposeMode = "new" | "reply" | "reply_all" | "forward";
|
|
6409
|
+
/**
|
|
6410
|
+
* Why a message the member wrote did not go out: the grant cannot send
|
|
6411
|
+
* (`reconnect`), the provider refused it (`rejected`), it was interrupted
|
|
6412
|
+
* mid-send and may have gone out (`uncertain`), the provider stayed out of
|
|
6413
|
+
* reach (`unavailable`), or the mailbox was disconnected (`mailbox_gone`).
|
|
6414
|
+
*/
|
|
6415
|
+
export type EmailSendFailure = "reconnect" | "rejected" | "uncertain" | "unavailable" | "mailbox_gone";
|
|
6416
|
+
/** A message the member wrote from their mailbox (email.compose), until its sent copy syncs back. */
|
|
6417
|
+
export interface EmailSend {
|
|
6418
|
+
id: string;
|
|
6419
|
+
account_id: string;
|
|
6420
|
+
/** The inbox message it answers or forwards; absent for a new message. */
|
|
6421
|
+
message_id?: string;
|
|
6422
|
+
mode: EmailComposeMode;
|
|
6423
|
+
to: string[];
|
|
6424
|
+
cc: string[];
|
|
6425
|
+
subject: string;
|
|
6426
|
+
status: "queued" | "sending" | "sent" | "failed";
|
|
6427
|
+
error?: EmailSendFailure;
|
|
6428
|
+
created_at: string;
|
|
6429
|
+
sent_at?: string;
|
|
6430
|
+
}
|
|
6431
|
+
/** email.compose input. */
|
|
6432
|
+
export interface EmailComposeInput {
|
|
6433
|
+
mode: EmailComposeMode;
|
|
6434
|
+
/** The inbox message answered or forwarded; not for a new message. */
|
|
6435
|
+
message_id?: string;
|
|
6436
|
+
/** The mailbox to write from; an answer defaults to the one that received the message. */
|
|
6437
|
+
account_id?: string;
|
|
6438
|
+
to: string[];
|
|
6439
|
+
cc?: string[];
|
|
6440
|
+
/** Defaults to the original's with Re: or Fwd: for an answer or forward. */
|
|
6441
|
+
subject?: string;
|
|
6442
|
+
/** Plain text; the mailbox's signature is added under it unless `signature` is false. */
|
|
6443
|
+
body: string;
|
|
6444
|
+
signature?: boolean;
|
|
6445
|
+
}
|
|
6267
6446
|
/** email.read_message result: metadata plus the stored (encrypted-at-rest) body. */
|
|
6268
6447
|
export interface EmailMessageBody {
|
|
6269
6448
|
id: string;
|
|
@@ -6284,6 +6463,8 @@ export interface EmailMessageBody {
|
|
|
6284
6463
|
* the sanitizer is the storage-side half of the defense, not all of it.
|
|
6285
6464
|
*/
|
|
6286
6465
|
body_html?: string;
|
|
6466
|
+
/** What the member wrote in answer that is still queued, failed, or sent but not yet synced back. */
|
|
6467
|
+
sends?: EmailSend[];
|
|
6287
6468
|
}
|
|
6288
6469
|
/**
|
|
6289
6470
|
* The calendar: what the workspace owes, on one timeline. `events` are
|
|
@@ -6414,7 +6595,35 @@ export interface AgendaEntry {
|
|
|
6414
6595
|
amount_cents?: number;
|
|
6415
6596
|
currency?: string;
|
|
6416
6597
|
remind_minutes?: number;
|
|
6598
|
+
/** For a date of a repeating event: the series it belongs to. */
|
|
6599
|
+
series_id?: string;
|
|
6600
|
+
/** For a date of a repeating event: the start its rule gave the date. */
|
|
6601
|
+
occurrence_start?: string;
|
|
6602
|
+
/** For a date of a repeating event: how the series repeats. */
|
|
6603
|
+
repeat?: CalendarRepeat;
|
|
6604
|
+
}
|
|
6605
|
+
/** How often a calendar event repeats. */
|
|
6606
|
+
export type CalendarRepeatFrequency = "daily" | "weekly" | "monthly" | "yearly";
|
|
6607
|
+
/** A weekday as the repeat rule names it. */
|
|
6608
|
+
export type CalendarWeekday = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
|
|
6609
|
+
/** How a repeating calendar event repeats, and the RFC 5545 rule it is stored as. */
|
|
6610
|
+
export interface CalendarRepeat {
|
|
6611
|
+
frequency: CalendarRepeatFrequency;
|
|
6612
|
+
/** Every how many days, weeks, months or years. */
|
|
6613
|
+
interval: number;
|
|
6614
|
+
/** For a weekly rule, the weekdays it falls on; empty otherwise. */
|
|
6615
|
+
weekdays: CalendarWeekday[];
|
|
6616
|
+
/** The last day it may happen on (YYYY-MM-DD), when it ends on a date. */
|
|
6617
|
+
until?: string;
|
|
6618
|
+
/** How many times it happens in all, when it ends after a count. */
|
|
6619
|
+
count?: number;
|
|
6620
|
+
/** The IANA zone each date keeps its time in. */
|
|
6621
|
+
time_zone: string;
|
|
6622
|
+
/** The RRULE (FREQ=WEEKLY;BYDAY=WE). */
|
|
6623
|
+
rule: string;
|
|
6417
6624
|
}
|
|
6625
|
+
/** How far a change to one date of a repeating event reaches. */
|
|
6626
|
+
export type CalendarScope = "this" | "following" | "all";
|
|
6418
6627
|
export interface AgendaResult {
|
|
6419
6628
|
from: string;
|
|
6420
6629
|
to: string;
|
|
@@ -6469,6 +6678,12 @@ export interface CalendarEvent {
|
|
|
6469
6678
|
editable: boolean;
|
|
6470
6679
|
overdue: boolean;
|
|
6471
6680
|
created_at: string;
|
|
6681
|
+
/** For a repeating event or one of its dates: the series. */
|
|
6682
|
+
series_id?: string;
|
|
6683
|
+
/** For a date of a repeating event: the start its rule gave the date. */
|
|
6684
|
+
occurrence_start?: string;
|
|
6685
|
+
/** For a repeating event: how it repeats. */
|
|
6686
|
+
repeat?: CalendarRepeat;
|
|
6472
6687
|
}
|
|
6473
6688
|
export interface CalendarEventList {
|
|
6474
6689
|
from: string;
|
|
@@ -6494,6 +6709,22 @@ export interface CalendarEventInput {
|
|
|
6494
6709
|
status?: CalendarStatus;
|
|
6495
6710
|
/** Notify the audience this many minutes before it starts. */
|
|
6496
6711
|
remind_minutes?: number;
|
|
6712
|
+
/** Make it repeat ("none" stops a repeat); the rule travels whole. */
|
|
6713
|
+
repeat?: CalendarRepeatFrequency | "none";
|
|
6714
|
+
repeat_interval?: number;
|
|
6715
|
+
repeat_weekdays?: CalendarWeekday[];
|
|
6716
|
+
/** The last day it may happen on, YYYY-MM-DD. */
|
|
6717
|
+
repeat_until?: string;
|
|
6718
|
+
repeat_count?: number;
|
|
6719
|
+
/** The IANA zone a repeat keeps its time in; the workspace's when omitted. */
|
|
6720
|
+
time_zone?: string;
|
|
6721
|
+
}
|
|
6722
|
+
/** Which date of a repeating event a write acts on, and how far it reaches. */
|
|
6723
|
+
export interface CalendarOccurrenceInput {
|
|
6724
|
+
event_id: string;
|
|
6725
|
+
/** The date's occurrence_start; an id the agenda gave a date already names it. */
|
|
6726
|
+
occurrence?: string;
|
|
6727
|
+
scope?: CalendarScope;
|
|
6497
6728
|
}
|
|
6498
6729
|
/** Block types that render something themselves. */
|
|
6499
6730
|
export type CanvasLeafType = "stats" | "chart" | "table" | "text" | "records" | "detail" | "actions" | "form" | "button" | "toggle" | "profile" | "kanban" | "agenda" | "event" | "callout" | "heading" | "divider" | "image" | "params" | "result";
|
|
@@ -7738,9 +7969,16 @@ export interface NemphiClient {
|
|
|
7738
7969
|
account_id: string;
|
|
7739
7970
|
/** When true, marking mail read on the platform also marks it read in the real mailbox (Gmail only). */
|
|
7740
7971
|
mark_read_in_provider?: boolean;
|
|
7972
|
+
/** The sign-off added under what the owner writes from this mailbox; "" clears it. */
|
|
7973
|
+
signature?: string;
|
|
7741
7974
|
}): Promise<{
|
|
7742
7975
|
account: EmailAccount;
|
|
7743
7976
|
}>;
|
|
7977
|
+
/** Write from one of the caller's own mailboxes: a new message, a reply, a reply to all or a forward. */
|
|
7978
|
+
composeEmail(input: EmailComposeInput): Promise<{
|
|
7979
|
+
queued: boolean;
|
|
7980
|
+
send: EmailSend;
|
|
7981
|
+
}>;
|
|
7744
7982
|
crmSettings(): Promise<CRMSettings>;
|
|
7745
7983
|
configureCRM(input: {
|
|
7746
7984
|
auto_create_contacts?: boolean;
|
|
@@ -8323,6 +8561,8 @@ export interface NemphiClient {
|
|
|
8323
8561
|
}): Promise<Party[]>;
|
|
8324
8562
|
listCRMInteractions(input?: {
|
|
8325
8563
|
party_id?: string;
|
|
8564
|
+
/** One deal's timeline: what was logged on it, and its contact's touchpoints on no deal. */
|
|
8565
|
+
deal_id?: string;
|
|
8326
8566
|
kind?: string;
|
|
8327
8567
|
source?: string;
|
|
8328
8568
|
unmatched?: boolean;
|
|
@@ -8851,6 +9091,8 @@ export interface NemphiClient {
|
|
|
8851
9091
|
deleted: boolean;
|
|
8852
9092
|
}>;
|
|
8853
9093
|
listLiveDocumentShares(id: string): Promise<LiveDocumentShares>;
|
|
9094
|
+
/** Notifies the members a comment on the document @-mentions (`knowledge.mention_in_comment`). */
|
|
9095
|
+
mentionInLiveDocumentComment(id: string, mention: LiveDocumentMentionInput): Promise<LiveDocumentMentions>;
|
|
8854
9096
|
shareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
|
|
8855
9097
|
unshareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
|
|
8856
9098
|
listLiveDocumentFolders(space: LiveDocumentSpace): Promise<LiveDocumentFolder[]>;
|
|
@@ -9431,17 +9673,12 @@ export interface NemphiClient {
|
|
|
9431
9673
|
title: string;
|
|
9432
9674
|
starts_at: string;
|
|
9433
9675
|
}): Promise<CalendarEvent>;
|
|
9434
|
-
updateCalendarEvent(input: CalendarEventInput & {
|
|
9435
|
-
event_id: string;
|
|
9676
|
+
updateCalendarEvent(input: CalendarEventInput & CalendarOccurrenceInput & {
|
|
9436
9677
|
clear_ends_at?: boolean;
|
|
9437
9678
|
clear_remind?: boolean;
|
|
9438
9679
|
}): Promise<CalendarEvent>;
|
|
9439
|
-
completeCalendarEvent(input:
|
|
9440
|
-
|
|
9441
|
-
}): Promise<CalendarEvent>;
|
|
9442
|
-
deleteCalendarEvent(input: {
|
|
9443
|
-
event_id: string;
|
|
9444
|
-
}): Promise<{
|
|
9680
|
+
completeCalendarEvent(input: CalendarOccurrenceInput): Promise<CalendarEvent>;
|
|
9681
|
+
deleteCalendarEvent(input: CalendarOccurrenceInput): Promise<{
|
|
9445
9682
|
id: string;
|
|
9446
9683
|
deleted: boolean;
|
|
9447
9684
|
}>;
|