@nemphi/sdk 0.8.5558 → 0.8.5722

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.
Files changed (103) hide show
  1. package/dist/generated/bank/client.d.ts +3 -1
  2. package/dist/generated/bank/client.d.ts.map +1 -1
  3. package/dist/generated/bank/client.js.map +1 -1
  4. package/dist/generated/bank/index.d.ts +1 -1
  5. package/dist/generated/bank/index.d.ts.map +1 -1
  6. package/dist/generated/bank/models.d.ts +7 -0
  7. package/dist/generated/bank/models.d.ts.map +1 -1
  8. package/dist/generated/bank/models.js +1 -0
  9. package/dist/generated/bank/models.js.map +1 -1
  10. package/dist/generated/bills/client.d.ts +13 -8
  11. package/dist/generated/bills/client.d.ts.map +1 -1
  12. package/dist/generated/bills/client.js +1 -0
  13. package/dist/generated/bills/client.js.map +1 -1
  14. package/dist/generated/bookings/client.d.ts +25 -8
  15. package/dist/generated/bookings/client.d.ts.map +1 -1
  16. package/dist/generated/bookings/client.js +2 -2
  17. package/dist/generated/bookings/client.js.map +1 -1
  18. package/dist/generated/bookings/models.d.ts +2 -0
  19. package/dist/generated/bookings/models.d.ts.map +1 -1
  20. package/dist/generated/bookings/models.js +2 -0
  21. package/dist/generated/bookings/models.js.map +1 -1
  22. package/dist/generated/calendar/client.d.ts +12 -0
  23. package/dist/generated/calendar/client.d.ts.map +1 -1
  24. package/dist/generated/calendar/client.js +2 -1
  25. package/dist/generated/calendar/client.js.map +1 -1
  26. package/dist/generated/callcenter/client.d.ts +8 -1
  27. package/dist/generated/callcenter/client.d.ts.map +1 -1
  28. package/dist/generated/callcenter/client.js.map +1 -1
  29. package/dist/generated/crm/client.d.ts +14 -10
  30. package/dist/generated/crm/client.d.ts.map +1 -1
  31. package/dist/generated/crm/client.js +3 -3
  32. package/dist/generated/crm/client.js.map +1 -1
  33. package/dist/generated/crm/models.d.ts +4 -0
  34. package/dist/generated/crm/models.d.ts.map +1 -1
  35. package/dist/generated/crm/models.js +11 -0
  36. package/dist/generated/crm/models.js.map +1 -1
  37. package/dist/generated/email/client.d.ts +24 -1
  38. package/dist/generated/email/client.d.ts.map +1 -1
  39. package/dist/generated/email/client.js +8 -0
  40. package/dist/generated/email/client.js.map +1 -1
  41. package/dist/generated/email/index.d.ts +2 -2
  42. package/dist/generated/email/index.d.ts.map +1 -1
  43. package/dist/generated/email/models.d.ts +8 -0
  44. package/dist/generated/email/models.d.ts.map +1 -1
  45. package/dist/generated/email/models.js +1 -0
  46. package/dist/generated/email/models.js.map +1 -1
  47. package/dist/generated/invoices/client.d.ts +4 -1
  48. package/dist/generated/invoices/client.d.ts.map +1 -1
  49. package/dist/generated/invoices/client.js.map +1 -1
  50. package/dist/generated/marketing/client.d.ts +11 -6
  51. package/dist/generated/marketing/client.d.ts.map +1 -1
  52. package/dist/generated/marketing/client.js.map +1 -1
  53. package/dist/generated/marketing/models.d.ts +1 -0
  54. package/dist/generated/marketing/models.d.ts.map +1 -1
  55. package/dist/generated/marketing/models.js +1 -0
  56. package/dist/generated/marketing/models.js.map +1 -1
  57. package/dist/generated/messages/client.d.ts +4 -1
  58. package/dist/generated/messages/client.d.ts.map +1 -1
  59. package/dist/generated/messages/client.js.map +1 -1
  60. package/dist/generated/messages/index.d.ts +1 -1
  61. package/dist/generated/messages/index.d.ts.map +1 -1
  62. package/dist/generated/messages/models.d.ts +24 -0
  63. package/dist/generated/messages/models.d.ts.map +1 -1
  64. package/dist/generated/messages/models.js +14 -0
  65. package/dist/generated/messages/models.js.map +1 -1
  66. package/dist/generated/metrics/client.d.ts +4 -1
  67. package/dist/generated/metrics/client.d.ts.map +1 -1
  68. package/dist/generated/metrics/client.js.map +1 -1
  69. package/dist/generated/numbering/client.d.ts +3 -1
  70. package/dist/generated/numbering/client.d.ts.map +1 -1
  71. package/dist/generated/numbering/client.js.map +1 -1
  72. package/dist/generated/onboarding/client.d.ts +16 -13
  73. package/dist/generated/onboarding/client.d.ts.map +1 -1
  74. package/dist/generated/onboarding/client.js.map +1 -1
  75. package/dist/generated/onboarding/models.d.ts +1 -0
  76. package/dist/generated/onboarding/models.d.ts.map +1 -1
  77. package/dist/generated/onboarding/models.js.map +1 -1
  78. package/dist/generated/quotes/client.d.ts +56 -9
  79. package/dist/generated/quotes/client.d.ts.map +1 -1
  80. package/dist/generated/quotes/client.js +19 -1
  81. package/dist/generated/quotes/client.js.map +1 -1
  82. package/dist/generated/quotes/index.d.ts +2 -2
  83. package/dist/generated/quotes/index.d.ts.map +1 -1
  84. package/dist/generated/quotes/models.d.ts +12 -0
  85. package/dist/generated/quotes/models.d.ts.map +1 -1
  86. package/dist/generated/quotes/models.js +3 -0
  87. package/dist/generated/quotes/models.js.map +1 -1
  88. package/dist/generated/sessions/client.d.ts +13 -3
  89. package/dist/generated/sessions/client.d.ts.map +1 -1
  90. package/dist/generated/sessions/client.js.map +1 -1
  91. package/dist/generated/sessions/models.d.ts +2 -0
  92. package/dist/generated/sessions/models.d.ts.map +1 -1
  93. package/dist/generated/sessions/models.js.map +1 -1
  94. package/dist/generated/sidebar/client.d.ts +1 -1
  95. package/dist/generated/sidebar/client.d.ts.map +1 -1
  96. package/dist/generated/sites/client.d.ts +3 -2
  97. package/dist/generated/sites/client.d.ts.map +1 -1
  98. package/dist/generated/sites/client.js.map +1 -1
  99. package/dist/index.d.ts +120 -5
  100. package/dist/index.d.ts.map +1 -1
  101. package/dist/index.js +5 -1
  102. package/dist/index.js.map +1 -1
  103. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -155,6 +155,8 @@ export interface OnboardingQuestion {
155
155
  options: string[];
156
156
  /** Several answers allowed. */
157
157
  multiple?: boolean;
158
+ /** Asked once the workspace is open rather than by the gate. */
159
+ later?: boolean;
158
160
  /** What has been answered so far. */
159
161
  answers?: string[];
160
162
  }
