@paid-ai/paid-node 0.5.0-alpha2 → 0.5.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/README.md +118 -36
- package/dist/cjs/Client.d.ts +35 -3
- package/dist/cjs/Client.js +57 -19
- package/dist/cjs/api/errors/InternalServerError.d.ts +9 -0
- package/dist/cjs/api/errors/InternalServerError.js +52 -0
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/index.d.ts +1 -1
- package/dist/cjs/api/index.js +1 -1
- package/dist/cjs/api/resources/agents/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/agents/client/Client.js +16 -0
- package/dist/cjs/api/resources/customers/client/Client.d.ts +38 -0
- package/dist/cjs/api/resources/customers/client/Client.js +164 -0
- package/dist/cjs/api/resources/customers/client/requests/CustomerCreate.d.ts +2 -0
- package/dist/cjs/api/resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.d.ts +30 -0
- package/dist/cjs/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.d.ts +30 -0
- package/dist/cjs/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.js +5 -0
- package/dist/cjs/api/resources/customers/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.d.ts +8 -1
- package/dist/cjs/api/resources/index.js +9 -2
- package/dist/cjs/api/resources/orders/client/requests/OrderCreate.d.ts +2 -0
- package/dist/cjs/api/resources/orders/resources/lines/client/Client.d.ts +0 -2
- package/dist/cjs/api/resources/orders/resources/lines/client/Client.js +0 -2
- package/dist/cjs/api/resources/orders/resources/lines/client/requests/LinesUpdateRequest.d.ts +0 -2
- package/dist/cjs/api/resources/plans/client/Client.d.ts +75 -0
- package/dist/cjs/api/resources/plans/client/Client.js +272 -0
- package/dist/cjs/api/resources/plans/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/plans/client/index.js +17 -0
- package/dist/cjs/api/resources/plans/client/requests/PlansGetUsageRequest.d.ts +35 -0
- package/dist/cjs/api/resources/plans/client/requests/PlansGetUsageRequest.js +5 -0
- package/dist/cjs/api/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/plans/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/plans/index.d.ts +1 -0
- package/dist/cjs/api/resources/plans/index.js +17 -0
- package/dist/cjs/api/resources/products/client/Client.d.ts +109 -0
- package/dist/cjs/api/resources/products/client/Client.js +470 -0
- package/dist/cjs/api/resources/products/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/products/client/index.js +17 -0
- package/dist/cjs/api/resources/products/client/requests/ProductCreate.d.ts +29 -0
- package/dist/cjs/api/resources/products/client/requests/ProductCreate.js +14 -0
- package/dist/cjs/api/resources/products/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/products/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/products/index.d.ts +1 -0
- package/dist/cjs/api/resources/products/index.js +17 -0
- package/dist/cjs/api/resources/traces/client/Client.d.ts +52 -0
- package/dist/cjs/api/resources/traces/client/Client.js +166 -0
- package/dist/cjs/api/resources/traces/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/traces/client/index.js +17 -0
- package/dist/cjs/api/resources/traces/client/requests/GetTracesRequest.d.ts +50 -0
- package/dist/cjs/api/resources/traces/client/requests/GetTracesRequest.js +5 -0
- package/dist/cjs/api/resources/traces/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/traces/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/traces/index.d.ts +1 -0
- package/dist/cjs/api/resources/traces/index.js +17 -0
- package/dist/cjs/api/resources/usage/client/Client.d.ts +47 -0
- package/dist/cjs/api/resources/usage/client/Client.js +146 -0
- package/dist/cjs/api/resources/usage/client/requests/UsageCheckUsageRequest.d.ts +28 -0
- package/dist/cjs/api/resources/usage/client/requests/UsageCheckUsageRequest.js +5 -0
- package/dist/cjs/api/resources/usage/client/requests/UsageRecordBulkV2Request.d.ts +29 -0
- package/dist/cjs/api/resources/usage/client/requests/UsageRecordBulkV2Request.js +5 -0
- package/dist/cjs/api/resources/usage/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/usage/index.d.ts +1 -0
- package/dist/cjs/api/resources/usage/index.js +1 -0
- package/dist/cjs/api/resources/usage/types/UsageCheckUsageResponse.d.ts +17 -0
- package/dist/cjs/api/resources/usage/types/UsageCheckUsageResponse.js +5 -0
- package/dist/cjs/api/resources/usage/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/usage/types/index.js +17 -0
- package/dist/cjs/api/types/CostAmount.d.ts +12 -0
- package/dist/cjs/api/types/CostAmount.js +5 -0
- package/dist/cjs/api/types/CostTrace.d.ts +22 -0
- package/dist/cjs/api/types/CostTrace.js +5 -0
- package/dist/cjs/api/types/CostTracesResponse.d.ts +11 -0
- package/dist/cjs/api/types/CostTracesResponse.js +5 -0
- package/dist/cjs/api/types/Customer.d.ts +2 -0
- package/dist/cjs/api/types/CustomerUpdate.d.ts +2 -0
- package/dist/cjs/api/types/OrderLineAttributeCreateOne.d.ts +4 -0
- package/dist/cjs/api/types/OrderLineAttributeCreateOne.js +5 -0
- package/dist/cjs/api/types/OrderLineCreate.d.ts +10 -4
- package/dist/cjs/api/types/PaginationMeta.d.ts +28 -0
- package/dist/cjs/api/types/PaginationMeta.js +5 -0
- package/dist/cjs/api/types/Plan.d.ts +58 -0
- package/dist/cjs/api/types/Plan.js +5 -0
- package/dist/cjs/api/types/PlanGroup.d.ts +23 -0
- package/dist/cjs/api/types/PlanGroup.js +5 -0
- package/dist/cjs/api/types/Product.d.ts +36 -0
- package/dist/cjs/api/types/Product.js +14 -0
- package/dist/cjs/api/types/ProductUpdate.d.ts +23 -0
- package/dist/cjs/api/types/ProductUpdate.js +14 -0
- package/dist/cjs/api/types/Signal.d.ts +7 -2
- package/dist/cjs/api/types/SignalV2.d.ts +22 -0
- package/dist/cjs/api/types/SignalV2.js +5 -0
- package/dist/cjs/api/types/Trace.d.ts +26 -0
- package/dist/cjs/api/types/Trace.js +5 -0
- package/dist/cjs/api/types/TracesResponse.d.ts +11 -0
- package/dist/cjs/api/types/TracesResponse.js +5 -0
- package/dist/cjs/api/types/UsagePaginationMeta.d.ts +16 -0
- package/dist/cjs/api/types/UsagePaginationMeta.js +5 -0
- package/dist/cjs/api/types/UsageSummariesResponse.d.ts +11 -0
- package/dist/cjs/api/types/UsageSummariesResponse.js +5 -0
- package/dist/cjs/api/types/UsageSummary.d.ts +58 -0
- package/dist/cjs/api/types/UsageSummary.js +5 -0
- package/dist/cjs/api/types/index.d.ts +15 -1
- package/dist/cjs/api/types/index.js +15 -1
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/index.js +4 -0
- package/dist/cjs/integrations/adapters/expressjs/base-adapter.d.ts +17 -0
- package/dist/cjs/integrations/adapters/expressjs/base-adapter.js +71 -0
- package/dist/cjs/integrations/adapters/expressjs/index.d.ts +6 -0
- package/dist/cjs/integrations/adapters/expressjs/index.js +20 -0
- package/dist/cjs/integrations/adapters/expressjs/routes.d.ts +162 -0
- package/dist/cjs/integrations/adapters/expressjs/routes.js +269 -0
- package/dist/cjs/integrations/adapters/nestjs/index.d.ts +7 -0
- package/dist/cjs/integrations/adapters/nestjs/index.js +23 -0
- package/dist/cjs/tracing/autoInstrumentation.d.ts +10 -0
- package/dist/cjs/tracing/autoInstrumentation.js +57 -0
- package/dist/cjs/tracing/index.d.ts +4 -0
- package/dist/cjs/tracing/index.js +12 -0
- package/dist/cjs/tracing/signal.d.ts +18 -1
- package/dist/cjs/tracing/signal.js +29 -13
- package/dist/cjs/tracing/spanProcessor.d.ts +10 -0
- package/dist/cjs/tracing/spanProcessor.js +82 -0
- package/dist/cjs/tracing/tracing.d.ts +12 -6
- package/dist/cjs/tracing/tracing.js +65 -58
- package/dist/cjs/tracing/tracingContext.d.ts +8 -0
- package/dist/cjs/tracing/tracingContext.js +28 -0
- package/dist/cjs/tracing/wrappers/anthropicWrapper.js +11 -7
- package/dist/cjs/tracing/wrappers/langchainCallback.js +11 -7
- package/dist/cjs/tracing/wrappers/mistralWrapper.js +11 -7
- package/dist/cjs/tracing/wrappers/openAiWrapper.js +24 -23
- package/dist/cjs/tracing/wrappers/vercelAIWrapper.js +68 -43
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +35 -3
- package/dist/esm/Client.mjs +54 -16
- package/dist/esm/api/errors/InternalServerError.d.mts +9 -0
- package/dist/esm/api/errors/InternalServerError.mjs +15 -0
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/index.d.mts +1 -1
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/resources/agents/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/agents/client/Client.mjs +16 -0
- package/dist/esm/api/resources/customers/client/Client.d.mts +38 -0
- package/dist/esm/api/resources/customers/client/Client.mjs +164 -0
- package/dist/esm/api/resources/customers/client/requests/CustomerCreate.d.mts +2 -0
- package/dist/esm/api/resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.d.mts +30 -0
- package/dist/esm/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.d.mts +30 -0
- package/dist/esm/api/resources/customers/client/requests/CustomersGetUsageByExternalIdRequest.mjs +4 -0
- package/dist/esm/api/resources/customers/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/index.d.mts +8 -1
- package/dist/esm/api/resources/index.mjs +8 -1
- package/dist/esm/api/resources/orders/client/requests/OrderCreate.d.mts +2 -0
- package/dist/esm/api/resources/orders/resources/lines/client/Client.d.mts +0 -2
- package/dist/esm/api/resources/orders/resources/lines/client/Client.mjs +0 -2
- package/dist/esm/api/resources/orders/resources/lines/client/requests/LinesUpdateRequest.d.mts +0 -2
- package/dist/esm/api/resources/plans/client/Client.d.mts +75 -0
- package/dist/esm/api/resources/plans/client/Client.mjs +232 -0
- package/dist/esm/api/resources/plans/client/index.d.mts +1 -0
- package/dist/esm/api/resources/plans/client/index.mjs +1 -0
- package/dist/esm/api/resources/plans/client/requests/PlansGetUsageRequest.d.mts +35 -0
- package/dist/esm/api/resources/plans/client/requests/PlansGetUsageRequest.mjs +4 -0
- package/dist/esm/api/resources/plans/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/plans/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/plans/index.d.mts +1 -0
- package/dist/esm/api/resources/plans/index.mjs +1 -0
- package/dist/esm/api/resources/products/client/Client.d.mts +109 -0
- package/dist/esm/api/resources/products/client/Client.mjs +430 -0
- package/dist/esm/api/resources/products/client/index.d.mts +1 -0
- package/dist/esm/api/resources/products/client/index.mjs +1 -0
- package/dist/esm/api/resources/products/client/requests/ProductCreate.d.mts +29 -0
- package/dist/esm/api/resources/products/client/requests/ProductCreate.mjs +11 -0
- package/dist/esm/api/resources/products/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/products/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/products/index.d.mts +1 -0
- package/dist/esm/api/resources/products/index.mjs +1 -0
- package/dist/esm/api/resources/traces/client/Client.d.mts +52 -0
- package/dist/esm/api/resources/traces/client/Client.mjs +126 -0
- package/dist/esm/api/resources/traces/client/index.d.mts +1 -0
- package/dist/esm/api/resources/traces/client/index.mjs +1 -0
- package/dist/esm/api/resources/traces/client/requests/GetTracesRequest.d.mts +50 -0
- package/dist/esm/api/resources/traces/client/requests/GetTracesRequest.mjs +4 -0
- package/dist/esm/api/resources/traces/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/traces/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/traces/index.d.mts +1 -0
- package/dist/esm/api/resources/traces/index.mjs +1 -0
- package/dist/esm/api/resources/usage/client/Client.d.mts +47 -0
- package/dist/esm/api/resources/usage/client/Client.mjs +146 -0
- package/dist/esm/api/resources/usage/client/requests/UsageCheckUsageRequest.d.mts +28 -0
- package/dist/esm/api/resources/usage/client/requests/UsageCheckUsageRequest.mjs +4 -0
- package/dist/esm/api/resources/usage/client/requests/UsageRecordBulkV2Request.d.mts +29 -0
- package/dist/esm/api/resources/usage/client/requests/UsageRecordBulkV2Request.mjs +4 -0
- package/dist/esm/api/resources/usage/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/usage/index.d.mts +1 -0
- package/dist/esm/api/resources/usage/index.mjs +1 -0
- package/dist/esm/api/resources/usage/types/UsageCheckUsageResponse.d.mts +17 -0
- package/dist/esm/api/resources/usage/types/UsageCheckUsageResponse.mjs +4 -0
- package/dist/esm/api/resources/usage/types/index.d.mts +1 -0
- package/dist/esm/api/resources/usage/types/index.mjs +1 -0
- package/dist/esm/api/types/CostAmount.d.mts +12 -0
- package/dist/esm/api/types/CostAmount.mjs +4 -0
- package/dist/esm/api/types/CostTrace.d.mts +22 -0
- package/dist/esm/api/types/CostTrace.mjs +4 -0
- package/dist/esm/api/types/CostTracesResponse.d.mts +11 -0
- package/dist/esm/api/types/CostTracesResponse.mjs +4 -0
- package/dist/esm/api/types/Customer.d.mts +2 -0
- package/dist/esm/api/types/CustomerUpdate.d.mts +2 -0
- package/dist/esm/api/types/OrderLineAttributeCreateOne.d.mts +4 -0
- package/dist/esm/api/types/OrderLineAttributeCreateOne.mjs +4 -0
- package/dist/esm/api/types/OrderLineCreate.d.mts +10 -4
- package/dist/esm/api/types/PaginationMeta.d.mts +28 -0
- package/dist/esm/api/types/PaginationMeta.mjs +4 -0
- package/dist/esm/api/types/Plan.d.mts +58 -0
- package/dist/esm/api/types/Plan.mjs +4 -0
- package/dist/esm/api/types/PlanGroup.d.mts +23 -0
- package/dist/esm/api/types/PlanGroup.mjs +4 -0
- package/dist/esm/api/types/Product.d.mts +36 -0
- package/dist/esm/api/types/Product.mjs +11 -0
- package/dist/esm/api/types/ProductUpdate.d.mts +23 -0
- package/dist/esm/api/types/ProductUpdate.mjs +11 -0
- package/dist/esm/api/types/Signal.d.mts +7 -2
- package/dist/esm/api/types/SignalV2.d.mts +22 -0
- package/dist/esm/api/types/SignalV2.mjs +4 -0
- package/dist/esm/api/types/Trace.d.mts +26 -0
- package/dist/esm/api/types/Trace.mjs +4 -0
- package/dist/esm/api/types/TracesResponse.d.mts +11 -0
- package/dist/esm/api/types/TracesResponse.mjs +4 -0
- package/dist/esm/api/types/UsagePaginationMeta.d.mts +16 -0
- package/dist/esm/api/types/UsagePaginationMeta.mjs +4 -0
- package/dist/esm/api/types/UsageSummariesResponse.d.mts +11 -0
- package/dist/esm/api/types/UsageSummariesResponse.mjs +4 -0
- package/dist/esm/api/types/UsageSummary.d.mts +58 -0
- package/dist/esm/api/types/UsageSummary.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +15 -1
- package/dist/esm/api/types/index.mjs +15 -1
- package/dist/esm/index.d.mts +1 -0
- package/dist/esm/index.mjs +1 -0
- package/dist/esm/integrations/adapters/expressjs/base-adapter.d.mts +17 -0
- package/dist/esm/integrations/adapters/expressjs/base-adapter.mjs +67 -0
- package/dist/esm/integrations/adapters/expressjs/index.d.mts +6 -0
- package/dist/esm/integrations/adapters/expressjs/index.mjs +6 -0
- package/dist/esm/integrations/adapters/expressjs/routes.d.mts +162 -0
- package/dist/esm/integrations/adapters/expressjs/routes.mjs +258 -0
- package/dist/esm/integrations/adapters/nestjs/index.d.mts +7 -0
- package/dist/esm/integrations/adapters/nestjs/index.mjs +7 -0
- package/dist/esm/tracing/autoInstrumentation.d.mts +10 -0
- package/dist/esm/tracing/autoInstrumentation.mjs +54 -0
- package/dist/esm/tracing/index.d.mts +4 -0
- package/dist/esm/tracing/index.mjs +4 -0
- package/dist/esm/tracing/signal.d.mts +18 -1
- package/dist/esm/tracing/signal.mjs +28 -12
- package/dist/esm/tracing/spanProcessor.d.mts +10 -0
- package/dist/esm/tracing/spanProcessor.mjs +78 -0
- package/dist/esm/tracing/tracing.d.mts +12 -6
- package/dist/esm/tracing/tracing.mjs +59 -52
- package/dist/esm/tracing/tracingContext.d.mts +8 -0
- package/dist/esm/tracing/tracingContext.mjs +23 -0
- package/dist/esm/tracing/wrappers/anthropicWrapper.mjs +11 -7
- package/dist/esm/tracing/wrappers/langchainCallback.mjs +11 -7
- package/dist/esm/tracing/wrappers/mistralWrapper.mjs +11 -7
- package/dist/esm/tracing/wrappers/openAiWrapper.mjs +24 -23
- package/dist/esm/tracing/wrappers/vercelAIWrapper.mjs +68 -43
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +41 -4
- package/reference.md +1147 -153
- package/dist/cjs/api/types/OrderLineAttributeCreate.d.ts +0 -12
- package/dist/esm/api/types/OrderLineAttributeCreate.d.mts +0 -12
- /package/dist/cjs/api/{types/OrderLineAttributeCreate.js → resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.js} +0 -0
- /package/dist/esm/api/{types/OrderLineAttributeCreate.mjs → resources/customers/client/requests/CustomersGetCostsByExternalIdRequest.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -450,12 +450,149 @@ await client.customers.deleteByExternalId("externalId");
|
|
|
450
450
|
</dl>
|
|
451
451
|
</details>
|
|
452
452
|
|
|
453
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">getCostsByExternalId</a>(externalId, { ...params }) -> Paid.CostTracesResponse</code></summary>
|
|
454
|
+
<dl>
|
|
455
|
+
<dd>
|
|
456
|
+
|
|
457
|
+
#### 🔌 Usage
|
|
458
|
+
|
|
459
|
+
<dl>
|
|
460
|
+
<dd>
|
|
461
|
+
|
|
462
|
+
<dl>
|
|
463
|
+
<dd>
|
|
464
|
+
|
|
465
|
+
```typescript
|
|
466
|
+
await client.customers.getCostsByExternalId("externalId", {
|
|
467
|
+
limit: 1,
|
|
468
|
+
offset: 1,
|
|
469
|
+
startTime: "2024-01-15T09:30:00Z",
|
|
470
|
+
endTime: "2024-01-15T09:30:00Z",
|
|
471
|
+
});
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
</dd>
|
|
475
|
+
</dl>
|
|
476
|
+
</dd>
|
|
477
|
+
</dl>
|
|
478
|
+
|
|
479
|
+
#### ⚙️ Parameters
|
|
480
|
+
|
|
481
|
+
<dl>
|
|
482
|
+
<dd>
|
|
483
|
+
|
|
484
|
+
<dl>
|
|
485
|
+
<dd>
|
|
486
|
+
|
|
487
|
+
**externalId:** `string` — The external ID of the customer
|
|
488
|
+
|
|
489
|
+
</dd>
|
|
490
|
+
</dl>
|
|
491
|
+
|
|
492
|
+
<dl>
|
|
493
|
+
<dd>
|
|
494
|
+
|
|
495
|
+
**request:** `Paid.CustomersGetCostsByExternalIdRequest`
|
|
496
|
+
|
|
497
|
+
</dd>
|
|
498
|
+
</dl>
|
|
499
|
+
|
|
500
|
+
<dl>
|
|
501
|
+
<dd>
|
|
502
|
+
|
|
503
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
504
|
+
|
|
505
|
+
</dd>
|
|
506
|
+
</dl>
|
|
507
|
+
</dd>
|
|
508
|
+
</dl>
|
|
509
|
+
|
|
510
|
+
</dd>
|
|
511
|
+
</dl>
|
|
512
|
+
</details>
|
|
513
|
+
|
|
514
|
+
<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">getUsageByExternalId</a>(externalId, { ...params }) -> Paid.UsageSummariesResponse</code></summary>
|
|
515
|
+
<dl>
|
|
516
|
+
<dd>
|
|
517
|
+
|
|
518
|
+
#### 🔌 Usage
|
|
519
|
+
|
|
520
|
+
<dl>
|
|
521
|
+
<dd>
|
|
522
|
+
|
|
523
|
+
<dl>
|
|
524
|
+
<dd>
|
|
525
|
+
|
|
526
|
+
```typescript
|
|
527
|
+
await client.customers.getUsageByExternalId("externalId", {
|
|
528
|
+
limit: 1,
|
|
529
|
+
offset: 1,
|
|
530
|
+
startTime: "2024-01-15T09:30:00Z",
|
|
531
|
+
endTime: "2024-01-15T09:30:00Z",
|
|
532
|
+
});
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
</dd>
|
|
536
|
+
</dl>
|
|
537
|
+
</dd>
|
|
538
|
+
</dl>
|
|
539
|
+
|
|
540
|
+
#### ⚙️ Parameters
|
|
541
|
+
|
|
542
|
+
<dl>
|
|
543
|
+
<dd>
|
|
544
|
+
|
|
545
|
+
<dl>
|
|
546
|
+
<dd>
|
|
547
|
+
|
|
548
|
+
**externalId:** `string` — The external ID of the customer
|
|
549
|
+
|
|
550
|
+
</dd>
|
|
551
|
+
</dl>
|
|
552
|
+
|
|
553
|
+
<dl>
|
|
554
|
+
<dd>
|
|
555
|
+
|
|
556
|
+
**request:** `Paid.CustomersGetUsageByExternalIdRequest`
|
|
557
|
+
|
|
558
|
+
</dd>
|
|
559
|
+
</dl>
|
|
560
|
+
|
|
561
|
+
<dl>
|
|
562
|
+
<dd>
|
|
563
|
+
|
|
564
|
+
**requestOptions:** `Customers.RequestOptions`
|
|
565
|
+
|
|
566
|
+
</dd>
|
|
567
|
+
</dl>
|
|
568
|
+
</dd>
|
|
569
|
+
</dl>
|
|
570
|
+
|
|
571
|
+
</dd>
|
|
572
|
+
</dl>
|
|
573
|
+
</details>
|
|
574
|
+
|
|
453
575
|
## Agents
|
|
454
576
|
|
|
455
577
|
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>() -> Paid.Agent[]</code></summary>
|
|
456
578
|
<dl>
|
|
457
579
|
<dd>
|
|
458
580
|
|
|
581
|
+
#### 📝 Description
|
|
582
|
+
|
|
583
|
+
<dl>
|
|
584
|
+
<dd>
|
|
585
|
+
|
|
586
|
+
<dl>
|
|
587
|
+
<dd>
|
|
588
|
+
|
|
589
|
+
DEPRECATED: Use /products instead. Agents are now products with type='agent'.
|
|
590
|
+
|
|
591
|
+
</dd>
|
|
592
|
+
</dl>
|
|
593
|
+
</dd>
|
|
594
|
+
</dl>
|
|
595
|
+
|
|
459
596
|
#### 🔌 Usage
|
|
460
597
|
|
|
461
598
|
<dl>
|
|
@@ -496,6 +633,21 @@ await client.agents.list();
|
|
|
496
633
|
<dl>
|
|
497
634
|
<dd>
|
|
498
635
|
|
|
636
|
+
#### 📝 Description
|
|
637
|
+
|
|
638
|
+
<dl>
|
|
639
|
+
<dd>
|
|
640
|
+
|
|
641
|
+
<dl>
|
|
642
|
+
<dd>
|
|
643
|
+
|
|
644
|
+
DEPRECATED: Use POST /products instead.
|
|
645
|
+
|
|
646
|
+
</dd>
|
|
647
|
+
</dl>
|
|
648
|
+
</dd>
|
|
649
|
+
</dl>
|
|
650
|
+
|
|
499
651
|
#### 🔌 Usage
|
|
500
652
|
|
|
501
653
|
<dl>
|
|
@@ -548,6 +700,21 @@ await client.agents.create({
|
|
|
548
700
|
<dl>
|
|
549
701
|
<dd>
|
|
550
702
|
|
|
703
|
+
#### 📝 Description
|
|
704
|
+
|
|
705
|
+
<dl>
|
|
706
|
+
<dd>
|
|
707
|
+
|
|
708
|
+
<dl>
|
|
709
|
+
<dd>
|
|
710
|
+
|
|
711
|
+
DEPRECATED: Use GET /products/{productId} instead.
|
|
712
|
+
|
|
713
|
+
</dd>
|
|
714
|
+
</dl>
|
|
715
|
+
</dd>
|
|
716
|
+
</dl>
|
|
717
|
+
|
|
551
718
|
#### 🔌 Usage
|
|
552
719
|
|
|
553
720
|
<dl>
|
|
@@ -581,7 +748,834 @@ await client.agents.get("agentId");
|
|
|
581
748
|
<dl>
|
|
582
749
|
<dd>
|
|
583
750
|
|
|
584
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
751
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
752
|
+
|
|
753
|
+
</dd>
|
|
754
|
+
</dl>
|
|
755
|
+
</dd>
|
|
756
|
+
</dl>
|
|
757
|
+
|
|
758
|
+
</dd>
|
|
759
|
+
</dl>
|
|
760
|
+
</details>
|
|
761
|
+
|
|
762
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(agentId, { ...params }) -> Paid.Agent</code></summary>
|
|
763
|
+
<dl>
|
|
764
|
+
<dd>
|
|
765
|
+
|
|
766
|
+
#### 📝 Description
|
|
767
|
+
|
|
768
|
+
<dl>
|
|
769
|
+
<dd>
|
|
770
|
+
|
|
771
|
+
<dl>
|
|
772
|
+
<dd>
|
|
773
|
+
|
|
774
|
+
DEPRECATED: Use PUT /products/{productId} instead.
|
|
775
|
+
|
|
776
|
+
</dd>
|
|
777
|
+
</dl>
|
|
778
|
+
</dd>
|
|
779
|
+
</dl>
|
|
780
|
+
|
|
781
|
+
#### 🔌 Usage
|
|
782
|
+
|
|
783
|
+
<dl>
|
|
784
|
+
<dd>
|
|
785
|
+
|
|
786
|
+
<dl>
|
|
787
|
+
<dd>
|
|
788
|
+
|
|
789
|
+
```typescript
|
|
790
|
+
await client.agents.update("agentId", {
|
|
791
|
+
name: "Acme Agent (Updated)",
|
|
792
|
+
agentAttributes: [
|
|
793
|
+
{
|
|
794
|
+
name: "Emails sent signal",
|
|
795
|
+
active: true,
|
|
796
|
+
pricing: {
|
|
797
|
+
eventName: "emails_sent",
|
|
798
|
+
taxable: true,
|
|
799
|
+
chargeType: "usage",
|
|
800
|
+
pricingModel: "PerUnit",
|
|
801
|
+
billingFrequency: "monthly",
|
|
802
|
+
pricePoints: {
|
|
803
|
+
USD: {
|
|
804
|
+
tiers: [
|
|
805
|
+
{
|
|
806
|
+
minQuantity: 0,
|
|
807
|
+
maxQuantity: 10,
|
|
808
|
+
unitPrice: 100,
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
minQuantity: 11,
|
|
812
|
+
maxQuantity: 100,
|
|
813
|
+
unitPrice: 90,
|
|
814
|
+
},
|
|
815
|
+
{
|
|
816
|
+
minQuantity: 101,
|
|
817
|
+
unitPrice: 80,
|
|
818
|
+
},
|
|
819
|
+
],
|
|
820
|
+
},
|
|
821
|
+
},
|
|
822
|
+
},
|
|
823
|
+
},
|
|
824
|
+
],
|
|
825
|
+
});
|
|
826
|
+
```
|
|
827
|
+
|
|
828
|
+
</dd>
|
|
829
|
+
</dl>
|
|
830
|
+
</dd>
|
|
831
|
+
</dl>
|
|
832
|
+
|
|
833
|
+
#### ⚙️ Parameters
|
|
834
|
+
|
|
835
|
+
<dl>
|
|
836
|
+
<dd>
|
|
837
|
+
|
|
838
|
+
<dl>
|
|
839
|
+
<dd>
|
|
840
|
+
|
|
841
|
+
**agentId:** `string`
|
|
842
|
+
|
|
843
|
+
</dd>
|
|
844
|
+
</dl>
|
|
845
|
+
|
|
846
|
+
<dl>
|
|
847
|
+
<dd>
|
|
848
|
+
|
|
849
|
+
**request:** `Paid.AgentUpdate`
|
|
850
|
+
|
|
851
|
+
</dd>
|
|
852
|
+
</dl>
|
|
853
|
+
|
|
854
|
+
<dl>
|
|
855
|
+
<dd>
|
|
856
|
+
|
|
857
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
858
|
+
|
|
859
|
+
</dd>
|
|
860
|
+
</dl>
|
|
861
|
+
</dd>
|
|
862
|
+
</dl>
|
|
863
|
+
|
|
864
|
+
</dd>
|
|
865
|
+
</dl>
|
|
866
|
+
</details>
|
|
867
|
+
|
|
868
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(agentId) -> void</code></summary>
|
|
869
|
+
<dl>
|
|
870
|
+
<dd>
|
|
871
|
+
|
|
872
|
+
#### 📝 Description
|
|
873
|
+
|
|
874
|
+
<dl>
|
|
875
|
+
<dd>
|
|
876
|
+
|
|
877
|
+
<dl>
|
|
878
|
+
<dd>
|
|
879
|
+
|
|
880
|
+
DEPRECATED: Use DELETE /products/{productId} instead.
|
|
881
|
+
|
|
882
|
+
</dd>
|
|
883
|
+
</dl>
|
|
884
|
+
</dd>
|
|
885
|
+
</dl>
|
|
886
|
+
|
|
887
|
+
#### 🔌 Usage
|
|
888
|
+
|
|
889
|
+
<dl>
|
|
890
|
+
<dd>
|
|
891
|
+
|
|
892
|
+
<dl>
|
|
893
|
+
<dd>
|
|
894
|
+
|
|
895
|
+
```typescript
|
|
896
|
+
await client.agents.delete("agentId");
|
|
897
|
+
```
|
|
898
|
+
|
|
899
|
+
</dd>
|
|
900
|
+
</dl>
|
|
901
|
+
</dd>
|
|
902
|
+
</dl>
|
|
903
|
+
|
|
904
|
+
#### ⚙️ Parameters
|
|
905
|
+
|
|
906
|
+
<dl>
|
|
907
|
+
<dd>
|
|
908
|
+
|
|
909
|
+
<dl>
|
|
910
|
+
<dd>
|
|
911
|
+
|
|
912
|
+
**agentId:** `string`
|
|
913
|
+
|
|
914
|
+
</dd>
|
|
915
|
+
</dl>
|
|
916
|
+
|
|
917
|
+
<dl>
|
|
918
|
+
<dd>
|
|
919
|
+
|
|
920
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
921
|
+
|
|
922
|
+
</dd>
|
|
923
|
+
</dl>
|
|
924
|
+
</dd>
|
|
925
|
+
</dl>
|
|
926
|
+
|
|
927
|
+
</dd>
|
|
928
|
+
</dl>
|
|
929
|
+
</details>
|
|
930
|
+
|
|
931
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Agent</code></summary>
|
|
932
|
+
<dl>
|
|
933
|
+
<dd>
|
|
934
|
+
|
|
935
|
+
#### 📝 Description
|
|
936
|
+
|
|
937
|
+
<dl>
|
|
938
|
+
<dd>
|
|
939
|
+
|
|
940
|
+
<dl>
|
|
941
|
+
<dd>
|
|
942
|
+
|
|
943
|
+
DEPRECATED: Use GET /products/external/{externalId} instead.
|
|
944
|
+
|
|
945
|
+
</dd>
|
|
946
|
+
</dl>
|
|
947
|
+
</dd>
|
|
948
|
+
</dl>
|
|
949
|
+
|
|
950
|
+
#### 🔌 Usage
|
|
951
|
+
|
|
952
|
+
<dl>
|
|
953
|
+
<dd>
|
|
954
|
+
|
|
955
|
+
<dl>
|
|
956
|
+
<dd>
|
|
957
|
+
|
|
958
|
+
```typescript
|
|
959
|
+
await client.agents.getByExternalId("externalId");
|
|
960
|
+
```
|
|
961
|
+
|
|
962
|
+
</dd>
|
|
963
|
+
</dl>
|
|
964
|
+
</dd>
|
|
965
|
+
</dl>
|
|
966
|
+
|
|
967
|
+
#### ⚙️ Parameters
|
|
968
|
+
|
|
969
|
+
<dl>
|
|
970
|
+
<dd>
|
|
971
|
+
|
|
972
|
+
<dl>
|
|
973
|
+
<dd>
|
|
974
|
+
|
|
975
|
+
**externalId:** `string`
|
|
976
|
+
|
|
977
|
+
</dd>
|
|
978
|
+
</dl>
|
|
979
|
+
|
|
980
|
+
<dl>
|
|
981
|
+
<dd>
|
|
982
|
+
|
|
983
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
984
|
+
|
|
985
|
+
</dd>
|
|
986
|
+
</dl>
|
|
987
|
+
</dd>
|
|
988
|
+
</dl>
|
|
989
|
+
|
|
990
|
+
</dd>
|
|
991
|
+
</dl>
|
|
992
|
+
</details>
|
|
993
|
+
|
|
994
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Agent</code></summary>
|
|
995
|
+
<dl>
|
|
996
|
+
<dd>
|
|
997
|
+
|
|
998
|
+
#### 📝 Description
|
|
999
|
+
|
|
1000
|
+
<dl>
|
|
1001
|
+
<dd>
|
|
1002
|
+
|
|
1003
|
+
<dl>
|
|
1004
|
+
<dd>
|
|
1005
|
+
|
|
1006
|
+
DEPRECATED: Use PUT /products/external/{externalId} instead.
|
|
1007
|
+
|
|
1008
|
+
</dd>
|
|
1009
|
+
</dl>
|
|
1010
|
+
</dd>
|
|
1011
|
+
</dl>
|
|
1012
|
+
|
|
1013
|
+
#### 🔌 Usage
|
|
1014
|
+
|
|
1015
|
+
<dl>
|
|
1016
|
+
<dd>
|
|
1017
|
+
|
|
1018
|
+
<dl>
|
|
1019
|
+
<dd>
|
|
1020
|
+
|
|
1021
|
+
```typescript
|
|
1022
|
+
await client.agents.updateByExternalId("externalId", {
|
|
1023
|
+
name: "Acme Agent (Updated)",
|
|
1024
|
+
agentAttributes: [
|
|
1025
|
+
{
|
|
1026
|
+
name: "Emails sent signal",
|
|
1027
|
+
active: true,
|
|
1028
|
+
pricing: {
|
|
1029
|
+
eventName: "emails_sent",
|
|
1030
|
+
taxable: true,
|
|
1031
|
+
chargeType: "usage",
|
|
1032
|
+
pricingModel: "PerUnit",
|
|
1033
|
+
billingFrequency: "monthly",
|
|
1034
|
+
pricePoints: {
|
|
1035
|
+
USD: {
|
|
1036
|
+
unitPrice: 150,
|
|
1037
|
+
},
|
|
1038
|
+
},
|
|
1039
|
+
},
|
|
1040
|
+
},
|
|
1041
|
+
],
|
|
1042
|
+
});
|
|
1043
|
+
```
|
|
1044
|
+
|
|
1045
|
+
</dd>
|
|
1046
|
+
</dl>
|
|
1047
|
+
</dd>
|
|
1048
|
+
</dl>
|
|
1049
|
+
|
|
1050
|
+
#### ⚙️ Parameters
|
|
1051
|
+
|
|
1052
|
+
<dl>
|
|
1053
|
+
<dd>
|
|
1054
|
+
|
|
1055
|
+
<dl>
|
|
1056
|
+
<dd>
|
|
1057
|
+
|
|
1058
|
+
**externalId:** `string`
|
|
1059
|
+
|
|
1060
|
+
</dd>
|
|
1061
|
+
</dl>
|
|
1062
|
+
|
|
1063
|
+
<dl>
|
|
1064
|
+
<dd>
|
|
1065
|
+
|
|
1066
|
+
**request:** `Paid.AgentUpdate`
|
|
1067
|
+
|
|
1068
|
+
</dd>
|
|
1069
|
+
</dl>
|
|
1070
|
+
|
|
1071
|
+
<dl>
|
|
1072
|
+
<dd>
|
|
1073
|
+
|
|
1074
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
1075
|
+
|
|
1076
|
+
</dd>
|
|
1077
|
+
</dl>
|
|
1078
|
+
</dd>
|
|
1079
|
+
</dl>
|
|
1080
|
+
|
|
1081
|
+
</dd>
|
|
1082
|
+
</dl>
|
|
1083
|
+
</details>
|
|
1084
|
+
|
|
1085
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
|
|
1086
|
+
<dl>
|
|
1087
|
+
<dd>
|
|
1088
|
+
|
|
1089
|
+
#### 📝 Description
|
|
1090
|
+
|
|
1091
|
+
<dl>
|
|
1092
|
+
<dd>
|
|
1093
|
+
|
|
1094
|
+
<dl>
|
|
1095
|
+
<dd>
|
|
1096
|
+
|
|
1097
|
+
DEPRECATED: Use DELETE /products/external/{externalId} instead.
|
|
1098
|
+
|
|
1099
|
+
</dd>
|
|
1100
|
+
</dl>
|
|
1101
|
+
</dd>
|
|
1102
|
+
</dl>
|
|
1103
|
+
|
|
1104
|
+
#### 🔌 Usage
|
|
1105
|
+
|
|
1106
|
+
<dl>
|
|
1107
|
+
<dd>
|
|
1108
|
+
|
|
1109
|
+
<dl>
|
|
1110
|
+
<dd>
|
|
1111
|
+
|
|
1112
|
+
```typescript
|
|
1113
|
+
await client.agents.deleteByExternalId("externalId");
|
|
1114
|
+
```
|
|
1115
|
+
|
|
1116
|
+
</dd>
|
|
1117
|
+
</dl>
|
|
1118
|
+
</dd>
|
|
1119
|
+
</dl>
|
|
1120
|
+
|
|
1121
|
+
#### ⚙️ Parameters
|
|
1122
|
+
|
|
1123
|
+
<dl>
|
|
1124
|
+
<dd>
|
|
1125
|
+
|
|
1126
|
+
<dl>
|
|
1127
|
+
<dd>
|
|
1128
|
+
|
|
1129
|
+
**externalId:** `string`
|
|
1130
|
+
|
|
1131
|
+
</dd>
|
|
1132
|
+
</dl>
|
|
1133
|
+
|
|
1134
|
+
<dl>
|
|
1135
|
+
<dd>
|
|
1136
|
+
|
|
1137
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
1138
|
+
|
|
1139
|
+
</dd>
|
|
1140
|
+
</dl>
|
|
1141
|
+
</dd>
|
|
1142
|
+
</dl>
|
|
1143
|
+
|
|
1144
|
+
</dd>
|
|
1145
|
+
</dl>
|
|
1146
|
+
</details>
|
|
1147
|
+
|
|
1148
|
+
## Products
|
|
1149
|
+
|
|
1150
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">list</a>() -> Paid.Product[]</code></summary>
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
#### 🔌 Usage
|
|
1155
|
+
|
|
1156
|
+
<dl>
|
|
1157
|
+
<dd>
|
|
1158
|
+
|
|
1159
|
+
<dl>
|
|
1160
|
+
<dd>
|
|
1161
|
+
|
|
1162
|
+
```typescript
|
|
1163
|
+
await client.products.list();
|
|
1164
|
+
```
|
|
1165
|
+
|
|
1166
|
+
</dd>
|
|
1167
|
+
</dl>
|
|
1168
|
+
</dd>
|
|
1169
|
+
</dl>
|
|
1170
|
+
|
|
1171
|
+
#### ⚙️ Parameters
|
|
1172
|
+
|
|
1173
|
+
<dl>
|
|
1174
|
+
<dd>
|
|
1175
|
+
|
|
1176
|
+
<dl>
|
|
1177
|
+
<dd>
|
|
1178
|
+
|
|
1179
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1180
|
+
|
|
1181
|
+
</dd>
|
|
1182
|
+
</dl>
|
|
1183
|
+
</dd>
|
|
1184
|
+
</dl>
|
|
1185
|
+
|
|
1186
|
+
</dd>
|
|
1187
|
+
</dl>
|
|
1188
|
+
</details>
|
|
1189
|
+
|
|
1190
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">create</a>({ ...params }) -> Paid.Product</code></summary>
|
|
1191
|
+
<dl>
|
|
1192
|
+
<dd>
|
|
1193
|
+
|
|
1194
|
+
#### 🔌 Usage
|
|
1195
|
+
|
|
1196
|
+
<dl>
|
|
1197
|
+
<dd>
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
```typescript
|
|
1203
|
+
await client.products.create({
|
|
1204
|
+
name: "Acme Product",
|
|
1205
|
+
description: "Acme Product does amazing things.",
|
|
1206
|
+
externalId: "acme-product",
|
|
1207
|
+
type: "product",
|
|
1208
|
+
});
|
|
1209
|
+
```
|
|
1210
|
+
|
|
1211
|
+
</dd>
|
|
1212
|
+
</dl>
|
|
1213
|
+
</dd>
|
|
1214
|
+
</dl>
|
|
1215
|
+
|
|
1216
|
+
#### ⚙️ Parameters
|
|
1217
|
+
|
|
1218
|
+
<dl>
|
|
1219
|
+
<dd>
|
|
1220
|
+
|
|
1221
|
+
<dl>
|
|
1222
|
+
<dd>
|
|
1223
|
+
|
|
1224
|
+
**request:** `Paid.ProductCreate`
|
|
1225
|
+
|
|
1226
|
+
</dd>
|
|
1227
|
+
</dl>
|
|
1228
|
+
|
|
1229
|
+
<dl>
|
|
1230
|
+
<dd>
|
|
1231
|
+
|
|
1232
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1233
|
+
|
|
1234
|
+
</dd>
|
|
1235
|
+
</dl>
|
|
1236
|
+
</dd>
|
|
1237
|
+
</dl>
|
|
1238
|
+
|
|
1239
|
+
</dd>
|
|
1240
|
+
</dl>
|
|
1241
|
+
</details>
|
|
1242
|
+
|
|
1243
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">get</a>(productId) -> Paid.Product</code></summary>
|
|
1244
|
+
<dl>
|
|
1245
|
+
<dd>
|
|
1246
|
+
|
|
1247
|
+
#### 🔌 Usage
|
|
1248
|
+
|
|
1249
|
+
<dl>
|
|
1250
|
+
<dd>
|
|
1251
|
+
|
|
1252
|
+
<dl>
|
|
1253
|
+
<dd>
|
|
1254
|
+
|
|
1255
|
+
```typescript
|
|
1256
|
+
await client.products.get("productId");
|
|
1257
|
+
```
|
|
1258
|
+
|
|
1259
|
+
</dd>
|
|
1260
|
+
</dl>
|
|
1261
|
+
</dd>
|
|
1262
|
+
</dl>
|
|
1263
|
+
|
|
1264
|
+
#### ⚙️ Parameters
|
|
1265
|
+
|
|
1266
|
+
<dl>
|
|
1267
|
+
<dd>
|
|
1268
|
+
|
|
1269
|
+
<dl>
|
|
1270
|
+
<dd>
|
|
1271
|
+
|
|
1272
|
+
**productId:** `string`
|
|
1273
|
+
|
|
1274
|
+
</dd>
|
|
1275
|
+
</dl>
|
|
1276
|
+
|
|
1277
|
+
<dl>
|
|
1278
|
+
<dd>
|
|
1279
|
+
|
|
1280
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1281
|
+
|
|
1282
|
+
</dd>
|
|
1283
|
+
</dl>
|
|
1284
|
+
</dd>
|
|
1285
|
+
</dl>
|
|
1286
|
+
|
|
1287
|
+
</dd>
|
|
1288
|
+
</dl>
|
|
1289
|
+
</details>
|
|
1290
|
+
|
|
1291
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">update</a>(productId, { ...params }) -> Paid.Product</code></summary>
|
|
1292
|
+
<dl>
|
|
1293
|
+
<dd>
|
|
1294
|
+
|
|
1295
|
+
#### 🔌 Usage
|
|
1296
|
+
|
|
1297
|
+
<dl>
|
|
1298
|
+
<dd>
|
|
1299
|
+
|
|
1300
|
+
<dl>
|
|
1301
|
+
<dd>
|
|
1302
|
+
|
|
1303
|
+
```typescript
|
|
1304
|
+
await client.products.update("productId", {});
|
|
1305
|
+
```
|
|
1306
|
+
|
|
1307
|
+
</dd>
|
|
1308
|
+
</dl>
|
|
1309
|
+
</dd>
|
|
1310
|
+
</dl>
|
|
1311
|
+
|
|
1312
|
+
#### ⚙️ Parameters
|
|
1313
|
+
|
|
1314
|
+
<dl>
|
|
1315
|
+
<dd>
|
|
1316
|
+
|
|
1317
|
+
<dl>
|
|
1318
|
+
<dd>
|
|
1319
|
+
|
|
1320
|
+
**productId:** `string`
|
|
1321
|
+
|
|
1322
|
+
</dd>
|
|
1323
|
+
</dl>
|
|
1324
|
+
|
|
1325
|
+
<dl>
|
|
1326
|
+
<dd>
|
|
1327
|
+
|
|
1328
|
+
**request:** `Paid.ProductUpdate`
|
|
1329
|
+
|
|
1330
|
+
</dd>
|
|
1331
|
+
</dl>
|
|
1332
|
+
|
|
1333
|
+
<dl>
|
|
1334
|
+
<dd>
|
|
1335
|
+
|
|
1336
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1337
|
+
|
|
1338
|
+
</dd>
|
|
1339
|
+
</dl>
|
|
1340
|
+
</dd>
|
|
1341
|
+
</dl>
|
|
1342
|
+
|
|
1343
|
+
</dd>
|
|
1344
|
+
</dl>
|
|
1345
|
+
</details>
|
|
1346
|
+
|
|
1347
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">delete</a>(productId) -> void</code></summary>
|
|
1348
|
+
<dl>
|
|
1349
|
+
<dd>
|
|
1350
|
+
|
|
1351
|
+
#### 🔌 Usage
|
|
1352
|
+
|
|
1353
|
+
<dl>
|
|
1354
|
+
<dd>
|
|
1355
|
+
|
|
1356
|
+
<dl>
|
|
1357
|
+
<dd>
|
|
1358
|
+
|
|
1359
|
+
```typescript
|
|
1360
|
+
await client.products.delete("productId");
|
|
1361
|
+
```
|
|
1362
|
+
|
|
1363
|
+
</dd>
|
|
1364
|
+
</dl>
|
|
1365
|
+
</dd>
|
|
1366
|
+
</dl>
|
|
1367
|
+
|
|
1368
|
+
#### ⚙️ Parameters
|
|
1369
|
+
|
|
1370
|
+
<dl>
|
|
1371
|
+
<dd>
|
|
1372
|
+
|
|
1373
|
+
<dl>
|
|
1374
|
+
<dd>
|
|
1375
|
+
|
|
1376
|
+
**productId:** `string`
|
|
1377
|
+
|
|
1378
|
+
</dd>
|
|
1379
|
+
</dl>
|
|
1380
|
+
|
|
1381
|
+
<dl>
|
|
1382
|
+
<dd>
|
|
1383
|
+
|
|
1384
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1385
|
+
|
|
1386
|
+
</dd>
|
|
1387
|
+
</dl>
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
|
|
1391
|
+
</dd>
|
|
1392
|
+
</dl>
|
|
1393
|
+
</details>
|
|
1394
|
+
|
|
1395
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Product</code></summary>
|
|
1396
|
+
<dl>
|
|
1397
|
+
<dd>
|
|
1398
|
+
|
|
1399
|
+
#### 🔌 Usage
|
|
1400
|
+
|
|
1401
|
+
<dl>
|
|
1402
|
+
<dd>
|
|
1403
|
+
|
|
1404
|
+
<dl>
|
|
1405
|
+
<dd>
|
|
1406
|
+
|
|
1407
|
+
```typescript
|
|
1408
|
+
await client.products.getByExternalId("externalId");
|
|
1409
|
+
```
|
|
1410
|
+
|
|
1411
|
+
</dd>
|
|
1412
|
+
</dl>
|
|
1413
|
+
</dd>
|
|
1414
|
+
</dl>
|
|
1415
|
+
|
|
1416
|
+
#### ⚙️ Parameters
|
|
1417
|
+
|
|
1418
|
+
<dl>
|
|
1419
|
+
<dd>
|
|
1420
|
+
|
|
1421
|
+
<dl>
|
|
1422
|
+
<dd>
|
|
1423
|
+
|
|
1424
|
+
**externalId:** `string`
|
|
1425
|
+
|
|
1426
|
+
</dd>
|
|
1427
|
+
</dl>
|
|
1428
|
+
|
|
1429
|
+
<dl>
|
|
1430
|
+
<dd>
|
|
1431
|
+
|
|
1432
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1433
|
+
|
|
1434
|
+
</dd>
|
|
1435
|
+
</dl>
|
|
1436
|
+
</dd>
|
|
1437
|
+
</dl>
|
|
1438
|
+
|
|
1439
|
+
</dd>
|
|
1440
|
+
</dl>
|
|
1441
|
+
</details>
|
|
1442
|
+
|
|
1443
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Product</code></summary>
|
|
1444
|
+
<dl>
|
|
1445
|
+
<dd>
|
|
1446
|
+
|
|
1447
|
+
#### 🔌 Usage
|
|
1448
|
+
|
|
1449
|
+
<dl>
|
|
1450
|
+
<dd>
|
|
1451
|
+
|
|
1452
|
+
<dl>
|
|
1453
|
+
<dd>
|
|
1454
|
+
|
|
1455
|
+
```typescript
|
|
1456
|
+
await client.products.updateByExternalId("externalId", {});
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
</dd>
|
|
1460
|
+
</dl>
|
|
1461
|
+
</dd>
|
|
1462
|
+
</dl>
|
|
1463
|
+
|
|
1464
|
+
#### ⚙️ Parameters
|
|
1465
|
+
|
|
1466
|
+
<dl>
|
|
1467
|
+
<dd>
|
|
1468
|
+
|
|
1469
|
+
<dl>
|
|
1470
|
+
<dd>
|
|
1471
|
+
|
|
1472
|
+
**externalId:** `string`
|
|
1473
|
+
|
|
1474
|
+
</dd>
|
|
1475
|
+
</dl>
|
|
1476
|
+
|
|
1477
|
+
<dl>
|
|
1478
|
+
<dd>
|
|
1479
|
+
|
|
1480
|
+
**request:** `Paid.ProductUpdate`
|
|
1481
|
+
|
|
1482
|
+
</dd>
|
|
1483
|
+
</dl>
|
|
1484
|
+
|
|
1485
|
+
<dl>
|
|
1486
|
+
<dd>
|
|
1487
|
+
|
|
1488
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1489
|
+
|
|
1490
|
+
</dd>
|
|
1491
|
+
</dl>
|
|
1492
|
+
</dd>
|
|
1493
|
+
</dl>
|
|
1494
|
+
|
|
1495
|
+
</dd>
|
|
1496
|
+
</dl>
|
|
1497
|
+
</details>
|
|
1498
|
+
|
|
1499
|
+
<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
|
|
1500
|
+
<dl>
|
|
1501
|
+
<dd>
|
|
1502
|
+
|
|
1503
|
+
#### 🔌 Usage
|
|
1504
|
+
|
|
1505
|
+
<dl>
|
|
1506
|
+
<dd>
|
|
1507
|
+
|
|
1508
|
+
<dl>
|
|
1509
|
+
<dd>
|
|
1510
|
+
|
|
1511
|
+
```typescript
|
|
1512
|
+
await client.products.deleteByExternalId("externalId");
|
|
1513
|
+
```
|
|
1514
|
+
|
|
1515
|
+
</dd>
|
|
1516
|
+
</dl>
|
|
1517
|
+
</dd>
|
|
1518
|
+
</dl>
|
|
1519
|
+
|
|
1520
|
+
#### ⚙️ Parameters
|
|
1521
|
+
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
<dl>
|
|
1526
|
+
<dd>
|
|
1527
|
+
|
|
1528
|
+
**externalId:** `string`
|
|
1529
|
+
|
|
1530
|
+
</dd>
|
|
1531
|
+
</dl>
|
|
1532
|
+
|
|
1533
|
+
<dl>
|
|
1534
|
+
<dd>
|
|
1535
|
+
|
|
1536
|
+
**requestOptions:** `Products.RequestOptions`
|
|
1537
|
+
|
|
1538
|
+
</dd>
|
|
1539
|
+
</dl>
|
|
1540
|
+
</dd>
|
|
1541
|
+
</dl>
|
|
1542
|
+
|
|
1543
|
+
</dd>
|
|
1544
|
+
</dl>
|
|
1545
|
+
</details>
|
|
1546
|
+
|
|
1547
|
+
## Contacts
|
|
1548
|
+
|
|
1549
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">list</a>() -> Paid.Contact[]</code></summary>
|
|
1550
|
+
<dl>
|
|
1551
|
+
<dd>
|
|
1552
|
+
|
|
1553
|
+
#### 🔌 Usage
|
|
1554
|
+
|
|
1555
|
+
<dl>
|
|
1556
|
+
<dd>
|
|
1557
|
+
|
|
1558
|
+
<dl>
|
|
1559
|
+
<dd>
|
|
1560
|
+
|
|
1561
|
+
```typescript
|
|
1562
|
+
await client.contacts.list();
|
|
1563
|
+
```
|
|
1564
|
+
|
|
1565
|
+
</dd>
|
|
1566
|
+
</dl>
|
|
1567
|
+
</dd>
|
|
1568
|
+
</dl>
|
|
1569
|
+
|
|
1570
|
+
#### ⚙️ Parameters
|
|
1571
|
+
|
|
1572
|
+
<dl>
|
|
1573
|
+
<dd>
|
|
1574
|
+
|
|
1575
|
+
<dl>
|
|
1576
|
+
<dd>
|
|
1577
|
+
|
|
1578
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
585
1579
|
|
|
586
1580
|
</dd>
|
|
587
1581
|
</dl>
|
|
@@ -592,7 +1586,7 @@ await client.agents.get("agentId");
|
|
|
592
1586
|
</dl>
|
|
593
1587
|
</details>
|
|
594
1588
|
|
|
595
|
-
<details><summary><code>client.
|
|
1589
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">create</a>({ ...params }) -> Paid.Contact</code></summary>
|
|
596
1590
|
<dl>
|
|
597
1591
|
<dd>
|
|
598
1592
|
|
|
@@ -605,41 +1599,12 @@ await client.agents.get("agentId");
|
|
|
605
1599
|
<dd>
|
|
606
1600
|
|
|
607
1601
|
```typescript
|
|
608
|
-
await client.
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
pricing: {
|
|
615
|
-
eventName: "emails_sent",
|
|
616
|
-
taxable: true,
|
|
617
|
-
chargeType: "usage",
|
|
618
|
-
pricingModel: "PerUnit",
|
|
619
|
-
billingFrequency: "monthly",
|
|
620
|
-
pricePoints: {
|
|
621
|
-
USD: {
|
|
622
|
-
tiers: [
|
|
623
|
-
{
|
|
624
|
-
minQuantity: 0,
|
|
625
|
-
maxQuantity: 10,
|
|
626
|
-
unitPrice: 100,
|
|
627
|
-
},
|
|
628
|
-
{
|
|
629
|
-
minQuantity: 11,
|
|
630
|
-
maxQuantity: 100,
|
|
631
|
-
unitPrice: 90,
|
|
632
|
-
},
|
|
633
|
-
{
|
|
634
|
-
minQuantity: 101,
|
|
635
|
-
unitPrice: 80,
|
|
636
|
-
},
|
|
637
|
-
],
|
|
638
|
-
},
|
|
639
|
-
},
|
|
640
|
-
},
|
|
641
|
-
},
|
|
642
|
-
],
|
|
1602
|
+
await client.contacts.create({
|
|
1603
|
+
customerExternalId: "acme-inc",
|
|
1604
|
+
salutation: "Mr.",
|
|
1605
|
+
firstName: "John",
|
|
1606
|
+
lastName: "Doe",
|
|
1607
|
+
email: "john.doe@example.com",
|
|
643
1608
|
});
|
|
644
1609
|
```
|
|
645
1610
|
|
|
@@ -656,15 +1621,7 @@ await client.agents.update("agentId", {
|
|
|
656
1621
|
<dl>
|
|
657
1622
|
<dd>
|
|
658
1623
|
|
|
659
|
-
**
|
|
660
|
-
|
|
661
|
-
</dd>
|
|
662
|
-
</dl>
|
|
663
|
-
|
|
664
|
-
<dl>
|
|
665
|
-
<dd>
|
|
666
|
-
|
|
667
|
-
**request:** `Paid.AgentUpdate`
|
|
1624
|
+
**request:** `Paid.ContactCreate`
|
|
668
1625
|
|
|
669
1626
|
</dd>
|
|
670
1627
|
</dl>
|
|
@@ -672,7 +1629,7 @@ await client.agents.update("agentId", {
|
|
|
672
1629
|
<dl>
|
|
673
1630
|
<dd>
|
|
674
1631
|
|
|
675
|
-
**requestOptions:** `
|
|
1632
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
676
1633
|
|
|
677
1634
|
</dd>
|
|
678
1635
|
</dl>
|
|
@@ -683,7 +1640,7 @@ await client.agents.update("agentId", {
|
|
|
683
1640
|
</dl>
|
|
684
1641
|
</details>
|
|
685
1642
|
|
|
686
|
-
<details><summary><code>client.
|
|
1643
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>(contactId) -> Paid.Contact</code></summary>
|
|
687
1644
|
<dl>
|
|
688
1645
|
<dd>
|
|
689
1646
|
|
|
@@ -696,7 +1653,7 @@ await client.agents.update("agentId", {
|
|
|
696
1653
|
<dd>
|
|
697
1654
|
|
|
698
1655
|
```typescript
|
|
699
|
-
await client.
|
|
1656
|
+
await client.contacts.get("contactId");
|
|
700
1657
|
```
|
|
701
1658
|
|
|
702
1659
|
</dd>
|
|
@@ -712,7 +1669,7 @@ await client.agents.delete("agentId");
|
|
|
712
1669
|
<dl>
|
|
713
1670
|
<dd>
|
|
714
1671
|
|
|
715
|
-
**
|
|
1672
|
+
**contactId:** `string`
|
|
716
1673
|
|
|
717
1674
|
</dd>
|
|
718
1675
|
</dl>
|
|
@@ -720,7 +1677,7 @@ await client.agents.delete("agentId");
|
|
|
720
1677
|
<dl>
|
|
721
1678
|
<dd>
|
|
722
1679
|
|
|
723
|
-
**requestOptions:** `
|
|
1680
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
724
1681
|
|
|
725
1682
|
</dd>
|
|
726
1683
|
</dl>
|
|
@@ -731,7 +1688,7 @@ await client.agents.delete("agentId");
|
|
|
731
1688
|
</dl>
|
|
732
1689
|
</details>
|
|
733
1690
|
|
|
734
|
-
<details><summary><code>client.
|
|
1691
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">delete</a>(contactId) -> void</code></summary>
|
|
735
1692
|
<dl>
|
|
736
1693
|
<dd>
|
|
737
1694
|
|
|
@@ -744,7 +1701,7 @@ await client.agents.delete("agentId");
|
|
|
744
1701
|
<dd>
|
|
745
1702
|
|
|
746
1703
|
```typescript
|
|
747
|
-
await client.
|
|
1704
|
+
await client.contacts.delete("contactId");
|
|
748
1705
|
```
|
|
749
1706
|
|
|
750
1707
|
</dd>
|
|
@@ -760,7 +1717,7 @@ await client.agents.getByExternalId("externalId");
|
|
|
760
1717
|
<dl>
|
|
761
1718
|
<dd>
|
|
762
1719
|
|
|
763
|
-
**
|
|
1720
|
+
**contactId:** `string`
|
|
764
1721
|
|
|
765
1722
|
</dd>
|
|
766
1723
|
</dl>
|
|
@@ -768,7 +1725,7 @@ await client.agents.getByExternalId("externalId");
|
|
|
768
1725
|
<dl>
|
|
769
1726
|
<dd>
|
|
770
1727
|
|
|
771
|
-
**requestOptions:** `
|
|
1728
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
772
1729
|
|
|
773
1730
|
</dd>
|
|
774
1731
|
</dl>
|
|
@@ -779,7 +1736,7 @@ await client.agents.getByExternalId("externalId");
|
|
|
779
1736
|
</dl>
|
|
780
1737
|
</details>
|
|
781
1738
|
|
|
782
|
-
<details><summary><code>client.
|
|
1739
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Contact</code></summary>
|
|
783
1740
|
<dl>
|
|
784
1741
|
<dd>
|
|
785
1742
|
|
|
@@ -792,27 +1749,7 @@ await client.agents.getByExternalId("externalId");
|
|
|
792
1749
|
<dd>
|
|
793
1750
|
|
|
794
1751
|
```typescript
|
|
795
|
-
await client.
|
|
796
|
-
name: "Acme Agent (Updated)",
|
|
797
|
-
agentAttributes: [
|
|
798
|
-
{
|
|
799
|
-
name: "Emails sent signal",
|
|
800
|
-
active: true,
|
|
801
|
-
pricing: {
|
|
802
|
-
eventName: "emails_sent",
|
|
803
|
-
taxable: true,
|
|
804
|
-
chargeType: "usage",
|
|
805
|
-
pricingModel: "PerUnit",
|
|
806
|
-
billingFrequency: "monthly",
|
|
807
|
-
pricePoints: {
|
|
808
|
-
USD: {
|
|
809
|
-
unitPrice: 150,
|
|
810
|
-
},
|
|
811
|
-
},
|
|
812
|
-
},
|
|
813
|
-
},
|
|
814
|
-
],
|
|
815
|
-
});
|
|
1752
|
+
await client.contacts.getByExternalId("externalId");
|
|
816
1753
|
```
|
|
817
1754
|
|
|
818
1755
|
</dd>
|
|
@@ -836,15 +1773,7 @@ await client.agents.updateByExternalId("externalId", {
|
|
|
836
1773
|
<dl>
|
|
837
1774
|
<dd>
|
|
838
1775
|
|
|
839
|
-
**
|
|
840
|
-
|
|
841
|
-
</dd>
|
|
842
|
-
</dl>
|
|
843
|
-
|
|
844
|
-
<dl>
|
|
845
|
-
<dd>
|
|
846
|
-
|
|
847
|
-
**requestOptions:** `Agents.RequestOptions`
|
|
1776
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
848
1777
|
|
|
849
1778
|
</dd>
|
|
850
1779
|
</dl>
|
|
@@ -855,7 +1784,7 @@ await client.agents.updateByExternalId("externalId", {
|
|
|
855
1784
|
</dl>
|
|
856
1785
|
</details>
|
|
857
1786
|
|
|
858
|
-
<details><summary><code>client.
|
|
1787
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
|
|
859
1788
|
<dl>
|
|
860
1789
|
<dd>
|
|
861
1790
|
|
|
@@ -868,7 +1797,7 @@ await client.agents.updateByExternalId("externalId", {
|
|
|
868
1797
|
<dd>
|
|
869
1798
|
|
|
870
1799
|
```typescript
|
|
871
|
-
await client.
|
|
1800
|
+
await client.contacts.deleteByExternalId("externalId");
|
|
872
1801
|
```
|
|
873
1802
|
|
|
874
1803
|
</dd>
|
|
@@ -892,7 +1821,7 @@ await client.agents.deleteByExternalId("externalId");
|
|
|
892
1821
|
<dl>
|
|
893
1822
|
<dd>
|
|
894
1823
|
|
|
895
|
-
**requestOptions:** `
|
|
1824
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
896
1825
|
|
|
897
1826
|
</dd>
|
|
898
1827
|
</dl>
|
|
@@ -903,9 +1832,9 @@ await client.agents.deleteByExternalId("externalId");
|
|
|
903
1832
|
</dl>
|
|
904
1833
|
</details>
|
|
905
1834
|
|
|
906
|
-
##
|
|
1835
|
+
## Orders
|
|
907
1836
|
|
|
908
|
-
<details><summary><code>client.
|
|
1837
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>() -> Paid.Order[]</code></summary>
|
|
909
1838
|
<dl>
|
|
910
1839
|
<dd>
|
|
911
1840
|
|
|
@@ -918,7 +1847,7 @@ await client.agents.deleteByExternalId("externalId");
|
|
|
918
1847
|
<dd>
|
|
919
1848
|
|
|
920
1849
|
```typescript
|
|
921
|
-
await client.
|
|
1850
|
+
await client.orders.list();
|
|
922
1851
|
```
|
|
923
1852
|
|
|
924
1853
|
</dd>
|
|
@@ -934,7 +1863,7 @@ await client.contacts.list();
|
|
|
934
1863
|
<dl>
|
|
935
1864
|
<dd>
|
|
936
1865
|
|
|
937
|
-
**requestOptions:** `
|
|
1866
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
938
1867
|
|
|
939
1868
|
</dd>
|
|
940
1869
|
</dl>
|
|
@@ -945,7 +1874,7 @@ await client.contacts.list();
|
|
|
945
1874
|
</dl>
|
|
946
1875
|
</details>
|
|
947
1876
|
|
|
948
|
-
<details><summary><code>client.
|
|
1877
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">create</a>({ ...params }) -> Paid.Order</code></summary>
|
|
949
1878
|
<dl>
|
|
950
1879
|
<dd>
|
|
951
1880
|
|
|
@@ -958,12 +1887,13 @@ await client.contacts.list();
|
|
|
958
1887
|
<dd>
|
|
959
1888
|
|
|
960
1889
|
```typescript
|
|
961
|
-
await client.
|
|
1890
|
+
await client.orders.create({
|
|
962
1891
|
customerExternalId: "acme-inc",
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
1892
|
+
name: "Acme Order",
|
|
1893
|
+
description: "Acme Order is an order for Acme, Inc.",
|
|
1894
|
+
startDate: "2025-01-01",
|
|
1895
|
+
endDate: "2026-01-01",
|
|
1896
|
+
currency: "USD",
|
|
967
1897
|
});
|
|
968
1898
|
```
|
|
969
1899
|
|
|
@@ -980,7 +1910,7 @@ await client.contacts.create({
|
|
|
980
1910
|
<dl>
|
|
981
1911
|
<dd>
|
|
982
1912
|
|
|
983
|
-
**request:** `Paid.
|
|
1913
|
+
**request:** `Paid.OrderCreate`
|
|
984
1914
|
|
|
985
1915
|
</dd>
|
|
986
1916
|
</dl>
|
|
@@ -988,7 +1918,7 @@ await client.contacts.create({
|
|
|
988
1918
|
<dl>
|
|
989
1919
|
<dd>
|
|
990
1920
|
|
|
991
|
-
**requestOptions:** `
|
|
1921
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
992
1922
|
|
|
993
1923
|
</dd>
|
|
994
1924
|
</dl>
|
|
@@ -999,7 +1929,7 @@ await client.contacts.create({
|
|
|
999
1929
|
</dl>
|
|
1000
1930
|
</details>
|
|
1001
1931
|
|
|
1002
|
-
<details><summary><code>client.
|
|
1932
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">get</a>(orderId) -> Paid.Order</code></summary>
|
|
1003
1933
|
<dl>
|
|
1004
1934
|
<dd>
|
|
1005
1935
|
|
|
@@ -1012,7 +1942,7 @@ await client.contacts.create({
|
|
|
1012
1942
|
<dd>
|
|
1013
1943
|
|
|
1014
1944
|
```typescript
|
|
1015
|
-
await client.
|
|
1945
|
+
await client.orders.get("orderId");
|
|
1016
1946
|
```
|
|
1017
1947
|
|
|
1018
1948
|
</dd>
|
|
@@ -1028,7 +1958,7 @@ await client.contacts.get("contactId");
|
|
|
1028
1958
|
<dl>
|
|
1029
1959
|
<dd>
|
|
1030
1960
|
|
|
1031
|
-
**
|
|
1961
|
+
**orderId:** `string`
|
|
1032
1962
|
|
|
1033
1963
|
</dd>
|
|
1034
1964
|
</dl>
|
|
@@ -1036,7 +1966,7 @@ await client.contacts.get("contactId");
|
|
|
1036
1966
|
<dl>
|
|
1037
1967
|
<dd>
|
|
1038
1968
|
|
|
1039
|
-
**requestOptions:** `
|
|
1969
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
1040
1970
|
|
|
1041
1971
|
</dd>
|
|
1042
1972
|
</dl>
|
|
@@ -1047,7 +1977,7 @@ await client.contacts.get("contactId");
|
|
|
1047
1977
|
</dl>
|
|
1048
1978
|
</details>
|
|
1049
1979
|
|
|
1050
|
-
<details><summary><code>client.
|
|
1980
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">delete</a>(orderId) -> void</code></summary>
|
|
1051
1981
|
<dl>
|
|
1052
1982
|
<dd>
|
|
1053
1983
|
|
|
@@ -1060,7 +1990,7 @@ await client.contacts.get("contactId");
|
|
|
1060
1990
|
<dd>
|
|
1061
1991
|
|
|
1062
1992
|
```typescript
|
|
1063
|
-
await client.
|
|
1993
|
+
await client.orders.delete("orderId");
|
|
1064
1994
|
```
|
|
1065
1995
|
|
|
1066
1996
|
</dd>
|
|
@@ -1076,7 +2006,7 @@ await client.contacts.delete("contactId");
|
|
|
1076
2006
|
<dl>
|
|
1077
2007
|
<dd>
|
|
1078
2008
|
|
|
1079
|
-
**
|
|
2009
|
+
**orderId:** `string`
|
|
1080
2010
|
|
|
1081
2011
|
</dd>
|
|
1082
2012
|
</dl>
|
|
@@ -1084,7 +2014,7 @@ await client.contacts.delete("contactId");
|
|
|
1084
2014
|
<dl>
|
|
1085
2015
|
<dd>
|
|
1086
2016
|
|
|
1087
|
-
**requestOptions:** `
|
|
2017
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
1088
2018
|
|
|
1089
2019
|
</dd>
|
|
1090
2020
|
</dl>
|
|
@@ -1095,7 +2025,7 @@ await client.contacts.delete("contactId");
|
|
|
1095
2025
|
</dl>
|
|
1096
2026
|
</details>
|
|
1097
2027
|
|
|
1098
|
-
<details><summary><code>client.
|
|
2028
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">activate</a>(orderId) -> Paid.Order</code></summary>
|
|
1099
2029
|
<dl>
|
|
1100
2030
|
<dd>
|
|
1101
2031
|
|
|
@@ -1108,7 +2038,7 @@ await client.contacts.delete("contactId");
|
|
|
1108
2038
|
<dd>
|
|
1109
2039
|
|
|
1110
2040
|
```typescript
|
|
1111
|
-
await client.
|
|
2041
|
+
await client.orders.activate("orderId");
|
|
1112
2042
|
```
|
|
1113
2043
|
|
|
1114
2044
|
</dd>
|
|
@@ -1124,7 +2054,7 @@ await client.contacts.getByExternalId("externalId");
|
|
|
1124
2054
|
<dl>
|
|
1125
2055
|
<dd>
|
|
1126
2056
|
|
|
1127
|
-
**
|
|
2057
|
+
**orderId:** `string`
|
|
1128
2058
|
|
|
1129
2059
|
</dd>
|
|
1130
2060
|
</dl>
|
|
@@ -1132,7 +2062,7 @@ await client.contacts.getByExternalId("externalId");
|
|
|
1132
2062
|
<dl>
|
|
1133
2063
|
<dd>
|
|
1134
2064
|
|
|
1135
|
-
**requestOptions:** `
|
|
2065
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
1136
2066
|
|
|
1137
2067
|
</dd>
|
|
1138
2068
|
</dl>
|
|
@@ -1143,7 +2073,9 @@ await client.contacts.getByExternalId("externalId");
|
|
|
1143
2073
|
</dl>
|
|
1144
2074
|
</details>
|
|
1145
2075
|
|
|
1146
|
-
|
|
2076
|
+
## Plans
|
|
2077
|
+
|
|
2078
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getById</a>(planId) -> Paid.Plan</code></summary>
|
|
1147
2079
|
<dl>
|
|
1148
2080
|
<dd>
|
|
1149
2081
|
|
|
@@ -1156,7 +2088,7 @@ await client.contacts.getByExternalId("externalId");
|
|
|
1156
2088
|
<dd>
|
|
1157
2089
|
|
|
1158
2090
|
```typescript
|
|
1159
|
-
await client.
|
|
2091
|
+
await client.plans.getById("planId");
|
|
1160
2092
|
```
|
|
1161
2093
|
|
|
1162
2094
|
</dd>
|
|
@@ -1172,7 +2104,7 @@ await client.contacts.deleteByExternalId("externalId");
|
|
|
1172
2104
|
<dl>
|
|
1173
2105
|
<dd>
|
|
1174
2106
|
|
|
1175
|
-
**
|
|
2107
|
+
**planId:** `string` — The ID of the plan
|
|
1176
2108
|
|
|
1177
2109
|
</dd>
|
|
1178
2110
|
</dl>
|
|
@@ -1180,7 +2112,7 @@ await client.contacts.deleteByExternalId("externalId");
|
|
|
1180
2112
|
<dl>
|
|
1181
2113
|
<dd>
|
|
1182
2114
|
|
|
1183
|
-
**requestOptions:** `
|
|
2115
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
1184
2116
|
|
|
1185
2117
|
</dd>
|
|
1186
2118
|
</dl>
|
|
@@ -1191,9 +2123,7 @@ await client.contacts.deleteByExternalId("externalId");
|
|
|
1191
2123
|
</dl>
|
|
1192
2124
|
</details>
|
|
1193
2125
|
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>() -> Paid.Order[]</code></summary>
|
|
2126
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getUsage</a>(planId, { ...params }) -> Paid.UsageSummariesResponse</code></summary>
|
|
1197
2127
|
<dl>
|
|
1198
2128
|
<dd>
|
|
1199
2129
|
|
|
@@ -1206,7 +2136,13 @@ await client.contacts.deleteByExternalId("externalId");
|
|
|
1206
2136
|
<dd>
|
|
1207
2137
|
|
|
1208
2138
|
```typescript
|
|
1209
|
-
await client.
|
|
2139
|
+
await client.plans.getUsage("planId", {
|
|
2140
|
+
externalId: "externalId",
|
|
2141
|
+
limit: 1,
|
|
2142
|
+
offset: 1,
|
|
2143
|
+
startTime: "2024-01-15T09:30:00Z",
|
|
2144
|
+
endTime: "2024-01-15T09:30:00Z",
|
|
2145
|
+
});
|
|
1210
2146
|
```
|
|
1211
2147
|
|
|
1212
2148
|
</dd>
|
|
@@ -1222,7 +2158,23 @@ await client.orders.list();
|
|
|
1222
2158
|
<dl>
|
|
1223
2159
|
<dd>
|
|
1224
2160
|
|
|
1225
|
-
**
|
|
2161
|
+
**planId:** `string` — The ID of the plan
|
|
2162
|
+
|
|
2163
|
+
</dd>
|
|
2164
|
+
</dl>
|
|
2165
|
+
|
|
2166
|
+
<dl>
|
|
2167
|
+
<dd>
|
|
2168
|
+
|
|
2169
|
+
**request:** `Paid.PlansGetUsageRequest`
|
|
2170
|
+
|
|
2171
|
+
</dd>
|
|
2172
|
+
</dl>
|
|
2173
|
+
|
|
2174
|
+
<dl>
|
|
2175
|
+
<dd>
|
|
2176
|
+
|
|
2177
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
1226
2178
|
|
|
1227
2179
|
</dd>
|
|
1228
2180
|
</dl>
|
|
@@ -1233,7 +2185,7 @@ await client.orders.list();
|
|
|
1233
2185
|
</dl>
|
|
1234
2186
|
</details>
|
|
1235
2187
|
|
|
1236
|
-
<details><summary><code>client.
|
|
2188
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getGroupById</a>(planGroupId) -> Paid.PlanGroup</code></summary>
|
|
1237
2189
|
<dl>
|
|
1238
2190
|
<dd>
|
|
1239
2191
|
|
|
@@ -1246,14 +2198,7 @@ await client.orders.list();
|
|
|
1246
2198
|
<dd>
|
|
1247
2199
|
|
|
1248
2200
|
```typescript
|
|
1249
|
-
await client.
|
|
1250
|
-
customerExternalId: "acme-inc",
|
|
1251
|
-
name: "Acme Order",
|
|
1252
|
-
description: "Acme Order is an order for Acme, Inc.",
|
|
1253
|
-
startDate: "2025-01-01",
|
|
1254
|
-
endDate: "2026-01-01",
|
|
1255
|
-
currency: "USD",
|
|
1256
|
-
});
|
|
2201
|
+
await client.plans.getGroupById("planGroupId");
|
|
1257
2202
|
```
|
|
1258
2203
|
|
|
1259
2204
|
</dd>
|
|
@@ -1269,7 +2214,7 @@ await client.orders.create({
|
|
|
1269
2214
|
<dl>
|
|
1270
2215
|
<dd>
|
|
1271
2216
|
|
|
1272
|
-
**
|
|
2217
|
+
**planGroupId:** `string` — The ID of the plan group
|
|
1273
2218
|
|
|
1274
2219
|
</dd>
|
|
1275
2220
|
</dl>
|
|
@@ -1277,7 +2222,7 @@ await client.orders.create({
|
|
|
1277
2222
|
<dl>
|
|
1278
2223
|
<dd>
|
|
1279
2224
|
|
|
1280
|
-
**requestOptions:** `
|
|
2225
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
1281
2226
|
|
|
1282
2227
|
</dd>
|
|
1283
2228
|
</dl>
|
|
@@ -1288,10 +2233,27 @@ await client.orders.create({
|
|
|
1288
2233
|
</dl>
|
|
1289
2234
|
</details>
|
|
1290
2235
|
|
|
1291
|
-
|
|
2236
|
+
## Usage
|
|
2237
|
+
|
|
2238
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">recordBulk</a>({ ...params }) -> void</code></summary>
|
|
2239
|
+
<dl>
|
|
2240
|
+
<dd>
|
|
2241
|
+
|
|
2242
|
+
#### 📝 Description
|
|
2243
|
+
|
|
2244
|
+
<dl>
|
|
2245
|
+
<dd>
|
|
2246
|
+
|
|
1292
2247
|
<dl>
|
|
1293
2248
|
<dd>
|
|
1294
2249
|
|
|
2250
|
+
DEPRECATED: Use POST /usage/v2/signals/bulk instead for cleaner field names.
|
|
2251
|
+
|
|
2252
|
+
</dd>
|
|
2253
|
+
</dl>
|
|
2254
|
+
</dd>
|
|
2255
|
+
</dl>
|
|
2256
|
+
|
|
1295
2257
|
#### 🔌 Usage
|
|
1296
2258
|
|
|
1297
2259
|
<dl>
|
|
@@ -1301,7 +2263,9 @@ await client.orders.create({
|
|
|
1301
2263
|
<dd>
|
|
1302
2264
|
|
|
1303
2265
|
```typescript
|
|
1304
|
-
await client.
|
|
2266
|
+
await client.usage.recordBulk({
|
|
2267
|
+
signals: [{}, {}, {}],
|
|
2268
|
+
});
|
|
1305
2269
|
```
|
|
1306
2270
|
|
|
1307
2271
|
</dd>
|
|
@@ -1317,7 +2281,7 @@ await client.orders.get("orderId");
|
|
|
1317
2281
|
<dl>
|
|
1318
2282
|
<dd>
|
|
1319
2283
|
|
|
1320
|
-
**
|
|
2284
|
+
**request:** `Paid.UsageRecordBulkRequest`
|
|
1321
2285
|
|
|
1322
2286
|
</dd>
|
|
1323
2287
|
</dl>
|
|
@@ -1325,7 +2289,7 @@ await client.orders.get("orderId");
|
|
|
1325
2289
|
<dl>
|
|
1326
2290
|
<dd>
|
|
1327
2291
|
|
|
1328
|
-
**requestOptions:** `
|
|
2292
|
+
**requestOptions:** `Usage.RequestOptions`
|
|
1329
2293
|
|
|
1330
2294
|
</dd>
|
|
1331
2295
|
</dl>
|
|
@@ -1336,7 +2300,7 @@ await client.orders.get("orderId");
|
|
|
1336
2300
|
</dl>
|
|
1337
2301
|
</details>
|
|
1338
2302
|
|
|
1339
|
-
<details><summary><code>client.
|
|
2303
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">usageRecordBulkV2</a>({ ...params }) -> void</code></summary>
|
|
1340
2304
|
<dl>
|
|
1341
2305
|
<dd>
|
|
1342
2306
|
|
|
@@ -1349,7 +2313,29 @@ await client.orders.get("orderId");
|
|
|
1349
2313
|
<dd>
|
|
1350
2314
|
|
|
1351
2315
|
```typescript
|
|
1352
|
-
await client.
|
|
2316
|
+
await client.usage.usageRecordBulkV2({
|
|
2317
|
+
signals: [
|
|
2318
|
+
{
|
|
2319
|
+
event_name: "emails_sent",
|
|
2320
|
+
product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
|
|
2321
|
+
customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d",
|
|
2322
|
+
},
|
|
2323
|
+
{
|
|
2324
|
+
event_name: "emails_sent",
|
|
2325
|
+
external_product_id: "acme-product",
|
|
2326
|
+
external_customer_id: "acme-inc",
|
|
2327
|
+
},
|
|
2328
|
+
{
|
|
2329
|
+
event_name: "meeting_booked",
|
|
2330
|
+
product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
|
|
2331
|
+
external_customer_id: "acme-inc",
|
|
2332
|
+
data: {
|
|
2333
|
+
meeting_duration: 30,
|
|
2334
|
+
meeting_type: "demo",
|
|
2335
|
+
},
|
|
2336
|
+
},
|
|
2337
|
+
],
|
|
2338
|
+
});
|
|
1353
2339
|
```
|
|
1354
2340
|
|
|
1355
2341
|
</dd>
|
|
@@ -1365,7 +2351,7 @@ await client.orders.delete("orderId");
|
|
|
1365
2351
|
<dl>
|
|
1366
2352
|
<dd>
|
|
1367
2353
|
|
|
1368
|
-
**
|
|
2354
|
+
**request:** `Paid.UsageRecordBulkV2Request`
|
|
1369
2355
|
|
|
1370
2356
|
</dd>
|
|
1371
2357
|
</dl>
|
|
@@ -1373,7 +2359,7 @@ await client.orders.delete("orderId");
|
|
|
1373
2359
|
<dl>
|
|
1374
2360
|
<dd>
|
|
1375
2361
|
|
|
1376
|
-
**requestOptions:** `
|
|
2362
|
+
**requestOptions:** `Usage.RequestOptions`
|
|
1377
2363
|
|
|
1378
2364
|
</dd>
|
|
1379
2365
|
</dl>
|
|
@@ -1384,7 +2370,7 @@ await client.orders.delete("orderId");
|
|
|
1384
2370
|
</dl>
|
|
1385
2371
|
</details>
|
|
1386
2372
|
|
|
1387
|
-
<details><summary><code>client.
|
|
2373
|
+
<details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">checkUsage</a>({ ...params }) -> Paid.UsageCheckUsageResponse</code></summary>
|
|
1388
2374
|
<dl>
|
|
1389
2375
|
<dd>
|
|
1390
2376
|
|
|
@@ -1397,7 +2383,10 @@ await client.orders.delete("orderId");
|
|
|
1397
2383
|
<dd>
|
|
1398
2384
|
|
|
1399
2385
|
```typescript
|
|
1400
|
-
await client.
|
|
2386
|
+
await client.usage.checkUsage({
|
|
2387
|
+
externalCustomerId: "acme-inc",
|
|
2388
|
+
externalProductId: "acme-agent",
|
|
2389
|
+
});
|
|
1401
2390
|
```
|
|
1402
2391
|
|
|
1403
2392
|
</dd>
|
|
@@ -1413,7 +2402,7 @@ await client.orders.activate("orderId");
|
|
|
1413
2402
|
<dl>
|
|
1414
2403
|
<dd>
|
|
1415
2404
|
|
|
1416
|
-
**
|
|
2405
|
+
**request:** `Paid.UsageCheckUsageRequest`
|
|
1417
2406
|
|
|
1418
2407
|
</dd>
|
|
1419
2408
|
</dl>
|
|
@@ -1421,7 +2410,7 @@ await client.orders.activate("orderId");
|
|
|
1421
2410
|
<dl>
|
|
1422
2411
|
<dd>
|
|
1423
2412
|
|
|
1424
|
-
**requestOptions:** `
|
|
2413
|
+
**requestOptions:** `Usage.RequestOptions`
|
|
1425
2414
|
|
|
1426
2415
|
</dd>
|
|
1427
2416
|
</dl>
|
|
@@ -1432,9 +2421,9 @@ await client.orders.activate("orderId");
|
|
|
1432
2421
|
</dl>
|
|
1433
2422
|
</details>
|
|
1434
2423
|
|
|
1435
|
-
##
|
|
2424
|
+
## Traces
|
|
1436
2425
|
|
|
1437
|
-
<details><summary><code>client.
|
|
2426
|
+
<details><summary><code>client.traces.<a href="/src/api/resources/traces/client/Client.ts">getTraces</a>({ ...params }) -> Paid.TracesResponse</code></summary>
|
|
1438
2427
|
<dl>
|
|
1439
2428
|
<dd>
|
|
1440
2429
|
|
|
@@ -1447,8 +2436,15 @@ await client.orders.activate("orderId");
|
|
|
1447
2436
|
<dd>
|
|
1448
2437
|
|
|
1449
2438
|
```typescript
|
|
1450
|
-
await client.
|
|
1451
|
-
|
|
2439
|
+
await client.traces.getTraces({
|
|
2440
|
+
limit: 1,
|
|
2441
|
+
offset: 1,
|
|
2442
|
+
startTime: "2024-01-15T09:30:00Z",
|
|
2443
|
+
endTime: "2024-01-15T09:30:00Z",
|
|
2444
|
+
externalCustomerId: "externalCustomerId",
|
|
2445
|
+
externalProductId: "externalProductId",
|
|
2446
|
+
externalAgentId: "externalAgentId",
|
|
2447
|
+
metadata: "metadata",
|
|
1452
2448
|
});
|
|
1453
2449
|
```
|
|
1454
2450
|
|
|
@@ -1465,7 +2461,7 @@ await client.usage.recordBulk({
|
|
|
1465
2461
|
<dl>
|
|
1466
2462
|
<dd>
|
|
1467
2463
|
|
|
1468
|
-
**request:** `Paid.
|
|
2464
|
+
**request:** `Paid.GetTracesRequest`
|
|
1469
2465
|
|
|
1470
2466
|
</dd>
|
|
1471
2467
|
</dl>
|
|
@@ -1473,7 +2469,7 @@ await client.usage.recordBulk({
|
|
|
1473
2469
|
<dl>
|
|
1474
2470
|
<dd>
|
|
1475
2471
|
|
|
1476
|
-
**requestOptions:** `
|
|
2472
|
+
**requestOptions:** `Traces.RequestOptions`
|
|
1477
2473
|
|
|
1478
2474
|
</dd>
|
|
1479
2475
|
</dl>
|
|
@@ -1502,12 +2498,10 @@ await client.usage.recordBulk({
|
|
|
1502
2498
|
await client.orders.lines.update("orderId", {
|
|
1503
2499
|
lines: [
|
|
1504
2500
|
{
|
|
1505
|
-
agentExternalId: "acme-agent",
|
|
1506
2501
|
name: "Order Line One",
|
|
1507
2502
|
description: "Order Line One is an order line for Acme, Inc.",
|
|
1508
2503
|
},
|
|
1509
2504
|
{
|
|
1510
|
-
agentExternalId: "acme-agent-2",
|
|
1511
2505
|
name: "Order Line Two",
|
|
1512
2506
|
description: "Order Line Two is an order line for Acme, Inc.",
|
|
1513
2507
|
},
|