@paid-ai/paid-node 1.2.0 → 1.3.0
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/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +12 -2
- package/dist/cjs/api/errors/ConflictError.d.ts +6 -0
- package/dist/cjs/api/errors/ConflictError.js +50 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/checkouts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/checkouts/client/requests/CreateCheckoutRequest.d.ts +2 -0
- package/dist/cjs/api/resources/customers/client/Client.d.ts +21 -0
- package/dist/cjs/api/resources/customers/client/Client.js +92 -0
- package/dist/cjs/api/resources/customers/client/requests/UpsertCustomerUserRequest.d.ts +16 -0
- package/dist/cjs/api/resources/customers/client/requests/UpsertCustomerUserRequest.js +3 -0
- package/dist/cjs/api/resources/customers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.d.ts +6 -0
- package/dist/cjs/api/resources/index.js +7 -1
- package/dist/cjs/api/resources/orders/client/Client.d.ts +60 -0
- package/dist/cjs/api/resources/orders/client/Client.js +242 -0
- package/dist/cjs/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.d.ts +22 -0
- package/dist/cjs/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/ListOrderSeatsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/orders/client/requests/ListOrderSeatsRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.d.ts +12 -0
- package/dist/cjs/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.js +3 -0
- package/dist/cjs/api/resources/orders/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/index.js +1 -0
- package/dist/cjs/api/resources/orders/types/ListOrderSeatsRequestStatus.d.ts +5 -0
- package/dist/cjs/api/resources/orders/types/ListOrderSeatsRequestStatus.js +8 -0
- package/dist/cjs/api/resources/orders/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/types/index.js +17 -0
- package/dist/cjs/api/resources/valueReceipts/client/Client.d.ts +75 -0
- package/dist/cjs/api/resources/valueReceipts/client/Client.js +347 -0
- package/dist/cjs/api/resources/valueReceipts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/client/index.js +17 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.d.ts +10 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.d.ts +9 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.js +3 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/valueReceipts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/valueReceipts/index.d.ts +1 -0
- package/dist/cjs/api/resources/valueReceipts/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +63 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +282 -0
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.ts +14 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/index.js +18 -0
- package/dist/cjs/api/resources/webhooks/types/TestWebhookRequestWebhookName.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/TestWebhookRequestWebhookName.js +15 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.js +15 -0
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +18 -0
- package/dist/cjs/api/types/BatchSeatAssignmentsResponse.d.ts +4 -0
- package/dist/cjs/api/types/BatchSeatAssignmentsResponse.js +3 -0
- package/dist/cjs/api/types/Checkout.d.ts +1 -0
- package/dist/cjs/api/types/CheckoutDetails.d.ts +21 -0
- package/dist/cjs/api/types/CheckoutDetails.js +3 -0
- package/dist/cjs/api/types/CustomerUser.d.ts +13 -0
- package/dist/cjs/api/types/CustomerUser.js +3 -0
- package/dist/cjs/api/types/CustomerUserStatus.d.ts +5 -0
- package/dist/cjs/api/types/CustomerUserStatus.js +8 -0
- package/dist/cjs/api/types/OrderSeat.d.ts +10 -0
- package/dist/cjs/api/types/OrderSeat.js +3 -0
- package/dist/cjs/api/types/OrderSeatListResponse.d.ts +5 -0
- package/dist/cjs/api/types/OrderSeatListResponse.js +3 -0
- package/dist/cjs/api/types/SeatAssignee.d.ts +5 -0
- package/dist/cjs/api/types/SeatAssignee.js +3 -0
- package/dist/cjs/api/types/SeatAssignmentStatus.d.ts +5 -0
- package/dist/cjs/api/types/SeatAssignmentStatus.js +8 -0
- package/dist/cjs/api/types/ValueReceiptDetail.d.ts +19 -0
- package/dist/cjs/api/types/ValueReceiptDetail.js +3 -0
- package/dist/cjs/api/types/ValueReceiptListResponse.d.ts +5 -0
- package/dist/cjs/api/types/ValueReceiptListResponse.js +3 -0
- package/dist/cjs/api/types/ValueReceiptSummary.d.ts +16 -0
- package/dist/cjs/api/types/ValueReceiptSummary.js +3 -0
- package/dist/cjs/api/types/Webhook.d.ts +24 -0
- package/dist/cjs/api/types/Webhook.js +18 -0
- package/dist/cjs/api/types/WebhookDeliveryStatus.d.ts +5 -0
- package/dist/cjs/api/types/WebhookDeliveryStatus.js +8 -0
- package/dist/cjs/api/types/WebhookListResponse.d.ts +4 -0
- package/dist/cjs/api/types/WebhookListResponse.js +3 -0
- package/dist/cjs/api/types/WebhookTestResponse.d.ts +3 -0
- package/dist/cjs/api/types/WebhookTestResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +15 -0
- package/dist/cjs/api/types/index.js +15 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +12 -2
- package/dist/esm/api/errors/ConflictError.d.mts +6 -0
- package/dist/esm/api/errors/ConflictError.mjs +13 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/checkouts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/checkouts/client/requests/CreateCheckoutRequest.d.mts +2 -0
- package/dist/esm/api/resources/customers/client/Client.d.mts +21 -0
- package/dist/esm/api/resources/customers/client/Client.mjs +92 -0
- package/dist/esm/api/resources/customers/client/requests/UpsertCustomerUserRequest.d.mts +16 -0
- package/dist/esm/api/resources/customers/client/requests/UpsertCustomerUserRequest.mjs +2 -0
- package/dist/esm/api/resources/customers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/index.d.mts +6 -0
- package/dist/esm/api/resources/index.mjs +6 -0
- package/dist/esm/api/resources/orders/client/Client.d.mts +60 -0
- package/dist/esm/api/resources/orders/client/Client.mjs +242 -0
- package/dist/esm/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.d.mts +22 -0
- package/dist/esm/api/resources/orders/client/requests/BatchSeatAssignmentsRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/ListOrderSeatsRequest.d.mts +14 -0
- package/dist/esm/api/resources/orders/client/requests/ListOrderSeatsRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.d.mts +12 -0
- package/dist/esm/api/resources/orders/client/requests/UpdateSeatAssignmentRequest.mjs +2 -0
- package/dist/esm/api/resources/orders/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/orders/types/ListOrderSeatsRequestStatus.d.mts +5 -0
- package/dist/esm/api/resources/orders/types/ListOrderSeatsRequestStatus.mjs +5 -0
- package/dist/esm/api/resources/orders/types/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/types/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.d.mts +75 -0
- package/dist/esm/api/resources/valueReceipts/client/Client.mjs +310 -0
- package/dist/esm/api/resources/valueReceipts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/client/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/GetValueReceiptByIdRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.d.mts +10 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/ListValueReceiptsRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.d.mts +10 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.d.mts +9 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/UnpublishValueReceiptRequest.mjs +2 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/valueReceipts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/valueReceipts/index.d.mts +1 -0
- package/dist/esm/api/resources/valueReceipts/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +63 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +245 -0
- package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.mts +14 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/index.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.mjs +12 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.mjs +12 -0
- package/dist/esm/api/resources/webhooks/types/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +2 -0
- package/dist/esm/api/types/BatchSeatAssignmentsResponse.d.mts +4 -0
- package/dist/esm/api/types/BatchSeatAssignmentsResponse.mjs +2 -0
- package/dist/esm/api/types/Checkout.d.mts +1 -0
- package/dist/esm/api/types/CheckoutDetails.d.mts +21 -0
- package/dist/esm/api/types/CheckoutDetails.mjs +2 -0
- package/dist/esm/api/types/CustomerUser.d.mts +13 -0
- package/dist/esm/api/types/CustomerUser.mjs +2 -0
- package/dist/esm/api/types/CustomerUserStatus.d.mts +5 -0
- package/dist/esm/api/types/CustomerUserStatus.mjs +5 -0
- package/dist/esm/api/types/OrderSeat.d.mts +10 -0
- package/dist/esm/api/types/OrderSeat.mjs +2 -0
- package/dist/esm/api/types/OrderSeatListResponse.d.mts +5 -0
- package/dist/esm/api/types/OrderSeatListResponse.mjs +2 -0
- package/dist/esm/api/types/SeatAssignee.d.mts +5 -0
- package/dist/esm/api/types/SeatAssignee.mjs +2 -0
- package/dist/esm/api/types/SeatAssignmentStatus.d.mts +5 -0
- package/dist/esm/api/types/SeatAssignmentStatus.mjs +5 -0
- package/dist/esm/api/types/ValueReceiptDetail.d.mts +19 -0
- package/dist/esm/api/types/ValueReceiptDetail.mjs +2 -0
- package/dist/esm/api/types/ValueReceiptListResponse.d.mts +5 -0
- package/dist/esm/api/types/ValueReceiptListResponse.mjs +2 -0
- package/dist/esm/api/types/ValueReceiptSummary.d.mts +16 -0
- package/dist/esm/api/types/ValueReceiptSummary.mjs +2 -0
- package/dist/esm/api/types/Webhook.d.mts +24 -0
- package/dist/esm/api/types/Webhook.mjs +15 -0
- package/dist/esm/api/types/WebhookDeliveryStatus.d.mts +5 -0
- package/dist/esm/api/types/WebhookDeliveryStatus.mjs +5 -0
- package/dist/esm/api/types/WebhookListResponse.d.mts +4 -0
- package/dist/esm/api/types/WebhookListResponse.mjs +2 -0
- package/dist/esm/api/types/WebhookTestResponse.d.mts +3 -0
- package/dist/esm/api/types/WebhookTestResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +15 -0
- package/dist/esm/api/types/index.mjs +15 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +711 -1
package/reference.md
CHANGED
|
@@ -1037,6 +1037,72 @@ await client.customers.getCustomerCreditBalancesByExternalId({
|
|
|
1037
1037
|
</dl>
|
|
1038
1038
|
|
|
1039
1039
|
|
|
1040
|
+
</dd>
|
|
1041
|
+
</dl>
|
|
1042
|
+
</details>
|
|
1043
|
+
|
|
1044
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">upsertCustomerUserByExternalId</a>({ ...params }) -> Paid.CustomerUser</code></summary>
|
|
1045
|
+
<dl>
|
|
1046
|
+
<dd>
|
|
1047
|
+
|
|
1048
|
+
#### 📝 Description
|
|
1049
|
+
|
|
1050
|
+
<dl>
|
|
1051
|
+
<dd>
|
|
1052
|
+
|
|
1053
|
+
<dl>
|
|
1054
|
+
<dd>
|
|
1055
|
+
|
|
1056
|
+
Create or update a customer user using customer and user external IDs
|
|
1057
|
+
</dd>
|
|
1058
|
+
</dl>
|
|
1059
|
+
</dd>
|
|
1060
|
+
</dl>
|
|
1061
|
+
|
|
1062
|
+
#### 🔌 Usage
|
|
1063
|
+
|
|
1064
|
+
<dl>
|
|
1065
|
+
<dd>
|
|
1066
|
+
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
```typescript
|
|
1071
|
+
await client.customers.upsertCustomerUserByExternalId({
|
|
1072
|
+
customerExternalId: "customerExternalId",
|
|
1073
|
+
userExternalId: "userExternalId"
|
|
1074
|
+
});
|
|
1075
|
+
|
|
1076
|
+
```
|
|
1077
|
+
</dd>
|
|
1078
|
+
</dl>
|
|
1079
|
+
</dd>
|
|
1080
|
+
</dl>
|
|
1081
|
+
|
|
1082
|
+
#### ⚙️ Parameters
|
|
1083
|
+
|
|
1084
|
+
<dl>
|
|
1085
|
+
<dd>
|
|
1086
|
+
|
|
1087
|
+
<dl>
|
|
1088
|
+
<dd>
|
|
1089
|
+
|
|
1090
|
+
**request:** `Paid.UpsertCustomerUserRequest`
|
|
1091
|
+
|
|
1092
|
+
</dd>
|
|
1093
|
+
</dl>
|
|
1094
|
+
|
|
1095
|
+
<dl>
|
|
1096
|
+
<dd>
|
|
1097
|
+
|
|
1098
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
1099
|
+
|
|
1100
|
+
</dd>
|
|
1101
|
+
</dl>
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
|
|
1105
|
+
|
|
1040
1106
|
</dd>
|
|
1041
1107
|
</dl>
|
|
1042
1108
|
</details>
|
|
@@ -1948,6 +2014,205 @@ await client.orders.getOrderLines({
|
|
|
1948
2014
|
</dl>
|
|
1949
2015
|
|
|
1950
2016
|
|
|
2017
|
+
</dd>
|
|
2018
|
+
</dl>
|
|
2019
|
+
</details>
|
|
2020
|
+
|
|
2021
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listOrderSeats</a>({ ...params }) -> Paid.OrderSeatListResponse</code></summary>
|
|
2022
|
+
<dl>
|
|
2023
|
+
<dd>
|
|
2024
|
+
|
|
2025
|
+
#### 📝 Description
|
|
2026
|
+
|
|
2027
|
+
<dl>
|
|
2028
|
+
<dd>
|
|
2029
|
+
|
|
2030
|
+
<dl>
|
|
2031
|
+
<dd>
|
|
2032
|
+
|
|
2033
|
+
List seats for an order
|
|
2034
|
+
</dd>
|
|
2035
|
+
</dl>
|
|
2036
|
+
</dd>
|
|
2037
|
+
</dl>
|
|
2038
|
+
|
|
2039
|
+
#### 🔌 Usage
|
|
2040
|
+
|
|
2041
|
+
<dl>
|
|
2042
|
+
<dd>
|
|
2043
|
+
|
|
2044
|
+
<dl>
|
|
2045
|
+
<dd>
|
|
2046
|
+
|
|
2047
|
+
```typescript
|
|
2048
|
+
await client.orders.listOrderSeats({
|
|
2049
|
+
id: "id"
|
|
2050
|
+
});
|
|
2051
|
+
|
|
2052
|
+
```
|
|
2053
|
+
</dd>
|
|
2054
|
+
</dl>
|
|
2055
|
+
</dd>
|
|
2056
|
+
</dl>
|
|
2057
|
+
|
|
2058
|
+
#### ⚙️ Parameters
|
|
2059
|
+
|
|
2060
|
+
<dl>
|
|
2061
|
+
<dd>
|
|
2062
|
+
|
|
2063
|
+
<dl>
|
|
2064
|
+
<dd>
|
|
2065
|
+
|
|
2066
|
+
**request:** `Paid.ListOrderSeatsRequest`
|
|
2067
|
+
|
|
2068
|
+
</dd>
|
|
2069
|
+
</dl>
|
|
2070
|
+
|
|
2071
|
+
<dl>
|
|
2072
|
+
<dd>
|
|
2073
|
+
|
|
2074
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2075
|
+
|
|
2076
|
+
</dd>
|
|
2077
|
+
</dl>
|
|
2078
|
+
</dd>
|
|
2079
|
+
</dl>
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
</dd>
|
|
2083
|
+
</dl>
|
|
2084
|
+
</details>
|
|
2085
|
+
|
|
2086
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">updateOrderSeatAssignment</a>({ ...params }) -> Paid.OrderSeat</code></summary>
|
|
2087
|
+
<dl>
|
|
2088
|
+
<dd>
|
|
2089
|
+
|
|
2090
|
+
#### 📝 Description
|
|
2091
|
+
|
|
2092
|
+
<dl>
|
|
2093
|
+
<dd>
|
|
2094
|
+
|
|
2095
|
+
<dl>
|
|
2096
|
+
<dd>
|
|
2097
|
+
|
|
2098
|
+
Assign or unassign a single seat on an order
|
|
2099
|
+
</dd>
|
|
2100
|
+
</dl>
|
|
2101
|
+
</dd>
|
|
2102
|
+
</dl>
|
|
2103
|
+
|
|
2104
|
+
#### 🔌 Usage
|
|
2105
|
+
|
|
2106
|
+
<dl>
|
|
2107
|
+
<dd>
|
|
2108
|
+
|
|
2109
|
+
<dl>
|
|
2110
|
+
<dd>
|
|
2111
|
+
|
|
2112
|
+
```typescript
|
|
2113
|
+
await client.orders.updateOrderSeatAssignment({
|
|
2114
|
+
id: "id",
|
|
2115
|
+
seatId: "seatId"
|
|
2116
|
+
});
|
|
2117
|
+
|
|
2118
|
+
```
|
|
2119
|
+
</dd>
|
|
2120
|
+
</dl>
|
|
2121
|
+
</dd>
|
|
2122
|
+
</dl>
|
|
2123
|
+
|
|
2124
|
+
#### ⚙️ Parameters
|
|
2125
|
+
|
|
2126
|
+
<dl>
|
|
2127
|
+
<dd>
|
|
2128
|
+
|
|
2129
|
+
<dl>
|
|
2130
|
+
<dd>
|
|
2131
|
+
|
|
2132
|
+
**request:** `Paid.UpdateSeatAssignmentRequest`
|
|
2133
|
+
|
|
2134
|
+
</dd>
|
|
2135
|
+
</dl>
|
|
2136
|
+
|
|
2137
|
+
<dl>
|
|
2138
|
+
<dd>
|
|
2139
|
+
|
|
2140
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2141
|
+
|
|
2142
|
+
</dd>
|
|
2143
|
+
</dl>
|
|
2144
|
+
</dd>
|
|
2145
|
+
</dl>
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
</details>
|
|
2151
|
+
|
|
2152
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">batchOrderSeatAssignments</a>({ ...params }) -> Paid.BatchSeatAssignmentsResponse</code></summary>
|
|
2153
|
+
<dl>
|
|
2154
|
+
<dd>
|
|
2155
|
+
|
|
2156
|
+
#### 📝 Description
|
|
2157
|
+
|
|
2158
|
+
<dl>
|
|
2159
|
+
<dd>
|
|
2160
|
+
|
|
2161
|
+
<dl>
|
|
2162
|
+
<dd>
|
|
2163
|
+
|
|
2164
|
+
Assign or unassign seats in batch for an order
|
|
2165
|
+
</dd>
|
|
2166
|
+
</dl>
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
#### 🔌 Usage
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
<dl>
|
|
2176
|
+
<dd>
|
|
2177
|
+
|
|
2178
|
+
```typescript
|
|
2179
|
+
await client.orders.batchOrderSeatAssignments({
|
|
2180
|
+
id: "id",
|
|
2181
|
+
assignments: [{
|
|
2182
|
+
seatId: "seatId"
|
|
2183
|
+
}]
|
|
2184
|
+
});
|
|
2185
|
+
|
|
2186
|
+
```
|
|
2187
|
+
</dd>
|
|
2188
|
+
</dl>
|
|
2189
|
+
</dd>
|
|
2190
|
+
</dl>
|
|
2191
|
+
|
|
2192
|
+
#### ⚙️ Parameters
|
|
2193
|
+
|
|
2194
|
+
<dl>
|
|
2195
|
+
<dd>
|
|
2196
|
+
|
|
2197
|
+
<dl>
|
|
2198
|
+
<dd>
|
|
2199
|
+
|
|
2200
|
+
**request:** `Paid.BatchSeatAssignmentsRequest`
|
|
2201
|
+
|
|
2202
|
+
</dd>
|
|
2203
|
+
</dl>
|
|
2204
|
+
|
|
2205
|
+
<dl>
|
|
2206
|
+
<dd>
|
|
2207
|
+
|
|
2208
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
2209
|
+
|
|
2210
|
+
</dd>
|
|
2211
|
+
</dl>
|
|
2212
|
+
</dd>
|
|
2213
|
+
</dl>
|
|
2214
|
+
|
|
2215
|
+
|
|
1951
2216
|
</dd>
|
|
1952
2217
|
</dl>
|
|
1953
2218
|
</details>
|
|
@@ -2470,7 +2735,7 @@ await client.checkouts.createCheckout({
|
|
|
2470
2735
|
</dl>
|
|
2471
2736
|
</details>
|
|
2472
2737
|
|
|
2473
|
-
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">getCheckout</a>({ ...params }) -> Paid.
|
|
2738
|
+
<details><summary><code>client.checkouts.<a href="/src/api/resources/checkouts/client/Client.ts">getCheckout</a>({ ...params }) -> Paid.CheckoutDetails</code></summary>
|
|
2474
2739
|
<dl>
|
|
2475
2740
|
<dd>
|
|
2476
2741
|
|
|
@@ -2660,6 +2925,451 @@ await client.customerPortals.createCustomerPortal();
|
|
|
2660
2925
|
</dl>
|
|
2661
2926
|
|
|
2662
2927
|
|
|
2928
|
+
</dd>
|
|
2929
|
+
</dl>
|
|
2930
|
+
</details>
|
|
2931
|
+
|
|
2932
|
+
## ValueReceipts
|
|
2933
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">listValueReceipts</a>({ ...params }) -> Paid.ValueReceiptListResponse</code></summary>
|
|
2934
|
+
<dl>
|
|
2935
|
+
<dd>
|
|
2936
|
+
|
|
2937
|
+
#### 📝 Description
|
|
2938
|
+
|
|
2939
|
+
<dl>
|
|
2940
|
+
<dd>
|
|
2941
|
+
|
|
2942
|
+
<dl>
|
|
2943
|
+
<dd>
|
|
2944
|
+
|
|
2945
|
+
List value receipts for the organization
|
|
2946
|
+
</dd>
|
|
2947
|
+
</dl>
|
|
2948
|
+
</dd>
|
|
2949
|
+
</dl>
|
|
2950
|
+
|
|
2951
|
+
#### 🔌 Usage
|
|
2952
|
+
|
|
2953
|
+
<dl>
|
|
2954
|
+
<dd>
|
|
2955
|
+
|
|
2956
|
+
<dl>
|
|
2957
|
+
<dd>
|
|
2958
|
+
|
|
2959
|
+
```typescript
|
|
2960
|
+
await client.valueReceipts.listValueReceipts();
|
|
2961
|
+
|
|
2962
|
+
```
|
|
2963
|
+
</dd>
|
|
2964
|
+
</dl>
|
|
2965
|
+
</dd>
|
|
2966
|
+
</dl>
|
|
2967
|
+
|
|
2968
|
+
#### ⚙️ Parameters
|
|
2969
|
+
|
|
2970
|
+
<dl>
|
|
2971
|
+
<dd>
|
|
2972
|
+
|
|
2973
|
+
<dl>
|
|
2974
|
+
<dd>
|
|
2975
|
+
|
|
2976
|
+
**request:** `Paid.ListValueReceiptsRequest`
|
|
2977
|
+
|
|
2978
|
+
</dd>
|
|
2979
|
+
</dl>
|
|
2980
|
+
|
|
2981
|
+
<dl>
|
|
2982
|
+
<dd>
|
|
2983
|
+
|
|
2984
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
2985
|
+
|
|
2986
|
+
</dd>
|
|
2987
|
+
</dl>
|
|
2988
|
+
</dd>
|
|
2989
|
+
</dl>
|
|
2990
|
+
|
|
2991
|
+
|
|
2992
|
+
</dd>
|
|
2993
|
+
</dl>
|
|
2994
|
+
</details>
|
|
2995
|
+
|
|
2996
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">getValueReceiptById</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
2997
|
+
<dl>
|
|
2998
|
+
<dd>
|
|
2999
|
+
|
|
3000
|
+
#### 📝 Description
|
|
3001
|
+
|
|
3002
|
+
<dl>
|
|
3003
|
+
<dd>
|
|
3004
|
+
|
|
3005
|
+
<dl>
|
|
3006
|
+
<dd>
|
|
3007
|
+
|
|
3008
|
+
Get a value receipt by ID, including its publish/share state.
|
|
3009
|
+
</dd>
|
|
3010
|
+
</dl>
|
|
3011
|
+
</dd>
|
|
3012
|
+
</dl>
|
|
3013
|
+
|
|
3014
|
+
#### 🔌 Usage
|
|
3015
|
+
|
|
3016
|
+
<dl>
|
|
3017
|
+
<dd>
|
|
3018
|
+
|
|
3019
|
+
<dl>
|
|
3020
|
+
<dd>
|
|
3021
|
+
|
|
3022
|
+
```typescript
|
|
3023
|
+
await client.valueReceipts.getValueReceiptById({
|
|
3024
|
+
id: "id"
|
|
3025
|
+
});
|
|
3026
|
+
|
|
3027
|
+
```
|
|
3028
|
+
</dd>
|
|
3029
|
+
</dl>
|
|
3030
|
+
</dd>
|
|
3031
|
+
</dl>
|
|
3032
|
+
|
|
3033
|
+
#### ⚙️ Parameters
|
|
3034
|
+
|
|
3035
|
+
<dl>
|
|
3036
|
+
<dd>
|
|
3037
|
+
|
|
3038
|
+
<dl>
|
|
3039
|
+
<dd>
|
|
3040
|
+
|
|
3041
|
+
**request:** `Paid.GetValueReceiptByIdRequest`
|
|
3042
|
+
|
|
3043
|
+
</dd>
|
|
3044
|
+
</dl>
|
|
3045
|
+
|
|
3046
|
+
<dl>
|
|
3047
|
+
<dd>
|
|
3048
|
+
|
|
3049
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3050
|
+
|
|
3051
|
+
</dd>
|
|
3052
|
+
</dl>
|
|
3053
|
+
</dd>
|
|
3054
|
+
</dl>
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
</dd>
|
|
3058
|
+
</dl>
|
|
3059
|
+
</details>
|
|
3060
|
+
|
|
3061
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">publishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
3062
|
+
<dl>
|
|
3063
|
+
<dd>
|
|
3064
|
+
|
|
3065
|
+
#### 📝 Description
|
|
3066
|
+
|
|
3067
|
+
<dl>
|
|
3068
|
+
<dd>
|
|
3069
|
+
|
|
3070
|
+
<dl>
|
|
3071
|
+
<dd>
|
|
3072
|
+
|
|
3073
|
+
Make a value receipt publicly accessible via URL.
|
|
3074
|
+
</dd>
|
|
3075
|
+
</dl>
|
|
3076
|
+
</dd>
|
|
3077
|
+
</dl>
|
|
3078
|
+
|
|
3079
|
+
#### 🔌 Usage
|
|
3080
|
+
|
|
3081
|
+
<dl>
|
|
3082
|
+
<dd>
|
|
3083
|
+
|
|
3084
|
+
<dl>
|
|
3085
|
+
<dd>
|
|
3086
|
+
|
|
3087
|
+
```typescript
|
|
3088
|
+
await client.valueReceipts.publishValueReceipt({
|
|
3089
|
+
id: "id"
|
|
3090
|
+
});
|
|
3091
|
+
|
|
3092
|
+
```
|
|
3093
|
+
</dd>
|
|
3094
|
+
</dl>
|
|
3095
|
+
</dd>
|
|
3096
|
+
</dl>
|
|
3097
|
+
|
|
3098
|
+
#### ⚙️ Parameters
|
|
3099
|
+
|
|
3100
|
+
<dl>
|
|
3101
|
+
<dd>
|
|
3102
|
+
|
|
3103
|
+
<dl>
|
|
3104
|
+
<dd>
|
|
3105
|
+
|
|
3106
|
+
**request:** `Paid.PublishValueReceiptBody`
|
|
3107
|
+
|
|
3108
|
+
</dd>
|
|
3109
|
+
</dl>
|
|
3110
|
+
|
|
3111
|
+
<dl>
|
|
3112
|
+
<dd>
|
|
3113
|
+
|
|
3114
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3115
|
+
|
|
3116
|
+
</dd>
|
|
3117
|
+
</dl>
|
|
3118
|
+
</dd>
|
|
3119
|
+
</dl>
|
|
3120
|
+
|
|
3121
|
+
|
|
3122
|
+
</dd>
|
|
3123
|
+
</dl>
|
|
3124
|
+
</details>
|
|
3125
|
+
|
|
3126
|
+
<details><summary><code>client.valueReceipts.<a href="/src/api/resources/valueReceipts/client/Client.ts">unpublishValueReceipt</a>({ ...params }) -> Paid.ValueReceiptDetail</code></summary>
|
|
3127
|
+
<dl>
|
|
3128
|
+
<dd>
|
|
3129
|
+
|
|
3130
|
+
#### 📝 Description
|
|
3131
|
+
|
|
3132
|
+
<dl>
|
|
3133
|
+
<dd>
|
|
3134
|
+
|
|
3135
|
+
<dl>
|
|
3136
|
+
<dd>
|
|
3137
|
+
|
|
3138
|
+
Revoke public access to a value receipt.
|
|
3139
|
+
</dd>
|
|
3140
|
+
</dl>
|
|
3141
|
+
</dd>
|
|
3142
|
+
</dl>
|
|
3143
|
+
|
|
3144
|
+
#### 🔌 Usage
|
|
3145
|
+
|
|
3146
|
+
<dl>
|
|
3147
|
+
<dd>
|
|
3148
|
+
|
|
3149
|
+
<dl>
|
|
3150
|
+
<dd>
|
|
3151
|
+
|
|
3152
|
+
```typescript
|
|
3153
|
+
await client.valueReceipts.unpublishValueReceipt({
|
|
3154
|
+
id: "id"
|
|
3155
|
+
});
|
|
3156
|
+
|
|
3157
|
+
```
|
|
3158
|
+
</dd>
|
|
3159
|
+
</dl>
|
|
3160
|
+
</dd>
|
|
3161
|
+
</dl>
|
|
3162
|
+
|
|
3163
|
+
#### ⚙️ Parameters
|
|
3164
|
+
|
|
3165
|
+
<dl>
|
|
3166
|
+
<dd>
|
|
3167
|
+
|
|
3168
|
+
<dl>
|
|
3169
|
+
<dd>
|
|
3170
|
+
|
|
3171
|
+
**request:** `Paid.UnpublishValueReceiptRequest`
|
|
3172
|
+
|
|
3173
|
+
</dd>
|
|
3174
|
+
</dl>
|
|
3175
|
+
|
|
3176
|
+
<dl>
|
|
3177
|
+
<dd>
|
|
3178
|
+
|
|
3179
|
+
**requestOptions:** `ValueReceipts.RequestOptions`
|
|
3180
|
+
|
|
3181
|
+
</dd>
|
|
3182
|
+
</dl>
|
|
3183
|
+
</dd>
|
|
3184
|
+
</dl>
|
|
3185
|
+
|
|
3186
|
+
|
|
3187
|
+
</dd>
|
|
3188
|
+
</dl>
|
|
3189
|
+
</details>
|
|
3190
|
+
|
|
3191
|
+
## Webhooks
|
|
3192
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooks</a>() -> Paid.WebhookListResponse</code></summary>
|
|
3193
|
+
<dl>
|
|
3194
|
+
<dd>
|
|
3195
|
+
|
|
3196
|
+
#### 📝 Description
|
|
3197
|
+
|
|
3198
|
+
<dl>
|
|
3199
|
+
<dd>
|
|
3200
|
+
|
|
3201
|
+
<dl>
|
|
3202
|
+
<dd>
|
|
3203
|
+
|
|
3204
|
+
List customer-facing billing webhooks for the authenticated organization.
|
|
3205
|
+
</dd>
|
|
3206
|
+
</dl>
|
|
3207
|
+
</dd>
|
|
3208
|
+
</dl>
|
|
3209
|
+
|
|
3210
|
+
#### 🔌 Usage
|
|
3211
|
+
|
|
3212
|
+
<dl>
|
|
3213
|
+
<dd>
|
|
3214
|
+
|
|
3215
|
+
<dl>
|
|
3216
|
+
<dd>
|
|
3217
|
+
|
|
3218
|
+
```typescript
|
|
3219
|
+
await client.webhooks.listWebhooks();
|
|
3220
|
+
|
|
3221
|
+
```
|
|
3222
|
+
</dd>
|
|
3223
|
+
</dl>
|
|
3224
|
+
</dd>
|
|
3225
|
+
</dl>
|
|
3226
|
+
|
|
3227
|
+
#### ⚙️ Parameters
|
|
3228
|
+
|
|
3229
|
+
<dl>
|
|
3230
|
+
<dd>
|
|
3231
|
+
|
|
3232
|
+
<dl>
|
|
3233
|
+
<dd>
|
|
3234
|
+
|
|
3235
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3236
|
+
|
|
3237
|
+
</dd>
|
|
3238
|
+
</dl>
|
|
3239
|
+
</dd>
|
|
3240
|
+
</dl>
|
|
3241
|
+
|
|
3242
|
+
|
|
3243
|
+
</dd>
|
|
3244
|
+
</dl>
|
|
3245
|
+
</details>
|
|
3246
|
+
|
|
3247
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateWebhook</a>({ ...params }) -> Paid.Webhook</code></summary>
|
|
3248
|
+
<dl>
|
|
3249
|
+
<dd>
|
|
3250
|
+
|
|
3251
|
+
#### 📝 Description
|
|
3252
|
+
|
|
3253
|
+
<dl>
|
|
3254
|
+
<dd>
|
|
3255
|
+
|
|
3256
|
+
<dl>
|
|
3257
|
+
<dd>
|
|
3258
|
+
|
|
3259
|
+
Enable or disable a webhook and configure the destination URL for the authenticated organization.
|
|
3260
|
+
</dd>
|
|
3261
|
+
</dl>
|
|
3262
|
+
</dd>
|
|
3263
|
+
</dl>
|
|
3264
|
+
|
|
3265
|
+
#### 🔌 Usage
|
|
3266
|
+
|
|
3267
|
+
<dl>
|
|
3268
|
+
<dd>
|
|
3269
|
+
|
|
3270
|
+
<dl>
|
|
3271
|
+
<dd>
|
|
3272
|
+
|
|
3273
|
+
```typescript
|
|
3274
|
+
await client.webhooks.updateWebhook({
|
|
3275
|
+
webhookName: "billing-invoice-created"
|
|
3276
|
+
});
|
|
3277
|
+
|
|
3278
|
+
```
|
|
3279
|
+
</dd>
|
|
3280
|
+
</dl>
|
|
3281
|
+
</dd>
|
|
3282
|
+
</dl>
|
|
3283
|
+
|
|
3284
|
+
#### ⚙️ Parameters
|
|
3285
|
+
|
|
3286
|
+
<dl>
|
|
3287
|
+
<dd>
|
|
3288
|
+
|
|
3289
|
+
<dl>
|
|
3290
|
+
<dd>
|
|
3291
|
+
|
|
3292
|
+
**request:** `Paid.UpdateWebhookRequest`
|
|
3293
|
+
|
|
3294
|
+
</dd>
|
|
3295
|
+
</dl>
|
|
3296
|
+
|
|
3297
|
+
<dl>
|
|
3298
|
+
<dd>
|
|
3299
|
+
|
|
3300
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3301
|
+
|
|
3302
|
+
</dd>
|
|
3303
|
+
</dl>
|
|
3304
|
+
</dd>
|
|
3305
|
+
</dl>
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
</dd>
|
|
3309
|
+
</dl>
|
|
3310
|
+
</details>
|
|
3311
|
+
|
|
3312
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>({ ...params }) -> Paid.WebhookTestResponse</code></summary>
|
|
3313
|
+
<dl>
|
|
3314
|
+
<dd>
|
|
3315
|
+
|
|
3316
|
+
#### 📝 Description
|
|
3317
|
+
|
|
3318
|
+
<dl>
|
|
3319
|
+
<dd>
|
|
3320
|
+
|
|
3321
|
+
<dl>
|
|
3322
|
+
<dd>
|
|
3323
|
+
|
|
3324
|
+
Send a synthetic webhook delivery to the configured destination for this webhook.
|
|
3325
|
+
</dd>
|
|
3326
|
+
</dl>
|
|
3327
|
+
</dd>
|
|
3328
|
+
</dl>
|
|
3329
|
+
|
|
3330
|
+
#### 🔌 Usage
|
|
3331
|
+
|
|
3332
|
+
<dl>
|
|
3333
|
+
<dd>
|
|
3334
|
+
|
|
3335
|
+
<dl>
|
|
3336
|
+
<dd>
|
|
3337
|
+
|
|
3338
|
+
```typescript
|
|
3339
|
+
await client.webhooks.testWebhook({
|
|
3340
|
+
webhookName: "billing-invoice-created"
|
|
3341
|
+
});
|
|
3342
|
+
|
|
3343
|
+
```
|
|
3344
|
+
</dd>
|
|
3345
|
+
</dl>
|
|
3346
|
+
</dd>
|
|
3347
|
+
</dl>
|
|
3348
|
+
|
|
3349
|
+
#### ⚙️ Parameters
|
|
3350
|
+
|
|
3351
|
+
<dl>
|
|
3352
|
+
<dd>
|
|
3353
|
+
|
|
3354
|
+
<dl>
|
|
3355
|
+
<dd>
|
|
3356
|
+
|
|
3357
|
+
**request:** `Paid.TestWebhookRequest`
|
|
3358
|
+
|
|
3359
|
+
</dd>
|
|
3360
|
+
</dl>
|
|
3361
|
+
|
|
3362
|
+
<dl>
|
|
3363
|
+
<dd>
|
|
3364
|
+
|
|
3365
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
3366
|
+
|
|
3367
|
+
</dd>
|
|
3368
|
+
</dl>
|
|
3369
|
+
</dd>
|
|
3370
|
+
</dl>
|
|
3371
|
+
|
|
3372
|
+
|
|
2663
3373
|
</dd>
|
|
2664
3374
|
</dl>
|
|
2665
3375
|
</details>
|