@finverse/sdk-typescript 0.0.403 → 0.0.404

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -179,6 +179,20 @@ export interface Account {
179
179
  [key: string]: string;
180
180
  };
181
181
  }
182
+ /**
183
+ * Account category
184
+ * @export
185
+ * @enum {string}
186
+ */
187
+ export declare const AccountCategory: {
188
+ readonly Unknown: "UNKNOWN";
189
+ readonly Deposit: "DEPOSIT";
190
+ readonly Card: "CARD";
191
+ readonly Investment: "INVESTMENT";
192
+ readonly Loan: "LOAN";
193
+ readonly Other: "OTHER";
194
+ };
195
+ export type AccountCategory = (typeof AccountCategory)[keyof typeof AccountCategory];
182
196
  /**
183
197
  *
184
198
  * @export
@@ -222,10 +236,10 @@ export type AccountNumberType = (typeof AccountNumberType)[keyof typeof AccountN
222
236
  export interface AccountType {
223
237
  /**
224
238
  *
225
- * @type {string}
239
+ * @type {AccountCategory}
226
240
  * @memberof AccountType
227
241
  */
228
- type?: AccountTypeTypeEnum;
242
+ type?: AccountCategory;
229
243
  /**
230
244
  *
231
245
  * @type {string}
@@ -233,14 +247,6 @@ export interface AccountType {
233
247
  */
234
248
  subtype?: AccountTypeSubtypeEnum;
235
249
  }
236
- export declare const AccountTypeTypeEnum: {
237
- readonly Deposit: "DEPOSIT";
238
- readonly Card: "CARD";
239
- readonly Investment: "INVESTMENT";
240
- readonly Loan: "LOAN";
241
- readonly Unknown: "UNKNOWN";
242
- };
243
- export type AccountTypeTypeEnum = (typeof AccountTypeTypeEnum)[keyof typeof AccountTypeTypeEnum];
244
250
  export declare const AccountTypeSubtypeEnum: {
245
251
  readonly Current: "CURRENT";
246
252
  readonly Savings: "SAVINGS";
@@ -523,6 +529,37 @@ export declare const AuthChecklistOptionsSubmittedByEnum: {
523
529
  readonly FinverseLink: "FINVERSE_LINK";
524
530
  };
525
531
  export type AuthChecklistOptionsSubmittedByEnum = (typeof AuthChecklistOptionsSubmittedByEnum)[keyof typeof AuthChecklistOptionsSubmittedByEnum];
532
+ /**
533
+ *
534
+ * @export
535
+ * @interface AuthenticationStatus
536
+ */
537
+ export interface AuthenticationStatus {
538
+ /**
539
+ *
540
+ * @type {LoginIdentityAuthStatus}
541
+ * @memberof AuthenticationStatus
542
+ */
543
+ status?: LoginIdentityAuthStatus;
544
+ /**
545
+ * The detailed event name
546
+ * @type {string}
547
+ * @memberof AuthenticationStatus
548
+ */
549
+ status_details?: string;
550
+ /**
551
+ *
552
+ * @type {string}
553
+ * @memberof AuthenticationStatus
554
+ */
555
+ last_update?: string | null;
556
+ /**
557
+ *
558
+ * @type {string}
559
+ * @memberof AuthenticationStatus
560
+ */
561
+ last_successful_update?: string | null;
562
+ }
526
563
  /**
527
564
  *
528
565
  * @export
@@ -577,7 +614,7 @@ export interface AvailablePaymentMethod {
577
614
  * @type {PaymentType}
578
615
  * @memberof AvailablePaymentMethod
579
616
  */
580
- payment_method_type?: PaymentType;
617
+ payment_method_type: PaymentType;
581
618
  /**
582
619
  * The payment method subtype, e.g., EDDA_HK, CARD_GENERIC etc
583
620
  * @type {string}
@@ -926,7 +963,7 @@ export interface CardAccount {
926
963
  * @type {string}
927
964
  * @memberof CardAccount
928
965
  */
929
- account_id?: string;
966
+ account_id: string;
930
967
  /**
931
968
  *
932
969
  * @type {string}
@@ -1103,7 +1140,7 @@ export interface CardFvLinkResponse {
1103
1140
  * @type {CardStatus}
1104
1141
  * @memberof CardFvLinkResponse
1105
1142
  */
1106
- status?: CardStatus;
1143
+ status: CardStatus;
1107
1144
  /**
1108
1145
  *
1109
1146
  * @type {CardFvLinkDetails}
@@ -1134,7 +1171,7 @@ export interface CardRecipient {
1134
1171
  * @type {string}
1135
1172
  * @memberof CardRecipient
1136
1173
  */
1137
- name?: string;
1174
+ name: string;
1138
1175
  }
1139
1176
  /**
1140
1177
  * Card status
@@ -2167,7 +2204,7 @@ export interface DeleteLoginIdentityResponse {
2167
2204
  * @type {boolean}
2168
2205
  * @memberof DeleteLoginIdentityResponse
2169
2206
  */
2170
- success?: boolean;
2207
+ success: boolean;
2171
2208
  }
2172
2209
  /**
2173
2210
  *
@@ -2180,19 +2217,19 @@ export interface DisputeResponse {
2180
2217
  * @type {string}
2181
2218
  * @memberof DisputeResponse
2182
2219
  */
