@arbidocs/client 0.3.140 → 0.3.141
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.cts +114 -10
- package/dist/index.d.ts +114 -10
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -247,6 +247,9 @@ interface paths {
|
|
|
247
247
|
* For each email:
|
|
248
248
|
* - If user already exists: Adds them to contacts with status="registered"
|
|
249
249
|
* - If user doesn't exist: Sends invitation email and creates contact with status="invited"
|
|
250
|
+
* - If an invitation is already pending: returns the contact unchanged without
|
|
251
|
+
* resending, since a resend rotates the code and invalidates the link already
|
|
252
|
+
* sent. Delete the contact to invite again before the invitation expires.
|
|
250
253
|
*
|
|
251
254
|
* Protected endpoint - requires authentication.
|
|
252
255
|
* Returns list of created contact records.
|
|
@@ -1971,7 +1974,12 @@ interface paths {
|
|
|
1971
1974
|
};
|
|
1972
1975
|
/**
|
|
1973
1976
|
* List Notes Endpoint
|
|
1974
|
-
* @description List notes visible in the active workspace
|
|
1977
|
+
* @description List notes visible in the active workspace.
|
|
1978
|
+
*
|
|
1979
|
+
* Newest first by default. Passing a date range (or ``dated_only``) turns this
|
|
1980
|
+
* into the timeline: only dated notes, ordered by when they happened. Each
|
|
1981
|
+
* bound is read at its own precision and widened outward, so ``date_to=2019``
|
|
1982
|
+
* runs through 31 December rather than stopping on 1 January.
|
|
1975
1983
|
*/
|
|
1976
1984
|
get: operations['list_notes'];
|
|
1977
1985
|
put?: never;
|
|
@@ -2026,6 +2034,36 @@ interface paths {
|
|
|
2026
2034
|
patch: operations['update_note'];
|
|
2027
2035
|
trace?: never;
|
|
2028
2036
|
};
|
|
2037
|
+
'/v1/notes/{note_ext_id}/remind': {
|
|
2038
|
+
parameters: {
|
|
2039
|
+
query?: never;
|
|
2040
|
+
header?: never;
|
|
2041
|
+
path?: never;
|
|
2042
|
+
cookie?: never;
|
|
2043
|
+
};
|
|
2044
|
+
get?: never;
|
|
2045
|
+
put?: never;
|
|
2046
|
+
/**
|
|
2047
|
+
* Remind Note Endpoint
|
|
2048
|
+
* @description Set a one-off reminder for a dated note, and link it to the note.
|
|
2049
|
+
*
|
|
2050
|
+
* Give an explicit ``remind_at`` or a ``lead_minutes`` offset before the note's
|
|
2051
|
+
* date; with neither it fires when the note's span starts. Only dated notes can
|
|
2052
|
+
* be reminded about — there is nothing to fire relative to otherwise.
|
|
2053
|
+
*
|
|
2054
|
+
* The reminder is deliberately CONTENT-FREE: it names the note by external id
|
|
2055
|
+
* and nothing else. ``tasks.name`` is plaintext while ``notes.content`` is
|
|
2056
|
+
* encrypted under the workspace key, so copying the text into the reminder
|
|
2057
|
+
* would leak the very thing the note protects. The client resolves the text
|
|
2058
|
+
* from the note when it displays the notification.
|
|
2059
|
+
*/
|
|
2060
|
+
post: operations['remind_note'];
|
|
2061
|
+
delete?: never;
|
|
2062
|
+
options?: never;
|
|
2063
|
+
head?: never;
|
|
2064
|
+
patch?: never;
|
|
2065
|
+
trace?: never;
|
|
2066
|
+
};
|
|
2029
2067
|
'/v1/notifications/ws-schemas': {
|
|
2030
2068
|
parameters: {
|
|
2031
2069
|
query?: never;
|
|
@@ -4495,6 +4533,13 @@ interface components {
|
|
|
4495
4533
|
/** Session Id */
|
|
4496
4534
|
session_id?: string | null;
|
|
4497
4535
|
};
|
|
4536
|
+
/** Body_remind_note */
|
|
4537
|
+
Body_remind_note: {
|
|
4538
|
+
/** Remind At */
|
|
4539
|
+
remind_at?: string | null;
|
|
4540
|
+
/** Lead Minutes */
|
|
4541
|
+
lead_minutes?: number | null;
|
|
4542
|
+
};
|
|
4498
4543
|
/**
|
|
4499
4544
|
* ChangePasswordRequest
|
|
4500
4545
|
* @description Password change request with signature-based auth.
|
|
@@ -5139,7 +5184,7 @@ interface components {
|
|
|
5139
5184
|
*/
|
|
5140
5185
|
ContactResponse: {
|
|
5141
5186
|
/** External Id */
|
|
5142
|
-
external_id
|
|
5187
|
+
external_id?: string | null;
|
|
5143
5188
|
/** Email */
|
|
5144
5189
|
email: string;
|
|
5145
5190
|
user?: components['schemas']['UserResponse'] | null;
|
|
@@ -5147,9 +5192,13 @@ interface components {
|
|
|
5147
5192
|
* Status
|
|
5148
5193
|
* @enum {string}
|
|
5149
5194
|
*/
|
|
5150
|
-
status: 'invitation_pending' | 'invitation_expired' | 'registered';
|
|
5195
|
+
status: 'invitation_pending' | 'invitation_expired' | 'registered' | 'failed';
|
|
5151
5196
|
/** Created At */
|
|
5152
5197
|
created_at: string;
|
|
5198
|
+
/** Outcome */
|
|
5199
|
+
outcome?: ('invited' | 'reinvited' | 'not_resent_still_pending' | 'contact_added' | 'already_contact' | 'failed') | null;
|
|
5200
|
+
/** Outcome Detail */
|
|
5201
|
+
outcome_detail?: string | null;
|
|
5153
5202
|
};
|
|
5154
5203
|
/**
|
|
5155
5204
|
* ContextUsage
|
|
@@ -5486,8 +5535,12 @@ interface components {
|
|
|
5486
5535
|
* @enum {string}
|
|
5487
5536
|
*/
|
|
5488
5537
|
source: 'manual' | 'learning' | 'curator';
|
|
5489
|
-
/**
|
|
5490
|
-
|
|
5538
|
+
/** Date */
|
|
5539
|
+
date?: string | null;
|
|
5540
|
+
/** Date End */
|
|
5541
|
+
date_end?: string | null;
|
|
5542
|
+
/** Timezone */
|
|
5543
|
+
timezone?: string | null;
|
|
5491
5544
|
/**
|
|
5492
5545
|
* Tag Ext Ids
|
|
5493
5546
|
* @default []
|
|
@@ -7485,8 +7538,14 @@ interface components {
|
|
|
7485
7538
|
shared: boolean;
|
|
7486
7539
|
/** Source */
|
|
7487
7540
|
source: string;
|
|
7488
|
-
/**
|
|
7489
|
-
|
|
7541
|
+
/** Date Start */
|
|
7542
|
+
date_start?: string | null;
|
|
7543
|
+
/** Date End */
|
|
7544
|
+
date_end?: string | null;
|
|
7545
|
+
/** Timezone */
|
|
7546
|
+
timezone?: string | null;
|
|
7547
|
+
/** Task Ext Id */
|
|
7548
|
+
task_ext_id?: string | null;
|
|
7490
7549
|
/**
|
|
7491
7550
|
* Tags
|
|
7492
7551
|
* @default []
|
|
@@ -10504,7 +10563,7 @@ interface components {
|
|
|
10504
10563
|
* UpdateNoteRequest
|
|
10505
10564
|
* @description Patch a note. An edit to ``text`` soft-deletes the old row and
|
|
10506
10565
|
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
|
|
10507
|
-
* ``
|
|
10566
|
+
* ``tag_ext_ids`` update in place.
|
|
10508
10567
|
*/
|
|
10509
10568
|
UpdateNoteRequest: {
|
|
10510
10569
|
/** Text */
|
|
@@ -10513,8 +10572,12 @@ interface components {
|
|
|
10513
10572
|
pinned?: boolean | null;
|
|
10514
10573
|
/** Shared */
|
|
10515
10574
|
shared?: boolean | null;
|
|
10516
|
-
/**
|
|
10517
|
-
|
|
10575
|
+
/** Date */
|
|
10576
|
+
date?: string | null;
|
|
10577
|
+
/** Date End */
|
|
10578
|
+
date_end?: string | null;
|
|
10579
|
+
/** Timezone */
|
|
10580
|
+
timezone?: string | null;
|
|
10518
10581
|
/** Tag Ext Ids */
|
|
10519
10582
|
tag_ext_ids?: string[] | null;
|
|
10520
10583
|
citations?: components['schemas']['CitationSources'] | null;
|
|
@@ -14274,6 +14337,12 @@ interface operations {
|
|
|
14274
14337
|
parameters: {
|
|
14275
14338
|
query?: {
|
|
14276
14339
|
pinned_only?: boolean;
|
|
14340
|
+
/** @description Range start, any precision ("2019", "2019-10") */
|
|
14341
|
+
date_from?: string | null;
|
|
14342
|
+
/** @description Range end, any precision */
|
|
14343
|
+
date_to?: string | null;
|
|
14344
|
+
/** @description Only notes that carry a date — the timeline view */
|
|
14345
|
+
dated_only?: boolean;
|
|
14277
14346
|
};
|
|
14278
14347
|
header?: never;
|
|
14279
14348
|
path?: never;
|
|
@@ -14400,6 +14469,41 @@ interface operations {
|
|
|
14400
14469
|
};
|
|
14401
14470
|
};
|
|
14402
14471
|
};
|
|
14472
|
+
remind_note: {
|
|
14473
|
+
parameters: {
|
|
14474
|
+
query?: never;
|
|
14475
|
+
header?: never;
|
|
14476
|
+
path: {
|
|
14477
|
+
note_ext_id: string;
|
|
14478
|
+
};
|
|
14479
|
+
cookie?: never;
|
|
14480
|
+
};
|
|
14481
|
+
requestBody?: {
|
|
14482
|
+
content: {
|
|
14483
|
+
'application/json': components['schemas']['Body_remind_note'];
|
|
14484
|
+
};
|
|
14485
|
+
};
|
|
14486
|
+
responses: {
|
|
14487
|
+
/** @description Successful Response */
|
|
14488
|
+
200: {
|
|
14489
|
+
headers: {
|
|
14490
|
+
[name: string]: unknown;
|
|
14491
|
+
};
|
|
14492
|
+
content: {
|
|
14493
|
+
'application/json': components['schemas']['NoteResponse'];
|
|
14494
|
+
};
|
|
14495
|
+
};
|
|
14496
|
+
/** @description Validation Error */
|
|
14497
|
+
422: {
|
|
14498
|
+
headers: {
|
|
14499
|
+
[name: string]: unknown;
|
|
14500
|
+
};
|
|
14501
|
+
content: {
|
|
14502
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
14503
|
+
};
|
|
14504
|
+
};
|
|
14505
|
+
};
|
|
14506
|
+
};
|
|
14403
14507
|
get_websocket_schema: {
|
|
14404
14508
|
parameters: {
|
|
14405
14509
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -247,6 +247,9 @@ interface paths {
|
|
|
247
247
|
* For each email:
|
|
248
248
|
* - If user already exists: Adds them to contacts with status="registered"
|
|
249
249
|
* - If user doesn't exist: Sends invitation email and creates contact with status="invited"
|
|
250
|
+
* - If an invitation is already pending: returns the contact unchanged without
|
|
251
|
+
* resending, since a resend rotates the code and invalidates the link already
|
|
252
|
+
* sent. Delete the contact to invite again before the invitation expires.
|
|
250
253
|
*
|
|
251
254
|
* Protected endpoint - requires authentication.
|
|
252
255
|
* Returns list of created contact records.
|
|
@@ -1971,7 +1974,12 @@ interface paths {
|
|
|
1971
1974
|
};
|
|
1972
1975
|
/**
|
|
1973
1976
|
* List Notes Endpoint
|
|
1974
|
-
* @description List notes visible in the active workspace
|
|
1977
|
+
* @description List notes visible in the active workspace.
|
|
1978
|
+
*
|
|
1979
|
+
* Newest first by default. Passing a date range (or ``dated_only``) turns this
|
|
1980
|
+
* into the timeline: only dated notes, ordered by when they happened. Each
|
|
1981
|
+
* bound is read at its own precision and widened outward, so ``date_to=2019``
|
|
1982
|
+
* runs through 31 December rather than stopping on 1 January.
|
|
1975
1983
|
*/
|
|
1976
1984
|
get: operations['list_notes'];
|
|
1977
1985
|
put?: never;
|
|
@@ -2026,6 +2034,36 @@ interface paths {
|
|
|
2026
2034
|
patch: operations['update_note'];
|
|
2027
2035
|
trace?: never;
|
|
2028
2036
|
};
|
|
2037
|
+
'/v1/notes/{note_ext_id}/remind': {
|
|
2038
|
+
parameters: {
|
|
2039
|
+
query?: never;
|
|
2040
|
+
header?: never;
|
|
2041
|
+
path?: never;
|
|
2042
|
+
cookie?: never;
|
|
2043
|
+
};
|
|
2044
|
+
get?: never;
|
|
2045
|
+
put?: never;
|
|
2046
|
+
/**
|
|
2047
|
+
* Remind Note Endpoint
|
|
2048
|
+
* @description Set a one-off reminder for a dated note, and link it to the note.
|
|
2049
|
+
*
|
|
2050
|
+
* Give an explicit ``remind_at`` or a ``lead_minutes`` offset before the note's
|
|
2051
|
+
* date; with neither it fires when the note's span starts. Only dated notes can
|
|
2052
|
+
* be reminded about — there is nothing to fire relative to otherwise.
|
|
2053
|
+
*
|
|
2054
|
+
* The reminder is deliberately CONTENT-FREE: it names the note by external id
|
|
2055
|
+
* and nothing else. ``tasks.name`` is plaintext while ``notes.content`` is
|
|
2056
|
+
* encrypted under the workspace key, so copying the text into the reminder
|
|
2057
|
+
* would leak the very thing the note protects. The client resolves the text
|
|
2058
|
+
* from the note when it displays the notification.
|
|
2059
|
+
*/
|
|
2060
|
+
post: operations['remind_note'];
|
|
2061
|
+
delete?: never;
|
|
2062
|
+
options?: never;
|
|
2063
|
+
head?: never;
|
|
2064
|
+
patch?: never;
|
|
2065
|
+
trace?: never;
|
|
2066
|
+
};
|
|
2029
2067
|
'/v1/notifications/ws-schemas': {
|
|
2030
2068
|
parameters: {
|
|
2031
2069
|
query?: never;
|
|
@@ -4495,6 +4533,13 @@ interface components {
|
|
|
4495
4533
|
/** Session Id */
|
|
4496
4534
|
session_id?: string | null;
|
|
4497
4535
|
};
|
|
4536
|
+
/** Body_remind_note */
|
|
4537
|
+
Body_remind_note: {
|
|
4538
|
+
/** Remind At */
|
|
4539
|
+
remind_at?: string | null;
|
|
4540
|
+
/** Lead Minutes */
|
|
4541
|
+
lead_minutes?: number | null;
|
|
4542
|
+
};
|
|
4498
4543
|
/**
|
|
4499
4544
|
* ChangePasswordRequest
|
|
4500
4545
|
* @description Password change request with signature-based auth.
|
|
@@ -5139,7 +5184,7 @@ interface components {
|
|
|
5139
5184
|
*/
|
|
5140
5185
|
ContactResponse: {
|
|
5141
5186
|
/** External Id */
|
|
5142
|
-
external_id
|
|
5187
|
+
external_id?: string | null;
|
|
5143
5188
|
/** Email */
|
|
5144
5189
|
email: string;
|
|
5145
5190
|
user?: components['schemas']['UserResponse'] | null;
|
|
@@ -5147,9 +5192,13 @@ interface components {
|
|
|
5147
5192
|
* Status
|
|
5148
5193
|
* @enum {string}
|
|
5149
5194
|
*/
|
|
5150
|
-
status: 'invitation_pending' | 'invitation_expired' | 'registered';
|
|
5195
|
+
status: 'invitation_pending' | 'invitation_expired' | 'registered' | 'failed';
|
|
5151
5196
|
/** Created At */
|
|
5152
5197
|
created_at: string;
|
|
5198
|
+
/** Outcome */
|
|
5199
|
+
outcome?: ('invited' | 'reinvited' | 'not_resent_still_pending' | 'contact_added' | 'already_contact' | 'failed') | null;
|
|
5200
|
+
/** Outcome Detail */
|
|
5201
|
+
outcome_detail?: string | null;
|
|
5153
5202
|
};
|
|
5154
5203
|
/**
|
|
5155
5204
|
* ContextUsage
|
|
@@ -5486,8 +5535,12 @@ interface components {
|
|
|
5486
5535
|
* @enum {string}
|
|
5487
5536
|
*/
|
|
5488
5537
|
source: 'manual' | 'learning' | 'curator';
|
|
5489
|
-
/**
|
|
5490
|
-
|
|
5538
|
+
/** Date */
|
|
5539
|
+
date?: string | null;
|
|
5540
|
+
/** Date End */
|
|
5541
|
+
date_end?: string | null;
|
|
5542
|
+
/** Timezone */
|
|
5543
|
+
timezone?: string | null;
|
|
5491
5544
|
/**
|
|
5492
5545
|
* Tag Ext Ids
|
|
5493
5546
|
* @default []
|
|
@@ -7485,8 +7538,14 @@ interface components {
|
|
|
7485
7538
|
shared: boolean;
|
|
7486
7539
|
/** Source */
|
|
7487
7540
|
source: string;
|
|
7488
|
-
/**
|
|
7489
|
-
|
|
7541
|
+
/** Date Start */
|
|
7542
|
+
date_start?: string | null;
|
|
7543
|
+
/** Date End */
|
|
7544
|
+
date_end?: string | null;
|
|
7545
|
+
/** Timezone */
|
|
7546
|
+
timezone?: string | null;
|
|
7547
|
+
/** Task Ext Id */
|
|
7548
|
+
task_ext_id?: string | null;
|
|
7490
7549
|
/**
|
|
7491
7550
|
* Tags
|
|
7492
7551
|
* @default []
|
|
@@ -10504,7 +10563,7 @@ interface components {
|
|
|
10504
10563
|
* UpdateNoteRequest
|
|
10505
10564
|
* @description Patch a note. An edit to ``text`` soft-deletes the old row and
|
|
10506
10565
|
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
|
|
10507
|
-
* ``
|
|
10566
|
+
* ``tag_ext_ids`` update in place.
|
|
10508
10567
|
*/
|
|
10509
10568
|
UpdateNoteRequest: {
|
|
10510
10569
|
/** Text */
|
|
@@ -10513,8 +10572,12 @@ interface components {
|
|
|
10513
10572
|
pinned?: boolean | null;
|
|
10514
10573
|
/** Shared */
|
|
10515
10574
|
shared?: boolean | null;
|
|
10516
|
-
/**
|
|
10517
|
-
|
|
10575
|
+
/** Date */
|
|
10576
|
+
date?: string | null;
|
|
10577
|
+
/** Date End */
|
|
10578
|
+
date_end?: string | null;
|
|
10579
|
+
/** Timezone */
|
|
10580
|
+
timezone?: string | null;
|
|
10518
10581
|
/** Tag Ext Ids */
|
|
10519
10582
|
tag_ext_ids?: string[] | null;
|
|
10520
10583
|
citations?: components['schemas']['CitationSources'] | null;
|
|
@@ -14274,6 +14337,12 @@ interface operations {
|
|
|
14274
14337
|
parameters: {
|
|
14275
14338
|
query?: {
|
|
14276
14339
|
pinned_only?: boolean;
|
|
14340
|
+
/** @description Range start, any precision ("2019", "2019-10") */
|
|
14341
|
+
date_from?: string | null;
|
|
14342
|
+
/** @description Range end, any precision */
|
|
14343
|
+
date_to?: string | null;
|
|
14344
|
+
/** @description Only notes that carry a date — the timeline view */
|
|
14345
|
+
dated_only?: boolean;
|
|
14277
14346
|
};
|
|
14278
14347
|
header?: never;
|
|
14279
14348
|
path?: never;
|
|
@@ -14400,6 +14469,41 @@ interface operations {
|
|
|
14400
14469
|
};
|
|
14401
14470
|
};
|
|
14402
14471
|
};
|
|
14472
|
+
remind_note: {
|
|
14473
|
+
parameters: {
|
|
14474
|
+
query?: never;
|
|
14475
|
+
header?: never;
|
|
14476
|
+
path: {
|
|
14477
|
+
note_ext_id: string;
|
|
14478
|
+
};
|
|
14479
|
+
cookie?: never;
|
|
14480
|
+
};
|
|
14481
|
+
requestBody?: {
|
|
14482
|
+
content: {
|
|
14483
|
+
'application/json': components['schemas']['Body_remind_note'];
|
|
14484
|
+
};
|
|
14485
|
+
};
|
|
14486
|
+
responses: {
|
|
14487
|
+
/** @description Successful Response */
|
|
14488
|
+
200: {
|
|
14489
|
+
headers: {
|
|
14490
|
+
[name: string]: unknown;
|
|
14491
|
+
};
|
|
14492
|
+
content: {
|
|
14493
|
+
'application/json': components['schemas']['NoteResponse'];
|
|
14494
|
+
};
|
|
14495
|
+
};
|
|
14496
|
+
/** @description Validation Error */
|
|
14497
|
+
422: {
|
|
14498
|
+
headers: {
|
|
14499
|
+
[name: string]: unknown;
|
|
14500
|
+
};
|
|
14501
|
+
content: {
|
|
14502
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
14503
|
+
};
|
|
14504
|
+
};
|
|
14505
|
+
};
|
|
14506
|
+
};
|
|
14403
14507
|
get_websocket_schema: {
|
|
14404
14508
|
parameters: {
|
|
14405
14509
|
query?: never;
|
package/package.json
CHANGED