sf-queue-sdk 0.3.1b255__tar.gz → 0.4.0__tar.gz

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/.gitignore

@@ -55,3 +55,7 @@ coverage/
 # packages/ts/queue-sdk/src/generated/ -- committed
 # packages/py/queue-sdk/queue_sdk/generated/ -- committed
 TODO-document-upload-queue.md
+
+# Local pipeline test output
+scripts/.env
+scripts/local-pdfs/

sf_queue_sdk-0.3.1b255/README.md → sf_queue_sdk-0.4.0/PKG-INFO

@@ -1,3 +1,11 @@
+Metadata-Version: 2.4
+Name: sf-queue-sdk
+Version: 0.4.0
+Summary: Python SDK for sf-queue - Redis-based queue system
+Requires-Python: >=3.11
+Requires-Dist: redis>=5.0.0
+Description-Content-Type: text/markdown
+
 # sf-queue-sdk
 
 Python SDK for sf-queue. Enqueues emails via Redis Streams with optional blocking confirmation from the Go consumer service.
@@ -144,7 +152,6 @@ print(result.error)       # error message if all failed
 | `image` | `{"src": str, "alt"?: str, "width"?: int, "height"?: int}` | No | Image in email body |
 | `service` | `str` | No | Service name for routing (e.g. `"sparkles"`). Routes to service-specific credentials, from address, and template. Defaults to the base config when omitted. |
 | `template` | `str` | No | Template name override (e.g. `"sparkles"`). Overrides the service's default template. Falls back to `"studyfetch"` when omitted. |
-| `brand` | `{"name"?: str, "logoUrl"?: str, "url"?: str, "accentColor"?: str}` | No | Per-workspace whitelabel branding (Honen template). `name` sets the wordmark/footer text **and** the From display name (the sending address and Resend key are unchanged, preserving the verified domain). Also overrides the logo, footer + header + unsubscribe link base, and CTA color. Any omitted field falls back to the default Honen brand. |
 
 ## Optional Fields
 
