Updating documentation

grpc/index.html

@@ -236,6 +236,13 @@ header. If provided, the request will fail with a <code>BAD_AUTHENTICATION</code
     </h4>
     
   
+    <h4 class="title is-5">
+      
+        <a href="org.signal.chat.one_time_donations.html">org.signal.chat.one_time_donations</a>
+      
+    </h4>
+    
+  
     <h4 class="title is-5">
       
         <a href="org.signal.chat.payments.html">org.signal.chat.payments</a>

grpc/org.signal.chat.donations.html

@@ -80,6 +80,24 @@
 
     
       
+      <p>
+        <a href="#message-org.signal.chat.donations.CreateDonationPermitRequest">
+          <span class="tag" style="min-width: 6em">Message</span>
+          <code>CreateDonationPermitRequest</code> 
+        </a>
+      </p>
+      
+    
+      
+      <p>
+        <a href="#message-org.signal.chat.donations.CreateDonationPermitResponse">
+          <span class="tag" style="min-width: 6em">Message</span>
+          <code>CreateDonationPermitResponse</code> 
+        </a>
+      </p>
+      
+    
+      
       <p>
         <a href="#message-org.signal.chat.donations.RedeemReceiptRequest">
           <span class="tag" style="min-width: 6em">Message</span>
@@ -147,6 +165,27 @@
  until the expiration time on the receipt.</p></p>
   </div>
   
+</div>
+
+<div class="box">
+  <div class="block">
+    <h5 class="title is-5" id="service-org.signal.chat.donations.Donations-CreateDonationPermit">
+      <a href="#service-org.signal.chat.donations.Donations-CreateDonationPermit">
+        rpc <code>CreateDonationPermit</code>
+      </a>
+    </h5>
+    Request: <code><a href="org.signal.chat.donations.html#message-org.signal.chat.donations.CreateDonationPermitRequest"><span title="org.signal.chat.donations.CreateDonationPermitRequest">org.signal.chat.donations.CreateDonationPermitRequest</span>
+    </a></code><br>
+    Response: <code><a href="org.signal.chat.donations.html#message-org.signal.chat.donations.CreateDonationPermitResponse"><span title="org.signal.chat.donations.CreateDonationPermitResponse">org.signal.chat.donations.CreateDonationPermitResponse</span>
+    </a></code><br>
+  </div>
+
+  
+  <div class="block">
+    <p><p>Generate a set of anonymous, single-use, permits for use with /v1/subscription endpoints.</p>
+<p>If rate limited, reduce requested permit count and/or try again after the prescribed delay.</p></p>
+  </div>
+  
 </div>
  
     </div>
@@ -163,6 +202,106 @@
 
     
       
+      <div class="block">
+        
+
+<h4 class="title is-4 type-heading" id="message-org.signal.chat.donations.CreateDonationPermitRequest">
+  <span>
+    <a href="#message-org.signal.chat.donations.CreateDonationPermitRequest" title="org.signal.chat.donations.CreateDonationPermitRequest">message CreateDonationPermitRequest</a>
+  
+  </span>
+  
+</h4>
+
+<div class="block content">
+  
+</div>
+
+<table class="table is-fullwidth is-hoverable is-bordered">
+  <thead>
+    <tr>
+      <th></th>
+      <th>Field</th>
+      <th>Type</th>
+      <th>Description</th>
+      
+    </tr>
+  </thead>
+  <tbody>
+    
+    <tr>
+      <td>1</td>
+      <td>
+        donation_permit_request
+      </td>
+      <td>
+        <code title="bytes">
+          
+          <span>bytes</span>
+        </code>
+      </td>
+      <td class="content"><p>a serialized libsignal DonationPermitRequest</p></td>
+      
+    </tr>
+    
+    
+  </tbody>
+</table>
+ 
+      </div>
+      
+    
+      
+      <div class="block">
+        
+
+<h4 class="title is-4 type-heading" id="message-org.signal.chat.donations.CreateDonationPermitResponse">
+  <span>
+    <a href="#message-org.signal.chat.donations.CreateDonationPermitResponse" title="org.signal.chat.donations.CreateDonationPermitResponse">message CreateDonationPermitResponse</a>
+  
+  </span>
+  
+</h4>
+
+<div class="block content">
+  
+</div>
+
+<table class="table is-fullwidth is-hoverable is-bordered">
+  <thead>
+    <tr>
+      <th></th>
+      <th>Field</th>
+      <th>Type</th>
+      <th>Description</th>
+      
+    </tr>
+  </thead>
+  <tbody>
+    
+    <tr>
+      <td>1</td>
+      <td>
+        donation_permit_response
+      </td>
+      <td>
+        <code title="bytes">
+          
+          <span>bytes</span>
+        </code>
+      </td>
+      <td class="content"><p>a serialized libsignal DonationPermitResponse</p></td>
+      
+    </tr>
+    
+    
+  </tbody>
+</table>
+ 
+      </div>
+      
+    
+      
       <div class="block">
         
 