2183
- dispute_id?: string;
2220
+ dispute_id: string;
2184
2221
  /**
2185
2222
  * Amount to be disputed, in currency\'s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
2186
2223
  * @type {number}
2187
2224
  * @memberof DisputeResponse
2188
2225
  */
2189
- amount?: number;
2226
+ amount: number;
2190
2227
  /**
2191
2228
  * The currency of the balance
2192
2229
  * @type {string}
2193
2230
  * @memberof DisputeResponse
2194
2231
  */
2195
- currency?: string;
2232
+ currency: string;
2196
2233
  /**
2197
2234
  * The name of the last event for this dispute
2198
2235
  * @type {string}
@@ -2270,7 +2307,7 @@ export interface DisputeResponse {
2270
2307
  * @type {DisputeStatus}
2271
2308
  * @memberof DisputeResponse
2272
2309
  */
2273
- dispute_status?: DisputeStatus;
2310
+ dispute_status: DisputeStatus;
2274
2311
  /**
2275
2312
  * The status of the dispute at the payment processor
2276
2313
  * @type {string}
@@ -2591,7 +2628,7 @@ export interface FVCard {
2591
2628
  * @type {CardStatus}
2592
2629
  * @memberof FVCard
2593
2630
  */
2594
- status?: CardStatus;
2631
+ status: CardStatus;
2595
2632
  /**
2596
2633
  *
2597
2634
  * @type {FvEmbeddedErrorModel}
@@ -2799,7 +2836,7 @@ export interface Fee {
2799
2836
  * @type {string}
2800
2837
  * @memberof Fee
2801
2838
  */
2802
- currency?: string;
2839
+ currency: string;
2803
2840
  /**
2804
2841
  *
2805
2842
  * @type {FeePaidBy}
@@ -3114,7 +3151,7 @@ export interface GetBalanceHistoryResponse {
3114
3151
  * @type {string}
3115
3152
  * @memberof GetBalanceHistoryResponse
3116
3153
  */
3117
- source?: GetBalanceHistoryResponseSourceEnum;
3154
+ source: GetBalanceHistoryResponseSourceEnum;
3118
3155
  }
3119
3156
  export declare const GetBalanceHistoryResponseSourceEnum: {
3120
3157
  readonly Institution: "INSTITUTION";
@@ -4235,7 +4272,7 @@ export interface InstitutionShort {
4235
4272
  * @type {string}
4236
4273
  * @memberof InstitutionShort
4237
4274
  */
4238
- institution_id?: string;
4275
+ institution_id: string;
4239
4276
  /**
4240
4277
  *
4241
4278
  * @type {Array<string>}
@@ -4961,7 +4998,7 @@ export interface ListPaymentsResponse {
4961
4998
  * @type {Array<PaymentResponse>}
4962
4999
  * @memberof ListPaymentsResponse
4963
5000
  */
4964
- payments?: Array<PaymentResponse>;
5001
+ payments: Array<PaymentResponse>;
4965
5002
  /**
4966
5003
  *
4967
5004
  * @type {number}
@@ -5123,7 +5160,7 @@ export interface LoginIdentity {
5123
5160
  * @type {string}
5124
5161
  * @memberof LoginIdentity
5125
5162
  */
5126
- login_identity_id?: string;
5163
+ login_identity_id: string;
5127
5164
  /**
5128
5165
  *
5129
5166
  * @type {string}
@@ -5168,10 +5205,10 @@ export interface LoginIdentity {
5168
5205
  billing_details?: LoginIdentityBillingDetails;
5169
5206
  /**
5170
5207
  *
5171
- * @type {string}
5208
+ * @type {LoginIdentityStatus}
5172
5209
  * @memberof LoginIdentity
5173
5210
  */
5174
- status?: string;
5211
+ status: LoginIdentityStatus;
5175
5212
  /**
5176
5213
  *
5177
5214
  * @type {LoginIdentityStatusDetails}
@@ -5186,10 +5223,10 @@ export interface LoginIdentity {
5186
5223
  product_status?: AllProductStatus;
5187
5224
  /**
5188
5225
  *
5189
- * @type {ProductStatus}
5226
+ * @type {AuthenticationStatus}
5190
5227
  * @memberof LoginIdentity
5191
5228
  */
5192
- authentication_status?: ProductStatus;
5229
+ authentication_status?: AuthenticationStatus;
5193
5230
  /**
5194
5231
  *
5195
5232
  * @type {LoginIdentityError}
@@ -5216,10 +5253,10 @@ export interface LoginIdentity {
5216
5253
  webhook?: string;
5217
5254
  /**
5218
5255
  *
5219
- * @type {string}
5256
+ * @type {LoginIdentitySessionStatus}
5220
5257
  * @memberof LoginIdentity
5221
5258
  */
5222
- session_status?: string;
5259
+ session_status?: LoginIdentitySessionStatus;
5223
5260
  /**
5224
5261
  *
5225
5262
  * @type {string}
@@ -5269,6 +5306,21 @@ export interface LoginIdentity {
5269
5306
  */
5270
5307
  refresh?: RefreshData;
5271
5308
  }
5309
+ /**
5310
+ * Login identity authentication status
5311
+ * @export
5312
+ * @enum {string}
5313
+ */
5314
+ export declare const LoginIdentityAuthStatus: {
5315
+ readonly Unknown: "UNKNOWN";
5316
+ readonly Linking: "LINKING";
5317
+ readonly Authenticating: "AUTHENTICATING";
5318
+ readonly Authenticated: "AUTHENTICATED";
5319
+ readonly AuthenticateFailed: "AUTHENTICATE_FAILED";
5320
+ readonly AuthenticationTemporarilyUnavailableForInstitution: "AUTHENTICATION_TEMPORARILY_UNAVAILABLE_FOR_INSTITUTION";
5321
+ readonly AuthenticationTooManyAttempts: "AUTHENTICATION_TOO_MANY_ATTEMPTS";
5322
+ };
5323
+ export type LoginIdentityAuthStatus = (typeof LoginIdentityAuthStatus)[keyof typeof LoginIdentityAuthStatus];
5272
5324
  /**
5273
5325
  *
5274
5326
  * @export
@@ -5332,6 +5384,18 @@ export interface LoginIdentityLoginMethodsAvailable {
5332
5384
  */
5333
5385
  haveSecret?: boolean;
5334
5386
  }
