@spritz-finance/api-client 0.8.1 → 0.8.2
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/spritz-api-client.d.ts +79 -29
- package/package.json +1 -1
|
@@ -2773,7 +2773,7 @@ interface operations {
|
|
|
2773
2773
|
"application/json": {
|
|
2774
2774
|
/**
|
|
2775
2775
|
* @description Destination account ID
|
|
2776
|
-
* @example
|
|
2776
|
+
* @example 6a073b8fc31db9dffe9cd278
|
|
2777
2777
|
*/
|
|
2778
2778
|
accountId: string;
|
|
2779
2779
|
/**
|
|
@@ -2801,7 +2801,7 @@ interface operations {
|
|
|
2801
2801
|
"application/x-www-form-urlencoded": {
|
|
2802
2802
|
/**
|
|
2803
2803
|
* @description Destination account ID
|
|
2804
|
-
* @example
|
|
2804
|
+
* @example 6a073b8fc31db9dffe9cd278
|
|
2805
2805
|
*/
|
|
2806
2806
|
accountId: string;
|
|
2807
2807
|
/**
|
|
@@ -2829,7 +2829,7 @@ interface operations {
|
|
|
2829
2829
|
"multipart/form-data": {
|
|
2830
2830
|
/**
|
|
2831
2831
|
* @description Destination account ID
|
|
2832
|
-
* @example
|
|
2832
|
+
* @example 6a073b8fc31db9dffe9cd278
|
|
2833
2833
|
*/
|
|
2834
2834
|
accountId: string;
|
|
2835
2835
|
/**
|
|
@@ -2876,7 +2876,7 @@ interface operations {
|
|
|
2876
2876
|
/**
|
|
2877
2877
|
* Format: date-time
|
|
2878
2878
|
* @description When the quote was created
|
|
2879
|
-
* @example 2026-05-
|
|
2879
|
+
* @example 2026-05-15T15:28:15.636Z
|
|
2880
2880
|
*/
|
|
2881
2881
|
createdAt: string;
|
|
2882
2882
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -2915,7 +2915,7 @@ interface operations {
|
|
|
2915
2915
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
2916
2916
|
/**
|
|
2917
2917
|
* @description Destination account ID
|
|
2918
|
-
* @example
|
|
2918
|
+
* @example 6a073b8fc31db9dffe9cd279
|
|
2919
2919
|
*/
|
|
2920
2920
|
accountId: string;
|
|
2921
2921
|
};
|
|
@@ -3122,7 +3122,7 @@ interface operations {
|
|
|
3122
3122
|
/**
|
|
3123
3123
|
* Format: date-time
|
|
3124
3124
|
* @description When the quote was created
|
|
3125
|
-
* @example 2026-05-
|
|
3125
|
+
* @example 2026-05-15T15:28:15.636Z
|
|
3126
3126
|
*/
|
|
3127
3127
|
createdAt: string;
|
|
3128
3128
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -3161,7 +3161,7 @@ interface operations {
|
|
|
3161
3161
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
3162
3162
|
/**
|
|
3163
3163
|
* @description Destination account ID
|
|
3164
|
-
* @example
|
|
3164
|
+
* @example 6a073b8fc31db9dffe9cd279
|
|
3165
3165
|
*/
|
|
3166
3166
|
accountId: string;
|
|
3167
3167
|
};
|
|
@@ -3658,7 +3658,7 @@ interface operations {
|
|
|
3658
3658
|
currency: string;
|
|
3659
3659
|
/**
|
|
3660
3660
|
* @description Destination account ID
|
|
3661
|
-
* @example
|
|
3661
|
+
* @example 6a073b8fc31db9dffe9cd27a
|
|
3662
3662
|
*/
|
|
3663
3663
|
accountId: string;
|
|
3664
3664
|
accountName: (string | null) | null;
|
|
@@ -3874,7 +3874,7 @@ interface operations {
|
|
|
3874
3874
|
currency: string;
|
|
3875
3875
|
/**
|
|
3876
3876
|
* @description Destination account ID
|
|
3877
|
-
* @example
|
|
3877
|
+
* @example 6a073b8fc31db9dffe9cd27a
|
|
3878
3878
|
*/
|
|
3879
3879
|
accountId: string;
|
|
3880
3880
|
accountName: (string | null) | null;
|
|
@@ -7083,11 +7083,31 @@ interface operations {
|
|
|
7083
7083
|
*/
|
|
7084
7084
|
bankAccountId: string;
|
|
7085
7085
|
/**
|
|
7086
|
-
* @description Institution name used for funding source display
|
|
7086
|
+
* @description Institution name used for funding source display. Prefer `institution.name` when present; this field will be removed in a future release.
|
|
7087
7087
|
* @example Plaid Test Bank
|
|
7088
7088
|
* @example null
|
|
7089
7089
|
*/
|
|
7090
7090
|
institutionName: string | null;
|
|
7091
|
+
/** @description Branding metadata for the institution backing the funding source, or null when no institution data is available. */
|
|
7092
|
+
institution: {
|
|
7093
|
+
/**
|
|
7094
|
+
* @description Display name for the institution
|
|
7095
|
+
* @example Chase
|
|
7096
|
+
*/
|
|
7097
|
+
name: string;
|
|
7098
|
+
/**
|
|
7099
|
+
* @description Absolute URL to the institution's logo (PNG). Null when the institution has no logo on file.
|
|
7100
|
+
* @example https://assets.platform.spritz.finance/institutions/ins_109508.png
|
|
7101
|
+
* @example null
|
|
7102
|
+
*/
|
|
7103
|
+
logoUrl: string | null;
|
|
7104
|
+
/**
|
|
7105
|
+
* @description Hex color (e.g. `#1e88e5`) representing the institution's brand. Null when unavailable.
|
|
7106
|
+
* @example #1e88e5
|
|
7107
|
+
* @example null
|
|
7108
|
+
*/
|
|
7109
|
+
primaryColor: string | null;
|
|
7110
|
+
} | null;
|
|
7091
7111
|
/**
|
|
7092
7112
|
* @description Last 4 digits of the linked bank account number
|
|
7093
7113
|
* @example 6789
|
|
@@ -7446,11 +7466,31 @@ interface operations {
|
|
|
7446
7466
|
*/
|
|
7447
7467
|
bankAccountId: string;
|
|
7448
7468
|
/**
|
|
7449
|
-
* @description Institution name used for funding source display
|
|
7469
|
+
* @description Institution name used for funding source display. Prefer `institution.name` when present; this field will be removed in a future release.
|
|
7450
7470
|
* @example Plaid Test Bank
|
|
7451
7471
|
* @example null
|
|
7452
7472
|
*/
|
|
7453
7473
|
institutionName: string | null;
|
|
7474
|
+
/** @description Branding metadata for the institution backing the funding source, or null when no institution data is available. */
|
|
7475
|
+
institution: {
|
|
7476
|
+
/**
|
|
7477
|
+
* @description Display name for the institution
|
|
7478
|
+
* @example Chase
|
|
7479
|
+
*/
|
|
7480
|
+
name: string;
|
|
7481
|
+
/**
|
|
7482
|
+
* @description Absolute URL to the institution's logo (PNG). Null when the institution has no logo on file.
|
|
7483
|
+
* @example https://assets.platform.spritz.finance/institutions/ins_109508.png
|
|
7484
|
+
* @example null
|
|
7485
|
+
*/
|
|
7486
|
+
logoUrl: string | null;
|
|
7487
|
+
/**
|
|
7488
|
+
* @description Hex color (e.g. `#1e88e5`) representing the institution's brand. Null when unavailable.
|
|
7489
|
+
* @example #1e88e5
|
|
7490
|
+
* @example null
|
|
7491
|
+
*/
|
|
7492
|
+
primaryColor: string | null;
|
|
7493
|
+
} | null;
|
|
7454
7494
|
/**
|
|
7455
7495
|
* @description Last 4 digits of the linked bank account number
|
|
7456
7496
|
* @example 6789
|
|
@@ -8171,7 +8211,7 @@ interface operations {
|
|
|
8171
8211
|
content: {
|
|
8172
8212
|
"application/json": {
|
|
8173
8213
|
/**
|
|
8174
|
-
* @description Plaid OAuth
|
|
8214
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8175
8215
|
* @example https://app.example.com/plaid/oauth-return
|
|
8176
8216
|
* @example com.example.app
|
|
8177
8217
|
*/
|
|
@@ -8179,7 +8219,7 @@ interface operations {
|
|
|
8179
8219
|
} | Record<string, never>;
|
|
8180
8220
|
"application/x-www-form-urlencoded": {
|
|
8181
8221
|
/**
|
|
8182
|
-
* @description Plaid OAuth
|
|
8222
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8183
8223
|
* @example https://app.example.com/plaid/oauth-return
|
|
8184
8224
|
* @example com.example.app
|
|
8185
8225
|
*/
|
|
@@ -8187,7 +8227,7 @@ interface operations {
|
|
|
8187
8227
|
} | Record<string, never>;
|
|
8188
8228
|
"multipart/form-data": {
|
|
8189
8229
|
/**
|
|
8190
|
-
* @description Plaid OAuth
|
|
8230
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8191
8231
|
* @example https://app.example.com/plaid/oauth-return
|
|
8192
8232
|
* @example com.example.app
|
|
8193
8233
|
*/
|
|
@@ -11598,7 +11638,7 @@ interface operations {
|
|
|
11598
11638
|
accessToken: string;
|
|
11599
11639
|
/**
|
|
11600
11640
|
* @description The internal ID of the authorized user
|
|
11601
|
-
* @example
|
|
11641
|
+
* @example 6a073b8fc31db9dffe9cd282
|
|
11602
11642
|
*/
|
|
11603
11643
|
userId: string;
|
|
11604
11644
|
/**
|
|
@@ -11614,7 +11654,7 @@ interface operations {
|
|
|
11614
11654
|
/**
|
|
11615
11655
|
* Format: date-time
|
|
11616
11656
|
* @description ISO 8601 timestamp when token expires
|
|
11617
|
-
* @example 2026-05-
|
|
11657
|
+
* @example 2026-05-15T16:28:15.737Z
|
|
11618
11658
|
*/
|
|
11619
11659
|
expiresAt: string;
|
|
11620
11660
|
};
|
|
@@ -11789,7 +11829,7 @@ interface operations {
|
|
|
11789
11829
|
/**
|
|
11790
11830
|
* Format: date-time
|
|
11791
11831
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
11792
|
-
* @example 2026-05-
|
|
11832
|
+
* @example 2026-05-15T15:28:15.737Z
|
|
11793
11833
|
*/
|
|
11794
11834
|
createdAt: string;
|
|
11795
11835
|
};
|
|
@@ -11960,7 +12000,7 @@ interface operations {
|
|
|
11960
12000
|
depositId: string;
|
|
11961
12001
|
/**
|
|
11962
12002
|
* @description Spritz user ID associated with the returned deposit
|
|
11963
|
-
* @example
|
|
12003
|
+
* @example 6a073b8fc31db9dffe9cd281
|
|
11964
12004
|
*/
|
|
11965
12005
|
userId: string;
|
|
11966
12006
|
/**
|
|
@@ -12148,7 +12188,7 @@ interface operations {
|
|
|
12148
12188
|
depositId: string;
|
|
12149
12189
|
/**
|
|
12150
12190
|
* @description Spritz user ID associated with the returned deposit
|
|
12151
|
-
* @example
|
|
12191
|
+
* @example 6a073b8fc31db9dffe9cd281
|
|
12152
12192
|
*/
|
|
12153
12193
|
userId: string;
|
|
12154
12194
|
/**
|
|
@@ -12317,7 +12357,7 @@ interface operations {
|
|
|
12317
12357
|
"application/json": {
|
|
12318
12358
|
/**
|
|
12319
12359
|
* @description Unique identifier for the webhook
|
|
12320
|
-
* @example
|
|
12360
|
+
* @example 6a073b8fc31db9dffe9cd283
|
|
12321
12361
|
*/
|
|
12322
12362
|
id: string;
|
|
12323
12363
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -12524,7 +12564,7 @@ interface operations {
|
|
|
12524
12564
|
"application/json": {
|
|
12525
12565
|
/**
|
|
12526
12566
|
* @description Unique identifier for the webhook
|
|
12527
|
-
* @example
|
|
12567
|
+
* @example 6a073b8fc31db9dffe9cd283
|
|
12528
12568
|
*/
|
|
12529
12569
|
id: string;
|
|
12530
12570
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -12860,7 +12900,7 @@ interface operations {
|
|
|
12860
12900
|
"application/json": {
|
|
12861
12901
|
/**
|
|
12862
12902
|
* @description Unique identifier for the webhook
|
|
12863
|
-
* @example
|
|
12903
|
+
* @example 6a073b8fc31db9dffe9cd283
|
|
12864
12904
|
*/
|
|
12865
12905
|
id: string;
|
|
12866
12906
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -13235,7 +13275,7 @@ interface operations {
|
|
|
13235
13275
|
/**
|
|
13236
13276
|
* Format: date-time
|
|
13237
13277
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
13238
|
-
* @example 2026-05-
|
|
13278
|
+
* @example 2026-05-15T15:33:15.737Z
|
|
13239
13279
|
*/
|
|
13240
13280
|
oldSecretExpiresAt?: string;
|
|
13241
13281
|
};
|
|
@@ -13382,7 +13422,7 @@ interface operations {
|
|
|
13382
13422
|
"application/json": {
|
|
13383
13423
|
/**
|
|
13384
13424
|
* @description Unique identifier for the user
|
|
13385
|
-
* @example
|
|
13425
|
+
* @example 6a073b8fc31db9dffe9cd27f
|
|
13386
13426
|
*/
|
|
13387
13427
|
id: string;
|
|
13388
13428
|
email: (string | null) | null;
|
|
@@ -13390,7 +13430,7 @@ interface operations {
|
|
|
13390
13430
|
/**
|
|
13391
13431
|
* Format: date-time
|
|
13392
13432
|
* @description ISO 8601 timestamp of when the user was created
|
|
13393
|
-
* @example 2026-05-
|
|
13433
|
+
* @example 2026-05-15T15:28:15.732Z
|
|
13394
13434
|
*/
|
|
13395
13435
|
signedUpAt: string;
|
|
13396
13436
|
timezone: (string | null) | null;
|
|
@@ -13720,7 +13760,7 @@ interface operations {
|
|
|
13720
13760
|
"application/json": {
|
|
13721
13761
|
/**
|
|
13722
13762
|
* @description Unique identifier for the user
|
|
13723
|
-
* @example
|
|
13763
|
+
* @example 6a073b8fc31db9dffe9cd27f
|
|
13724
13764
|
*/
|
|
13725
13765
|
id: string;
|
|
13726
13766
|
email: (string | null) | null;
|
|
@@ -13728,7 +13768,7 @@ interface operations {
|
|
|
13728
13768
|
/**
|
|
13729
13769
|
* Format: date-time
|
|
13730
13770
|
* @description ISO 8601 timestamp of when the user was created
|
|
13731
|
-
* @example 2026-05-
|
|
13771
|
+
* @example 2026-05-15T15:28:15.732Z
|
|
13732
13772
|
*/
|
|
13733
13773
|
signedUpAt: string;
|
|
13734
13774
|
timezone: (string | null) | null;
|
|
@@ -14130,7 +14170,7 @@ interface operations {
|
|
|
14130
14170
|
"application/json": {
|
|
14131
14171
|
/**
|
|
14132
14172
|
* @description Unique identifier for the user
|
|
14133
|
-
* @example
|
|
14173
|
+
* @example 6a073b8fc31db9dffe9cd27f
|
|
14134
14174
|
*/
|
|
14135
14175
|
id: string;
|
|
14136
14176
|
email: (string | null) | null;
|
|
@@ -14138,7 +14178,7 @@ interface operations {
|
|
|
14138
14178
|
/**
|
|
14139
14179
|
* Format: date-time
|
|
14140
14180
|
* @description ISO 8601 timestamp of when the user was created
|
|
14141
|
-
* @example 2026-05-
|
|
14181
|
+
* @example 2026-05-15T15:28:15.732Z
|
|
14142
14182
|
*/
|
|
14143
14183
|
signedUpAt: string;
|
|
14144
14184
|
timezone: (string | null) | null;
|
|
@@ -23815,6 +23855,11 @@ declare class FundingSourceService {
|
|
|
23815
23855
|
id: string;
|
|
23816
23856
|
bankAccountId: string;
|
|
23817
23857
|
institutionName: string | null;
|
|
23858
|
+
institution: {
|
|
23859
|
+
name: string;
|
|
23860
|
+
logoUrl: string | null;
|
|
23861
|
+
primaryColor: string | null;
|
|
23862
|
+
} | null;
|
|
23818
23863
|
accountNumberLast4: string | null;
|
|
23819
23864
|
accountType: "checking" | "savings" | "business" | "unknown";
|
|
23820
23865
|
status: "pending" | "active" | "review_required" | "ineligible" | "disabled";
|
|
@@ -23826,6 +23871,11 @@ declare class FundingSourceService {
|
|
|
23826
23871
|
id: string;
|
|
23827
23872
|
bankAccountId: string;
|
|
23828
23873
|
institutionName: string | null;
|
|
23874
|
+
institution: {
|
|
23875
|
+
name: string;
|
|
23876
|
+
logoUrl: string | null;
|
|
23877
|
+
primaryColor: string | null;
|
|
23878
|
+
} | null;
|
|
23829
23879
|
accountNumberLast4: string | null;
|
|
23830
23880
|
accountType: "checking" | "savings" | "business" | "unknown";
|
|
23831
23881
|
status: "pending" | "active" | "review_required" | "ineligible" | "disabled";
|