grpc/org.signal.chat.subscriptions.html

@@ -325,7 +325,7 @@
     
       
       <p>
-        <a href="#message-org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired">
+        <a href="#message-org.signal.chat.subscriptions.PaymentRequired">
           <span class="tag" style="min-width: 6em">Message</span>
           <code>PaymentRequired</code> 
         </a>
@@ -1630,7 +1630,7 @@ depending on which processor was used</p></td>
     <tr>
       <td>1</td>
       <td>
-        subscriberId
+        subscriber_id
       </td>
       <td>
         <code title="bytes">
@@ -1646,7 +1646,7 @@ other values will result in an INVALID_ARGUMENT error.</p></td>
     <tr>
       <td>2</td>
       <td>
-        paymentMethod
+        payment_method
       </td>
       <td>
         <code title="org.signal.chat.subscriptions.PaymentMethod">
@@ -1659,6 +1659,21 @@ other values will result in an INVALID_ARGUMENT error.</p></td>
       
     </tr>
     
+    <tr>
+      <td>3</td>
+      <td>
+        donation_permit
+      </td>
+      <td>
+        <code title="bytes">
+          
+          <span>bytes</span>
+        </code>
+      </td>
+      <td class="content"><p>a libsignal DonationPermit from rpc Donations.CreateDonationPermit</p></td>
+      
+    </tr>
+    
     
   </tbody>
 </table>
@@ -1785,6 +1800,26 @@ other values will result in an INVALID_ARGUMENT error.</p></td>
           
         </tr>
       
+        
+
+        <tr>
+          <td>
+            5
+          </td>
+          <td>
+            permit_rejected
+          </td>
+          <td>
+            <code title="org.signal.chat.errors.FailedZkAuthentication">
+              
+              <a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedZkAuthentication"><span title="org.signal.chat.errors.FailedZkAuthentication">org.signal.chat.errors.FailedZkAuthentication</span>
+    </a>
+            </code>
+          </td>
+          <td class="content"><p>The donation permit was expired or already spent</p></td>
+          
+        </tr>
+      
     
   </tbody>
 </table>
@@ -2562,9 +2597,9 @@ for display purposes only</p></td>
             payment_required
           </td>
           <td>
-            <code title="org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired">
+            <code title="org.signal.chat.subscriptions.PaymentRequired">
               
-              <a href="org.signal.chat.subscriptions.html#message-org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired"><span title="org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired">org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired</span>
+              <a href="org.signal.chat.subscriptions.html#message-org.signal.chat.subscriptions.PaymentRequired"><span title="org.signal.chat.subscriptions.PaymentRequired">org.signal.chat.subscriptions.PaymentRequired</span>
     </a>
             </code>
           </td>
@@ -2891,12 +2926,9 @@ for display purposes only</p></td>
       <div class="block">
         
 
-<h4 class="title is-4 type-heading" id="message-org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired">
+<h4 class="title is-4 type-heading" id="message-org.signal.chat.subscriptions.PaymentRequired">
   <span>
-    <a href="#message-org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired" title="org.signal.chat.subscriptions.GetReceiptCredentialsResponse.PaymentRequired">message PaymentRequired</a>
-  
-    <br /><span style="font-size: 0.7em; font-weight: normal">(Nested in <a href="org.signal.chat.subscriptions.html#message-org.signal.chat.subscriptions.GetReceiptCredentialsResponse"><span title="org.signal.chat.subscriptions.GetReceiptCredentialsResponse">org.signal.chat.subscriptions.GetReceiptCredentialsResponse</span>
-    </a>)</span>
+    <a href="#message-org.signal.chat.subscriptions.PaymentRequired" title="org.signal.chat.subscriptions.PaymentRequired">message PaymentRequired</a>
   
   </span>
   
