@signsealer/sdk 1.25.0 → 1.27.0

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.
@@ -4,7 +4,9 @@
4
4
  * Deliberately dependency-free: `fetch` is in the runtime, and a signing SDK
5
5
  * that drags a HTTP library into somebody's build is a signing SDK that gets
6
6
  * declined at review. It runs anywhere `fetch` does, which is every Node since
7
- * 18, every edge runtime and the browser — though a key belongs on a server.
7
+ * 18 and every edge runtime. It is the server's half: a client given a secret
8
+ * key in a web page throws (1.26.0), and the page's half, which holds no key,
9
+ * is `@signsealer/embed`.
8
10
  *
9
11
  * Three things it does that a hand-rolled client usually does not:
10
12
  *
@@ -131,7 +133,11 @@ export interface Account {
131
133
  available: boolean;
132
134
  why_not: "test" | "plan" | "number" | "beta" | null;
133
135
  wording: string;
134
- /** The business's own verified texting number (1.13.0), once it has one. */
136
+ /**
137
+ * The business's own verified texting number (1.13.0), once it has one.
138
+ * Null to an app the business connected, and to a tablet (1.26.0): only
139
+ * the business's own key, and a partner for a business it manages, see it.
140
+ */
135
141
  number?: string | null;
136
142
  /**
137
143
  * Where a text goes (1.24.0): `US` and `CA`, and `GB` while texting UK
@@ -171,10 +177,14 @@ export interface TextingApplication {
171
177
  /** `applied`, `submitted`, `in_review`, `needs_changes`, `verified`, `paused`, `failed`, and the steps of bringing a number. */
172
178
  status: string;
173
179
  kind: TextingNumberKind;
174
- /** The number, once it is the business's: verified or paused. */
180
+ /**
181
+ * The number, once it is the business's: verified or paused. On
182
+ * `account()`, null to an app the business connected and to a tablet
183
+ * (1.26.0), as `reason` is.
184
+ */
175
185
  phone: string | null;
176
186
  area_code: string | null;
177
- /** What the carriers asked to change, or why it is held up; null otherwise. */
187
+ /** What the carriers asked to change, or why it is held up; null otherwise, and null to a connected app (1.26.0). */
178
188
  reason: string | null;
179
189
  /** True for a number the business already had and is bringing. */
180
190
  brought: boolean;
@@ -220,6 +230,127 @@ export interface TextingNumberInvitation {
220
230
  fields: string[];
221
231
  expires_at: string;
222
232
  }
233
+ /**
234
+ * A business's brand, delivery and reminders (00792). `editable` is true only
235
+ * for a partner key acting for a business it manages.
236
+ */
237
+ export interface Settings {
238
+ editable: boolean;
239
+ branding: {
240
+ business_name: string;
241
+ brand_name: string | null;
242
+ /** Hex colours, `#` and six digits. */
243
+ primary_color: string | null;
244
+ accent_color: string | null;
245
+ /** The name the business's emails come from. */
246
+ sender_name: string | null;
247
+ /** Where a signer's reply goes. */
248
+ reply_to: string | null;
249
+ has_logo: boolean;
250
+ logo_url: string | null;
251
+ };
252
+ /** `signsealer`: we send the links; `mine`: your system does; `both`: see `GET /v1/settings`. */
253
+ delivery: {
254
+ who_sends: "signsealer" | "mine" | "both";
255
+ };
256
+ /** Days before an unsigned link is reminded (0 is never), and how long a link lives. */
257
+ reminders: {
258
+ remind_after_days: number;
259
+ link_days: number;
260
+ };
261
+ /** 1.27.0: the language the business writes its templates in and offers its signers first. */
262
+ language?: {
263
+ default_language: string;
264
+ };
265
+ }
266
+ /** What `updateSettings` changes: only what is named; null clears it (00792). */
267
+ export interface SettingsChanges {
268
+ brand_name?: string | null;
269
+ primary_color?: string | null;
270
+ accent_color?: string | null;
271
+ sender_name?: string | null;
272
+ reply_to?: string | null;
273
+ /** A PNG, base64, a megabyte at most; null takes the logo away. */
274
+ logo_png_base64?: string | null;
275
+ who_sends?: "signsealer" | "mine" | "both";
276
+ remind_after_days?: number | null;
277
+ link_days?: number | null;
278
+ }
279
+ /** A managed business's texting-number application, filed by its partner (00792). */
280
+ export interface TextingNumberApplication {
281
+ /** A sole proprietor applies themselves: the registry texts them a code. */
282
+ kind: "toll_free" | "local";
283
+ legal_name: string;
284
+ entity_type: "PRIVATE_PROFIT" | "PUBLIC_PROFIT" | "NON_PROFIT" | "GOVERNMENT";
285
+ ein: string;
286
+ website: string;
287
+ address_line1: string;
288
+ address_line2?: string;
289
+ city: string;
290
+ state: string;
291
+ postal_code: string;
292
+ contact_first_name: string;
293
+ contact_last_name: string;
294
+ contact_email: string;
295
+ contact_phone: string;
296
+ volume: "10" | "100" | "1,000" | "10,000" | "100,000";
297
+ /** For a local number. */
298
+ area_code?: string;
299
+ vertical?: string;
300
+ privacy_url?: string;
301
+ terms_url?: string;
302
+ opt_in_url?: string;
303
+ own_opt_in?: string;
304
+ /** Your statement, for the business, that it is all true and it texts only people who asked. */
305
+ attest: true;
306
+ }
307
+ /** The business's own texting number, where its application has got to, and the carriers' wording (00792). */
308
+ export interface TextingNumberState {
309
+ /**
310
+ * False for a key the application is not its to read (an app the business
311
+ * connected): `number` then has its status, `application` empty, `reason`
312
+ * null, and `events` empty.
313
+ */
314
+ detail: boolean;
315
+ /** True for a live partner key acting for a business it manages. */
316
+ may_apply: boolean;
317
+ /** `own_account`: the business applies in its own dashboard; `sandbox`: it never texts anybody. */
318
+ why_not: "own_account" | "sandbox" | null;
319
+ member: boolean;
320
+ ready: boolean;
321
+ kinds: Array<{
322
+ kind: TextingNumberKind;
323
+ name: string;
324
+ monthly_cents: number;
325
+ setup_cents: number;
326
+ needs_cents: number;
327
+ by_partner: boolean;
328
+ }>;
329
+ number: null | {
330
+ status: string;
331
+ kind: TextingNumberKind | null;
332
+ area_code: string | null;
333
+ phone: string | null;
334
+ reason: string | null;
335
+ applied_at: string;
336
+ submitted_at: string | null;
337
+ verified_at: string | null;
338
+ setup_cents: number;
339
+ filed: boolean;
340
+ application: Record<string, string | null>;
341
+ };
342
+ events: Array<{
343
+ at: string;
344
+ status: string;
345
+ note: string | null;
346
+ }>;
347
+ /** Word for word: the consent a signer ticks, the texts they get, the answer to HELP. */
348
+ wording: {
349
+ consent: string;
350
+ samples: string[];
351
+ help: string;
352
+ };
353
+ }
223
354
  /** What `recordSmsConsent` wrote, with the number as we normalised it. */
224
355
  export interface SmsConsentRecorded {
225
356
  /** E.164. One number written three ways is one record, and this is it. */
@@ -255,6 +386,64 @@ export interface Template {
255
386
  remind_days?: number | null;
256
387
  /** Signatures on versions older than this are not current: the terms changed (00406). */
257
388
  resign_from_version?: number | null;
389
+ /** 1.27.0: the language this version is written in. */
390
+ language?: string;
391
+ }
392
+ /** A question's words in a translation (1.27.0), by its key; the choices in the original's order. */
393
+ export interface TranslatedField {
394
+ label?: string;
395
+ hint?: string;
396
+ options?: string[];
397
+ block_label?: string;
398
+ block_intro?: string;
399
+ }
400
+ /** A business's own official translation of a template version, whole (1.27.0). */
401
+ export interface TemplateTranslation {
402
+ id: string;
403
+ template_id: string;
404
+ language: string;
405
+ kind: "official";
406
+ title: string;
407
+ body: string;
408
+ body_format: "text" | "markdown";
409
+ fields: Record<string, TranslatedField>;
410
+ /** The template's own consent line, in the language; null when the template has none. */
411
+ consent_text: string | null;
412
+ body_sha256: string;
413
+ ready_at: string;
414
+ }
415
+ /** What `templateTranslations` answers (1.27.0). */
416
+ export interface TemplateTranslations {
417
+ template_id: string;
418
+ code: string;
419
+ version: number;
420
+ is_published: boolean;
421
+ /** The language the version is written in. */
422
+ language: string;
423
+ has_pdf: boolean;
424
+ /** Every version's translations in use; `this_version` false for one a revision left behind. */
425
+ translations: Array<{
426
+ id: string;
427
+ template_id: string;
428
+ version: number;
429
+ this_version: boolean;
430
+ language: string;
431
+ language_name: string;
432
+ language_english: string;
433
+ kind: "official";
434
+ title: string;
435
+ body_sha256: string;
436
+ ready_at: string;
437
+ made_by: string | null;
438
+ /** Still has exactly this version's blanks and questions. */
439
+ fits: boolean;
440
+ }>;
441
+ /** The languages one may be written in. */
442
+ languages: Array<{
443
+ code: string;
444
+ name_english: string;
445
+ name_own: string;
446
+ }>;
258
447
  }
259
448
  /**
260
449
  * One template version, whole (1.6.0): its text, what it asks, the settings
@@ -456,6 +645,8 @@ export interface TemplateInput {
456
645
  code: string;
457
646
  name: string;
458
647
  kind: "nda" | "waiver" | "contract" | "consent" | "policy" | "other";
648
+ /** 1.27.0: the language it is written in; the business's default when left out. */
649
+ language?: string;
459
650
  /** The words people will sign. `{{variable}}` is substituted at prepare time. */
460
651
  body: string;
461
652
  variables?: string[];
@@ -463,6 +654,11 @@ export interface TemplateInput {
463
654
  consent_text?: string | null;
464
655
  /** Up to 50. Set here rather than in a second call — see `createTemplate`. */
465
656
  fields?: Ask[];
657
+ /**
658
+ * `markdown` to write it with the dashboard's formatting (headings, bold,
659
+ * italic, lists) from the first version; `text`, the default, otherwise.
660
+ */
661
+ body_format?: "text" | "markdown";
466
662
  }
467
663
  /**
468
664
  * The brand an account shows its signers (00220). SignSealer's own without
@@ -584,6 +780,52 @@ export interface TemplatePdf {
584
780
  original_name?: string | null;
585
781
  uploaded_at?: string;
586
782
  }
783
+ /** A page of a PDF template (1.26.0): its size in points as a reader sees it, and where its picture is. */
784
+ export interface TemplatePage {
785
+ n: number;
786
+ width: number;
787
+ height: number;
788
+ rotation?: number;
789
+ /** The API path of its picture (`templatePage`), with the same key; null until SignSealer has drawn it. */
790
+ image_url: string | null;
791
+ }
792
+ /** What `templateFields` and `setTemplateFields` answer (1.26.0). */
793
+ export interface TemplateFields {
794
+ template_id: string;
795
+ code: string;
796
+ version: number;
797
+ is_published: boolean;
798
+ has_pdf: boolean;
799
+ /** Null for a written template, which has no pages. */
800
+ page_count: number | null;
801
+ pages: TemplatePage[];
802
+ /** Each question, a box on the page with its `place`. */
803
+ fields: Ask[];
804
+ /** Names this list: give it to `setTemplateFields` to have a save made from an older list refused (409 `stale`). */
805
+ fields_version: string;
806
+ }
807
+ /** What `createPdfTemplate` answers (1.26.0): the draft, as `template` answers it, and what was found in the file. */
808
+ export interface PdfTemplate extends TemplateDetail {
809
+ pdf: {
810
+ page_count: number;
811
+ /** Hex. The fingerprint the body names and the certificate commits to. */
812
+ sha256: string;
813
+ pages: TemplatePage[];
814
+ /** How many boxes of each kind were put where the file asks for them; `more_to_sign`, the pages of any further place to sign, left for you. */
815
+ found: {
816
+ signature: number;
817
+ date: number;
818
+ initials: number;
819
+ questions: number;
820
+ business: number;
821
+ more_to_sign: number[];
822
+ };
823
+ /** A scan: `all` pages are pictures, or these pages are. Read only where the business switched on Read scanned PDFs. */
824
+ scan: "all" | number[] | null;
825
+ /** What was taken out of the file because it could act on its own. */
826
+ removed: string[];
827
+ };
828
+ }
587
829
  /**
588
830
  * What a reader will be told about the signer of a sealed PDF.
589
831
  *
@@ -613,7 +855,8 @@ export interface SignerLink {
613
855
  * The signing token. Returned once, and never again — only its hash is kept.
614
856
  * Null for a signer held for their turn on a document signed in order
615
857
  * (00609): their link is made and sent to them when the step before them is
616
- * signed.
858
+ * signed. Null too, with `redacted`, on the answer to a retry with the same
859
+ * idempotency key (1.26.0).
617
860
  */
618
861
  token: string | null;
619
862
  /** The page to send them to, built from the token (1.6.0); null when `token` is. */
@@ -626,6 +869,12 @@ export interface SignerLink {
626
869
  for_business?: boolean;
627
870
  /** Signed only by an approval from the application it was bound to (1.18.0, 00684); it has no link. */
628
871
  application_bound?: true;
872
+ /**
873
+ * The answer to a retry with the same idempotency key (1.26.0): the link was
874
+ * in the first answer only, so `token` and `url` are null here. Mint a fresh
875
+ * one with `embedLink`, or send one with `remind`.
876
+ */
877
+ redacted?: true;
629
878
  }
630
879
  /** Who has signed one document (00340): names and states, nothing else. */
631
880
  export interface DocumentSigners {
@@ -693,6 +942,8 @@ export interface StartedWorkflow {
693
942
  signers: SignerLink[];
694
943
  /** 00541: the roles whose `show_if` these answers did not meet, by label; absent when every role signs. */
695
944
  not_needed?: string[];
945
+ /** A retry's answer whose tokens were taken out (1.26.0): see `SignerLink.redacted`. */
946
+ links_redacted?: true;
696
947
  }
697
948
  export interface PacketSummary {
698
949
  packet_id: string;
@@ -915,7 +1166,9 @@ export interface ClientOptions {
915
1166
  userAgent?: string;
916
1167
  }
917
1168
  /** This package's version, as `package.json` has it; `tests/sdk.ts` holds the two together. */
918
- export declare const SDK_VERSION = "1.25.0";
1169
+ export declare const SDK_VERSION = "1.27.0";
1170
+ /** What a client built with a secret key in a web page throws (1.26.0). */
1171
+ export declare const KEY_IN_PAGE_MESSAGE: string;
919
1172
  export declare class SignSealer {
920
1173
  #private;
921
1174
  /**
@@ -937,6 +1190,30 @@ export declare class SignSealer {
937
1190
  * moment somebody is deciding whether to trust the page.
938
1191
  */
939
1192
  branding(): Promise<Branding>;
1193
+ /**
1194
+ * The business's brand, how its signing links go, and its reminders
1195
+ * (00792). `editable` says whether this key may change them: true only for
1196
+ * a partner acting for a business it manages.
1197
+ */
1198
+ settings(): Promise<Settings>;
1199
+ /**
1200
+ * Set a managed business's brand, delivery and reminders, as its partner
1201
+ * (00792; with `partner.business(id)`). Only what is named changes; null
1202
+ * clears it. Any other key is refused with 403: a business that owns its
1203
+ * account sets these in its dashboard. A PATCH of the same values, so a
1204
+ * retry after a lost answer sets the same thing again.
1205
+ */
1206
+ updateSettings(changes: SettingsChanges): Promise<Settings>;
1207
+ /**
1208
+ * Apply for a managed business's texting number, as its partner (00792;
1209
+ * with `partner.business(id)`), for a toll-free or a local number. Checked
1210
+ * as the carriers would check it; a local number's setup is drawn from
1211
+ * your balance now. Sent once, never retried: a second answer would file
1212
+ * the application again.
1213
+ */
1214
+ applyForTextingNumber(application: TextingNumberApplication): Promise<TextingNumberState>;
1215
+ /** The business's own texting number, its application's steps, and the carriers' wording (00792). */
1216
+ textingNumber(): Promise<TextingNumberState>;
940
1217
  /** Prove the key works, and say whose account it is. */
941
1218
  account(): Promise<Account>;
942
1219
  /** Every version of every template, newest first; `code` narrows it to one template's versions. No text: `template(id)` has that. */
@@ -958,6 +1235,8 @@ export declare class SignSealer {
958
1235
  fields?: Ask[];
959
1236
  /** What changed in this draft (1.7.0); null clears it. */
960
1237
  change_note?: string | null;
1238
+ /** 1.27.0: the language the draft is written in. */
1239
+ language?: string;
961
1240
  }): Promise<TemplateDetail>;
962
1241
  /**
963
1242
  * Publish a draft (1.6.0): from now on documents made from its code use
@@ -965,7 +1244,13 @@ export declare class SignSealer {
965
1244
  * is wrong, for a placeholder the template does not declare or a PDF with
966
1245
  * pages nobody has drawn.
967
1246
  */
968
- publishTemplate(id: string, idempotencyKey?: string): Promise<TemplateDetail>;
1247
+ publishTemplate(id: string, idempotencyKey?: string): Promise<TemplateDetail & {
1248
+ /** 1.26.0: what was published but cannot be signed where it is: `nothing_placed`, a PDF with no box on its pages. */
1249
+ warnings?: Array<{
1250
+ code: string;
1251
+ message: string;
1252
+ }>;
1253
+ }>;
969
1254
  /**
970
1255
  * The next version of a published template, as a draft (1.6.0): the
971
1256
  * newest version copied, with whatever you change. `id` must be the
@@ -996,6 +1281,35 @@ export declare class SignSealer {
996
1281
  version: number;
997
1282
  discarded: true;
998
1283
  }>;
1284
+ /**
1285
+ * The language a template version is written in, and the business's own
1286
+ * official translations of every version of its code (1.27.0). A signer
1287
+ * who reads a translation's language reads it in place of the original and
1288
+ * signs it; a revision leaves translations behind until copied forward.
1289
+ */
1290
+ templateTranslations(id: string): Promise<TemplateTranslations>;
1291
+ /** One official translation of this version, whole (1.27.0). */
1292
+ templateTranslation(id: string, language: string): Promise<TemplateTranslation>;
1293
+ /**
1294
+ * Save the business's own official translation of this version (1.27.0),
1295
+ * replacing the one there was. Refused with 422, saying why, unless only
1296
+ * the words differ: exactly the original's blanks, the same paragraphs that
1297
+ * depend on an answer, every question's words (and its line, choices and
1298
+ * group, where the original has them), and the template's own consent line
1299
+ * where it has one. Not for an uploaded PDF.
1300
+ */
1301
+ setTemplateTranslation(id: string, language: string, input: {
1302
+ title: string;
1303
+ body: string;
1304
+ fields?: Record<string, TranslatedField>;
1305
+ consent_text?: string | null;
1306
+ }): Promise<TemplateTranslation>;
1307
+ /** Withdraw this version's translation in a language (1.27.0): signers who have not read it read the original. */
1308
+ withdrawTemplateTranslation(id: string, language: string): Promise<{
1309
+ template_id: string;
1310
+ language: string;
1311
+ withdrawn: boolean;
1312
+ }>;
999
1313
  /**
1000
1314
  * The settings a template's code carries to every version (1.6.0).
1001
1315
  * `resign: true` asks everybody who signed an older version to sign the
@@ -1030,10 +1344,56 @@ export declare class SignSealer {
1030
1344
  *
1031
1345
  * `ready` is the one to check: a PDF template cannot be published until
1032
1346
  * SignSealer has drawn a picture of every page from the file itself
1033
- * (00474), which it does as the file is uploaded. Uploading the file is a
1034
- * dashboard step, where the boxes are placed; there is no API route for it.
1347
+ * (00474), which it does as the file is uploaded, in the dashboard or with
1348
+ * `createPdfTemplate`.
1035
1349
  */
1036
1350
  templatePdf(id: string): Promise<TemplatePdf>;
1351
+ /**
1352
+ * A PDF template, as a draft, from the file (1.26.0): what the dashboard's
1353
+ * upload makes. The file is read, sanitised and drawn exactly as an upload
1354
+ * is -- up to 12 MB and 60 pages, refused in the dashboard's words past
1355
+ * either, or when it is not a PDF or is password-protected -- and the
1356
+ * signature and date every PDF starts with are put where the file asks for
1357
+ * them, with initials, a printed name and a fillable form's questions each
1358
+ * on its box. Check them with `templateFields`, move them with
1359
+ * `setTemplateFields`, then `publishTemplate`. `pdf` is the file's bytes
1360
+ * or its base64. Needs `signing:templates`.
1361
+ */
1362
+ createPdfTemplate(input: {
1363
+ name: string;
1364
+ pdf: Uint8Array | string;
1365
+ filename: string;
1366
+ kind?: "nda" | "waiver" | "contract" | "consent" | "policy" | "other";
1367
+ code?: string;
1368
+ }, idempotencyKey?: string): Promise<PdfTemplate>;
1369
+ /**
1370
+ * The questions and boxes a template asks for (1.26.0), with a PDF's pages
1371
+ * and the address of each page's picture, for a screen to draw them on.
1372
+ */
1373
+ templateFields(id: string): Promise<TemplateFields>;
1374
+ /**
1375
+ * Replace a draft's questions and boxes (1.26.0): the whole list, as the
1376
+ * dashboard's Place step saves it. A box's `place` is its page and
1377
+ * fractions of the page from its top-left. Refused, naming the question,
1378
+ * for a page the file does not have, a box off its page, a kind that is
1379
+ * not one, and a published version (revise it first).
1380
+ *
1381
+ * `fieldsVersion`, optional, is the `fields_version` of the list these
1382
+ * replace, as `templateFields` answered it: given, a save made after the
1383
+ * list changed (a box SignSealer placed on a scan, another person's save)
1384
+ * is refused with 409 `stale` rather than undoing it.
1385
+ */
1386
+ setTemplateFields(id: string, fields: Ask[], opts?: {
1387
+ fieldsVersion?: string;
1388
+ }): Promise<TemplateFields>;
1389
+ /** One page of a PDF template as PNG bytes (1.26.0), the picture a signer is shown. 404 until it is drawn. */
1390
+ templatePage(id: string, page: number): Promise<{
1391
+ page: number;
1392
+ width: number;
1393
+ height: number;
1394
+ contentType: string;
1395
+ bytes: Uint8Array<ArrayBufferLike>;
1396
+ }>;
1037
1397
  /**
1038
1398
  * Record that you have consent to text a number.
1039
1399
  *
@@ -1238,6 +1598,11 @@ export declare class SignSealer {
1238
1598
  /**
1239
1599
  * Send, and take the links back once.
1240
1600
  *
1601
+ * Once means once: a retry with the same idempotency key (the client's own,
1602
+ * after a dropped connection, or yours) sends nothing again and answers with
1603
+ * every link's `token` and `url` null, `redacted: true` on each and
1604
+ * `links_redacted: true` on the answer. Mint a fresh link with `embedLink`.
1605
+ *
1241
1606
  * Each signer needs an `email`, a `phone`, or both; a `cc` may have neither.
1242
1607
  * Given both, the same link goes out twice — by mail and by text — because a
1243
1608
  * person who does not check one inbox checks the other. The text goes only
@@ -1273,6 +1638,7 @@ export declare class SignSealer {
1273
1638
  };
1274
1639
  }>, idempotencyKey?: string): Promise<{
1275
1640
  links: SignerLink[];
1641
+ links_redacted?: true;
1276
1642
  }>;
1277
1643
  void(documentId: string, reason: string, idempotencyKey?: string): Promise<{
1278
1644
  voided: true;
@@ -1414,14 +1780,18 @@ export declare class SignSealer {
1414
1780
  events?: string[];
1415
1781
  label?: string;
1416
1782
  }): Promise<EnsuredWebhook>;
1783
+ /**
1784
+ * Add an endpoint. Its signing `secret` is in the first answer only: a
1785
+ * retry with the same idempotency key -- the client's own, after a
1786
+ * connection dropped, or yours -- adds nothing and answers with the same
1787
+ * `id`, `secret` null and `secrets_redacted: true` (1.26.0). Keep the
1788
+ * secret from the first answer; if it was lost, `rotateWebhookSecret`.
1789
+ */
1417
1790
  addWebhook(input: {
1418
1791
  url: string;
1419
1792
  events?: string[];
1420
1793
  label?: string;
1421
- }, idempotencyKey?: string): Promise<{
1422
- id: string;
1423
- secret: string;
1424
- }>;
1794
+ }, idempotencyKey?: string): Promise<AddedWebhook>;
1425
1795
  /**
1426
1796
  * Change an endpoint. Turning one back on forgives its failures and sends
1427
1797
  * what it held: `resumed` says it was paused, `waiting` how many are now
@@ -2677,7 +3047,9 @@ export declare class SignSealerPartner {
2677
3047
  /**
2678
3048
  * 00763: a start link to one of your businesses' screens inside your product,
2679
3049
  * for one of your users. It opens once, within five minutes: ask for it as
2680
- * the page that frames it loads. Sent once.
3050
+ * the page that frames it loads. Sent once. `components` are the screens:
3051
+ * `documents` (the default), `send` (00789), `templates` (00791), and
3052
+ * `settings` and `texting` (00792). Mount it with `@signsealer/embed`.
2681
3053
  */
2682
3054
  embedSession(id: string, session: {
2683
3055
  user: {
@@ -2686,7 +3058,7 @@ export declare class SignSealerPartner {
2686
3058
  email?: string;
2687
3059
  role?: "admin" | "member";
2688
3060
  };
2689
- components?: Array<"documents">;
3061
+ components?: Array<"documents" | "send" | "templates" | "settings" | "texting">;
2690
3062
  }): Promise<PartnerEmbedSession>;
2691
3063
  /** 00759: a calendar month (YYYY-MM, this one when left out) per business, in your prices, with what to bill. */
2692
3064
  usage(month?: string): Promise<PartnerUsage>;
@@ -3159,6 +3531,15 @@ export interface DocumentFromPdf {
3159
3531
  /** What was taken out of the file because it could act on its own. */
3160
3532
  removed: string[];
3161
3533
  }
3534
+ /** What `addWebhook` answers. */
3535
+ export interface AddedWebhook {
3536
+ id: string;
3537
+ /** Keep it, it is not shown again: null on a retry with the same idempotency key (1.26.0). */
3538
+ secret: string | null;
3539
+ /** On such a retry: the secret was taken out of the copy the API kept (1.26.0). */
3540
+ redacted?: true;
3541
+ secrets_redacted?: true;
3542
+ }
3162
3543
  export interface EnsuredWebhook {
3163
3544
  id: string;
3164
3545
  created: boolean;