@@ -192,31 +199,28 @@ client.email.send(
 
 ## Whitelabel Branding
 
-Pass `brand` to render the Honen template with a workspace's own identity. Any
-omitted field falls back to the default Honen brand, so unbranded emails are
-unaffected.
+The Honen template accepts optional brand overrides. Empty fields retain the
+standard Honen identity.
 
 ```python
 client.email.send(
     to="member@acme.com",
     preview="You have been invited",
-    subject="Join the Acme workspace",
+    subject="Join Acme",
     paragraphs=["You have been invited to Acme."],
-    button={"text": "Accept invite", "href": "https://learn.acme.com/invite/abc"},
+    service="honen",
+    template="honen",
     brand={
-        "name": "Acme",  # wordmark + From display name ("Acme <noreply@...>")
+        "name": "Acme",
         "logoUrl": "https://cdn.acme.com/logo.png",
-        "url": "https://learn.acme.com",  # header/footer/unsubscribe link base
-        "accentColor": "#0043FF",         # CTA button color
+        "url": "https://learn.acme.com",
+        "accentColor": "#0043FF",
     },
 )
 ```
 
-The `name` also becomes the From display name: the email arrives from
-`Acme <noreply@honen.studyfetch.com>` instead of `Honen <noreply@...>`. Only the
-display label changes — the verified sending address and the service's Resend
-key stay the same, so DKIM/SPF alignment is unaffected. Omit `name` (or the whole
-`brand`) to keep the default Honen From.
+`name` also becomes the From display name while the selected route or validated
+From override continues to control the sending address and provider key.
 
 ## Migrating from sendEmail / sendBatchEmail
 
@@ -594,7 +598,7 @@ result = client.document_upload.send(
 | `url` | `str` | Yes | Download URL for the source file |
 | `generate_notes` | `bool` | Yes | Whether to generate study notes |
 | `generate_study_path` | `bool` | Yes | Whether to generate a study path |
-| `splitting` | `str` | No | Splitting strategy (default: `"auto"`) |
+| `splitting` | `str` | No | Splitting strategy for sources with at least 40,000 tokens (default: `"auto"`). Smaller sources always persist as one material after per-topic note generation. |
 | `language` | `str` | No | Target language code (default: `"en"`) |
 | `use_markdown_ocr` | `bool` | No | Use Markdown OCR for image interpretation (default: `False`) |
 | `flashcard_amount` | `int` | No | Number of flashcards to generate (default: `12`) |
@@ -608,6 +612,7 @@ result = client.document_upload.send(
 | `upload_batch_id` | `Optional[str]` | No | Batch ID when multiple files uploaded together |
 | `youtube_title` | `Optional[str]` | No | Title override for YouTube video transcripts |
 | `skip_material_creation` | `Optional[bool]` | No | Skip folder and material creation when the material already exists (e.g. live lectures) |
+| `existing_material_id` | `Optional[str]` | No | ID of an existing material to link to topics instead of creating new ones (used with `skip_material_creation`) |
 
 ### Response Type
 
@@ -676,7 +681,7 @@ result = client.document_notes.send(
     uploaded_file_id="file_abc123",
     study_set_id="set_xyz",
     user_id="user_123",
-    stash_key="clustering-stash/file_abc123/1720000000.json",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
     is_deferred=True,
     callback_url="https://api.example.com/completeCluster",
     callback_api_key="secret",
@@ -692,7 +697,7 @@ result = client.document_notes.send(
     uploaded_file_id="file_abc123",
     study_set_id="set_xyz",
     user_id="user_123",
-    stash_key="clustering-stash/file_abc123/1720000000.json",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
     is_deferred=False,
     generate_notes=False,
     folder_id="folder_abc",
@@ -701,6 +706,25 @@ result = client.document_notes.send(
 )
 ```
 
+### Note regeneration for existing materials
+
+Use `skip_material_creation` and `existing_material_id` to regenerate notes for an existing `noNotes` material using its original clustering stash. The stash key is deterministic: `clustering-stash/{study_set_id}/{uploaded_file_id}.json`.
+
+```python
+result = client.document_notes.send(
+    uploaded_file_id="file_abc123",
+    study_set_id="set_xyz",
+    user_id="user_123",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
+    is_deferred=False,
+    generate_notes=True,
+    skip_material_creation=True,
+    existing_material_id="mat_existing_456",
+    callback_url="https://api.example.com/noNotesGen/callback",
+    callback_api_key="secret",
+)
+```
+
 ### Document Notes Fields
 
 | Field | Type | Required | Description |
@@ -708,12 +732,16 @@ result = client.document_notes.send(
 | `uploaded_file_id` | `str` | Yes | ID of the uploaded file record |
 | `study_set_id` | `str` | Yes | Study set to persist materials into |
 | `user_id` | `str` | Yes | User who uploaded the document |
-| `stash_key` | `str` | Yes | GCS key of the clustering stash JSON |
+| `stash_key` | `str` | Yes | GCS key of the clustering stash JSON (deterministic: `clustering-stash/{study_set_id}/{uploaded_file_id}.json`) |
 | `is_deferred` | `bool` | No | Whether the study set has existing topics requiring approval (default: `False`) |
 | `generate_notes` | `bool` | No | Whether to generate notes (default: `True`). Set to `False` for noNotes materials |
 | `callback_url` | `Optional[str]` | No | URL to POST results to after completion |
 | `callback_api_key` | `Optional[str]` | No | Auth key for the callback |
 | `folder_id` | `Optional[str]` | No | Pre-created folder ID for the materials |
+| `skip_material_creation` | `Optional[bool]` | No | Skip creating new materials; update an existing one instead (used for note regeneration) |
+| `existing_material_id` | `Optional[str]` | No | ID of the existing material to update with generated notes (used with `skip_material_creation`) |
+| `target_topic_index` | `Optional[int]` | No | Index of the specific topic to regenerate notes for (matches `material.order`). Omit to generate all topics. |
+| `append_mode` | `Optional[bool]` | No | When `True`, generated notes are appended to existing material content rather than replacing it |
 
 ### Response Types
 

sf_queue_sdk-0.3.1b255/PKG-INFO → sf_queue_sdk-0.4.0/README.md

@@ -1,11 +1,3 @@
-Metadata-Version: 2.4
-Name: sf-queue-sdk
-Version: 0.3.1b255
-Summary: Python SDK for sf-queue - Redis-based queue system
-Requires-Python: >=3.11
-Requires-Dist: redis>=5.0.0
-Description-Content-Type: text/markdown
-
 # sf-queue-sdk
 
 Python SDK for sf-queue. Enqueues emails via Redis Streams with optional blocking confirmation from the Go consumer service.
@@ -152,7 +144,6 @@ print(result.error)       # error message if all failed
 | `image` | `{"src": str, "alt"?: str, "width"?: int, "height"?: int}` | No | Image in email body |
 | `service` | `str` | No | Service name for routing (e.g. `"sparkles"`). Routes to service-specific credentials, from address, and template. Defaults to the base config when omitted. |
 | `template` | `str` | No | Template name override (e.g. `"sparkles"`). Overrides the service's default template. Falls back to `"studyfetch"` when omitted. |
-| `brand` | `{"name"?: str, "logoUrl"?: str, "url"?: str, "accentColor"?: str}` | No | Per-workspace whitelabel branding (Honen template). `name` sets the wordmark/footer text **and** the From display name (the sending address and Resend key are unchanged, preserving the verified domain). Also overrides the logo, footer + header + unsubscribe link base, and CTA color. Any omitted field falls back to the default Honen brand. |
 
 ## Optional Fields
 
@@ -200,31 +191,28 @@ client.email.send(
 
 ## Whitelabel Branding
 
-Pass `brand` to render the Honen template with a workspace's own identity. Any
-omitted field falls back to the default Honen brand, so unbranded emails are
-unaffected.
+The Honen template accepts optional brand overrides. Empty fields retain the
+standard Honen identity.
 
 ```python
 client.email.send(
     to="member@acme.com",
     preview="You have been invited",
-    subject="Join the Acme workspace",
+    subject="Join Acme",
     paragraphs=["You have been invited to Acme."],
-    button={"text": "Accept invite", "href": "https://learn.acme.com/invite/abc"},
+    service="honen",
+    template="honen",
     brand={
-        "name": "Acme",  # wordmark + From display name ("Acme <noreply@...>")
+        "name": "Acme",
         "logoUrl": "https://cdn.acme.com/logo.png",
-        "url": "https://learn.acme.com",  # header/footer/unsubscribe link base
-        "accentColor": "#0043FF",         # CTA button color
+        "url": "https://learn.acme.com",
+        "accentColor": "#0043FF",
     },
 )
 ```
 
-The `name` also becomes the From display name: the email arrives from
-`Acme <noreply@honen.studyfetch.com>` instead of `Honen <noreply@...>`. Only the
-display label changes — the verified sending address and the service's Resend
-key stay the same, so DKIM/SPF alignment is unaffected. Omit `name` (or the whole
-`brand`) to keep the default Honen From.
+`name` also becomes the From display name while the selected route or validated
+From override continues to control the sending address and provider key.
 
 ## Migrating from sendEmail / sendBatchEmail
 
@@ -602,7 +590,7 @@ result = client.document_upload.send(
 | `url` | `str` | Yes | Download URL for the source file |
 | `generate_notes` | `bool` | Yes | Whether to generate study notes |
 | `generate_study_path` | `bool` | Yes | Whether to generate a study path |
-| `splitting` | `str` | No | Splitting strategy (default: `"auto"`) |
+| `splitting` | `str` | No | Splitting strategy for sources with at least 40,000 tokens (default: `"auto"`). Smaller sources always persist as one material after per-topic note generation. |
 | `language` | `str` | No | Target language code (default: `"en"`) |
 | `use_markdown_ocr` | `bool` | No | Use Markdown OCR for image interpretation (default: `False`) |
 | `flashcard_amount` | `int` | No | Number of flashcards to generate (default: `12`) |
@@ -616,6 +604,7 @@ result = client.document_upload.send(
 | `upload_batch_id` | `Optional[str]` | No | Batch ID when multiple files uploaded together |
 | `youtube_title` | `Optional[str]` | No | Title override for YouTube video transcripts |
 | `skip_material_creation` | `Optional[bool]` | No | Skip folder and material creation when the material already exists (e.g. live lectures) |
+| `existing_material_id` | `Optional[str]` | No | ID of an existing material to link to topics instead of creating new ones (used with `skip_material_creation`) |
 
 ### Response Type
 
@@ -684,7 +673,7 @@ result = client.document_notes.send(
     uploaded_file_id="file_abc123",
     study_set_id="set_xyz",
     user_id="user_123",
-    stash_key="clustering-stash/file_abc123/1720000000.json",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
     is_deferred=True,
     callback_url="https://api.example.com/completeCluster",
     callback_api_key="secret",
@@ -700,7 +689,7 @@ result = client.document_notes.send(
     uploaded_file_id="file_abc123",
     study_set_id="set_xyz",
     user_id="user_123",
-    stash_key="clustering-stash/file_abc123/1720000000.json",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
     is_deferred=False,
     generate_notes=False,
     folder_id="folder_abc",
@@ -709,6 +698,25 @@ result = client.document_notes.send(
 )
 ```
 
+### Note regeneration for existing materials
+
+Use `skip_material_creation` and `existing_material_id` to regenerate notes for an existing `noNotes` material using its original clustering stash. The stash key is deterministic: `clustering-stash/{study_set_id}/{uploaded_file_id}.json`.
+
+```python
+result = client.document_notes.send(
+    uploaded_file_id="file_abc123",
+    study_set_id="set_xyz",
+    user_id="user_123",
+    stash_key="clustering-stash/set_xyz/file_abc123.json",
+    is_deferred=False,
+    generate_notes=True,
+    skip_material_creation=True,
+    existing_material_id="mat_existing_456",
+    callback_url="https://api.example.com/noNotesGen/callback",
+    callback_api_key="secret",
+)
+```
+
 ### Document Notes Fields
 
 | Field | Type | Required | Description |
@@ -716,12 +724,16 @@ result = client.document_notes.send(
 | `uploaded_file_id` | `str` | Yes | ID of the uploaded file record |
 | `study_set_id` | `str` | Yes | Study set to persist materials into |
 | `user_id` | `str` | Yes | User who uploaded the document |
-| `stash_key` | `str` | Yes | GCS key of the clustering stash JSON |
+| `stash_key` | `str` | Yes | GCS key of the clustering stash JSON (deterministic: `clustering-stash/{study_set_id}/{uploaded_file_id}.json`) |
 | `is_deferred` | `bool` | No | Whether the study set has existing topics requiring approval (default: `False`) |
 | `generate_notes` | `bool` | No | Whether to generate notes (default: `True`). Set to `False` for noNotes materials |
 | `callback_url` | `Optional[str]` | No | URL to POST results to after completion |
 | `callback_api_key` | `Optional[str]` | No | Auth key for the callback |
 | `folder_id` | `Optional[str]` | No | Pre-created folder ID for the materials |
+| `skip_material_creation` | `Optional[bool]` | No | Skip creating new materials; update an existing one instead (used for note regeneration) |
+| `existing_material_id` | `Optional[str]` | No | ID of the existing material to update with generated notes (used with `skip_material_creation`) |
+| `target_topic_index` | `Optional[int]` | No | Index of the specific topic to regenerate notes for (matches `material.order`). Omit to generate all topics. |
+| `append_mode` | `Optional[bool]` | No | When `True`, generated notes are appended to existing material content rather than replacing it |
 
 ### Response Types
 

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sf-queue-sdk"
-version = "0.3.1b255"
+version = "0.4.0"
 description = "Python SDK for sf-queue - Redis-based queue system"
 readme = "README.md"
 requires-python = ">=3.11"

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/__init__.py

@@ -1,6 +1,6 @@
 """sf-queue Python SDK - Redis-based queue system."""
 
-__version__ = "0.3.1b255"
+__version__ = "0.4.0"
 
 from queue_sdk.client import QueueClient
 from queue_sdk.query import QueryClient

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/generated/queue/email/v1/email_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1aqueue/email/v1/email.proto\x12\x0equeue.email.v1\"5\n\x0b\x45mailButton\x12\x12\n\x04text\x18\x01 \x01(\tR\x04text\x12\x12\n\x04href\x18\x02 \x01(\tR\x04href\"^\n\nEmailImage\x12\x10\n\x03src\x18\x01 \x01(\tR\x03src\x12\x10\n\x03\x61lt\x18\x02 \x01(\tR\x03\x61lt\x12\x14\n\x05width\x18\x03 \x01(\x05R\x05width\x12\x16\n\x06height\x18\x04 \x01(\x05R\x06height\"p\n\nEmailBrand\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12\x19\n\x08logo_url\x18\x02 \x01(\tR\x07logoUrl\x12\x10\n\x03url\x18\x03 \x01(\tR\x03url\x12!\n\x0c\x61\x63\x63\x65nt_color\x18\x04 \x01(\tR\x0b\x61\x63\x63\x65ntColor\"\xa3\x03\n\x0c\x45mailRequest\x12\x0e\n\x02to\x18\x01 \x01(\tR\x02to\x12\x18\n\x07preview\x18\x02 \x01(\tR\x07preview\x12\x18\n\x07subject\x18\x03 \x01(\tR\x07subject\x12\x1e\n\nparagraphs\x18\x04 \x03(\tR\nparagraphs\x12\x33\n\x06\x62utton\x18\x05 \x01(\x0b\x32\x1b.queue.email.v1.EmailButtonR\x06\x62utton\x12\x19\n\x08reply_to\x18\x06 \x01(\tR\x07replyTo\x12\x30\n\x05image\x18\x07 \x01(\x0b\x32\x1a.queue.email.v1.EmailImageR\x05image\x12\x18\n\x07service\x18\x08 \x01(\tR\x07service\x12\x1a\n\x08template\x18\t \x01(\tR\x08template\x12\x12\n\x04html\x18\n \x01(\tR\x04html\x12\x12\n\x04\x66rom\x18\x0b \x01(\tR\x04\x66rom\x12\x1d\n\nresend_key\x18\x0c \x01(\tR\tresendKey\x12\x30\n\x05\x62rand\x18\r \x01(\x0b\x32\x1a.queue.email.v1.EmailBrandR\x05\x62rand\"\xa8\x03\n\x11\x42\x61tchEmailRequest\x12\x0e\n\x02to\x18\x01 \x03(\tR\x02to\x12\x18\n\x07preview\x18\x02 \x01(\tR\x07preview\x12\x18\n\x07subject\x18\x03 \x01(\tR\x07subject\x12\x1e\n\nparagraphs\x18\x04 \x03(\tR\nparagraphs\x12\x33\n\x06\x62utton\x18\x05 \x01(\x0b\x32\x1b.queue.email.v1.EmailButtonR\x06\x62utton\x12\x19\n\x08reply_to\x18\x06 \x01(\tR\x07replyTo\x12\x30\n\x05image\x18\x07 \x01(\x0b\x32\x1a.queue.email.v1.EmailImageR\x05image\x12\x18\n\x07service\x18\x08 \x01(\tR\x07service\x12\x1a\n\x08template\x18\t \x01(\tR\x08template\x12\x12\n\x04html\x18\n \x01(\tR\x04html\x12\x12\n\x04\x66rom\x18\x0b \x01(\tR\x04\x66rom\x12\x1d\n\nresend_key\x18\x0c \x01(\tR\tresendKey\x12\x30\n\x05\x62rand\x18\r \x01(\x0b\x32\x1a.queue.email.v1.EmailBrandR\x05\x62rand\"^\n\rEmailResponse\x12\x18\n\x07success\x18\x01 \x01(\x08R\x07success\x12\x1d\n\nmessage_id\x18\x02 \x01(\tR\tmessageId\x12\x14\n\x05\x65rror\x18\x03 \x01(\tR\x05\x65rrorBLZJgithub.com/StudyFetch/sf-queue/packages/go/proto-go/queue/email/v1;emailv1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1aqueue/email/v1/email.proto\x12\x0equeue.email.v1\"5\n\x0b\x45mailButton\x12\x12\n\x04text\x18\x01 \x01(\tR\x04text\x12\x12\n\x04href\x18\x02 \x01(\tR\x04href\"^\n\nEmailImage\x12\x10\n\x03src\x18\x01 \x01(\tR\x03src\x12\x10\n\x03\x61lt\x18\x02 \x01(\tR\x03\x61lt\x12\x14\n\x05width\x18\x03 \x01(\x05R\x05width\x12\x16\n\x06height\x18\x04 \x01(\x05R\x06height\"p\n\nEmailBrand\x12\x12\n\x04name\x18\x01 \x01(\tR\x04name\x12\x19\n\x08logo_url\x18\x02 \x01(\tR\x07logoUrl\x12\x10\n\x03url\x18\x03 \x01(\tR\x03url\x12!\n\x0c\x61\x63\x63\x65nt_color\x18\x04 \x01(\tR\x0b\x61\x63\x63\x65ntColor\"\xc0\x03\n\x0c\x45mailRequest\x12\x0e\n\x02to\x18\x01 \x01(\tR\x02to\x12\x18\n\x07preview\x18\x02 \x01(\tR\x07preview\x12\x18\n\x07subject\x18\x03 \x01(\tR\x07subject\x12\x1e\n\nparagraphs\x18\x04 \x03(\tR\nparagraphs\x12\x33\n\x06\x62utton\x18\x05 \x01(\x0b\x32\x1b.queue.email.v1.EmailButtonR\x06\x62utton\x12\x19\n\x08reply_to\x18\x06 \x01(\tR\x07replyTo\x12\x30\n\x05image\x18\x07 \x01(\x0b\x32\x1a.queue.email.v1.EmailImageR\x05image\x12\x18\n\x07service\x18\x08 \x01(\tR\x07service\x12\x1a\n\x08template\x18\t \x01(\tR\x08template\x12\x12\n\x04html\x18\n \x01(\tR\x04html\x12\x12\n\x04\x66rom\x18\x0b \x01(\tR\x04\x66rom\x12\x1d\n\nresend_key\x18\x0c \x01(\tR\tresendKey\x12\x30\n\x05\x62rand\x18\r \x01(\x0b\x32\x1a.queue.email.v1.EmailBrandR\x05\x62rand\x12\x1b\n\tbody_html\x18\x0e \x01(\tR\x08\x62odyHtml\"\xc5\x03\n\x11\x42\x61tchEmailRequest\x12\x0e\n\x02to\x18\x01 \x03(\tR\x02to\x12\x18\n\x07preview\x18\x02 \x01(\tR\x07preview\x12\x18\n\x07subject\x18\x03 \x01(\tR\x07subject\x12\x1e\n\nparagraphs\x18\x04 \x03(\tR\nparagraphs\x12\x33\n\x06\x62utton\x18\x05 \x01(\x0b\x32\x1b.queue.email.v1.EmailButtonR\x06\x62utton\x12\x19\n\x08reply_to\x18\x06 \x01(\tR\x07replyTo\x12\x30\n\x05image\x18\x07 \x01(\x0b\x32\x1a.queue.email.v1.EmailImageR\x05image\x12\x18\n\x07service\x18\x08 \x01(\tR\x07service\x12\x1a\n\x08template\x18\t \x01(\tR\x08template\x12\x12\n\x04html\x18\n \x01(\tR\x04html\x12\x12\n\x04\x66rom\x18\x0b \x01(\tR\x04\x66rom\x12\x1d\n\nresend_key\x18\x0c \x01(\tR\tresendKey\x12\x30\n\x05\x62rand\x18\r \x01(\x0b\x32\x1a.queue.email.v1.EmailBrandR\x05\x62rand\x12\x1b\n\tbody_html\x18\x0e \x01(\tR\x08\x62odyHtml\"^\n\rEmailResponse\x12\x18\n\x07success\x18\x01 \x01(\x08R\x07success\x12\x1d\n\nmessage_id\x18\x02 \x01(\tR\tmessageId\x12\x14\n\x05\x65rror\x18\x03 \x01(\tR\x05\x65rrorBLZJgithub.com/StudyFetch/sf-queue/packages/go/proto-go/queue/email/v1;emailv1b\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -39,9 +39,9 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_EMAILBRAND']._serialized_start=197
   _globals['_EMAILBRAND']._serialized_end=309
   _globals['_EMAILREQUEST']._serialized_start=312
-  _globals['_EMAILREQUEST']._serialized_end=731
-  _globals['_BATCHEMAILREQUEST']._serialized_start=734
-  _globals['_BATCHEMAILREQUEST']._serialized_end=1158
-  _globals['_EMAILRESPONSE']._serialized_start=1160
-  _globals['_EMAILRESPONSE']._serialized_end=1254
+  _globals['_EMAILREQUEST']._serialized_end=760
+  _globals['_BATCHEMAILREQUEST']._serialized_start=763
+  _globals['_BATCHEMAILREQUEST']._serialized_end=1216
+  _globals['_EMAILRESPONSE']._serialized_start=1218
+  _globals['_EMAILRESPONSE']._serialized_end=1312
 # @@protoc_insertion_point(module_scope)

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/generated/queue/email/v1/email_pb2.pyi

@@ -39,7 +39,7 @@ class EmailBrand(_message.Message):
     def __init__(self, name: _Optional[str] = ..., logo_url: _Optional[str] = ..., url: _Optional[str] = ..., accent_color: _Optional[str] = ...) -> None: ...
 
 class EmailRequest(_message.Message):
-    __slots__ = ("to", "preview", "subject", "paragraphs", "button", "reply_to", "image", "service", "template", "html", "resend_key", "brand")
+    __slots__ = ("to", "preview", "subject", "paragraphs", "button", "reply_to", "image", "service", "template", "html", "resend_key", "brand", "body_html")
     TO_FIELD_NUMBER: _ClassVar[int]
     PREVIEW_FIELD_NUMBER: _ClassVar[int]
     SUBJECT_FIELD_NUMBER: _ClassVar[int]
@@ -53,6 +53,7 @@ class EmailRequest(_message.Message):
     FROM_FIELD_NUMBER: _ClassVar[int]
     RESEND_KEY_FIELD_NUMBER: _ClassVar[int]
     BRAND_FIELD_NUMBER: _ClassVar[int]
+    BODY_HTML_FIELD_NUMBER: _ClassVar[int]
     to: str
     preview: str
     subject: str
@@ -65,10 +66,11 @@ class EmailRequest(_message.Message):
     html: str
     resend_key: str
     brand: EmailBrand
-    def __init__(self, to: _Optional[str] = ..., preview: _Optional[str] = ..., subject: _Optional[str] = ..., paragraphs: _Optional[_Iterable[str]] = ..., button: _Optional[_Union[EmailButton, _Mapping]] = ..., reply_to: _Optional[str] = ..., image: _Optional[_Union[EmailImage, _Mapping]] = ..., service: _Optional[str] = ..., template: _Optional[str] = ..., html: _Optional[str] = ..., resend_key: _Optional[str] = ..., brand: _Optional[_Union[EmailBrand, _Mapping]] = ..., **kwargs) -> None: ...
+    body_html: str
+    def __init__(self, to: _Optional[str] = ..., preview: _Optional[str] = ..., subject: _Optional[str] = ..., paragraphs: _Optional[_Iterable[str]] = ..., button: _Optional[_Union[EmailButton, _Mapping]] = ..., reply_to: _Optional[str] = ..., image: _Optional[_Union[EmailImage, _Mapping]] = ..., service: _Optional[str] = ..., template: _Optional[str] = ..., html: _Optional[str] = ..., resend_key: _Optional[str] = ..., brand: _Optional[_Union[EmailBrand, _Mapping]] = ..., body_html: _Optional[str] = ..., **kwargs) -> None: ...
 
 class BatchEmailRequest(_message.Message):
-    __slots__ = ("to", "preview", "subject", "paragraphs", "button", "reply_to", "image", "service", "template", "html", "resend_key", "brand")
+    __slots__ = ("to", "preview", "subject", "paragraphs", "button", "reply_to", "image", "service", "template", "html", "resend_key", "brand", "body_html")
     TO_FIELD_NUMBER: _ClassVar[int]
     PREVIEW_FIELD_NUMBER: _ClassVar[int]
     SUBJECT_FIELD_NUMBER: _ClassVar[int]
@@ -82,6 +84,7 @@ class BatchEmailRequest(_message.Message):
     FROM_FIELD_NUMBER: _ClassVar[int]
     RESEND_KEY_FIELD_NUMBER: _ClassVar[int]
     BRAND_FIELD_NUMBER: _ClassVar[int]
+    BODY_HTML_FIELD_NUMBER: _ClassVar[int]
     to: _containers.RepeatedScalarFieldContainer[str]
     preview: str
     subject: str
@@ -94,7 +97,8 @@ class BatchEmailRequest(_message.Message):
     html: str
     resend_key: str
     brand: EmailBrand
-    def __init__(self, to: _Optional[_Iterable[str]] = ..., preview: _Optional[str] = ..., subject: _Optional[str] = ..., paragraphs: _Optional[_Iterable[str]] = ..., button: _Optional[_Union[EmailButton, _Mapping]] = ..., reply_to: _Optional[str] = ..., image: _Optional[_Union[EmailImage, _Mapping]] = ..., service: _Optional[str] = ..., template: _Optional[str] = ..., html: _Optional[str] = ..., resend_key: _Optional[str] = ..., brand: _Optional[_Union[EmailBrand, _Mapping]] = ..., **kwargs) -> None: ...
+    body_html: str
+    def __init__(self, to: _Optional[_Iterable[str]] = ..., preview: _Optional[str] = ..., subject: _Optional[str] = ..., paragraphs: _Optional[_Iterable[str]] = ..., button: _Optional[_Union[EmailButton, _Mapping]] = ..., reply_to: _Optional[str] = ..., image: _Optional[_Union[EmailImage, _Mapping]] = ..., service: _Optional[str] = ..., template: _Optional[str] = ..., html: _Optional[str] = ..., resend_key: _Optional[str] = ..., brand: _Optional[_Union[EmailBrand, _Mapping]] = ..., body_html: _Optional[str] = ..., **kwargs) -> None: ...
 
 class EmailResponse(_message.Message):
     __slots__ = ("success", "message_id", "error")

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/queues/document_notes_queue.py

@@ -30,6 +30,10 @@ class DocumentNotesQueue(BaseQueue):
         callback_url: Optional[str] = None,
         callback_api_key: Optional[str] = None,
         folder_id: Optional[str] = None,
+        skip_material_creation: Optional[bool] = None,
+        existing_material_id: Optional[str] = None,
+        target_topic_index: Optional[int] = None,
+        append_mode: Optional[bool] = None,
     ) -> SendResult:
         """Enqueue a note generation request."""
         self._validate(uploaded_file_id, study_set_id, user_id, stash_key)
@@ -43,6 +47,10 @@ class DocumentNotesQueue(BaseQueue):
             callback_url=callback_url,
             callback_api_key=callback_api_key,
             folder_id=folder_id,
+            skip_material_creation=skip_material_creation,
+            existing_material_id=existing_material_id,
+            target_topic_index=target_topic_index,
+            append_mode=append_mode,
         )
         message_id = self._enqueue(payload)
 
@@ -59,6 +67,10 @@ class DocumentNotesQueue(BaseQueue):
         callback_url: Optional[str],
         callback_api_key: Optional[str],
         folder_id: Optional[str],
+        skip_material_creation: Optional[bool],
+        existing_material_id: Optional[str],
+        target_topic_index: Optional[int],
+        append_mode: Optional[bool],
     ) -> dict[str, Any]:
         payload: dict[str, Any] = {
             "uploadedFileId": uploaded_file_id,
@@ -75,6 +87,14 @@ class DocumentNotesQueue(BaseQueue):
             payload["callbackApiKey"] = callback_api_key
         if folder_id is not None:
             payload["folderId"] = folder_id
+        if skip_material_creation is not None:
+            payload["skipMaterialCreation"] = skip_material_creation
+        if existing_material_id is not None:
+            payload["existingMaterialId"] = existing_material_id
+        if target_topic_index is not None:
+            payload["targetTopicIndex"] = target_topic_index
+        if append_mode is not None:
+            payload["appendMode"] = append_mode
 
         return payload
 

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/queues/document_upload_queue.py

@@ -51,6 +51,7 @@ class DocumentUploadQueue(BaseQueue):
         callback_api_key: Optional[str] = None,
         study_plan_hook: Optional[bool] = None,
         skip_material_creation: Optional[bool] = None,
+        existing_material_id: Optional[str] = None,
     ) -> SendResult:
         """Enqueue a document upload processing request (fire and forget)."""
         self._validate(uploaded_file_id, study_set_id, user_id, pdf_s3_key, filename)
@@ -86,6 +87,7 @@ class DocumentUploadQueue(BaseQueue):
             callback_api_key=callback_api_key,
             study_plan_hook=study_plan_hook,
             skip_material_creation=skip_material_creation,
+            existing_material_id=existing_material_id,
         )
         message_id = self._enqueue(payload)
         self._set_initial_status(message_id)
@@ -171,6 +173,7 @@ class DocumentUploadQueue(BaseQueue):
         callback_api_key: Optional[str],
         study_plan_hook: Optional[bool],
         skip_material_creation: Optional[bool],
+        existing_material_id: Optional[str],
     ) -> dict[str, Any]:
         """Build the document upload payload (snake_case -> camelCase)."""
         payload: dict[str, Any] = {
@@ -222,6 +225,8 @@ class DocumentUploadQueue(BaseQueue):
             payload["studyPlanHook"] = study_plan_hook
         if skip_material_creation is not None:
             payload["skipMaterialCreation"] = skip_material_creation
+        if existing_material_id is not None:
+            payload["existingMaterialId"] = existing_material_id
 
         return payload
 

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/queues/email_queue.py

@@ -24,7 +24,7 @@ class EmailQueue(BaseQueue):
         to: str,
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]] = None,
         button: Optional[dict[str, str]] = None,
         reply_to: Optional[str] = None,
         image: Optional[dict[str, Any]] = None,
