@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

package/reference.md

@@ -699,6 +699,46 @@ await client.accounts.deleteEnvironment("environment_id");
 </dl>
 </details>
 
+<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">quickstart</a>() -> Schematic.QuickstartResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.accounts.quickstart();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Accounts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## features
 
 <details><summary><code>client.features.<a href="/src/api/resources/features/client/Client.ts">countAudienceCompanies</a>({ ...params }) -> Schematic.CountAudienceCompaniesResponse</code></summary>
@@ -1765,6 +1805,54 @@ await client.features.countFlags();
 
 ## billing
 
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCoupons</a>({ ...params }) -> Schematic.ListCouponsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.listCoupons();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.ListCouponsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">upsertBillingCoupon</a>({ ...params }) -> Schematic.UpsertBillingCouponResponse</code></summary>
 <dl>
 <dd>
@@ -1878,7 +1966,7 @@ await client.billing.upsertBillingCustomer({
 </dl>
 </details>
 
-<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCustomers</a>({ ...params }) -> Schematic.ListCustomersResponse</code></summary>
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCustomersWithSubscriptions</a>({ ...params }) -> Schematic.ListCustomersWithSubscriptionsResponse</code></summary>
 <dl>
 <dd>
 
@@ -1891,7 +1979,7 @@ await client.billing.upsertBillingCustomer({
 <dd>
 
 ```typescript
-await client.billing.listCustomers();
+await client.billing.listCustomersWithSubscriptions();
 ```
 
 </dd>
@@ -1907,7 +1995,7 @@ await client.billing.listCustomers();
 <dl>
 <dd>
 
-**request:** `Schematic.ListCustomersRequest`
+**request:** `Schematic.ListCustomersWithSubscriptionsRequest`
 
 </dd>
 </dl>
@@ -2345,13 +2433,20 @@ await client.billing.searchBillingPrices();
 
 ```typescript
 await client.billing.upsertBillingPrice({
+    billingScheme: "per_unit",
     currency: "currency",
+    externalAccountId: "external_account_id",
     interval: "interval",
     isActive: true,
     price: 1,
     priceExternalId: "price_external_id",
+    priceTiers: [
+        {
+            priceExternalId: "price_external_id",
+        },
+    ],
     productExternalId: "product_external_id",
-    usageType: "usage_type",
+    usageType: "licensed",
 });
 ```
 
@@ -2387,6 +2482,54 @@ await client.billing.upsertBillingPrice({
 </dl>
 </details>
 
+<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">deleteBillingProduct</a>(billingId) -> Schematic.DeleteBillingProductResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.deleteBillingProduct("billing_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**billingId:** `string` — billing_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Billing.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listProductPrices</a>({ ...params }) -> Schematic.ListProductPricesResponse</code></summary>
 <dl>
 <dd>
@@ -2497,11 +2640,9 @@ await client.billing.deleteProductPrice("billing_id");
 
 ```typescript
 await client.billing.upsertBillingProduct({
-    currency: "currency",
     externalId: "external_id",
     name: "name",
     price: 1.1,
-    quantity: 1,
 });
 ```
 
@@ -2647,6 +2788,7 @@ await client.billing.countBillingProducts();
 
 ```typescript
 await client.billing.upsertBillingSubscription({
+    cancelAtPeriodEnd: true,
     currency: "currency",
     customerExternalId: "customer_external_id",
     discounts: [
@@ -2666,7 +2808,7 @@ await client.billing.upsertBillingSubscription({
             priceExternalId: "price_external_id",
             productExternalId: "product_external_id",
             quantity: 1,
-            usageType: "usage_type",
+            usageType: "licensed",
         },
     ],
     subscriptionExternalId: "subscription_external_id",
@@ -2772,7 +2914,7 @@ await client.checkout.internal({
 </dl>
 </details>
 
-<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">getCheckoutData</a>(checkoutInternalId) -> Schematic.GetCheckoutDataResponse</code></summary>
+<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">getCheckoutData</a>({ ...params }) -> Schematic.GetCheckoutDataResponse</code></summary>
 <dl>
 <dd>
 
@@ -2785,7 +2927,9 @@ await client.checkout.internal({
 <dd>
 
 ```typescript
-await client.checkout.getCheckoutData("checkout_internal_id");
+await client.checkout.getCheckoutData({
+    companyId: "company_id",
+});
 ```
 
 </dd>
@@ -2801,7 +2945,7 @@ await client.checkout.getCheckoutData("checkout_internal_id");
 <dl>
 <dd>
 
-**checkoutInternalId:** `string` — checkout_internal_id
+**request:** `Schematic.CheckoutDataRequestBody`
 
 </dd>
 </dl>
@@ -3305,9 +3449,7 @@ await client.companies.deleteCompanyByKeys({
 ```typescript
 await client.companies.lookupCompany({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -4158,6 +4300,11 @@ await client.companies.listUsers();
 
 ```typescript
 await client.companies.upsertUser({
+    companies: [
+        {
+            key: "value",
+        },
+    ],
     company: {
         key: "value",
     },
@@ -4357,6 +4504,11 @@ await client.companies.countUsers();
 
 ```typescript
 await client.companies.createUser({
+    companies: [
+        {
+            key: "value",
+        },
+    ],
     company: {
         key: "value",
     },
@@ -4465,9 +4617,7 @@ await client.companies.deleteUserByKeys({
 ```typescript
 await client.companies.lookupUser({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -5421,9 +5571,7 @@ await client.entitlements.countPlanEntitlements();
 ```typescript
 await client.entitlements.getFeatureUsageByCompany({
     keys: {
-        keys: {
-            key: "value",
-        },
+        keys: "keys",
     },
 });
 ```
@@ -5691,6 +5839,309 @@ await client.plans.deleteAudience("plan_audience_id");
 </dl>
 </details>
 
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listPlanTraits</a>({ ...params }) -> Schematic.ListPlanTraitsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.listPlanTraits();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.ListPlanTraitsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">createPlanTrait</a>({ ...params }) -> Schematic.CreatePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.createPlanTrait({
+    planId: "plan_id",
+    traitId: "trait_id",
+    traitValue: "trait_value",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CreatePlanTraitRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getPlanTrait</a>(planTraitId) -> Schematic.GetPlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.getPlanTrait("plan_trait_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updatePlanTrait</a>(planTraitId, { ...params }) -> Schematic.UpdatePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.updatePlanTrait("plan_trait_id", {
+    planId: "plan_id",
+    traitValue: "trait_value",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Schematic.UpdatePlanTraitRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">deletePlanTrait</a>(planTraitId) -> Schematic.DeletePlanTraitResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.deletePlanTrait("plan_trait_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planTraitId:** `string` — plan_trait_id
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">countPlanTraits</a>({ ...params }) -> Schematic.CountPlanTraitsResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.countPlanTraits();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CountPlanTraitsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listPlans</a>({ ...params }) -> Schematic.ListPlansResponse</code></summary>
 <dl>
 <dd>
@@ -6665,6 +7116,58 @@ await client.crm.upsertCrmProduct({
 </dl>
 </details>
 
+## dataexports
+
+<details><summary><code>client.dataexports.<a href="/src/api/resources/dataexports/client/Client.ts">createDataExport</a>({ ...params }) -> Schematic.CreateDataExportResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dataexports.createDataExport({
+    metadata: "metadata",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Schematic.CreateDataExportRequestBody`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dataexports.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## events
 
 <details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEventBatch</a>({ ...params }) -> Schematic.CreateEventBatchResponse</code></summary>
@@ -7012,7 +7515,11 @@ await client.plangroups.getPlanGroup();
 ```typescript
 await client.plangroups.createPlanGroup({
     addOnIds: ["add_on_ids"],
-    planIds: ["plan_ids"],
+    orderedPlans: [
+        {
+            planId: "plan_id",
+        },
+    ],
 });
 ```
 
@@ -7063,7 +7570,11 @@ await client.plangroups.createPlanGroup({
 ```typescript
 await client.plangroups.updatePlanGroup("plan_group_id", {
     addOnIds: ["add_on_ids"],
-    planIds: ["plan_ids"],
+    orderedPlans: [
+        {
+            planId: "plan_id",
+        },
+    ],
 });
 ```