@@ -4361,7 +4393,7 @@ for display purposes only</p></td>
     <tr>
       <td>1</td>
       <td>
-        subscriberId
+        subscriber_id
       </td>
       <td>
         <code title="bytes">
@@ -4373,6 +4405,22 @@ for display purposes only</p></td>
       
     </tr>
     
+    <tr>
+      <td>2</td>
+      <td>
+        donation_permit
+      </td>
+      <td>
+        <code title="bytes">
+          
+          <span>bytes</span>
+        </code>
+      </td>
+      <td class="content"><p>A libsignal DonationPermit from rpc Donations.CreateDonationPermit.
+Not required if the subscriber already exists.</p></td>
+      
+    </tr>
+    
     
   </tbody>
 </table>
@@ -4458,6 +4506,26 @@ for display purposes only</p></td>
           
         </tr>
       
+        
+
+        <tr>
+          <td>
+            3
+          </td>
+          <td>
+            permit_rejected
+          </td>
+          <td>
+            <code title="org.signal.chat.errors.FailedZkAuthentication">
+              
+              <a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedZkAuthentication"><span title="org.signal.chat.errors.FailedZkAuthentication">org.signal.chat.errors.FailedZkAuthentication</span>
+    </a>
+            </code>
+          </td>
+          <td class="content"><p>The donation permit was expired or already spent</p></td>
+          
+        </tr>
+      
     
   </tbody>
 </table>

signal-server-openapi.yaml

@@ -1324,6 +1324,11 @@ paths:
         schema:
           type: integer
           format: int64
+      - name: User-Agent
+        in: header
+        schema:
+          type: string
+          nullable: true
       responses:
         "200":
           description: "Success, response body includes upload form"
@@ -2667,6 +2672,11 @@ paths:
         Once the payment is complete, the paymentIntentId can be used at /v1/subscriptions/receipt_credentials
       operationId: createBoostPaymentIntent
       parameters:
+      - name: Donation-Permit
+        in: header
+        description: A base64-encoded donation permit retrieved from POST /v1/donation/permit
+        schema:
+          $ref: "#/components/schemas/DonationPermitHeader"
       - name: User-Agent
         in: header
         schema:
@@ -2699,6 +2709,8 @@ paths:
                 properties:
                   error:
                     type: string
+        "401":
+          description: Donation permit was invalid or already spent
       security:
       - authenticatedAccount: []
       - {}
@@ -3269,6 +3281,11 @@ paths:
       - Subscriptions
       operationId: createPaymentMethod
       parameters:
+      - name: Donation-Permit
+        in: header
+        description: A base64-encoded donation permit retrieved from POST /v1/donation/permit
+        schema:
+          $ref: "#/components/schemas/DonationPermitHeader"
       - name: subscriberId
         in: path
         required: true
@@ -3430,6 +3447,17 @@ paths:
         period of time will result in the subscription being canceled.
       operationId: updateSubscriber
       parameters:
+      - name: Donation-Permit
+        in: header
+        description: A base64-encoded donation permit retrieved from POST /v1/donation/permit.
+          Not required if the subscriber already exists.
+        schema:
+          $ref: "#/components/schemas/DonationPermitHeader"
+      - name: User-Agent
+        in: header
+        schema:
+          type: string
+          nullable: true
       - name: subscriberId
         in: path
         required: true
@@ -3438,6 +3466,8 @@ paths:
       responses:
         "200":
           description: The subscriber was successfully created or refreshed
+        "401":
+          description: Donation permit was invalid or already spent
         "403":
           description: subscriberId authentication failure OR account authentication
             is present
@@ -5661,6 +5691,23 @@ components:
         clientSecret:
           type: string
           description: A client secret that can be used to complete a stripe PaymentIntent
+    DonationPermit:
+      type: object
+      properties:
+        spendId:
+          type: string
+          format: byte
+        expiration:
+          type: string
+          format: date-time
+        internalContentsForJNI:
+          type: string
+          format: byte
+    DonationPermitHeader:
+      type: object
+      properties:
+        permit:
+          $ref: "#/components/schemas/DonationPermit"
     CreateBoostRequest:
       required:
       - amount