update list params (#357)

axshani · ilyamerman · web-flow · commit d38056de512d · 2023-06-20T14:19:12.000+03:00
* update list params

* lint

---------

Co-authored-by: Ilya Merman &lt;ilya@unit.co&gt;
diff --git a/resources/application.ts b/resources/application.ts
@@ -1,5 +1,5 @@
-import { Application, BeneficialOwner, BeneficialOwnerDTO, ApplicationDocument, CreateApplicationRequest, DownloadDocumentRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest, PatchBusinessApplicationBeneficialOwner } from "../types/application"
-import { UnitResponse, Include, UnitConfig, BaseListParams } from "../types/common"
+import { Application, BeneficialOwner, BeneficialOwnerDTO, ApplicationDocument, CreateApplicationRequest, DownloadDocumentRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest, PatchBusinessApplicationBeneficialOwner, ApplicationStatus } from "../types/application"
+import { UnitResponse, Include, UnitConfig, BaseListParams, Tags, Sort } from "../types/common"
 import { BaseResource } from "./baseResource"
 
 export class Applications extends BaseResource {
@@ -121,16 +121,16 @@ export interface ApplicationListParams extends BaseListParams {
      * Optional. Filter Applications by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 
     /**
-     * Optional. Filter Account by its status (Open, Frozen, or Closed). Usage example: filter[status][0]=Closed
+     * Optional. Filter applications by [Application Status](https://docs.unit.co/applications#application-statuses). Usage example: filter[status][0]=Pending&filter[status][1]=Approved
      */
-    status?: string[]
+    status?: ApplicationStatus[]
 }
diff --git a/resources/applicationForm.ts b/resources/applicationForm.ts
@@ -1,5 +1,5 @@
 import { BaseResource } from "./baseResource"
-import { BaseListParams, Include, UnitConfig, UnitResponse } from "../types/common"
+import { BaseListParams, Include, Sort, Tags, UnitConfig, UnitResponse } from "../types/common"
 import { CreateApplicationFormRequest, CreateApplicationFormResponse, ApplicationForm } from "../types/applicationForm"
 import { Application } from "../types"
 
@@ -32,11 +32,11 @@ export interface ApplicationFormsListParams extends BaseListParams {
      * Optional. Filter Applications by [Tags](https://developers.unit.co/#tags).
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
      * default: sort=-period
      */
-    sort?: string
+    sort?: Sort
 }
diff --git a/resources/authorization.ts b/resources/authorization.ts
@@ -1,5 +1,5 @@
 import { Authorization, AuthorizationStatus } from "../types/authorization"
-import { BaseListParams, Meta, UnitConfig, UnitResponse } from "../types/common"
+import { BaseListParams, Meta, Sort, UnitConfig, UnitResponse } from "../types/common"
 import { BaseResource } from "./baseResource"
 
 export class Authorizations extends BaseResource {
@@ -88,7 +88,7 @@ export interface AuthorizationQueryParams extends BaseListParams {
     /**
      * Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
      */
-    sort?: string
+    sort?: Sort
 
     /**
      * Optional. Filter result by their 4-digit ISO 18245 merchant category code (MCC).
diff --git a/resources/cards.ts b/resources/cards.ts
@@ -1,6 +1,6 @@
 import {
-    Card, CardLimits, CreateDebitCardRequest, EnableCardToCardPaymentRequest, EnableCardToCardPaymentResponse, MobileWalletPayload, MobileWalletPayloadRequest, PinStatus, ReplaceCardRequest, UpdateCardRequest, CreateCardRquest} from "../types/cards"
-import { BaseListParams, Include, UnitConfig, UnitResponse } from "../types/common"
+    Card, CardLimits, CreateDebitCardRequest, EnableCardToCardPaymentRequest, EnableCardToCardPaymentResponse, MobileWalletPayload, MobileWalletPayloadRequest, PinStatus, ReplaceCardRequest, UpdateCardRequest, CreateCardRquest, CardStatus} from "../types/cards"
+import { BaseListParams, Include, Sort, Tags, UnitConfig, UnitResponse } from "../types/common"
 import { Customer } from "../types/customer"
 import { Account } from "../types/account"
 import { BaseResource } from "./baseResource"
@@ -131,17 +131,17 @@ export interface CardListParams extends BaseListParams {
     /**
      * Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active
      */
-    status?: string[]
+    status?: CardStatus[]
 
     /**
      * Optional. Filter Applications by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 }
diff --git a/resources/checkDeposit.ts b/resources/checkDeposit.ts
@@ -1,4 +1,4 @@
-import { Account, Customer, Transaction } from "../types"
+import { Account, CheckDepositStatus, Customer, Sort, Tags, Transaction } from "../types"
 import { CheckDeposit, CreateCheckDepositRequest, PatchCheckDepositRequest, UploadCheckDepositRequest } from "../types"
 import { UnitResponse, Include, UnitConfig, BaseListParams } from "../types"
 import { BaseResource } from "./baseResource"
@@ -79,17 +79,17 @@ export interface CheckDepositListParams extends BaseListParams {
      * Optional. Filter Applications by [Tags](https://developers.unit.co/#tags).
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filter results by [Check Deposit Status](https://developers.unit.co/check-deposits#check-deposit-status).
      */
-    status?: string[]
+    status?: CheckDepositStatus[]
 
     /**
      * Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
      */
-    sort?: string
+    sort?: Sort
 
     /**
      * Optional. Related resource available to include: customer. See [Getting Related Resources](https://developers.unit.co/#intro-getting-related-resources).
diff --git a/resources/customer.ts b/resources/customer.ts
@@ -1,5 +1,5 @@
-import { UnitResponse, UnitConfig, Meta, BaseListParams } from "../types/common"
-import { Customer, PatchCustomerRequest, ArchiveCustomerRequest, AddAuthorizedUsersRequest, RemoveAuthorizedUsersRequest } from "../types/customer"
+import { UnitResponse, UnitConfig, Meta, BaseListParams, Tags, Sort } from "../types/common"
+import { Customer, PatchCustomerRequest, ArchiveCustomerRequest, AddAuthorizedUsersRequest, RemoveAuthorizedUsersRequest, CustomerStatus } from "../types/customer"
 import { BaseResource } from "./baseResource"
 
 export class Customers extends BaseResource {
@@ -65,16 +65,16 @@ export interface CustomersListParams extends BaseListParams {
      * Optional. Filter customers by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filter customers by status (Active, Archived). Usage example: *filter[status][0]=Active
      */
-    status?: string[]
+    status?: CustomerStatus[]
 
     /**
      * Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 }
diff --git a/resources/payments.ts b/resources/payments.ts
@@ -1,7 +1,7 @@
 import { Account } from "../types/account"
-import { BaseListParams, Include, Meta, UnitConfig, UnitResponse } from "../types/common"
+import { BaseListParams, Include, Meta, Sort, Tags, UnitConfig, UnitResponse } from "../types/common"
 import { Customer } from "../types/customer"
-import { BulkPayments, CreatePaymentRequest, PatchPaymentRequest, Payment } from "../types/payments"
+import { BulkPayments, CreatePaymentRequest, PatchPaymentRequest, Payment, PaymentStatus } from "../types/payments"
 import { Transaction } from "../types/transactions"
 import { BaseResource } from "./baseResource"
 
@@ -45,6 +45,7 @@ export class Payments extends BaseResource {
             ...(params?.since && { "filter[since]": params.since }),
             ...(params?.until && { "filter[until]": params.until }),
             ...(params?.counterpartyAccountId && { "filter[counterpartyAccountId]": params.counterpartyAccountId }),
+            ...(params?.recurringPaymentId && { "filter[recurringPaymentId]": params.recurringPaymentId }),
             ...(params?.fromAmount && { "filter[fromAmount]": params.fromAmount }),
             ...(params?.toAmount && { "filter[toAmount]": params.toAmount }),
             "sort": params?.sort ? params.sort : "-createdAt",
@@ -65,6 +66,11 @@ export class Payments extends BaseResource {
             params.direction.forEach((d, idx) => {
                 parameters[`filter[direction][${idx}]`] = d
             })
+
+        if (params?.feature)
+            params.feature.forEach((d, idx) => {
+                parameters[`filter[feature][${idx}]`] = d
+            })
         
         return this.httpGet<UnitResponse<Payment[]> & Include<Account[] | Customer[] | Transaction[]> & Meta>("", { params: parameters })
     }
@@ -87,12 +93,12 @@ export interface PaymentListParams extends BaseListParams {
      * Optional. Filter Applications by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filter Payments by [ACH Status](https://developers.unit.co/payments/#ach-status).
      */
-    status?: string[]
+    status?: PaymentStatus[]
 
     /**
      * Optional. Filter Payments by Payment type. such as (ACHPayment, BookPayment, WirePayment or BillPayment).
@@ -133,11 +139,21 @@ export interface PaymentListParams extends BaseListParams {
      * Optional. Leave empty or provide sort = createdAt for ascending order.Provide sort = -createdAt(leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 
     /**
     * Optional. A comma-separated list of related resources to include in the response.
     * Related resources include: customer, account. [See Getting Related Resources](https://developers.unit.co/#intro-getting-related-resources)
     */
     include?: string
+
+    /**
+     * Optional. Filters the results by the specified recurring payment id.
+     */
+    recurringPaymentId?: string
+
+    /**
+     * Optional. Filter Payments by Payment feature (SameDay, RecurringPayment). Usage example: filter[feature][0]=SameDay
+     */
+    feature?: string[]
 }
diff --git a/resources/receivedPayments.ts b/resources/receivedPayments.ts
@@ -1,5 +1,5 @@
 import { Account } from "../types/account"
-import {BaseListParams, Include, Meta, UnitConfig, UnitResponse} from "../types/common"
+import {BaseListParams, Include, Meta, Sort, Tags, UnitConfig, UnitResponse} from "../types/common"
 import { Customer } from "../types/customer"
 import { AchReceivedPayment, PatchPaymentRequest, ReceivedPaymentStatus } from "../types/payments"
 import { Transaction } from "../types/transactions"
@@ -66,7 +66,7 @@ export interface ReceivedPaymentListParams extends BaseListParams {
      * Optional. Filter Applications by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filter Received Payments by ReceivedPayment Status. Usage example: filter[status][0]=Pending&filter[status][1]=Advanced. cant be stated with includeCompleted.
@@ -82,7 +82,7 @@ export interface ReceivedPaymentListParams extends BaseListParams {
      * Optional. Leave empty or provide sort = createdAt for ascending order.Provide sort = -createdAt(leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 
     /**
     * Optional. A comma-separated list of related resources to include in the response.
diff --git a/resources/recurringPayments.ts b/resources/recurringPayments.ts
@@ -1,6 +1,6 @@
 import { BaseResource } from "./baseResource"
-import { BaseListParams, Meta, UnitConfig, UnitResponse } from "../types/common"
-import { CreateRecurringPaymentRequest, RecurringPayment } from "../types/recurringPayment"
+import { BaseListParams, Meta, Sort, Tags, UnitConfig, UnitResponse } from "../types/common"
+import { CreateRecurringPaymentRequest, RecurringPayment, RecurringPaymentStatus } from "../types/recurringPayment"
 
 export class RecurringPayments extends BaseResource {
     constructor(token: string, basePath: string, config?: UnitConfig) {
@@ -84,12 +84,12 @@ export interface RecurringPaymentListParams extends BaseListParams {
      * Optional. Filter Applications by Tags.
      * default: empty
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filter recurring payments by status (Active, Completed or Disabled). Usage example: *filter[status][0]=Active
      */
-    status?: string[]
+    status?: RecurringPaymentStatus[]
 
     /**
      * Optional. Filter recurring payments by Recurring Payment type. such as (RecurringCreditAchPayment, RecurringCreditBookPayment). Usage example: filter[type][0]=RecurringCreditAchPayment&filter[type][1]=RecurringCreditBookPayment
@@ -124,5 +124,5 @@ export interface RecurringPaymentListParams extends BaseListParams {
      * Optional. Leave empty or provide sort = createdAt for ascending order.Provide sort = -createdAt(leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 }
diff --git a/resources/statements.ts b/resources/statements.ts
@@ -1,4 +1,4 @@
-import { BaseListParams, Statement, UnitConfig, UnitResponse } from "../types"
+import { BaseListParams, Sort, Statement, UnitConfig, UnitResponse } from "../types"
 import { BaseResource } from "./baseResource"
 import {responseEncoding, ResponseType} from "axios"
 
@@ -60,7 +60,7 @@ export interface StatementsListParams extends BaseListParams {
      * Optional. sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
      * default: sort=-period
      */
-    sort?: string
+    sort?: Sort
 
     /**
      * Optional. Filters the results for a specific month. e.g. 2021-01
diff --git a/resources/transactions.ts b/resources/transactions.ts
@@ -1,4 +1,4 @@
-import { BaseListParams, Include, Meta, UnitConfig, UnitResponse } from "../types/common"
+import { BaseListParams, Include, Meta, Sort, Tags, UnitConfig, UnitResponse } from "../types/common"
 import { Customer } from "../types/customer"
 import { Account } from "../types/account"
 import { Transaction } from "../types/transactions"
@@ -101,7 +101,7 @@ export interface TransactionListParams extends BaseListParams {
     * Optional. Filter Applications by Tags.
     * default: empty
     */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Filters the Transactions that occurred after the specified date.
@@ -127,7 +127,7 @@ export interface TransactionListParams extends BaseListParams {
      * Optional. .Leave empty or provide sort = createdAt for ascending order.Provide sort = -createdAt(leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 
     /**
      * Optional. Filter Transactions by Transaction type. Possible values include: OriginatedAch, ReceivedAch, ReturnedAch, DishonoredAch, Book,
diff --git a/types/common.ts b/types/common.ts
@@ -25,10 +25,10 @@ export interface BaseListParams extends UnimplementedFields {
      * default: 0
      */
     offset?: number
-
-    [k: string]: unknown
 }
 
+export type Sort = "createdAt" | "-createdAt"
+
 /**
  * See [Tags](https://developers.unit.co/#tags).
  * Inherited from the payment tags (see [Tag Inheritance](https://developers.unit.co/#tag-inheritance)).
diff --git a/types/rewards.ts b/types/rewards.ts
@@ -1,4 +1,4 @@
-import { BaseListParams, Relationship } from "./common"
+import { BaseListParams, Relationship, Sort, Tags } from "./common"
 
 export type RewardStatus = "Sent" | "Rejected"
 
@@ -172,13 +172,13 @@ export interface RewardListParams extends BaseListParams {
     /**
      * Optional. Filter rewards by [Tags](https://developers.unit.co/#tags).
      */
-    tags?: object
+    tags?: Tags
 
     /**
      * Optional. Leave empty or provide sort = createdAt for ascending order.Provide sort = -createdAt(leading minus sign) for descending order.
      * default: sort=-createdAt
      */
-    sort?: string
+    sort?: Sort
 
     /**
     * Optional. A comma-separated list of related resources to include in the response.