@@ -163,12 +165,12 @@ export interface OnboardingState {
163
165
  completed: boolean;
164
166
  completed_at?: string;
165
167
  questions: OnboardingQuestion[];
166
- /** Question ids still unanswered — the gate stays shut while non-empty. */
168
+ /** The gate's question ids still unanswered — the gate stays shut while non-empty. */
167
169
  missing: string[];
168
170
  profile: WorkspaceProfile;
169
171
  /** Tool modules worth setting up for this workspace. */
170
172
  modules: string[];
171
- /** The autonomy level the answers imply; shown as the suggestion. */
173
+ /** The autonomy level shown pre-selected: always the most cautious one. */
172
174
  recommended_autonomy: WorkspaceAutonomy;
173
175
  /**
174
176
  * The canvas this workspace is on its way to, rebuilt on every
@@ -444,7 +446,14 @@ export interface Run {
444
446
  agent_name?: string;
445
447
  agent_definition?: string;
446
448
  trigger: string;
449
+ /** The brief the model reads: instructions, ids and context, not for people. */
447
450
  goal: string;
451
+ /**
452
+ * What the run is about as a person reads it: the member's own words, a
453
+ * routine's name, the goal's first line. "" when the goal is data; name
454
+ * the run by its agent then.
455
+ */
456
+ title?: string;
448
457
  status: "running" | "awaiting_approval" | "awaiting_agents" | "awaiting_input" | "idle" | "succeeded" | "failed" | "cancelled";
449
458
  result?: string;
450
459
  error?: string;
@@ -695,6 +704,10 @@ export interface InboxApproval {
695
704
  tool: string;
696
705
  arguments: unknown;
697
706
  goal: string;
707
+ /** What the run is about as a person reads it ("" when it names nothing). */
708
+ title?: string;
709
+ /** The chat conversation the request came from, "" for work no conversation started. */
710
+ thread_id?: string;
698
711
  agent_id: string;
699
712
  agent_name: string;
700
713
  agent_definition: string;
@@ -705,6 +718,10 @@ export interface InboxQuestion {
705
718
  run_id: string;
706
719
  questions: RunQuestion[] | null;
707
720
  goal: string;
721
+ /** What the run is about as a person reads it ("" when it names nothing). */
722
+ title?: string;
723
+ /** The chat conversation the request came from, "" for work no conversation started. */
724
+ thread_id?: string;
708
725
  agent_id: string;
709
726
  agent_name: string;
710
727
  agent_definition: string;
@@ -1433,6 +1450,8 @@ export interface InvitePreview {
1433
1450
  email: string;
1434
1451
  role: string;
1435
1452
  role_name?: string;
1453
+ /** Who sent the invitation; "" when unknown. */
1454
+ inviter_name?: string;
1436
1455
  expires_at: string;
1437
1456
  }
1438
1457
  export type BudgetSection = "income" | "fixed" | "variable" | "savings" | "debt";
@@ -2638,6 +2657,12 @@ export interface BookingRange {
2638
2657
  end_time: string;
2639
2658
  }
2640
2659
  export type BookingWeekday = BookingRange["weekday"];
2660
+ /**
2661
+ * How a booking page meets its guests: in a Nemphi video call made for each
2662
+ * booking, by phone, at an address, or at another meeting link. Null is a
2663
+ * page's free-text place from before the kinds existed.
2664
+ */
2665
+ export type BookingLocationKind = "nemphi_call" | "phone" | "in_person" | "link";
2641
2666
  /** A published offer of somebody's hours, with the link that spends it. */
2642
2667
  export interface BookingType {
2643
2668
  id: string;
@@ -2656,6 +2681,7 @@ export interface BookingType {
2656
2681
  max_per_day: number | null;
2657
2682
  time_zone: string;
2658
2683
  location: string;
2684
+ location_kind: BookingLocationKind | null;
2659
2685
  status: "active" | "paused";
2660
2686
  publishes_to_calendar: boolean;
2661
2687
  ranges: BookingRange[];
@@ -2695,6 +2721,8 @@ export interface Booking {
2695
2721
  party_id: string | null;
2696
2722
  event_id: string | null;
2697
2723
  location: string;
2724
+ /** The guest link of the appointment's Nemphi call (`/call/{token}`); null without one or once cancelled. */
2725
+ call_url: string | null;
2698
2726
  cancelled_at: string | null;
2699
2727
  cancel_reason: string;
2700
2728
  created_at: string;
@@ -2707,6 +2735,7 @@ export interface PublicBookingType {
2707
2735
  duration_minutes: number;
2708
2736
  time_zone: string;
2709
2737
  location: string;
2738
+ location_kind: BookingLocationKind | null;
2710
2739
  status: "active" | "paused";
2711
2740
  host_name: string;
2712
2741
  workspace_name: string;
@@ -2729,6 +2758,8 @@ export interface PublicBookingConfirmation {
2729
2758
  guest_name: string | null;
2730
2759
  location: string | null;
2731
2760
  booking_type_name: string | null;
2761
+ /** The guest link of the appointment's Nemphi call (`/call/{token}`), when it has one. */
2762
+ call_url: string | null;
2732
2763
  };
2733
2764
  manage_token: string | null;
2734
2765
  }
@@ -2740,6 +2771,8 @@ export interface ManagedBooking {
2740
2771
  status: string;
2741
2772
  guest_name: string;
2742
2773
  notes: string;
2774
+ /** The guest link of the appointment's Nemphi call; null without one or once cancelled. */
2775
+ call_url: string | null;
2743
2776
  };
2744
2777
  booking_type: {
2745
2778
  slug: string;
@@ -2747,6 +2780,7 @@ export interface ManagedBooking {
2747
2780
  duration_minutes: number;
2748
2781
  time_zone: string;
2749
2782
  location: string;
2783
+ location_kind: BookingLocationKind | null;
2750
2784
  workspace_name: string;
2751
2785
  };
2752
2786
  }
@@ -2841,11 +2875,47 @@ export interface ThreadDelegateRow {
2841
2875
  goal: string;
2842
2876
  created_at: string;
2843
2877
  }
2878
+ /**
2879
+ * One state-changing call an agent made for a conversation, read from the
2880
+ * actions ledger (never from the agent's own words), filed under the
2881
+ * answer it led to.
2882
+ */
2883
+ export interface ThreadActionRow {
2884
+ id: string;
2885
+ run_id: string;
2886
+ /** The tool's dotted name. */
2887
+ tool: string;
2888
+ created_at: string;
2889
+ /** The agent message the call led to; "" while the run has not answered since. */
2890
+ message_id: string;
2891
+ /** What names the record it created or changed; "" when the answer names none. */
2892
+ label: string;
2893
+ /** Where that record opens in the app; "" when it has no page. */
2894
+ href: string;
2895
+ amount_cents: number | null;
2896
+ currency: string;
2897
+ }
2898
+ /** An approval someone decided for a conversation's runs. */
2899
+ export interface ThreadDecisionRow {
2900
+ approval_id: string;
2901
+ run_id: string;
2902
+ tool: string;
2903
+ decided: "approved" | "denied";
2904
+ /** Who decided, by name; "" when nobody the workspace knows did. */
2905
+ decided_by: string;
2906
+ decided_at: string;
2907
+ /** The arguments the person was asked to authorize. */
2908
+ arguments: Json;
2909
+ }
2844
2910
  /** Result of messages.activity: the thread's live runs plus the delegates below them. */
2845
2911
  export interface MessageThreadActivity {
2846
2912
  activity: ThreadActivityRow[];
2847
2913
  /** Newest 20, oldest first. */
2848
2914
  delegates: ThreadDelegateRow[];
2915
+ /** What the thread's recent runs changed, oldest first. */
2916
+ actions?: ThreadActionRow[];
2917
+ /** The approvals decided for the thread's recent runs, newest first. */
2918
+ decisions?: ThreadDecisionRow[];
2849
2919
  }
2850
2920
  /** What kind of capability a usage row describes. */
2851
2921
  export type FeatureKind = "tool" | "page" | "agent";
@@ -4123,6 +4193,8 @@ export interface NumberingRange {
4123
4193
  created_at: string;
4124
4194
  /** Which documents consume this range: invoice | credit_note | debit_note. */
4125
4195
  document_kind: DocumentKind;
4196
+ /** Whether posting may take numbers from it (a superseded resolution is not). */
4197
+ active: boolean;
4126
4198
  }
4127
4199
  export interface Invoice {
4128
4200
  id: string;
@@ -5318,6 +5390,12 @@ export interface PublicCallCenterQueue {
5318
5390
  name: string;
5319
5391
  purpose: CallCenterPurpose;
5320
5392
  workspace_name: string;
5393
+ /**
5394
+ * Whether someone would answer a call now: the queue's voice agent, or
5395
+ * one of its people set available. When nobody would, a call is recorded
5396
+ * as missed at once, with the caller's number for a call back.
5397
+ */
5398
+ available: boolean;
5321
5399
  }
5322
5400
  /** A visitor's web call. `key` comes back only when it rings; `join_token` once it is answered. */
5323
5401
  export interface PublicCallCenterCall {
@@ -5950,6 +6028,8 @@ export interface EmailCampaignRecipient {
5950
6028
  }
5951
6029
  export interface EmailCampaignDetail {
5952
6030
  campaign: EmailCampaign;
6031
+ /** How many addresses the audience reaches right now: what a send would go to. */
6032
+ estimated_recipients: number;
5953
6033
  /** Hourly buckets per event type (open, click, delivery, bounce, unsubscribe). */
5954
6034
  /** The visits this campaign's links brought to the workspace's own sites. */
5955
6035
  site_visits: AttributedSiteVisits;
@@ -6131,6 +6211,18 @@ export interface EmailMessage {
6131
6211
  tag_color?: string;
6132
6212
  /** Private automatic search category; independent of user-defined tags. */
6133
6213
  category?: EmailCategory;
6214
+ /**
6215
+ * The sender's domain when the message passed DMARC for it and the domain
6216
+ * publishes a BIMI logo: fetch the logo with `emailSenderLogos`. Absent
6217
+ * otherwise, and on mail synced before logos were kept.
6218
+ */
6219
+ sender_logo_domain?: string;
6220
+ }
6221
+ /** A sender domain's BIMI logo (email.sender_logos). */
6222
+ export interface EmailSenderLogo {
6223
+ domain: string;
6224
+ /** The logo as SVG markup; render it as an image (a data: URI), never inline in the page. */
6225
+ svg: string;
6134
6226
  }
6135
6227
  export type EmailCategory = "finance" | "sales" | "support" | "scheduling" | "updates" | "promotions" | "other";
6136
6228
  /** One of the member's mail tags (email.list_tags). */
@@ -6152,6 +6244,8 @@ export interface CRMPartyTag {
6152
6244
  description?: string;
6153
6245
  /** How many parties carry it. */
6154
6246
  parties?: number;
6247
+ /** How many of those parties have an email address (absent with no parties). */
6248
+ with_email?: number;
6155
6249
  }
6156
6250
  /** Approved WhatsApp message template on a connected WABA. */
6157
6251
  export interface WhatsAppMessageTemplate {
@@ -6226,6 +6320,11 @@ export interface AgendaQuery {
6226
6320
  * strict upcoming queue — highlights and the upcoming list do this.
6227
6321
  */
6228
6322
  overdue?: boolean;
6323
+ /**
6324
+ * IANA zone the days are read in (America/Bogota): an entry's `date`, the
6325
+ * window and today. The workspace's zone when omitted.
6326
+ */
6327
+ time_zone?: string;
6229
6328
  }
6230
6329
  /** One dated thing, whatever produced it. */
6231
6330
  export interface ConnectedCalendar {
@@ -6743,6 +6842,8 @@ export interface AgentSession {
6743
6842
  project_name: string | null;
6744
6843
  /** The custom app the session builds, by slug, when it is filed under one. */
6745
6844
  app_slug: string | null;
6845
+ /** What the session was started for: "app" while the App builder makes a new app. */
6846
+ purpose: "app" | null;
6746
6847
  created_by_type: string | null;
6747
6848
  created_by_id: string | null;
6748
6849
  run_count: number;
@@ -6759,6 +6860,8 @@ export interface AgentSessionRun {
6759
6860
  id: string;
6760
6861
  trigger: string;
6761
6862
  goal: string;
6863
+ /** What the run is about as a person reads it; `goal` is the brief the model reads. */
6864
+ title: string;
6762
6865
  status: Run["status"];
6763
6866
  result: string | null;
6764
6867
  error: string | null;
@@ -7721,10 +7824,11 @@ export interface NemphiClient {
7721
7824
  }): Promise<MarketingTopPosts>;
7722
7825
  emailMarketingStatus(): Promise<EmailMarketingStatus>;
7723
7826
  emailReputation(): Promise<EmailReputation>;
7724
- enableEmailMarketing(input?: {
7827
+ enableEmailMarketing(input: {
7725
7828
  from_name?: string;
7726
7829
  reply_to?: string;
7727
- physical_address?: string;
7830
+ /** The postal address every campaign footer shows; required (anti-spam law). */
7831
+ physical_address: string;
7728
7832
  }): Promise<{
7729
7833
  settings: EmailMarketingSettings;
7730
7834
  queued: boolean;
@@ -8270,6 +8374,8 @@ export interface NemphiClient {
8270
8374
  before_id?: string;
8271
8375
  limit?: number;
8272
8376
  }): Promise<EmailInbox>;
8377
+ /** The BIMI logos of the given sender domains (each a message's `sender_logo_domain`); domains without one are left out. */
8378
+ emailSenderLogos(domains: string[]): Promise<EmailSenderLogo[]>;
8273
8379
  /** The caller's mail tags with per-tag message counts. */
8274
8380
  listEmailTags(): Promise<EmailTag[]>;
8275
8381
  /**
@@ -9012,6 +9118,8 @@ export interface NemphiClient {
9012
9118
  listBills(input?: {
9013
9119
  status?: string;
9014
9120
  kind?: DocumentKind<"bill">;
9121
+ /** Only the bills filed from this source document. */
9122
+ document_id?: string;
9015
9123
  limit?: number;
9016
9124
  }): Promise<Bill[]>;
9017
9125
  getBill(billId: string): Promise<BillDetail>;
@@ -9316,6 +9424,8 @@ export interface NemphiClient {
9316
9424
  kind?: CalendarKind;
9317
9425
  include_cancelled?: boolean;
9318
9426
  limit?: number;
9427
+ /** IANA zone the days are read in; the workspace's zone when omitted. */
9428
+ time_zone?: string;
9319
9429
  }): Promise<CalendarEventList>;
9320
9430
  createCalendarEvent(input: CalendarEventInput & {
9321
9431
  title: string;
@@ -9679,6 +9789,7 @@ export interface NemphiClient {
9679
9789
  horizon_days?: number;
9680
9790
  max_per_day?: number;
9681
9791
  time_zone?: string;
9792
+ location_kind?: BookingLocationKind;
9682
9793
  location?: string;
9683
9794
  calendar_id?: string;
9684
9795
  }, opts?: InvokeOpts): Promise<{
@@ -9697,6 +9808,7 @@ export interface NemphiClient {
9697
9808
  horizon_days?: number;
9698
9809
  max_per_day?: number;
9699
9810
  time_zone?: string;
9811
+ location_kind?: BookingLocationKind;
9700
9812
  location?: string;
9701
9813
  calendar_id?: string;
9702
9814
  }, opts?: InvokeOpts): Promise<{
@@ -9781,10 +9893,13 @@ export interface NemphiClient {
9781
9893
  /** The queue behind a call-center web call link. Unauthenticated. */
9782
9894
  getPublicCallCenterQueue(key: string): Promise<PublicCallCenterQueue>;
9783
9895
  /** Rings the queue; keep the returned `key`, it is the caller's hold on the call. */
9784
- ringPublicCallCenter(key: string, input: {
9896
+ ringPublicCallCenter(key: string,
9897
+ /** `callback`: the caller asks to be called back; the call is recorded as missed without ringing. */
9898
+ input: {
9785
9899
  name: string;
9786
9900
  phone?: string;
9787
9901
  email?: string;
9902
+ callback?: boolean;
9788
9903
  }): Promise<PublicCallCenterCall>;
9789
9904
  /** Polls a web call; once answered it carries the room's `join_token`. */
9790
9905
  getPublicCallCenterCall(key: string, callId: string, callerKey: string): Promise<PublicCallCenterCall>;