@schematichq/schematic-typescript-node 1.1.2 → 1.1.5

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

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface CountBillingProductsRequest {
+    ids?: string | string[];
+    name?: string;
+    q?: string;
+    /**
+     * Filter products that are not linked to any plan
+     */
+    withoutLinkedToPlan?: boolean;
+    /**
+     * Page limit (default 100)
+     */
+    limit?: number;
+    /**
+     * Page offset (default 0)
+     */
+    offset?: number;
+}

package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.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/CreateBillingPriceRequestBody.d.ts

@@ -4,6 +4,7 @@
 /**
  * @example
  *     {
+ *         currency: "currency",
  *         interval: "interval",
  *         price: 1,
  *         priceExternalId: "price_external_id",
@@ -11,6 +12,7 @@
  *     }
  */
 export interface CreateBillingPriceRequestBody {
+    currency: string;
     interval: string;
     price: number;
     priceExternalId: string;

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

@@ -5,10 +5,14 @@ import * as Schematic from "../../../../index";
 /**
  * @example
  *     {
+ *         currency: "currency",
  *         customerExternalId: "customer_external_id",
- *         expiredAt: new Date("2024-01-15T09:30:00.000Z"),
+ *         expiredAt: "2024-01-15T09:30:00Z",
  *         productExternalIds: [{
+ *                 currency: "currency",
+ *                 interval: "interval",
  *                 price: 1,
+ *                 priceExternalId: "price_external_id",
  *                 productExternalId: "product_external_id"
  *             }],
  *         subscriptionExternalId: "subscription_external_id",
@@ -16,10 +20,13 @@ import * as Schematic from "../../../../index";
  *     }
  */
 export interface CreateBillingSubscriptionsRequestBody {
+    currency: string;
     customerExternalId: string;
     expiredAt: Date;
     interval?: string;
     metadata?: Record<string, unknown>;
+    periodEnd?: number;
+    periodStart?: number;
     productExternalIds: Schematic.BillingProductPricing[];
     status?: string;
     subscriptionExternalId: string;

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         amountDue: 1,
+ *         amountPaid: 1,
+ *         amountRemaining: 1,
+ *         collectionMethod: "collection_method",
+ *         currency: "currency",
+ *         customerExternalId: "customer_external_id",
+ *         subtotal: 1
+ *     }
+ */
+export interface CreateInvoiceRequestBody {
+    amountDue: number;
+    amountPaid: number;
+    amountRemaining: number;
+    collectionMethod: string;
+    currency: string;
+    customerExternalId: string;
+    dueDate?: Date;
+    externalId?: string;
+    paymentMethodExternalId?: string;
+    subscriptionExternalId?: string;
+    subtotal: number;
+    url?: string;
+}

package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.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/CreateMeterRequestBody.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         displayName: "DisplayName",
+ *         eventName: "EventName",
+ *         eventPayloadKey: "EventPayloadKey",
+ *         externalId: "external_id"
+ *     }
+ */
+export interface CreateMeterRequestBody {
+    displayName: string;
+    eventName: string;
+    eventPayloadKey: string;
+    externalId: string;
+}

package/dist/api/resources/billing/client/requests/CreateMeterRequestBody.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/CreatePaymentMethodRequestBody.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customer_external_id",
+ *         externalId: "external_id",
+ *         paymentMethodType: "payment_method_type"
+ *     }
+ */
+export interface CreatePaymentMethodRequestBody {
+    accountLast4?: string;
+    accountName?: string;
+    bankName?: string;
+    billingEmail?: string;
+    billingName?: string;
+    cardBrand?: string;
+    cardExpMonth?: number;
+    cardExpYear?: number;
+    cardLast4?: string;
+    customerExternalId: string;
+    externalId: string;
+    paymentMethodType: string;
+    subscriptionExternalId?: string;
+}

package/dist/api/resources/billing/client/requests/CreatePaymentMethodRequestBody.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/ListBillingProductsRequest.d.ts

@@ -9,6 +9,10 @@ export interface ListBillingProductsRequest {
     ids?: string | string[];
     name?: string;
     q?: string;
+    /**
+     * Filter products that are not linked to any plan
+     */
+    withoutLinkedToPlan?: boolean;
     /**
      * Page limit (default 100)
      */

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customer_external_id"
+ *     }
+ */
+export interface ListInvoicesRequest {
+    companyId?: string;
+    customerExternalId: string;
+    subscriptionExternalId?: string;
+    /**
+     * Page limit (default 100)
+     */
+    limit?: number;
+    /**
+     * Page offset (default 0)
+     */
+    offset?: number;
+}

package/dist/api/resources/billing/client/requests/ListInvoicesRequest.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/{companies/client/requests/ListCompanyPlansRequest.d.ts → billing/client/requests/ListMetersRequest.d.ts}

@@ -5,9 +5,8 @@
  * @example
  *     {}
  */