5387
+ /**
5388
+ * Login identity session status
5389
+ * @export
5390
+ * @enum {string}
5391
+ */
5392
+ export declare const LoginIdentitySessionStatus: {
5393
+ readonly Unknown: "UNKNOWN";
5394
+ readonly InProgress: "IN_PROGRESS";
5395
+ readonly Completed: "COMPLETED";
5396
+ readonly Unlinked: "UNLINKED";
5397
+ };
5398
+ export type LoginIdentitySessionStatus = (typeof LoginIdentitySessionStatus)[keyof typeof LoginIdentitySessionStatus];
5335
5399
  /**
5336
5400
  *
5337
5401
  * @export
@@ -5343,13 +5407,13 @@ export interface LoginIdentityShort {
5343
5407
  * @type {string}
5344
5408
  * @memberof LoginIdentityShort
5345
5409
  */
5346
- login_identity_id?: string;
5410
+ login_identity_id: string;
5347
5411
  /**
5348
5412
  *
5349
- * @type {string}
5413
+ * @type {LoginIdentityStatus}
5350
5414
  * @memberof LoginIdentityShort
5351
5415
  */
5352
- status?: string;
5416
+ status: LoginIdentityStatus;
5353
5417
  /**
5354
5418
  *
5355
5419
  * @type {string}
@@ -5357,6 +5421,28 @@ export interface LoginIdentityShort {
5357
5421
  */
5358
5422
  last_session_id?: string;
5359
5423
  }
5424
+ /**
5425
+ * Login identity status
5426
+ * @export
5427
+ * @enum {string}
5428
+ */
5429
+ export declare const LoginIdentityStatus: {
5430
+ readonly Unknown: "UNKNOWN";
5431
+ readonly Error: "ERROR";
5432
+ readonly Linking: "LINKING";
5433
+ readonly Authenticating: "AUTHENTICATING";
5434
+ readonly ConnectionComplete: "CONNECTION_COMPLETE";
5435
+ readonly ConnectionInProgress: "CONNECTION_IN_PROGRESS";
5436
+ readonly DataRetrievalInProgress: "DATA_RETRIEVAL_IN_PROGRESS";
5437
+ readonly DataAvailable: "DATA_AVAILABLE";
5438
+ readonly DataRetrievalPartiallySuccessful: "DATA_RETRIEVAL_PARTIALLY_SUCCESSFUL";
5439
+ readonly DataRetrievalComplete: "DATA_RETRIEVAL_COMPLETE";
5440
+ readonly Refreshing: "REFRESHING";
5441
+ readonly Unlinked: "UNLINKED";
5442
+ readonly UnlinkSucceeded: "UNLINK_SUCCEEDED";
5443
+ readonly UnlinkFailed: "UNLINK_FAILED";
5444
+ };
5445
+ export type LoginIdentityStatus = (typeof LoginIdentityStatus)[keyof typeof LoginIdentityStatus];
5360
5446
  /**
5361
5447
  *
5362
5448
  * @export
@@ -5764,7 +5850,7 @@ export interface MandateFvLinkResponse {
5764
5850
  * @type {MandateStatus}
5765
5851
  * @memberof MandateFvLinkResponse
5766
5852
  */
5767
- mandate_status?: MandateStatus;
5853
+ mandate_status: MandateStatus;
5768
5854
  /**
5769
5855
  *
5770
5856
  * @type {MandateRecipient}
@@ -6103,7 +6189,7 @@ export interface PaymentAccountDetails {
6103
6189
  * @type {string}
6104
6190
  * @memberof PaymentAccountDetails
6105
6191
  */
6106
- account_id?: string;
6192
+ account_id: string;
6107
6193
  /**
6108
6194
  *
6109
6195
  * @type {RecipientAccountNumber}
@@ -6121,7 +6207,7 @@ export interface PaymentAccountDetails {
6121
6207
  * @type {PaymentAccountType}
6122
6208
  * @memberof PaymentAccountDetails
6123
6209
  */
6124
- account_type?: PaymentAccountType;
6210
+ account_type: PaymentAccountType;
6125
6211
  /**
6126
6212
  * Accountholder name of the payment account
6127
6213
  * @type {string}
@@ -6220,7 +6306,7 @@ export interface PaymentAccountDetailsWithEnrichedData {
6220
6306
  * @type {string}
6221
6307
  * @memberof PaymentAccountDetailsWithEnrichedData
6222
6308
  */
