@subnoto/api-client 2.6.4 → 2.7.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.
|
Binary file
|
package/package.json
CHANGED
|
@@ -3608,7 +3608,7 @@ export interface paths {
|
|
|
3608
3608
|
* @description The status of the envelope.
|
|
3609
3609
|
* @enum {string}
|
|
3610
3610
|
*/
|
|
3611
|
-
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled";
|
|
3611
|
+
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled" | "expired";
|
|
3612
3612
|
/** @description The date and time the envelope was created (unix timestamp). */
|
|
3613
3613
|
creationDate: number;
|
|
3614
3614
|
/** @description The date and time the envelope was last updated (unix timestamp). */
|
|
@@ -4122,7 +4122,7 @@ export interface paths {
|
|
|
4122
4122
|
* @description The status of the envelope.
|
|
4123
4123
|
* @enum {string}
|
|
4124
4124
|
*/
|
|
4125
|
-
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled";
|
|
4125
|
+
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled" | "expired";
|
|
4126
4126
|
/** @description The UUID of the workspace the envelope belongs to. */
|
|
4127
4127
|
workspaceUuid: string;
|
|
4128
4128
|
/** @description The creator of the envelope. */
|
|
@@ -4455,6 +4455,237 @@ export interface paths {
|
|
|
4455
4455
|
patch?: never;
|
|
4456
4456
|
trace?: never;
|
|
4457
4457
|
};
|
|
4458
|
+
"/public/logs/list": {
|
|
4459
|
+
parameters: {
|
|
4460
|
+
query?: never;
|
|
4461
|
+
header?: never;
|
|
4462
|
+
path?: never;
|
|
4463
|
+
cookie?: never;
|
|
4464
|
+
};
|
|
4465
|
+
get?: never;
|
|
4466
|
+
put?: never;
|
|
4467
|
+
/**
|
|
4468
|
+
* list
|
|
4469
|
+
* @description List logs by category with filters, pagination and sorting.
|
|
4470
|
+
*/
|
|
4471
|
+
post: {
|
|
4472
|
+
parameters: {
|
|
4473
|
+
query?: never;
|
|
4474
|
+
header?: never;
|
|
4475
|
+
path?: never;
|
|
4476
|
+
cookie?: never;
|
|
4477
|
+
};
|
|
4478
|
+
requestBody: {
|
|
4479
|
+
content: {
|
|
4480
|
+
"application/json": {
|
|
4481
|
+
/**
|
|
4482
|
+
* @description The log category to list.
|
|
4483
|
+
* @enum {string}
|
|
4484
|
+
*/
|
|
4485
|
+
category: "envelope" | "team" | "user";
|
|
4486
|
+
/** @description Filter by workspace UUID (envelope category only). */
|
|
4487
|
+
workspaceUuid?: string;
|
|
4488
|
+
/** @description Filter by envelope UUID (envelope category only). */
|
|
4489
|
+
envelopeUuid?: string;
|
|
4490
|
+
/** @description Filter by event types. For envelope category use envelope event types; for team category use team event types. When empty or omitted, all event types are returned. */
|
|
4491
|
+
eventTypes?: (("ENVELOPE_CREATED" | "ENVELOPE_SENT" | "DOCUMENT_SIGNED" | "ENVELOPE_COMPLETED" | "ENVELOPE_OPENED" | "ENVELOPE_DECLINED" | "ENVELOPE_CANCELED" | "RECIPIENT_VERIFIED") | ("TEAM_CREATED" | "TEAM_CONFIG_UPDATED" | "MEMBER_INVITED" | "INVITE_REVOKED" | "MEMBER_JOINED" | "MEMBER_REMOVED" | "MEMBER_ROLE_UPDATED" | "API_KEY_CREATED" | "API_KEY_UPDATED" | "API_KEY_INVALIDATED" | "WEBHOOK_CREATED" | "WEBHOOK_UPDATED" | "WEBHOOK_DELETED" | "SSO_CONFIG_CREATED" | "SSO_CONFIG_UPDATED" | "SSO_CONFIG_DELETED"))[];
|
|
4492
|
+
/**
|
|
4493
|
+
* @description The page number (1-indexed). Defaults to 1.
|
|
4494
|
+
* @default 1
|
|
4495
|
+
*/
|
|
4496
|
+
page?: number;
|
|
4497
|
+
/**
|
|
4498
|
+
* @description The number of results per page. Defaults to 50, maximum is 50.
|
|
4499
|
+
* @default 50
|
|
4500
|
+
*/
|
|
4501
|
+
limit?: number;
|
|
4502
|
+
/**
|
|
4503
|
+
* @description The field to sort by. Defaults to 'timestamp'.
|
|
4504
|
+
* @default timestamp
|
|
4505
|
+
* @enum {string}
|
|
4506
|
+
*/
|
|
4507
|
+
sortBy?: "timestamp" | "id";
|
|
4508
|
+
/**
|
|
4509
|
+
* @description The sort order. Defaults to 'desc'.
|
|
4510
|
+
* @default desc
|
|
4511
|
+
* @enum {string}
|
|
4512
|
+
*/
|
|
4513
|
+
sortOrder?: "asc" | "desc";
|
|
4514
|
+
};
|
|
4515
|
+
};
|
|
4516
|
+
};
|
|
4517
|
+
responses: {
|
|
4518
|
+
/** @description Default Response */
|
|
4519
|
+
200: {
|
|
4520
|
+
headers: {
|
|
4521
|
+
[name: string]: unknown;
|
|
4522
|
+
};
|
|
4523
|
+
content: {
|
|
4524
|
+
"application/json": {
|
|
4525
|
+
logs: {
|
|
4526
|
+
/**
|
|
4527
|
+
* @description The log category.
|
|
4528
|
+
* @enum {string}
|
|
4529
|
+
*/
|
|
4530
|
+
category: "envelope" | "team" | "user";
|
|
4531
|
+
/** @description The type of event. */
|
|
4532
|
+
eventType: string;
|
|
4533
|
+
/** @description Event-specific data. */
|
|
4534
|
+
eventData: {
|
|
4535
|
+
[key: string]: unknown;
|
|
4536
|
+
};
|
|
4537
|
+
/** @description The timestamp of when this event occurred (unix timestamp). */
|
|
4538
|
+
timestamp: number;
|
|
4539
|
+
author: {
|
|
4540
|
+
/** @description The author ID (0 for System user). */
|
|
4541
|
+
id: number;
|
|
4542
|
+
/** @description The author email address. */
|
|
4543
|
+
email: string;
|
|
4544
|
+
/** @description The author display name. */
|
|
4545
|
+
name: string;
|
|
4546
|
+
};
|
|
4547
|
+
/** @description The envelope UUID (envelope category only). */
|
|
4548
|
+
envelopeUuid?: string;
|
|
4549
|
+
/** @description The workspace UUID (envelope category only). */
|
|
4550
|
+
workspaceUuid?: string;
|
|
4551
|
+
}[];
|
|
4552
|
+
/** @description The total number of logs matching the filters. */
|
|
4553
|
+
totalCount: number;
|
|
4554
|
+
};
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
/** @description Default Response */
|
|
4558
|
+
400: {
|
|
4559
|
+
headers: {
|
|
4560
|
+
[name: string]: unknown;
|
|
4561
|
+
};
|
|
4562
|
+
content: {
|
|
4563
|
+
"application/json": {
|
|
4564
|
+
/** @description HTTP status code */
|
|
4565
|
+
statusCode: number;
|
|
4566
|
+
error: {
|
|
4567
|
+
/**
|
|
4568
|
+
* @description The error code
|
|
4569
|
+
* @enum {string}
|
|
4570
|
+
*/
|
|
4571
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "LOG_CATEGORY_NOT_IMPLEMENTED" | "INVALID_REQUEST_FORMAT";
|
|
4572
|
+
/** @description The error message */
|
|
4573
|
+
message: string;
|
|
4574
|
+
/** @description A suggestion to resolve the error */
|
|
4575
|
+
suggestion: string;
|
|
4576
|
+
/** @description A URL to the documentation */
|
|
4577
|
+
documentationUrl: string;
|
|
4578
|
+
};
|
|
4579
|
+
/** @description The unique identifier of the request */
|
|
4580
|
+
requestId: string;
|
|
4581
|
+
/** @description The timestamp of the response */
|
|
4582
|
+
timestamp: string;
|
|
4583
|
+
/** @description The path of the request */
|
|
4584
|
+
path: string;
|
|
4585
|
+
};
|
|
4586
|
+
};
|
|
4587
|
+
};
|
|
4588
|
+
/** @description Default Response */
|
|
4589
|
+
401: {
|
|
4590
|
+
headers: {
|
|
4591
|
+
[name: string]: unknown;
|
|
4592
|
+
};
|
|
4593
|
+
content: {
|
|
4594
|
+
"application/json": {
|
|
4595
|
+
/** @description HTTP status code */
|
|
4596
|
+
statusCode: number;
|
|
4597
|
+
error: {
|
|
4598
|
+
/**
|
|
4599
|
+
* @description The error code
|
|
4600
|
+
* @enum {string}
|
|
4601
|
+
*/
|
|
4602
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4603
|
+
/** @description The error message */
|
|
4604
|
+
message: string;
|
|
4605
|
+
/** @description A suggestion to resolve the error */
|
|
4606
|
+
suggestion: string;
|
|
4607
|
+
/** @description A URL to the documentation */
|
|
4608
|
+
documentationUrl: string;
|
|
4609
|
+
};
|
|
4610
|
+
/** @description The unique identifier of the request */
|
|
4611
|
+
requestId: string;
|
|
4612
|
+
/** @description The timestamp of the response */
|
|
4613
|
+
timestamp: string;
|
|
4614
|
+
/** @description The path of the request */
|
|
4615
|
+
path: string;
|
|
4616
|
+
};
|
|
4617
|
+
};
|
|
4618
|
+
};
|
|
4619
|
+
/** @description Default Response */
|
|
4620
|
+
403: {
|
|
4621
|
+
headers: {
|
|
4622
|
+
[name: string]: unknown;
|
|
4623
|
+
};
|
|
4624
|
+
content: {
|
|
4625
|
+
"application/json": {
|
|
4626
|
+
/** @description HTTP status code */
|
|
4627
|
+
statusCode: number;
|
|
4628
|
+
error: {
|
|
4629
|
+
/**
|
|
4630
|
+
* @description The error code
|
|
4631
|
+
* @enum {string}
|
|
4632
|
+
*/
|
|
4633
|
+
code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
|
|
4634
|
+
/** @description The error message */
|
|
4635
|
+
message: string;
|
|
4636
|
+
/** @description A suggestion to resolve the error */
|
|
4637
|
+
suggestion: string;
|
|
4638
|
+
/** @description A URL to the documentation */
|
|
4639
|
+
documentationUrl: string;
|
|
4640
|
+
};
|
|
4641
|
+
/** @description The unique identifier of the request */
|
|
4642
|
+
requestId: string;
|
|
4643
|
+
/** @description The timestamp of the response */
|
|
4644
|
+
timestamp: string;
|
|
4645
|
+
/** @description The path of the request */
|
|
4646
|
+
path: string;
|
|
4647
|
+
};
|
|
4648
|
+
};
|
|
4649
|
+
};
|
|
4650
|
+
/** @description Default Response */
|
|
4651
|
+
500: {
|
|
4652
|
+
headers: {
|
|
4653
|
+
[name: string]: unknown;
|
|
4654
|
+
};
|
|
4655
|
+
content: {
|
|
4656
|
+
"application/json": {
|
|
4657
|
+
/** @description HTTP status code */
|
|
4658
|
+
statusCode: number;
|
|
4659
|
+
error: {
|
|
4660
|
+
/**
|
|
4661
|
+
* @description The error code
|
|
4662
|
+
* @enum {string}
|
|
4663
|
+
*/
|
|
4664
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4665
|
+
/** @description The error message */
|
|
4666
|
+
message: string;
|
|
4667
|
+
/** @description A suggestion to resolve the error */
|
|
4668
|
+
suggestion: string;
|
|
4669
|
+
/** @description A URL to the documentation */
|
|
4670
|
+
documentationUrl: string;
|
|
4671
|
+
};
|
|
4672
|
+
/** @description The unique identifier of the request */
|
|
4673
|
+
requestId: string;
|
|
4674
|
+
/** @description The timestamp of the response */
|
|
4675
|
+
timestamp: string;
|
|
4676
|
+
/** @description The path of the request */
|
|
4677
|
+
path: string;
|
|
4678
|
+
};
|
|
4679
|
+
};
|
|
4680
|
+
};
|
|
4681
|
+
};
|
|
4682
|
+
};
|
|
4683
|
+
delete?: never;
|
|
4684
|
+
options?: never;
|
|
4685
|
+
head?: never;
|
|
4686
|
+
patch?: never;
|
|
4687
|
+
trace?: never;
|
|
4688
|
+
};
|
|
4458
4689
|
"/public/template/list": {
|
|
4459
4690
|
parameters: {
|
|
4460
4691
|
query?: never;
|
|
@@ -5320,6 +5551,7 @@ export enum ApiPaths {
|
|
|
5320
5551
|
PostPublicEnvelopeGetproof = "/public/envelope/get-proof",
|
|
5321
5552
|
PostPublicEnvelopeList = "/public/envelope/list",
|
|
5322
5553
|
PostPublicEnvelopeUpdate = "/public/envelope/update",
|
|
5554
|
+
PostPublicLogsList = "/public/logs/list",
|
|
5323
5555
|
PostPublicTemplateList = "/public/template/list",
|
|
5324
5556
|
PostPublicUtilsWhoami = "/public/utils/whoami",
|
|
5325
5557
|
PostPublicWorkspaceCreate = "/public/workspace/create",
|