-export interface ListCompanyPlansRequest {
-    companyId?: string;
-    planId?: string;
+export interface ListMetersRequest {
+    displayName?: string;
     /**
      * Page limit (default 100)
      */

package/dist/api/resources/billing/client/requests/ListMetersRequest.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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customer_external_id"
+ *     }
+ */
+export interface ListPaymentMethodsRequest {
+    companyId?: string;
+    customerExternalId: string;
+    subscriptionExternalId?: string;
+    /**
+     * Page limit (default 100)
+     */
+    limit?: number;
+    /**
+     * Page offset (default 0)
+     */
+    offset?: number;
+}

package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.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/ListProductPricesRequest.d.ts

@@ -9,6 +9,10 @@ export interface ListProductPricesRequest {
     ids?: string | string[];
     name?: string;
     q?: string;
+    /**
+     * Filter products that are not linked to any plan
+     */
+    withoutLinkedToPlan?: boolean;
     /**
      * Page limit (default 100)
      */

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

@@ -1,8 +1,15 @@
 export { type CreateBillingCustomerRequestBody } from "./CreateBillingCustomerRequestBody";
 export { type ListCustomersRequest } from "./ListCustomersRequest";
 export { type CountCustomersRequest } from "./CountCustomersRequest";
+export { type ListInvoicesRequest } from "./ListInvoicesRequest";
+export { type CreateInvoiceRequestBody } from "./CreateInvoiceRequestBody";
+export { type ListMetersRequest } from "./ListMetersRequest";
+export { type CreateMeterRequestBody } from "./CreateMeterRequestBody";
+export { type ListPaymentMethodsRequest } from "./ListPaymentMethodsRequest";
+export { type CreatePaymentMethodRequestBody } from "./CreatePaymentMethodRequestBody";
 export { type CreateBillingPriceRequestBody } from "./CreateBillingPriceRequestBody";
 export { type ListProductPricesRequest } from "./ListProductPricesRequest";
 export { type CreateBillingProductRequestBody } from "./CreateBillingProductRequestBody";
 export { type ListBillingProductsRequest } from "./ListBillingProductsRequest";
+export { type CountBillingProductsRequest } from "./CountBillingProductsRequest";
 export { type CreateBillingSubscriptionsRequestBody } from "./CreateBillingSubscriptionsRequestBody";

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface CountBillingProductsParams {
+    ids?: string[];
+    /** Page limit (default 100) */
+    limit?: number;
+    name?: string;
+    /** Page offset (default 0) */
+    offset?: number;
+    q?: string;
+    /** Filter products that are not linked to any plan */
+    withoutLinkedToPlan?: boolean;
+}

package/dist/api/resources/billing/types/CountBillingProductsParams.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/CountBillingProductsResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../../../index";
+export interface CountBillingProductsResponse {
+    data: Schematic.CountResponse;
+    /** Input parameters */
+    params: Schematic.CountBillingProductsParams;
+}

package/dist/api/resources/billing/types/CountBillingProductsResponse.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/DeleteProductPriceResponse.d.ts

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

package/dist/api/resources/billing/types/DeleteProductPriceResponse.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

@@ -12,4 +12,6 @@ export interface ListBillingProductsParams {
     /** Page offset (default 0) */
     offset?: number;
     q?: string;
+    /** Filter products that are not linked to any plan */
+    withoutLinkedToPlan?: boolean;
 }

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface ListInvoicesParams {
+    companyId?: string;
+    customerExternalId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    subscriptionExternalId?: string;
+}

package/dist/api/resources/billing/types/ListInvoicesParams.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/ListInvoicesResponse.d.ts

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

package/dist/api/resources/billing/types/ListInvoicesResponse.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/{companies/types/ListCompanyPlansParams.d.ts → billing/types/ListMetersParams.d.ts}

@@ -4,11 +4,10 @@
 /**
  * Input parameters
  */
-export interface ListCompanyPlansParams {
-    companyId?: string;
+export interface ListMetersParams {
+    displayName?: string;
     /** Page limit (default 100) */
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
-    planId?: string;
 }

package/dist/api/resources/billing/types/ListMetersParams.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/ListMetersResponse.d.ts

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

package/dist/api/resources/billing/types/ListMetersResponse.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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Input parameters
+ */
+export interface ListPaymentMethodsParams {
+    companyId?: string;
+    customerExternalId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    subscriptionExternalId?: string;
+}

package/dist/api/resources/billing/types/ListPaymentMethodsParams.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/ListPaymentMethodsResponse.d.ts

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

package/dist/api/resources/billing/types/ListPaymentMethodsResponse.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/ListProductPricesParams.d.ts

@@ -12,4 +12,6 @@ export interface ListProductPricesParams {
     /** Page offset (default 0) */
     offset?: number;
     q?: string;
+    /** Filter products that are not linked to any plan */
+    withoutLinkedToPlan?: boolean;
 }

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

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

package/dist/api/resources/billing/types/UpsertBillingMeterResponse.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/UpsertInvoiceResponse.d.ts

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

package/dist/api/resources/billing/types/UpsertInvoiceResponse.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/UpsertPaymentMethodResponse.d.ts

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

package/dist/api/resources/billing/types/UpsertPaymentMethodResponse.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/index.d.ts

@@ -3,10 +3,22 @@ export * from "./ListCustomersParams";
 export * from "./ListCustomersResponse";
 export * from "./CountCustomersParams";
 export * from "./CountCustomersResponse";
+export * from "./ListInvoicesParams";
+export * from "./ListInvoicesResponse";
+export * from "./UpsertInvoiceResponse";
+export * from "./ListMetersParams";
+export * from "./ListMetersResponse";
+export * from "./UpsertBillingMeterResponse";
+export * from "./ListPaymentMethodsParams";
+export * from "./ListPaymentMethodsResponse";
+export * from "./UpsertPaymentMethodResponse";
 export * from "./UpsertBillingPriceResponse";
 export * from "./ListProductPricesParams";
 export * from "./ListProductPricesResponse";
+export * from "./DeleteProductPriceResponse";
 export * from "./UpsertBillingProductResponse";
 export * from "./ListBillingProductsParams";
 export * from "./ListBillingProductsResponse";
+export * from "./CountBillingProductsParams";
+export * from "./CountBillingProductsResponse";
 export * from "./UpsertBillingSubscriptionResponse";

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

@@ -19,10 +19,22 @@ __exportStar(require("./ListCustomersParams"), exports);
 __exportStar(require("./ListCustomersResponse"), exports);
 __exportStar(require("./CountCustomersParams"), exports);
 __exportStar(require("./CountCustomersResponse"), exports);
+__exportStar(require("./ListInvoicesParams"), exports);
+__exportStar(require("./ListInvoicesResponse"), exports);
+__exportStar(require("./UpsertInvoiceResponse"), exports);
+__exportStar(require("./ListMetersParams"), exports);
+__exportStar(require("./ListMetersResponse"), exports);
+__exportStar(require("./UpsertBillingMeterResponse"), exports);
+__exportStar(require("./ListPaymentMethodsParams"), exports);
+__exportStar(require("./ListPaymentMethodsResponse"), exports);
+__exportStar(require("./UpsertPaymentMethodResponse"), exports);
 __exportStar(require("./UpsertBillingPriceResponse"), exports);
 __exportStar(require("./ListProductPricesParams"), exports);
 __exportStar(require("./ListProductPricesResponse"), exports);
+__exportStar(require("./DeleteProductPriceResponse"), exports);
 __exportStar(require("./UpsertBillingProductResponse"), exports);
 __exportStar(require("./ListBillingProductsParams"), exports);
 __exportStar(require("./ListBillingProductsResponse"), exports);
+__exportStar(require("./CountBillingProductsParams"), exports);
+__exportStar(require("./CountBillingProductsResponse"), exports);
 __exportStar(require("./UpsertBillingSubscriptionResponse"), exports);

package/dist/api/resources/companies/client/Client.d.ts

@@ -202,19 +202,6 @@ export declare class Companies {
      *     await client.companies.deleteCompanyMembership("company_membership_id")
      */
     deleteCompanyMembership(companyMembershipId: string, requestOptions?: Companies.RequestOptions): Promise<Schematic.DeleteCompanyMembershipResponse>;
-    /**
-     * @param {Schematic.ListCompanyPlansRequest} request
-     * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Schematic.BadRequestError}
-     * @throws {@link Schematic.UnauthorizedError}
-     * @throws {@link Schematic.ForbiddenError}
-     * @throws {@link Schematic.InternalServerError}
-     *
-     * @example
-     *     await client.companies.listCompanyPlans()
-     */
-    listCompanyPlans(request?: Schematic.ListCompanyPlansRequest, requestOptions?: Companies.RequestOptions): Promise<Schematic.ListCompanyPlansResponse>;
     /**
      * @param {Schematic.GetActiveCompanySubscriptionRequest} request
      * @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
@@ -298,9 +285,9 @@ export declare class Companies {
      *
      * @example
      *     await client.companies.getOrCreateEntityTraitDefinition({
-     *         entityType: Schematic.CreateEntityTraitDefinitionRequestBodyEntityType.Company,
+     *         entityType: "company",
      *         hierarchy: ["hierarchy"],
-     *         traitType: Schematic.CreateEntityTraitDefinitionRequestBodyTraitType.Boolean
+     *         traitType: "boolean"
      *     })
      */
     getOrCreateEntityTraitDefinition(request: Schematic.CreateEntityTraitDefinitionRequestBody, requestOptions?: Companies.RequestOptions): Promise<Schematic.GetOrCreateEntityTraitDefinitionResponse>;
@@ -330,7 +317,7 @@ export declare class Companies {
      *
      * @example
      *     await client.companies.updateEntityTraitDefinition("entity_trait_definition_id", {
-     *         traitType: Schematic.UpdateEntityTraitDefinitionRequestBodyTraitType.Boolean
+     *         traitType: "boolean"
      *     })
      */
     updateEntityTraitDefinition(entityTraitDefinitionId: string, request: Schematic.UpdateEntityTraitDefinitionRequestBody, requestOptions?: Companies.RequestOptions): Promise<Schematic.UpdateEntityTraitDefinitionResponse>;