6223
- account_id?: string;
6309
+ account_id: string;
6224
6310
  /**
6225
6311
  *
6226
6312
  * @type {RecipientAccountNumber}
@@ -6238,7 +6324,7 @@ export interface PaymentAccountDetailsWithEnrichedData {
6238
6324
  * @type {PaymentAccountType}
6239
6325
  * @memberof PaymentAccountDetailsWithEnrichedData
6240
6326
  */
6241
- account_type?: PaymentAccountType;
6327
+ account_type: PaymentAccountType;
6242
6328
  /**
6243
6329
  * Accountholder name of the payment account
6244
6330
  * @type {string}
@@ -6544,13 +6630,13 @@ export interface PaymentFvLinkResponse {
6544
6630
  * @type {PaymentStatus}
6545
6631
  * @memberof PaymentFvLinkResponse
6546
6632
  */
6547
- status?: PaymentStatus;
6633
+ status: PaymentStatus;
6548
6634
  /**
6549
6635
  *
6550
6636
  * @type {PaymentType}
6551
6637
  * @memberof PaymentFvLinkResponse
6552
6638
  */
6553
- type?: PaymentType;
6639
+ type: PaymentType;
6554
6640
  /**
6555
6641
  *
6556
6642
  * @type {PaymentFvLinkDetails}
@@ -6679,19 +6765,19 @@ export interface PaymentLinkResponse {
6679
6765
  * @type {string}
6680
6766
  * @memberof PaymentLinkResponse
6681
6767
  */
6682
- payment_link_id?: string;
6768
+ payment_link_id: string;
6683
6769
  /**
6684
6770
  * The amount of the payment. Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
6685
6771
  * @type {number}
6686
6772
  * @memberof PaymentLinkResponse
6687
6773
  */
6688
- amount?: number;
6774
+ amount: number;
6689
6775
  /**
6690
6776
  *
6691
6777
  * @type {string}
6692
6778
  * @memberof PaymentLinkResponse
6693
6779
  */
6694
- currency?: string;
6780
+ currency: string;
6695
6781
  /**
6696
6782
  *
6697
6783
  * @type {PaymentLinkCustomizations}
@@ -6703,7 +6789,7 @@ export interface PaymentLinkResponse {
6703
6789
  * @type {PaymentLinkMode}
6704
6790
  * @memberof PaymentLinkResponse
6705
6791
  */
6706
- mode?: PaymentLinkMode;
6792
+ mode: PaymentLinkMode;
6707
6793
  /**
6708
6794
  *
6709
6795
  * @type {PaymentLinkDetails}
@@ -6749,13 +6835,13 @@ export interface PaymentLinkResponse {
6749
6835
  * @type {PaymentLinkStatus}
6750
6836
  * @memberof PaymentLinkResponse
6751
6837
  */
6752
- status?: PaymentLinkStatus;
6838
+ status: PaymentLinkStatus;
6753
6839
  /**
6754
6840
  *
6755
6841
  * @type {PaymentLinkSessionStatus}
6756
6842
  * @memberof PaymentLinkResponse
6757
6843
  */
6758
- session_status?: PaymentLinkSessionStatus;
6844
+ session_status: PaymentLinkSessionStatus;
6759
6845
  /**
6760
6846
  * Timestamp of when the payment link was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
6761
6847
  * @type {string}
@@ -6918,13 +7004,13 @@ export interface PaymentMethodFvLinkResponse {
6918
7004
  * @type {string}
6919
7005
  * @memberof PaymentMethodFvLinkResponse
6920
7006
  */
6921
- payment_method_id?: string;
7007
+ payment_method_id: string;
6922
7008
  /**
6923
7009
  *
6924
7010
  * @type {PaymentMethodType}
6925
7011
  * @memberof PaymentMethodFvLinkResponse
6926
7012
  */
6927
- payment_method_type?: PaymentMethodType;
7013
+ payment_method_type: PaymentMethodType;
6928
7014
  /**
6929
7015
  *
6930
7016
  * @type {string}
@@ -7386,13 +7472,13 @@ export interface PaymentMethodResponse {
7386
7472
  * @type {string}
7387
7473
  * @memberof PaymentMethodResponse
7388
7474
  */
7389
- payment_method_id?: string;
7475
+ payment_method_id: string;
7390
7476
  /**
7391
7477
  *
7392
7478
  * @type {PaymentMethodType}
7393
7479
  * @memberof PaymentMethodResponse
7394
7480
  */
7395
- payment_method_type?: PaymentMethodType;
7481
+ payment_method_type: PaymentMethodType;
7396
7482
  /**
7397
7483
  * Whether the payment method is live (true) or a test payment method (false), based on its payment rail. Absent if the payment rail is unknown.
7398
7484
  * @type {boolean}
@@ -7459,17 +7545,23 @@ export interface PaymentProcessorDetails {
7459
7545
  */
7460
7546
  scheme?: string;
7461
7547
  /**
7462
- * Virtual account number issued by the processor (e.g. KCP manual virtual account payments).
7548
+ * Virtual account number issued by the processor (applicable to KCP manual virtual account payments).
7463
7549
  * @type {string}
7464
7550
  * @memberof PaymentProcessorDetails
7465
7551
  */
