Meta data (#140)

* added meta data to list functions

* lint-fix

Co-authored-by: Ilya Merman <[email protected]>

Author: axshani

resources/authorization.ts

@@ -1,5 +1,5 @@
 import { Authorization } from "../types/authorization"
-import { UnitConfig, UnitResponse } from "../types/common"
+import { Meta, UnitConfig, UnitResponse } from "../types/common"
 import { BaseResource } from "./baseResource"
 
 export class Authorizations extends BaseResource {
@@ -12,7 +12,7 @@ export class Authorizations extends BaseResource {
         return this.httpGet<UnitResponse<Authorization>>(`/${id}`)
     }
 
-    public async find(params?: AuthorizationQueryParams): Promise<UnitResponse<Authorization[]>> {
+    public async find(params?: AuthorizationQueryParams): Promise<UnitResponse<Authorization[]> & Meta> {
         const parameters: any = {
             "page[limit]": (params?.limit ? params.limit : 100),
             "page[offset]": (params?.offset ? params.offset : 0),
@@ -30,7 +30,7 @@ export class Authorizations extends BaseResource {
                 parameters[`filter[status][${idx}]`] = s
             })
 
-        return this.httpGet<UnitResponse<Authorization[]>>("", { params: parameters })
+        return this.httpGet<UnitResponse<Authorization[]> & Meta>("", { params: parameters })
     }
 }
 

resources/customer.ts

@@ -1,4 +1,4 @@
-import { UnitResponse, UnitConfig } from "../types/common"
+import { UnitResponse, UnitConfig, Meta } from "../types/common"
 import { Customer, PatchCustomerRequest } from "../types/customer"
 import { BaseResource } from "./baseResource"
 
@@ -16,7 +16,7 @@ export class Customers extends BaseResource {
         return this.httpGet<UnitResponse<Customer>>(`/${customerId}`)
     }
 
-    public async list(params?: CustomersListParams): Promise<UnitResponse<Customer[]>> {
+    public async list(params?: CustomersListParams): Promise<UnitResponse<Customer[]> & Meta> {
 
         const parameters = {
             "page[limit]": (params?.limit ? params.limit : 100),
@@ -27,7 +27,7 @@ export class Customers extends BaseResource {
             "sort": params?.sort ? params.sort : "-createdAt"
         }
 
-        return this.httpGet<UnitResponse<Customer[]>>("", { params: parameters })
+        return this.httpGet<UnitResponse<Customer[]> & Meta>("", { params: parameters })
     }
 }
 

resources/payments.ts

@@ -1,5 +1,5 @@
 import { Account } from "../types/account"
-import { Include, UnitConfig, UnitResponse } from "../types/common"
+import { Include, Meta, UnitConfig, UnitResponse } from "../types/common"
 import { Customer } from "../types/customer"
 import { CreatePaymentRequest, PatchPaymentRequest, Payment } from "../types/payments"
 import { Transaction } from "../types/transactions"
@@ -31,7 +31,7 @@ export class Payments extends BaseResource {
         return this.httpGet<UnitResponse<Payment & Include<Account[] | Customer[] | Transaction[]>>>(`/${id}`, { params })
     }
 
-    public async list(params?: PaymentListParams): Promise<UnitResponse<Payment[] & Include<Account[] | Customer[] | Transaction[]>>> {
+    public async list(params?: PaymentListParams): Promise<UnitResponse<Payment[] & Include<Account[] | Customer[] | Transaction[]> & Meta>> {
         const parameters: any = {
             "page[limit]": (params?.limit ? params.limit : 100),
             "page[offset]": (params?.offset ? params.offset : 0),
@@ -59,7 +59,7 @@ export class Payments extends BaseResource {
                 parameters[`filter[direction][${idx}]`] = d
             })
 
-        return this.httpGet<UnitResponse<Payment[] & Include<Account[] | Customer[] | Transaction[]>>>("", { params: parameters })
+        return this.httpGet<UnitResponse<Payment[] & Include<Account[] | Customer[] | Transaction[]> & Meta>>("", { params: parameters })
     }
 }
 

resources/transactions.ts

@@ -1,4 +1,4 @@
-import { Include, UnitConfig, UnitResponse } from "../types/common"
+import { Include, Meta, UnitConfig, UnitResponse } from "../types/common"
 import { Customer } from "../types/customer"
 import { Account } from "../types/account"
 import { Transaction } from "../types/transactions"
@@ -28,7 +28,7 @@ export class Transactions extends BaseResource {
         return await this.httpGet<UnitResponse<Transaction> & Include<Account[] | Customer[]>>(`/accounts/${accountId}/transactions/${transactionId}`, { params: parameters })
     }
 
-    public async list(params?: TransactionListParams): Promise<UnitResponse<Transaction[]> & Include<Account[] | Customer[]>> {
+    public async list(params?: TransactionListParams): Promise<UnitResponse<Transaction[]> & Include<Account[] | Customer[]> & Meta> {
         const parameters: any = {
             "page[limit]": (params?.limit ? params.limit : 100),
             "page[offset]": (params?.offset ? params.offset : 0),
@@ -49,7 +49,7 @@ export class Transactions extends BaseResource {
                 parameters[`filter[type][${idx}]`] = t
             })
 
-        return await this.httpGet<UnitResponse<Transaction[]> & Include<Account[] | Customer[]>>("/transactions", { params: parameters })
+        return await this.httpGet<UnitResponse<Transaction[]> & Include<Account[] | Customer[]> & Meta>("/transactions", { params: parameters })
     }
 
     /**

types/common.ts

@@ -366,6 +366,19 @@ export interface Include<T> {
     included?: T
 }
 
+export interface Meta extends UnimplementedFields {
+    /**
+     * JSON object that contains pagination data
+     */
+    meta:{
+        pagination: {
+            total: number
+            limit: number
+            offset: number
+        }
+    }
+}
+
 export interface UnitConfig {
     axios?: AxiosInstance
 }