@ogcio/building-blocks-sdk 0.2.74 → 0.2.76

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 (10) hide show
  1. package/.gitleaksignore +19 -34
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +14 -0
  4. package/dist/client/clients/payments/index.d.ts +11 -0
  5. package/dist/client/clients/payments/index.d.ts.map +1 -1
  6. package/dist/client/clients/payments/schema.d.ts +22 -19
  7. package/dist/client/clients/payments/schema.d.ts.map +1 -1
  8. package/package.json +1 -1
  9. package/src/client/clients/payments/open-api-definition.json +159 -48
  10. package/src/client/clients/payments/schema.ts +22 -19
package/src/client/clients/payments/open-api-definition.json CHANGED
@@ -1926,6 +1926,25 @@
1926
1926
  ]
1927
1927
  }
1928
1928
  },
1929
+ "allowedAuthMethods": {
1930
+ "type": "array",
1931
+ "items": {
1932
+ "anyOf": [
1933
+ {
1934
+ "type": "string",
1935
+ "enum": [
1936
+ "email_otp"
1937
+ ]
1938
+ },
1939
+ {
1940
+ "type": "string",
1941
+ "enum": [
1942
+ "social:mygovid"
1943
+ ]
1944
+ }
1945
+ ]
1946
+ }
1947
+ },
1929
1948
  "status": {
1930
1949
  "anyOf": [
1931
1950
  {
@@ -1953,6 +1972,7 @@
1953
1972
  "paymentRequestId",
1954
1973
  "title",
1955
1974
  "providers",
1975
+ "allowedAuthMethods",
1956
1976
  "status"
1957
1977
  ],
1958
1978
  "example": {
@@ -1985,6 +2005,7 @@
1985
2005
  "createdAt": "2024-01-15T10:30:00Z"
1986
2006
  }
1987
2007
  ],
2008
+ "allowedAuthMethods": [],
1988
2009
  "status": "active"
1989
2010
  }
1990
2011
  }
@@ -2202,6 +2223,25 @@
2202
2223
  "allowCustomAmount": {
2203
2224
  "type": "boolean"
2204
2225
  },
2226
+ "allowedAuthMethods": {
2227
+ "type": "array",
2228
+ "items": {
2229
+ "anyOf": [
2230
+ {
2231
+ "type": "string",
2232
+ "enum": [
2233
+ "email_otp"
2234
+ ]
2235
+ },
2236
+ {
2237
+ "type": "string",
2238
+ "enum": [
2239
+ "social:mygovid"
2240
+ ]
2241
+ }
2242
+ ]
2243
+ }
2244
+ },
2205
2245
  "providers": {
2206
2246
  "type": "array",
2207
2247
  "items": {
@@ -2240,6 +2280,7 @@
2240
2280
  "redirectUrl",
2241
2281
  "allowAmountOverride",
2242
2282
  "allowCustomAmount",
2283
+ "allowedAuthMethods",
2243
2284
  "providers",
2244
2285
  "status"
2245
2286
  ]
@@ -2260,6 +2301,9 @@
2260
2301
  "redirectUrl": "https://example.com/success",
2261
2302
  "allowAmountOverride": false,
2262
2303
  "allowCustomAmount": false,
2304
+ "allowedAuthMethods": [
2305
+ "email_otp"
2306
+ ],
2263
2307
  "providers": [
2264
2308
  "prov_stripe_001",
2265
2309
  "prov_realex_001"
@@ -2282,6 +2326,9 @@
2282
2326
  "redirectUrl": null,
2283
2327
  "allowAmountOverride": true,
2284
2328
  "allowCustomAmount": true,
2329
+ "allowedAuthMethods": [
2330
+ "email_otp"
2331
+ ],
2285
2332
  "providers": [
2286
2333
  "prov_stripe_001"
2287
2334
  ],
@@ -2303,6 +2350,9 @@
2303
2350
  "redirectUrl": "https://example.com/donation-success",
2304
2351
  "allowAmountOverride": true,
2305
2352
  "allowCustomAmount": true,
2353
+ "allowedAuthMethods": [
2354
+ "social:mygovid"
2355
+ ],
2306
2356
  "providers": [
2307
2357
  "prov_stripe_001"
2308
2358
  ],
@@ -3160,6 +3210,25 @@
3160
3210
  "amount": {
3161
3211
  "type": "number"
3162
3212
  },
3213
+ "allowedAuthMethods": {
3214
+ "type": "array",
3215
+ "items": {
3216
+ "anyOf": [
3217
+ {
3218
+ "type": "string",
3219
+ "enum": [
3220
+ "email_otp"
3221
+ ]
3222
+ },
3223
+ {
3224
+ "type": "string",
3225
+ "enum": [
3226
+ "social:mygovid"
3227
+ ]
3228
+ }
3229
+ ]
3230
+ }
3231
+ },
3163
3232
  "allowAmountOverride": {
3164
3233
  "type": "boolean"
3165
3234
  },
@@ -3170,6 +3239,7 @@
3170
3239
  "required": [
3171
3240
  "paymentRequestId",
3172
3241
  "title",
3242
+ "allowedAuthMethods",
3173
3243
  "allowAmountOverride",
3174
3244
  "createdAt"
3175
3245
  ],
@@ -3184,6 +3254,9 @@
3184
3254
  "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
3185
3255
  },
3186
3256
  "amount": 55,
3257
+ "allowedAuthMethods": [
3258
+ "email_otp"
3259
+ ],
3187
3260
  "allowAmountOverride": false,
3188
3261
  "createdAt": "2024-01-15T10:30:00Z"
3189
3262
  }
