afternoon-sdk 0.0.6 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "afternoon-sdk",
-    "version": "0.0.6",
+    "version": "0.0.7",
     "private": false,
     "repository": "https://github.com/fern-demo/afternoon-ts-sdk",
     "type": "commonjs",

package/reference.md

@@ -326,9 +326,7 @@ await client.customers.updateACustomer({
 </dl>
 </details>
 
-## Events
-
-<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">ingestBillableEvents</a>({ ...params }) -> Afternoon.IngestResponse</code></summary>
+<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">listCustomerBalances</a>({ ...params }) -> Afternoon.CustomerBalancesResponse</code></summary>
 <dl>
 <dd>
 
@@ -340,7 +338,7 @@ await client.customers.updateACustomer({
 <dl>
 <dd>
 
-Accepts a batch of billable events for processing. Events are queued for async processing.
+Returns all wallet balances for a customer.
 
 </dd>
 </dl>
@@ -356,15 +354,8 @@ Accepts a batch of billable events for processing. Events are queued for async p
 <dd>
 
 ```typescript
-await client.events.ingestBillableEvents({
-    events: [
-        {
-            event_name: "api.request",
-            idempotency_key: "evt_abc123xyz",
-            customer_id: "cjld2cjxh0000qzrmn831i7rn",
-            timestamp: "2023-11-07T05:31:56Z",
-        },
-    ],
+await client.customers.listCustomerBalances({
+    id: "cm5x9z8nv0000h85r7l9p2k1m",
 });
 ```
 
@@ -381,7 +372,7 @@ await client.events.ingestBillableEvents({
 <dl>
 <dd>
 
-**request:** `Afternoon.IngestRequest`
+**request:** `Afternoon.GetV1CustomersIdBalancesRequest`
 
 </dd>
 </dl>
@@ -389,7 +380,7 @@ await client.events.ingestBillableEvents({
 <dl>
 <dd>
 
-**requestOptions:** `Events.RequestOptions`
+**requestOptions:** `Customers.RequestOptions`
 
 </dd>
 </dl>
@@ -400,7 +391,9 @@ await client.events.ingestBillableEvents({
 </dl>
 </details>
 
-<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">synchronouslyIngestBillableEvents</a>({ ...params }) -> Afternoon.InngestSyncResponse</code></summary>
+## Events
+
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">ingestBillableEvents</a>({ ...params }) -> Afternoon.InngestSyncResponse</code></summary>
 <dl>
 <dd>
 
@@ -428,7 +421,7 @@ Accepts a single billable event and inserts it synchronously into the database.
 <dd>
 
 ```typescript
-await client.events.synchronouslyIngestBillableEvents({
+await client.events.ingestBillableEvents({
     event_name: "api.request",
     idempotency_key: "evt_abc123xyz",
     customer_id: "cjld2cjxh0000qzrmn831i7rn",
@@ -667,7 +660,7 @@ await client.subscriptions.retrieveASubscription({
 </dl>
 </details>
 
-<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">deleteASubscription</a>({ ...params }) -> Afternoon.DeleteSubscriptionResponse</code></summary>
+<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">updateASubscription</a>({ ...params }) -> Afternoon.SubscriptionResponse</code></summary>
 <dl>
 <dd>
 
@@ -679,7 +672,7 @@ await client.subscriptions.retrieveASubscription({
 <dl>
 <dd>
 
-Permanently deletes a subscription by its ID.
+Updates an existing subscription. Only provided fields are changed. Setting status to "canceled" automatically sets canceled_at.
 
 </dd>
 </dl>
@@ -695,7 +688,7 @@ Permanently deletes a subscription by its ID.
 <dd>
 
 ```typescript
-await client.subscriptions.deleteASubscription({
+await client.subscriptions.updateASubscription({
     id: "cm5x9z8nv0000h85r7l9p2k1m",
 });
 ```
@@ -713,7 +706,7 @@ await client.subscriptions.deleteASubscription({
 <dl>
 <dd>
 
-**request:** `Afternoon.DeleteV1SubscriptionsIdRequest`
+**request:** `Afternoon.UpdateSubscriptionRequest`
 
 </dd>
 </dl>
@@ -732,7 +725,7 @@ await client.subscriptions.deleteASubscription({
 </dl>
 </details>
 
-<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">updateASubscription</a>({ ...params }) -> Afternoon.SubscriptionResponse</code></summary>
+<details><summary><code>client.subscriptions.<a href="/src/api/resources/subscriptions/client/Client.ts">cancelASubscription</a>({ ...params }) -> Afternoon.SubscriptionResponse</code></summary>
 <dl>
 <dd>
 
@@ -744,7 +737,7 @@ await client.subscriptions.deleteASubscription({
 <dl>
 <dd>
 
-Updates an existing subscription. Only provided fields are changed. Setting status to "canceled" automatically sets canceled_at.
+Cancels a subscription immediately or at the end of the current billing period.
 
 </dd>
 </dl>
@@ -760,8 +753,9 @@ Updates an existing subscription. Only provided fields are changed. Setting stat
 <dd>
 
 ```typescript
-await client.subscriptions.updateASubscription({
+await client.subscriptions.cancelASubscription({
     id: "cm5x9z8nv0000h85r7l9p2k1m",
+    cancel_mode: "now",
 });
 ```
 
@@ -778,7 +772,7 @@ await client.subscriptions.updateASubscription({
 <dl>
 <dd>
 
-**request:** `Afternoon.UpdateSubscriptionRequest`
+**request:** `Afternoon.CancelSubscriptionRequest`
 
 </dd>
 </dl>
@@ -811,7 +805,7 @@ await client.subscriptions.updateASubscription({
 <dl>
 <dd>
 
-Returns a paginated list of invoices. Supports optional customer_id, subscription_id, and status filters.
+Returns a paginated list of invoices. Supports optional customer_id, and status filters.
 
 </dd>
 </dl>
@@ -865,71 +859,6 @@ await client.invoices.listInvoices({
 </dl>
 </details>
 
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">createADraftInvoice</a>({ ...params }) -> Afternoon.InvoiceResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates a new draft invoice for a customer. The customer must belong to the authenticated company.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.createADraftInvoice({
-    customer_id: "cm5x9z8nv0001h85r7l9p2k2m",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.CreateInvoiceRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">retrieveAnInvoice</a>({ ...params }) -> Afternoon.InvoiceResponse</code></summary>
 <dl>
 <dd>
@@ -995,72 +924,9 @@ await client.invoices.retrieveAnInvoice({
 </dl>
 </details>
 
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">deleteADraftInvoice</a>({ ...params }) -> Afternoon.DeleteInvoiceResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Permanently deletes a draft invoice. Returns 422 if the invoice is not in draft status.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
+## SubscriptionSignupLinks
 
-<dl>
-<dd>
-
-```typescript
-await client.invoices.deleteADraftInvoice({
-    id: "cm5x9z8nv0000h85r7l9p2k1m",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.DeleteV1InvoicesIdRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">updateADraftInvoice</a>({ ...params }) -> Afternoon.InvoiceResponse</code></summary>
+<details><summary><code>client.subscriptionSignupLinks.<a href="/src/api/resources/subscriptionSignupLinks/client/Client.ts">createASubscriptionSignupLink</a>({ ...params }) -> Afternoon.SubscriptionSignupLinkResponse</code></summary>
 <dl>
 <dd>
 
@@ -1072,7 +938,7 @@ await client.invoices.deleteADraftInvoice({
 <dl>
 <dd>
 
-Updates a draft invoice. Only provided fields are changed. Returns 422 if the invoice is not in draft status.
+Generates a tokenised signup link that allows a specific customer to subscribe to a plan. The returned token can be appended to your subscribe page URL (e.g. /subscribe/{token}). The token expires after 24 hours.
 
 </dd>
 </dl>
@@ -1088,337 +954,9 @@ Updates a draft invoice. Only provided fields are changed. Returns 422 if the in
 <dd>
 
 ```typescript
-await client.invoices.updateADraftInvoice({
-    id: "cm5x9z8nv0000h85r7l9p2k1m",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.UpdateInvoiceRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">finalizeADraftInvoice</a>({ ...params }) -> Afternoon.InvoiceResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Transitions a draft invoice to open. Assigns an invoice number, sets finalizedAt, and recalculates totals. Requires at least one line item.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.finalizeADraftInvoice({
-    id: "cm5x9z8nv0000h85r7l9p2k1m",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.PostV1InvoicesIdFinalizeRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">voidAnOpenInvoice</a>({ ...params }) -> Afternoon.InvoiceResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Transitions an open invoice to void. Only open invoices can be voided.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.voidAnOpenInvoice({
-    id: "cm5x9z8nv0000h85r7l9p2k1m",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.PostV1InvoicesIdVoidRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">addALineItem</a>({ ...params }) -> Afternoon.LineItemResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Adds a line item to a draft invoice. Recalculates invoice totals.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.addALineItem({
-    id: "cm5x9z8nv0000h85r7l9p2k1m",
-    quantity: 1,
-    unit_amount_cents: 5000,
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.CreateLineItemRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">removeALineItem</a>({ ...params }) -> Afternoon.DeleteLineItemResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Removes a line item from a draft invoice. Recalculates invoice totals.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.removeALineItem({
-    id: "id",
-    lineId: "lineId",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Afternoon.DeleteV1InvoicesIdLineItemsLineIdRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Invoices.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.invoices.<a href="/src/api/resources/invoices/client/Client.ts">updateALineItem</a>({ ...params }) -> Afternoon.LineItemResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Updates a line item on a draft invoice. Recalculates invoice totals.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.invoices.updateALineItem({
-    id: "id",
-    lineId: "lineId",
+await client.subscriptionSignupLinks.createASubscriptionSignupLink({
+    customer_id: "cm5x9z8nv0001h85r7l9p2k2m",
+    plan_id: "cm5x9z8nv0002h85r7l9p2k3m",
 });
 ```
 
@@ -1435,7 +973,7 @@ await client.invoices.updateALineItem({
 <dl>
 <dd>
 
-**request:** `Afternoon.UpdateLineItemRequest`
+**request:** `Afternoon.CreateSubscriptionSignupLinkRequest`
 
 </dd>
 </dl>
@@ -1443,7 +981,7 @@ await client.invoices.updateALineItem({
 <dl>
 <dd>
 
-**requestOptions:** `Invoices.RequestOptions`
+**requestOptions:** `SubscriptionSignupLinks.RequestOptions`
 
 </dd>
 </dl>