@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../../index";
 /**
  * @example
  *     {}
@@ -9,11 +10,15 @@ export interface CountBillingProductsRequest {
     ids?: string | string[];
     name?: string;
     q?: string;
-    priceUsageType?: string;
+    priceUsageType?: Schematic.CountBillingProductsRequestPriceUsageType;
     /**
      * Filter products that are not linked to any plan
      */
     withoutLinkedToPlan?: boolean;
+    /**
+     * Filter products that are one time charges
+     */
+    withOneTimeCharges?: boolean;
     /**
      * Filter products that have zero price for free subscription type
      */
@@ -22,6 +27,10 @@ export interface CountBillingProductsRequest {
      * Filter products that have prices
      */
     withPricesOnly?: boolean;
+    /**
+     * Filter products that are active
+     */
+    isActive?: boolean;
     /**
      * Page limit (default 100)
      */

package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts

@@ -6,6 +6,7 @@
  *     {}
  */
 export interface CountCustomersRequest {
+    companyIds?: string | string[];
     name?: string;
     failedToImport?: boolean;
     q?: string;

package/dist/api/resources/billing/client/requests/CreateBillingCustomerRequestBody.d.ts

@@ -15,6 +15,7 @@
  */
 export interface CreateBillingCustomerRequestBody {
     companyId?: string;
+    defaultPaymentMethodId?: string;
     email: string;
     externalId: string;
     failedToImport: boolean;

package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts

@@ -1,25 +1,37 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         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"
  *     }
  */
 export interface CreateBillingPriceRequestBody {
+    billingScheme: Schematic.CreateBillingPriceRequestBodyBillingScheme;
     currency: string;
+    externalAccountId: string;
     interval: string;
     isActive: boolean;
     meterId?: string;
+    packageSize?: number;
     price: number;
+    priceDecimal?: string;
     priceExternalId: string;
+    priceTiers: Schematic.CreateBillingPriceTierRequestBody[];
     productExternalId: string;
-    usageType: string;
+    tierMode?: Schematic.CreateBillingPriceRequestBodyTierMode;
+    usageType: Schematic.CreateBillingPriceRequestBodyUsageType;
 }

package/dist/api/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts

@@ -4,17 +4,14 @@
 /**
  * @example
  *     {
- *         currency: "currency",
  *         externalId: "external_id",
  *         name: "name",
- *         price: 1.1,
- *         quantity: 1
+ *         price: 1.1
  *     }
  */
 export interface CreateBillingProductRequestBody {
-    currency: string;
     externalId: string;
+    isActive?: boolean;
     name: string;
     price: number;
-    quantity: number;
 }

package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.d.ts

@@ -5,6 +5,7 @@ import * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         cancelAtPeriodEnd: true,
  *         currency: "currency",
  *         customerExternalId: "customer_external_id",
  *         discounts: [{
@@ -21,15 +22,18 @@ import * as Schematic from "../../../../index";
  *                 priceExternalId: "price_external_id",
  *                 productExternalId: "product_external_id",
  *                 quantity: 1,
- *                 usageType: "usage_type"
+ *                 usageType: "licensed"
  *             }],
  *         subscriptionExternalId: "subscription_external_id",
  *         totalPrice: 1
  *     }
  */
 export interface CreateBillingSubscriptionsRequestBody {
+    cancelAt?: number;
+    cancelAtPeriodEnd: boolean;
     currency: string;
     customerExternalId: string;
+    defaultPaymentMethodId?: string;
     discounts: Schematic.BillingSubscriptionDiscount[];
     expiredAt: Date;
     interval?: string;
@@ -41,5 +45,5 @@ export interface CreateBillingSubscriptionsRequestBody {
     subscriptionExternalId: string;
     totalPrice: number;
     trialEnd?: number;
-    trialEndSetting?: string;
+    trialEndSetting?: Schematic.CreateBillingSubscriptionsRequestBodyTrialEndSetting;
 }

package/dist/api/resources/billing/client/requests/CreatePaymentMethodRequestBody.d.ts

@@ -22,5 +22,4 @@ export interface CreatePaymentMethodRequestBody {
     customerExternalId: string;
     externalId: string;
     paymentMethodType: string;
-    subscriptionExternalId?: string;
 }

package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../../index";
 /**
  * @example
  *     {}
@@ -9,11 +10,15 @@ export interface ListBillingProductsRequest {
     ids?: string | string[];
     name?: string;
     q?: string;
-    priceUsageType?: string;
+    priceUsageType?: Schematic.ListBillingProductsRequestPriceUsageType;
     /**
      * Filter products that are not linked to any plan
      */
     withoutLinkedToPlan?: boolean;
+    /**
+     * Filter products that are one time charges
+     */
+    withOneTimeCharges?: boolean;
     /**
      * Filter products that have zero price for free subscription type
      */
@@ -22,6 +27,10 @@ export interface ListBillingProductsRequest {
      * Filter products that have prices
      */
     withPricesOnly?: boolean;
+    /**
+     * Filter products that are active
+     */
+    isActive?: boolean;
     /**
      * Page limit (default 100)
      */

package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ListCouponsRequest {
+    isActive?: boolean;
+    q?: string;
+    /**
+     * Page limit (default 100)
+     */
+    limit?: number;
+    /**
+     * Page offset (default 0)
+     */
+    offset?: number;
+}

package/dist/api/resources/billing/client/requests/ListCouponsRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/billing/client/requests/{ListCustomersRequest.d.ts → ListCustomersWithSubscriptionsRequest.d.ts}

@@ -5,7 +5,8 @@
  * @example
  *     {}
  */
-export interface ListCustomersRequest {
+export interface ListCustomersWithSubscriptionsRequest {
+    companyIds?: string | string[];
     name?: string;
     failedToImport?: boolean;
     q?: string;

package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts

@@ -10,7 +10,6 @@
 export interface ListPaymentMethodsRequest {
     companyId?: string;
     customerExternalId: string;
-    subscriptionExternalId?: string;
     /**
      * Page limit (default 100)
      */

package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../../index";
 /**
  * @example
  *     {}
@@ -9,11 +10,15 @@ export interface ListProductPricesRequest {
     ids?: string | string[];
     name?: string;
     q?: string;
-    priceUsageType?: string;
+    priceUsageType?: Schematic.ListProductPricesRequestPriceUsageType;
     /**
      * Filter products that are not linked to any plan
      */
     withoutLinkedToPlan?: boolean;
+    /**
+     * Filter products that are one time charges
+     */
+    withOneTimeCharges?: boolean;
     /**
      * Filter products that have zero price for free subscription type
      */
@@ -22,6 +27,10 @@ export interface ListProductPricesRequest {
      * Filter products that have prices
      */
     withPricesOnly?: boolean;
+    /**
+     * Filter products that are active
+     */
+    isActive?: boolean;
     /**
      * Page limit (default 100)
      */

package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts

@@ -1,14 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../../index";
 /**
  * @example
  *     {}
  */
 export interface SearchBillingPricesRequest {
     ids?: string | string[];
+    q?: string;
     interval?: string;
-    usageType?: string;
+    usageType?: Schematic.SearchBillingPricesRequestUsageType;
     price?: number;
     /**
      * Page limit (default 100)

package/dist/api/resources/billing/client/requests/index.d.ts

@@ -1,6 +1,7 @@
+export { type ListCouponsRequest } from "./ListCouponsRequest";
 export { type CreateCouponRequestBody } from "./CreateCouponRequestBody";
 export { type CreateBillingCustomerRequestBody } from "./CreateBillingCustomerRequestBody";
-export { type ListCustomersRequest } from "./ListCustomersRequest";
+export { type ListCustomersWithSubscriptionsRequest } from "./ListCustomersWithSubscriptionsRequest";
 export { type CountCustomersRequest } from "./CountCustomersRequest";
 export { type ListInvoicesRequest } from "./ListInvoicesRequest";
 export { type CreateInvoiceRequestBody } from "./CreateInvoiceRequestBody";

package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts

@@ -1,18 +1,23 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../index";
 /**
  * Input parameters
  */
 export interface CountBillingProductsParams {
     ids?: string[];
+    /** Filter products that are active */
+    isActive?: boolean;
     /** Page limit (default 100) */
     limit?: number;
     name?: string;
     /** Page offset (default 0) */
     offset?: number;
-    priceUsageType?: string;
+    priceUsageType?: Schematic.CountBillingProductsResponseParamsPriceUsageType;
     q?: string;
+    /** Filter products that are one time charges */
+    withOneTimeCharges?: boolean;
     /** Filter products that have prices */
     withPricesOnly?: boolean;
     /** Filter products that have zero price for free subscription type */

package/dist/api/resources/billing/types/CountBillingProductsRequestPriceUsageType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CountBillingProductsRequestPriceUsageType = "licensed" | "metered";
+export declare const CountBillingProductsRequestPriceUsageType: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};

package/dist/api/resources/billing/types/CountBillingProductsRequestPriceUsageType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CountBillingProductsRequestPriceUsageType = void 0;
+exports.CountBillingProductsRequestPriceUsageType = {
+    Licensed: "licensed",
+    Metered: "metered",
+};

package/dist/api/resources/billing/types/CountBillingProductsResponseParamsPriceUsageType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CountBillingProductsResponseParamsPriceUsageType = "licensed" | "metered";
+export declare const CountBillingProductsResponseParamsPriceUsageType: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};

package/dist/api/resources/billing/types/CountBillingProductsResponseParamsPriceUsageType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CountBillingProductsResponseParamsPriceUsageType = void 0;
+exports.CountBillingProductsResponseParamsPriceUsageType = {
+    Licensed: "licensed",
+    Metered: "metered",
+};

package/dist/api/resources/billing/types/CountCustomersParams.d.ts

@@ -5,6 +5,7 @@
  * Input parameters
  */
 export interface CountCustomersParams {
+    companyIds?: string[];
     failedToImport?: boolean;
     /** Page limit (default 100) */
     limit?: number;

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingPriceRequestBodyBillingScheme = "per_unit" | "tiered";
+export declare const CreateBillingPriceRequestBodyBillingScheme: {
+    readonly PerUnit: "per_unit";
+    readonly Tiered: "tiered";
+};

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBillingPriceRequestBodyBillingScheme = void 0;
+exports.CreateBillingPriceRequestBodyBillingScheme = {
+    PerUnit: "per_unit",
+    Tiered: "tiered",
+};

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingPriceRequestBodyTierMode = "volume" | "graduated";
+export declare const CreateBillingPriceRequestBodyTierMode: {
+    readonly Volume: "volume";
+    readonly Graduated: "graduated";
+};

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBillingPriceRequestBodyTierMode = void 0;
+exports.CreateBillingPriceRequestBodyTierMode = {
+    Volume: "volume",
+    Graduated: "graduated",
+};

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyUsageType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingPriceRequestBodyUsageType = "licensed" | "metered";
+export declare const CreateBillingPriceRequestBodyUsageType: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};

package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyUsageType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBillingPriceRequestBodyUsageType = void 0;
+exports.CreateBillingPriceRequestBodyUsageType = {
+    Licensed: "licensed",
+    Metered: "metered",
+};

package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreateBillingSubscriptionsRequestBodyTrialEndSetting = "subscribe" | "cancel";
+export declare const CreateBillingSubscriptionsRequestBodyTrialEndSetting: {
+    readonly Subscribe: "subscribe";
+    readonly Cancel: "cancel";
+};

package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateBillingSubscriptionsRequestBodyTrialEndSetting = void 0;
+exports.CreateBillingSubscriptionsRequestBodyTrialEndSetting = {
+    Subscribe: "subscribe",
+    Cancel: "cancel",
+};

package/dist/api/resources/billing/types/DeleteBillingProductResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface DeleteBillingProductResponse {
+    data: Schematic.DeleteResponse;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/billing/types/DeleteBillingProductResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts

@@ -1,18 +1,23 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../../../index";
 /**
  * Input parameters
  */
 export interface ListBillingProductsParams {
     ids?: string[];
+    /** Filter products that are active */
+    isActive?: boolean;
     /** Page limit (default 100) */
     limit?: number;
     name?: string;
     /** Page offset (default 0) */
     offset?: number;
-    priceUsageType?: string;
+    priceUsageType?: Schematic.ListBillingProductsResponseParamsPriceUsageType;
     q?: string;
+    /** Filter products that are one time charges */
+    withOneTimeCharges?: boolean;
     /** Filter products that have prices */
     withPricesOnly?: boolean;
     /** Filter products that have zero price for free subscription type */

package/dist/api/resources/billing/types/ListBillingProductsRequestPriceUsageType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ListBillingProductsRequestPriceUsageType = "licensed" | "metered";
+export declare const ListBillingProductsRequestPriceUsageType: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};

package/dist/api/resources/billing/types/ListBillingProductsRequestPriceUsageType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListBillingProductsRequestPriceUsageType = void 0;
+exports.ListBillingProductsRequestPriceUsageType = {
+    Licensed: "licensed",
+    Metered: "metered",
+};

package/dist/api/resources/billing/types/ListBillingProductsResponseParamsPriceUsageType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ListBillingProductsResponseParamsPriceUsageType = "licensed" | "metered";
+export declare const ListBillingProductsResponseParamsPriceUsageType: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};

package/dist/api/resources/billing/types/ListBillingProductsResponseParamsPriceUsageType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListBillingProductsResponseParamsPriceUsageType = void 0;
+exports.ListBillingProductsResponseParamsPriceUsageType = {
+    Licensed: "licensed",
+    Metered: "metered",
+};

package/dist/api/resources/billing/types/ListCouponsParams.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface ListCouponsParams {
+    isActive?: boolean;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    q?: string;
+}

package/dist/api/resources/billing/types/ListCouponsParams.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/billing/types/ListCouponsResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface ListCouponsResponse {
+    /** The returned resources */
+    data: Schematic.BillingCouponResponseData[];
+    /** Input parameters */
+    params: Schematic.ListCouponsParams;
+}

package/dist/api/resources/billing/types/ListCouponsResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/{api/resources/billing/types/ListCustomersParams.d.ts → dist/api/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts}

@@ -4,7 +4,8 @@
 /**
  * Input parameters
  */
-export interface ListCustomersParams {
+export interface ListCustomersWithSubscriptionsParams {
+    companyIds?: string[];
     failedToImport?: boolean;
     /** Page limit (default 100) */
     limit?: number;

package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsParams.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/{api/resources/billing/types/ListCustomersResponse.d.ts → dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts}

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../../../index";
-export interface ListCustomersResponse {
+export interface ListCustomersWithSubscriptionsResponse {
     /** The returned resources */
     data: Schematic.BillingCustomerWithSubscriptionsResponseData[];
     /** Input parameters */
-    params: Schematic.ListCustomersParams;
+    params: Schematic.ListCustomersWithSubscriptionsParams;
 }

package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/billing/types/ListPaymentMethodsParams.d.ts

@@ -11,5 +11,4 @@ export interface ListPaymentMethodsParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
-    subscriptionExternalId?: string;
 }