@@ -3422,6 +3495,25 @@
3422
3495
  ]
3423
3496
  }
3424
3497
  },
3498
+ "allowedAuthMethods": {
3499
+ "type": "array",
3500
+ "items": {
3501
+ "anyOf": [
3502
+ {
3503
+ "type": "string",
3504
+ "enum": [
3505
+ "email_otp"
3506
+ ]
3507
+ },
3508
+ {
3509
+ "type": "string",
3510
+ "enum": [
3511
+ "social:mygovid"
3512
+ ]
3513
+ }
3514
+ ]
3515
+ }
3516
+ },
3425
3517
  "status": {
3426
3518
  "anyOf": [
3427
3519
  {
@@ -3458,6 +3550,7 @@
3458
3550
  "paymentRequestId",
3459
3551
  "title",
3460
3552
  "providers",
3553
+ "allowedAuthMethods",
3461
3554
  "status",
3462
3555
  "allowAmountOverride",
3463
3556
  "allowCustomAmount"
@@ -3495,7 +3588,10 @@
3495
3588
  "status": "active",
3496
3589
  "redirectUrl": "https://example.com/payment-success",
3497
3590
  "allowAmountOverride": false,
3498
- "allowCustomAmount": false
3591
+ "allowCustomAmount": false,
3592
+ "allowedAuthMethods": [
3593
+ "email_otp"
3594
+ ]
3499
3595
  }
3500
3596
  },
3501
3597
  "metadata": {
@@ -4070,6 +4166,25 @@
4070
4166
  },
4071
4167
  "allowCustomAmount": {
4072
4168
  "type": "boolean"
4169
+ },
4170
+ "allowedAuthMethods": {
4171
+ "type": "array",
4172
+ "items": {
4173
+ "anyOf": [
4174
+ {
4175
+ "type": "string",
4176
+ "enum": [
4177
+ "email_otp"
4178
+ ]
4179
+ },
4180
+ {
4181
+ "type": "string",
4182
+ "enum": [
4183
+ "social:mygovid"
4184
+ ]
4185
+ }
4186
+ ]
4187
+ }
4073
4188
  }
4074
4189
  },
4075
4190
  "required": [
@@ -4081,7 +4196,8 @@
4081
4196
  "status",
4082
4197
  "redirectUrl",
4083
4198
  "allowAmountOverride",
4084
- "allowCustomAmount"
4199
+ "allowCustomAmount",
4200
+ "allowedAuthMethods"
4085
4201
  ],