@@ -32,10 +32,22 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> SendResult:
         """Enqueue an email for processing (fire and forget)."""
         payload = self._build_payload(
-            to, preview, subject, paragraphs, button, reply_to, image, service, template, html, brand
+            to,
+            preview,
+            subject,
+            paragraphs,
+            button,
+            reply_to,
+            image,
+            service,
+            template,
+            html,
+            brand,
+            body_html,
         )
         message_id = self._enqueue(payload)
         return SendResult(message_id=message_id)
@@ -45,7 +57,7 @@ class EmailQueue(BaseQueue):
         to: str,
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]] = None,
         button: Optional[dict[str, str]] = None,
         reply_to: Optional[str] = None,
         image: Optional[dict[str, Any]] = None,
@@ -54,10 +66,22 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> EmailResponse:
         """Enqueue an email and wait for processing confirmation."""
         payload = self._build_payload(
-            to, preview, subject, paragraphs, button, reply_to, image, service, template, html, brand
+            to,
+            preview,
+            subject,
+            paragraphs,
+            button,
+            reply_to,
+            image,
+            service,
+            template,
+            html,
+            brand,
+            body_html,
         )
         return self._enqueue_and_wait(payload, timeout)
 
@@ -66,7 +90,7 @@ class EmailQueue(BaseQueue):
         to: list[str],
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]] = None,
         button: Optional[dict[str, str]] = None,
         reply_to: Optional[str] = None,
         image: Optional[dict[str, Any]] = None,
