@nemphi/sdk 0.8.6830 → 0.8.6854
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +48 -22
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -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;
|
|
@@ -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,8 +2246,10 @@ 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;
|
|
@@ -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;
|
|
@@ -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;
|
|
@@ -3819,7 +3827,8 @@ export interface EinvoiceDownload {
|
|
|
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;
|
|
@@ -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
|
/**
|
|
@@ -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). */
|
|
@@ -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. */
|
|
@@ -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;
|
|
@@ -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;
|
|
@@ -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`. */
|
|
@@ -6518,7 +6538,8 @@ export interface MarketingAccountsComparison extends MarketingWindow {
|
|
|
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
6544
|
points: {
|
|
6524
6545
|
date: string;
|
|
@@ -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. */
|
|
@@ -10855,7 +10880,8 @@ export interface CustomAppDiff {
|
|
|
10855
10880
|
to: number | null;
|
|
10856
10881
|
files: {
|
|
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
10886
|
}[];
|
|
10861
10887
|
grants_added: string[];
|