4086
4202
  "example": {
4087
4203
  "paymentRequestId": "pr_1234567890abcdef",
@@ -4756,6 +4872,9 @@
4756
4872
  "extPaymentId": {
4757
4873
  "type": "string"
4758
4874
  },
4875
+ "choosenAuthMethod": {
4876
+ "type": "string"
4877
+ },
4759
4878
  "paymentProviderId": {
4760
4879
  "type": "string"
4761
4880
  },
@@ -4782,12 +4901,14 @@
4782
4901
  "status",
4783
4902
  "amount",
4784
4903
  "extPaymentId",
4904
+ "choosenAuthMethod",
4785
4905
  "paymentProviderId",
4786
4906
  "updatedAt",
4787
4907
  "title"
4788
4908
  ],
4789
4909
  "example": {
4790
4910
  "transactionId": "tx_1234567890abcdef",
4911
+ "choosenAuthMethod": "email_otp",
4791
4912
  "status": "succeeded",
4792
4913
  "amount": 25,
4793
4914
  "extPaymentId": "pi_stripe_1234567890",
@@ -5150,6 +5271,9 @@
5150
5271
  }
5151
5272
  ]
5152
5273
  },
5274
+ "choosenAuthMethod": {
5275
+ "type": "string"
5276
+ },
5153
5277
  "paymentProviderId": {
5154
5278
  "type": "string"
5155
5279
  },
@@ -5256,6 +5380,7 @@
5256
5380
  "status",
5257
5381
  "amount",
5258
5382
  "extPaymentId",
5383
+ "choosenAuthMethod",
5259
5384
  "paymentProviderId",
5260
5385
  "updatedAt",
5261
5386
  "title",
@@ -5277,6 +5402,7 @@
5277
5402
  "en": "Driver License Renewal Fee",
5278
5403
  "ga": "Táille Athnuachana Ceadúnais Tiomána"
5279
5404
  },
5405
+ "choosenAuthMethod": "email_otp",
5280
5406
  "description": {
5281
5407
  "en": "Payment for renewing your driver license",
5282
5408
  "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
@@ -6392,6 +6518,9 @@
6392
6518
  }
6393
6519
  ]
6394
6520
  },
6521
+ "choosenAuthMethod": {
6522
+ "type": "string"
6523
+ },
6395
6524
  "paymentProviderId": {
6396
6525
  "type": "string"
6397
6526
  },
@@ -6498,6 +6627,7 @@
6498
6627
  "status",
6499
6628
  "amount",
6500
6629
  "extPaymentId",
6630
+ "choosenAuthMethod",
6501
6631
  "paymentProviderId",
6502
6632
  "updatedAt",
6503
6633
  "title",
@@ -6519,6 +6649,7 @@
6519
6649
  "en": "Driver License Renewal Fee",
6520
6650
  "ga": "Táille Athnuachana Ceadúnais Tiomána"
6521
6651
  },
6652
+ "choosenAuthMethod": "email_otp",
6522
6653
  "description": {
6523
6654
  "en": "Payment for renewing your driver license",
6524
6655
  "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
@@ -6977,6 +7108,7 @@
6977
7108
  "extPaymentId": "pi_stripe_1234567890",
6978
7109
  "amount": 25,
6979
7110
  "paymentProviderId": "prov_stripe_001",
7111
+ "choosenAuthMethod": "email_otp",
6980
7112
  "metadata": {
6981
7113
  "runId": "run_1234567890",
6982
7114
  "journeyId": "journey_1234567890",
@@ -7002,6 +7134,7 @@
7002
7134
  "extPaymentId": "pi_realex_0987654321",
7003
7135
  "amount": 80,
7004
7136
  "paymentProviderId": "prov_realex_001",
7137
+ "choosenAuthMethod": "social:mygovid",
7005
7138
  "metadata": {
7006
7139
  "runId": "run_0987654321",
7007
7140
  "journeyId": "journey_0987654321",
@@ -7407,6 +7540,9 @@
7407
7540
  }
7408
7541
  ]
7409
7542
  },