7466
7552
  virtual_account_number?: string;
7467
7553
  /**
7468
- * Bank code for the virtual account without a BK prefix (e.g. KCP manual virtual account payments).
7554
+ * Bank code for the virtual account without a \"BK\"/\"B\" prefix (applicable to KCP manual virtual account payments).
7469
7555
  * @type {string}
7470
7556
  * @memberof PaymentProcessorDetails
7471
7557
  */
7472
7558
  virtual_account_bank_code?: string;
7559
+ /**
7560
+ * Bank code of the payer\'s bank without a \"BK\"/\"B\" prefix (applicable to KCP bank transfer payments).
7561
+ * @type {string}
7562
+ * @memberof PaymentProcessorDetails
7563
+ */
7564
+ bank_code?: string;
7473
7565
  /**
7474
7566
  *
7475
7567
  * @type {PaymentProcessorResult}
@@ -7525,7 +7617,7 @@ export interface PaymentResponse {
7525
7617
  * @type {string}
7526
7618
  * @memberof PaymentResponse
7527
7619
  */
7528
- payment_id?: string;
7620
+ payment_id: string;
7529
7621
  /**
7530
7622
  * Whether the payment is live (true) or a test payment (false), based on its payment rail. Absent if the payment rail is unknown.
7531
7623
  * @type {boolean}
@@ -7555,13 +7647,13 @@ export interface PaymentResponse {
7555
7647
  * @type {string}
7556
7648
  * @memberof PaymentResponse
7557
7649
  */
7558
- currency?: string;
7650
+ currency: string;
7559
7651
  /**
7560
7652
  *
7561
7653
  * @type {PaymentType}
7562
7654
  * @memberof PaymentResponse
7563
7655
  */
7564
- type?: PaymentType;
7656
+ type: PaymentType;
7565
7657
  /**
7566
7658
  * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
7567
7659
  * @type {string}
@@ -7573,7 +7665,7 @@ export interface PaymentResponse {
7573
7665
  * @type {PaymentStatus}
7574
7666
  * @memberof PaymentResponse
7575
7667
  */
7576
- status?: PaymentStatus;
7668
+ status: PaymentStatus;
7577
7669
  /**
7578
7670
  * ID of the payment method this pament is referring to.
7579
7671
  * @type {string}
@@ -7923,7 +8015,7 @@ export interface PaymentUser {
7923
8015
  * @type {string}
7924
8016
  * @memberof PaymentUser
7925
8017
  */
7926
- user_id?: string;
8018
+ user_id: string;
7927
8019
  /**
7928
8020
  *
7929
8021
  * @type {PaymentUserType}
@@ -8014,7 +8106,7 @@ export interface PaymentUserWithoutEmail {
8014
8106
  * @type {string}
8015
8107
  * @memberof PaymentUserWithoutEmail
8016
8108
  */
8017
- user_id?: string;
8109
+ user_id: string;
8018
8110
  /**
8019
8111
  *
8020
8112
  * @type {PaymentUserType}
@@ -8182,19 +8274,19 @@ export interface PayoutSnapshotResponse {
8182
8274
  * @type {string}
8183
8275
  * @memberof PayoutSnapshotResponse
8184
8276
  */
8185
- payout_id?: string;
8277
+ payout_id: string;
8186
8278
  /**
8187
8279
  *
8188
8280
  * @type {PayoutStatus}
8189
8281
  * @memberof PayoutSnapshotResponse
8190
8282
  */
8191
- status?: PayoutStatus;
8283
+ status: PayoutStatus;
8192
8284
  /**
8193
8285
  *
8194
8286
  * @type {PayoutType}
8195
8287
  * @memberof PayoutSnapshotResponse
8196
8288
  */
8197
- type?: PayoutType;
8289
+ type: PayoutType;
8198
8290
  /**
8199
8291
  *
8200
8292
  * @type {string}
@@ -8238,13 +8330,13 @@ export interface PayoutSnapshotResponse {
8238
8330
  * @type {number}
8239
8331
  * @memberof PayoutSnapshotResponse
8240
8332
  */
8241
- amount?: number;
8333
+ amount: number;
8242
8334
  /**
8243
8335
  *
8244
8336
  * @type {string}
8245
8337
  * @memberof PayoutSnapshotResponse
8246
8338
  */
8247
- currency?: string;
8339
+ currency: string;
8248
8340
  /**
8249
8341
  *
8250
8342
  * @type {MandateRecipient}
@@ -8516,6 +8608,22 @@ export interface ProcessorRiskData {
8516
8608
  */
8517
8609
  shopper_locale?: string;
8518
8610
  }
8611
+ /**
8612
+ * Health status of a login identity product
8613
+ * @export
8614
+ * @enum {string}
8615
+ */
8616
+ export declare const ProductHealthStatus: {
8617
+ readonly Unknown: "UNKNOWN";
8618
+ readonly InProgress: "IN_PROGRESS";
8619
+ readonly Success: "SUCCESS";
8620
+ readonly Warning: "WARNING";
8621
+ readonly Error: "ERROR";
8622
+ readonly NotSupported: "NOT_SUPPORTED";
8623
+ readonly NotAvailable: "NOT_AVAILABLE";
8624
+ readonly TemporarilyUnavailableForInstitution: "TEMPORARILY_UNAVAILABLE_FOR_INSTITUTION";
8625
+ };
8626
+ export type ProductHealthStatus = (typeof ProductHealthStatus)[keyof typeof ProductHealthStatus];
8519
8627
  /**
8520
8628
  *
8521
8629
  * @export
@@ -8523,11 +8631,11 @@ export interface ProcessorRiskData {
8523
8631
  */
