@distyra/sdk 0.3.0 → 0.5.0

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.
Files changed (2) hide show
  1. package/dist/generated.d.ts +1410 -96
  2. package/package.json +1 -1
@@ -34,7 +34,7 @@ export interface paths {
34
34
  put?: never;
35
35
  /**
36
36
  * Enrich a single transaction
37
- * @description Single-transaction enrichment. Resolution flow: normalize, then cache, catalog match, classifier, and LLM fallback. Returns the full response shape with an `availability` block; fields not yet available (logos, location, subscription/recurring detection) are returned as `null`/`false` and flagged as unavailable. Confidence values are uncalibrated similarity scores.
37
+ * @description Single-transaction enrichment. Resolution flow: normalize, then cache, catalog match, classifier, and LLM fallback. Returns the full response shape with an `availability` block; fields not yet available (logos, location, subscription) are returned as `null`/`false` and flagged. `metadata.is_subscription` is a merchant-category hint, not per-transaction recurrence,as unavailable. Confidence values are uncalibrated similarity scores.
38
38
  */
39
39
  post: operations["enrichSingle"];
40
40
  delete?: never;
@@ -548,6 +548,56 @@ export interface paths {
548
548
  patch?: never;
549
549
  trace?: never;
550
550
  };
551
+ "/v1/billing/invoices/{id}/pdf": {
552
+ parameters: {
553
+ query?: never;
554
+ header?: never;
555
+ path?: never;
556
+ cookie?: never;
557
+ };
558
+ /**
559
+ * Download an invoice or credit-note PDF
560
+ * @description Streams the stored PDF for one of the organization's invoices or credit notes.
561
+ *
562
+ * **404** for an unknown id (RLS-scoped to your org). **410** if the PDF has not been generated/stored yet.
563
+ *
564
+ * Required scope: `enrichment:read`.
565
+ */
566
+ get: operations["getBillingInvoicePdf"];
567
+ put?: never;
568
+ post?: never;
569
+ delete?: never;
570
+ options?: never;
571
+ head?: never;
572
+ patch?: never;
573
+ trace?: never;
574
+ };
575
+ "/v1/billing/payments/{paymentId}": {
576
+ parameters: {
577
+ query?: never;
578
+ header?: never;
579
+ path?: never;
580
+ cookie?: never;
581
+ };
582
+ /**
583
+ * Live Mollie state for one of the org’s payments
584
+ * @description Returns a reconciliation projection of the Mollie payment behind a ledger
585
+ * entry or invoice: status, method, settlement, refund/chargeback totals, and
586
+ * the payment's own dashboard deep-link. First-party only (service principal).
587
+ *
588
+ * **404** if the payment id is not one of this org’s payments.
589
+ *
590
+ * Required scope: `enrichment:read`.
591
+ */
592
+ get: operations["getBillingPayment"];
593
+ put?: never;
594
+ post?: never;
595
+ delete?: never;
596
+ options?: never;
597
+ head?: never;
598
+ patch?: never;
599
+ trace?: never;
600
+ };
551
601
  "/v1/enrich/batch/async": {
552
602
  parameters: {
553
603
  query?: never;
@@ -730,6 +780,110 @@ export interface paths {
730
780
  patch?: never;
731
781
  trace?: never;
732
782
  };
783
+ "/v1/connect/aspsps": {
784
+ parameters: {
785
+ query?: never;
786
+ header?: never;
787
+ path?: never;
788
+ cookie?: never;
789
+ };
790
+ /** List banks (ASPSPs) available for a country */
791
+ get: operations["listAspsps"];
792
+ put?: never;
793
+ post?: never;
794
+ delete?: never;
795
+ options?: never;
796
+ head?: never;
797
+ patch?: never;
798
+ trace?: never;
799
+ };
800
+ "/v1/connect/connections": {
801
+ parameters: {
802
+ query?: never;
803
+ header?: never;
804
+ path?: never;
805
+ cookie?: never;
806
+ };
807
+ /** List your bank connections */
808
+ get: operations["listConnections"];
809
+ put?: never;
810
+ /** Open a bank connection (returns the authorization URL) */
811
+ post: operations["createConnection"];
812
+ delete?: never;
813
+ options?: never;
814
+ head?: never;
815
+ patch?: never;
816
+ trace?: never;
817
+ };
818
+ "/v1/connect/connections/{id}": {
819
+ parameters: {
820
+ query?: never;
821
+ header?: never;
822
+ path?: never;
823
+ cookie?: never;
824
+ };
825
+ /** Read a bank connection */
826
+ get: operations["getConnection"];
827
+ put?: never;
828
+ post?: never;
829
+ /** Revoke a bank connection */
830
+ delete: operations["revokeConnection"];
831
+ options?: never;
832
+ head?: never;
833
+ patch?: never;
834
+ trace?: never;
835
+ };
836
+ "/v1/connect/connections/{id}/accounts": {
837
+ parameters: {
838
+ query?: never;
839
+ header?: never;
840
+ path?: never;
841
+ cookie?: never;
842
+ };
843
+ /** List the accounts on a connection */
844
+ get: operations["getConnectionAccounts"];
845
+ put?: never;
846
+ post?: never;
847
+ delete?: never;
848
+ options?: never;
849
+ head?: never;
850
+ patch?: never;
851
+ trace?: never;
852
+ };
853
+ "/v1/connect/connections/{id}/transactions": {
854
+ parameters: {
855
+ query?: never;
856
+ header?: never;
857
+ path?: never;
858
+ cookie?: never;
859
+ };
860
+ /** Fetch normalized transactions for a connection */
861
+ get: operations["getConnectionTransactions"];
862
+ put?: never;
863
+ post?: never;
864
+ delete?: never;
865
+ options?: never;
866
+ head?: never;
867
+ patch?: never;
868
+ trace?: never;
869
+ };
870
+ "/v1/connect/hosted-link": {
871
+ parameters: {
872
+ query?: never;
873
+ header?: never;
874
+ path?: never;
875
+ cookie?: never;
876
+ };
877
+ get?: never;
878
+ put?: never;
879
+ /** Mint a hosted bank-connect link for an applicant */
880
+ post: operations["createHostedConnectLink"];
881
+ delete?: never;
882
+ options?: never;
883
+ head?: never;
884
+ patch?: never;
885
+ trace?: never;
886
+ };
733
887
  "/v1/internal/crawl/re-enqueue": {
734
888
  parameters: {
735
889
  query?: never;
@@ -887,6 +1041,16 @@ export interface operations {
887
1041
  * @example true
888
1042
  */
889
1043
  cache_only?: "true" | "false";
1044
+ /**
1045
+ * @description When `true` and the request mints a brand-new (cold) merchant, block up to `wait_timeout_ms` for the background logo crawl to finish, then return the real logo instead of `logo_url: null`. No effect for already-known merchants (no new crawl fires). On timeout, returns the normal async response (which carries the low-quality favicon floor when one is available).
1046
+ * @example true
1047
+ */
1048
+ wait_for_crawl?: "true" | "false";
1049
+ /**
1050
+ * @description Upper bound in milliseconds for `wait_for_crawl` (default 8000, max 15000). Ignored unless `wait_for_crawl=true`.
1051
+ * @example 8000
1052
+ */
1053
+ wait_timeout_ms?: string;
890
1054
  };
891
1055
  header?: never;
892
1056
  path?: never;
@@ -946,9 +1110,11 @@ export interface operations {
946
1110
  * @example {
947
1111
  * "merchant": {
948
1112
  * "name": "Albert Heijn",
949
- * "parent": null,
1113
+ * "parent": "Ahold Delhaize",
1114
+ * "parent_catalog_id": 9001,
950
1115
  * "domain": "ah.nl",
951
1116
  * "logo_url": "https://cdn.distyra.com/saas/142/a3f2b9e7d4c1f8a0/v1/light.png?token=…&expires=…",
1117
+ * "logo_quality_score": 0.8,
952
1118
  * "brand_colors": {
953
1119
  * "primary": "#0FAEEF"
954
1120
  * },
@@ -973,7 +1139,6 @@ export interface operations {
973
1139
  * "is_subscription": false,
974
1140
  * "is_marketplace": false,
975
1141
  * "facilitator": null,
976
- * "is_recurring_candidate": false,
977
1142
  * "transaction_type": "merchant_payment",
978
1143
  * "is_transfer": false,
979
1144
  * "is_bank_internal": false,
@@ -995,8 +1160,7 @@ export interface operations {
995
1160
  * "transaction_type": true,
996
1161
  * "logos": false,
997
1162
  * "location": false,
998
- * "subscription_detection": false,
999
- * "recurring_detection": false
1163
+ * "subscription_detection": false
1000
1164
  * },
1001
1165
  * "livemode": true
1002
1166
  * }
@@ -1005,8 +1169,10 @@ export interface operations {
1005
1169
  merchant: {
1006
1170
  name: string | null;
1007
1171
  parent: string | null;
1172
+ parent_catalog_id: number | null;
1008
1173
  domain: string | null;
1009
1174
  logo_url: string | null;
1175
+ logo_quality_score: number | null;
1010
1176
  brand_colors: {
1011
1177
  [key: string]: unknown;
1012
1178
  };
@@ -1031,10 +1197,10 @@ export interface operations {
1031
1197
  country: string | null;
1032
1198
  };
1033
1199
  metadata: {
1200
+ /** @description Merchant-category hint: true when the resolved merchant predominantly bills on subscription (streaming, SaaS, telco, gym, insurance). This reflects the MERCHANT, not this transaction — a single charge at a subscription merchant may still be a one-off. True only for conservatively curated brands; false also means "not flagged / unknown". Per-account recurrence detection needs the transaction series and lives in the banking/iOS layer, not this stateless API. */
1034
1201
  is_subscription: boolean;
1035
1202
  is_marketplace: boolean;
1036
1203
  facilitator: string | null;
1037
- is_recurring_candidate: boolean;
1038
1204
  transaction_type: string | null;
1039
1205
  is_transfer: boolean;
1040
1206
  is_bank_internal: boolean;
@@ -1061,7 +1227,6 @@ export interface operations {
1061
1227
  logos: boolean;
1062
1228
  location: boolean;
1063
1229
  subscription_detection: boolean;
1064
- recurring_detection: boolean;
1065
1230
  };
1066
1231
  /** @description true when served to a live key; false when served to a test-mode (sk_test_) key. Test-mode responses run the full cascade but carry no billing or quota impact. */
1067
1232
  livemode: boolean;
@@ -1173,6 +1338,16 @@ export interface operations {
1173
1338
  * @example true
1174
1339
  */
1175
1340
  cache_only?: "true" | "false";
1341
+ /**
1342
+ * @description When `true` and the request mints a brand-new (cold) merchant, block up to `wait_timeout_ms` for the background logo crawl to finish, then return the real logo instead of `logo_url: null`. No effect for already-known merchants (no new crawl fires). On timeout, returns the normal async response (which carries the low-quality favicon floor when one is available).
1343
+ * @example true
1344
+ */
1345
+ wait_for_crawl?: "true" | "false";
1346
+ /**
1347
+ * @description Upper bound in milliseconds for `wait_for_crawl` (default 8000, max 15000). Ignored unless `wait_for_crawl=true`.
1348
+ * @example 8000
1349
+ */
1350
+ wait_timeout_ms?: string;
1176
1351
  };
1177
1352
  header?: never;
1178
1353
  path?: never;
@@ -3126,6 +3301,11 @@ export interface operations {
3126
3301
  /** Format: uuid */
3127
3302
  id: string;
3128
3303
  applicant_id: string;
3304
+ /**
3305
+ * @description The lender's own reference for Distyra Connect analyses, joined from the originating connection. For connect-originated analyses `applicant_id` is the connection id (the data-source identity used for idempotency), and this is the human reference the lender set on the connection. null for direct JSON /analyze submissions, where the lender's reference is already `applicant_id`.
3306
+ * @example loan_app_42
3307
+ */
3308
+ applicant_ref: string | null;
3129
3309
  /** Format: date-time */
3130
3310
  created_at: string;
3131
3311
  /** @description false for 7-day idempotent re-pulls and for calls within the included-quota tier. */
@@ -4643,65 +4823,24 @@ export interface operations {
4643
4823
  };
4644
4824
  };
4645
4825
  };
4646
- enrichBatchAsync: {
4826
+ getBillingInvoicePdf: {
4647
4827
  parameters: {
4648
4828
  query?: never;
4649
4829
  header?: never;
4650
- path?: never;
4651
- cookie?: never;
4652
- };
4653
- requestBody: {
4654
- content: {
4655
- "application/json": {
4656
- items: {
4657
- descriptor: string;
4658
- amount?: number;
4659
- currency?: string;
4660
- mcc?: string;
4661
- country_hint?: string;
4662
- merchant_name?: string;
4663
- bank_code_description?: string;
4664
- }[];
4665
- };
4830
+ path: {
4831
+ id: string;
4666
4832
  };
4833
+ cookie?: never;
4667
4834
  };
4835
+ requestBody?: never;
4668
4836
  responses: {
4669
4837
  /** @description Default Response */
4670
- 202: {
4671
- headers: {
4672
- [name: string]: unknown;
4673
- };
4674
- content: {
4675
- "application/json": {
4676
- /** Format: uuid */
4677
- id: string;
4678
- /** @enum {string} */
4679
- status: "pending";
4680
- item_count: number;
4681
- /** Format: date-time */
4682
- submitted_at: string;
4683
- /** Format: date-time */
4684
- expires_at: string;
4685
- /** Format: uri */
4686
- status_url: string;
4687
- };
4688
- };
4689
- };
4690
- /** @description Standard error envelope used for all non-2xx responses. */
4691
- 400: {
4838
+ 200: {
4692
4839
  headers: {
4693
4840
  [name: string]: unknown;
4694
4841
  };
4695
4842
  content: {
4696
- "application/json": {
4697
- /**
4698
- * @description Stable machine-readable code. SDK consumers should switch on this.
4699
- * @example invalid_key
4700
- */
4701
- error: string;
4702
- /** @description Free-form human-readable explanation. Safe to surface. */
4703
- detail?: string;
4704
- };
4843
+ "application/pdf": unknown;
4705
4844
  };
4706
4845
  };
4707
4846
  /** @description Standard error envelope used for all non-2xx responses. */
@@ -4710,7 +4849,7 @@ export interface operations {
4710
4849
  [name: string]: unknown;
4711
4850
  };
4712
4851
  content: {
4713
- "application/json": {
4852
+ "application/pdf": {
4714
4853
  /**
4715
4854
  * @description Stable machine-readable code. SDK consumers should switch on this.
4716
4855
  * @example invalid_key
@@ -4722,12 +4861,12 @@ export interface operations {
4722
4861
  };
4723
4862
  };
4724
4863
  /** @description Standard error envelope used for all non-2xx responses. */
4725
- 402: {
4864
+ 403: {
4726
4865
  headers: {
4727
4866
  [name: string]: unknown;
4728
4867
  };
4729
4868
  content: {
4730
- "application/json": {
4869
+ "application/pdf": {
4731
4870
  /**
4732
4871
  * @description Stable machine-readable code. SDK consumers should switch on this.
4733
4872
  * @example invalid_key
@@ -4739,12 +4878,12 @@ export interface operations {
4739
4878
  };
4740
4879
  };
4741
4880
  /** @description Standard error envelope used for all non-2xx responses. */
4742
- 403: {
4881
+ 404: {
4743
4882
  headers: {
4744
4883
  [name: string]: unknown;
4745
4884
  };
4746
4885
  content: {
4747
- "application/json": {
4886
+ "application/pdf": {
4748
4887
  /**
4749
4888
  * @description Stable machine-readable code. SDK consumers should switch on this.
4750
4889
  * @example invalid_key
@@ -4756,12 +4895,12 @@ export interface operations {
4756
4895
  };
4757
4896
  };
4758
4897
  /** @description Standard error envelope used for all non-2xx responses. */
4759
- 429: {
4898
+ 410: {
4760
4899
  headers: {
4761
4900
  [name: string]: unknown;
4762
4901
  };
4763
4902
  content: {
4764
- "application/json": {
4903
+ "application/pdf": {
4765
4904
  /**
4766
4905
  * @description Stable machine-readable code. SDK consumers should switch on this.
4767
4906
  * @example invalid_key
@@ -4774,12 +4913,12 @@ export interface operations {
4774
4913
  };
4775
4914
  };
4776
4915
  };
4777
- enrichBatchAsyncStatus: {
4916
+ getBillingPayment: {
4778
4917
  parameters: {
4779
4918
  query?: never;
4780
4919
  header?: never;
4781
4920
  path: {
4782
- id: string;
4921
+ paymentId: string;
4783
4922
  };
4784
4923
  cookie?: never;
4785
4924
  };
@@ -4792,22 +4931,31 @@ export interface operations {
4792
4931
  };
4793
4932
  content: {
4794
4933
  "application/json": {
4795
- /** Format: uuid */
4796
4934
  id: string;
4797
- status: "pending" | "running" | "completed" | "failed" | "expired";
4798
- item_count: number;
4799
- completed_count: number;
4800
- failed_count: number;
4801
- /** Format: date-time */
4802
- submitted_at: string;
4803
- started_at: string | null;
4804
- completed_at: string | null;
4805
- /** Format: date-time */
4806
- expires_at: string;
4807
- result: {
4808
- [key: string]: unknown;
4809
- }[] | null;
4810
- error: string | null;
4935
+ status: string;
4936
+ method: string | null;
4937
+ sequenceType: string | null;
4938
+ amount: {
4939
+ value: string;
4940
+ currency: string;
4941
+ };
4942
+ settlementAmount: {
4943
+ value: string;
4944
+ currency: string;
4945
+ } | null;
4946
+ amountRefunded: {
4947
+ value: string;
4948
+ currency: string;
4949
+ } | null;
4950
+ amountChargedBack: {
4951
+ value: string;
4952
+ currency: string;
4953
+ } | null;
4954
+ isRefunded: boolean;
4955
+ isChargedBack: boolean;
4956
+ createdAt: string | null;
4957
+ paidAt: string | null;
4958
+ dashboardUrl: string | null;
4811
4959
  };
4812
4960
  };
4813
4961
  };
@@ -4862,28 +5010,283 @@ export interface operations {
4862
5010
  };
4863
5011
  };
4864
5012
  };
4865
- };
4866
- };
4867
- getMerchant: {
4868
- parameters: {
4869
- query?: never;
4870
- header?: never;
4871
- path: {
4872
- /** @description Catalog id (positive integer, accepted as a path string). */
4873
- id: string;
5013
+ /** @description Standard error envelope used for all non-2xx responses. */
5014
+ 502: {
5015
+ headers: {
5016
+ [name: string]: unknown;
5017
+ };
5018
+ content: {
5019
+ "application/json": {
5020
+ /**
5021
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5022
+ * @example invalid_key
5023
+ */
5024
+ error: string;
5025
+ /** @description Free-form human-readable explanation. Safe to surface. */
5026
+ detail?: string;
5027
+ };
5028
+ };
4874
5029
  };
4875
- cookie?: never;
4876
- };
4877
- requestBody?: never;
4878
- responses: {
4879
- /** @description Default Response */
4880
- 200: {
5030
+ /** @description Standard error envelope used for all non-2xx responses. */
5031
+ 503: {
4881
5032
  headers: {
4882
5033
  [name: string]: unknown;
4883
5034
  };
4884
5035
  content: {
4885
5036
  "application/json": {
4886
- /** @description Catalog id; pass to /v1/merchants/{id} to refetch. */
5037
+ /**
5038
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5039
+ * @example invalid_key
5040
+ */
5041
+ error: string;
5042
+ /** @description Free-form human-readable explanation. Safe to surface. */
5043
+ detail?: string;
5044
+ };
5045
+ };
5046
+ };
5047
+ };
5048
+ };
5049
+ enrichBatchAsync: {
5050
+ parameters: {
5051
+ query?: never;
5052
+ header?: never;
5053
+ path?: never;
5054
+ cookie?: never;
5055
+ };
5056
+ requestBody: {
5057
+ content: {
5058
+ "application/json": {
5059
+ items: {
5060
+ descriptor: string;
5061
+ amount?: number;
5062
+ currency?: string;
5063
+ mcc?: string;
5064
+ country_hint?: string;
5065
+ merchant_name?: string;
5066
+ bank_code_description?: string;
5067
+ }[];
5068
+ };
5069
+ };
5070
+ };
5071
+ responses: {
5072
+ /** @description Default Response */
5073
+ 202: {
5074
+ headers: {
5075
+ [name: string]: unknown;
5076
+ };
5077
+ content: {
5078
+ "application/json": {
5079
+ /** Format: uuid */
5080
+ id: string;
5081
+ /** @enum {string} */
5082
+ status: "pending";
5083
+ item_count: number;
5084
+ /** Format: date-time */
5085
+ submitted_at: string;
5086
+ /** Format: date-time */
5087
+ expires_at: string;
5088
+ /** Format: uri */
5089
+ status_url: string;
5090
+ };
5091
+ };
5092
+ };
5093
+ /** @description Standard error envelope used for all non-2xx responses. */
5094
+ 400: {
5095
+ headers: {
5096
+ [name: string]: unknown;
5097
+ };
5098
+ content: {
5099
+ "application/json": {
5100
+ /**
5101
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5102
+ * @example invalid_key
5103
+ */
5104
+ error: string;
5105
+ /** @description Free-form human-readable explanation. Safe to surface. */
5106
+ detail?: string;
5107
+ };
5108
+ };
5109
+ };
5110
+ /** @description Standard error envelope used for all non-2xx responses. */
5111
+ 401: {
5112
+ headers: {
5113
+ [name: string]: unknown;
5114
+ };
5115
+ content: {
5116
+ "application/json": {
5117
+ /**
5118
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5119
+ * @example invalid_key
5120
+ */
5121
+ error: string;
5122
+ /** @description Free-form human-readable explanation. Safe to surface. */
5123
+ detail?: string;
5124
+ };
5125
+ };
5126
+ };
5127
+ /** @description Standard error envelope used for all non-2xx responses. */
5128
+ 402: {
5129
+ headers: {
5130
+ [name: string]: unknown;
5131
+ };
5132
+ content: {
5133
+ "application/json": {
5134
+ /**
5135
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5136
+ * @example invalid_key
5137
+ */
5138
+ error: string;
5139
+ /** @description Free-form human-readable explanation. Safe to surface. */
5140
+ detail?: string;
5141
+ };
5142
+ };
5143
+ };
5144
+ /** @description Standard error envelope used for all non-2xx responses. */
5145
+ 403: {
5146
+ headers: {
5147
+ [name: string]: unknown;
5148
+ };
5149
+ content: {
5150
+ "application/json": {
5151
+ /**
5152
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5153
+ * @example invalid_key
5154
+ */
5155
+ error: string;
5156
+ /** @description Free-form human-readable explanation. Safe to surface. */
5157
+ detail?: string;
5158
+ };
5159
+ };
5160
+ };
5161
+ /** @description Standard error envelope used for all non-2xx responses. */
5162
+ 429: {
5163
+ headers: {
5164
+ [name: string]: unknown;
5165
+ };
5166
+ content: {
5167
+ "application/json": {
5168
+ /**
5169
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5170
+ * @example invalid_key
5171
+ */
5172
+ error: string;
5173
+ /** @description Free-form human-readable explanation. Safe to surface. */
5174
+ detail?: string;
5175
+ };
5176
+ };
5177
+ };
5178
+ };
5179
+ };
5180
+ enrichBatchAsyncStatus: {
5181
+ parameters: {
5182
+ query?: never;
5183
+ header?: never;
5184
+ path: {
5185
+ id: string;
5186
+ };
5187
+ cookie?: never;
5188
+ };
5189
+ requestBody?: never;
5190
+ responses: {
5191
+ /** @description Default Response */
5192
+ 200: {
5193
+ headers: {
5194
+ [name: string]: unknown;
5195
+ };
5196
+ content: {
5197
+ "application/json": {
5198
+ /** Format: uuid */
5199
+ id: string;
5200
+ status: "pending" | "running" | "completed" | "failed" | "expired";
5201
+ item_count: number;
5202
+ completed_count: number;
5203
+ failed_count: number;
5204
+ /** Format: date-time */
5205
+ submitted_at: string;
5206
+ started_at: string | null;
5207
+ completed_at: string | null;
5208
+ /** Format: date-time */
5209
+ expires_at: string;
5210
+ result: {
5211
+ [key: string]: unknown;
5212
+ }[] | null;
5213
+ error: string | null;
5214
+ };
5215
+ };
5216
+ };
5217
+ /** @description Standard error envelope used for all non-2xx responses. */
5218
+ 401: {
5219
+ headers: {
5220
+ [name: string]: unknown;
5221
+ };
5222
+ content: {
5223
+ "application/json": {
5224
+ /**
5225
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5226
+ * @example invalid_key
5227
+ */
5228
+ error: string;
5229
+ /** @description Free-form human-readable explanation. Safe to surface. */
5230
+ detail?: string;
5231
+ };
5232
+ };
5233
+ };
5234
+ /** @description Standard error envelope used for all non-2xx responses. */
5235
+ 403: {
5236
+ headers: {
5237
+ [name: string]: unknown;
5238
+ };
5239
+ content: {
5240
+ "application/json": {
5241
+ /**
5242
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5243
+ * @example invalid_key
5244
+ */
5245
+ error: string;
5246
+ /** @description Free-form human-readable explanation. Safe to surface. */
5247
+ detail?: string;
5248
+ };
5249
+ };
5250
+ };
5251
+ /** @description Standard error envelope used for all non-2xx responses. */
5252
+ 404: {
5253
+ headers: {
5254
+ [name: string]: unknown;
5255
+ };
5256
+ content: {
5257
+ "application/json": {
5258
+ /**
5259
+ * @description Stable machine-readable code. SDK consumers should switch on this.
5260
+ * @example invalid_key
5261
+ */
5262
+ error: string;
5263
+ /** @description Free-form human-readable explanation. Safe to surface. */
5264
+ detail?: string;
5265
+ };
5266
+ };
5267
+ };
5268
+ };
5269
+ };
5270
+ getMerchant: {
5271
+ parameters: {
5272
+ query?: never;
5273
+ header?: never;
5274
+ path: {
5275
+ /** @description Catalog id (positive integer, accepted as a path string). */
5276
+ id: string;
5277
+ };
5278
+ cookie?: never;
5279
+ };
5280
+ requestBody?: never;
5281
+ responses: {
5282
+ /** @description Default Response */
5283
+ 200: {
5284
+ headers: {
5285
+ [name: string]: unknown;
5286
+ };
5287
+ content: {
5288
+ "application/json": {
5289
+ /** @description Catalog id; pass to /v1/merchants/{id} to refetch. */
4887
5290
  id: number;
4888
5291
  name: string;
4889
5292
  parent: string | null;
@@ -5363,7 +5766,7 @@ export interface operations {
5363
5766
  */
5364
5767
  url: string;
5365
5768
  /** @description Subset of supported events to subscribe to. Defaults to all currently-supported. */
5366
- events?: ("batch.completed" | "batch.failed" | "analysis.completed" | "ingestion.completed")[];
5769
+ events?: ("batch.completed" | "batch.failed" | "analysis.completed" | "ingestion.completed" | "connect.connection.activated")[];
5367
5770
  };
5368
5771
  };
5369
5772
  };
@@ -5692,6 +6095,917 @@ export interface operations {
5692
6095
  };
5693
6096
  };
5694
6097
  };
6098
+ listAspsps: {
6099
+ parameters: {
6100
+ query: {
6101
+ country: string;
6102
+ psu_type?: "business" | "personal";
6103
+ };
6104
+ header?: never;
6105
+ path?: never;
6106
+ cookie?: never;
6107
+ };
6108
+ requestBody?: never;
6109
+ responses: {
6110
+ /** @description Default Response */
6111
+ 200: {
6112
+ headers: {
6113
+ [name: string]: unknown;
6114
+ };
6115
+ content: {
6116
+ "application/json": {
6117
+ country: string;
6118
+ psu_type: "business" | "personal";
6119
+ aspsps: {
6120
+ name: string;
6121
+ country: string;
6122
+ }[];
6123
+ };
6124
+ };
6125
+ };
6126
+ /** @description Standard error envelope used for all non-2xx responses. */
6127
+ 400: {
6128
+ headers: {
6129
+ [name: string]: unknown;
6130
+ };
6131
+ content: {
6132
+ "application/json": {
6133
+ /**
6134
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6135
+ * @example invalid_key
6136
+ */
6137
+ error: string;
6138
+ /** @description Free-form human-readable explanation. Safe to surface. */
6139
+ detail?: string;
6140
+ };
6141
+ };
6142
+ };
6143
+ /** @description Standard error envelope used for all non-2xx responses. */
6144
+ 401: {
6145
+ headers: {
6146
+ [name: string]: unknown;
6147
+ };
6148
+ content: {
6149
+ "application/json": {
6150
+ /**
6151
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6152
+ * @example invalid_key
6153
+ */
6154
+ error: string;
6155
+ /** @description Free-form human-readable explanation. Safe to surface. */
6156
+ detail?: string;
6157
+ };
6158
+ };
6159
+ };
6160
+ /** @description Standard error envelope used for all non-2xx responses. */
6161
+ 403: {
6162
+ headers: {
6163
+ [name: string]: unknown;
6164
+ };
6165
+ content: {
6166
+ "application/json": {
6167
+ /**
6168
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6169
+ * @example invalid_key
6170
+ */
6171
+ error: string;
6172
+ /** @description Free-form human-readable explanation. Safe to surface. */
6173
+ detail?: string;
6174
+ };
6175
+ };
6176
+ };
6177
+ /** @description Standard error envelope used for all non-2xx responses. */
6178
+ 502: {
6179
+ headers: {
6180
+ [name: string]: unknown;
6181
+ };
6182
+ content: {
6183
+ "application/json": {
6184
+ /**
6185
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6186
+ * @example invalid_key
6187
+ */
6188
+ error: string;
6189
+ /** @description Free-form human-readable explanation. Safe to surface. */
6190
+ detail?: string;
6191
+ };
6192
+ };
6193
+ };
6194
+ /** @description Standard error envelope used for all non-2xx responses. */
6195
+ 503: {
6196
+ headers: {
6197
+ [name: string]: unknown;
6198
+ };
6199
+ content: {
6200
+ "application/json": {
6201
+ /**
6202
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6203
+ * @example invalid_key
6204
+ */
6205
+ error: string;
6206
+ /** @description Free-form human-readable explanation. Safe to surface. */
6207
+ detail?: string;
6208
+ };
6209
+ };
6210
+ };
6211
+ };
6212
+ };
6213
+ listConnections: {
6214
+ parameters: {
6215
+ query?: never;
6216
+ header?: never;
6217
+ path?: never;
6218
+ cookie?: never;
6219
+ };
6220
+ requestBody?: never;
6221
+ responses: {
6222
+ /** @description Default Response */
6223
+ 200: {
6224
+ headers: {
6225
+ [name: string]: unknown;
6226
+ };
6227
+ content: {
6228
+ "application/json": {
6229
+ connections: {
6230
+ /** Format: uuid */
6231
+ id: string;
6232
+ applicant_ref: string | null;
6233
+ aspsp_name: string | null;
6234
+ country: string | null;
6235
+ psu_type: "business" | "personal";
6236
+ status: "pending" | "active" | "expired" | "revoked";
6237
+ consent_expires_at: string | null;
6238
+ /** Format: date-time */
6239
+ created_at: string;
6240
+ }[];
6241
+ };
6242
+ };
6243
+ };
6244
+ /** @description Standard error envelope used for all non-2xx responses. */
6245
+ 401: {
6246
+ headers: {
6247
+ [name: string]: unknown;
6248
+ };
6249
+ content: {
6250
+ "application/json": {
6251
+ /**
6252
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6253
+ * @example invalid_key
6254
+ */
6255
+ error: string;
6256
+ /** @description Free-form human-readable explanation. Safe to surface. */
6257
+ detail?: string;
6258
+ };
6259
+ };
6260
+ };
6261
+ /** @description Standard error envelope used for all non-2xx responses. */
6262
+ 403: {
6263
+ headers: {
6264
+ [name: string]: unknown;
6265
+ };
6266
+ content: {
6267
+ "application/json": {
6268
+ /**
6269
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6270
+ * @example invalid_key
6271
+ */
6272
+ error: string;
6273
+ /** @description Free-form human-readable explanation. Safe to surface. */
6274
+ detail?: string;
6275
+ };
6276
+ };
6277
+ };
6278
+ };
6279
+ };
6280
+ createConnection: {
6281
+ parameters: {
6282
+ query?: never;
6283
+ header?: never;
6284
+ path?: never;
6285
+ cookie?: never;
6286
+ };
6287
+ requestBody: {
6288
+ content: {
6289
+ "application/json": {
6290
+ /** @description ISO-2 country code, e.g. DE. */
6291
+ country: string;
6292
+ /** @description Bank name; resolved to the canonical Enable Banking ASPSP name. */
6293
+ aspsp_name: string;
6294
+ /** @description Your reference for the applicant/deal (model 2). Omit for a self-link of your own accounts (model 1). */
6295
+ applicant_ref?: string;
6296
+ /**
6297
+ * Format: uri
6298
+ * @description Where to send the applicant after consent. Defaults to a Distyra-hosted page.
6299
+ */
6300
+ return_url?: string;
6301
+ };
6302
+ };
6303
+ };
6304
+ responses: {
6305
+ /** @description Default Response */
6306
+ 201: {
6307
+ headers: {
6308
+ [name: string]: unknown;
6309
+ };
6310
+ content: {
6311
+ "application/json": {
6312
+ /** Format: uuid */
6313
+ connection_id: string;
6314
+ /**
6315
+ * Format: uri
6316
+ * @description Redirect the applicant here to complete SCA at their bank.
6317
+ */
6318
+ authorization_url: string;
6319
+ };
6320
+ };
6321
+ };
6322
+ /** @description Standard error envelope used for all non-2xx responses. */
6323
+ 400: {
6324
+ headers: {
6325
+ [name: string]: unknown;
6326
+ };
6327
+ content: {
6328
+ "application/json": {
6329
+ /**
6330
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6331
+ * @example invalid_key
6332
+ */
6333
+ error: string;
6334
+ /** @description Free-form human-readable explanation. Safe to surface. */
6335
+ detail?: string;
6336
+ };
6337
+ };
6338
+ };
6339
+ /** @description Standard error envelope used for all non-2xx responses. */
6340
+ 401: {
6341
+ headers: {
6342
+ [name: string]: unknown;
6343
+ };
6344
+ content: {
6345
+ "application/json": {
6346
+ /**
6347
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6348
+ * @example invalid_key
6349
+ */
6350
+ error: string;
6351
+ /** @description Free-form human-readable explanation. Safe to surface. */
6352
+ detail?: string;
6353
+ };
6354
+ };
6355
+ };
6356
+ /** @description Standard error envelope used for all non-2xx responses. */
6357
+ 402: {
6358
+ headers: {
6359
+ [name: string]: unknown;
6360
+ };
6361
+ content: {
6362
+ "application/json": {
6363
+ /**
6364
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6365
+ * @example invalid_key
6366
+ */
6367
+ error: string;
6368
+ /** @description Free-form human-readable explanation. Safe to surface. */
6369
+ detail?: string;
6370
+ };
6371
+ };
6372
+ };
6373
+ /** @description Standard error envelope used for all non-2xx responses. */
6374
+ 403: {
6375
+ headers: {
6376
+ [name: string]: unknown;
6377
+ };
6378
+ content: {
6379
+ "application/json": {
6380
+ /**
6381
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6382
+ * @example invalid_key
6383
+ */
6384
+ error: string;
6385
+ /** @description Free-form human-readable explanation. Safe to surface. */
6386
+ detail?: string;
6387
+ };
6388
+ };
6389
+ };
6390
+ /** @description Standard error envelope used for all non-2xx responses. */
6391
+ 422: {
6392
+ headers: {
6393
+ [name: string]: unknown;
6394
+ };
6395
+ content: {
6396
+ "application/json": {
6397
+ /**
6398
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6399
+ * @example invalid_key
6400
+ */
6401
+ error: string;
6402
+ /** @description Free-form human-readable explanation. Safe to surface. */
6403
+ detail?: string;
6404
+ };
6405
+ };
6406
+ };
6407
+ /** @description Standard error envelope used for all non-2xx responses. */
6408
+ 502: {
6409
+ headers: {
6410
+ [name: string]: unknown;
6411
+ };
6412
+ content: {
6413
+ "application/json": {
6414
+ /**
6415
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6416
+ * @example invalid_key
6417
+ */
6418
+ error: string;
6419
+ /** @description Free-form human-readable explanation. Safe to surface. */
6420
+ detail?: string;
6421
+ };
6422
+ };
6423
+ };
6424
+ /** @description Standard error envelope used for all non-2xx responses. */
6425
+ 503: {
6426
+ headers: {
6427
+ [name: string]: unknown;
6428
+ };
6429
+ content: {
6430
+ "application/json": {
6431
+ /**
6432
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6433
+ * @example invalid_key
6434
+ */
6435
+ error: string;
6436
+ /** @description Free-form human-readable explanation. Safe to surface. */
6437
+ detail?: string;
6438
+ };
6439
+ };
6440
+ };
6441
+ };
6442
+ };
6443
+ getConnection: {
6444
+ parameters: {
6445
+ query?: never;
6446
+ header?: never;
6447
+ path: {
6448
+ id: string;
6449
+ };
6450
+ cookie?: never;
6451
+ };
6452
+ requestBody?: never;
6453
+ responses: {
6454
+ /** @description Default Response */
6455
+ 200: {
6456
+ headers: {
6457
+ [name: string]: unknown;
6458
+ };
6459
+ content: {
6460
+ "application/json": {
6461
+ /** Format: uuid */
6462
+ id: string;
6463
+ applicant_ref: string | null;
6464
+ aspsp_name: string | null;
6465
+ country: string | null;
6466
+ psu_type: "business" | "personal";
6467
+ status: "pending" | "active" | "expired" | "revoked";
6468
+ consent_expires_at: string | null;
6469
+ /** Format: date-time */
6470
+ created_at: string;
6471
+ };
6472
+ };
6473
+ };
6474
+ /** @description Standard error envelope used for all non-2xx responses. */
6475
+ 401: {
6476
+ headers: {
6477
+ [name: string]: unknown;
6478
+ };
6479
+ content: {
6480
+ "application/json": {
6481
+ /**
6482
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6483
+ * @example invalid_key
6484
+ */
6485
+ error: string;
6486
+ /** @description Free-form human-readable explanation. Safe to surface. */
6487
+ detail?: string;
6488
+ };
6489
+ };
6490
+ };
6491
+ /** @description Standard error envelope used for all non-2xx responses. */
6492
+ 403: {
6493
+ headers: {
6494
+ [name: string]: unknown;
6495
+ };
6496
+ content: {
6497
+ "application/json": {
6498
+ /**
6499
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6500
+ * @example invalid_key
6501
+ */
6502
+ error: string;
6503
+ /** @description Free-form human-readable explanation. Safe to surface. */
6504
+ detail?: string;
6505
+ };
6506
+ };
6507
+ };
6508
+ /** @description Standard error envelope used for all non-2xx responses. */
6509
+ 404: {
6510
+ headers: {
6511
+ [name: string]: unknown;
6512
+ };
6513
+ content: {
6514
+ "application/json": {
6515
+ /**
6516
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6517
+ * @example invalid_key
6518
+ */
6519
+ error: string;
6520
+ /** @description Free-form human-readable explanation. Safe to surface. */
6521
+ detail?: string;
6522
+ };
6523
+ };
6524
+ };
6525
+ };
6526
+ };
6527
+ revokeConnection: {
6528
+ parameters: {
6529
+ query?: never;
6530
+ header?: never;
6531
+ path: {
6532
+ id: string;
6533
+ };
6534
+ cookie?: never;
6535
+ };
6536
+ requestBody?: never;
6537
+ responses: {
6538
+ /** @description Default Response */
6539
+ 204: {
6540
+ headers: {
6541
+ [name: string]: unknown;
6542
+ };
6543
+ content?: never;
6544
+ };
6545
+ /** @description Standard error envelope used for all non-2xx responses. */
6546
+ 401: {
6547
+ headers: {
6548
+ [name: string]: unknown;
6549
+ };
6550
+ content: {
6551
+ "application/json": {
6552
+ /**
6553
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6554
+ * @example invalid_key
6555
+ */
6556
+ error: string;
6557
+ /** @description Free-form human-readable explanation. Safe to surface. */
6558
+ detail?: string;
6559
+ };
6560
+ };
6561
+ };
6562
+ /** @description Standard error envelope used for all non-2xx responses. */
6563
+ 403: {
6564
+ headers: {
6565
+ [name: string]: unknown;
6566
+ };
6567
+ content: {
6568
+ "application/json": {
6569
+ /**
6570
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6571
+ * @example invalid_key
6572
+ */
6573
+ error: string;
6574
+ /** @description Free-form human-readable explanation. Safe to surface. */
6575
+ detail?: string;
6576
+ };
6577
+ };
6578
+ };
6579
+ /** @description Standard error envelope used for all non-2xx responses. */
6580
+ 404: {
6581
+ headers: {
6582
+ [name: string]: unknown;
6583
+ };
6584
+ content: {
6585
+ "application/json": {
6586
+ /**
6587
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6588
+ * @example invalid_key
6589
+ */
6590
+ error: string;
6591
+ /** @description Free-form human-readable explanation. Safe to surface. */
6592
+ detail?: string;
6593
+ };
6594
+ };
6595
+ };
6596
+ };
6597
+ };
6598
+ getConnectionAccounts: {
6599
+ parameters: {
6600
+ query?: never;
6601
+ header?: never;
6602
+ path: {
6603
+ id: string;
6604
+ };
6605
+ cookie?: never;
6606
+ };
6607
+ requestBody?: never;
6608
+ responses: {
6609
+ /** @description Default Response */
6610
+ 200: {
6611
+ headers: {
6612
+ [name: string]: unknown;
6613
+ };
6614
+ content: {
6615
+ "application/json": {
6616
+ accounts: {
6617
+ account_id: string;
6618
+ uid?: string;
6619
+ name: string;
6620
+ currency: string;
6621
+ iban?: string;
6622
+ account_type?: string;
6623
+ balance: {
6624
+ amount: number;
6625
+ currency: string;
6626
+ };
6627
+ }[];
6628
+ };
6629
+ };
6630
+ };
6631
+ /** @description Standard error envelope used for all non-2xx responses. */
6632
+ 401: {
6633
+ headers: {
6634
+ [name: string]: unknown;
6635
+ };
6636
+ content: {
6637
+ "application/json": {
6638
+ /**
6639
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6640
+ * @example invalid_key
6641
+ */
6642
+ error: string;
6643
+ /** @description Free-form human-readable explanation. Safe to surface. */
6644
+ detail?: string;
6645
+ };
6646
+ };
6647
+ };
6648
+ /** @description Standard error envelope used for all non-2xx responses. */
6649
+ 403: {
6650
+ headers: {
6651
+ [name: string]: unknown;
6652
+ };
6653
+ content: {
6654
+ "application/json": {
6655
+ /**
6656
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6657
+ * @example invalid_key
6658
+ */
6659
+ error: string;
6660
+ /** @description Free-form human-readable explanation. Safe to surface. */
6661
+ detail?: string;
6662
+ };
6663
+ };
6664
+ };
6665
+ /** @description Standard error envelope used for all non-2xx responses. */
6666
+ 404: {
6667
+ headers: {
6668
+ [name: string]: unknown;
6669
+ };
6670
+ content: {
6671
+ "application/json": {
6672
+ /**
6673
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6674
+ * @example invalid_key
6675
+ */
6676
+ error: string;
6677
+ /** @description Free-form human-readable explanation. Safe to surface. */
6678
+ detail?: string;
6679
+ };
6680
+ };
6681
+ };
6682
+ /** @description Standard error envelope used for all non-2xx responses. */
6683
+ 409: {
6684
+ headers: {
6685
+ [name: string]: unknown;
6686
+ };
6687
+ content: {
6688
+ "application/json": {
6689
+ /**
6690
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6691
+ * @example invalid_key
6692
+ */
6693
+ error: string;
6694
+ /** @description Free-form human-readable explanation. Safe to surface. */
6695
+ detail?: string;
6696
+ };
6697
+ };
6698
+ };
6699
+ /** @description Standard error envelope used for all non-2xx responses. */
6700
+ 502: {
6701
+ headers: {
6702
+ [name: string]: unknown;
6703
+ };
6704
+ content: {
6705
+ "application/json": {
6706
+ /**
6707
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6708
+ * @example invalid_key
6709
+ */
6710
+ error: string;
6711
+ /** @description Free-form human-readable explanation. Safe to surface. */
6712
+ detail?: string;
6713
+ };
6714
+ };
6715
+ };
6716
+ /** @description Standard error envelope used for all non-2xx responses. */
6717
+ 503: {
6718
+ headers: {
6719
+ [name: string]: unknown;
6720
+ };
6721
+ content: {
6722
+ "application/json": {
6723
+ /**
6724
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6725
+ * @example invalid_key
6726
+ */
6727
+ error: string;
6728
+ /** @description Free-form human-readable explanation. Safe to surface. */
6729
+ detail?: string;
6730
+ };
6731
+ };
6732
+ };
6733
+ };
6734
+ };
6735
+ getConnectionTransactions: {
6736
+ parameters: {
6737
+ query?: {
6738
+ /** @description EB account uid; omit to fetch all accounts on the connection. */
6739
+ account_id?: string;
6740
+ date_from?: string;
6741
+ date_to?: string;
6742
+ /** @description Run enrichment on each transaction (bills the enrichment meter; needs enrichment:read). */
6743
+ enrich?: "true" | "false";
6744
+ /** @description Run the full underwriting analysis (enrichment always included; bills the per-applicant underwriting meter; needs underwriting:write). Returns the analysis bundle instead of transactions. */
6745
+ underwrite?: "true" | "false";
6746
+ };
6747
+ header?: never;
6748
+ path: {
6749
+ id: string;
6750
+ };
6751
+ cookie?: never;
6752
+ };
6753
+ requestBody?: never;
6754
+ responses: {
6755
+ /** @description Default Response */
6756
+ 200: {
6757
+ headers: {
6758
+ [name: string]: unknown;
6759
+ };
6760
+ content: {
6761
+ "application/json": {
6762
+ [key: string]: unknown;
6763
+ };
6764
+ };
6765
+ };
6766
+ /** @description Standard error envelope used for all non-2xx responses. */
6767
+ 401: {
6768
+ headers: {
6769
+ [name: string]: unknown;
6770
+ };
6771
+ content: {
6772
+ "application/json": {
6773
+ /**
6774
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6775
+ * @example invalid_key
6776
+ */
6777
+ error: string;
6778
+ /** @description Free-form human-readable explanation. Safe to surface. */
6779
+ detail?: string;
6780
+ };
6781
+ };
6782
+ };
6783
+ /** @description Standard error envelope used for all non-2xx responses. */
6784
+ 402: {
6785
+ headers: {
6786
+ [name: string]: unknown;
6787
+ };
6788
+ content: {
6789
+ "application/json": {
6790
+ /**
6791
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6792
+ * @example invalid_key
6793
+ */
6794
+ error: string;
6795
+ /** @description Free-form human-readable explanation. Safe to surface. */
6796
+ detail?: string;
6797
+ };
6798
+ };
6799
+ };
6800
+ /** @description Standard error envelope used for all non-2xx responses. */
6801
+ 403: {
6802
+ headers: {
6803
+ [name: string]: unknown;
6804
+ };
6805
+ content: {
6806
+ "application/json": {
6807
+ /**
6808
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6809
+ * @example invalid_key
6810
+ */
6811
+ error: string;
6812
+ /** @description Free-form human-readable explanation. Safe to surface. */
6813
+ detail?: string;
6814
+ };
6815
+ };
6816
+ };
6817
+ /** @description Standard error envelope used for all non-2xx responses. */
6818
+ 404: {
6819
+ headers: {
6820
+ [name: string]: unknown;
6821
+ };
6822
+ content: {
6823
+ "application/json": {
6824
+ /**
6825
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6826
+ * @example invalid_key
6827
+ */
6828
+ error: string;
6829
+ /** @description Free-form human-readable explanation. Safe to surface. */
6830
+ detail?: string;
6831
+ };
6832
+ };
6833
+ };
6834
+ /** @description Standard error envelope used for all non-2xx responses. */
6835
+ 409: {
6836
+ headers: {
6837
+ [name: string]: unknown;
6838
+ };
6839
+ content: {
6840
+ "application/json": {
6841
+ /**
6842
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6843
+ * @example invalid_key
6844
+ */
6845
+ error: string;
6846
+ /** @description Free-form human-readable explanation. Safe to surface. */
6847
+ detail?: string;
6848
+ };
6849
+ };
6850
+ };
6851
+ /** @description Standard error envelope used for all non-2xx responses. */
6852
+ 422: {
6853
+ headers: {
6854
+ [name: string]: unknown;
6855
+ };
6856
+ content: {
6857
+ "application/json": {
6858
+ /**
6859
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6860
+ * @example invalid_key
6861
+ */
6862
+ error: string;
6863
+ /** @description Free-form human-readable explanation. Safe to surface. */
6864
+ detail?: string;
6865
+ };
6866
+ };
6867
+ };
6868
+ /** @description Standard error envelope used for all non-2xx responses. */
6869
+ 502: {
6870
+ headers: {
6871
+ [name: string]: unknown;
6872
+ };
6873
+ content: {
6874
+ "application/json": {
6875
+ /**
6876
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6877
+ * @example invalid_key
6878
+ */
6879
+ error: string;
6880
+ /** @description Free-form human-readable explanation. Safe to surface. */
6881
+ detail?: string;
6882
+ };
6883
+ };
6884
+ };
6885
+ /** @description Standard error envelope used for all non-2xx responses. */
6886
+ 503: {
6887
+ headers: {
6888
+ [name: string]: unknown;
6889
+ };
6890
+ content: {
6891
+ "application/json": {
6892
+ /**
6893
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6894
+ * @example invalid_key
6895
+ */
6896
+ error: string;
6897
+ /** @description Free-form human-readable explanation. Safe to surface. */
6898
+ detail?: string;
6899
+ };
6900
+ };
6901
+ };
6902
+ };
6903
+ };
6904
+ createHostedConnectLink: {
6905
+ parameters: {
6906
+ query?: never;
6907
+ header?: never;
6908
+ path?: never;
6909
+ cookie?: never;
6910
+ };
6911
+ requestBody: {
6912
+ content: {
6913
+ "application/json": {
6914
+ country: string;
6915
+ applicant_ref?: string;
6916
+ /** Format: uri */
6917
+ return_url?: string;
6918
+ /** @default 72 */
6919
+ expires_in_hours?: number;
6920
+ };
6921
+ };
6922
+ };
6923
+ responses: {
6924
+ /** @description Default Response */
6925
+ 201: {
6926
+ headers: {
6927
+ [name: string]: unknown;
6928
+ };
6929
+ content: {
6930
+ "application/json": {
6931
+ /** Format: uri */
6932
+ url: string;
6933
+ token: string;
6934
+ /** Format: date-time */
6935
+ expires_at: string;
6936
+ };
6937
+ };
6938
+ };
6939
+ /** @description Standard error envelope used for all non-2xx responses. */
6940
+ 400: {
6941
+ headers: {
6942
+ [name: string]: unknown;
6943
+ };
6944
+ content: {
6945
+ "application/json": {
6946
+ /**
6947
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6948
+ * @example invalid_key
6949
+ */
6950
+ error: string;
6951
+ /** @description Free-form human-readable explanation. Safe to surface. */
6952
+ detail?: string;
6953
+ };
6954
+ };
6955
+ };
6956
+ /** @description Standard error envelope used for all non-2xx responses. */
6957
+ 401: {
6958
+ headers: {
6959
+ [name: string]: unknown;
6960
+ };
6961
+ content: {
6962
+ "application/json": {
6963
+ /**
6964
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6965
+ * @example invalid_key
6966
+ */
6967
+ error: string;
6968
+ /** @description Free-form human-readable explanation. Safe to surface. */
6969
+ detail?: string;
6970
+ };
6971
+ };
6972
+ };
6973
+ /** @description Standard error envelope used for all non-2xx responses. */
6974
+ 403: {
6975
+ headers: {
6976
+ [name: string]: unknown;
6977
+ };
6978
+ content: {
6979
+ "application/json": {
6980
+ /**
6981
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6982
+ * @example invalid_key
6983
+ */
6984
+ error: string;
6985
+ /** @description Free-form human-readable explanation. Safe to surface. */
6986
+ detail?: string;
6987
+ };
6988
+ };
6989
+ };
6990
+ /** @description Standard error envelope used for all non-2xx responses. */
6991
+ 503: {
6992
+ headers: {
6993
+ [name: string]: unknown;
6994
+ };
6995
+ content: {
6996
+ "application/json": {
6997
+ /**
6998
+ * @description Stable machine-readable code. SDK consumers should switch on this.
6999
+ * @example invalid_key
7000
+ */
7001
+ error: string;
7002
+ /** @description Free-form human-readable explanation. Safe to surface. */
7003
+ detail?: string;
7004
+ };
7005
+ };
7006
+ };
7007
+ };
7008
+ };
5695
7009
  internalCrawlReenqueue: {
5696
7010
  parameters: {
5697
7011
  query?: never;