7543
+ "choosenAuthMethod": {
7544
+ "type": "string"
7545
+ },
7410
7546
  "paymentProviderId": {
7411
7547
  "type": "string"
7412
7548
  },
@@ -7513,6 +7649,7 @@
7513
7649
  "status",
7514
7650
  "amount",
7515
7651
  "extPaymentId",
7652
+ "choosenAuthMethod",
7516
7653
  "paymentProviderId",
7517
7654
  "updatedAt",
7518
7655
  "title",
@@ -7534,6 +7671,7 @@
7534
7671
  "en": "Driver License Renewal Fee",
7535
7672
  "ga": "Táille Athnuachana Ceadúnais Tiomána"
7536
7673
  },
7674
+ "choosenAuthMethod": "email_otp",
7537
7675
  "description": {
7538
7676
  "en": "Payment for renewing your driver license",
7539
7677
  "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
@@ -7912,52 +8050,7 @@
7912
8050
  "examples": {
7913
8051
  "type": "array",
7914
8052
  "items": {
7915
- "type": "object",
7916
- "properties": {
7917
- "userId": {
7918
- "type": "string"
7919
- },
7920
- "transactionId": {
7921
- "type": "string"
7922
- },
7923
- "paymentRequestId": {
7924
- "type": "string"
7925
- },
7926
- "paymentRequestTitle": {
7927
- "type": "object",
7928
- "properties": {
7929
- "en": {
7930
- "type": "string"
7931
- },
7932
- "ga": {
7933
- "type": "string"
7934
- }
7935
- }
7936
- },
7937
- "amount": {
7938
- "type": "integer"
7939
- },
7940
- "extReferenceCode": {
7941
- "type": "string"
7942
- },
7943
- "paymentMethod": {
7944
- "type": "string"
7945
- },
7946
- "paymentProviderName": {
7947
- "type": "string"
7948
- },
7949
- "status": {
7950
- "type": "string"
7951
- },
7952
- "createdAt": {
7953
- "type": "string",
7954
- "format": "date-time"
7955
- },
7956
- "updatedAt": {
7957
- "type": "string",
7958
- "format": "date-time"
7959
- }
7960
- }
8053
+ "type": "object"
7961
8054
  }
7962
8055
  },
7963
8056
  "type": {
@@ -8063,6 +8156,14 @@
8063
8156
  }
8064
8157
  }
8065
8158
  },
