@spytecgps/nova-orm 0.0.90 → 0.0.92

package/dist/repositories/billing/getBillingSubscriptionsBraintree.d.ts

@@ -0,0 +1,5 @@
+import { BillingSubscriptionBraintree } from '../../entities';
+import { NovaDataSource } from '../../novaDataSource';
+import { GetBillingSubscriptionsBraintreeParams } from '../../types/billing';
+import { Logger } from '../../types/logger';
+export declare const getBillingSubscriptionsBraintree: (novaDataSource: NovaDataSource, params: GetBillingSubscriptionsBraintreeParams, logger: Logger) => Promise<BillingSubscriptionBraintree[]>;

package/dist/repositories/billing/getCanceledImeis.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { CanceledImeiResult, GetCanceledImeisParams } from '../../types/billing';
+import { Logger } from '../../types/logger';
+export declare const getCanceledImeis: (novaDataSource: NovaDataSource, params: GetCanceledImeisParams, logger: Logger) => Promise<CanceledImeiResult[]>;

package/dist/repositories/billing/getChurnStatusByClientId.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { BillingSubscriptionChurnStatus, GetChurnStatusByClientIdParams } from '../../types/billing';
+import { Logger } from '../../types/logger';
+export declare const getChurnStatusByClientId: (novaDataSource: NovaDataSource, params: GetChurnStatusByClientIdParams, logger: Logger) => Promise<BillingSubscriptionChurnStatus[]>;

package/dist/repositories/billing/index.d.ts

@@ -1,5 +1,5 @@
-import { Billing, BillingCustomerBraintree, BillingDeviceHistory, BillingStatusHistoryBraintree, User } from '../../entities';
-import { CreateBillingDeviceHistoryParams, CreateBillingParams, CreateBillingStatusHistoryBraintreeParams, GetBillingCustomerBraintreeByIdParams, GetBillingsParams, GetClientIdFromBraintreeCustomerParams, GetUserByBraintreeCustomerIdParams, UpdateBillingCustomerBraintreeParams, UpdateBillingParams, UpsertBillingCustomerBraintreeParams } from '../../types/billing';
+import { Billing, BillingCustomerBraintree, BillingDeviceHistory, BillingStatusHistoryBraintree, BillingSubscriptionBraintree, User } from '../../entities';
+import { BillingSubscriptionChurnStatus, CanceledImeiResult, CreateBillingDeviceHistoryParams, CreateBillingParams, CreateBillingStatusHistoryBraintreeParams, GetBillingCustomerBraintreeByIdParams, GetBillingsParams, GetBillingSubscriptionsBraintreeParams, GetCanceledImeisParams, GetChurnStatusByClientIdParams, GetClientIdFromBraintreeCustomerParams, GetUserByBraintreeCustomerIdParams, UpdateBillingCustomerBraintreeParams, UpdateBillingParams, UpsertBillingCustomerBraintreeParams, UpsertBillingSubscriptionBraintreeParams } from '../../types/billing';
 import { BaseRepository } from '../baseRepository';
 export declare class BillingRepository extends BaseRepository {
     /**
@@ -119,4 +119,37 @@ export declare class BillingRepository extends BaseRepository {
      * @returns The user information
      */
     getUserByBraintreeCustomerId(params: GetUserByBraintreeCustomerIdParams): Promise<User>;
+    /**
+     * Get billing braintree subscriptions
+     * @param {GetBillingSubscriptionsBraintreeParams} params containing information to get billing braintree subscriptions
+     * - params.filters.subscriptionId: The braintree subscription id
+     * - params.filters.clientId: The clientId
+     * @returns The billing braintree subscriptions corresponding to the provided filters
+     */
+    getBillingSubscriptionsBraintree(params: GetBillingSubscriptionsBraintreeParams): Promise<BillingSubscriptionBraintree[]>;
+    /**
+     * Get churn status by clientId
+     * @param {GetChurnStatusByClientIdParams} params containing information to get billing braintree subscriptions
+     * - params.filters.clientId: The clientId
+     * @returns The churn status list for all subscriptions for the provided clientId
+     */
+    getChurnStatusByClientId(params: GetChurnStatusByClientIdParams): Promise<BillingSubscriptionChurnStatus[]>;
+    /**
+     * Upsert billing subscription braintree
+     * @param {UpsertBillingSubscriptionBraintreeParams} params containing information to upsert billing braintree subscription
+     * @returns Whether the billing braintree subscription was upserted
+     */
+    upsertBillingSubscriptionBraintree(params: UpsertBillingSubscriptionBraintreeParams): Promise<boolean>;
+    /**
+     * Get canceled imei
+     * @param {GetCanceledImeisParams} params containing information to get canceled imeis
+     * - params.filters.minCancellationDate: The min cancellation date
+     * - params.filters.maxCancellationDate: The max cancellation date
+     * - params.filters.canceledIn: which canceled status to check by ('carrier', 'device' or 'both')
+     * - params.filters.excludeB2B: whether to exclude devices from B2B clients
+     * - params.filters.excludeTest: whether to exclude devices from test clients
+     * - params.pagingOptions.pageSize: max elements to return
+     * @returns The list of canceled imeis
+     */
+    getCanceledImeis(params: GetCanceledImeisParams): Promise<CanceledImeiResult[]>;
 }

package/dist/repositories/billing/upsertBillingSubscriptionBraintree.d.ts

@@ -0,0 +1,4 @@
+import { NovaDataSource } from '../../novaDataSource';
+import { UpsertBillingSubscriptionBraintreeParams } from '../../types/billing';
+import { Logger } from '../../types/logger';
+export declare const upsertBillingSubscriptionBraintree: (novaDataSource: NovaDataSource, params: UpsertBillingSubscriptionBraintreeParams, logger: Logger) => Promise<boolean>;

package/dist/types/billing.d.ts

@@ -97,3 +97,77 @@ export interface GetUserByBraintreeCustomerIdParams {
         customerId: string;
     };
 }
+export interface GetBillingSubscriptionsBraintreeParams {
+    filters: {
+        subscriptionId?: string;
+        clientId?: number;
+    };
+}
+export interface GetChurnStatusByClientIdParams {
+    filters: {
+        clientId: number;
+    };
+}
+export interface BillingSubscriptionChurnStatus {
+    braintreeCustomerId: string;
+    braintreeSubscriptionStatus: string;
+    subscriptionId: string;
+    churnStatus?: string | 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 {
+    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;
+    subscriptionId: string;
+    createdAt: Date;
+    updatedAt: string;
+    iccidStatus: string;
+    carrier: string;
+}

package/dist/utils/stringToDateTransformer.d.ts

@@ -0,0 +1,5 @@
+import { ValueTransformer } from 'typeorm';
+export declare class StringToDateTransformer implements ValueTransformer {
+    to(value: string | null): string | null;
+    from(value: string): Date | null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/nova-orm",
-  "version": "0.0.90",
+  "version": "0.0.92",
   "description": "ORM with PlanetScale",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",