@spytecgps/nova-orm 1.2.23 → 1.2.25

package/dist/types/billing.d.ts

@@ -1,342 +1,342 @@
-import { BaseSelectQueryParams } from './common';
-export interface GetBillingsParams extends BaseSelectQueryParams {
-    filters: {
-        imei?: string;
-        clientId?: number;
-        subscriptionId?: string;
-        status?: string;
-    };
-    projectionOptions?: {
-        withClient?: boolean;
-        withPlan?: boolean;
-    };
-}
-export interface CreateBillingParams {
-    id?: number;
-    deviceId?: number;
-    imei?: string;
-    planId?: string;
-    subscriptionId?: string;
-    platform?: string;
-    status?: string;
-    subscriptionValue?: number;
-    subscriptionPeriodMonths?: number;
-    subscriptionValueMonthly?: number;
-    clientId?: number;
-}
-export interface UpdateBillingParams {
-    filters: {
-        imei: string;
-    };
-    values: {
-        deviceId?: number;
-        planId?: string;
-        subscriptionId?: string;
-        platform?: string;
-        status?: string;
-        subscriptionValue?: number;
-        subscriptionPeriodMonths?: number;
-        subscriptionValueMonthly?: number;
-        clientId?: number;
-    };
-}
-export interface GetClientIdFromBraintreeCustomerParams extends BaseSelectQueryParams {
-    filters: {
-        customerId: string;
-    };
-}
-export interface GetBillingCustomerBraintreeByIdParams extends BaseSelectQueryParams {
-    filters: {
-        id: string;
-    };
-}
-export interface UpdateBillingCustomerBraintreeParams {
-    filters: {
-        id: string;
-    };
-    values: {
-        firstName?: string;
-        lastName?: string;
-        company?: string;
-        email?: string;
-        phone?: string;
-        churnStatus?: string;
-    };
-}
-export interface UpsertBillingCustomerBraintreeParams {
-    id: string;
-    firstName?: string;
-    lastName?: string;
-    company?: string;
-    email?: string;
-    phone?: string;
-}
-export interface CreateBillingStatusHistoryBraintreeParams {
-    subscriptionId: string;
-    subscriptionHistories: {
-        id?: number;
-        status?: string;
-        balance?: number;
-        price?: number;
-        currencyIsoCode?: string;
-        planId?: string;
-        timestamp?: string;
-    }[];
-}
-export interface CreateBillingDeviceHistoryParams {
-    id?: number;
-    clientId?: number;
-    deviceId?: number;
-    imei?: string;
-    planId?: string;
-    subscriptionId?: string;
-    platform?: string;
-    status?: string;
-}
-export interface GetUserByBraintreeCustomerIdParams extends BaseSelectQueryParams {
-    filters: {
-        customerId: string;
-    };
-}
-export interface GetBillingSubscriptionsBraintreeParams extends BaseSelectQueryParams {
-    filters: {
-        subscriptionId?: string;
-        clientId?: number;
-    };
-}
-export interface BillingSubscriptionParams extends BaseSelectQueryParams {
-    imei: string;
-}
-export interface GetChurnStatusByClientIdParams extends BaseSelectQueryParams {
-    filters: {
-        clientId: number;
-    };
-}
-export interface BillingSubscriptionChurnStatus {
-    braintreeCustomerId: string;
-    braintreeSubscriptionStatus: string;
-    subscriptionId: string;
-    churnStatus?: string | null;
-    nextBillingDate?: Date | null;
-    lastStatusUpdate?: string | null;
-    subscriptionPeriodMonths?: number | null;
-}
-export interface UpsertBillingSubscriptionBraintreeParams {
-    subscriptionId: string;
-    customerId?: string | null;
-    planId?: string | null;
-    createdAt?: Date | null;
-    updatedAt?: Date | null;
-    subscriptionStart?: Date | null;
-    subscriptionEnd?: Date | null;
-    nextBillingDate?: Date | null;
-    subscriptionValue?: number | null;
-    status?: string | null;
-    subscriptionPeriodMonths?: number | null;
-    paymentInstrumentType?: string | null;
-    paymentInstrumentDetails?: object | null;
-    isPaused?: boolean | null;
-    discountDetails?: object | null;
-    addons?: object | null;
-    balance?: number | null;
-    currentBillingCycle?: number | null;
-    daysPastDue?: number | null;
-    description?: string | null;
-    descriptor?: object | null;
-    failureCount?: number | null;
-    firstBillingDate?: Date | null;
-    merchantAccountId?: string | null;
-    nextBillingPeriodAmount?: number | null;
-    numberOfBillingCycles?: number | null;
-    paidThroughDate?: Date | null;
-    paymentMethodToken?: string | null;
-    statusHistory?: object | null;
-    trialDuration?: number | null;
-    trialDurationUnit?: string | null;
-    trialPeriod?: boolean | null;
-}
-export interface GetCanceledImeisParams extends BaseSelectQueryParams {
-    filters: {
-        minCancellationDate: Date;
-        maxCancellationDate: Date;
-        canceledIn: 'carrier' | 'device' | 'both';
-        excludeB2B: boolean;
-        excludeTest: boolean;
-    };
-    pagingOptions: {
-        pageSize: number | 100;
-    };
-}
-export interface CanceledImeiResult {
-    imei: string;
-    iccid: string;
-    clientId: number;
-    clientTypeId: number;
-    email: string;
-    subscriptionId: string;
-    createdAt: Date;
-    updatedAt: string;
-    status: string;
-    carrier: string;
-    isEnterpriseCustomer: boolean;
-}
-export interface GetMagentoPlanParams extends BaseSelectQueryParams {
-    filters: {
-        annual: boolean;
-        code: string;
-    };
-}
-export interface CreateBillingHubspotPaymentLogParams {
-    id?: number;
-    amountPaid: number;
-    owner?: string | null;
-    bankOfIssuer?: string | null;
-    billingAddress?: string | null;
-    billingAddressCity?: string | null;
-    billingAddressCountry?: string | null;
-    billingAddressLine1?: string | null;
-    billingAddressLine2?: string | null;
-    billingAddressState?: string | null;
-    billingAddressZip?: string | null;
-    createdByUserId?: string | null;
-    currencyCode?: string | null;
-    customer?: string | null;
-    grossAmount?: number | null;
-    lastFourDigits?: string | null;
-    lineItemDiscountAmount?: number | null;
-    netAmount?: number | null;
-    objectCreateDateTime?: Date | null;
-    objectId?: string | null;
-    objectLastModifiedDateTime?: Date | null;
-    orderDiscountAmount?: number | null;
-    orderDiscountCode?: string | null;
-    orderDiscountPercentage?: number | null;
-    ownerAssignedDateTime?: Date | null;
-    paymentDateTime?: Date | null;
-    paymentId?: string | null;
-    paymentMethod?: string | null;
-    paymentSourceName?: string | null;
-    paymentType?: string | null;
-    processingFees?: number | null;
-    refunded?: number | null;
-    shippingAddress?: string | null;
-    shippingAddressCity?: string | null;
-    shippingAddressCountry?: string | null;
-    shippingAddressLine1?: string | null;
-    shippingAddressLine2?: string | null;
-    shippingAddressState?: string | null;
-    shippingAddressZip?: string | null;
-    source?: string | null;
-    sourceId?: string | null;
-    sourceUrl?: string | null;
-    status?: string | null;
-    statusUpdatedOn?: Date | null;
-    totalDiscountAmount?: number | null;
-    totalFees?: number | null;
-    totalTaxes?: number | null;
-    updatedByUserId?: string | null;
-}
-export interface UpsertBillingKlarnaCustomerParams {
-    id: string;
-    firstName?: string | null;
-    lastName?: string | null;
-    billingEmail?: string | null;
-    shippingEmail?: string | null;
-    streetAddress?: string | null;
-    city?: string | null;
-    region?: string | null;
-    country?: string | null;
-    postalCode?: string | null;
-    phone?: string | null;
-    createdAt?: Date | null;
-}
-export interface UpsertBillingKlarnaOrderParams {
-    deviceId: string;
-    klarnaCustomerId: string;
-    orderId: string;
-    planId?: string | null;
-    createdAt?: Date | null;
-    subscriptionStart?: Date | null;
-    subscriptionEnd?: Date | null;
-    nextBillingDate?: Date | null;
-    subscriptionValue?: number | null;
-    status?: string | null;
-    paymentType?: string | null;
-    discounts?: object | null;
-    addOns?: object | null;
-    nextBillingPeriodAmount?: number | null;
-    paymentMethodToken?: string | null;
-}
-export type UpsertBillingPlanParamsStatus = 'active' | 'disabled' | 'draft';
-export type UpsertBillingPlanParamsTagetConsumer = 'consumer' | 'enterprise' | 'any';
-export type UpsertBillingPlanParamsTrialDurationUnit = 'day' | 'month' | null;
-export interface UpsertBillingPlanParams {
-    planId: string;
-    targetCustomer: UpsertBillingPlanParamsTagetConsumer;
-    code: string;
-    status: UpsertBillingPlanParamsStatus;
-    platform: string;
-    billingFrequency: number;
-    contractLength: number;
-    numberOfBillingCycles?: number | null;
-    description?: string | null;
-    name: string;
-    price: string;
-    trialDuration?: number | null;
-    trialDurationUnit?: UpsertBillingPlanParamsTrialDurationUnit;
-    trialPeriod?: boolean | null;
-    createdAt: Date;
-    updatedAt: Date;
-    addOns?: Record<string, any>[] | null;
-    discounts?: Record<string, any>[] | null;
-    startDate?: Date | null;
-    endDate?: Date | null;
-}
-export interface UpsertBillingDeviceTypePlanParams {
-    deviceTypeId: number;
-    planId: string;
-    deviceTypeModel?: string;
-    deviceType?: string | null;
-    createdAt?: Date;
-    status: UpsertBillingPlanParamsStatus;
-}
-export interface GetBillingDeviceTypePlansParams extends BaseSelectQueryParams {
-    planId: string;
-}
-export interface GetBillingPlansParams extends BaseSelectQueryParams {
-    deviceTypeId: number;
-    targetCustomer: string;
-    status: string;
-    date: string | null;
-    sortField?: 'planId' | 'billingFrequency' | 'price' | 'createdAt';
-    sortOrder?: 'ASC' | 'DESC';
-}
-export interface GetBillingPlanResult {
-    deviceTypeId: number;
-    planId: string;
-    deviceType: string;
-    deviceTypeModel: string;
-    targetCustomer: 'consumer' | 'enterprise' | 'any';
-    plan: string;
-    platform: string;
-    billingFrequency: number;
-    contractLength: number;
-    description: string;
-    price: string;
-    createdAt: Date;
-    addOns: Record<string, any>[];
-    discounts: Record<string, any>[];
-    startDate: Date | null;
-    endDate: Date | null;
-    imageUrl: string;
-    productName: string;
-}
-export interface GetBraintreePastDueSubscriptionParams extends BaseSelectQueryParams {
-    filters: {
-        numberOfPastDueDays: number;
-    };
-}
-export interface BraintreePastDueSubscription {
-    subscriptionId: string;
-    timestamp: string;
-}
+import { BaseSelectQueryParams } from './common';
+export interface GetBillingsParams extends BaseSelectQueryParams {
+    filters: {
+        imei?: string;
+        clientId?: number;
+        subscriptionId?: string;
+        status?: string;
+    };
+    projectionOptions?: {
+        withClient?: boolean;
+        withPlan?: boolean;
+    };
+}
+export interface CreateBillingParams {
+    id?: number;
+    deviceId?: number;
+    imei?: string;
+    planId?: string;
+    subscriptionId?: string;
+    platform?: string;
+    status?: string;
+    subscriptionValue?: number;
+    subscriptionPeriodMonths?: number;
+    subscriptionValueMonthly?: number;
+    clientId?: number;
+}
+export interface UpdateBillingParams {
+    filters: {
+        imei: string;
+    };
+    values: {
+        deviceId?: number;
+        planId?: string;
+        subscriptionId?: string;
+        platform?: string;
+        status?: string;
+        subscriptionValue?: number;
+        subscriptionPeriodMonths?: number;
+        subscriptionValueMonthly?: number;
+        clientId?: number;
+    };
+}
+export interface GetClientIdFromBraintreeCustomerParams extends BaseSelectQueryParams {
+    filters: {
+        customerId: string;
+    };
+}
+export interface GetBillingCustomerBraintreeByIdParams extends BaseSelectQueryParams {
+    filters: {
+        id: string;
+    };
+}
+export interface UpdateBillingCustomerBraintreeParams {
+    filters: {
+        id: string;
+    };
+    values: {
+        firstName?: string;
+        lastName?: string;
+        company?: string;
+        email?: string;
+        phone?: string;
+        churnStatus?: string;
+    };
+}
+export interface UpsertBillingCustomerBraintreeParams {
+    id: string;
+    firstName?: string;
+    lastName?: string;
+    company?: string;
+    email?: string;
+    phone?: string;
+}
+export interface CreateBillingStatusHistoryBraintreeParams {
+    subscriptionId: string;
+    subscriptionHistories: {
+        id?: number;
+        status?: string;
+        balance?: number;
+        price?: number;
+        currencyIsoCode?: string;
+        planId?: string;
+        timestamp?: string;
+    }[];
+}
+export interface CreateBillingDeviceHistoryParams {
+    id?: number;
+    clientId?: number;
+    deviceId?: number;
+    imei?: string;
+    planId?: string;
+    subscriptionId?: string;
+    platform?: string;
+    status?: string;
+}
+export interface GetUserByBraintreeCustomerIdParams extends BaseSelectQueryParams {
+    filters: {
+        customerId: string;
+    };
+}
+export interface GetBillingSubscriptionsBraintreeParams extends BaseSelectQueryParams {
+    filters: {
+        subscriptionId?: string;
+        clientId?: number;
+    };
+}
+export interface BillingSubscriptionParams extends BaseSelectQueryParams {
+    imei: string;
+}
+export interface GetChurnStatusByClientIdParams extends BaseSelectQueryParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface BillingSubscriptionChurnStatus {
+    braintreeCustomerId: string;
+    braintreeSubscriptionStatus: string;
+    subscriptionId: string;
+    churnStatus?: string | null;
+    nextBillingDate?: Date | null;
+    lastStatusUpdate?: string | null;
+    subscriptionPeriodMonths?: number | null;
+}
+export interface UpsertBillingSubscriptionBraintreeParams {
+    subscriptionId: string;
+    customerId?: string | null;
+    planId?: string | null;
+    createdAt?: Date | null;
+    updatedAt?: Date | null;
+    subscriptionStart?: Date | null;
+    subscriptionEnd?: Date | null;
+    nextBillingDate?: Date | null;
+    subscriptionValue?: number | null;
+    status?: string | null;
+    subscriptionPeriodMonths?: number | null;
+    paymentInstrumentType?: string | null;
+    paymentInstrumentDetails?: object | null;
+    isPaused?: boolean | null;
+    discountDetails?: object | null;
+    addons?: object | null;
+    balance?: number | null;
+    currentBillingCycle?: number | null;
+    daysPastDue?: number | null;
+    description?: string | null;
+    descriptor?: object | null;
+    failureCount?: number | null;
+    firstBillingDate?: Date | null;
+    merchantAccountId?: string | null;
+    nextBillingPeriodAmount?: number | null;
+    numberOfBillingCycles?: number | null;
+    paidThroughDate?: Date | null;
+    paymentMethodToken?: string | null;
+    statusHistory?: object | null;
+    trialDuration?: number | null;
+    trialDurationUnit?: string | null;
+    trialPeriod?: boolean | null;
+}
+export interface GetCanceledImeisParams extends BaseSelectQueryParams {
+    filters: {
+        minCancellationDate: Date;
+        maxCancellationDate: Date;
+        canceledIn: 'carrier' | 'device' | 'both';
+        excludeB2B: boolean;
+        excludeTest: boolean;
+    };
+    pagingOptions: {
+        pageSize: number | 100;
+    };
+}
+export interface CanceledImeiResult {
+    imei: string;
+    iccid: string;
+    clientId: number;
+    clientTypeId: number;
+    email: string;
+    subscriptionId: string;
+    createdAt: Date;
+    updatedAt: string;
+    status: string;
+    carrier: string;
+    isEnterpriseCustomer: boolean;
+}
+export interface GetMagentoPlanParams extends BaseSelectQueryParams {
+    filters: {
+        annual: boolean;
+        code: string;
+    };
+}
+export interface CreateBillingHubspotPaymentLogParams {
+    id?: number;
+    amountPaid: number;
+    owner?: string | null;
+    bankOfIssuer?: string | null;
+    billingAddress?: string | null;
+    billingAddressCity?: string | null;
+    billingAddressCountry?: string | null;
+    billingAddressLine1?: string | null;
+    billingAddressLine2?: string | null;
+    billingAddressState?: string | null;
+    billingAddressZip?: string | null;
+    createdByUserId?: string | null;
+    currencyCode?: string | null;
+    customer?: string | null;
+    grossAmount?: number | null;
+    lastFourDigits?: string | null;
+    lineItemDiscountAmount?: number | null;
+    netAmount?: number | null;
+    objectCreateDateTime?: Date | null;
+    objectId?: string | null;
+    objectLastModifiedDateTime?: Date | null;
+    orderDiscountAmount?: number | null;
+    orderDiscountCode?: string | null;
+    orderDiscountPercentage?: number | null;
+    ownerAssignedDateTime?: Date | null;
+    paymentDateTime?: Date | null;
+    paymentId?: string | null;
+    paymentMethod?: string | null;
+    paymentSourceName?: string | null;
+    paymentType?: string | null;
+    processingFees?: number | null;
+    refunded?: number | null;
+    shippingAddress?: string | null;
+    shippingAddressCity?: string | null;
+    shippingAddressCountry?: string | null;
+    shippingAddressLine1?: string | null;
+    shippingAddressLine2?: string | null;
+    shippingAddressState?: string | null;
+    shippingAddressZip?: string | null;
+    source?: string | null;
+    sourceId?: string | null;
+    sourceUrl?: string | null;
+    status?: string | null;
+    statusUpdatedOn?: Date | null;
+    totalDiscountAmount?: number | null;
+    totalFees?: number | null;
+    totalTaxes?: number | null;
+    updatedByUserId?: string | null;
+}
+export interface UpsertBillingKlarnaCustomerParams {
+    id: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    billingEmail?: string | null;
+    shippingEmail?: string | null;
+    streetAddress?: string | null;
+    city?: string | null;
+    region?: string | null;
+    country?: string | null;
+    postalCode?: string | null;
+    phone?: string | null;
+    createdAt?: Date | null;
+}
+export interface UpsertBillingKlarnaOrderParams {
+    deviceId: string;
+    klarnaCustomerId: string;
+    orderId: string;
+    planId?: string | null;
+    createdAt?: Date | null;
+    subscriptionStart?: Date | null;
+    subscriptionEnd?: Date | null;
+    nextBillingDate?: Date | null;
+    subscriptionValue?: number | null;
+    status?: string | null;
+    paymentType?: string | null;
+    discounts?: object | null;
+    addOns?: object | null;
+    nextBillingPeriodAmount?: number | null;
+    paymentMethodToken?: string | null;
+}
+export type UpsertBillingPlanParamsStatus = 'active' | 'disabled' | 'draft';
+export type UpsertBillingPlanParamsTagetConsumer = 'consumer' | 'enterprise' | 'any';
+export type UpsertBillingPlanParamsTrialDurationUnit = 'day' | 'month' | null;
+export interface UpsertBillingPlanParams {
+    planId: string;
+    targetCustomer: UpsertBillingPlanParamsTagetConsumer;
+    code: string;
+    status: UpsertBillingPlanParamsStatus;
+    platform: string;
+    billingFrequency: number;
+    contractLength: number;
+    numberOfBillingCycles?: number | null;
+    description?: string | null;
+    name: string;
+    price: string;
+    trialDuration?: number | null;
+    trialDurationUnit?: UpsertBillingPlanParamsTrialDurationUnit;
+    trialPeriod?: boolean | null;
+    createdAt: Date;
+    updatedAt: Date;
+    addOns?: Record<string, any>[] | null;
+    discounts?: Record<string, any>[] | null;
+    startDate?: Date | null;
+    endDate?: Date | null;
+}
+export interface UpsertBillingDeviceTypePlanParams {
+    deviceTypeId: number;
+    planId: string;
+    deviceTypeModel?: string;
+    deviceType?: string | null;
+    createdAt?: Date;
+    status: UpsertBillingPlanParamsStatus;
+}
+export interface GetBillingDeviceTypePlansParams extends BaseSelectQueryParams {
+    planId: string;
+}
+export interface GetBillingPlansParams extends BaseSelectQueryParams {
+    deviceTypeId: number;
+    targetCustomer: string;
+    status: string;
+    date: string | null;
+    sortField?: 'planId' | 'billingFrequency' | 'price' | 'createdAt';
+    sortOrder?: 'ASC' | 'DESC';
+}
+export interface GetBillingPlanResult {
+    deviceTypeId: number;
+    planId: string;
+    deviceType: string;
+    deviceTypeModel: string;
+    targetCustomer: 'consumer' | 'enterprise' | 'any';
+    plan: string;
+    platform: string;
+    billingFrequency: number;
+    contractLength: number;
+    description: string;
+    price: string;
+    createdAt: Date;
+    addOns: Record<string, any>[];
+    discounts: Record<string, any>[];
+    startDate: Date | null;
+    endDate: Date | null;
+    imageUrl: string;
+    productName: string;
+}
+export interface GetBraintreePastDueSubscriptionParams extends BaseSelectQueryParams {
+    filters: {
+        numberOfPastDueDays: number;
+    };
+}
+export interface BraintreePastDueSubscription {
+    subscriptionId: string;
+    timestamp: string;
+}