8159
+ "choosenAuthMethod": {
8160
+ "type": "object",
8161
+ "properties": {
8162
+ "type": {
8163
+ "type": "string"
8164
+ }
8165
+ }
8166
+ },
8066
8167
  "status": {
8067
8168
  "type": "object",
8068
8169
  "properties": {
@@ -8380,6 +8481,9 @@
8380
8481
  "paymentProviderName": {
8381
8482
  "type": "string"
8382
8483
  },
8484
+ "choosenAuthMethod": {
8485
+ "type": "string"
8486
+ },
8383
8487
  "status": {
8384
8488
  "anyOf": [
8385
8489
  {
@@ -8448,6 +8552,7 @@
8448
8552
  "extReferenceCode",
8449
8553
  "paymentMethod",
8450
8554
  "paymentProviderName",
8555
+ "choosenAuthMethod",
8451
8556
  "status",
8452
8557
  "createdAt",
8453
8558
  "updatedAt"
@@ -8464,6 +8569,7 @@
8464
8569
  "extReferenceCode": "pi_stripe_1234567890",
8465
8570
  "paymentMethod": "card",
8466
8571
  "paymentProviderName": "Stripe Production",
8572
+ "choosenAuthMethod": "email_otp",
8467
8573
  "status": "succeeded",
8468
8574
  "createdAt": "2024-01-15T14:30:00Z",
8469
8575
  "updatedAt": "2024-01-15T14:30:00Z"
@@ -10619,6 +10725,9 @@
10619
10725
  }
10620
10726
  ]
10621
10727
  },
10728
+ "choosenAuthMethod": {
10729
+ "type": "string"
10730
+ },
10622
10731
  "paymentProviderId": {
10623
10732
  "type": "string"
10624
10733
  },
@@ -10725,6 +10834,7 @@
10725
10834
  "status",
10726
10835
  "amount",
10727
10836
  "extPaymentId",
10837
+ "choosenAuthMethod",
10728
10838
  "paymentProviderId",
10729
10839
  "updatedAt",
10730
10840
  "title",
@@ -10746,6 +10856,7 @@
10746
10856
  "en": "Driver License Renewal Fee",
10747
10857
  "ga": "Táille Athnuachana Ceadúnais Tiomána"
10748
10858
  },
10859
+ "choosenAuthMethod": "email_otp",
10749
10860
  "description": {
10750
10861
  "en": "Payment for renewing your driver license",
10751
10862
  "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
package/src/client/clients/payments/schema.ts CHANGED
@@ -1324,6 +1324,7 @@ export interface operations {
1324
1324
  status: "connected" | "disconnected";
1325
1325
  createdAt: string;
1326
1326
  }[];
1327
+ allowedAuthMethods: ("email_otp" | "social:mygovid")[];
1327
1328
  status: "active" | "inactive" | "draft";
1328
1329
  }[];
1329
1330
  metadata?: {
@@ -1506,6 +1507,7 @@ export interface operations {
1506
1507
  redirectUrl: string | null;
1507
1508
  allowAmountOverride: boolean;
1508
1509
  allowCustomAmount: boolean;
1510
+ allowedAuthMethods: ("email_otp" | "social:mygovid")[];
1509
1511
  providers: string[];
1510
1512
  status: "active" | "inactive" | "draft";
1511
1513
  };
@@ -1627,6 +1629,7 @@ export interface operations {
1627
1629
  ga?: string;
1628
1630
  };
1629
1631
  amount?: number;
1632
+ allowedAuthMethods: ("email_otp" | "social:mygovid")[];
1630
1633
  allowAmountOverride: boolean;
1631
1634
  createdAt: string;
1632
1635
  }[];
@@ -1720,7 +1723,10 @@ export interface operations {
1720
1723
  * "status": "active",
1721
1724
  * "redirectUrl": "https://example.com/payment-success",
1722
1725
  * "allowAmountOverride": false,
1723
- * "allowCustomAmount": false
1726
+ * "allowCustomAmount": false,
1727
+ * "allowedAuthMethods": [
1728
+ * "email_otp"
1729
+ * ]
1724
1730
  * }
1725
1731
  */
1726
1732
  data: {
@@ -1743,6 +1749,7 @@ export interface operations {
1743
1749
  status: "connected" | "disconnected";
1744
1750
  createdAt: string;
1745
1751
  }[];
1752
+ allowedAuthMethods: ("email_otp" | "social:mygovid")[];
1746
1753
  status: "active" | "inactive" | "draft";
1747
1754
  redirectUrl?: string;
1748
1755
  allowAmountOverride: boolean;
@@ -1936,6 +1943,7 @@ export interface operations {
1936
1943
  redirectUrl: string;
1937
1944
  allowAmountOverride: boolean;
1938
1945
  allowCustomAmount: boolean;
1946
+ allowedAuthMethods: ("email_otp" | "social:mygovid")[];
1939
1947
  };
1940
1948
  metadata?: {
1941
1949
  /** @description Object containing the links to the related endpoints */
@@ -2134,6 +2142,7 @@ export interface operations {
2134
2142
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
2135
2143
  amount: number;
2136
2144
  extPaymentId: string;
2145
+ choosenAuthMethod: string;
2137
2146
  paymentProviderId: string;
2138
2147
  updatedAt: string;
2139
2148
  title: {
@@ -2241,6 +2250,7 @@ export interface operations {
2241
2250
  * "en": "Driver License Renewal Fee",
2242
2251
  * "ga": "Táille Athnuachana Ceadúnais Tiomána"
2243
2252
  * },
2253
+ * "choosenAuthMethod": "email_otp",
2244
2254
  * "description": {
2245
2255
  * "en": "Payment for renewing your driver license",
2246
2256
  * "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
@@ -2272,6 +2282,7 @@ export interface operations {
2272
2282
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
2273
2283
  amount: number;
2274
2284
  extPaymentId: string;
2285
+ choosenAuthMethod: string;
2275
2286
  paymentProviderId: string;
2276
2287
  updatedAt: string;
2277
2288
  title: {
@@ -2561,6 +2572,7 @@ export interface operations {
2561
2572
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
2562
2573
  amount: number;
2563
2574
  extPaymentId: string;
2575
+ choosenAuthMethod: string;
2564
2576
  paymentProviderId: string;
2565
2577
  updatedAt: string;
2566
2578
  title: {
@@ -2825,6 +2837,7 @@ export interface operations {
2825
2837
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
2826
2838
  amount: number;
2827
2839
  extPaymentId: string;
2840
+ choosenAuthMethod: string;
2828
2841
  paymentProviderId: string;
2829
2842
  updatedAt: string;
2830
2843
  title: {
@@ -2958,24 +2971,7 @@ export interface operations {
2958
2971
  };
2959
2972
  content: {
2960
2973
  "application/json": {
2961
- examples?: {
2962
- userId?: string;
2963
- transactionId?: string;
2964
- paymentRequestId?: string;
2965
- paymentRequestTitle?: {
2966
- en?: string;
2967
- ga?: string;
2968
- };
2969
- amount?: number;
2970
- extReferenceCode?: string;
2971
- paymentMethod?: string;
2972
- paymentProviderName?: string;
2973
- status?: string;
2974
- /** Format: date-time */
2975
- createdAt?: string;
2976
- /** Format: date-time */
2977
- updatedAt?: string;
2978
- }[];
2974
+ examples?: Record<string, never>[];
2979
2975
  type?: string;
2980
2976
  properties?: {
2981
2977
  userId?: {
@@ -3013,6 +3009,9 @@ export interface operations {
3013
3009
  paymentProviderName?: {
3014
3010
  type?: string;
3015
3011
  };
3012
+ choosenAuthMethod?: {
3013
+ type?: string;
3014
+ };
3016
3015
  status?: {
3017
3016
  anyOf?: {
3018
3017
  const?: string;
@@ -3141,6 +3140,7 @@ export interface operations {
3141
3140
  * "extReferenceCode": "pi_stripe_1234567890",
3142
3141
  * "paymentMethod": "card",
3143
3142
  * "paymentProviderName": "Stripe Production",
3143
+ * "choosenAuthMethod": "email_otp",
3144
3144
  * "status": "succeeded",
3145
3145
  * "createdAt": "2024-01-15T14:30:00Z",
3146
3146
  * "updatedAt": "2024-01-15T14:30:00Z"
@@ -3158,6 +3158,7 @@ export interface operations {
3158
3158
  extReferenceCode: string;
3159
3159
  paymentMethod: string;
3160
3160
  paymentProviderName: string;
3161
+ choosenAuthMethod: string;
3161
3162
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
3162
3163
  createdAt: string;
3163
3164
  updatedAt: string;
@@ -3790,6 +3791,7 @@ export interface operations {
3790
3791
  * "en": "Driver License Renewal Fee",
3791
3792
  * "ga": "Táille Athnuachana Ceadúnais Tiomána"
3792
3793
  * },
3794
+ * "choosenAuthMethod": "email_otp",
3793
3795
  * "description": {
3794
3796
  * "en": "Payment for renewing your driver license",
3795
3797
  * "ga": "Íocaíocht le haghaidh do cheadúnais tiomána a athnuachan"
@@ -3821,6 +3823,7 @@ export interface operations {
3821
3823
  status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
3822
3824
  amount: number;
3823
3825
  extPaymentId: string;
3826
+ choosenAuthMethod: string;
3824
3827
  paymentProviderId: string;
3825
3828
  updatedAt: string;
3826
3829
  title: {