Merge pull request #119 from starkbank/fix/typescript-types

Specify null types for optional parameters
starkbank · Mar 19, 2024 · ece0c7c · ece0c7c
2 parents 9f480a4 + 30fccb5
commit ece0c7c
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 ## [Unreleased]
 ### Fixed
 - tags types parameter reference
+- optional parameters types
 
 ## [2.23.2] - 2024-02-21
 ### Changed

diff --git a/types/darfPayment/darfPayment.d.ts b/types/darfPayment/darfPayment.d.ts
@@ -45,9 +45,9 @@ declare module 'starkbank' {
         interestAmount: number
         due: string
 
-        referenceNumber: string
-        scheduled: string
-        tags: string[]
+        referenceNumber: string | null
+        scheduled: string | null
+        tags: string[] | null
 
         readonly id : string
         readonly status : string

diff --git a/types/deposit/deposit.d.ts b/types/deposit/deposit.d.ts
@@ -36,15 +36,15 @@ declare module 'starkbank' {
         amount: number
         type: string
         status: string
-        tags: string[]
+        tags: string[] | null
         fee: number
         transactionIds: string[]
         created: string
         updated: string
 
         constructor(params: {
             id: string, name: string, taxId: string, bankCode: string, branchCode: string, accountNumber: string, accountType: string, amount: number,
-            type: string, status: string, tags: string[], fee: number, transactionIds: string[], created: string, updated: string
+            type: string, status: string, tags: string[] | null, fee: number, transactionIds: string[], created: string, updated: string
         })
     }
 

diff --git a/types/invoice/invoice.d.ts b/types/invoice/invoice.d.ts
@@ -57,7 +57,7 @@ declare module 'starkbank' {
             due: string
         }[]
         rules : invoice.Rule[] | null
-        tags: string[]
+        tags: string[] | null
         descriptions: {
             key: string
             value?: string
@@ -79,7 +79,7 @@ declare module 'starkbank' {
 
         constructor(params: {
             amount: number, taxId: string, name: string, due?: string, expiration?: number, fine?: number, 
-            interest?: number, discounts?: {percentage: number, due: string}[], tags?: string[], 
+            interest?: number, discounts?: {percentage: number, due: string}[], tags?: string[] | null, 
             descriptions?: {key: string, value?: string}[], fee?: number | null, pdf?: string | null, link?: string | null, 
             nominalAmount?: number | null, fineAmount?: number | null, interestAmount?: number | null, 
             discountAmount?: number | null, id?: string, brcode?: string | null, status?: string | null, transactionIds?: string[] | null, created?: string | null, 

diff --git a/types/paymentRequest/paymentRequest.d.ts b/types/paymentRequest/paymentRequest.d.ts
@@ -38,7 +38,7 @@ declare module 'starkbank' {
         type: string
 
         due: string
-        tags: string[]
+        tags: string[] | null
 
         readonly id: string
         readonly amount: number | null
@@ -54,7 +54,7 @@ declare module 'starkbank' {
 
         constructor(params: {
             centerId: string, payment: Transfer | BoletoPayment | UtilityPayment | Transaction | BrcodePayment | {}, 
-            type?: string, due?: string, tags?: string[], id?: string | null | null, amount?: number | null, 
+            type?: string, due?: string, tags?: string[] | null, id?: string | null | null, amount?: number | null, 
             status?: string | null, description?: string | null, actions?: {type: string, id: string, 
             action: string}[] | null, updated?: string | null, created?: string | null
         })

diff --git a/types/taxPayment/taxPayment.d.ts b/types/taxPayment/taxPayment.d.ts
@@ -39,7 +39,7 @@ declare module 'starkbank' {
         barCode: string
 
         scheduled: string
-        tags: string[]
+        tags: string[] | null
 
         readonly id : string
         readonly type : string
@@ -51,7 +51,7 @@ declare module 'starkbank' {
         readonly created : string
 
         constructor(params: {
-            description: string, line?: string, barCode?: string, scheduled?: string, tags?: string[], 
+            description: string, line?: string, barCode?: string, scheduled?: string, tags?: string[] | null, 
             id?: string | null, type?: string | null, status?: string | null, amount?: number | null, 
             fee?: number | null, transactionIds?: string[] | null, updated?: string | null, 
             created?: string | null

diff --git a/types/transaction/transaction.d.ts b/types/transaction/transaction.d.ts
@@ -38,7 +38,7 @@ declare module 'starkbank' {
         externalId: string
         receiverId: string
 
-        tags: string[]
+        tags: string[] | null
 
         readonly senderId : string
         readonly id : string
@@ -50,7 +50,7 @@ declare module 'starkbank' {
 
         constructor(params: {
             amount: number, description: string, externalId: string, receiverId: string, 
-            tags?: string[], senderId?: string | null, id?: string | null, fee?: number | null, 
+            tags?: string[] | null, senderId?: string | null, id?: string | null, fee?: number | null, 
             source?: string | null, balance?: number | null, created?: string | null, 
         })
     }

diff --git a/types/transfer/transfer.d.ts b/types/transfer/transfer.d.ts
@@ -62,7 +62,7 @@ declare module 'starkbank' {
 
         constructor(params: {
             amount: number, name: string, taxId: string, bankCode: string, branchCode: string, accountNumber: string, 
-            accountType?: string, externalId?: string, tags?: string[], rules?: transfer.Rule[], scheduled?: string, 
+            accountType?: string, externalId?: string, tags?: string[] | null, rules?: transfer.Rule[], scheduled?: string, 
             description?: string | null, id?: string | null, fee?: number | null, status?: string | null, 
             transactionIds?: string[] | null, metadata?: {}, created?: string | null, updated?: string | null, 
         })