@arbidocs/client 0.3.140 → 0.3.142

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 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 (newest first).
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;
@@ -5139,7 +5177,7 @@ interface components {
5139
5177
  */
5140
5178
  ContactResponse: {
5141
5179
  /** External Id */
5142
- external_id: string;
5180
+ external_id?: string | null;
5143
5181
  /** Email */
5144
5182
  email: string;
5145
5183
  user?: components['schemas']['UserResponse'] | null;
@@ -5147,9 +5185,13 @@ interface components {
5147
5185
  * Status
5148
5186
  * @enum {string}
5149
5187
  */
5150
- status: 'invitation_pending' | 'invitation_expired' | 'registered';
5188
+ status: 'invitation_pending' | 'invitation_expired' | 'registered' | 'failed';
5151
5189
  /** Created At */
5152
5190
  created_at: string;
5191
+ /** Outcome */
5192
+ outcome?: ('invited' | 'reinvited' | 'not_resent_still_pending' | 'contact_added' | 'already_contact' | 'failed') | null;
5193
+ /** Outcome Detail */
5194
+ outcome_detail?: string | null;
5153
5195
  };
5154
5196
  /**
5155
5197
  * ContextUsage
@@ -5486,8 +5528,12 @@ interface components {
5486
5528
  * @enum {string}
5487
5529
  */
5488
5530
  source: 'manual' | 'learning' | 'curator';
5489
- /** Note Date */
5490
- note_date?: string | null;
5531
+ /** Date */
5532
+ date?: string | null;
5533
+ /** Date End */
5534
+ date_end?: string | null;
5535
+ /** Timezone */
5536
+ timezone?: string | null;
5491
5537
  /**
5492
5538
  * Tag Ext Ids
5493
5539
  * @default []
@@ -7485,8 +7531,17 @@ interface components {
7485
7531
  shared: boolean;
7486
7532
  /** Source */
7487
7533
  source: string;
7488
- /** Note Date */
7489
- note_date?: string | null;
7534
+ /** Date Start */
7535
+ date_start?: string | null;
7536
+ /** Date End */
7537
+ date_end?: string | null;
7538
+ /** Timezone */
7539
+ timezone?: string | null;
7540
+ /**
7541
+ * Reminder Task Ext Ids
7542
+ * @default []
7543
+ */
7544
+ reminder_task_ext_ids: string[];
7490
7545
  /**
7491
7546
  * Tags
7492
7547
  * @default []
@@ -8403,6 +8458,23 @@ interface components {
8403
8458
  /** Picture */
8404
8459
  picture?: string | null;
8405
8460
  };
8461
+ /**
8462
+ * RemindNoteRequest
8463
+ * @description Set a one-off reminder for a dated note.
8464
+ *
8465
+ * Give either an explicit ``remind_at`` or a ``lead_minutes`` offset before
8466
+ * the note's date; with neither, the reminder fires when its span starts.
8467
+ *
8468
+ * A declared model rather than embedded ``Body(...)`` params: FastAPI
8469
+ * synthesises an inline ``Body_*`` schema for those, which is not strict, and
8470
+ * the client generator rejects request bodies that accept unknown fields.
8471
+ */
8472
+ RemindNoteRequest: {
8473
+ /** Remind At */
8474
+ remind_at?: string | null;
8475
+ /** Lead Minutes */
8476
+ lead_minutes?: number | null;
8477
+ };
8406
8478
  /**
8407
8479
  * RemoveWorkspaceUserItem
8408
8480
  * @description A user or agent to remove from a workspace.
@@ -10504,7 +10576,7 @@ interface components {
10504
10576
  * UpdateNoteRequest
10505
10577
  * @description Patch a note. An edit to ``text`` soft-deletes the old row and
10506
10578
  * inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
10507
- * ``note_date``/``tag_ext_ids`` update in place.
10579
+ * ``tag_ext_ids`` update in place.
10508
10580
  */
10509
10581
  UpdateNoteRequest: {
10510
10582
  /** Text */
@@ -10513,8 +10585,12 @@ interface components {
10513
10585
  pinned?: boolean | null;
10514
10586
  /** Shared */
10515
10587
  shared?: boolean | null;
10516
- /** Note Date */
10517
- note_date?: string | null;
10588
+ /** Date */
10589
+ date?: string | null;
10590
+ /** Date End */
10591
+ date_end?: string | null;
10592
+ /** Timezone */
10593
+ timezone?: string | null;
10518
10594
  /** Tag Ext Ids */
10519
10595
  tag_ext_ids?: string[] | null;
10520
10596
  citations?: components['schemas']['CitationSources'] | null;
@@ -14274,6 +14350,12 @@ interface operations {
14274
14350
  parameters: {
14275
14351
  query?: {
14276
14352
  pinned_only?: boolean;
14353
+ /** @description Range start, any precision ("2019", "2019-10") */
14354
+ date_from?: string | null;
14355
+ /** @description Range end, any precision */
14356
+ date_to?: string | null;
14357
+ /** @description Only notes that carry a date — the timeline view */
14358
+ dated_only?: boolean;
14277
14359
  };
14278
14360
  header?: never;
14279
14361
  path?: never;
@@ -14400,6 +14482,41 @@ interface operations {
14400
14482
  };
14401
14483
  };
14402
14484
  };
14485
+ remind_note: {
14486
+ parameters: {
14487
+ query?: never;
14488
+ header?: never;
14489
+ path: {
14490
+ note_ext_id: string;
14491
+ };
14492
+ cookie?: never;
14493
+ };
14494
+ requestBody?: {
14495
+ content: {
14496
+ 'application/json': components['schemas']['RemindNoteRequest'];
14497
+ };
14498
+ };
14499
+ responses: {
14500
+ /** @description Successful Response */
14501
+ 200: {
14502
+ headers: {
14503
+ [name: string]: unknown;
14504
+ };
14505
+ content: {
14506
+ 'application/json': components['schemas']['NoteResponse'];
14507
+ };
14508
+ };
14509
+ /** @description Validation Error */
14510
+ 422: {
14511
+ headers: {
14512
+ [name: string]: unknown;
14513
+ };
14514
+ content: {
14515
+ 'application/json': components['schemas']['HTTPValidationError'];
14516
+ };
14517
+ };
14518
+ };
14519
+ };
14403
14520
  get_websocket_schema: {
14404
14521
  parameters: {
14405
14522
  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 (newest first).
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;
@@ -5139,7 +5177,7 @@ interface components {
5139
5177
  */
5140
5178
  ContactResponse: {
5141
5179
  /** External Id */
5142
- external_id: string;
5180
+ external_id?: string | null;
5143
5181
  /** Email */
5144
5182
  email: string;
5145
5183
  user?: components['schemas']['UserResponse'] | null;
@@ -5147,9 +5185,13 @@ interface components {
5147
5185
  * Status
5148
5186
  * @enum {string}
5149
5187
  */
5150
- status: 'invitation_pending' | 'invitation_expired' | 'registered';
5188
+ status: 'invitation_pending' | 'invitation_expired' | 'registered' | 'failed';
5151
5189
  /** Created At */
5152
5190
  created_at: string;
5191
+ /** Outcome */
5192
+ outcome?: ('invited' | 'reinvited' | 'not_resent_still_pending' | 'contact_added' | 'already_contact' | 'failed') | null;
5193
+ /** Outcome Detail */
5194
+ outcome_detail?: string | null;
5153
5195
  };
5154
5196
  /**
5155
5197
  * ContextUsage
@@ -5486,8 +5528,12 @@ interface components {
5486
5528
  * @enum {string}
5487
5529
  */
5488
5530
  source: 'manual' | 'learning' | 'curator';
5489
- /** Note Date */
5490
- note_date?: string | null;
5531
+ /** Date */
5532
+ date?: string | null;
5533
+ /** Date End */
5534
+ date_end?: string | null;
5535
+ /** Timezone */
5536
+ timezone?: string | null;
5491
5537
  /**
5492
5538
  * Tag Ext Ids
5493
5539
  * @default []
@@ -7485,8 +7531,17 @@ interface components {
7485
7531
  shared: boolean;
7486
7532
  /** Source */
7487
7533
  source: string;
7488
- /** Note Date */
7489
- note_date?: string | null;
7534
+ /** Date Start */
7535
+ date_start?: string | null;
7536
+ /** Date End */
7537
+ date_end?: string | null;
7538
+ /** Timezone */
7539
+ timezone?: string | null;
7540
+ /**
7541
+ * Reminder Task Ext Ids
7542
+ * @default []
7543
+ */
7544
+ reminder_task_ext_ids: string[];
7490
7545
  /**
7491
7546
  * Tags
7492
7547
  * @default []
@@ -8403,6 +8458,23 @@ interface components {
8403
8458
  /** Picture */
8404
8459
  picture?: string | null;
8405
8460
  };
8461
+ /**
8462
+ * RemindNoteRequest
8463
+ * @description Set a one-off reminder for a dated note.
8464
+ *
8465
+ * Give either an explicit ``remind_at`` or a ``lead_minutes`` offset before
8466
+ * the note's date; with neither, the reminder fires when its span starts.
8467
+ *
8468
+ * A declared model rather than embedded ``Body(...)`` params: FastAPI
8469
+ * synthesises an inline ``Body_*`` schema for those, which is not strict, and
8470
+ * the client generator rejects request bodies that accept unknown fields.
8471
+ */
8472
+ RemindNoteRequest: {
8473
+ /** Remind At */
8474
+ remind_at?: string | null;
8475
+ /** Lead Minutes */
8476
+ lead_minutes?: number | null;
8477
+ };
8406
8478
  /**
8407
8479
  * RemoveWorkspaceUserItem
8408
8480
  * @description A user or agent to remove from a workspace.
@@ -10504,7 +10576,7 @@ interface components {
10504
10576
  * UpdateNoteRequest
10505
10577
  * @description Patch a note. An edit to ``text`` soft-deletes the old row and
10506
10578
  * inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
10507
- * ``note_date``/``tag_ext_ids`` update in place.
10579
+ * ``tag_ext_ids`` update in place.
10508
10580
  */
10509
10581
  UpdateNoteRequest: {
10510
10582
  /** Text */
@@ -10513,8 +10585,12 @@ interface components {
10513
10585
  pinned?: boolean | null;
10514
10586
  /** Shared */
10515
10587
  shared?: boolean | null;
10516
- /** Note Date */
10517
- note_date?: string | null;
10588
+ /** Date */
10589
+ date?: string | null;
10590
+ /** Date End */
10591
+ date_end?: string | null;
10592
+ /** Timezone */
10593
+ timezone?: string | null;
10518
10594
  /** Tag Ext Ids */
10519
10595
  tag_ext_ids?: string[] | null;
10520
10596
  citations?: components['schemas']['CitationSources'] | null;
@@ -14274,6 +14350,12 @@ interface operations {
14274
14350
  parameters: {
14275
14351
  query?: {
14276
14352
  pinned_only?: boolean;
14353
+ /** @description Range start, any precision ("2019", "2019-10") */
14354
+ date_from?: string | null;
14355
+ /** @description Range end, any precision */
14356
+ date_to?: string | null;
14357
+ /** @description Only notes that carry a date — the timeline view */
14358
+ dated_only?: boolean;
14277
14359
  };
14278
14360
  header?: never;
14279
14361
  path?: never;
@@ -14400,6 +14482,41 @@ interface operations {
14400
14482
  };
14401
14483
  };
14402
14484
  };
14485
+ remind_note: {
14486
+ parameters: {
14487
+ query?: never;
14488
+ header?: never;
14489
+ path: {
14490
+ note_ext_id: string;
14491
+ };
14492
+ cookie?: never;
14493
+ };
14494
+ requestBody?: {
14495
+ content: {
14496
+ 'application/json': components['schemas']['RemindNoteRequest'];
14497
+ };
14498
+ };
14499
+ responses: {
14500
+ /** @description Successful Response */
14501
+ 200: {
14502
+ headers: {
14503
+ [name: string]: unknown;
14504
+ };
14505
+ content: {
14506
+ 'application/json': components['schemas']['NoteResponse'];
14507
+ };
14508
+ };
14509
+ /** @description Validation Error */
14510
+ 422: {
14511
+ headers: {
14512
+ [name: string]: unknown;
14513
+ };
14514
+ content: {
14515
+ 'application/json': components['schemas']['HTTPValidationError'];
14516
+ };
14517
+ };
14518
+ };
14519
+ };
14403
14520
  get_websocket_schema: {
14404
14521
  parameters: {
14405
14522
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.140",
3
+ "version": "0.3.142",
4
4
  "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",