@@ -74,11 +98,23 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> SendResult:
         """Enqueue a batch email for processing (fire and forget)."""
         self._validate_batch(to)
         payload = self._build_batch_payload(
-            to, preview, subject, paragraphs, button, reply_to, image, service, template, html, brand
+            to,
+            preview,
+            subject,
+            paragraphs,
+            button,
+            reply_to,
+            image,
+            service,
+            template,
+            html,
+            brand,
+            body_html,
         )
         message_id = self._enqueue(payload)
         return SendResult(message_id=message_id)
@@ -88,7 +124,7 @@ class EmailQueue(BaseQueue):
         to: list[str],
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]] = None,
         button: Optional[dict[str, str]] = None,
         reply_to: Optional[str] = None,
         image: Optional[dict[str, Any]] = None,
@@ -97,11 +133,23 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> BatchEmailResponse:
         """Enqueue a batch email and wait for processing confirmation."""
         self._validate_batch(to)
         payload = self._build_batch_payload(
-            to, preview, subject, paragraphs, button, reply_to, image, service, template, html, brand
+            to,
+            preview,
+            subject,
+            paragraphs,
+            button,
+            reply_to,
+            image,
+            service,
+            template,
+            html,
+            brand,
+            body_html,
         )
         response = self._enqueue_and_wait(payload, timeout)
 