8524
8632
  export interface ProductStatus {
8525
8633
  /**
8526
- * The current health of this product
8527
- * @type {string}
8634
+ *
8635
+ * @type {ProductHealthStatus}
8528
8636
  * @memberof ProductStatus
8529
8637
  */
8530
- status?: string;
8638
+ status: ProductHealthStatus;
8531
8639
  /**
8532
8640
  * The detailed event name
8533
8641
  * @type {string}
@@ -9202,7 +9310,7 @@ export interface Statement {
9202
9310
  * @type {string}
9203
9311
  * @memberof Statement
9204
9312
  */
9205
- id?: string;
9313
+ id: string;
9206
9314
  /**
9207
9315
  * YYYY-MM-DD
9208
9316
  * @type {string}
@@ -9233,7 +9341,7 @@ export interface StatementLink {
9233
9341
  * @type {string}
9234
9342
  * @memberof StatementLink
9235
9343
  */
9236
- url?: string;
9344
+ url: string;
9237
9345
  /**
9238
9346
  * expiry of the signedURL
9239
9347
  * @type {string}
@@ -9245,7 +9353,7 @@ export interface StatementLink {
9245
9353
  * @type {string}
9246
9354
  * @memberof StatementLink
9247
9355
  */
9248
- statement_id?: string;
9356
+ statement_id: string;
9249
9357
  }
9250
9358
  /**
9251
9359
  *
@@ -9407,13 +9515,13 @@ export interface Transaction {
9407
9515
  * @type {string}
9408
9516
  * @memberof Transaction
9409
9517
  */
9410
- transaction_id?: string;
9518
+ transaction_id: string;
9411
9519
  /**
9412
9520
  *
9413
9521
  * @type {string}
9414
9522
  * @memberof Transaction
9415
9523
  */
9416
- account_id?: string;
9524
+ account_id: string;
9417
9525
  /**
9418
9526
  *
9419
9527
  * @type {string}
@@ -9591,7 +9699,7 @@ export interface TransactionLimitsResponse {
9591
9699
  * @type {number}
9592
9700
  * @memberof TransactionLimitsResponse
9593
9701
  */
