@vrplatform/hyperline-client 1.0.29 → 1.0.31

package/src/client.ts

@@ -1,5 +1,4 @@
-import { utc } from '@vrplatform/utils';
-import type { operations, paths } from './_types.generated';
+import type { paths } from './_types.generated';
 import { BillableEvents, CreateBillableEvent } from './types';
 import { arrayBufferToBase64 } from './utils';
 
@@ -64,20 +63,14 @@ export class HyperlineAPI {
         (content ? JSON.stringify(content) : null) ||
         'Unknown error';
 
-      if (status === 429) {
-        // get difference between rate limit reset and now
-        const rateLimitReset = utc(result?.headers.get('x-ratelimit-reset'));
-        const diff = rateLimitReset.diff(utc(), 'milliseconds');
-
-        // wait until rate limit resets
-        await new Promise((resolve) => setTimeout(resolve, diff));
-
-        return await this.fetchBasic<T>(path, options, data);
-      } else if (status === 404 && method === 'GET') {
+      if (status === 404 && method === 'GET') {
         return null;
       } else {
-        throw new Error(
-          `Hyperline Error ${status} (${statusText}) in ${path} for ${method}: ${message}`
+        throw Object.assign(
+          new Error(
+            `Hyperline Error ${status} (${statusText}) in ${path} for ${method}: ${message}`
+          ),
+          { status }
         );
       }
     } else if (result.headers.get('content-type')?.includes('application/pdf'))
@@ -132,8 +125,8 @@ export class HyperlineAPI {
     }
 
     return await this.fetch<
-      paths['/v1/customers/{id}']['get']['responses'][200]['content']['application/json']
-    >(`/v1/customers/${id}`);
+      paths['/v2/customers/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v2/customers/${id}`);
   }
 
   async getCustomerById(id?: string) {
@@ -142,48 +135,48 @@ export class HyperlineAPI {
       throw new Error('Missing tenant ID');
     }
 
-    const results = await this.fetch<
-      paths['/v1/customers']['get']['responses'][200]['content']['application/json']
-    >(`/v1/customers?external_id__equals=${id}`);
+    const results = await this.getCustomers({
+      external_id__equals: id,
+      status: 'all',
+      limit: 1,
+    });
 
     return results?.data[0];
   }
 
   async getCustomers(
-    skip = 0,
-    take = 100,
-    query: operations['getCustomers']['parameters']['query'] = {}
+    query: paths['/v2/customers']['get']['parameters']['query'] = {}
   ) {
     const queryParams = new URLSearchParams();
-    queryParams.set('take', take.toString());
-    queryParams.set('skip', skip.toString());
 
-    for (const [key, value] of Object.entries(query)) {
+    for (const [key, value] of Object.entries({ limit: 100, ...query })) {
       if (value === undefined || value === null) continue;
       queryParams.set(key, value.toString());
     }
 
     return await this.fetch<
-      paths['/v1/customers']['get']['responses'][200]['content']['application/json']
-    >(`/v1/customers?${queryParams.toString()}`);
+      paths['/v2/customers']['get']['responses'][200]['content']['application/json']
+    >(`/v2/customers?${queryParams.toString()}`);
   }
 
   async getAllCustomers(
-    items: paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data'] = [],
-    query: operations['getCustomers']['parameters']['query'] = {}
+    items: paths['/v2/customers']['get']['responses'][200]['content']['application/json']['data'] = [],
+    query: paths['/v2/customers']['get']['parameters']['query'] = {}
   ): Promise<
-    paths['/v1/customers']['get']['responses'][200]['content']['application/json']['data']
+    paths['/v2/customers']['get']['responses'][200]['content']['application/json']['data']
   > {
-    const { data } = (await this.getCustomers(items.length, 100, {
+    const page = await this.getCustomers({
       status: 'all',
       ...query,
-    })) || {
-      data: [],
-    };
+    });
+    if (!page) throw new Error('Customer list not found');
 
-    return data.length
-      ? this.getAllCustomers([...items, ...data], { status: 'all', ...query })
-      : [...items, ...data];
+    return page.next_cursor
+      ? this.getAllCustomers([...items, ...page.data], {
+          ...query,
+          cursor: page.next_cursor,
+        })
+      : [...items, ...page.data];
   }
 
   async createCustomer(
@@ -267,7 +260,7 @@ export class HyperlineAPI {
   async getSubscriptions(
     skip = 0,
     take = 100,
-    query: operations['getSubscriptions']['parameters']['query'] = {
+    query: paths['/v2/subscriptions']['get']['parameters']['query'] = {
       status: 'all',
     }
   ) {
@@ -287,7 +280,7 @@ export class HyperlineAPI {
 
   async getAllSubscriptions(
     items: paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data'] = [],
-    query: operations['getSubscriptions']['parameters']['query'] = {}
+    query: paths['/v2/subscriptions']['get']['parameters']['query'] = {}
   ): Promise<
     paths['/v2/subscriptions']['get']['responses'][200]['content']['application/json']['data']
   > {
@@ -359,25 +352,6 @@ export class HyperlineAPI {
     });
   }
 
-  // PLAN
-
-  async getPlan(id: string) {
-    if (!id) {
-      this.logger.error('Missing plan ID', { id });
-      throw new Error('Missing plan ID');
-    }
-
-    return await this.fetch<
-      paths['/v1/plans/{id}']['get']['responses'][200]['content']['application/json']
-    >(`/v1/plans/${id}`);
-  }
-
-  async getPlans(skip = 0, take = 100) {
-    return await this.fetch<
-      paths['/v1/plans']['get']['responses'][200]['content']['application/json']
-    >(`/v1/plans?take=${take}&skip=${skip}`);
-  }
-
   // INVOICE
 
   async getInvoice(id: string) {
@@ -387,47 +361,33 @@ export class HyperlineAPI {
     }
 
     return await this.fetch<
-      paths['/v1/invoices/{id}']['get']['responses'][200]['content']['application/json']
-    >(`/v1/invoices/${id}`);
+      paths['/v2/invoices/{id}']['get']['responses'][200]['content']['application/json']
+    >(`/v2/invoices/${id}`);
   }
 
   async getInvoices(
-    skip = 0,
-    take = 100,
-    query: operations['getInvoices']['parameters']['query'] = { status: 'all' }
+    query: paths['/v2/invoices']['get']['parameters']['query'] = {}
   ) {
     const queryParams = new URLSearchParams();
-    queryParams.set('take', take.toString());
-    queryParams.set('skip', skip.toString());
-
-    for (const [key, value] of Object.entries(query)) {
+    for (const [key, value] of Object.entries({
+      limit: 100,
+      status: 'all',
+      ...query,
+    })) {
       if (value === undefined || value === null) continue;
       queryParams.set(key, value.toString());
     }
 
     return await this.fetch<
-      paths['/v1/invoices']['get']['responses'][200]['content']['application/json']
-    >(`/v1/invoices?${queryParams.toString()}`);
+      paths['/v2/invoices']['get']['responses'][200]['content']['application/json']
+    >(`/v2/invoices?${queryParams.toString()}`);
   }
 
   async getInvoicesByCustomerId(
     id: string,
-    filters?: Partial<operations['getInvoices']['parameters']['query']>
+    filters?: paths['/v2/invoices']['get']['parameters']['query']
   ) {
-    const queryParams = new URLSearchParams();
-    queryParams.append('customerId__equals', id);
-
-    if (filters) {
-      Object.entries(filters).forEach(([key, value]) => {
-        if (value !== undefined && value !== null) {
-          queryParams.append(key, value.toString());
-        }
-      });
-    }
-
-    return await this.fetch<
-      paths['/v1/invoices']['get']['responses'][200]['content']['application/json']
-    >(`/v1/invoices?${queryParams.toString()}`);
+    return await this.getInvoices({ ...filters, customer_id: id });
   }
 
   async getInvoiceDownload(id: string) {
@@ -441,21 +401,20 @@ export class HyperlineAPI {
   }
 
   async getAllInvoices(
-    items: paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data'] = [],
-    query: operations['getInvoices']['parameters']['query'] = { status: 'all' }
+    items: paths['/v2/invoices']['get']['responses'][200]['content']['application/json']['data'] = [],
+    query: paths['/v2/invoices']['get']['parameters']['query'] = {}
   ): Promise<
-    paths['/v1/invoices']['get']['responses'][200]['content']['application/json']['data']
+    paths['/v2/invoices']['get']['responses'][200]['content']['application/json']['data']
   > {
-    const { data } = (await this.getInvoices(items.length, 100, {
-      status: 'all',
-      ...query,
-    })) || {
-      data: [],
-    };
-
-    return data.length
-      ? this.getAllInvoices([...items, ...data], { status: 'all', ...query })
-      : [...items, ...data];
+    const page = await this.getInvoices(query);
+    if (!page) throw new Error('Invoice list not found');
+
+    return page.next_cursor
+      ? this.getAllInvoices([...items, ...page.data], {
+          ...query,
+          cursor: page.next_cursor,
+        })
+      : [...items, ...page.data];
   }
 
   async voidInvoice(

package/src/const.ts

@@ -1,4 +1,4 @@
-import type { TrackingEvent } from '@vrplatform/log';
+import type { TrackingEvent } from '@vrplatform/tracking';
 import { HyperlineEntities } from './types';
 
 // Tenants
@@ -73,6 +73,7 @@ export const WEBHOOKS = {
   'payment_method.deleted': 'hyperline_payment_method_deleted',
   'payment_method.expired': 'hyperline_payment_method_expired',
   'subscription.activated': 'hyperline_subscription_status_changed',
+  'subscription.updated': 'hyperline_subscription_status_changed',
   'subscription.reactivated': 'hyperline_subscription_status_changed',
   'subscription.cancellation_scheduled':
     'hyperline_subscription_cancellation_scheduled',

package/src/types.ts

@@ -39,5 +39,6 @@ export type CreateBillableEvent = {
     amount?: number;
     amountGl?: number;
     amountNonGl?: number;
+    amountAll?: number;
   };
 };

package/src/utils/calculateMrr.ts

@@ -19,17 +19,18 @@ export async function calculateMrr(
       liveBilling?: boolean
     ): Promise<{
       customer_id: string;
+      // BIL-614: legacy minimums remain until the subscription migration is complete.
       plan_id: string | null;
       products?: unknown[];
       coupons?: (
         | {
             type: 'amount';
-            repeat: 'once' | 'forever' | 'custom';
+            repeat: HyperlineEntities['Coupon']['repeat'];
             discount_amount: number;
           }
         | {
             type: 'percent';
-            repeat: 'once' | 'forever' | 'custom';
+            repeat: HyperlineEntities['Coupon']['repeat'];
             discount_percent: number;
           }
       )[];
@@ -62,7 +63,7 @@ export async function calculateMrr(
     } | null>;
     getInvoicesByCustomerId(id: string): Promise<{
       data: {
-        emitted_at: string;
+        issued_at: string;
         total_amount: number;
       }[];
     } | null>;
@@ -185,7 +186,7 @@ export async function calculateMrr(
 
     // sort invoices by date
     const invoices = data
-      ?.sort((a, b) => a.emitted_at.localeCompare(b.emitted_at))
+      ?.sort((a, b) => a.issued_at.localeCompare(b.issued_at))
       .reverse();
 
     // get the last invoice