@@ -120,7 +168,7 @@ class EmailQueue(BaseQueue):
         to: str,
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]],
         button: Optional[dict[str, str]],
         reply_to: Optional[str],
         image: Optional[dict[str, Any]],
@@ -128,13 +176,14 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> dict[str, Any]:
         """Build and sanitize the email payload."""
         payload: dict[str, Any] = {
             "to": to,
             "preview": sanitize(preview),
             "subject": sanitize(subject),
-            "paragraphs": sanitize_list(paragraphs),
+            "paragraphs": sanitize_list(paragraphs or []),
         }
 
         if button:
@@ -163,6 +212,9 @@ class EmailQueue(BaseQueue):
         if html:
             payload["html"] = html
 
+        if body_html:
+            payload["bodyHtml"] = body_html
+
         if brand:
             payload["brand"] = self._build_brand(brand)
 
@@ -170,7 +222,7 @@ class EmailQueue(BaseQueue):
 
     @staticmethod
     def _build_brand(brand: dict[str, str]) -> dict[str, str]:
-        """Sanitize whitelabel branding. Name is user text; URLs/color pass through."""
+        """Sanitize Honen template branding."""
         result: dict[str, str] = {}
         if brand.get("name"):
             result["name"] = sanitize(brand["name"])
@@ -187,7 +239,7 @@ class EmailQueue(BaseQueue):
         to: list[str],
         preview: str,
         subject: str,
-        paragraphs: list[str],
+        paragraphs: Optional[list[str]],
         button: Optional[dict[str, str]],
         reply_to: Optional[str],
         image: Optional[dict[str, Any]],
@@ -195,6 +247,7 @@ class EmailQueue(BaseQueue):
         template: Optional[str] = None,
         html: Optional[str] = None,
         brand: Optional[dict[str, str]] = None,
+        body_html: Optional[str] = None,
     ) -> dict[str, Any]:
         """Build and sanitize the batch email payload."""
         payload = self._build_payload(
@@ -209,6 +262,7 @@ class EmailQueue(BaseQueue):
             template=template,
             html=html,
             brand=brand,
+            body_html=body_html,
         )
         payload["to"] = to
         payload["batch"] = True

{sf_queue_sdk-0.3.1b255 → sf_queue_sdk-0.4.0}/queue_sdk/types.py

@@ -281,6 +281,9 @@ class DocumentNotesData:
     callback_url: Optional[str] = None
     callback_api_key: Optional[str] = None
     folder_id: Optional[str] = None
+    skip_material_creation: Optional[bool] = None
+    existing_material_id: Optional[str] = None
+    target_topic_index: Optional[int] = None
 
 
 @dataclass