9594
- max_transaction_amount?: number;
9702
+ max_transaction_amount: number;
9595
9703
  /**
9596
9704
  * The maximum amount of money that can be transferred in a single transaction under this mandate set by the payer. Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
9597
9705
  * @type {number}
package/dist/api.js CHANGED
@@ -22,8 +22,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.PaymentMethodIntegrationMetadataGocardlessMetadataStatusEnum = exports.PaymentMethodIntegrationMetadataAdyenMetadataRecurringProcessingModelEnum = exports.PaymentMethodIntegrationMetadataIntegrationIdEnum = exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentLinkStatus = exports.PaymentLinkSessionStatus = exports.PaymentLinkMode = exports.PaymentLinkCustomizationsUiModeEnum = exports.PaymentLinkCustomizationsLanguageEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.PaymentAccountType = exports.MandateStatus = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.MandateAuthLinkCustomizationsLanguageEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestLanguageEnum = exports.LinkTokenRequestUiModeEnum = exports.LineItemItemTypeEnum = exports.KcpVaMetadataVaReceiptGubnEnum = exports.IntegrationMetadataResponseIntegrationIdEnum = exports.IntegrationMetadataRequestIntegrationIdEnum = exports.IntegrationMetadataPaymentUserRequestIntegrationIdEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FuturePaymentsMode = exports.FinverseErrorCategory = exports.FeePaidBy = exports.DisputeStatus = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentAccountRequestAccountTypeEnum = exports.CreateMandateRequestWithDdaReferenceStatusEnum = exports.CreateCardRequestStatusEnum = exports.CompleteKcpPaymentRequestCardPointUseEnum = exports.CardStatus = exports.CardFundingType = exports.BillStatus = exports.AutopayEnrollmentConfigurationEnrollmentPrefillValueEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = exports.AccountNumberType = void 0;
26
- exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.ListPayoutsPayoutTypesEnum = exports.ListPayoutsStatusesEnum = exports.ListPaymentsPaymentTypesEnum = exports.ListPaymentsPaymentTypeEnum = exports.ListPaymentsSenderTypeEnum = exports.ListPaymentsStatusesEnum = exports.ListPaymentAccountsWithEnrichedDataAccountTypeEnum = exports.ListMandatesSenderTypeEnum = exports.ListMandatesStatusesEnum = exports.ListDisputesStatusesEnum = exports.ListDetokenizedMandatesSenderTypeEnum = exports.ListDetokenizedMandatesStatusesEnum = exports.ListBillsStatusesEnum = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.GetBalanceHistorySourceEnum = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.TokenGrantTypeEnum = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.ListInstitutionsInstitutionTypeEnum = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.UpdateTestPaymentStatusRequestStatusEnum = exports.TransactionLimitsResponsePeriodEnum = exports.TransactionLimitsRequestPeriodEnum = exports.SenderDetailDetailsTypeEnum = exports.RefreshLoginIdentityLinkCustomizationsUiModeEnum = exports.RefreshLoginIdentityLinkCustomizationsLanguageEnum = exports.PayoutType = exports.PayoutStatus = exports.PaymentUserType = exports.PaymentType = exports.PaymentStatus = exports.PaymentScheduleFrequencyEnum = exports.PaymentMethodType = exports.PaymentMethodIntegrationMetadataGocardlessMetadataFundsSettlementEnum = void 0;
25
+ exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentLinkStatus = exports.PaymentLinkSessionStatus = exports.PaymentLinkMode = exports.PaymentLinkCustomizationsUiModeEnum = exports.PaymentLinkCustomizationsLanguageEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.PaymentAccountType = exports.MandateStatus = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.MandateAuthLinkCustomizationsLanguageEnum = exports.LoginMethodStatusEnum = exports.LoginIdentityStatus = exports.LoginIdentitySessionStatus = exports.LoginIdentityAuthStatus = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestLanguageEnum = exports.LinkTokenRequestUiModeEnum = exports.LineItemItemTypeEnum = exports.KcpVaMetadataVaReceiptGubnEnum = exports.IntegrationMetadataResponseIntegrationIdEnum = exports.IntegrationMetadataRequestIntegrationIdEnum = exports.IntegrationMetadataPaymentUserRequestIntegrationIdEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FuturePaymentsMode = exports.FinverseErrorCategory = exports.FeePaidBy = exports.DisputeStatus = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentAccountRequestAccountTypeEnum = exports.CreateMandateRequestWithDdaReferenceStatusEnum = exports.CreateCardRequestStatusEnum = exports.CompleteKcpPaymentRequestCardPointUseEnum = exports.CardStatus = exports.CardFundingType = exports.BillStatus = exports.AutopayEnrollmentConfigurationEnrollmentPrefillValueEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountNumberType = exports.AccountCategory = void 0;
26
+ exports.ListPayoutsPayoutTypesEnum = exports.ListPayoutsStatusesEnum = exports.ListPaymentsPaymentTypesEnum = exports.ListPaymentsPaymentTypeEnum = exports.ListPaymentsSenderTypeEnum = exports.ListPaymentsStatusesEnum = exports.ListPaymentAccountsWithEnrichedDataAccountTypeEnum = exports.ListMandatesSenderTypeEnum = exports.ListMandatesStatusesEnum = exports.ListDisputesStatusesEnum = exports.ListDetokenizedMandatesSenderTypeEnum = exports.ListDetokenizedMandatesStatusesEnum = exports.ListBillsStatusesEnum = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.GetBalanceHistorySourceEnum = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.TokenGrantTypeEnum = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.ListInstitutionsInstitutionTypeEnum = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.UpdateTestPaymentStatusRequestStatusEnum = exports.TransactionLimitsResponsePeriodEnum = exports.TransactionLimitsRequestPeriodEnum = exports.SenderDetailDetailsTypeEnum = exports.RefreshLoginIdentityLinkCustomizationsUiModeEnum = exports.RefreshLoginIdentityLinkCustomizationsLanguageEnum = exports.ProductHealthStatus = exports.PayoutType = exports.PayoutStatus = exports.PaymentUserType = exports.PaymentType = exports.PaymentStatus = exports.PaymentScheduleFrequencyEnum = exports.PaymentMethodType = exports.PaymentMethodIntegrationMetadataGocardlessMetadataFundsSettlementEnum = exports.PaymentMethodIntegrationMetadataGocardlessMetadataStatusEnum = exports.PaymentMethodIntegrationMetadataAdyenMetadataRecurringProcessingModelEnum = exports.PaymentMethodIntegrationMetadataIntegrationIdEnum = void 0;
27
+ exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = void 0;
27
28
  const axios_1 = require("axios");
28
29
  // Some imports not used depending on template conditions
29
30
  // @ts-ignore
@@ -31,20 +32,26 @@ const common_1 = require("./common");
31
32
  // @ts-ignore
32
33
  const base_1 = require("./base");
33
34
  /**
34
- * Type of account number. Possible values: LOCAL, IBAN
35
+ * Account category
35
36
  * @export
36
37
  * @enum {string}
37
38
  */
