pdfdancer-client-python 0.3.4__tar.gz → 0.3.6__tar.gz

{pdfdancer_client_python-0.3.4 → pdfdancer_client_python-0.3.6}/CLAUDE.md

@@ -95,7 +95,7 @@ pdf.save("output.pdf")
 ### Initialization
 
 ```python
-# Open existing PDF with token from env var PDFDANCER_TOKEN
+# Open existing PDF with token from env var PDFDANCER_API_TOKEN
 pdf = PDFDancer.open(pdf_data="document.pdf")
 
 # Open with explicit token

{pdfdancer_client_python-0.3.4 → pdfdancer_client_python-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdfdancer-client-python
-Version: 0.3.4
+Version: 0.3.6
 Summary: Python client for PDFDancer API
 Author-email: "The Famous Cat Ltd." <hi@thefamouscat.com>
 License: 
@@ -289,7 +289,7 @@ from pdfdancer import Color, PDFDancer, StandardFonts
 
 with PDFDancer.open(
     pdf_data=Path("input.pdf"),
-    token="your-api-token",             # optional when PDFDANCER_TOKEN is set
+    token="your-api-token",             # optional when PDFDANCER_API_TOKEN is set
     base_url="https://api.pdfdancer.com",
 ) as pdf:
     # Locate and update an existing paragraph
@@ -443,7 +443,7 @@ with PDFDancer.open("confidential.pdf") as pdf:
 
 ## Configuration
 
-- Set `PDFDANCER_TOKEN` for authentication (preferred for local development and CI).
+- Set `PDFDANCER_API_TOKEN` for authentication (preferred). `PDFDANCER_TOKEN` is also supported for backwards compatibility.
 - Override the API host with `PDFDANCER_BASE_URL` (e.g., sandbox or local environments). Defaults to `https://api.pdfdancer.com`.
 - Tune HTTP read timeouts via the `timeout` argument on `PDFDancer.open()` and `PDFDancer.new()` (default: 30 seconds).
 - For testing against self-signed certificates, call `pdfdancer.set_ssl_verify(False)` to temporarily disable TLS verification.
@@ -513,13 +513,13 @@ Set your PDFDancer API token as an environment variable:
 
 ```bash
 # On macOS/Linux:
-export PDFDANCER_TOKEN="your-api-token-here"
+export PDFDANCER_API_TOKEN="your-api-token-here"
 
 # On Windows (Command Prompt):
-set PDFDANCER_TOKEN=your-api-token-here
+set PDFDANCER_API_TOKEN=your-api-token-here
 
 # On Windows (PowerShell):
-$env:PDFDANCER_TOKEN="your-api-token-here"
+$env:PDFDANCER_API_TOKEN="your-api-token-here"
 ```
 
 For permanent configuration, add this to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).
@@ -651,7 +651,7 @@ pip install -e .
 
 #### Test Failures
 
-- Ensure `PDFDANCER_TOKEN` is set for e2e tests
+- Ensure `PDFDANCER_API_TOKEN` is set for e2e tests
 - Check network connectivity to the PDFDancer API
 - Verify you're using Python 3.10 or higher
 

{pdfdancer_client_python-0.3.4 → pdfdancer_client_python-0.3.6}/README.md

@@ -50,7 +50,7 @@ from pdfdancer import Color, PDFDancer, StandardFonts
 
 with PDFDancer.open(
     pdf_data=Path("input.pdf"),
-    token="your-api-token",             # optional when PDFDANCER_TOKEN is set
+    token="your-api-token",             # optional when PDFDANCER_API_TOKEN is set
     base_url="https://api.pdfdancer.com",
 ) as pdf:
     # Locate and update an existing paragraph
@@ -204,7 +204,7 @@ with PDFDancer.open("confidential.pdf") as pdf:
 
 ## Configuration
 
-- Set `PDFDANCER_TOKEN` for authentication (preferred for local development and CI).
+- Set `PDFDANCER_API_TOKEN` for authentication (preferred). `PDFDANCER_TOKEN` is also supported for backwards compatibility.
 - Override the API host with `PDFDANCER_BASE_URL` (e.g., sandbox or local environments). Defaults to `https://api.pdfdancer.com`.
 - Tune HTTP read timeouts via the `timeout` argument on `PDFDancer.open()` and `PDFDancer.new()` (default: 30 seconds).
 - For testing against self-signed certificates, call `pdfdancer.set_ssl_verify(False)` to temporarily disable TLS verification.
@@ -274,13 +274,13 @@ Set your PDFDancer API token as an environment variable:
 
 ```bash
 # On macOS/Linux:
-export PDFDANCER_TOKEN="your-api-token-here"
+export PDFDANCER_API_TOKEN="your-api-token-here"
 
 # On Windows (Command Prompt):
-set PDFDANCER_TOKEN=your-api-token-here
+set PDFDANCER_API_TOKEN=your-api-token-here
 
 # On Windows (PowerShell):
-$env:PDFDANCER_TOKEN="your-api-token-here"
+$env:PDFDANCER_API_TOKEN="your-api-token-here"
 ```
 
 For permanent configuration, add this to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).
@@ -412,7 +412,7 @@ pip install -e .
 
 #### Test Failures
 
-- Ensure `PDFDANCER_TOKEN` is set for e2e tests
+- Ensure `PDFDANCER_API_TOKEN` is set for e2e tests
 - Check network connectivity to the PDFDancer API
 - Verify you're using Python 3.10 or higher
 

{pdfdancer_client_python-0.3.4 → pdfdancer_client_python-0.3.6}/docs/api-schemas/v0.yml

@@ -7,7 +7,31 @@ paths:
     get:
       operationId: listTenants
       parameters:
-      - name: include
+      - name: status
+        in: query
+        required: true
+        explode: false
+        schema:
+          type: string
+      - name: plan
+        in: query
+        required: true
+        explode: false
+        schema:
+          type: string
+      - name: anonymous
+        in: query
+        required: true
+        explode: false
+        schema:
+          type: string
+      - name: sortBy
+        in: query
+        required: true
+        explode: false
+        schema:
+          type: string
+      - name: order
         in: query
         required: true
         explode: false
@@ -1415,10 +1439,15 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/AnalyticsService.UserStats"
-  /payment/checkout-session:
+  /pdf/add:
     post:
-      operationId: checkoutSession
+      operationId: addObject
       parameters:
+      - name: X-Session-Id
+        in: header
+        required: true
+        schema:
+          type: string
       - name: v
         in: query
         description: API version
@@ -1443,24 +1472,25 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/PaymentController.CheckoutSessionRequest"
+              $ref: "#/components/schemas/AddRequest"
         required: true
       responses:
         "200":
-          description: checkoutSession 200 response
+          description: addObject 200 response
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/PaymentController.CheckoutSessionResponse"
-  /pdf/add:
+                type: boolean
+  /pdf/analyze:
     post:
-      operationId: addObject
+      operationId: analyzePdf
       parameters:
-      - name: X-Session-Id
-        in: header
-        required: true
+      - name: types
+        in: query
+        explode: false
         schema:
           type: string
+          nullable: true
       - name: v
         in: query
         description: API version
@@ -1483,17 +1513,25 @@ paths:
           type: string
       requestBody:
         content:
-          application/json:
+          multipart/form-data:
             schema:
-              $ref: "#/components/schemas/AddRequest"
+              type: object
+              properties:
+                pdf:
+                  type: string
+                  format: binary
+            encoding:
+              pdf:
+                contentType: application/octet-stream
+                explode: false
         required: true
       responses:
         "200":
-          description: addObject 200 response
+          description: analyzePdf 200 response
           content:
             application/json:
               schema:
-                type: boolean
+                $ref: "#/components/schemas/DocumentSnapshot"
   /pdf/delete:
     delete:
       operationId: deleteObject
@@ -2547,9 +2585,9 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Subscription"
-  /subscription/activate-early-access-plan:
+  /subscription/create-checkout-session:
     post:
-      operationId: activateEarlyAccessPlan
+      operationId: createCheckoutSession
       parameters:
       - name: v
         in: query
@@ -2571,17 +2609,22 @@ paths:
         description: API version
         schema:
           type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SubscriptionController.CheckoutRequest"
+        required: true
       responses:
         "200":
-          description: activateEarlyAccessPlan 200 response
+          description: createCheckoutSession 200 response
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/Subscription"
-      deprecated: true
-  /subscription/activate-free-plan:
+                type: object
+  /subscription/create-portal-session:
     post:
-      operationId: activateFreePlan
+      operationId: createPortalSession
       parameters:
       - name: v
         in: query
@@ -2605,47 +2648,21 @@ paths:
           type: string
       responses:
         "200":
-          description: activateFreePlan 200 response
+          description: createPortalSession 200 response
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/Subscription"
-      deprecated: true
-  /subscription/create-checkout-session:
-    post:
-      operationId: createCheckoutSession
+                type: object
+  /subscription/session-status:
+    get:
+      operationId: getSessionStatus
       parameters:
-      - name: v
-        in: query
-        description: API version
-        schema:
-          type: string
-      - name: api-version
+      - name: session_id
         in: query
-        description: API version
-        schema:
-          type: string
-      - name: X-API-VERSION
-        in: header
-        description: API version
-        schema:
-          type: string
-      - name: Accept-Version
-        in: header
-        description: API version
+        required: true
+        explode: false
         schema:
           type: string
-      responses:
-        "200":
-          description: createCheckoutSession 200 response
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/SubscriptionController.SessionResponse"
-  /subscription/create-portal-session:
-    post:
-      operationId: createPortalSession
-      parameters:
       - name: v
         in: query
         description: API version
@@ -2668,20 +2685,15 @@ paths:
           type: string
       responses:
         "200":
-          description: createPortalSession 200 response
+          description: getSessionStatus 200 response
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/SubscriptionController.SessionResponse"
-  /template/replace:
-    post:
-      operationId: replaceTemplates
+                type: object
+  /subscription/status:
+    get:
+      operationId: getSubscriptionStatus
       parameters:
-      - name: X-Session-Id
-        in: header
-        required: true
-        schema:
-          type: string
       - name: v
         in: query
         description: API version
@@ -2702,19 +2714,13 @@ paths:
         description: API version
         schema:
           type: string
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/TemplateReplaceRequest"
-        required: true
       responses:
         "200":
-          description: replaceTemplates 200 response
+          description: getSubscriptionStatus 200 response
           content:
             application/json:
               schema:
-                type: boolean
+                $ref: "#/components/schemas/SubscriptionController.SubscriptionStatus"
   /test:
     get:
       operationId: test
@@ -4396,7 +4402,9 @@ components:
         mapping:
           CHECKBOX: "#/components/schemas/FormFieldRef"
           FORM_FIELD: "#/components/schemas/FormFieldRef"
+          DROPDOWN: "#/components/schemas/FormFieldRef"
           RADIO_BUTTON: "#/components/schemas/FormFieldRef"
+          BUTTON: "#/components/schemas/FormFieldRef"
           PARAGRAPH: "#/components/schemas/TextTypeObjectRef"
           TEXT_LINE: "#/components/schemas/TextTypeObjectRef"
           PAGE: "#/components/schemas/PageRef"
@@ -4621,21 +4629,6 @@ components:
       oneOf:
       - $ref: "#/components/schemas/Line"
       - $ref: "#/components/schemas/Bezier"
-    PaymentController.CheckoutSessionRequest:
-      required:
-      - plan
-      type: object
-      properties:
-        plan:
-          type: string
-    PaymentController.CheckoutSessionResponse:
-      required:
-      - url
-      type: object
-      properties:
-        url:
-          type: string
-          format: url
     Point:
       required:
       - x
@@ -4678,6 +4671,8 @@ components:
         effectivePageIndex:
           type: integer
           format: int32
+        center:
+          $ref: "#/components/schemas/Point"
     Position.PositionMode:
       type: string
       enum:
@@ -4895,9 +4890,11 @@ components:
           format: double
     Subscription:
       required:
+      - cancelAt
       - end
       - product
       - start
+      - status
       type: object
       properties:
         start:
@@ -4908,44 +4905,28 @@ components:
           format: date-time
         product:
           $ref: "#/components/schemas/Product"
-    SubscriptionController.SessionResponse:
-      required:
-      - url
-      type: object
-      properties:
-        url:
+        status:
           type: string
-    TemplateReplaceRequest:
+        cancelAt:
+          type: string
+          format: date-time
+    SubscriptionController.CheckoutRequest:
       required:
-      - replacements
+      - plan
       type: object
       properties:
-        pageIndex:
-          type: integer
-          format: int32
-          nullable: true
-        replacements:
-          type: array
-          items:
-            $ref: "#/components/schemas/TemplateReplacement"
-    TemplateReplacement:
+        plan:
+          type: string
+    SubscriptionController.SubscriptionStatus:
       required:
-      - placeholder
-      - text
+      - planCode
+      - status
       type: object
       properties:
-        placeholder:
+        planCode:
           type: string
-        text:
+        status:
           type: string
-        font:
-          nullable: true
-          allOf:
-          - $ref: "#/components/schemas/Font"
-        color:
-          nullable: true
-          allOf:
-          - $ref: "#/components/schemas/Color"
     TextElement:
       type: object
       allOf:
@@ -4983,6 +4964,10 @@ components:
             $ref: "#/components/schemas/Color"
           text:
             type: string
+          words:
+            type: array
+            items:
+              $ref: "#/components/schemas/Word"
     TextStatus:
       required:
       - fontType
@@ -5141,3 +5126,13 @@ components:
           type: string
         color:
           type: string
+    Word:
+      type: object
+      allOf:
+      - $ref: "#/components/schemas/PDFObject"
+      - type: object
+        properties:
+          objectType:
+            $ref: "#/components/schemas/ObjectType"
+          text:
+            type: string