38
- exports.AccountNumberType = {
39
- Local: 'LOCAL',
40
- Iban: 'IBAN',
41
- };
42
- exports.AccountTypeTypeEnum = {
39
+ exports.AccountCategory = {
40
+ Unknown: 'UNKNOWN',
43
41
  Deposit: 'DEPOSIT',
44
42
  Card: 'CARD',
45
43
  Investment: 'INVESTMENT',
46
44
  Loan: 'LOAN',
47
- Unknown: 'UNKNOWN',
45
+ Other: 'OTHER',
46
+ };
47
+ /**
48
+ * Type of account number. Possible values: LOCAL, IBAN
49
+ * @export
50
+ * @enum {string}
51
+ */
52
+ exports.AccountNumberType = {
53
+ Local: 'LOCAL',
54
+ Iban: 'IBAN',
48
55
  };
49
56
  exports.AccountTypeSubtypeEnum = {
50
57
  Current: 'CURRENT',
@@ -246,6 +253,52 @@ exports.LinkTokenRequestAutomaticDataRefreshEnum = {
246
253
  Off: 'OFF',
247
254
  ForcedOn: 'FORCED_ON',
248
255
  };
256
+ /**
257
+ * Login identity authentication status
258
+ * @export
259
+ * @enum {string}
260
+ */
261
+ exports.LoginIdentityAuthStatus = {
262
+ Unknown: 'UNKNOWN',
263
+ Linking: 'LINKING',
264
+ Authenticating: 'AUTHENTICATING',
265
+ Authenticated: 'AUTHENTICATED',
266
+ AuthenticateFailed: 'AUTHENTICATE_FAILED',
267
+ AuthenticationTemporarilyUnavailableForInstitution: 'AUTHENTICATION_TEMPORARILY_UNAVAILABLE_FOR_INSTITUTION',
268
+ AuthenticationTooManyAttempts: 'AUTHENTICATION_TOO_MANY_ATTEMPTS',
269
+ };
270
+ /**
271
+ * Login identity session status
272
+ * @export
273
+ * @enum {string}
274
+ */
275
+ exports.LoginIdentitySessionStatus = {
276
+ Unknown: 'UNKNOWN',
277
+ InProgress: 'IN_PROGRESS',
278
+ Completed: 'COMPLETED',
279
+ Unlinked: 'UNLINKED',
280
+ };
281
+ /**
282
+ * Login identity status
283
+ * @export
284
+ * @enum {string}
285
+ */
286
+ exports.LoginIdentityStatus = {
287
+ Unknown: 'UNKNOWN',
288
+ Error: 'ERROR',
289
+ Linking: 'LINKING',
290
+ Authenticating: 'AUTHENTICATING',
291
+ ConnectionComplete: 'CONNECTION_COMPLETE',
292
+ ConnectionInProgress: 'CONNECTION_IN_PROGRESS',
293
+ DataRetrievalInProgress: 'DATA_RETRIEVAL_IN_PROGRESS',
294
+ DataAvailable: 'DATA_AVAILABLE',
295
+ DataRetrievalPartiallySuccessful: 'DATA_RETRIEVAL_PARTIALLY_SUCCESSFUL',
296
+ DataRetrievalComplete: 'DATA_RETRIEVAL_COMPLETE',
297
+ Refreshing: 'REFRESHING',
298
+ Unlinked: 'UNLINKED',
299
+ UnlinkSucceeded: 'UNLINK_SUCCEEDED',
300
+ UnlinkFailed: 'UNLINK_FAILED',
301
+ };
249
302
  exports.LoginMethodStatusEnum = {
250
303
  Supported: 'SUPPORTED',
251
304
  Alpha: 'ALPHA',
@@ -435,6 +488,21 @@ exports.PayoutType = {
435
488
  Settlement: 'SETTLEMENT',
436
489
  OnDemand: 'ON_DEMAND',
437
490
  };
491
+ /**
492
+ * Health status of a login identity product
493
+ * @export
494
+ * @enum {string}
495
+ */
496
+ exports.ProductHealthStatus = {
497
+ Unknown: 'UNKNOWN',
498
+ InProgress: 'IN_PROGRESS',
499
+ Success: 'SUCCESS',
500
+ Warning: 'WARNING',
501
+ Error: 'ERROR',
502
+ NotSupported: 'NOT_SUPPORTED',
503
+ NotAvailable: 'NOT_AVAILABLE',
504
+ TemporarilyUnavailableForInstitution: 'TEMPORARILY_UNAVAILABLE_FOR_INSTITUTION',
505
+ };
438
506
  exports.RefreshLoginIdentityLinkCustomizationsLanguageEnum = {
439
507
  En: 'en',
440
508
  Vi: 'vi',
@@ -29,6 +29,6 @@ export declare function getAccounts(): {
29
29
  };
30
30
  login_identity: {
31
31
  login_identity_id: string;
32
- status: string;
32
+ status: "DATA_RETRIEVAL_COMPLETE";
33
33
  };
34
34
  };
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getAccounts = getAccounts;
4
+ const api_1 = require("../../api");
4
5
  function getAccounts() {
5
6
  return {
6
7
  accounts: [
@@ -101,7 +102,7 @@ function getAccounts() {
101
102
  },
102
103
  login_identity: {
103
104
  login_identity_id: '01F7MP3J3H485QSDQC0FS15KE7',
104
- status: 'DATA_RETRIEVAL_COMPLETE',
105
+ status: api_1.LoginIdentityStatus.DataRetrievalComplete,
105
106
  },
106
107
  };
107
108
  }
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getBalanceHistory = getBalanceHistory;
4
+ const api_1 = require("../../api");
4
5
  const account_1 = require("./account");
5
6
  function getBalanceHistory() {
6
7
  var _a;
@@ -16,5 +17,6 @@ function getBalanceHistory() {
16
17
  ],
17
18
  institution: accountData.institution,
18
19
  login_identity: accountData.login_identity,
20
+ source: api_1.GetBalanceHistoryResponseSourceEnum.Institution,
19
21
  };
20
22
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@finverse/sdk-typescript",
3
- "version": "0.0.403",
3
+ "version": "0.0.404",
4
4
  "description": "OpenAPI client for @finverse/sdk-typescript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {